box: Move box type definitions into another file.
[L-SMASH.git] / core / box.h
blobdf55ebcf9c3ad3f0bcacb9033cfaae6b2126659c
1 /*****************************************************************************
2 * box.h
3 *****************************************************************************
4 * Copyright (C) 2010-2017 L-SMASH project
6 * Authors: Yusuke Nakamura <muken.the.vfrmaniac@gmail.com>
8 * Permission to use, copy, modify, and/or distribute this software for any
9 * purpose with or without fee is hereby granted, provided that the above
10 * copyright notice and this permission notice appear in all copies.
12 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
13 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
14 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
15 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
16 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
17 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
18 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19 *****************************************************************************/
21 /* This file is available under an ISC license. */
23 #ifndef LSMASH_BOX_H
24 #define LSMASH_BOX_H
26 /* For generating creation_time and modification_time.
27 * According to ISO/IEC-14496-5-2001, the difference between Unix time and Mac OS time is 2082758400.
28 * However this is wrong and 2082844800 is correct. */
29 #include <time.h>
30 #define ISOM_MAC_EPOCH_OFFSET 2082844800
32 #include "box_type.h"
34 /* aliases internally used only for convenience */
35 typedef struct lsmash_file_tag isom_file_abstract_t;
36 typedef struct lsmash_root_tag isom_root_abstract_t;
37 typedef struct isom_unknown_box_tag isom_unknown_t;
39 typedef struct lsmash_box_tag isom_box_t;
40 typedef struct isom_unknown_box_tag isom_unknown_box_t;
41 typedef struct isom_mdhd_tag isom_mdhd_t;
42 typedef struct isom_stbl_tag isom_stbl_t;
44 typedef void (*isom_extension_destructor_t)( void *extension_data );
45 typedef int (*isom_extension_writer_t)( lsmash_bs_t *bs, isom_box_t *box );
47 typedef int (*isom_bitrate_updater_t)( isom_stbl_t *stbl, isom_mdhd_t *mdhd, uint32_t sample_description_index );
49 /* If size is 1, then largesize is actual size.
50 * If size is 0, then this box is the last one in the file. */
51 #define ISOM_BASEBOX_COMMON \
52 const lsmash_class_t *class; \
53 lsmash_root_t *root; /* pointer to root */ \
54 lsmash_file_t *file; /* pointer to file */ \
55 isom_box_t *parent; /* pointer to the parent box of this box */ \
56 void *nonexist_ptr; /* pointer to non-existing box constant */ \
57 uint8_t *binary; /* used only when LSMASH_BINARY_CODED_BOX */ \
58 isom_extension_destructor_t destruct; /* box specific destructor */ \
59 isom_extension_writer_t write; /* box specific writer */ \
60 uint32_t manager; /* flags for L-SMASH */ \
61 uint64_t precedence; /* precedence of the box position */ \
62 uint64_t pos; /* starting position of this box in the file */ \
63 lsmash_entry_list_t extensions; /* extension boxes */ \
64 uint64_t size; /* the number of bytes in this box */ \
65 lsmash_box_type_t type
67 #define ISOM_FULLBOX_COMMON \
68 ISOM_BASEBOX_COMMON; \
69 uint8_t version; /* Basically, version is either 0 or 1 */ \
70 uint32_t flags /* In the actual structure of box, flags is 24 bits. */
72 #define ISOM_BASEBOX_COMMON_SIZE 8
73 #define ISOM_FULLBOX_COMMON_SIZE 12
74 #define ISOM_LIST_FULLBOX_COMMON_SIZE 16
76 /* flags for L-SMASH */
77 #define LSMASH_UNKNOWN_BOX 0x001
78 #define LSMASH_ABSENT_IN_FILE 0x002
79 #define LSMASH_QTFF_BASE 0x004
80 #define LSMASH_VIDEO_DESCRIPTION 0x008
81 #define LSMASH_AUDIO_DESCRIPTION 0x010
82 #define LSMASH_FULLBOX 0x020
83 #define LSMASH_LAST_BOX 0x040
84 #define LSMASH_INCOMPLETE_BOX 0x080
85 #define LSMASH_BINARY_CODED_BOX 0x100
86 #define LSMASH_PLACEHOLDER 0x200
87 #define LSMASH_WRITTEN_BOX 0x400
88 #define LSMASH_NON_EXISTING_BOX 0x800 /* This flag indicates a read only non-existing box constant.
89 * Don't use for wild boxes other than non-existing box constants
90 * because this flags prevents attempting to freeing its box. */
92 /* Use these macros for checking existences of boxes.
93 * If the result of LSMASH_IS_EXISTING_BOX is 0, the evaluated box is read only.
94 * If the result of LSMASH_IS_NON_EXISTING_BOX is 1, the evaluated box is read only. */
95 #define LSMASH_IS_EXISTING_BOX( box_ptr ) \
96 ((box_ptr) && !((box_ptr)->manager & LSMASH_NON_EXISTING_BOX))
97 #define LSMASH_IS_NON_EXISTING_BOX( box_ptr ) \
98 (!(box_ptr) || ((box_ptr)->manager & LSMASH_NON_EXISTING_BOX))
100 #define LSMASH_IS_BOX_ADDITION_SUCCESS( box_ptr ) \
101 (!((box_ptr)->manager & LSMASH_NON_EXISTING_BOX))
102 #define LSMASH_IS_BOX_ADDITION_FAILURE( box_ptr ) \
103 (!!((box_ptr)->manager & LSMASH_NON_EXISTING_BOX))
105 /* Use this macro for disabling a predefined child box in struct.
106 * Predefined childs must not be NULL for safety. */
107 #define LSMASH_MAKE_BOX_NON_EXISTING( box_ptr ) \
108 (box_ptr) = (void *)(box_ptr)->nonexist_ptr
110 /* 12-byte ISO reserved value:
111 * 0xXXXXXXXX-0011-0010-8000-00AA00389B71 */
112 static const uint8_t static_lsmash_iso_12_bytes[12]
113 = { 0x00, 0x11, 0x00, 0x10, 0x80, 0x00, 0x00, 0xAA, 0x00, 0x38, 0x9B, 0x71 };
114 #define LSMASH_ISO_12_BYTES static_lsmash_iso_12_bytes
116 /* L-SMASH original 12-byte QuickTime file format value for CODEC discrimination mainly:
117 * 0xXXXXXXXX-0F11-4DA5-BF4E-F2C48C6AA11E */
118 static const uint8_t static_lsmash_qtff_12_bytes[12]
119 = { 0x0F, 0x11, 0x4D, 0xA5, 0xBF, 0x4E, 0xF2, 0xC4, 0x8C, 0x6A, 0xA1, 0x1E };
120 #define LSMASH_QTFF_12_BYTES static_lsmash_qtff_12_bytes
122 struct lsmash_box_tag
124 ISOM_FULLBOX_COMMON;
127 /* Unknown Box
128 * This structure is for boxes we don't know or define yet.
129 * This box must be always appended as an extension box. */
130 struct isom_unknown_box_tag
132 ISOM_BASEBOX_COMMON;
133 uint32_t unknown_size;
134 uint8_t *unknown_field;
137 /* File Type Box
138 * This box identifies the specifications to which this file complies.
139 * This box shall occur before any variable-length box.
140 * In the absence of this box, the file is QuickTime file format or MP4 version 1 file format.
141 * In MP4 version 1 file format, Object Descriptor Box is mandatory.
142 * In QuickTime file format, Object Descriptor Box isn't defined.
143 * Therefore, if this box and an Object Descriptor Box are absent in the file, the file shall be QuickTime file format. */
144 typedef struct
146 ISOM_BASEBOX_COMMON;
147 uint32_t major_brand; /* brand identifier */
148 uint32_t minor_version; /* the minor version of the major brand */
149 uint32_t *compatible_brands; /* a list, to the end of the box, of brands */
151 uint32_t brand_count; /* the number of factors in compatible_brands array */
152 } isom_ftyp_t;
154 /* Color Table Box
155 * This box defines a list of preferred colors for displaying the movie on devices that support only 256 colors.
156 * The list may contain up to 256 colors. This box contains a Macintosh color table data structure.
157 * This box is defined in QuickTime File Format Specification.
158 * The color table structure is also defined in struct ColorTable defined in Quickdraw.h. */
159 typedef struct
161 /* An array of colors.
162 * Each color is made of four unsigned 16-bit integers. */
163 uint16_t value; /* index or other value
164 * Must be set to 0. */
165 /* true color */
166 uint16_t r; /* magnitude of red component */
167 uint16_t g; /* magnitude of green component */
168 uint16_t b; /* magnitude of blue component */
169 } isom_qt_color_array_t;
171 typedef struct
173 uint32_t seed; /* unique identifier for table
174 * Must be set to 0. */
175 uint16_t flags; /* high bit: 0 = PixMap; 1 = device
176 * Must be set to 0x8000. */
177 uint16_t size; /* the number of colors in the following color array
178 * This is a zero-relative value;
179 * setting this field to 0 means that there is one color in the array. */
180 isom_qt_color_array_t *array;
181 } isom_qt_color_table_t;
183 typedef struct
185 ISOM_BASEBOX_COMMON;
186 isom_qt_color_table_t color_table;
187 } isom_ctab_t;
189 /* Track Header Box
190 * This box specifies the characteristics of a single track. */
191 typedef struct
193 /* version is either 0 or 1
194 * flags
195 * 0x000001: Indicates that the track is enabled.
196 * A disabled track is treated as if it were not present.
197 * 0x000002: Indicates that the track is used in the presentation.
198 * 0x000004: Indicates that the track is used when previewing the presentation.
199 * 0x000008: Indicates that the track is used in the movie's poster. (only defined in QuickTime file format)
200 * ISOM: If in a presentation all tracks have neither track_in_movie nor track_in_preview set,
201 * then all tracks shall be treated as if both flags were set on all tracks. */
202 ISOM_FULLBOX_COMMON;
203 /* version == 0: uint64_t -> uint32_t */
204 uint64_t creation_time; /* the creation time of this track (in seconds since midnight, Jan. 1, 1904, in UTC time) */
205 uint64_t modification_time; /* the most recent time the track was modified (in seconds since midnight, Jan. 1, 1904, in UTC time) */
206 uint32_t track_ID; /* an integer that uniquely identifies the track
207 * Track IDs are never re-used and cannot be zero. */
208 uint32_t reserved1;
209 uint64_t duration; /* the duration of this track expressed in the movie timescale units */
210 /* The following fields are treated as
211 * ISOM: template fields.
212 * MP41: reserved fields.
213 * MP42: ignored fileds since compositions are done using BIFS system.
214 * 3GPP: ignored fields except for alternate_group.
215 * QTFF: usable fields. */
216 uint32_t reserved2[2];
217 int16_t layer; /* the front-to-back ordering of video tracks; tracks with lower numbers are closer to the viewer. */
218 int16_t alternate_group; /* an integer that specifies a group or collection of tracks
219 * If this field is not 0, it should be the same for tracks that contain alternate data for one another
220 * and different for tracks belonging to different such groups.
221 * Only one track within an alternate group should be played or streamed at any one time. */
222 int16_t volume; /* fixed point 8.8 number. 0x0100 is full volume. */
223 uint16_t reserved3;
224 int32_t matrix[9]; /* transformation matrix for the video */
225 /* track's visual presentation size
226 * All images in the sequence are scaled to this size, before any overall transformation of the track represented by the matrix.
227 * Note: these fields are treated as reserved in MP4 version 1. */
228 uint32_t width; /* fixed point 16.16 number */
229 uint32_t height; /* fixed point 16.16 number */
230 /* */
231 } isom_tkhd_t;
233 /* Track Clean Aperture Dimensions Box
234 * A presentation mode where clap and pasp are reflected. */
235 typedef struct
237 ISOM_FULLBOX_COMMON;
238 uint32_t width; /* fixed point 16.16 number */
239 uint32_t height; /* fixed point 16.16 number */
240 } isom_clef_t;
242 /* Track Production Aperture Dimensions Box
243 * A presentation mode where pasp is reflected. */
244 typedef struct
246 ISOM_FULLBOX_COMMON;
247 uint32_t width; /* fixed point 16.16 number */
248 uint32_t height; /* fixed point 16.16 number */
249 } isom_prof_t;
251 /* Track Encoded Pixels Dimensions Box
252 * A presentation mode where clap and pasp are not reflected. */
253 typedef struct
255 ISOM_FULLBOX_COMMON;
256 uint32_t width; /* fixed point 16.16 number */
257 uint32_t height; /* fixed point 16.16 number */
258 } isom_enof_t;
260 /* Track Aperture Mode Dimensions Box */
261 typedef struct
263 ISOM_BASEBOX_COMMON;
264 isom_clef_t *clef; /* Track Clean Aperture Dimensions Box */
265 isom_prof_t *prof; /* Track Production Aperture Dimensions Box */
266 isom_enof_t *enof; /* Track Encoded Pixels Dimensions Box */
267 } isom_tapt_t;
269 /* Edit List Box
270 * This box contains an explicit timeline map.
271 * Each entry defines part of the track timeline: by mapping part of the media timeline, or by indicating 'empty' time,
272 * or by defining a 'dwell', where a single time-point in the media is held for a period.
273 * The last edit in a track shall never be an empty edit.
274 * Any difference between the duration in the Movie Header Box, and the track's duration is expressed as an implicit empty edit at the end.
275 * It is recommended that any edits, explicit or implied, not select any portion of the composition timeline that doesn't map to a sample.
276 * Therefore, if the first sample in the track has non-zero CTS, then this track should have at least one edit and the start time in it should
277 * correspond to the value of the CTS the first sample has or more not to exceed the largest CTS in this track. */
278 typedef struct
280 /* This entry is called Timeline Mapping Edit (TME) entry in UltraViolet Common File Format.
281 * version == 0: 64bits -> 32bits */
282 uint64_t segment_duration; /* the duration of this edit expressed in the movie timescale units */
283 int64_t media_time; /* the starting composition time within the media of this edit segment
284 * If this field is set to -1, it is an empty edit. */
285 int32_t media_rate; /* the relative rate at which to play the media corresponding to this edit segment
286 * If this value is 0, then the edit is specifying a 'dwell':
287 * the media at media_time is presented for the segment_duration.
288 * This field is expressed as 16.16 fixed-point number. */
289 } isom_elst_entry_t;
291 typedef struct
293 ISOM_FULLBOX_COMMON; /* version is either 0 or 1 */
294 lsmash_entry_list_t *list;
295 } isom_elst_t;
297 /* Edit Box
298 * This optional box maps the presentation time-line to the media time-line as it is stored in the file.
299 * In the absence of this box, there is an implicit one-to-one mapping of these time-lines,
300 * and the presentation of a track starts at the beginning of the presentation. */
301 typedef struct
303 ISOM_BASEBOX_COMMON;
304 isom_elst_t *elst; /* Edit List Box */
305 } isom_edts_t;
307 /* Track Reference Box
308 * The Track Reference Box contains Track Reference Type Boxes.
309 * Track Reference Type Boxes define relationships between tracks.
310 * They allow one track to specify how it is related to other tracks. */
311 typedef struct
313 ISOM_BASEBOX_COMMON;
314 uint32_t *track_ID; /* track_IDs of reference tracks / Zero value must not be used */
316 uint32_t ref_count; /* number of reference tracks */
317 } isom_tref_type_t;
319 typedef struct
321 ISOM_BASEBOX_COMMON;
322 lsmash_entry_list_t ref_list; /* Track Reference Type Boxes */
323 } isom_tref_t;
325 /* Media Header Box
326 * This box declares overall information that is media-independent, and relevant to characteristics of the media in a track.*/
327 struct isom_mdhd_tag
329 ISOM_FULLBOX_COMMON; /* version is either 0 or 1 */
330 /* version == 0: uint64_t -> uint32_t */
331 uint64_t creation_time; /* the creation time of the media in this track (in seconds since midnight, Jan. 1, 1904, in UTC time) */
332 uint64_t modification_time; /* the most recent time the media in this track was modified (in seconds since midnight, Jan. 1, 1904, in UTC time) */
333 uint32_t timescale; /* media timescale: timescale for this media */
334 uint64_t duration; /* the duration of this media expressed in the timescale indicated in this box */
335 /* */
336 uint16_t language; /* ISOM: ISO-639-2/T language codes. Most significant 1-bit is 0.
337 * Each character is packed as the difference between its ASCII value and 0x60.
338 * QTFF: Macintosh language codes is usually used.
339 * Mac's value is less than 0x800 while ISO's value is 0x800 or greater. */
340 int16_t quality; /* ISOM: pre_defined / QTFF: the media's playback quality */
343 /* Handler Reference Box
344 * In Media Box, this box is mandatory and (ISOM: should/QTFF: must) come before Media Information Box.
345 * ISOM: this box might be also in Meta Box.
346 * QTFF: this box might be also in Media Information Box. If this box is present there, it must come before Data Information Box. */
347 typedef struct
349 ISOM_FULLBOX_COMMON;
350 uint32_t componentType; /* ISOM: pre_difined = 0
351 * QTFF: 'mhlr' for Media Handler Reference Box and 'dhlr' for Data Handler Reference Box */
352 uint32_t componentSubtype; /* Both ISOM and QT: when present in Media Handler Reference Box, this field defines the type of media data.
353 * ISOM: when present in Metadata Handler Reference Box, this field defines the format of the meta box contents.
354 * QTFF: when present in Data Handler Reference Box, this field defines the data reference type. */
355 /* The following fields are defined in QTFF however these fields aren't mentioned in QuickTime SDK and are reserved in the specification.
356 * In ISOM, these fields are still defined as reserved. */
357 uint32_t componentManufacturer; /* vendor indentification / A value of 0 matches any manufacturer. */
358 uint32_t componentFlags; /* flags describing required component capabilities
359 * The high-order 8 bits should be set to 0.
360 * The low-order 24 bits are specific to each component type. */
361 uint32_t componentFlagsMask; /* This field indicates which flags in the componentFlags field are relevant to this operation. */
362 /* */
363 uint8_t *componentName; /* ISOM: a null-terminated string in UTF-8 characters
364 * QTFF: Pascal string */
366 uint32_t componentName_length;
367 } isom_hdlr_t;
370 /** Media Information Header Boxes
371 ** There is a different media information header for each track type
372 ** (corresponding to the media handler-type); the matching header shall be present. **/
373 /* Video Media Header Box
374 * This box contains general presentation information, independent of the coding, for video media. */
375 typedef struct
377 ISOM_FULLBOX_COMMON; /* flags is 1 */
378 uint16_t graphicsmode; /* template: graphicsmode = 0 */
379 uint16_t opcolor[3]; /* template: opcolor = { 0, 0, 0 } */
380 } isom_vmhd_t;
382 /* Sound Media Header Box
383 * This box contains general presentation information, independent of the coding, for audio media. */
384 typedef struct
386 ISOM_FULLBOX_COMMON;
387 int16_t balance; /* a fixed-point 8.8 number that places mono audio tracks in a stereo space. template: balance = 0 */
388 uint16_t reserved;
389 } isom_smhd_t;
391 /* Hint Media Header Box
392 * This box contains general information, independent of the protocol, for hint tracks. (A PDU is a Protocol Data Unit.) */
393 typedef struct
395 ISOM_FULLBOX_COMMON;
396 uint16_t maxPDUsize; /* the size in bytes of the largest PDU in this (hint) stream */
397 uint16_t avgPDUsize; /* the average size of a PDU over the entire presentation */
398 uint32_t maxbitrate; /* the maximum rate in bits/second over any window of one second */
399 uint32_t avgbitrate; /* the average rate in bits/second over the entire presentation */
400 uint32_t reserved;
401 } isom_hmhd_t;
403 /* Null Media Header Box
404 * This box may be used for streams other than visual and audio (e.g., timed metadata streams). */
405 typedef struct
407 /* Streams other than visual and audio may use a Null Media Header Box */
408 ISOM_FULLBOX_COMMON; /* flags is currently all zero */
409 } isom_nmhd_t;
411 /* Generic Media Information Box */
412 typedef struct
414 ISOM_FULLBOX_COMMON;
415 uint16_t graphicsmode;
416 uint16_t opcolor[3];
417 int16_t balance; /* This field is nomally set to 0. */
418 uint16_t reserved; /* Reserved for use by Apple. Set this field to 0. */
419 } isom_gmin_t;
421 /* Text Media Information Box */
422 typedef struct
424 ISOM_BASEBOX_COMMON;
425 int32_t matrix[9]; /* Unkown fields. Default values are probably:
426 * { 0x00010000, 0, 0, 0, 0x00010000, 0, 0, 0, 0x40000000 } */
427 } isom_text_t;
429 /* Generic Media Information Header Box */
430 typedef struct
432 ISOM_BASEBOX_COMMON;
433 isom_gmin_t *gmin; /* Generic Media Information Box */
434 isom_text_t *text; /* Text Media Information Box */
435 } isom_gmhd_t;
436 /** **/
438 /* Data Reference Box
439 * name and location fields are expressed in null-terminated string using UTF-8 characters. */
440 typedef struct
442 /* This box is DataEntryUrlBox or DataEntryUrnBox */
443 ISOM_FULLBOX_COMMON; /* flags == 0x000001 means that the media data is in the same file
444 * as the Movie Box containing this data reference. */
445 char *name; /* only for DataEntryUrnBox */
446 char *location; /* a location to find the resource with the given name */
448 uint32_t name_length;
449 uint32_t location_length;
450 lsmash_file_t *ref_file; /* pointer to the handle of the referenced file */
451 } isom_dref_entry_t;
453 typedef struct
455 ISOM_FULLBOX_COMMON;
456 lsmash_entry_list_t list;
457 } isom_dref_t;
459 /* Data Information Box */
460 typedef struct
462 /* This box is in Media Information Box or Meta Box */
463 ISOM_BASEBOX_COMMON;
464 isom_dref_t *dref; /* Data Reference Box */
465 } isom_dinf_t;
467 /** Sample Description **/
468 /* ES Descriptor Box */
469 struct mp4sys_ES_Descriptor_t; /* FIXME: I think these structs using mp4sys should be placed in isom.c */
470 typedef struct
472 ISOM_FULLBOX_COMMON;
473 struct mp4sys_ES_Descriptor_t *ES;
474 } isom_esds_t;
476 /* MPEG-4 Bit Rate Box
477 * This box signals the bit rate information of the AVC video stream. */
478 typedef struct
480 ISOM_BASEBOX_COMMON;
481 uint32_t bufferSizeDB; /* the size of the decoding buffer for the elementary stream in bytes */
482 uint32_t maxBitrate; /* the maximum rate in bits/second over any window of one second */
483 uint32_t avgBitrate; /* the average rate in bits/second over the entire presentation */
484 } isom_btrt_t;
486 /* Global Header Box */
487 typedef struct
489 ISOM_BASEBOX_COMMON;
490 uint32_t header_size;
491 uint8_t *header_data;
492 } isom_glbl_t;
494 /* Clean Aperture Box
495 * There are notionally four values in this box and these parameters are represented as a fraction N/D.
496 * Here, we refer to the pair of parameters fooN and fooD as foo.
497 * Considering the pixel dimensions as defined by the VisualSampleEntry width and height.
498 * If picture centre of the image is at pcX and pcY, then horizOff and vertOff are defined as follows:
499 * pcX = horizOff + (width - 1)/2;
500 * pcY = vertOff + (height - 1)/2;
501 * The leftmost/rightmost pixel and the topmost/bottommost line of the clean aperture fall at:
502 * pcX +/- (cleanApertureWidth - 1)/2;
503 * pcY +/- (cleanApertureHeight - 1)/2;
504 * QTFF: this box is a mandatory extension for all uncompressed Y'CbCr data formats. */
505 typedef struct
507 ISOM_BASEBOX_COMMON;
508 uint32_t cleanApertureWidthN;
509 uint32_t cleanApertureWidthD;
510 uint32_t cleanApertureHeightN;
511 uint32_t cleanApertureHeightD;
512 int32_t horizOffN;
513 uint32_t horizOffD;
514 int32_t vertOffN;
515 uint32_t vertOffD;
516 } isom_clap_t;
518 /* Pixel Aspect Ratio Box
519 * This box specifies the aspect ratio of a pixel, in arbitrary units.
520 * If a pixel appears H wide and V tall, then hSpacing/vSpacing is equal to H/V.
521 * When adjusting pixel aspect ratio, normally, the horizontal dimension of the video is scaled, if needed. */
522 typedef struct
524 ISOM_BASEBOX_COMMON;
525 uint32_t hSpacing; /* horizontal spacing */
526 uint32_t vSpacing; /* vertical spacing */
527 } isom_pasp_t;
529 /* ISOM: Colour Information Box / QTFF: Color Parameter Box
530 * This box is used to map the numerical values of pixels in the file to a common representation of color
531 * in which images can be correctly compared, combined, and displayed.
532 * If colour information is supplied in both this box, and also in the video bitstream,
533 * this box takes precedence, and over-rides the information in the bitstream.
534 * For QuickTime file format:
535 * This box ('colr') supersedes the Gamma Level Box ('gama').
536 * Writers of QTFF should never write both into an Image Description, and readers of QTFF should ignore 'gama' if 'colr' is present.
537 * Note: this box is a mandatory extension for all uncompressed Y'CbCr data formats.
538 * For ISO Base Media file format:
539 * Colour information may be supplied in one or more Colour Information Boxes placed in a VisualSampleEntry.
540 * These should be placed in order in the sample entry starting with the most accurate (and potentially the most difficult to process), in progression to the least.
541 * These are advisory and concern rendering and colour conversion, and there is no normative behaviour associated with them; a reader may choose to use the most suitable. */
542 typedef struct
544 ISOM_BASEBOX_COMMON;
545 uint32_t color_parameter_type; /* QTFF: 'nclc' or 'prof'
546 * ISOM: 'nclx', 'rICC' or 'prof' */
547 /* for 'nclc' and 'nclx' */
548 uint16_t primaries_index; /* CIE 1931 xy chromaticity coordinates */
549 uint16_t transfer_function_index; /* nonlinear transfer function from RGB to ErEgEb */
550 uint16_t matrix_index; /* matrix from ErEgEb to EyEcbEcr */
551 /* for 'nclx' */
552 unsigned full_range_flag : 1;
553 unsigned reserved : 7;
554 } isom_colr_t;
556 /* Gamma Level Box
557 * This box is used to indicate that the decompressor corrects gamma level at display time.
558 * This box is defined in QuickTime File Format Specification and ImageCompression.h. */
559 typedef struct
561 ISOM_BASEBOX_COMMON;
562 uint32_t level; /* A fixed-point 16.16 number indicating the gamma level at which the image was captured.
563 * Zero value indicates platform's standard gamma. */
564 } isom_gama_t;
566 /* Field/Frame Information Box
567 * This box is used by applications to modify decompressed image data or by decompressor components to determine field display order.
568 * This box is defined in QuickTime File Format Specification, dispatch019 and ImageCodec.h.
569 * Note: this box is a mandatory extension for all uncompressed Y'CbCr data formats. */
570 typedef struct
572 ISOM_BASEBOX_COMMON;
573 uint8_t fields; /* the number of fields per frame
574 * 1: progressive scan
575 * 2: 2:1 interlaced */
576 uint8_t detail; /* field ordering */
577 } isom_fiel_t;
579 /* Colorspace Box
580 * This box is defined in ImageCompression.h. */
581 typedef struct
583 ISOM_BASEBOX_COMMON;
584 uint32_t pixel_format; /* the native pixel format of an image */
585 } isom_cspc_t;
587 /* Significant Bits Box
588 * This box is defined in Letters from the Ice Floe dispatch019.
589 * Note: this box is a mandatory extension for 'v216' (Uncompressed Y'CbCr, 10, 12, 14, or 16-bit-per-component 4:2:2). */
590 typedef struct
592 ISOM_BASEBOX_COMMON;
593 uint8_t significantBits; /* the number of significant bits per component */
594 } isom_sgbt_t;
596 /* Sample Scale Box
597 * If this box is present and can be interpreted by the decoder,
598 * all samples shall be displayed according to the scaling behaviour that is specified in this box.
599 * Otherwise, all samples are scaled to the size that is indicated by the width and height field in the Track Header Box.
600 * This box is defined in ISO Base Media file format. */
601 typedef struct
603 ISOM_FULLBOX_COMMON;
604 uint8_t constraint_flag; /* Upper 7-bits are reserved.
605 * If this flag is set, all samples described by this sample entry shall be scaled
606 * according to the method specified by the field 'scale_method'. */
607 uint8_t scale_method; /* The semantics of the values for scale_method are as specified for the 'fit' attribute of regions in SMIL 1.0. */
608 int16_t display_center_x;
609 int16_t display_center_y;
610 } isom_stsl_t;
612 /* Sample Entry */
613 #define ISOM_SAMPLE_ENTRY \
614 ISOM_BASEBOX_COMMON; \
615 uint8_t reserved[6]; \
616 uint16_t data_reference_index
618 typedef struct
620 ISOM_SAMPLE_ENTRY;
621 } isom_sample_entry_t;
623 /* Mpeg Sample Entry */
624 typedef struct
626 ISOM_SAMPLE_ENTRY;
627 } isom_mp4s_entry_t;
629 /* ISOM: Visual Sample Entry / QTFF: Image Description
630 * For maximum compatibility, the following extension boxes should follow, not precede,
631 * any extension boxes defined in or required by derived specifications.
632 * Clean Aperture Box
633 * Pixel Aspect Ratio Box */
634 typedef struct
636 ISOM_SAMPLE_ENTRY;
637 int16_t version; /* ISOM: pre_defined / QTFF: sample description version */
638 int16_t revision_level; /* ISOM: reserved / QTFF: version of the CODEC */
639 int32_t vendor; /* ISOM: pre_defined / QTFF: whose CODEC */
640 uint32_t temporalQuality; /* ISOM: pre_defined / QTFF: the temporal quality factor */
641 uint32_t spatialQuality; /* ISOM: pre_defined / QTFF: the spatial quality factor */
642 /* The width and height are the maximum pixel counts that the codec will deliver.
643 * Since these are counts they do not take into account pixel aspect ratio. */
644 uint16_t width;
645 uint16_t height;
646 /* */
647 uint32_t horizresolution; /* 16.16 fixed-point / template: horizresolution = 0x00480000 / 72 dpi */
648 uint32_t vertresolution; /* 16.16 fixed-point / template: vertresolution = 0x00480000 / 72 dpi */
649 uint32_t dataSize; /* ISOM: reserved / QTFF: if known, the size of data for this descriptor */
650 uint16_t frame_count; /* frame per sample / template: frame_count = 1 */
651 char compressorname[33]; /* a fixed 32-byte field, with the first byte set to the number of bytes to be displayed */
652 uint16_t depth; /* ISOM: template: depth = 0x0018
653 * AVC : 0x0018: colour with no alpha
654 * 0x0028: grayscale with no alpha
655 * 0x0020: gray or colour with alpha
656 * QTFF: depth of this data (1-32) or (33-40 grayscale) */
657 int16_t color_table_ID; /* ISOM: template: pre_defined = -1
658 * QTFF: color table ID
659 * If this field is set to -1, the default color table should be used for the specified depth
660 * If the color table ID is set to 0, a color table is contained within the sample description itself.
661 * The color table immediately follows the color table ID field. */
662 /* Color table follows color_table_ID only when color_table_ID is set to 0. */
663 isom_qt_color_table_t color_table; /* a list of preferred colors for displaying the movie on devices that support only 256 colors */
664 } isom_visual_entry_t;
666 /* Format Box
667 * This box shows the data format of the stored sound media.
668 * ISO base media file format also defines the same four-character-code for the type field,
669 * however, that is used to indicate original sample description of the media when a protected sample entry is used. */
670 typedef struct
672 ISOM_BASEBOX_COMMON;
673 uint32_t data_format; /* copy of sample description type */
674 } isom_frma_t;
676 /* Audio Endian Box */
677 typedef struct
679 ISOM_BASEBOX_COMMON;
680 int16_t littleEndian;
681 } isom_enda_t;
683 /* MPEG-4 Audio Box */
684 typedef struct
686 ISOM_BASEBOX_COMMON;
687 uint32_t unknown; /* always 0? */
688 } isom_mp4a_t;
690 /* Terminator Box
691 * This box is present to indicate the end of the sound description. It contains no data. */
692 typedef struct
694 ISOM_BASEBOX_COMMON; /* size = 8, type = 0x00000000 */
695 } isom_terminator_t;
697 /* Sound Information Decompression Parameters Box
698 * This box is defined in QuickTime file format.
699 * This box provides the ability to store data specific to a given audio decompressor in the sound description.
700 * The contents of this box are dependent on the audio decompressor. */
701 typedef struct
703 ISOM_BASEBOX_COMMON;
704 isom_frma_t *frma; /* Format Box */
705 isom_enda_t *enda; /* Audio Endian Box */
706 isom_mp4a_t *mp4a; /* MPEG-4 Audio Box */
707 isom_terminator_t *terminator; /* Terminator Box */
708 } isom_wave_t;
710 /* Audio Channel Layout Box
711 * This box is defined in QuickTime file format or Apple Lossless Audio inside ISO Base Media. */
712 typedef struct
714 uint32_t channelLabel; /* the channelLabel that describes the channel */
715 uint32_t channelFlags; /* flags that control the interpretation of coordinates */
716 uint32_t coordinates[3]; /* an ordered triple that specifies a precise speaker location / 32-bit floating point */
717 } isom_channel_description_t;
719 typedef struct
721 ISOM_FULLBOX_COMMON;
722 uint32_t channelLayoutTag; /* the channelLayoutTag indicates the layout */
723 uint32_t channelBitmap; /* If channelLayoutTag is set to 0x00010000, this field is the channel usage bitmap. */
724 uint32_t numberChannelDescriptions; /* the number of items in the Channel Descriptions array */
725 /* Channel Descriptions array */
726 isom_channel_description_t *channelDescriptions;
727 } isom_chan_t;
729 /* Sampling Rate Box
730 * This box may be present only in an AudioSampleEntryV1, and when present,
731 * it overrides the samplerate field and documents the actual sampling rate.
732 * When this box is present, the media timescale should be the same as the
733 * sampling rate, or an integer division or multiple of it. */
734 typedef struct
736 ISOM_FULLBOX_COMMON;
737 uint32_t sampling_rate; /* the actual sampling rate of the audio media, expressed as a 32-bit integer
738 * The value of this field overrides the samplerate field in the AudioSampleEntryV1
739 * and documents the actual sampling rate. */
740 } isom_srat_t;
742 /* ISOM: Audio Sample Entry / QTFF: Sound Description */
743 typedef struct
745 ISOM_SAMPLE_ENTRY;
746 int16_t version; /* ISOM: version = 0 is used to support non-high samplerate audio format.
747 * version = 1, called AudioSampleEntryV1, is used to support high samplerate audio format.
748 * An AudioSampleEntryV1 requires that the enclosing Sample Description Box also takes the version 1.
749 * For maximum compatibility, an AudioSampleEntryV1 should only be used when needed.
750 * QTFF: version = 0 supports only 'raw ' or 'twos' audio format.
751 * version = 1 is used to support out-of-band configuration settings for decompression.
752 * version = 2 is used to support high samplerate, or 3 or more multichannel audio format. */
753 int16_t revision_level; /* ISOM: reserved / QTFF: version of the CODEC */
754 int32_t vendor; /* ISOM: reserved / QTFF: whose CODEC */
755 uint16_t channelcount; /* ISOM: template: channelcount = 2
756 * channelcount is a value greater than zero that indicates the maximum number of channels that the
757 * audio could deliver.
758 * A channelcount of 1 indicates mono audio, and 2 indicates stereo (left/right).
759 * When values greater than 2 are used, the codec configuration should identify the channel assignment.
760 * QTFF: the number of audio channels
761 * Allowable values are 1 (mono) or 2 (stereo).
762 * For more than 2, set this field to 3 and use numAudioChannels instead of this field. */
763 uint16_t samplesize; /* ISOM: template: samplesize = 16
764 * QTFF: the number of bits in each uncompressed sample for a single channel
765 * Allowable values are 8 or 16.
766 * For non-mod8, set this field to 16 and use constBitsPerChannel instead of this field.
767 * For more than 16, set this field to 16 and use bytesPerPacket instead of this field. */
768 int16_t compression_ID; /* ISOM: pre_defined
769 * QTFF: version = 0 -> must be set to 0.
770 * version = 2 -> must be set to -2. */
771 uint16_t packet_size; /* ISOM: reserved / QTFF: must be set to 0. */
772 uint32_t samplerate; /* the sampling rate expressed as a 16.16 fixed-point number
773 * ISOM: template: samplerate = {default samplerate of media}<<16
774 * When it is desired to indicate an audio sampling rate greater than the value that can be represented in
775 * this field, this field should contain a value left-shifted 16 bits that matches the media timescale,
776 * or be an integer division or multiple of it.
777 * QTFF: the integer portion should match the media's timescale.
778 * If this field is invalid because of higher samplerate,
779 * then set this field to 0x00010000 and use audioSampleRate instead of this field. */
780 /* QTFF-based version 1 fields
781 * These fields are for description of the compression ratio of fixed ratio audio compression algorithms.
782 * If these fields are not used, they are set to 0. */
783 uint32_t samplesPerPacket; /* For compressed audio, be set to the number of uncompressed frames generated by a compressed frame.
784 * For uncompressed audio, shall be set to 1. */
785 uint32_t bytesPerPacket; /* the number of bytes in a sample for a single channel */
786 uint32_t bytesPerFrame; /* the number of bytes in a frame */
787 uint32_t bytesPerSample; /* 8-bit audio: 1, other audio: 2 */
788 /* QTFF-based version 2 fields
789 * LPCMFrame: one sample from each channel.
790 * AudioPacket: For uncompressed audio, an AudioPacket is simply one LPCMFrame.
791 * For compressed audio, an AudioPacket is the natural compressed access unit of that format. */
792 uint32_t sizeOfStructOnly; /* offset to extensions */
793 uint64_t audioSampleRate; /* 64-bit floating point */
794 uint32_t numAudioChannels; /* any channel assignment info will be in Audio Channel Layout Box. */
795 int32_t always7F000000; /* always 0x7F000000 */
796 uint32_t constBitsPerChannel; /* only set if constant (and only for uncompressed audio) */
797 uint32_t formatSpecificFlags;
798 uint32_t constBytesPerAudioPacket; /* only set if constant */
799 uint32_t constLPCMFramesPerAudioPacket; /* only set if constant */
800 } isom_audio_entry_t;
802 /* Hint Sample Entry */
803 #define ISOM_HINT_SAMPLE_ENTRY \
804 ISOM_SAMPLE_ENTRY; \
805 uint8_t *data
807 typedef struct
809 ISOM_HINT_SAMPLE_ENTRY;
810 uint32_t data_length;
811 } isom_hint_entry_t;
813 /* Metadata Sample Entry */
814 #define ISOM_METADATA_SAMPLE_ENTRY \
815 ISOM_SAMPLE_ENTRY
817 typedef struct
819 ISOM_METADATA_SAMPLE_ENTRY;
820 } isom_metadata_entry_t;
822 /* QuickTime Text Sample Description */
823 typedef struct
825 ISOM_SAMPLE_ENTRY;
826 int32_t displayFlags;
827 int32_t textJustification;
828 uint16_t bgColor[3]; /* background RGB color */
829 /* defaultTextBox */
830 int16_t top;
831 int16_t left;
832 int16_t bottom;
833 int16_t right;
834 /* defaultStyle */
835 int32_t scrpStartChar; /* starting character position */
836 int16_t scrpHeight;
837 int16_t scrpAscent;
838 int16_t scrpFont;
839 uint16_t scrpFace; /* only first 8-bits are used */
840 int16_t scrpSize;
841 uint16_t scrpColor[3]; /* foreground RGB color */
842 /* defaultFontName is Pascal string */
843 uint8_t font_name_length;
844 char *font_name;
845 } isom_qt_text_entry_t;
847 /* FontRecord */
848 typedef struct
850 uint16_t font_ID;
851 /* Pascal string */
852 uint8_t font_name_length;
853 char *font_name;
854 } isom_font_record_t;
856 /* Font Table Box */
857 typedef struct
859 ISOM_BASEBOX_COMMON;
860 /* FontRecord
861 * entry_count is uint16_t. */
862 lsmash_entry_list_t *list;
863 } isom_ftab_t;
865 /* 3GPP Timed Text Sample Entry */
866 typedef struct
868 ISOM_SAMPLE_ENTRY;
869 uint32_t displayFlags;
870 int8_t horizontal_justification;
871 int8_t vertical_justification;
872 uint8_t background_color_rgba[4];
873 /* BoxRecord default_text_box */
874 int16_t top;
875 int16_t left;
876 int16_t bottom;
877 int16_t right;
878 /* StyleRecord default_style */
879 uint16_t startChar; /* always 0 */
880 uint16_t endChar; /* always 0 */
881 uint16_t font_ID;
882 uint8_t face_style_flags;
883 uint8_t font_size;
884 uint8_t text_color_rgba[4];
885 /* Font Table Box font_table */
886 isom_ftab_t *ftab;
887 } isom_tx3g_entry_t;
889 /* Sample Description Box */
890 typedef struct
892 ISOM_FULLBOX_COMMON;
893 uint32_t entry_count; /* print only */
894 lsmash_entry_list_t list;
895 } isom_stsd_t;
896 /** **/
898 /* Decoding Time to Sample Box
899 * This box contains a compact version of a table that allows indexing from decoding time to sample number.
900 * Each entry in the table gives the number of consecutive samples with the same time delta, and the delta of those samples.
901 * By adding the deltas a complete time-to-sample map may be built.
902 * All samples must have non-zero durations except for the last one.
903 * The sum of all deltas gives the media duration in the track (not mapped to the movie timescale, and not considering any edit list).
904 * DTS is an abbreviation of 'decoding time stamp'. */
905 typedef struct
907 uint32_t sample_count; /* number of consecutive samples that have the given sample_delta */
908 uint32_t sample_delta; /* DTS[0] = 0; DTS[n+1] = DTS[n] + sample_delta[n]; */
909 } isom_stts_entry_t;
911 typedef struct
913 ISOM_FULLBOX_COMMON;
914 lsmash_entry_list_t *list;
915 } isom_stts_t;
917 /* Composition Time to Sample Box
918 * This box provides the offset between decoding time and composition time.
919 * CTS is an abbreviation of 'composition time stamp'.
920 * This box is optional and must only be present if DTS and CTS differ for any samples. */
921 typedef struct
923 #define ISOM_NON_OUTPUT_SAMPLE_OFFSET 0x80000000
924 uint32_t sample_count; /* number of consecutive samples that have the given sample_offset */
925 uint32_t sample_offset; /* CTS[n] = DTS[n] + sample_offset[n];
926 * ISOM: if version is set to 1, sample_offset is signed 32-bit integer.
927 * QTFF: sample_offset is always signed 32-bit integer. */
928 } isom_ctts_entry_t;
930 typedef struct
932 ISOM_FULLBOX_COMMON;
933 lsmash_entry_list_t *list;
934 } isom_ctts_t;
936 /* Composition to Decode Box (Composition Shift Least Greatest Box)
937 * This box may be used to relate the composition and decoding timelines,
938 * and deal with some of the ambiguities that signed composition offsets introduce. */
939 typedef struct
941 ISOM_FULLBOX_COMMON;
942 int32_t compositionToDTSShift; /* If this value is added to the composition times (as calculated by the CTS offsets from the DTS),
943 * then for all samples, their CTS is guaranteed to be greater than or equal to their DTS,
944 * and the buffer model implied by the indicated profile/level will be honoured;
945 * if leastDecodeToDisplayDelta is positive or zero, this field can be 0;
946 * otherwise it should be at least (- leastDecodeToDisplayDelta). */
947 int32_t leastDecodeToDisplayDelta; /* the smallest sample_offset in this track */
948 int32_t greatestDecodeToDisplayDelta; /* the largest sample_offset in this track */
949 int32_t compositionStartTime; /* the smallest CTS for any sample */
950 int32_t compositionEndTime; /* the CTS plus the composition duration, of the sample with the largest CTS in this track */
951 } isom_cslg_t;
953 /* Sample Size Box / Compact Sample Size Box
954 * This box contains the sample count and a table giving the size in bytes of each sample.
955 * The total number of samples in the media within the initial movie is always indicated in the sample_count.
956 * Note: a sample size of zero is not prohibited in general, but it must be valid and defined for the coding system,
957 * as defined by the sample entry, that the sample belongs to. */
958 typedef struct
960 uint32_t entry_size; /* the size of a sample */
961 } isom_stsz_entry_t;
963 typedef struct
965 ISOM_FULLBOX_COMMON;
966 uint32_t sample_size; /* the default sample size
967 * If this field is set to 0, then the samples have different sizes. */
968 uint32_t sample_count; /* the number of samples in the media within the initial movie */
969 lsmash_entry_list_t *list; /* available if sample_size == 0 */
970 } isom_stsz_t;
972 typedef struct
974 ISOM_FULLBOX_COMMON;
975 unsigned int reserved : 24; /* 0 */
976 unsigned int field_size : 8; /* the size in bits of the entries in the following table
977 * It shall take the value 4, 8 or 16. If the value 4 is used, then each byte contains two values
978 * entry[i]<<4 + entry[i+1]; if the sizes do not fill an integral number of bytes, the last byte is
979 * padded with zero. */
980 uint32_t sample_count; /* the number of entries in the following table */
981 lsmash_entry_list_t *list; /* L-SMASH uses isom_stsz_entry_t for its internal processes. */
982 } isom_stz2_t;
984 /* Sync Sample Box
985 * If this box is not present, every sample is a random access point.
986 * In AVC streams, this box cannot point non-IDR samples.
987 * The table is arranged in strictly increasing order of sample number. */
988 typedef struct
990 uint32_t sample_number; /* the numbers of the samples that are random access points in the stream. */
991 } isom_stss_entry_t;
993 typedef struct
995 ISOM_FULLBOX_COMMON;
996 lsmash_entry_list_t *list;
997 } isom_stss_t;
999 /* Partial Sync Sample Box
1000 * Tip from QT engineering - Open-GOP intra frames need to be marked as "partial sync samples".
1001 * Partial sync frames perform a partial reset of inter-frame dependencies;
1002 * decoding two partial sync frames and the non-droppable difference frames between them is
1003 * sufficient to prepare a decompressor for correctly decoding the difference frames that follow. */
1004 typedef struct
1006 uint32_t sample_number; /* the numbers of the samples that are partial sync samples in the stream. */
1007 } isom_stps_entry_t;
1009 typedef struct
1011 ISOM_FULLBOX_COMMON;
1012 lsmash_entry_list_t *list;
1013 } isom_stps_t;
1015 /* Independent and Disposable Samples Box */
1016 typedef struct
1018 unsigned is_leading : 2; /* ISOM: leading / QTFF: samples later in decode order may have earlier display times */
1019 unsigned sample_depends_on : 2; /* independency */
1020 unsigned sample_is_depended_on : 2; /* disposable */
1021 unsigned sample_has_redundancy : 2; /* redundancy */
1022 } isom_sdtp_entry_t;
1024 typedef struct
1026 ISOM_FULLBOX_COMMON;
1027 /* According to the specification, the size of the table, sample_count, doesn't exist in this box.
1028 * Instead of this, it is taken from the sample_count in the stsz or the stz2 box. */
1029 lsmash_entry_list_t *list;
1030 } isom_sdtp_t;
1032 /* Sample To Chunk Box
1033 * This box can be used to find the chunk that contains a sample, its position, and the associated sample description.
1034 * The table is compactly coded. Each entry gives the index of the first chunk of a run of chunks with the same characteristics.
1035 * By subtracting one entry here from the previous one, you can compute how many chunks are in this run.
1036 * You can convert this to a sample count by multiplying by the appropriate samples_per_chunk. */
1037 typedef struct
1039 uint32_t first_chunk; /* the index of the first chunk in this run of chunks that share the same samples_per_chunk and sample_description_index */
1040 uint32_t samples_per_chunk; /* the number of samples in each of these chunks */
1041 uint32_t sample_description_index; /* the index of the sample entry that describes the samples in this chunk */
1042 } isom_stsc_entry_t;
1044 typedef struct
1046 ISOM_FULLBOX_COMMON;
1047 lsmash_entry_list_t *list;
1048 } isom_stsc_t;
1050 /* Chunk Offset Box
1051 * chunk_offset is the offset of the start of a chunk into its containing media file.
1052 * Offsets are file offsets, not the offset into any box within the file. */
1053 typedef struct
1055 uint32_t chunk_offset;
1056 } isom_stco_entry_t;
1058 typedef struct
1060 /* for large presentations */
1061 uint64_t chunk_offset;
1062 } isom_co64_entry_t;
1064 typedef struct
1066 ISOM_FULLBOX_COMMON; /* type = 'stco': 32-bit chunk offsets / type = 'co64': 64-bit chunk offsets */
1067 lsmash_entry_list_t *list;
1069 uint8_t large_presentation; /* Set 1 to this if 64-bit chunk-offset are needed. */
1070 } isom_stco_t; /* share with co64 box */
1072 /* Sample Group Description Box
1073 * This box gives information about the characteristics of sample groups. */
1074 typedef struct
1076 ISOM_FULLBOX_COMMON; /* Use of version 0 entries is deprecated. */
1077 uint32_t grouping_type; /* an integer that identifies the sbgp that is associated with this sample group description */
1078 uint32_t default_length; /* the length of every group entry (if the length is constant), or zero (if it is variable)
1079 * This field is available only if version == 1. */
1080 lsmash_entry_list_t *list;
1081 } isom_sgpd_t;
1083 /* Random Access Entry
1084 * Samples marked by this group must be random access points, and may also be sync points. */
1085 typedef struct
1087 /* grouping_type is 'rap ' */
1088 uint32_t description_length; /* This field is available only if version == 1 and default_length == 0. */
1089 unsigned num_leading_samples_known : 1; /* the value of one indicates that the number of leading samples is known for each sample in this group,
1090 * and the number is specified by num_leading_samples. */
1091 unsigned num_leading_samples : 7; /* the number of leading samples for each sample in this group
1092 * Note: when num_leading_samples_known is equal to 0, this field should be ignored. */
1093 } isom_rap_entry_t;
1095 /* Roll Recovery Entry
1096 * This grouping type is defined as that group of samples having the same roll distance. */
1097 typedef struct
1099 /* grouping_type is 'roll' */
1100 uint32_t description_length; /* This field is available only if version == 1 and default_length == 0. */
1101 int16_t roll_distance; /* the number of samples that must be decoded in order for a sample to be decoded correctly
1102 * A positive value indicates post-roll, and a negative value indicates pre-roll.
1103 * The value zero must not be used. */
1104 } isom_roll_entry_t;
1106 /* Sample to Group Box
1107 * This box is used to find the group that a sample belongs to and the associated description of that sample group. */
1108 typedef struct
1110 ISOM_FULLBOX_COMMON;
1111 uint32_t grouping_type; /* Links it to its sample group description table with the same value for grouping type. */
1112 uint32_t grouping_type_parameter; /* an indication of the sub-type of the grouping
1113 * This field is available only if version == 1. */
1114 lsmash_entry_list_t *list;
1115 } isom_sbgp_t;
1117 typedef struct
1119 uint32_t sample_count; /* the number of consecutive samples with the same sample group descriptor */
1120 uint32_t group_description_index; /* the index of the sample group entry which describes the samples in this group
1121 * The index ranges from 1 to the number of sample group entries in the Sample Group Description Box,
1122 * or takes the value 0 to indicate that this sample is a member of no group of this type.
1123 * Within the Sample to Group Box in movie fragment, the group description indexes for groups defined
1124 * within the same fragment start at 0x10001, i.e. the index value 1, with the value 1 in the top 16 bits. */
1125 } isom_group_assignment_entry_t;
1127 /* Sample Table Box */
1128 struct isom_stbl_tag
1130 ISOM_BASEBOX_COMMON;
1131 isom_stsd_t *stsd; /* Sample Description Box */
1132 isom_stts_t *stts; /* Decoding Time to Sample Box */
1133 isom_ctts_t *ctts; /* Composition Time to Sample Box */
1134 isom_cslg_t *cslg; /* ISOM: Composition to Decode Box / QTFF: Composition Shift Least Greatest Box */
1135 isom_stss_t *stss; /* Sync Sample Box */
1136 isom_stps_t *stps; /* ISOM: null / QTFF: Partial Sync Sample Box */
1137 isom_sdtp_t *sdtp; /* Independent and Disposable Samples Box */
1138 isom_stsc_t *stsc; /* Sample To Chunk Box */
1139 isom_stsz_t *stsz; /* Sample Size Box */
1140 isom_stz2_t *stz2; /* Compact Sample Size Box */
1141 isom_stco_t *stco; /* Chunk Offset Box */
1142 lsmash_entry_list_t sgpd_list; /* Sample Group Description Boxes */
1143 lsmash_entry_list_t sbgp_list; /* Sample To Group Boxes */
1145 /* Use 'stz2' instead of 'stsz' if possible. (write mode only) */
1146 int (*compress_sample_size_table)( isom_stbl_t *stbl );
1147 /* Add independent and disposable info for each sample if possible. (write mode only) */
1148 int (*add_dependency_type)( isom_stbl_t *stbl, lsmash_file_t *file, lsmash_sample_property_t *prop );
1151 /* Media Information Box */
1152 typedef struct
1154 ISOM_BASEBOX_COMMON;
1155 /* Media Information Header Boxes */
1156 isom_vmhd_t *vmhd; /* Video Media Header Box */
1157 isom_smhd_t *smhd; /* Sound Media Header Box */
1158 isom_hmhd_t *hmhd; /* ISOM: Hint Media Header Box / QTFF: null */
1159 isom_nmhd_t *nmhd; /* ISOM: Null Media Header Box / QTFF: null */
1160 isom_gmhd_t *gmhd; /* ISOM: null / QTFF: Generic Media Information Header Box */
1161 /* */
1162 isom_hdlr_t *hdlr; /* ISOM: null / QTFF: Data Handler Reference Box
1163 * Note: this box must come before Data Information Box. */
1164 isom_dinf_t *dinf; /* Data Information Box */
1165 isom_stbl_t *stbl; /* Sample Table Box */
1166 } isom_minf_t;
1168 /* Media Box */
1169 typedef struct
1171 ISOM_BASEBOX_COMMON;
1172 isom_mdhd_t *mdhd; /* Media Header Box */
1173 isom_hdlr_t *hdlr; /* ISOM: Handler Reference Box / QTFF: Media Handler Reference Box
1174 * Note: this box must come before Media Information Box. */
1175 isom_minf_t *minf; /* Media Information Box */
1176 } isom_mdia_t;
1178 /* Movie Header Box
1179 * This box defines overall information which is media-independent, and relevant to the entire presentation considered as a whole. */
1180 typedef struct
1182 ISOM_FULLBOX_COMMON; /* version is either 0 or 1 */
1183 /* version == 0: uint64_t -> uint32_t */
1184 uint64_t creation_time; /* the creation time of the presentation (in seconds since midnight, Jan. 1, 1904, in UTC time) */
1185 uint64_t modification_time; /* the most recent time the presentation was modified (in seconds since midnight, Jan. 1, 1904, in UTC time) */
1186 uint32_t timescale; /* movie timescale: timescale for the entire presentation */
1187 uint64_t duration; /* the duration, expressed in movie timescale, of the longest track */
1188 /* The following fields are treated as
1189 * ISOM: template fields.
1190 * MP41: reserved fields.
1191 * MP42: ignored fileds since compositions are done using BIFS system.
1192 * 3GPP: ignored fields.
1193 * QTFF: usable fields. */
1194 int32_t rate; /* fixed point 16.16 number. 0x00010000 is normal forward playback. */
1195 int16_t volume; /* fixed point 8.8 number. 0x0100 is full volume. */
1196 int16_t reserved;
1197 int32_t preferredLong[2]; /* ISOM: reserved / QTFF: unknown */
1198 int32_t matrix[9]; /* transformation matrix for the video */
1199 /* The following fields are defined in QuickTime file format.
1200 * In ISO Base Media file format, these fields are treated as pre_defined. */
1201 int32_t previewTime; /* the time value in the movie at which the preview begins */
1202 int32_t previewDuration; /* the duration of the movie preview in movie timescale units */
1203 int32_t posterTime; /* the time value of the time of the movie poster */
1204 int32_t selectionTime; /* the time value for the start time of the current selection */
1205 int32_t selectionDuration; /* the duration of the current selection in movie timescale units */
1206 int32_t currentTime; /* the time value for current time position within the movie */
1207 /* */
1208 uint32_t next_track_ID; /* larger than the largest track-ID in use */
1209 } isom_mvhd_t;
1211 /* Object Descriptor Box
1212 * Note that this box is mandatory under 14496-1:2001 (mp41) while not mandatory under 14496-14:2003 (mp42). */
1213 struct mp4sys_ObjectDescriptor_t; /* FIXME: I think these structs using mp4sys should be placed in isom.c */
1214 typedef struct
1216 ISOM_FULLBOX_COMMON;
1217 struct mp4sys_ObjectDescriptor_t *OD;
1218 } isom_iods_t;
1220 /* Media Data Box
1221 * This box contains the media data.
1222 * A presentation may contain zero or more Media Data Boxes.*/
1223 typedef struct
1225 ISOM_BASEBOX_COMMON; /* If size is 0, then this box is the last box. */
1227 uint64_t media_size; /* the total media size already written in this box */
1228 uint64_t reserved_size; /* the reserved total media size in this box
1229 * If 'media_size' > 'reserved_size' occurs when finishing a non-fragmented movie,
1230 * rewrite the size of this box. */
1231 } isom_mdat_t;
1233 /* Free Space Box
1234 * The contents of a free-space box are irrelevant and may be ignored without affecting the presentation. */
1235 typedef struct
1237 ISOM_BASEBOX_COMMON; /* type is 'free' or 'skip' */
1238 uint32_t length;
1239 uint8_t *data;
1240 } isom_free_t;
1242 typedef isom_free_t isom_skip_t;
1244 /* Chapter List Box
1245 * This box is NOT defined in the ISO/MPEG-4 specs.
1246 * Basically, this box exists in User Data Box inside Movie Box if present. */
1247 typedef struct
1249 uint64_t start_time; /* version = 0: expressed in movie timescale units
1250 * version = 1: expressed in 100 nanoseconds */
1251 /* Chapter name is Pascal string */
1252 uint8_t chapter_name_length;
1253 char *chapter_name;
1254 } isom_chpl_entry_t;
1256 typedef struct
1258 ISOM_FULLBOX_COMMON; /* version = 0 is defined in F4V file format. */
1259 uint8_t unknown; /* only available under version = 1 */
1260 lsmash_entry_list_t *list; /* if version is set to 0, entry_count is uint8_t. */
1261 } isom_chpl_t;
1263 typedef struct
1265 char *chapter_name;
1266 uint64_t start_time;
1267 } isom_chapter_entry_t;
1269 /* Metadata Item Keys Box */
1270 typedef struct
1272 ISOM_FULLBOX_COMMON;
1273 lsmash_entry_list_t *list;
1274 } isom_keys_t;
1276 typedef struct
1278 uint32_t key_size; /* the size of the entire structure containing a key definition
1279 * key_size = sizeof(key_size) + sizeof(key_namespace) + sizeof(key_value) */
1280 uint32_t key_namespace; /* a naming scheme used for metadata keys
1281 * Location metadata keys, for example, use the 'mdta' key namespace. */
1282 uint8_t *key_value; /* the actual name of the metadata key
1283 * Keys with the 'mdta' namespace use a reverse DNS naming convention. */
1284 } isom_keys_entry_t;
1286 /* Meaning Box */
1287 typedef struct
1289 ISOM_FULLBOX_COMMON;
1290 uint8_t *meaning_string; /* to fill the box */
1292 uint32_t meaning_string_length;
1293 } isom_mean_t;
1295 /* Name Box */
1296 typedef struct
1298 ISOM_FULLBOX_COMMON;
1299 uint8_t *name; /* to fill the box */
1301 uint32_t name_length;
1302 } isom_name_t;
1304 /* Data Box */
1305 typedef struct
1307 ISOM_BASEBOX_COMMON;
1308 /* type indicator */
1309 uint16_t reserved; /* always 0 */
1310 uint8_t type_set_identifier; /* 0: type set of the common basic data types */
1311 uint8_t type_code; /* type of data code */
1312 /* */
1313 uint32_t the_locale; /* reserved to be 0 */
1314 uint8_t *value; /* to fill the box */
1316 uint32_t value_length;
1317 } isom_data_t;
1319 /* Metadata Item Box */
1320 typedef struct
1322 ISOM_BASEBOX_COMMON;
1323 isom_mean_t *mean; /* Meaning Box */
1324 isom_name_t *name; /* Name Box */
1325 isom_data_t *data; /* Data Box */
1326 } isom_metaitem_t;
1328 /* Metadata Item List Box */
1329 typedef struct
1331 ISOM_BASEBOX_COMMON;
1332 lsmash_entry_list_t metaitem_list; /* Metadata Item Box List
1333 * There is no entry_count field. */
1334 } isom_ilst_t;
1336 /* Meta Box */
1337 typedef struct
1339 ISOM_FULLBOX_COMMON; /* ISOM: FullBox / QTFF: BaseBox */
1340 isom_hdlr_t *hdlr; /* Metadata Handler Reference Box */
1341 isom_dinf_t *dinf; /* ISOM: Data Information Box / QTFF: null */
1342 isom_keys_t *keys; /* ISOM: null / QTFF: Metadata Item Keys Box */
1343 isom_ilst_t *ilst; /* Metadata Item List Box only defined in Apple MPEG-4 and QTFF */
1344 } isom_meta_t;
1346 /* Window Location Box */
1347 typedef struct
1349 ISOM_BASEBOX_COMMON;
1350 /* default window location for movie */
1351 uint16_t x;
1352 uint16_t y;
1353 } isom_WLOC_t;
1355 /* Looping Box */
1356 typedef struct
1358 ISOM_BASEBOX_COMMON;
1359 uint32_t looping_mode; /* 0 for none, 1 for looping, 2 for palindromic looping */
1360 } isom_LOOP_t;
1362 /* Play Selection Only Box */
1363 typedef struct
1365 ISOM_BASEBOX_COMMON;
1366 uint8_t selection_only; /* whether only the selected area of the movie should be played */
1367 } isom_SelO_t;
1369 /* Play All Frames Box */
1370 typedef struct
1372 ISOM_BASEBOX_COMMON;
1373 uint8_t play_all_frames; /* whether all frames of video should be played, regardless of timing */
1374 } isom_AllF_t;
1376 /* Copyright Box
1377 * The Copyright box contains a copyright declaration which applies to the entire presentation,
1378 * when contained within the Movie Box, or, when contained in a track, to that entire track.
1379 * There may be multiple copyright boxes using different language codes. */
1380 typedef struct
1382 ISOM_FULLBOX_COMMON;
1383 uint16_t language; /* ISO-639-2/T language codes. Most significant 1-bit is 0.
1384 * Each character is packed as the difference between its ASCII value and 0x60. */
1385 uint8_t *notice; /* a null-terminated string in either UTF-8 or UTF-16 characters, giving a copyright notice.
1386 * If UTF-16 is used, the string shall start with the BYTE ORDER MARK (0xFEFF), to distinguish it from a UTF-8 string.
1387 * This mark does not form part of the final string. */
1388 uint32_t notice_length;
1389 } isom_cprt_t;
1391 /* User Data Box
1392 * This box is a container box for informative user-data.
1393 * This user data is formatted as a set of boxes with more specific box types, which declare more precisely their content.
1394 * QTFF: for historical reasons, this box is optionally terminated by a 32-bit integer set to 0. */
1395 typedef struct
1397 ISOM_BASEBOX_COMMON;
1398 isom_chpl_t *chpl; /* Chapter List Box */
1399 isom_meta_t *meta; /* Meta Box extended by Apple for iTunes movie */
1400 /* QuickTime user data */
1401 isom_WLOC_t *WLOC; /* Window Location Box */
1402 isom_LOOP_t *LOOP; /* Looping Box */
1403 isom_SelO_t *SelO; /* Play Selection Only Box */
1404 isom_AllF_t *AllF; /* Play All Frames Box */
1405 /* Copyright Box List */
1406 lsmash_entry_list_t cprt_list; /* Copyright Boxes is defined in ISO Base Media and 3GPP file format */
1407 } isom_udta_t;
1409 /** Caches for handling tracks **/
1410 typedef struct
1412 uint64_t alloc; /* total buffer size for the pool */
1413 uint64_t size; /* total size of samples in the pool */
1414 uint32_t sample_count; /* number of samples in the pool */
1415 uint8_t *data; /* actual data of samples in the pool */
1416 } isom_sample_pool_t;
1418 typedef struct
1420 uint32_t chunk_number; /* chunk number */
1421 uint32_t sample_description_index; /* sample description index */
1422 uint64_t first_dts; /* the first DTS in chunk */
1423 isom_sample_pool_t *pool; /* samples pooled to interleave */
1424 } isom_chunk_t;
1426 typedef struct
1428 uint64_t dts;
1429 uint64_t cts;
1430 int32_t ctd_shift;
1431 } isom_timestamp_t;
1433 typedef struct
1435 isom_group_assignment_entry_t *assignment; /* the address corresponding to the entry in Sample to Group Box */
1436 isom_group_assignment_entry_t *prev_assignment; /* the address of the previous assignment */
1437 isom_rap_entry_t *random_access; /* the address corresponding to the random access entry in Sample Group Description Box */
1438 uint8_t is_prev_rap; /* whether the previous sample is a random access point or not */
1439 } isom_rap_group_t;
1441 typedef struct
1443 isom_group_assignment_entry_t *assignment; /* the address corresponding to the entry in Sample to Group Box */
1444 isom_sgpd_t *sgpd; /* the address to the active Sample Group Description Box */
1445 uint32_t first_sample; /* the number of the first sample of the group */
1446 uint32_t recovery_point; /* the identifier necessary for the recovery from its starting point to be completed */
1447 uint64_t rp_cts; /* the CTS of the recovery point */
1448 int16_t roll_distance; /* the current roll_distance
1449 * The value may be updated when 'described' is set to ROLL_DISTANCE_INITIALIZED. */
1450 #define MAX_ROLL_WAIT_AND_SEE_COUNT 64
1451 uint8_t wait_and_see_count; /* Wait-and-see after initialization of roll_distance until reaching MAX_ROLL_WAIT_AND_SEE. */
1452 uint8_t is_fragment; /* the flag if the current group is in fragment */
1453 uint8_t prev_is_recovery_start; /* whether the previous sample is a starting point of recovery or not */
1454 uint8_t delimited; /* the flag if the sample_count is determined */
1455 #define ROLL_DISTANCE_INITIALIZED 1
1456 #define ROLL_DISTANCE_DETERMINED 2
1457 uint8_t described; /* the status of the group description */
1458 } isom_roll_group_t;
1460 typedef struct
1462 lsmash_entry_list_t *pool; /* grouping pooled to delimit and describe */
1463 } isom_grouping_t;
1465 typedef struct
1467 uint64_t segment_duration; /* the sum of the subsegment_duration of preceeding subsegments */
1468 uint64_t largest_cts; /* the largest CTS of a subsegment of the reference stream */
1469 uint64_t smallest_cts; /* the smallest CTS of a subsegment of the reference stream */
1470 uint64_t first_sample_cts; /* the CTS of the first sample of a subsegment of the reference stream */
1471 /* SAP related info within the active subsegment of the reference stream */
1472 uint64_t first_ed_cts; /* the earliest CTS of decodable samples after the first recovery point */
1473 uint64_t first_rp_cts; /* the CTS of the first recovery point */
1474 uint32_t first_rp_number; /* the number of the first recovery point */
1475 uint32_t first_ra_number; /* the number of the first random accessible sample */
1476 lsmash_random_access_flag first_ra_flags; /* the flags of the first random accessible sample */
1477 int is_first_recovery_point;
1478 int decodable;
1479 } isom_subsegment_t;
1481 typedef struct
1483 uint8_t has_samples; /* Whether whole movie has any sample or not. */
1484 uint8_t roll_grouping;
1485 uint8_t rap_grouping;
1486 uint32_t traf_number;
1487 uint32_t last_duration; /* the last sample duration in this track fragment */
1488 uint64_t largest_cts; /* the largest CTS in this track fragment */
1489 uint32_t sample_count; /* the number of samples in this track fragment */
1490 uint32_t output_sample_count; /* the number of output samples in this track fragment */
1491 isom_subsegment_t subsegment;
1492 } isom_fragment_t;
1494 typedef struct
1496 uint8_t all_sync; /* if all samples are sync sample */
1497 uint8_t is_audio;
1498 isom_chunk_t chunk;
1499 isom_timestamp_t timestamp; /* Each field stores the last valid value. */
1500 isom_grouping_t roll;
1501 isom_rap_group_t *rap;
1502 isom_fragment_t *fragment;
1503 } isom_cache_t;
1505 /** Movie Fragments Boxes **/
1506 /* Track Fragments Flags ('tf_flags') */
1507 typedef enum
1509 ISOM_TF_FLAGS_BASE_DATA_OFFSET_PRESENT = 0x000001, /* base-data-offset-present:
1510 * This flag indicates the presence of the base_data_offset field.
1511 * The base_data_offset is the base offset to use when calculating data offsets.
1512 * Offsets are file offsets as like as chunk_offset in Chunk Offset Box.
1513 * If this flag is set and default-base-is-moof is not set, the base_data_offset
1514 * for the first track in the movie fragment is the position of the first byte
1515 * of the enclosing Movie Fragment Box, and for second and subsequent track
1516 * fragments, the default is the end of the data defined by the preceding fragment. */
1517 ISOM_TF_FLAGS_SAMPLE_DESCRIPTION_INDEX_PRESENT = 0x000002, /* sample-description-index-present
1518 * This flag indicates the presence of the sample_description_index field. */
1519 ISOM_TF_FLAGS_DEFAULT_SAMPLE_DURATION_PRESENT = 0x000008, /* default-sample-duration-present:
1520 * This flag indicates the presence of the default_sample_duration field. */
1521 ISOM_TF_FLAGS_DEFAULT_SAMPLE_SIZE_PRESENT = 0x000010, /* default-sample-size-present:
1522 * This flag indicates the presence of the default_sample_size field. */
1523 ISOM_TF_FLAGS_DEFAULT_SAMPLE_FLAGS_PRESENT = 0x000020, /* default-sample-flags-present:
1524 * This flag indicates the presence of the default_sample_flags field. */
1525 ISOM_TF_FLAGS_DURATION_IS_EMPTY = 0x010000, /* duration-is-empty:
1526 * This flag indicates there are no samples for this time interval. */
1527 ISOM_TF_FLAGS_DEFAULT_BASE_IS_MOOF = 0x020000, /* default-base-is-moof:
1528 * If base-data-offset-present is not set, this flag indicates the implicit
1529 * base_data_offset is always equal to the position of the first byte of the
1530 * enclosing Movie Fragment BOX.
1531 * This flag is only available under the 'iso5' or later brands and cannot be set
1532 * when earlier brands are included in the File Type box. */
1533 } isom_tf_flags_code;
1535 /* Track Run Flags ('tr_flags') */
1536 typedef enum
1538 ISOM_TR_FLAGS_DATA_OFFSET_PRESENT = 0x000001, /* data-offset-present:
1539 * This flag indicates the presence of the data_offset field. */
1540 ISOM_TR_FLAGS_FIRST_SAMPLE_FLAGS_PRESENT = 0x000004, /* first-sample-flags-present:
1541 * This flag indicates the presence of the first_sample_flags field. */
1542 ISOM_TR_FLAGS_SAMPLE_DURATION_PRESENT = 0x000100, /* sample-duration-present:
1543 * This flag indicates the presence of the sample_duration field. */
1544 ISOM_TR_FLAGS_SAMPLE_SIZE_PRESENT = 0x000200, /* sample-size-present:
1545 * This flag indicates the presence of the sample_size field. */
1546 ISOM_TR_FLAGS_SAMPLE_FLAGS_PRESENT = 0x000400, /* sample-flags-present:
1547 * This flag indicates the presence of the sample_flags field. */
1548 ISOM_TR_FLAGS_SAMPLE_COMPOSITION_TIME_OFFSET_PRESENT = 0x000800, /* sample-composition-time-offsets-present:
1549 * This flag indicates the presence of the sample_composition_time_offset field. */
1550 } isom_tr_flags_code;
1552 /* Sample Flags */
1553 typedef struct
1555 unsigned reserved : 4;
1556 /* The definition of the following fields is quite the same as Independent and Disposable Samples Box. */
1557 unsigned is_leading : 2;
1558 unsigned sample_depends_on : 2;
1559 unsigned sample_is_depended_on : 2;
1560 unsigned sample_has_redundancy : 2;
1561 /* */
1562 unsigned sample_padding_value : 3; /* the number of bits at the end of this sample */
1563 unsigned sample_is_non_sync_sample : 1; /* 0 value means this sample is sync sample. */
1564 uint16_t sample_degradation_priority;
1565 } isom_sample_flags_t;
1567 /* Movie Extends Header Box
1568 * This box is omitted when used in live streaming.
1569 * If this box is not present, the overall duration must be computed by examining each fragment. */
1570 typedef struct
1572 ISOM_FULLBOX_COMMON;
1573 /* version == 0: uint64_t -> uint32_t */
1574 uint64_t fragment_duration; /* the duration of the longest track, in the timescale indicated in the Movie Header Box, including movie fragments. */
1575 } isom_mehd_t;
1577 /* Track Extends Box
1578 * This box sets up default values used by the movie fragments. */
1579 typedef struct
1581 ISOM_FULLBOX_COMMON;
1582 uint32_t track_ID; /* identifier of the track; this shall be the track ID of a track in the Movie Box */
1583 uint32_t default_sample_description_index;
1584 uint32_t default_sample_duration;
1585 uint32_t default_sample_size;
1586 isom_sample_flags_t default_sample_flags;
1587 } isom_trex_t;
1589 /* Movie Extends Box
1590 * This box warns readers that there might be Movie Fragment Boxes in this file. */
1591 typedef struct
1593 ISOM_BASEBOX_COMMON;
1594 isom_mehd_t *mehd; /* Movie Extends Header Box / omitted when used in live streaming */
1595 lsmash_entry_list_t trex_list; /* Track Extends Box */
1596 } isom_mvex_t;
1598 /* Movie Fragment Header Box
1599 * This box contains a sequence number, as a safety check.
1600 * The sequence number 'usually' starts at 1 and must increase for each movie fragment in the file, in the order in which they occur. */
1601 typedef struct
1603 ISOM_FULLBOX_COMMON;
1604 uint32_t sequence_number; /* the ordinal number of this fragment, in increasing order */
1605 } isom_mfhd_t;
1607 /* Track Fragment Header Box
1608 * Each movie fragment can contain zero or more fragments for each track;
1609 * and a track fragment can contain zero or more contiguous runs of samples.
1610 * This box sets up information and defaults used for those runs of samples. */
1611 typedef struct
1613 ISOM_FULLBOX_COMMON; /* flags field is used for 'tf_flags'. */
1614 uint32_t track_ID;
1615 /* all the following are optional fields */
1616 uint64_t base_data_offset; /* an explicit anchor for the data offsets in each track run
1617 * To avoid the case this field might overflow, e.g. semi-permanent live streaming and broadcasting,
1618 * you shall not use this optional field. */
1619 uint32_t sample_description_index; /* override default_sample_description_index in Track Extends Box */
1620 uint32_t default_sample_duration; /* override default_sample_duration in Track Extends Box */
1621 uint32_t default_sample_size; /* override default_sample_size in Track Extends Box */
1622 isom_sample_flags_t default_sample_flags; /* override default_sample_flags in Track Extends Box */
1623 } isom_tfhd_t;
1625 /* Track Fragment Base Media Decode Time Box
1626 * This box provides the absolute decode time, measured on the media timeline, of the first sample in decode order in the track fragment.
1627 * This can be useful, for example, when performing random access in a file;
1628 * it is not necessary to sum the sample durations of all preceding samples in previous fragments to find this value
1629 * (where the sample durations are the deltas in the Decoding Time to Sample Box and the sample_durations in the preceding track runs).
1630 * This box, if present, shall be positioned after the Track Fragment Header Box and before the first Track Fragment Run box. */
1631 typedef struct
1633 ISOM_FULLBOX_COMMON; /* version is either 0 or 1 */
1634 /* version == 0: 64bits -> 32bits */
1635 uint64_t baseMediaDecodeTime; /* an integer equal to the sum of the decode durations of all earlier samples in the media, expressed in the media's timescale
1636 * It does not include the samples added in the enclosing track fragment.
1637 * NOTE: the decode timeline is a media timeline, established before any explicit or implied mapping of media time to presentation time,
1638 * for example by an edit list or similar structure. */
1639 } isom_tfdt_t;
1641 /* Track Fragment Run Box
1642 * Within the Track Fragment Box, there are zero or more Track Fragment Run Boxes.
1643 * If the duration-is-empty flag is set in the tf_flags, there are no track runs.
1644 * A track run documents a contiguous set of samples for a track. */
1645 typedef struct
1647 ISOM_FULLBOX_COMMON; /* flags field is used for 'tr_flags'. */
1648 uint32_t sample_count; /* the number of samples being added in this run; also the number of rows in the following table */
1649 /* The following are optional fields. */
1650 int32_t data_offset; /* This value is added to the implicit or explicit data_offset established in the Track Fragment Header Box.
1651 * If this field is not present, then the data for this run starts immediately after the data of the previous run,
1652 * or at the base_data_offset defined by the Track Fragment Header Box if this is the first run in a track fragment. */
1653 isom_sample_flags_t first_sample_flags; /* a set of flags for the first sample only of this run */
1654 lsmash_entry_list_t *optional; /* all fields in this array are optional. */
1655 } isom_trun_t;
1657 typedef struct
1659 /* If the following fields is present, each field overrides default value described in Track Fragment Header Box or Track Extends Box. */
1660 uint32_t sample_duration; /* override default_sample_duration */
1661 uint32_t sample_size; /* override default_sample_size */
1662 isom_sample_flags_t sample_flags; /* override default_sample_flags */
1663 /* */
1664 uint32_t sample_composition_time_offset; /* composition time offset
1665 * If version == 0, unsigned 32-bit integer.
1666 * Otherwise, signed 32-bit integer. */
1667 } isom_trun_optional_row_t;
1669 /* Track Fragment Box */
1670 typedef struct
1672 ISOM_BASEBOX_COMMON;
1673 isom_tfhd_t *tfhd; /* Track Fragment Header Box */
1674 isom_tfdt_t *tfdt; /* Track Fragment Base Media Decode Time Box */
1675 lsmash_entry_list_t trun_list; /* Track Fragment Run Box List
1676 * If the duration-is-empty flag is set in the tf_flags, there are no track runs. */
1677 isom_sdtp_t *sdtp; /* Independent and Disposable Samples Box (available under Protected Interoperable File Format) */
1678 lsmash_entry_list_t sgpd_list; /* Sample Group Description Boxes (available under ISO Base Media version 6 or later) */
1679 lsmash_entry_list_t sbgp_list; /* Sample To Group Boxes */
1681 isom_cache_t *cache; /* taken over from corresponding 'trak' */
1682 } isom_traf_t;
1684 /* Movie Fragment Box */
1685 typedef struct
1687 ISOM_BASEBOX_COMMON;
1688 isom_mfhd_t *mfhd; /* Movie Fragment Header Box */
1689 lsmash_entry_list_t traf_list; /* Track Fragment Box List */
1690 } isom_moof_t;
1692 /* Track Fragment Random Access Box
1693 * Each entry in this box contains the location and the presentation time of the sync sample.
1694 * Note that not every sync sample in the track needs to be listed in the table.
1695 * The absence of this box does not mean that all the samples are sync samples. */
1696 typedef struct
1698 ISOM_FULLBOX_COMMON;
1699 uint32_t track_ID;
1700 unsigned int reserved : 26;
1701 unsigned int length_size_of_traf_num : 2; /* the length in byte of the traf_number field minus one */
1702 unsigned int length_size_of_trun_num : 2; /* the length in byte of the trun_number field minus one */
1703 unsigned int length_size_of_sample_num : 2; /* the length in byte of the sample_number field minus one */
1704 uint32_t number_of_entry; /* the number of the entries for this track
1705 * Value zero indicates that every sample is a sync sample and no table entry follows. */
1706 lsmash_entry_list_t *list; /* entry_count corresponds to number_of_entry. */
1707 } isom_tfra_t;
1709 typedef struct
1711 /* version == 0: 64bits -> 32bits */
1712 uint64_t time; /* the presentation time of the sync sample in units defined in the Media Header Box of the associated track
1713 * For segments based on movie sample tables or movie fragments, presentation times are in the movie timeline,
1714 * that is they are composition times after the application of any edit list for the track.
1715 * Note: the definition of segment is portion of an ISO base media file format file, consisting of either
1716 * (a) a movie box, with its associated media data (if any) and other associated boxes
1717 * or
1718 * (b) one or more movie fragment boxes, with their associated media data, and other associated boxes. */
1719 uint64_t moof_offset; /* the offset of the Movie Fragment Box used in this entry
1720 * Offset is the byte-offset between the beginning of the file and the beginning of the Movie Fragment Box. */
1721 /* */
1722 uint32_t traf_number; /* the Track Fragment Box ('traf') number that contains the sync sample
1723 * The number ranges from 1 in each Movie Fragment Box ('moof'). */
1724 uint32_t trun_number; /* the Track Fragment Run Box ('trun') number that contains the sync sample
1725 * The number ranges from 1 in each Track Fragment Box ('traf'). */
1726 uint32_t sample_number; /* the sample number that contains the sync sample
1727 * The number ranges from 1 in each Track Fragment Run Box ('trun'). */
1728 } isom_tfra_location_time_entry_t;
1730 /* Movie Fragment Random Access Offset Box
1731 * This box provides a copy of the length field from the enclosing Movie Fragment Random Access Box. */
1732 typedef struct
1734 ISOM_FULLBOX_COMMON;
1735 uint32_t length; /* an integer gives the number of bytes of the enclosing Movie Fragment Random Access Box
1736 * This field is placed at the last of the enclosing box to assist readers scanning
1737 * from the end of the file in finding the Movie Fragment Random Access Box. */
1738 } isom_mfro_t;
1740 /* Movie Fragment Random Access Box
1741 * This box provides a table which may assist readers in finding sync samples in a file using movie fragments,
1742 * and is usually placed at or near the end of the file.
1743 * The last box within the Movie Fragment Random Access Box, which is called Movie Fragment Random Access Offset Box,
1744 * provides a copy of the length field from the Movie Fragment Random Access Box. */
1745 typedef struct
1747 ISOM_BASEBOX_COMMON;
1748 lsmash_entry_list_t tfra_list; /* Track Fragment Random Access Box */
1749 isom_mfro_t *mfro; /* Movie Fragment Random Access Offset Box */
1750 } isom_mfra_t;
1752 /* Movie fragment manager
1753 * The presence of this means we use the structure of movie fragments. */
1754 typedef struct
1756 #define FIRST_MOOF_POS_UNDETERMINED UINT64_MAX
1757 isom_moof_t *movie; /* the address corresponding to the current Movie Fragment Box */
1758 uint64_t first_moof_pos;
1759 uint64_t pool_size; /* the total sample size in the current movie fragment */
1760 uint64_t sample_count; /* the number of samples within the current movie fragment */
1761 lsmash_entry_list_t *pool; /* samples pooled to interleave for the current movie fragment */
1762 } isom_fragment_manager_t;
1764 /** **/
1766 /* Track Box */
1767 typedef struct
1769 ISOM_BASEBOX_COMMON;
1770 isom_tkhd_t *tkhd; /* Track Header Box */
1771 isom_tapt_t *tapt; /* ISOM: null / QTFF: Track Aperture Mode Dimensions Box */
1772 isom_edts_t *edts; /* Edit Box */
1773 isom_tref_t *tref; /* Track Reference Box */
1774 isom_mdia_t *mdia; /* Media Box */
1775 isom_udta_t *udta; /* User Data Box */
1776 isom_meta_t *meta; /* Meta Box */
1778 isom_cache_t *cache;
1779 uint32_t related_track_ID;
1780 uint8_t is_chapter;
1781 } isom_trak_t;
1783 /* Movie Box */
1784 typedef struct
1786 ISOM_BASEBOX_COMMON;
1787 isom_mvhd_t *mvhd; /* Movie Header Box */
1788 isom_iods_t *iods; /* MP4: Object Descriptor Box */
1789 lsmash_entry_list_t trak_list; /* Track Box List */
1790 isom_udta_t *udta; /* User Data Box */
1791 isom_ctab_t *ctab; /* ISOM: null / QTFF: Color Table Box */
1792 isom_meta_t *meta; /* Meta Box */
1793 isom_mvex_t *mvex; /* Movie Extends Box */
1794 } isom_moov_t;
1796 /** Segments
1797 * segment
1798 * portion of an ISO base media file format file, consisting of either (a) a movie box, with its associated media data
1799 * (if any) and other associated boxes or (b) one or more movie fragment boxes, with their associated media data, and
1800 * and other associated boxes
1801 * subsegment
1802 * time interval of a segment formed from movie fragment boxes, that is also a valid segment
1803 * A subsegment is defined as a time interval of the containing (sub)segment, and corresponds to a single range of
1804 * bytes of the containing (sub)segment. The durations of all the subsegments sum to the duration of the containing
1805 * (sub)segment.
1807 /* Segment Type Box
1808 * Media presentations may be divided into segments for delivery, for example, it is possible (e.g. in HTTP streaming) to
1809 * form files that contain a segment ? or concatenated segments ? which would not necessarily form ISO Base Media file
1810 * format compliant files (e.g. they do not contain a Movie Box).
1811 * If segments are stored in separate files (e.g. on a standard HTTP server) it is recommended that these 'segment files'
1812 * contain a Segment Type Box, which must be first if present, to enable identification of those files, and declaration of
1813 * the specifications with which they are compliant.
1814 * Segment Type Boxes that are not first in a file may be ignored.
1815 * Valid Segment Type Boxes shall be the first box in a segment.
1816 * Note:
1817 * The 'valid' here does not always mean that any brand of that segment has compatibility against other brands of it.
1818 * After concatenations of segments, the result file might contain incompatibilities among brands. */
1819 typedef isom_ftyp_t isom_styp_t;
1821 /* Segment Index Box
1822 * This box provides a compact index of one media stream within the media segment to which it applies.
1824 * Each Segment Index Box documents how a (sub)segment is divided into one or more subsegments (which may themselves be
1825 * further subdivided using Segment Index boxes).
1827 * Each entry in the Segment Index Box contains a reference type that indicates whether the reference points directly to
1828 * the media bytes of a referenced leaf subsegment, which is a subsegment that does not contain any indexing information
1829 * that would enable its further division into subsegments, or to a Segment Index box that describes how the referenced
1830 * subsegment is further subdivided; as a result, the segment may be indexed in a 'hierarchical' or 'daisy-chain' or
1831 * other form by documenting time and byte offset information for other Segment Index Boxes applying to portions of the
1832 * same (sub)segment.
1834 * For segments based on ISO Base Media file format (i.e. based on movie sample tables or movie fragments):
1835 * ! an access unit is a sample;
1836 * ! a subsegment is a self-contained set of one or more consecutive movie fragments; a self-contained set contains
1837 * one or more Movie Fragment Boxes with the corresponding Media Data Box(es), and a Media Data Box containing data
1838 * referenced by a Movie Fragment Box must follow that Movie Fragment Box and precede the next Movie Fragment box
1839 * containing information about the same track;
1840 * ! Segment Index Boxes shall be placed before subsegment material they document, that is, before any Movie Fragment
1841 * Box of the documented material of the subsegment;
1842 * ! streams are tracks in the file format, and stream IDs are track IDs;
1843 * ! a subsegment contains a stream access point if a track fragment within the subsegment for the track with track_ID
1844 * equal to reference_ID contains a stream access point;
1845 * ! initialisation data for SAPs consists of the Movie Box;
1846 * ! presentation times are in the movie timeline, that is they are composition times after the application of any edit
1847 * list for the track;
1848 * ! the ISAP is a position exactly pointing to the start of a top-level box, such as a Movie Fragment Box;
1849 * ! a SAP of type 1 or type 2 is indicated as a sync sample;
1850 * ! a SAP of type 3 is marked as a member of a sample group of type 'rap ';
1851 * ! a SAP of type 4 is marked as a member of a sample group of type 'roll' where the value of the roll_distance field
1852 * is greater than 0.
1853 * For SAPs of type 5 and 6, no specific signalling in the ISO Base Media file format is supported. */
1854 typedef struct
1856 unsigned int reference_type : 1; /* 1: the reference is to a Segment Index Box
1857 * 0: the reference is to media content
1858 * For files based on the ISO Base Media file format, the reference is to a
1859 * Movie Fragment Box.
1860 * If a separate index segment is used, then entries with reference type 1 are
1861 * in the index segment, and entries with reference type 0 are in the media file. */
1862 unsigned int reference_size : 31; /* the distance in bytes from the first byte of the referenced item to the first
1863 * byte of the next referenced item, or in the case of the last entry, the end of
1864 * the referenced material */
1865 uint32_t subsegment_duration; /* when the reference is to Segment Index Box, i.e. reference_type is equal to 1:
1866 * this field carries the sum of the subsegment_duration fields in that box;
1867 * when the reference is to a subsegment:
1868 * this field carries the difference between the earliest presentation time of
1869 * any access unit of the reference stream in the next subsegment (or the first
1870 * subsegment of the next segment, if this is the last subsegment of the segment,
1871 * or the end presentation time of the reference stream if this is the last
1872 * subsegment of the stream) and the earliest presentation time of any access
1873 * unit of the reference stream in the referenced subsegment;
1874 * The duration is expressed in the timescale of the enclosing Segment Index Box. */
1875 unsigned int starts_with_SAP : 1; /* whether the referenced subsegments start with a SAP */
1876 unsigned int SAP_type : 3; /* a SAP type or the value 0
1877 * When starting with a SAP, the value 0 means a SAP may be of an unknown type.
1878 * Otherwise, the value 0 means no information of SAPs is provided. */
1879 unsigned int SAP_delta_time : 28; /* TSAP of the first SAP, in decoding order, in the referenced subsegment for
1880 * the reference stream
1881 * If the referenced subsegments do not contain a SAP, SAP_delta_time is
1882 * reserved with the value 0, otherwise SAP_delta_time is the difference between
1883 * the earliest presentation time of the subsegment, and the TSAP.
1884 * Note that this difference may be zero, in the case that the subsegment starts
1885 * with a SAP. */
1886 } isom_sidx_referenced_item_t;
1888 typedef struct
1890 ISOM_FULLBOX_COMMON;
1891 uint32_t reference_ID; /* the stream ID for the reference stream
1892 * If this Segment Index box is referenced from a "parent" Segment Index box, the value
1893 * of the value of reference_ID shall be the same as the value of reference_ID of the
1894 * "parent" Segment Index Box. */
1895 uint32_t timescale; /* the timescale, in ticks per second, for the time and duration fields within this box
1896 * It is recommended that this match the timescale of the reference stream or track.
1897 * For files based on the ISO Base Media file format, that is the timescale field of
1898 * the Media Header Box of the track. */
1899 /* version == 0: 64bits -> 32bits */
1900 uint64_t earliest_presentation_time; /* the earliest presentation time of any access unit in the reference stream
1901 * in the first subsegment, in the timescale indicated in the timescale field */
1902 uint64_t first_offset; /* the distance in bytes, in the file containing media, from the anchor point,
1903 * to the first byte of the indexed material */
1904 /* */
1905 uint16_t reserved; /* 0 */
1906 uint16_t reference_count; /* the number of referenced items */
1907 lsmash_entry_list_t *list; /* entry_count corresponds to reference_count. */
1908 } isom_sidx_t;
1910 /** **/
1912 /* File */
1913 struct lsmash_file_tag
1915 ISOM_FULLBOX_COMMON; /* The 'size' field indicates total file size.
1916 * The 'flags' field indicates file mode. */
1917 isom_ftyp_t *ftyp; /* File Type Box */
1918 lsmash_entry_list_t styp_list; /* Segment Type Box List */
1919 isom_moov_t *moov; /* Movie Box */
1920 lsmash_entry_list_t sidx_list; /* Segment Index Box List */
1921 lsmash_entry_list_t moof_list; /* Movie Fragment Box List */
1922 isom_mdat_t *mdat; /* Media Data Box */
1923 isom_meta_t *meta; /* Meta Box */
1924 isom_mfra_t *mfra; /* Movie Fragment Random Access Box */
1926 lsmash_bs_t *bs; /* bytestream manager */
1927 isom_fragment_manager_t *fragment; /* movie fragment manager */
1928 lsmash_entry_list_t *print;
1929 lsmash_entry_list_t *timeline;
1930 lsmash_file_t *initializer; /* A file containing the initialization information of whole movie including subsequent segments
1931 * For ISOBMFF, an initializer corresponds to a file containing the 'moov' box.
1932 * ROOT-to-initializer is designed to be a one-to-one relationship while initializer-to-file
1933 * is designed to be a one-to-many relationship. */
1934 struct importer_tag *importer; /* An importer of this file
1935 * Importer-to-file is designed to be a one-to-one relationship. */
1936 uint64_t fragment_count; /* the number of movie fragments we created */
1937 double max_chunk_duration; /* max duration per chunk in seconds */
1938 double max_async_tolerance; /* max tolerance, in seconds, for amount of interleaving asynchronization between tracks */
1939 uint64_t max_chunk_size; /* max size per chunk in bytes. */
1940 uint32_t brand_count;
1941 uint32_t *compatible_brands; /* the backup of the compatible brands in the File Type Box or the valid Segment Type Box */
1942 uint8_t fake_file_mode; /* If set to 1, the bytestream manager handles fake-file stream. */
1943 /* flags for compatibility */
1944 #define COMPAT_FLAGS_OFFSET offsetof( lsmash_file_t, qt_compatible )
1945 uint8_t qt_compatible; /* compatibility with QuickTime file format */
1946 uint8_t isom_compatible; /* compatibility with ISO Base Media file format */
1947 uint8_t avc_extensions; /* compatibility with AVC extensions */
1948 uint8_t mp4_version1; /* compatibility with MP4 ver.1 file format */
1949 uint8_t mp4_version2; /* compatibility with MP4 ver.2 file format */
1950 uint8_t itunes_movie; /* compatibility with iTunes Movie */
1951 uint8_t max_3gpp_version; /* maximum 3GPP version */
1952 uint8_t max_isom_version; /* maximum ISO Base Media file format version */
1953 uint8_t min_isom_version; /* minimum ISO Base Media file format version */
1954 uint8_t forbid_tref; /* If set to 1, track reference is forbidden. */
1955 uint8_t undefined_64_ver; /* If set to 1, 64-bit version fields, e.g. duration, are undefined. */
1956 uint8_t allow_moof_base; /* If set to 1, default-base-is-moof is available for muxing. */
1957 uint8_t media_segment; /* If set to 1, this file is a media segment. */
1960 /* fake-file stream */
1961 typedef struct
1963 uint32_t size;
1964 uint8_t *data;
1965 uint32_t pos;
1966 } fake_file_stream_t;
1968 /* ROOT */
1969 struct lsmash_root_tag
1971 ISOM_FULLBOX_COMMON; /* The 'file' field contains the address of the current active file. */
1972 lsmash_entry_list_t file_list; /* the list of all files the ROOT contains */
1975 /** **/
1977 /* Pre-defined precedence */
1978 #define LSMASH_BOX_PRECEDENCE_ISOM_FTYP (LSMASH_BOX_PRECEDENCE_H - 0 * LSMASH_BOX_PRECEDENCE_S)
1979 #define LSMASH_BOX_PRECEDENCE_ISOM_STYP (LSMASH_BOX_PRECEDENCE_H - 0 * LSMASH_BOX_PRECEDENCE_S)
1980 #define LSMASH_BOX_PRECEDENCE_ISOM_SIDX (LSMASH_BOX_PRECEDENCE_N + 1 * LSMASH_BOX_PRECEDENCE_S) /* shall be placed before any 'moof' of the documented subsegments */
1981 #define LSMASH_BOX_PRECEDENCE_ISOM_MOOV (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
1982 #define LSMASH_BOX_PRECEDENCE_ISOM_MVHD (LSMASH_BOX_PRECEDENCE_HM - 0 * LSMASH_BOX_PRECEDENCE_S)
1983 #define LSMASH_BOX_PRECEDENCE_ISOM_IODS (LSMASH_BOX_PRECEDENCE_HM - 2 * LSMASH_BOX_PRECEDENCE_S)
1984 #define LSMASH_BOX_PRECEDENCE_ISOM_TRAK (LSMASH_BOX_PRECEDENCE_N - 2 * LSMASH_BOX_PRECEDENCE_S)
1985 #define LSMASH_BOX_PRECEDENCE_ISOM_TKHD (LSMASH_BOX_PRECEDENCE_HM - 0 * LSMASH_BOX_PRECEDENCE_S)
1986 #define LSMASH_BOX_PRECEDENCE_QTFF_TAPT (LSMASH_BOX_PRECEDENCE_N - 1 * LSMASH_BOX_PRECEDENCE_S)
1987 #define LSMASH_BOX_PRECEDENCE_QTFF_CLEF (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
1988 #define LSMASH_BOX_PRECEDENCE_QTFF_PROF (LSMASH_BOX_PRECEDENCE_N - 1 * LSMASH_BOX_PRECEDENCE_S)
1989 #define LSMASH_BOX_PRECEDENCE_QTFF_ENOF (LSMASH_BOX_PRECEDENCE_N - 2 * LSMASH_BOX_PRECEDENCE_S)
1990 #define LSMASH_BOX_PRECEDENCE_ISOM_EDTS (LSMASH_BOX_PRECEDENCE_N - 2 * LSMASH_BOX_PRECEDENCE_S)
1991 #define LSMASH_BOX_PRECEDENCE_ISOM_ELST (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
1992 #define LSMASH_BOX_PRECEDENCE_ISOM_TREF (LSMASH_BOX_PRECEDENCE_N - 3 * LSMASH_BOX_PRECEDENCE_S)
1993 #define LSMASH_BOX_PRECEDENCE_ISOM_TREF_TYPE (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
1994 #define LSMASH_BOX_PRECEDENCE_ISOM_MDIA (LSMASH_BOX_PRECEDENCE_N - 4 * LSMASH_BOX_PRECEDENCE_S)
1995 #define LSMASH_BOX_PRECEDENCE_ISOM_MDHD (LSMASH_BOX_PRECEDENCE_HM - 0 * LSMASH_BOX_PRECEDENCE_S)
1996 #define LSMASH_BOX_PRECEDENCE_ISOM_HDLR (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
1997 #define LSMASH_BOX_PRECEDENCE_ISOM_MINF (LSMASH_BOX_PRECEDENCE_N - 1 * LSMASH_BOX_PRECEDENCE_S)
1998 #define LSMASH_BOX_PRECEDENCE_ISOM_VMHD (LSMASH_BOX_PRECEDENCE_HM - 0 * LSMASH_BOX_PRECEDENCE_S)
1999 #define LSMASH_BOX_PRECEDENCE_ISOM_SMHD (LSMASH_BOX_PRECEDENCE_HM - 0 * LSMASH_BOX_PRECEDENCE_S)
2000 #define LSMASH_BOX_PRECEDENCE_ISOM_HMHD (LSMASH_BOX_PRECEDENCE_HM - 0 * LSMASH_BOX_PRECEDENCE_S)
2001 #define LSMASH_BOX_PRECEDENCE_ISOM_NMHD (LSMASH_BOX_PRECEDENCE_HM - 0 * LSMASH_BOX_PRECEDENCE_S)
2002 #define LSMASH_BOX_PRECEDENCE_QTFF_GMHD (LSMASH_BOX_PRECEDENCE_HM - 0 * LSMASH_BOX_PRECEDENCE_S)
2003 #define LSMASH_BOX_PRECEDENCE_QTFF_GMIN (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
2004 #define LSMASH_BOX_PRECEDENCE_QTFF_TEXT (LSMASH_BOX_PRECEDENCE_N - 1 * LSMASH_BOX_PRECEDENCE_S)
2005 #define LSMASH_BOX_PRECEDENCE_ISOM_DINF (LSMASH_BOX_PRECEDENCE_N - 1 * LSMASH_BOX_PRECEDENCE_S)
2006 #define LSMASH_BOX_PRECEDENCE_ISOM_DREF (LSMASH_BOX_PRECEDENCE_N - 1 * LSMASH_BOX_PRECEDENCE_S)
2007 #define LSMASH_BOX_PRECEDENCE_ISOM_DREF_ENTRY (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
2008 #define LSMASH_BOX_PRECEDENCE_ISOM_STBL (LSMASH_BOX_PRECEDENCE_N - 2 * LSMASH_BOX_PRECEDENCE_S)
2009 #define LSMASH_BOX_PRECEDENCE_ISOM_STSD (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
2010 #define LSMASH_BOX_PRECEDENCE_QTFF_GLBL (LSMASH_BOX_PRECEDENCE_HM - 0 * LSMASH_BOX_PRECEDENCE_S)
2011 #define LSMASH_BOX_PRECEDENCE_ISOM_ESDS (LSMASH_BOX_PRECEDENCE_HM - 0 * LSMASH_BOX_PRECEDENCE_S)
2012 #define LSMASH_BOX_PRECEDENCE_QTFF_ESDS (LSMASH_BOX_PRECEDENCE_HM - 1 * LSMASH_BOX_PRECEDENCE_S) /* preceded by 'frma' and 'mp4a' */
2013 #define LSMASH_BOX_PRECEDENCE_ISOM_BTRT (LSMASH_BOX_PRECEDENCE_HM - 1 * LSMASH_BOX_PRECEDENCE_S)
2014 #define LSMASH_BOX_PRECEDENCE_ISOM_COLR (LSMASH_BOX_PRECEDENCE_LP + 2 * LSMASH_BOX_PRECEDENCE_S)
2015 #define LSMASH_BOX_PRECEDENCE_QTFF_COLR (LSMASH_BOX_PRECEDENCE_LP + 2 * LSMASH_BOX_PRECEDENCE_S)
2016 #define LSMASH_BOX_PRECEDENCE_QTFF_GAMA (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
2017 #define LSMASH_BOX_PRECEDENCE_QTFF_FIEL (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
2018 #define LSMASH_BOX_PRECEDENCE_QTFF_CSPC (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
2019 #define LSMASH_BOX_PRECEDENCE_QTFF_SGBT (LSMASH_BOX_PRECEDENCE_HM - 0 * LSMASH_BOX_PRECEDENCE_S) /* 'v216' specific */
2020 #define LSMASH_BOX_PRECEDENCE_ISOM_CLAP (LSMASH_BOX_PRECEDENCE_LP + 1 * LSMASH_BOX_PRECEDENCE_S)
2021 #define LSMASH_BOX_PRECEDENCE_ISOM_PASP (LSMASH_BOX_PRECEDENCE_LP - 0 * LSMASH_BOX_PRECEDENCE_S)
2022 #define LSMASH_BOX_PRECEDENCE_ISOM_STSL (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
2023 #define LSMASH_BOX_PRECEDENCE_ISOM_CHAN (LSMASH_BOX_PRECEDENCE_LP - 0 * LSMASH_BOX_PRECEDENCE_S)
2024 #define LSMASH_BOX_PRECEDENCE_QTFF_CHAN (LSMASH_BOX_PRECEDENCE_LP - 0 * LSMASH_BOX_PRECEDENCE_S)
2025 #define LSMASH_BOX_PRECEDENCE_QTFF_WAVE (LSMASH_BOX_PRECEDENCE_HM - 0 * LSMASH_BOX_PRECEDENCE_S)
2026 #define LSMASH_BOX_PRECEDENCE_QTFF_FRMA (LSMASH_BOX_PRECEDENCE_HM + 1 * LSMASH_BOX_PRECEDENCE_S) /* precede any as much as possible */
2027 #define LSMASH_BOX_PRECEDENCE_QTFF_ENDA (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
2028 #define LSMASH_BOX_PRECEDENCE_QTFF_MP4A (LSMASH_BOX_PRECEDENCE_HM - 0 * LSMASH_BOX_PRECEDENCE_S)
2029 #define LSMASH_BOX_PRECEDENCE_QTFF_TERMINATOR (LSMASH_BOX_PRECEDENCE_L - 0 * LSMASH_BOX_PRECEDENCE_S)
2030 #define LSMASH_BOX_PRECEDENCE_ISOM_SRAT (LSMASH_BOX_PRECEDENCE_LP - 1 * LSMASH_BOX_PRECEDENCE_S) /* place at the end for maximum compatibility */
2031 #define LSMASH_BOX_PRECEDENCE_ISOM_FTAB (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
2032 #define LSMASH_BOX_PRECEDENCE_ISOM_STTS (LSMASH_BOX_PRECEDENCE_N - 2 * LSMASH_BOX_PRECEDENCE_S)
2033 #define LSMASH_BOX_PRECEDENCE_ISOM_CTTS (LSMASH_BOX_PRECEDENCE_N - 4 * LSMASH_BOX_PRECEDENCE_S)
2034 #define LSMASH_BOX_PRECEDENCE_ISOM_CSLG (LSMASH_BOX_PRECEDENCE_N - 6 * LSMASH_BOX_PRECEDENCE_S)
2035 #define LSMASH_BOX_PRECEDENCE_ISOM_STSS (LSMASH_BOX_PRECEDENCE_N - 8 * LSMASH_BOX_PRECEDENCE_S)
2036 #define LSMASH_BOX_PRECEDENCE_QTFF_STPS (LSMASH_BOX_PRECEDENCE_N - 10 * LSMASH_BOX_PRECEDENCE_S)
2037 #define LSMASH_BOX_PRECEDENCE_ISOM_SDTP (LSMASH_BOX_PRECEDENCE_N - 12 * LSMASH_BOX_PRECEDENCE_S)
2038 #define LSMASH_BOX_PRECEDENCE_ISOM_STSC (LSMASH_BOX_PRECEDENCE_N - 14 * LSMASH_BOX_PRECEDENCE_S)
2039 #define LSMASH_BOX_PRECEDENCE_ISOM_STSZ (LSMASH_BOX_PRECEDENCE_N - 16 * LSMASH_BOX_PRECEDENCE_S)
2040 #define LSMASH_BOX_PRECEDENCE_ISOM_STZ2 (LSMASH_BOX_PRECEDENCE_N - 16 * LSMASH_BOX_PRECEDENCE_S)
2041 #define LSMASH_BOX_PRECEDENCE_ISOM_STCO (LSMASH_BOX_PRECEDENCE_N - 18 * LSMASH_BOX_PRECEDENCE_S)
2042 #define LSMASH_BOX_PRECEDENCE_ISOM_CO64 (LSMASH_BOX_PRECEDENCE_N - 18 * LSMASH_BOX_PRECEDENCE_S)
2043 #define LSMASH_BOX_PRECEDENCE_ISOM_SGPD (LSMASH_BOX_PRECEDENCE_N - 20 * LSMASH_BOX_PRECEDENCE_S)
2044 #define LSMASH_BOX_PRECEDENCE_ISOM_SBGP (LSMASH_BOX_PRECEDENCE_N - 22 * LSMASH_BOX_PRECEDENCE_S)
2045 #define LSMASH_BOX_PRECEDENCE_ISOM_UDTA (LSMASH_BOX_PRECEDENCE_N - 5 * LSMASH_BOX_PRECEDENCE_S)
2046 #define LSMASH_BOX_PRECEDENCE_ISOM_MEAN (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
2047 #define LSMASH_BOX_PRECEDENCE_ISOM_NAME (LSMASH_BOX_PRECEDENCE_N - 1 * LSMASH_BOX_PRECEDENCE_S)
2048 #define LSMASH_BOX_PRECEDENCE_ISOM_DATA (LSMASH_BOX_PRECEDENCE_N - 2 * LSMASH_BOX_PRECEDENCE_S)
2049 #define LSMASH_BOX_PRECEDENCE_QTFF_KEYS (LSMASH_BOX_PRECEDENCE_N - 1 * LSMASH_BOX_PRECEDENCE_S)
2050 #define LSMASH_BOX_PRECEDENCE_ISOM_ILST (LSMASH_BOX_PRECEDENCE_N - 2 * LSMASH_BOX_PRECEDENCE_S)
2051 #define LSMASH_BOX_PRECEDENCE_ISOM_METAITEM (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
2052 #define LSMASH_BOX_PRECEDENCE_ISOM_CHPL (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
2053 #define LSMASH_BOX_PRECEDENCE_ISOM_META (LSMASH_BOX_PRECEDENCE_N - 7 * LSMASH_BOX_PRECEDENCE_S)
2054 #define LSMASH_BOX_PRECEDENCE_QTFF_WLOC (LSMASH_BOX_PRECEDENCE_N - 8 * LSMASH_BOX_PRECEDENCE_S)
2055 #define LSMASH_BOX_PRECEDENCE_QTFF_LOOP (LSMASH_BOX_PRECEDENCE_N - 9 * LSMASH_BOX_PRECEDENCE_S)
2056 #define LSMASH_BOX_PRECEDENCE_QTFF_SELO (LSMASH_BOX_PRECEDENCE_N - 10 * LSMASH_BOX_PRECEDENCE_S)
2057 #define LSMASH_BOX_PRECEDENCE_QTFF_ALLF (LSMASH_BOX_PRECEDENCE_N - 11 * LSMASH_BOX_PRECEDENCE_S)
2058 #define LSMASH_BOX_PRECEDENCE_ISOM_CPRT (LSMASH_BOX_PRECEDENCE_N - 12 * LSMASH_BOX_PRECEDENCE_S)
2059 #define LSMASH_BOX_PRECEDENCE_QTFF_CTAB (LSMASH_BOX_PRECEDENCE_N - 6 * LSMASH_BOX_PRECEDENCE_S)
2060 #define LSMASH_BOX_PRECEDENCE_ISOM_MVEX (LSMASH_BOX_PRECEDENCE_N - 8 * LSMASH_BOX_PRECEDENCE_S)
2061 #define LSMASH_BOX_PRECEDENCE_ISOM_MEHD (LSMASH_BOX_PRECEDENCE_HM - 0 * LSMASH_BOX_PRECEDENCE_S)
2062 #define LSMASH_BOX_PRECEDENCE_ISOM_TREX (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
2063 #define LSMASH_BOX_PRECEDENCE_ISOM_MOOF (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
2064 #define LSMASH_BOX_PRECEDENCE_ISOM_MFHD (LSMASH_BOX_PRECEDENCE_HM - 0 * LSMASH_BOX_PRECEDENCE_S)
2065 #define LSMASH_BOX_PRECEDENCE_ISOM_TRAF (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
2066 #define LSMASH_BOX_PRECEDENCE_ISOM_TFHD (LSMASH_BOX_PRECEDENCE_HM - 0 * LSMASH_BOX_PRECEDENCE_S)
2067 #define LSMASH_BOX_PRECEDENCE_ISOM_TFDT (LSMASH_BOX_PRECEDENCE_HM - 1 * LSMASH_BOX_PRECEDENCE_S) /* shall be positioned after 'tfhd' and before 'trun' */
2068 #define LSMASH_BOX_PRECEDENCE_ISOM_TRUN (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
2069 #define LSMASH_BOX_PRECEDENCE_ISOM_MFRA (LSMASH_BOX_PRECEDENCE_L - 0 * LSMASH_BOX_PRECEDENCE_S)
2070 #define LSMASH_BOX_PRECEDENCE_ISOM_TFRA (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
2071 #define LSMASH_BOX_PRECEDENCE_ISOM_MFRO (LSMASH_BOX_PRECEDENCE_L - 0 * LSMASH_BOX_PRECEDENCE_S)
2072 #define LSMASH_BOX_PRECEDENCE_ISOM_MDAT (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
2073 #define LSMASH_BOX_PRECEDENCE_ISOM_FREE (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
2074 #define LSMASH_BOX_PRECEDENCE_ISOM_SKIP (LSMASH_BOX_PRECEDENCE_N - 0 * LSMASH_BOX_PRECEDENCE_S)
2076 /* Track reference types */
2077 typedef enum
2079 ISOM_TREF_TYPE_AVCP = LSMASH_4CC( 'a', 'v', 'c', 'p' ), /* AVC parameter set stream link */
2080 ISOM_TREF_TYPE_CDSC = LSMASH_4CC( 'c', 'd', 's', 'c' ), /* This track describes the referenced track. */
2081 ISOM_TREF_TYPE_DPND = LSMASH_4CC( 'd', 'p', 'n', 'd' ), /* This track has an MPEG-4 dependency on the referenced track. */
2082 ISOM_TREF_TYPE_HIND = LSMASH_4CC( 'h', 'i', 'n', 'd' ), /* Hint dependency */
2083 ISOM_TREF_TYPE_HINT = LSMASH_4CC( 'h', 'i', 'n', 't' ), /* Links hint track to original media track */
2084 ISOM_TREF_TYPE_IPIR = LSMASH_4CC( 'i', 'p', 'i', 'r' ), /* This track contains IPI declarations for the referenced track. */
2085 ISOM_TREF_TYPE_MPOD = LSMASH_4CC( 'm', 'p', 'o', 'd' ), /* This track is an OD track which uses the referenced track as an included elementary stream track. */
2086 ISOM_TREF_TYPE_SBAS = LSMASH_4CC( 's', 'b', 'a', 's' ), /* Scalable base */
2087 ISOM_TREF_TYPE_SCAL = LSMASH_4CC( 's', 'c', 'a', 'l' ), /* Scalable extraction */
2088 ISOM_TREF_TYPE_SWFR = LSMASH_4CC( 's', 'w', 'f', 'r' ), /* AVC Switch from */
2089 ISOM_TREF_TYPE_SWTO = LSMASH_4CC( 's', 'w', 't', 'o' ), /* AVC Switch to */
2090 ISOM_TREF_TYPE_SYNC = LSMASH_4CC( 's', 'y', 'n', 'c' ), /* This track uses the referenced track as its synchronization source. */
2091 ISOM_TREF_TYPE_VDEP = LSMASH_4CC( 'v', 'd', 'e', 'p' ), /* Auxiliary video depth */
2092 ISOM_TREF_TYPE_VPLX = LSMASH_4CC( 'v', 'p', 'l', 'x' ), /* Auxiliary video parallax */
2094 QT_TREF_TYPE_CHAP = LSMASH_4CC( 'c', 'h', 'a', 'p' ), /* Chapter or scene list. Usually references a text track. */
2095 QT_TREF_TYPE_SCPT = LSMASH_4CC( 's', 'c', 'p', 't' ), /* Transcript. Usually references a text track. */
2096 QT_TREF_TYPE_SSRC = LSMASH_4CC( 's', 's', 'r', 'c' ), /* Nonprimary source. Indicates that the referenced track should send its data to this track, rather than presenting it. */
2097 QT_TREF_TYPE_TMCD = LSMASH_4CC( 't', 'm', 'c', 'd' ), /* Time code. Usually references a time code track. */
2098 } isom_track_reference_type;
2100 /* Handler types */
2101 enum isom_handler_type
2103 QT_HANDLER_TYPE_DATA = LSMASH_4CC( 'd', 'h', 'l', 'r' ),
2104 QT_HANDLER_TYPE_MEDIA = LSMASH_4CC( 'm', 'h', 'l', 'r' ),
2107 enum isom_meta_type
2109 ISOM_META_HANDLER_TYPE_ITUNES_METADATA = LSMASH_4CC( 'm', 'd', 'i', 'r' ),
2112 /* Data reference types */
2113 enum isom_data_reference_type
2115 ISOM_REFERENCE_HANDLER_TYPE_URL = LSMASH_4CC( 'u', 'r', 'l', ' ' ),
2116 ISOM_REFERENCE_HANDLER_TYPE_URN = LSMASH_4CC( 'u', 'r', 'n', ' ' ),
2118 QT_REFERENCE_HANDLER_TYPE_ALIAS = LSMASH_4CC( 'a', 'l', 'i', 's' ),
2119 QT_REFERENCE_HANDLER_TYPE_RESOURCE = LSMASH_4CC( 'r', 's', 'r', 'c' ),
2120 QT_REFERENCE_HANDLER_TYPE_URL = LSMASH_4CC( 'u', 'r', 'l', ' ' ),
2123 /* Lanuage codes */
2124 typedef struct
2126 uint16_t mac_value;
2127 uint16_t iso_name;
2128 } isom_language_t;
2130 static const isom_language_t isom_languages[] =
2132 { 0, ISOM_LANGUAGE_CODE_ENGLISH },
2133 { 1, ISOM_LANGUAGE_CODE_FRENCH },
2134 { 2, ISOM_LANGUAGE_CODE_GERMAN },
2135 { 3, ISOM_LANGUAGE_CODE_ITALIAN },
2136 { 4, ISOM_LANGUAGE_CODE_DUTCH_M },
2137 { 5, ISOM_LANGUAGE_CODE_SWEDISH },
2138 { 6, ISOM_LANGUAGE_CODE_SPANISH },
2139 { 7, ISOM_LANGUAGE_CODE_DANISH },
2140 { 8, ISOM_LANGUAGE_CODE_PORTUGUESE },
2141 { 9, ISOM_LANGUAGE_CODE_NORWEGIAN },
2142 { 10, ISOM_LANGUAGE_CODE_HEBREW },
2143 { 11, ISOM_LANGUAGE_CODE_JAPANESE },
2144 { 12, ISOM_LANGUAGE_CODE_ARABIC },
2145 { 13, ISOM_LANGUAGE_CODE_FINNISH },
2146 { 14, ISOM_LANGUAGE_CODE_GREEK },
2147 { 15, ISOM_LANGUAGE_CODE_ICELANDIC },
2148 { 16, ISOM_LANGUAGE_CODE_MALTESE },
2149 { 17, ISOM_LANGUAGE_CODE_TURKISH },
2150 { 18, ISOM_LANGUAGE_CODE_CROATIAN },
2151 { 19, ISOM_LANGUAGE_CODE_CHINESE },
2152 { 20, ISOM_LANGUAGE_CODE_URDU },
2153 { 21, ISOM_LANGUAGE_CODE_HINDI },
2154 { 22, ISOM_LANGUAGE_CODE_THAI },
2155 { 23, ISOM_LANGUAGE_CODE_KOREAN },
2156 { 24, ISOM_LANGUAGE_CODE_LITHUANIAN },
2157 { 25, ISOM_LANGUAGE_CODE_POLISH },
2158 { 26, ISOM_LANGUAGE_CODE_HUNGARIAN },
2159 { 27, ISOM_LANGUAGE_CODE_ESTONIAN },
2160 { 28, ISOM_LANGUAGE_CODE_LATVIAN },
2161 { 29, ISOM_LANGUAGE_CODE_SAMI },
2162 { 30, ISOM_LANGUAGE_CODE_FAROESE },
2163 { 32, ISOM_LANGUAGE_CODE_RUSSIAN },
2164 { 33, ISOM_LANGUAGE_CODE_CHINESE },
2165 { 34, ISOM_LANGUAGE_CODE_DUTCH },
2166 { 35, ISOM_LANGUAGE_CODE_IRISH },
2167 { 36, ISOM_LANGUAGE_CODE_ALBANIAN },
2168 { 37, ISOM_LANGUAGE_CODE_ROMANIAN },
2169 { 38, ISOM_LANGUAGE_CODE_CZECH },
2170 { 39, ISOM_LANGUAGE_CODE_SLOVAK },
2171 { 40, ISOM_LANGUAGE_CODE_SLOVENIA },
2172 { 41, ISOM_LANGUAGE_CODE_YIDDISH },
2173 { 42, ISOM_LANGUAGE_CODE_SERBIAN },
2174 { 43, ISOM_LANGUAGE_CODE_MACEDONIAN },
2175 { 44, ISOM_LANGUAGE_CODE_BULGARIAN },
2176 { 45, ISOM_LANGUAGE_CODE_UKRAINIAN },
2177 { 46, ISOM_LANGUAGE_CODE_BELARUSIAN },
2178 { 47, ISOM_LANGUAGE_CODE_UZBEK },
2179 { 48, ISOM_LANGUAGE_CODE_KAZAKH },
2180 { 49, ISOM_LANGUAGE_CODE_AZERBAIJANI },
2181 { 51, ISOM_LANGUAGE_CODE_ARMENIAN },
2182 { 52, ISOM_LANGUAGE_CODE_GEORGIAN },
2183 { 53, ISOM_LANGUAGE_CODE_MOLDAVIAN },
2184 { 54, ISOM_LANGUAGE_CODE_KIRGHIZ },
2185 { 55, ISOM_LANGUAGE_CODE_TAJIK },
2186 { 56, ISOM_LANGUAGE_CODE_TURKMEN },
2187 { 57, ISOM_LANGUAGE_CODE_MONGOLIAN },
2188 { 59, ISOM_LANGUAGE_CODE_PASHTO },
2189 { 60, ISOM_LANGUAGE_CODE_KURDISH },
2190 { 61, ISOM_LANGUAGE_CODE_KASHMIRI },
2191 { 62, ISOM_LANGUAGE_CODE_SINDHI },
2192 { 63, ISOM_LANGUAGE_CODE_TIBETAN },
2193 { 64, ISOM_LANGUAGE_CODE_NEPALI },
2194 { 65, ISOM_LANGUAGE_CODE_SANSKRIT },
2195 { 66, ISOM_LANGUAGE_CODE_MARATHI },
2196 { 67, ISOM_LANGUAGE_CODE_BENGALI },
2197 { 68, ISOM_LANGUAGE_CODE_ASSAMESE },
2198 { 69, ISOM_LANGUAGE_CODE_GUJARATI },
2199 { 70, ISOM_LANGUAGE_CODE_PUNJABI },
2200 { 71, ISOM_LANGUAGE_CODE_ORIYA },
2201 { 72, ISOM_LANGUAGE_CODE_MALAYALAM },
2202 { 73, ISOM_LANGUAGE_CODE_KANNADA },
2203 { 74, ISOM_LANGUAGE_CODE_TAMIL },
2204 { 75, ISOM_LANGUAGE_CODE_TELUGU },
2205 { 76, ISOM_LANGUAGE_CODE_SINHALESE },
2206 { 77, ISOM_LANGUAGE_CODE_BURMESE },
2207 { 78, ISOM_LANGUAGE_CODE_KHMER },
2208 { 79, ISOM_LANGUAGE_CODE_LAO },
2209 { 80, ISOM_LANGUAGE_CODE_VIETNAMESE },
2210 { 81, ISOM_LANGUAGE_CODE_INDONESIAN },
2211 { 82, ISOM_LANGUAGE_CODE_TAGALOG },
2212 { 83, ISOM_LANGUAGE_CODE_MALAY_ROMAN },
2213 { 84, ISOM_LANGUAGE_CODE_MAYAY_ARABIC },
2214 { 85, ISOM_LANGUAGE_CODE_AMHARIC },
2215 { 87, ISOM_LANGUAGE_CODE_OROMO },
2216 { 88, ISOM_LANGUAGE_CODE_SOMALI },
2217 { 89, ISOM_LANGUAGE_CODE_SWAHILI },
2218 { 90, ISOM_LANGUAGE_CODE_KINYARWANDA },
2219 { 91, ISOM_LANGUAGE_CODE_RUNDI },
2220 { 92, ISOM_LANGUAGE_CODE_CHEWA },
2221 { 93, ISOM_LANGUAGE_CODE_MALAGASY },
2222 { 94, ISOM_LANGUAGE_CODE_ESPERANTO },
2223 { 128, ISOM_LANGUAGE_CODE_WELSH },
2224 { 129, ISOM_LANGUAGE_CODE_BASQUE },
2225 { 130, ISOM_LANGUAGE_CODE_CATALAN },
2226 { 131, ISOM_LANGUAGE_CODE_LATIN },
2227 { 132, ISOM_LANGUAGE_CODE_QUECHUA },
2228 { 133, ISOM_LANGUAGE_CODE_GUARANI },
2229 { 134, ISOM_LANGUAGE_CODE_AYMARA },
2230 { 135, ISOM_LANGUAGE_CODE_TATAR },
2231 { 136, ISOM_LANGUAGE_CODE_UIGHUR },
2232 { 137, ISOM_LANGUAGE_CODE_DZONGKHA },
2233 { 138, ISOM_LANGUAGE_CODE_JAVANESE },
2234 { UINT16_MAX, 0 }
2237 /* Color parameters */
2238 enum isom_color_patameter_type
2240 ISOM_COLOR_PARAMETER_TYPE_NCLX = LSMASH_4CC( 'n', 'c', 'l', 'x' ), /* on-screen colours */
2241 ISOM_COLOR_PARAMETER_TYPE_RICC = LSMASH_4CC( 'r', 'I', 'C', 'C' ), /* restricted ICC profile */
2242 ISOM_COLOR_PARAMETER_TYPE_PROF = LSMASH_4CC( 'p', 'r', 'o', 'f' ), /* unrestricted ICC profile */
2244 QT_COLOR_PARAMETER_TYPE_NCLC = LSMASH_4CC( 'n', 'c', 'l', 'c' ), /* NonConstant Luminance Coding */
2245 QT_COLOR_PARAMETER_TYPE_PROF = LSMASH_4CC( 'p', 'r', 'o', 'f' ), /* ICC profile */
2248 /* Sample grouping types */
2249 typedef enum
2251 ISOM_GROUP_TYPE_3GAG = LSMASH_4CC( '3', 'g', 'a', 'g' ), /* Text track3GPP PSS Annex G video buffer parameters */
2252 ISOM_GROUP_TYPE_ALST = LSMASH_4CC( 'a', 'l', 's', 't' ), /* Alternative startup sequence */
2253 ISOM_GROUP_TYPE_AVCB = LSMASH_4CC( 'a', 'v', 'c', 'b' ), /* AVC HRD parameters */
2254 ISOM_GROUP_TYPE_AVLL = LSMASH_4CC( 'a', 'v', 'l', 'l' ), /* AVC Layer */
2255 ISOM_GROUP_TYPE_AVSS = LSMASH_4CC( 'a', 'v', 's', 's' ), /* AVC Sub Sequence */
2256 ISOM_GROUP_TYPE_DTRT = LSMASH_4CC( 'd', 't', 'r', 't' ), /* Decode re-timing */
2257 ISOM_GROUP_TYPE_MVIF = LSMASH_4CC( 'm', 'v', 'i', 'f' ), /* MVC Scalability Information */
2258 ISOM_GROUP_TYPE_PROL = LSMASH_4CC( 'p', 'r', 'o', 'l' ), /* Pre-roll */
2259 ISOM_GROUP_TYPE_RAP = LSMASH_4CC( 'r', 'a', 'p', ' ' ), /* Random Access Point */
2260 ISOM_GROUP_TYPE_RASH = LSMASH_4CC( 'r', 'a', 's', 'h' ), /* Rate Share */
2261 ISOM_GROUP_TYPE_ROLL = LSMASH_4CC( 'r', 'o', 'l', 'l' ), /* Pre-roll/Post-roll */
2262 ISOM_GROUP_TYPE_SCIF = LSMASH_4CC( 's', 'c', 'i', 'f' ), /* SVC Scalability Information */
2263 ISOM_GROUP_TYPE_SCNM = LSMASH_4CC( 's', 'c', 'n', 'm' ), /* AVC/SVC/MVC map groups */
2264 ISOM_GROUP_TYPE_VIPR = LSMASH_4CC( 'v', 'i', 'p', 'r' ), /* View priority */
2265 } isom_grouping_type;
2267 /* wrapper to avoid boring cast */
2268 #define isom_init_box_common( box, parent, box_type, precedence, destructor ) \
2269 isom_init_box_common_orig( box, parent, box_type, precedence, (isom_extension_destructor_t)(destructor) )
2271 void isom_init_box_common_orig
2273 void *box,
2274 void *parent,
2275 lsmash_box_type_t box_type,
2276 uint64_t precedence,
2277 isom_extension_destructor_t destructor
2280 int isom_is_fullbox( void *box );
2281 int isom_is_lpcm_audio( void *box );
2282 int isom_is_qt_audio( lsmash_codec_type_t type );
2283 int isom_is_uncompressed_ycbcr( lsmash_codec_type_t type );
2284 int isom_is_waveform_audio( lsmash_box_type_t type );
2286 size_t isom_skip_box_common
2288 uint8_t **p_data
2291 uint8_t *isom_get_child_box_position
2293 uint8_t *parent_data,
2294 uint32_t parent_size,
2295 lsmash_box_type_t child_type,
2296 uint32_t *child_size
2299 void isom_bs_put_basebox_common( lsmash_bs_t *bs, isom_box_t *box );
2300 void isom_bs_put_fullbox_common( lsmash_bs_t *bs, isom_box_t *box );
2301 void isom_bs_put_box_common( lsmash_bs_t *bs, void *box );
2303 #define isom_is_printable_char( c ) ((c) >= 32 && (c) < 128)
2304 #define isom_is_printable_4cc( fourcc ) \
2305 (isom_is_printable_char( ((fourcc) >> 24) & 0xff ) \
2306 && isom_is_printable_char( ((fourcc) >> 16) & 0xff ) \
2307 && isom_is_printable_char( ((fourcc) >> 8) & 0xff ) \
2308 && isom_is_printable_char( (fourcc) & 0xff ))
2310 #define isom_4cc2str( fourcc ) (const char [5]){ (fourcc) >> 24, (fourcc) >> 16, (fourcc) >> 8, (fourcc), 0 }
2312 int isom_check_initializer_present( lsmash_root_t *root );
2314 isom_trak_t *isom_get_trak( lsmash_file_t *file, uint32_t track_ID );
2315 isom_trex_t *isom_get_trex( isom_mvex_t *mvex, uint32_t track_ID );
2316 isom_traf_t *isom_get_traf( isom_moof_t *moof, uint32_t track_ID );
2317 isom_tfra_t *isom_get_tfra( isom_mfra_t *mfra, uint32_t track_ID );
2318 isom_sgpd_t *isom_get_sample_group_description( isom_stbl_t *stbl, uint32_t grouping_type );
2319 isom_sbgp_t *isom_get_sample_to_group( isom_stbl_t *stbl, uint32_t grouping_type );
2320 isom_sgpd_t *isom_get_roll_recovery_sample_group_description( lsmash_entry_list_t *list );
2321 isom_sbgp_t *isom_get_roll_recovery_sample_to_group( lsmash_entry_list_t *list );
2322 isom_sgpd_t *isom_get_fragment_sample_group_description( isom_traf_t *traf, uint32_t grouping_type );
2323 isom_sbgp_t *isom_get_fragment_sample_to_group( isom_traf_t *traf, uint32_t grouping_type );
2325 isom_trak_t *isom_track_create( lsmash_file_t *file, lsmash_media_type media_type );
2326 isom_moov_t *isom_movie_create( lsmash_file_t *file );
2328 int isom_setup_handler_reference( isom_hdlr_t *hdlr, uint32_t media_type );
2329 int isom_setup_iods( isom_moov_t *moov );
2331 uint32_t isom_get_sample_count
2333 isom_trak_t *trak
2336 isom_sample_pool_t *isom_create_sample_pool
2338 uint64_t size
2341 int isom_update_sample_tables
2343 isom_trak_t *trak,
2344 lsmash_sample_t *sample,
2345 uint32_t *samples_per_packet,
2346 isom_sample_entry_t *sample_entry
2349 int isom_pool_sample
2351 isom_sample_pool_t *pool,
2352 lsmash_sample_t *sample,
2353 uint32_t samples_per_packet
2356 int isom_append_sample_by_type
2358 void *track,
2359 lsmash_sample_t *sample,
2360 isom_sample_entry_t *sample_entry,
2361 int (*func_append_sample)( void *, lsmash_sample_t *, isom_sample_entry_t * )
2364 int isom_calculate_bitrate_description
2366 isom_stbl_t *stbl,
2367 isom_mdhd_t *mdhd,
2368 uint32_t *bufferSizeDB,
2369 uint32_t *maxBitrate,
2370 uint32_t *avgBitrate,
2371 uint32_t sample_description_index
2374 int isom_is_variable_size
2376 isom_stbl_t *stbl
2379 uint32_t isom_get_first_sample_size
2381 isom_stbl_t *stbl
2385 void isom_update_cache_timestamp
2387 isom_cache_t *cache,
2388 uint64_t dts,
2389 uint64_t cts,
2390 int32_t ctd_shift,
2391 uint32_t sample_duration,
2392 int non_output_sample
2395 /* Make CTS from DTS and sample_offset.
2396 * This function does NOT add the value of composition to decode timeline shift to the result. */
2397 static inline uint64_t isom_make_cts
2399 uint64_t dts,
2400 uint32_t sample_offset,
2401 int32_t ctd_shift
2404 if( sample_offset != ISOM_NON_OUTPUT_SAMPLE_OFFSET )
2405 return ctd_shift ? (dts + (int32_t)sample_offset) : (dts + sample_offset);
2406 else
2407 return LSMASH_TIMESTAMP_UNDEFINED;
2410 /* Make CTS from DTS and sample_offset.
2411 * This function adds the value of composition to decode timeline shift to the result. */
2412 static inline uint64_t isom_make_cts_adjust
2414 uint64_t dts,
2415 uint32_t sample_offset,
2416 int32_t ctd_shift
2419 if( sample_offset != ISOM_NON_OUTPUT_SAMPLE_OFFSET )
2420 return ctd_shift ? (dts + (int32_t)sample_offset + ctd_shift) : (dts + sample_offset);
2421 else
2422 return LSMASH_TIMESTAMP_UNDEFINED;
2425 /* Utilities for sample entry type decision
2426 * NOTE: This implementation does not work when 'mdia' and/or 'hdlr' is stored as binary string. */
2427 static inline int isom_check_media_hdlr_from_stsd( isom_stsd_t *stsd )
2429 return ((isom_stbl_t *)stsd->parent
2430 && (isom_minf_t *)stsd->parent->parent
2431 && (isom_mdia_t *)stsd->parent->parent->parent
2432 && ((isom_mdia_t *)stsd->parent->parent->parent)->hdlr);
2434 static inline lsmash_media_type isom_get_media_type_from_stsd( isom_stsd_t *stsd )
2436 assert( isom_check_media_hdlr_from_stsd( stsd ) );
2437 return ((isom_mdia_t *)stsd->parent->parent->parent)->hdlr->componentSubtype;
2440 int isom_add_sample_grouping( isom_box_t *parent, isom_grouping_type grouping_type );
2441 int isom_group_random_access( isom_box_t *parent, isom_cache_t *cache, lsmash_sample_t *sample );
2442 int isom_group_roll_recovery( isom_box_t *parent, isom_cache_t *cache, lsmash_sample_t *sample );
2444 int isom_update_tkhd_duration( isom_trak_t *trak );
2445 int isom_update_bitrate_description( isom_mdia_t *mdia );
2446 int isom_complement_data_reference( isom_minf_t *minf );
2447 int isom_check_large_offset_requirement( isom_moov_t *moov, uint64_t meta_size );
2448 void isom_add_preceding_box_size( isom_moov_t *moov, uint64_t preceding_size );
2449 int isom_establish_movie( lsmash_file_t *file );
2450 int isom_rap_grouping_established( isom_rap_group_t *group, int num_leading_samples_known, isom_sgpd_t *sgpd, int is_fragment );
2451 int isom_all_recovery_completed( isom_sbgp_t *sbgp, lsmash_entry_list_t *pool );
2453 lsmash_file_t *isom_add_file( lsmash_root_t *root );
2454 isom_ftyp_t *isom_add_ftyp( lsmash_file_t *file );
2455 isom_moov_t *isom_add_moov( lsmash_file_t *file );
2456 isom_mvhd_t *isom_add_mvhd( isom_moov_t *moov );
2457 isom_iods_t *isom_add_iods( isom_moov_t *moov );
2458 isom_ctab_t *isom_add_ctab( void *parent_box );
2459 isom_trak_t *isom_add_trak( isom_moov_t *moov );
2460 isom_tkhd_t *isom_add_tkhd( isom_trak_t *trak );
2461 isom_tapt_t *isom_add_tapt( isom_trak_t *trak );
2462 isom_clef_t *isom_add_clef( isom_tapt_t *tapt );
2463 isom_prof_t *isom_add_prof( isom_tapt_t *tapt );
2464 isom_enof_t *isom_add_enof( isom_tapt_t *tapt );
2465 isom_edts_t *isom_add_edts( isom_trak_t *trak );
2466 isom_elst_t *isom_add_elst( isom_edts_t *edts );
2467 isom_tref_t *isom_add_tref( isom_trak_t *trak );
2468 isom_tref_type_t *isom_add_track_reference_type( isom_tref_t *tref, isom_track_reference_type type );
2469 isom_mdia_t *isom_add_mdia( isom_trak_t *trak );
2470 isom_mdhd_t *isom_add_mdhd( isom_mdia_t *mdia );
2471 isom_hdlr_t *isom_add_hdlr( void *parent_box );
2472 isom_minf_t *isom_add_minf( isom_mdia_t *mdia );
2473 isom_vmhd_t *isom_add_vmhd( isom_minf_t *minf );
2474 isom_smhd_t *isom_add_smhd( isom_minf_t *minf );
2475 isom_hmhd_t *isom_add_hmhd( isom_minf_t *minf );
2476 isom_nmhd_t *isom_add_nmhd( isom_minf_t *minf );
2477 isom_gmhd_t *isom_add_gmhd( isom_minf_t *minf );
2478 isom_gmin_t *isom_add_gmin( isom_gmhd_t *gmhd );
2479 isom_text_t *isom_add_text( isom_gmhd_t *gmhd );
2480 isom_dinf_t *isom_add_dinf( void *parent_box );
2481 isom_dref_t *isom_add_dref( isom_dinf_t *dinf );
2482 isom_dref_entry_t *isom_add_dref_entry( isom_dref_t *dref, lsmash_box_type_t type );
2483 isom_stbl_t *isom_add_stbl( isom_minf_t *minf );
2484 isom_stsd_t *isom_add_stsd( isom_stbl_t *stbl );
2485 isom_visual_entry_t *isom_add_visual_description( isom_stsd_t *stsd, lsmash_codec_type_t sample_type );
2486 isom_audio_entry_t *isom_add_audio_description( isom_stsd_t *stsd, lsmash_codec_type_t sample_type );
2487 isom_qt_text_entry_t *isom_add_qt_text_description( isom_stsd_t *stsd );
2488 isom_tx3g_entry_t *isom_add_tx3g_description( isom_stsd_t *stsd );
2489 isom_esds_t *isom_add_esds( void *parent_box );
2490 isom_glbl_t *isom_add_glbl( void *parent_box );
2491 isom_clap_t *isom_add_clap( isom_visual_entry_t *visual );
2492 isom_pasp_t *isom_add_pasp( isom_visual_entry_t *visual );
2493 isom_colr_t *isom_add_colr( isom_visual_entry_t *visual );
2494 isom_gama_t *isom_add_gama( isom_visual_entry_t *visual );
2495 isom_fiel_t *isom_add_fiel( isom_visual_entry_t *visual );
2496 isom_cspc_t *isom_add_cspc( isom_visual_entry_t *visual );
2497 isom_sgbt_t *isom_add_sgbt( isom_visual_entry_t *visual );
2498 isom_stsl_t *isom_add_stsl( isom_visual_entry_t *visual );
2499 isom_btrt_t *isom_add_btrt( isom_visual_entry_t *visual );
2500 isom_wave_t *isom_add_wave( isom_audio_entry_t *audio );
2501 isom_frma_t *isom_add_frma( isom_wave_t *wave );
2502 isom_enda_t *isom_add_enda( isom_wave_t *wave );
2503 isom_mp4a_t *isom_add_mp4a( isom_wave_t *wave );
2504 isom_terminator_t *isom_add_terminator( isom_wave_t *wave );
2505 isom_chan_t *isom_add_chan( isom_audio_entry_t *audio );
2506 isom_srat_t *isom_add_srat( isom_audio_entry_t *audio );
2507 isom_ftab_t *isom_add_ftab( isom_tx3g_entry_t *tx3g );
2508 isom_stts_t *isom_add_stts( isom_stbl_t *stbl );
2509 isom_ctts_t *isom_add_ctts( isom_stbl_t *stbl );
2510 isom_cslg_t *isom_add_cslg( isom_stbl_t *stbl );
2511 isom_stsc_t *isom_add_stsc( isom_stbl_t *stbl );
2512 isom_stsz_t *isom_add_stsz( isom_stbl_t *stbl );
2513 isom_stz2_t *isom_add_stz2( isom_stbl_t *stbl );
2514 isom_stss_t *isom_add_stss( isom_stbl_t *stbl );
2515 isom_stps_t *isom_add_stps( isom_stbl_t *stbl );
2516 isom_sdtp_t *isom_add_sdtp( isom_box_t *parent );
2517 isom_sgpd_t *isom_add_sgpd( void *parent_box );
2518 isom_sbgp_t *isom_add_sbgp( void *parent_box );
2519 isom_stco_t *isom_add_stco( isom_stbl_t *stbl );
2520 isom_stco_t *isom_add_co64( isom_stbl_t *stbl );
2521 isom_udta_t *isom_add_udta( void *parent_box );
2522 isom_cprt_t *isom_add_cprt( isom_udta_t *udta );
2523 isom_WLOC_t *isom_add_WLOC( isom_udta_t *udta );
2524 isom_LOOP_t *isom_add_LOOP( isom_udta_t *udta );
2525 isom_SelO_t *isom_add_SelO( isom_udta_t *udta );
2526 isom_AllF_t *isom_add_AllF( isom_udta_t *udta );
2527 isom_chpl_t *isom_add_chpl( isom_udta_t *udta );
2528 isom_meta_t *isom_add_meta( void *parent_box );
2529 isom_keys_t *isom_add_keys( isom_meta_t *meta );
2530 isom_ilst_t *isom_add_ilst( isom_meta_t *meta );
2531 isom_metaitem_t *isom_add_metaitem( isom_ilst_t *ilst, lsmash_itunes_metadata_item item );
2532 isom_mean_t *isom_add_mean( isom_metaitem_t *metaitem );
2533 isom_name_t *isom_add_name( isom_metaitem_t *metaitem );
2534 isom_data_t *isom_add_data( isom_metaitem_t *metaitem );
2535 isom_mvex_t *isom_add_mvex( isom_moov_t *moov );
2536 isom_mehd_t *isom_add_mehd( isom_mvex_t *mvex );
2537 isom_trex_t *isom_add_trex( isom_mvex_t *mvex );
2538 isom_moof_t *isom_add_moof( lsmash_file_t *file );
2539 isom_mfhd_t *isom_add_mfhd( isom_moof_t *moof );
2540 isom_traf_t *isom_add_traf( isom_moof_t *moof );
2541 isom_tfhd_t *isom_add_tfhd( isom_traf_t *traf );
2542 isom_tfdt_t *isom_add_tfdt( isom_traf_t *traf );
2543 isom_trun_t *isom_add_trun( isom_traf_t *traf );
2544 isom_mfra_t *isom_add_mfra( lsmash_file_t *file );
2545 isom_tfra_t *isom_add_tfra( isom_mfra_t *mfra );
2546 isom_mfro_t *isom_add_mfro( isom_mfra_t *mfra );
2547 isom_mdat_t *isom_add_mdat( lsmash_file_t *file );
2548 isom_free_t *isom_add_free( void *parent_box );
2549 isom_styp_t *isom_add_styp( lsmash_file_t *file );
2550 isom_sidx_t *isom_add_sidx( lsmash_file_t *file );
2552 void isom_remove_sample_description( isom_sample_entry_t *sample );
2553 void isom_remove_unknown_box( isom_unknown_box_t *unknown_box );
2554 void isom_remove_sample_pool( isom_sample_pool_t *pool );
2556 uint64_t isom_update_box_size( void *box );
2558 int isom_add_extension_binary( void *parent_box, lsmash_box_type_t box_type, uint64_t precedence, uint8_t *box_data, uint32_t box_size );
2559 void isom_remove_all_extension_boxes( lsmash_entry_list_t *extensions );
2560 isom_box_t *isom_get_extension_box( lsmash_entry_list_t *extensions, lsmash_box_type_t box_type );
2561 void *isom_get_extension_box_format( lsmash_entry_list_t *extensions, lsmash_box_type_t box_type );
2562 void isom_remove_box_by_itself( void *opaque_box );
2564 #endif