1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class ASF_Object_TimecodeIndex</title>
<link rel="stylesheet" href="../../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class ASF_Object_TimecodeIndex</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-vars">Vars</a>
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This top-level ASF object supplies timecode indexing information for the</p>
<p class="description"><p>streams of an ASF file. It includes stream-specific indexing information based on the timecodes found in the file. If the <em>Timecode Index Object</em> is used, it is recommended that timecodes be stored as a <em>Payload Extension
System</em> on the appropriate stream. It is also recommended that every timecode appearing in the ASF file have a corresponging index entry.</p><p>The index is designed to be broken into blocks to facilitate storage that is more space-efficient by using 32-bit offsets relative to a 64-bit base. That is, each index block has a full 64-bit offset in the block header that is added to the 32-bit offsets found in each index entry. If a file is larger than 2^32 bytes, then multiple index blocks can be used to fully index the entire large file while still keeping index entry offsets at 32 bits.</p><p>To locate an object with a particular timecode in an ASF file, one would typically look through the <em>Timecode Index Object</em> in blocks of the appropriate range and try to locate the nearest possible timecode. The corresponding <em>Offset</em> field values of the <em>Index Entry</em> are byte offsets that, when combined with the <em>Block Position</em> value of the Index Block, indicate the starting location in bytes of an ASF Data Packet relative to the start of the first ASF Data Packet in the file.</p><p>Any ASF file containing a <em>Timecode Index Object</em> shall also contain a <em>Timecode Index Parameters Object</em> in its <a href="../../php-reader/ASF/ASF_Object_Header.html">ASF Header</a>.</p></p>
<ul class="tags">
<li><span class="field">author:</span> Sven Vollbehr <<a href="mailto:svollbehr@gmail.com">svollbehr@gmail.com</a>></li>
<li><span class="field">version:</span> $Rev: 108 $</li>
<li><span class="field">copyright:</span> Copyright (c) 2008 The PHP Reader Project Workgroup</li>
<li><span class="field">license:</span> <a href="http://code.google.com/p/php-reader/wiki/License">New BSD License</a></li>
</ul>
<p class="notes">
Located in <a class="field" href="_ASF---Object---TimecodeIndex.php.html">/ASF/Object/TimecodeIndex.php</a> (line <span class="field">76</span>)
</p>
<pre><a href="../../php-reader/ASF/ASF_Object.html">ASF_Object</a>
|
--ASF_Object_TimecodeIndex</pre>
</div>
</div>
<a name="sec-const-summary"></a>
<div class="info-box">
<div class="info-box-title">Class Constant Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
<a href="#sec-vars">Vars</a>
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="const-summary">
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#NEAREST_PAST_CLEANPOINT" title="details" class="const-name">NEAREST_PAST_CLEANPOINT</a> = <span class="var-type"> 3</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#NEAREST_PAST_DATA_PACKET" title="details" class="const-name">NEAREST_PAST_DATA_PACKET</a> = <span class="var-type"> 1</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#NEAREST_PAST_MEDIA" title="details" class="const-name">NEAREST_PAST_MEDIA</a> = <span class="var-type"> 2</span>
</div>
</div>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
<a href="#sec-vars">Vars</a>
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">ASF_Object_TimecodeIndex</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
(<span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span> <span class="var-name">$reader</span>, [<span class="var-type"></span> <span class="var-name">&$options</span> = <span class="var-default">array()</span>], <span class="var-type">Array</span> <span class="var-name">$options</span>)
</div>
<div class="method-definition">
<span class="method-result">Array</span>
<a href="#getIndexBlocks" title="details" class="method-name">getIndexBlocks</a>
()
</div>
<div class="method-definition">
<span class="method-result">Array</span>
<a href="#getIndexSpecifiers" title="details" class="method-name">getIndexSpecifiers</a>
()
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../../php-reader/ASF/ASF_Object.html">ASF_Object</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../../php-reader/ASF/ASF_Object.html#var$_options">ASF_Object::$_options</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../../php-reader/ASF/ASF_Object.html#var$_reader">ASF_Object::$_reader</a></span><br>
</span>
</blockquote>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-vars">Vars</a>
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">114</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructs the class with given parameters and reads object related data from the ASF file.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">ASF_Object_TimecodeIndex</span>
<span class="method-name">
__construct
</span>
(<span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span> <span class="var-name">$reader</span>, [<span class="var-type"></span> <span class="var-name">&$options</span> = <span class="var-default">array()</span>], <span class="var-type">Array</span> <span class="var-name">$options</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span>
<span class="var-name">$reader</span><span class="var-description">: The reader object.</span> </li>
<li>
<span class="var-type">Array</span>
<span class="var-name">$options</span><span class="var-description">: The options array.</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$options</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../../php-reader/ASF/ASF_Object.html#method__construct">ASF_Object::__construct()</a></dt>
<dd>Constructs the class with given parameters and options.</dd>
</dl>
</div>
<a name="methodgetIndexBlocks" id="getIndexBlocks"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getIndexBlocks</span> (line <span class="line-number">180</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns an array of index entries. Each entry consists of the following keys.</p>
<p class="description"><p><ul><li>timecodeRange -- Specifies the timecode range for this block.
Subsequent blocks must contain range numbers greater than or equal to
this one.</li></ul> <ul><li>blockPositions -- Specifies a list of byte offsets of the beginnings of
the blocks relative to the beginning of the first Data Packet (for
example, the beginning of the Data Object + 50 bytes).</li></ul> <ul></ul><ul><li>timecode -- This is the 4-byte timecode for these entries.</li><li>offsets -- Specifies the offset. An offset value of 0xffffffff
indicates an invalid offset value.</li></ul></p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">Array</span>
<span class="method-name">
getIndexBlocks
</span>
()
</div>
</div>
<a name="methodgetIndexSpecifiers" id="getIndexSpecifiers"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getIndexSpecifiers</span> (line <span class="line-number">159</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns an array of index specifiers. Each entry consists of the following keys.</p>
<p class="description"><p><ul><li>streamNumber -- Specifies the stream number that the <em>Index
Specifiers</em> refer to. Valid values are between 1 and 127.</li></ul> <ul><li>indexType -- Specifies the type of index.</li></ul></p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">Array</span>
<span class="method-name">
getIndexSpecifiers
</span>
()
</div>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../../php-reader/ASF/ASF_Object.html">ASF_Object</a></span></p>
<blockquote>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#method__construct">ASF_Object::__construct()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetIdentifier">ASF_Object::getIdentifier()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetOffset">ASF_Object::getOffset()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetOption">ASF_Object::getOption()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetOptions">ASF_Object::getOptions()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetParent">ASF_Object::getParent()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetSize">ASF_Object::getSize()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetIdentifier">ASF_Object::setIdentifier()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetOffset">ASF_Object::setOffset()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetOption">ASF_Object::setOption()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetOptions">ASF_Object::setOptions()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetParent">ASF_Object::setParent()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetSize">ASF_Object::setSize()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#method__get">ASF_Object::__get()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#method__set">ASF_Object::__set()</a></span><br>
</blockquote>
</div>
</div>
<a name="sec-consts"></a>
<div class="info-box">
<div class="info-box-title">Class Constants</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
<a href="#sec-vars">Vars</a>
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="constNEAREST_PAST_CLEANPOINT" id="NEAREST_PAST_CLEANPOINT"><!-- --></A>
<div class="oddrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">NEAREST_PAST_CLEANPOINT</span>
= <span class="const-default"> 3</span>
(line <span class="line-number">99</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Indicates that the index type is Nearest Past Cleanpoint. The Nearest Past Cleanpoint indexes point to the closest data packet containing an entire object (or first fragment of an object) that has the Cleanpoint Flag set.</p>
<p class="description"><p>Nearest Past Cleanpoint is the most common type of index.</p></p>
</div>
<a name="constNEAREST_PAST_DATA_PACKET" id="NEAREST_PAST_DATA_PACKET"><!-- --></A>
<div class="evenrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">NEAREST_PAST_DATA_PACKET</span>
= <span class="const-default"> 1</span>
(line <span class="line-number">83</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Indicates that the index type is Nearest Past Data Packet. The Nearest Past Data Packet indexes point to the data packet whose presentation time is closest to the index entry time.</p>
</div>
<a name="constNEAREST_PAST_MEDIA" id="NEAREST_PAST_MEDIA"><!-- --></A>
<div class="oddrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">NEAREST_PAST_MEDIA</span>
= <span class="const-default"> 2</span>
(line <span class="line-number">90</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Indicates that the index type is Nearest Past Media. The Nearest Past Object indexes point to the closest data packet containing an entire object or first fragment of an object.</p>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Fri, 05 Sep 2008 20:19:43 +0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
</p>
</div></body>
</html>
|
