Fix a crash when checking compatibilities of segment files.
[L-SMASH.git] / lsmash.h
blob1f05255937421b0cfb494411127fc961ded7517f
1 /*****************************************************************************
2 * lsmash.h:
3 *****************************************************************************
4 * Copyright (C) 2010-2014 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_H
24 #define LSMASH_H
26 #include <stddef.h>
27 #include <stdint.h>
29 #define PRIVATE /* If this declaration is placed at a variable, any user shall NOT use it. */
31 #define LSMASH_4CC( a, b, c, d ) (((a)<<24) | ((b)<<16) | ((c)<<8) | (d))
33 /****************************************************************************
34 * Version
35 ****************************************************************************/
36 #define LSMASH_VERSION_MAJOR 1
37 #define LSMASH_VERSION_MINOR 13
38 #define LSMASH_VERSION_MICRO 28
40 #define LSMASH_VERSION_INT( a, b, c ) (((a) << 16) | ((b) << 8) | (c))
42 /****************************************************************************
43 * ROOT
44 * The top-level opaque handler for whole file handling.
45 ****************************************************************************/
46 typedef struct lsmash_root_tag lsmash_root_t;
47 typedef struct lsmash_file_tag lsmash_file_t;
49 typedef enum
51 LSMASH_FILE_MODE_WRITE = 1, /* output/muxing */
52 LSMASH_FILE_MODE_READ = 1<<1, /* input/demuxing */
53 LSMASH_FILE_MODE_FRAGMENTED = 1<<2, /* movie fragments */
54 LSMASH_FILE_MODE_DUMP = 1<<3,
55 LSMASH_FILE_MODE_BOX = 1<<4, /* box structure */
56 LSMASH_FILE_MODE_INITIALIZATION = 1<<5, /* movie sample table */
57 LSMASH_FILE_MODE_MEDIA = 1<<6, /* media data */
58 LSMASH_FILE_MODE_INDEX = 1<<7,
59 LSMASH_FILE_MODE_SEGMENT = 1<<8, /* segment */
60 LSMASH_FILE_MODE_WRITE_FRAGMENTED = LSMASH_FILE_MODE_WRITE | LSMASH_FILE_MODE_FRAGMENTED, /* deprecated */
61 } lsmash_file_mode;
63 typedef enum
65 ISOM_BRAND_TYPE_3G2A = LSMASH_4CC( '3', 'g', '2', 'a' ), /* 3GPP2 */
66 ISOM_BRAND_TYPE_3GE6 = LSMASH_4CC( '3', 'g', 'e', '6' ), /* 3GPP Release 6 Extended Presentation Profile */
67 ISOM_BRAND_TYPE_3GE9 = LSMASH_4CC( '3', 'g', 'e', '9' ), /* 3GPP Release 9 Extended Presentation Profile */
68 ISOM_BRAND_TYPE_3GF9 = LSMASH_4CC( '3', 'g', 'f', '9' ), /* 3GPP Release 9 File-delivery Server Profile */
69 ISOM_BRAND_TYPE_3GG6 = LSMASH_4CC( '3', 'g', 'g', '6' ), /* 3GPP Release 6 General Profile */
70 ISOM_BRAND_TYPE_3GG9 = LSMASH_4CC( '3', 'g', 'g', '9' ), /* 3GPP Release 9 General Profile */
71 ISOM_BRAND_TYPE_3GH9 = LSMASH_4CC( '3', 'g', 'h', '9' ), /* 3GPP Release 9 Adaptive Streaming Profile */
72 ISOM_BRAND_TYPE_3GM9 = LSMASH_4CC( '3', 'g', 'm', '9' ), /* 3GPP Release 9 Media Segment Profile */
73 ISOM_BRAND_TYPE_3GP4 = LSMASH_4CC( '3', 'g', 'p', '4' ), /* 3GPP Release 4 */
74 ISOM_BRAND_TYPE_3GP5 = LSMASH_4CC( '3', 'g', 'p', '5' ), /* 3GPP Release 5 */
75 ISOM_BRAND_TYPE_3GP6 = LSMASH_4CC( '3', 'g', 'p', '6' ), /* 3GPP Release 6 Basic Profile */
76 ISOM_BRAND_TYPE_3GP7 = LSMASH_4CC( '3', 'g', 'p', '7' ), /* 3GPP Release 7 */
77 ISOM_BRAND_TYPE_3GP8 = LSMASH_4CC( '3', 'g', 'p', '8' ), /* 3GPP Release 8 */
78 ISOM_BRAND_TYPE_3GP9 = LSMASH_4CC( '3', 'g', 'p', '9' ), /* 3GPP Release 9 Basic Profile */
79 ISOM_BRAND_TYPE_3GR6 = LSMASH_4CC( '3', 'g', 'r', '6' ), /* 3GPP Release 6 Progressive Download Profile */
80 ISOM_BRAND_TYPE_3GR9 = LSMASH_4CC( '3', 'g', 'r', '9' ), /* 3GPP Release 9 Progressive Download Profile */
81 ISOM_BRAND_TYPE_3GS6 = LSMASH_4CC( '3', 'g', 's', '6' ), /* 3GPP Release 6 Streaming Server Profile */
82 ISOM_BRAND_TYPE_3GS9 = LSMASH_4CC( '3', 'g', 's', '9' ), /* 3GPP Release 9 Streaming Server Profile */
83 ISOM_BRAND_TYPE_3GT9 = LSMASH_4CC( '3', 'g', 't', '9' ), /* 3GPP Release 9 Media Stream Recording Profile */
84 ISOM_BRAND_TYPE_ARRI = LSMASH_4CC( 'A', 'R', 'R', 'I' ), /* ARRI Digital Camera */
85 ISOM_BRAND_TYPE_CAEP = LSMASH_4CC( 'C', 'A', 'E', 'P' ), /* Canon Digital Camera */
86 ISOM_BRAND_TYPE_CDES = LSMASH_4CC( 'C', 'D', 'e', 's' ), /* Convergent Designs */
87 ISOM_BRAND_TYPE_LCAG = LSMASH_4CC( 'L', 'C', 'A', 'G' ), /* Leica digital camera */
88 ISOM_BRAND_TYPE_M4A = LSMASH_4CC( 'M', '4', 'A', ' ' ), /* iTunes MPEG-4 audio protected or not */
89 ISOM_BRAND_TYPE_M4B = LSMASH_4CC( 'M', '4', 'B', ' ' ), /* iTunes AudioBook protected or not */
90 ISOM_BRAND_TYPE_M4P = LSMASH_4CC( 'M', '4', 'P', ' ' ), /* MPEG-4 protected audio */
91 ISOM_BRAND_TYPE_M4V = LSMASH_4CC( 'M', '4', 'V', ' ' ), /* MPEG-4 protected audio+video */
92 ISOM_BRAND_TYPE_MFSM = LSMASH_4CC( 'M', 'F', 'S', 'M' ), /* Media File for Samsung video Metadata */
93 ISOM_BRAND_TYPE_MPPI = LSMASH_4CC( 'M', 'P', 'P', 'I' ), /* Photo Player Multimedia Application Format */
94 ISOM_BRAND_TYPE_ROSS = LSMASH_4CC( 'R', 'O', 'S', 'S' ), /* Ross Video */
95 ISOM_BRAND_TYPE_AVC1 = LSMASH_4CC( 'a', 'v', 'c', '1' ), /* Advanced Video Coding extensions */
96 ISOM_BRAND_TYPE_BBXM = LSMASH_4CC( 'b', 'b', 'x', 'm' ), /* Blinkbox Master File */
97 ISOM_BRAND_TYPE_CAQV = LSMASH_4CC( 'c', 'a', 'q', 'v' ), /* Casio Digital Camera */
98 ISOM_BRAND_TYPE_CCFF = LSMASH_4CC( 'c', 'c', 'f', 'f' ), /* Common container file format */
99 ISOM_BRAND_TYPE_DA0A = LSMASH_4CC( 'd', 'a', '0', 'a' ), /* DMB AF */
100 ISOM_BRAND_TYPE_DA0B = LSMASH_4CC( 'd', 'a', '0', 'b' ), /* DMB AF */
101 ISOM_BRAND_TYPE_DA1A = LSMASH_4CC( 'd', 'a', '1', 'a' ), /* DMB AF */
102 ISOM_BRAND_TYPE_DA1B = LSMASH_4CC( 'd', 'a', '1', 'b' ), /* DMB AF */
103 ISOM_BRAND_TYPE_DA2A = LSMASH_4CC( 'd', 'a', '2', 'a' ), /* DMB AF */
104 ISOM_BRAND_TYPE_DA2B = LSMASH_4CC( 'd', 'a', '2', 'b' ), /* DMB AF */
105 ISOM_BRAND_TYPE_DA3A = LSMASH_4CC( 'd', 'a', '3', 'a' ), /* DMB AF */
106 ISOM_BRAND_TYPE_DA3B = LSMASH_4CC( 'd', 'a', '3', 'b' ), /* DMB AF */
107 ISOM_BRAND_TYPE_DASH = LSMASH_4CC( 'd', 'a', 's', 'h' ), /* Indexed self-initializing Media Segment */
108 ISOM_BRAND_TYPE_DBY1 = LSMASH_4CC( 'd', 'b', 'y', '1' ), /* MP4 files with Dolby content */
109 ISOM_BRAND_TYPE_DMB1 = LSMASH_4CC( 'd', 'm', 'b', '1' ), /* DMB AF */
110 ISOM_BRAND_TYPE_DSMS = LSMASH_4CC( 'd', 's', 'm', 's' ), /* Self-initializing Media Segment */
111 ISOM_BRAND_TYPE_DV1A = LSMASH_4CC( 'd', 'v', '1', 'a' ), /* DMB AF */
112 ISOM_BRAND_TYPE_DV1B = LSMASH_4CC( 'd', 'v', '1', 'b' ), /* DMB AF */
113 ISOM_BRAND_TYPE_DV2A = LSMASH_4CC( 'd', 'v', '2', 'a' ), /* DMB AF */
114 ISOM_BRAND_TYPE_DV2B = LSMASH_4CC( 'd', 'v', '2', 'b' ), /* DMB AF */
115 ISOM_BRAND_TYPE_DV3A = LSMASH_4CC( 'd', 'v', '3', 'a' ), /* DMB AF */
116 ISOM_BRAND_TYPE_DV3B = LSMASH_4CC( 'd', 'v', '3', 'b' ), /* DMB AF */
117 ISOM_BRAND_TYPE_DVR1 = LSMASH_4CC( 'd', 'v', 'r', '1' ), /* DVB RTP */
118 ISOM_BRAND_TYPE_DVT1 = LSMASH_4CC( 'd', 'v', 't', '1' ), /* DVB Transport Stream */
119 ISOM_BRAND_TYPE_IFRM = LSMASH_4CC( 'i', 'f', 'r', 'm' ), /* Apple iFrame */
120 ISOM_BRAND_TYPE_ISC2 = LSMASH_4CC( 'i', 's', 'c', '2' ), /* Files encrypted according to ISMACryp 2.0 */
121 ISOM_BRAND_TYPE_ISO2 = LSMASH_4CC( 'i', 's', 'o', '2' ), /* ISO Base Media file format version 2 */
122 ISOM_BRAND_TYPE_ISO3 = LSMASH_4CC( 'i', 's', 'o', '3' ), /* ISO Base Media file format version 3 */
123 ISOM_BRAND_TYPE_ISO4 = LSMASH_4CC( 'i', 's', 'o', '4' ), /* ISO Base Media file format version 4 */
124 ISOM_BRAND_TYPE_ISO5 = LSMASH_4CC( 'i', 's', 'o', '5' ), /* ISO Base Media file format version 5 */
125 ISOM_BRAND_TYPE_ISO6 = LSMASH_4CC( 'i', 's', 'o', '6' ), /* ISO Base Media file format version 6 */
126 ISOM_BRAND_TYPE_ISO7 = LSMASH_4CC( 'i', 's', 'o', '7' ), /* ISO Base Media file format version 7 */
127 ISOM_BRAND_TYPE_ISOM = LSMASH_4CC( 'i', 's', 'o', 'm' ), /* ISO Base Media file format version 1 */
128 ISOM_BRAND_TYPE_JPSI = LSMASH_4CC( 'j', 'p', 's', 'i' ), /* The JPSearch data interchange format */
129 ISOM_BRAND_TYPE_LMSG = LSMASH_4CC( 'l', 'm', 's', 'g' ), /* last Media Segment indicator */
130 ISOM_BRAND_TYPE_MJ2S = LSMASH_4CC( 'm', 'j', '2', 's' ), /* Motion JPEG 2000 simple profile */
131 ISOM_BRAND_TYPE_MJP2 = LSMASH_4CC( 'm', 'j', 'p', '2' ), /* Motion JPEG 2000, general profile */
132 ISOM_BRAND_TYPE_MP21 = LSMASH_4CC( 'm', 'p', '2', '1' ), /* MPEG-21 */
133 ISOM_BRAND_TYPE_MP41 = LSMASH_4CC( 'm', 'p', '4', '1' ), /* MP4 version 1 */
134 ISOM_BRAND_TYPE_MP42 = LSMASH_4CC( 'm', 'p', '4', '2' ), /* MP4 version 2 */
135 ISOM_BRAND_TYPE_MP71 = LSMASH_4CC( 'm', 'p', '7', '1' ), /* MPEG-7 file-level metadata */
136 ISOM_BRAND_TYPE_MSDH = LSMASH_4CC( 'm', 's', 'd', 'h' ), /* Media Segment */
137 ISOM_BRAND_TYPE_MSIX = LSMASH_4CC( 'm', 's', 'i', 'x' ), /* Indexed Media Segment */
138 ISOM_BRAND_TYPE_NIKO = LSMASH_4CC( 'n', 'i', 'k', 'o' ), /* Nikon Digital Camera */
139 ISOM_BRAND_TYPE_ODCF = LSMASH_4CC( 'o', 'd', 'c', 'f' ), /* OMA DCF */
140 ISOM_BRAND_TYPE_OPF2 = LSMASH_4CC( 'o', 'p', 'f', '2' ), /* OMA PDCF */
141 ISOM_BRAND_TYPE_OPX2 = LSMASH_4CC( 'o', 'p', 'x', '2' ), /* OMA Adapted PDCF */
142 ISOM_BRAND_TYPE_PANA = LSMASH_4CC( 'p', 'a', 'n', 'a' ), /* Panasonic Digital Camera */
143 ISOM_BRAND_TYPE_PIFF = LSMASH_4CC( 'p', 'i', 'f', 'f' ), /* Protected Interoperable File Format */
144 ISOM_BRAND_TYPE_PNVI = LSMASH_4CC( 'p', 'n', 'v', 'i' ), /* Panasonic Video Intercom */
145 ISOM_BRAND_TYPE_QT = LSMASH_4CC( 'q', 't', ' ', ' ' ), /* QuickTime file format */
146 ISOM_BRAND_TYPE_RISX = LSMASH_4CC( 'r', 'i', 's', 'x' ), /* Representation Index Segment */
147 ISOM_BRAND_TYPE_SDV = LSMASH_4CC( 's', 'd', 'v', ' ' ), /* SD Video */
148 ISOM_BRAND_TYPE_SIMS = LSMASH_4CC( 's', 'i', 'm', 's' ), /* Sub-Indexed Media Segment */
149 ISOM_BRAND_TYPE_SISX = LSMASH_4CC( 's', 'i', 's', 'x' ), /* Single Index Segment */
150 ISOM_BRAND_TYPE_SSSS = LSMASH_4CC( 's', 's', 's', 's' ), /* Subsegment Index Segment */
151 } lsmash_brand_type;
153 typedef struct
155 lsmash_file_mode mode; /* file modes */
156 /** custom I/O stuff **/
157 void *opaque; /* custom I/O opaque handler used for the following callback functions */
158 /* Attempt to read up to 'size' bytes from the file referenced by 'opaque' into the buffer starting at 'buf'.
160 * Return the number of bytes read if successful.
161 * Return 0 if no more read.
162 * Return a negative value otherwise. */
163 int (*read)
165 void *opaque,
166 uint8_t *buf,
167 int size
169 /* Write up to 'size' bytes to the file referenced by 'opaque' from the buffer starting at 'buf'.
171 * Return the number of bytes written if successful.
172 * Return a negative value otherwise. */
173 int (*write)
175 void *opaque,
176 uint8_t *buf,
177 int size
179 /* Change the location of the read/write pointer of 'opaque'.
180 * The offset of the pointer is determined according to the directive 'whence' as follows:
181 * If 'whence' is set to SEEK_SET, the offset is set to 'offset' bytes.
182 * If 'whence' is set to SEEK_CUR, the offset is set to its current location plus 'offset' bytes.
183 * If 'whence' is set to SEEK_END, the offset is set to the size of the file plus 'offset' bytes.
185 * Return the resulting offset of the location in bytes from the beginning of the file if successful.
186 * Return a negative value otherwise. */
187 int64_t (*seek)
189 void *opaque,
190 int64_t offset,
191 int whence
193 /** file types or segment types **/
194 lsmash_brand_type major_brand; /* the best used brand */
195 lsmash_brand_type *brands; /* the list of compatible brands */
196 uint32_t brand_count; /* the number of compatible brands used in the file */
197 uint32_t minor_version; /* minor version of the best used brand
198 * minor_version is informative only i.e. not specifying requirements but merely providing information.
199 * It must not be used to determine the conformance of a file to a standard. */
200 /** muxing only **/
201 double max_chunk_duration; /* max duration per chunk in seconds. 0.5 is default value. */
202 double max_async_tolerance; /* max tolerance, in seconds, for amount of interleaving asynchronization between tracks.
203 * 2.0 is default value. At least twice of max_chunk_duration is used. */
204 uint64_t max_chunk_size; /* max size per chunk in bytes. 4*1024*1024 (4MiB) is default value. */
205 /** demuxing only **/
206 uint64_t max_read_size; /* max size of reading from the file at a time. 4*1024*1024 (4MiB) is default value. */
207 } lsmash_file_parameters_t;
209 /* Allocate a ROOT.
210 * The allocated ROOT can be deallocate by lsmash_destroy_root().
212 * Return the address of an allocated ROOT if successful.
213 * Return NULL otherwise. */
214 lsmash_root_t *lsmash_create_root( void );
216 /* Open a file where the path is given.
217 * And if successful, set up the parameters by 'open_mode'.
218 * Here, the 'open_mode' parameter is either 0 or 1 as follows:
219 * 0: Create a file for output/muxing operations.
220 * If a file with the same name already exists, its contents are discarded and the file is treated as a new file.
221 * If user specifies "-" for 'filename', operations are done on stdout.
222 * The file types or segment types are set up as specified in 'param'.
223 * 1: Open a file for input/demuxing operations. The file must exist.
224 * If user specifies "-" for 'filename', operations are done on stdin.
226 * This function sets up file modes minimally.
227 * User can add additional modes and/or remove modes already set later.
228 * The other parameters except for the custom I/O stuff are set to a default.
229 * User shall not touch the custom I/O stuff for the opened file if using this function.
231 * The opened file can be closed by lsmash_close_file().
233 * Note:
234 * 'filename' must be encoded by UTF-8 if 'open_mode' is equal to 0.
235 * On Windows, lsmash_convert_ansi_to_utf8() may help you.
237 * Return 0 if successful.
238 * Return a negative value otherwise. */
239 int lsmash_open_file
241 const char *filename,
242 int open_mode,
243 lsmash_file_parameters_t *param
246 /* Close a file opened by lsmash_open_file().
248 * Return 0 if successful.
249 * Return a negative value otherwise. */
250 int lsmash_close_file
252 lsmash_file_parameters_t *param
255 /* Associate a file with a ROOT and allocate the handle of that file.
256 * The all allocated handles can be deallocated by lsmash_destroy_root().
258 * Note:
259 * At present, the added file is only referenced by all tracks of the movie defined in the same file.
260 * External data references are not implemented yet, but will come in the near future.
262 * Return the address of the allocated handle of the added file if successful.
263 * Return NULL otherwise. */
264 lsmash_file_t *lsmash_set_file
266 lsmash_root_t *root,
267 lsmash_file_parameters_t *param
270 /* Read whole boxes in a given file.
271 * You can also get file modes and file types or segment types by this function.
273 * Return the file size (if seekable) or 0 if successful.
274 * Return a negative value otherwise. */
275 int64_t lsmash_read_file
277 lsmash_file_t *file,
278 lsmash_file_parameters_t *param
281 /* Open the movie file to which the path is given, and allocate and set up the ROOT of the file.
282 * The allocated ROOT can be deallocated by lsmash_destroy_root().
284 * Users can specify "-" for 'filename'.
285 * In this case,
286 * (1) read from stdin when 'mode' contains LSMASH_FILE_MODE_READ,
287 * or
288 * (2) write into stdout when 'mode' contains LSMASH_FILE_MODE_WRITE_FRAGMENTED.
290 * Note that 'filename' must be encoded by UTF-8 if 'mode' contains LSMASH_FILE_MODE_WRITE.
291 * On Windows, lsmash_convert_ansi_to_utf8() may help you.
293 * WARNING: This function is deprecated!
295 * Return the address of an allocated ROOT of the file if successful.
296 * Return NULL otherwise. */
297 lsmash_root_t *lsmash_open_movie
299 const char *filename, /* the path of a file you want to open. */
300 lsmash_file_mode mode /* mode for opening file */
303 /* Deallocate a given ROOT. */
304 void lsmash_destroy_root
306 lsmash_root_t *root /* the address of a ROOT you want to deallocate */
309 /* Deallocate all boxes in a given ROOT. */
310 void lsmash_discard_boxes
312 lsmash_root_t *root /* the address of a ROOT you want to deallocate all boxes in it */
315 /****************************************************************************
316 * Basic Types
317 ****************************************************************************/
318 /* rational types */
319 typedef struct
321 uint32_t n; /* numerator */
322 uint32_t d; /* denominator */
323 } lsmash_rational_u32_t;
325 typedef struct
327 int32_t n; /* numerator */
328 uint32_t d; /* denominator */
329 } lsmash_rational_s32_t;
331 typedef enum
333 LSMASH_BOOLEAN_FALSE = 0,
334 LSMASH_BOOLEAN_TRUE = 1
335 } lsmash_boolean_t;
337 /****************************************************************************
338 * Allocation
339 ****************************************************************************/
340 /* Allocate a memory block.
341 * The allocated memory block can be deallocate by lsmash_free().
343 * Return the address to the beginning of a memory block if successful.
344 * Return NULL otherwise. */
345 void *lsmash_malloc
347 size_t size /* size of a memory block, in bytes */
350 /* Allocate a memory block.
351 * The allocated memory block shall be initialized to all bits 0.
352 * The allocated memory block can be deallocate by lsmash_free().
354 * Return the address to the beginning of a memory block if successful.
355 * Return NULL otherwise. */
356 void *lsmash_malloc_zero
358 size_t size /* size of a memory block, in bytes */
361 /* Reallocate a memory block.
362 * The reallocated memory block can be deallocate by lsmash_free().
363 * If this function succeed, the given memory block is deallocated and the address is invalid.
364 * If this function fails, the address to the given memory block is still valid and the memory block is unchanged.
366 * Return the address to the beginning of a memory block if successful.
367 * Return NULL otherwise. */
368 void *lsmash_realloc
370 void *ptr, /* an address to a memory block previously allocated with
371 * lsmash_malloc(), lsmash_malloc_zero(), lsmash_realloc() or lsmash_memdup()
372 * Alternatively, NULL makes this function to allocate a new memory block. */
373 size_t size /* size of a memory block, in bytes */
376 /* Allocate a memory block and copy all bits from a given memory block.
377 * The allocated memory block can be deallocate by lsmash_free().
379 * Return the address to the beginning of an allocated memory block if successful.
380 * Return NULL otherwise. */
381 void *lsmash_memdup
383 const void *ptr, /* an address to the source of data to be copied */
384 size_t size /* number of bytes to copy */
387 /* Deallocate a given memory block.
388 * If the given address to a memory block is NULL, this function does nothing. */
389 void lsmash_free
391 void *ptr /* an address to a memory block previously allocated with
392 * lsmash_malloc(), lsmash_malloc_zero(), lsmash_realloc() or lsmash_memdup() */
395 /* Deallocate a given memory block.
396 * If the given address to a memory block is NULL, this function does nothing.
397 * Set NULL to the pointer to the memory block after deallocating.
399 * As an example of usage.
400 * Let's say you allocate a memory block and set the address to the beginning of it to the pointer 'ptr'.
401 * You can deallocate the memory block and set NULL to 'ptr' by lsmash_freep( &ptr ).
403 void lsmash_freep
405 void *ptrptr /* the address to a pointer to a memory block previously allocated with
406 * lsmash_malloc(), lsmash_malloc_zero(), lsmash_realloc() or lsmash_memdup() */
409 /****************************************************************************
410 * Box
411 ****************************************************************************/
412 typedef struct lsmash_box_tag lsmash_box_t;
413 typedef uint32_t lsmash_compact_box_type_t;
415 /* An UUID structure for extended box type */
416 typedef struct
418 uint32_t fourcc; /* four characters codes that identify extended box type partially
419 * If the box is not a UUID box, this field shall be the same as the box type.
420 * Note: characters in this field aren't always printable. */
421 uint8_t id[12]; /* If the box is not a UUID box, this field shall be set to 12-byte ISO reserved value
422 * { 0x00, 0x11, 0x00, 0x10, 0x80, 0x00, 0x00, 0xAA, 0x00, 0x38, 0x9B, 0x71 }
423 * and shall not be written into the stream together with above-defined four characters codes.
424 * As an exception, we could set the value
425 * { 0x0F, 0x11, 0x4D, 0xA5, 0xBF, 0x4E, 0xF2, 0xC4, 0x8C, 0x6A, 0xA1, 0x1E }
426 * to indicate the box is derived from QuickTime file format. */
427 } lsmash_extended_box_type_t;
429 typedef struct
431 lsmash_compact_box_type_t fourcc; /* four characters codes that identify box type
432 * Note: characters in this field aren't always printable. */
433 lsmash_extended_box_type_t user; /* Universal Unique IDentifier, i.e. UUID */
434 /* If 'fourcc' doesn't equal 'uuid', ignore this field. */
435 } lsmash_box_type_t;
437 typedef struct
439 lsmash_box_type_t type; /* box type */
440 uint32_t number; /* the number of box in ascending order excluding boxes unspecified by 'type' within
441 * the same level of the box nested structure. */
442 } lsmash_box_path_t;
444 #define LSMASH_BOX_TYPE_INITIALIZER { 0x00000000, { 0x00000000, { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 } } }
445 #define LSMASH_BOX_TYPE_UNSPECIFIED static_lsmash_box_type_unspecified
446 static const lsmash_box_type_t static_lsmash_box_type_unspecified = LSMASH_BOX_TYPE_INITIALIZER;
448 /* Return extended box type that consists of combination of given FourCC and 12-byte ID. */
449 lsmash_extended_box_type_t lsmash_form_extended_box_type
451 uint32_t fourcc,
452 const uint8_t id[12]
455 /* Return box type that consists of combination of given compact and extended box type. */
456 lsmash_box_type_t lsmash_form_box_type
458 lsmash_compact_box_type_t type,
459 lsmash_extended_box_type_t user
462 #define LSMASH_ISO_BOX_TYPE_INITIALIZER( x ) { x, { x, { 0x00, 0x11, 0x00, 0x10, 0x80, 0x00, 0x00, 0xAA, 0x00, 0x38, 0x9B, 0x71 } } }
463 #define LSMASH_QTFF_BOX_TYPE_INITIALIZER( x ) { x, { x, { 0x0F, 0x11, 0x4D, 0xA5, 0xBF, 0x4E, 0xF2, 0xC4, 0x8C, 0x6A, 0xA1, 0x1E } } }
464 lsmash_box_type_t lsmash_form_iso_box_type( lsmash_compact_box_type_t type );
465 lsmash_box_type_t lsmash_form_qtff_box_type( lsmash_compact_box_type_t type );
467 /* precedence of the box position
468 * Box with higher value will precede physically other boxes with lower one.
469 * The lower 32-bits are intended to determine order of boxes with the same box type. */
470 #define LSMASH_BOX_PRECEDENCE_L 0x0000000000800000ULL /* Lowest */
471 #define LSMASH_BOX_PRECEDENCE_LP 0x000FFFFF00000000ULL /* Lowest+ */
472 #define LSMASH_BOX_PRECEDENCE_N 0x0080000000000000ULL /* Normal */
473 #define LSMASH_BOX_PRECEDENCE_HM 0xFFEEEEEE00000000ULL /* Highest- */
474 #define LSMASH_BOX_PRECEDENCE_H 0xFFFFFFFF00800000ULL /* Highest */
475 #define LSMASH_BOX_PRECEDENCE_S 0x0000010000000000ULL /* Step */
477 /* Check if the type of two boxes is identical or not.
479 * Return 1 if the both box types are identical.
480 * Return 0 otherwise. */
481 int lsmash_check_box_type_identical
483 lsmash_box_type_t a,
484 lsmash_box_type_t b
487 /* Check if the type of a given box is already specified or not.
489 * Return 1 if the box type is specified.
490 * Return 0 otherwise, i.e. LSMASH_BOX_TYPE_UNSPECIFIED. */
491 int lsmash_check_box_type_specified
493 const lsmash_box_type_t *box_type
496 /* Allocate a box.
497 * The allocated box can be deallocated by lsmash_destroy_box().
499 * Return the address of an allocated box if successful.
500 * Return NULL otherwise. */
501 lsmash_box_t *lsmash_create_box
503 lsmash_box_type_t type,
504 uint8_t *data,
505 uint32_t size,
506 uint64_t precedence
509 /* Get a box under a given 'parent' box.
510 * The path of a box must be terminated by LSMASH_BOX_TYPE_UNSPECIFIED.
512 * Return the address of the box specified by 'box_path'.
513 * Return NULL otherwise. */
514 lsmash_box_t *lsmash_get_box
516 lsmash_box_t *parent,
517 const lsmash_box_path_t box_path[]
520 /* Add a box into 'parent' box as a child box.
522 * Return 0 if successful.
523 * Return a negative value otherwise. */
524 int lsmash_add_box
526 lsmash_box_t *parent,
527 lsmash_box_t *box
530 /* Add a box into 'parent' box as a child box.
531 * If the adding child box is known and its children (if any) are known, expand them into known
532 * struct formats for the internal references within the L-SMASH library.
533 * If this function succeed, the adding child box is deallocated and the address is invalid.
534 * Instead of that, this function replaces the invalid address with the valid one of the new
535 * allocated memory block representing the added and expanded child box.
537 * Return 0 if successful.
538 * Return a negative value otherwise. */
539 int lsmash_add_box_ex
541 lsmash_box_t *parent,
542 lsmash_box_t **box
545 /* Deallocate a given box and its children. */
546 void lsmash_destroy_box
548 lsmash_box_t *box
551 /* Deallocate all children of a given box. */
552 void lsmash_destroy_children
554 lsmash_box_t *box
557 /* Get the precedence of a given box.
559 * Return 0 if successful.
560 * Return a negative value otherwise. */
561 int lsmash_get_box_precedence
563 lsmash_box_t *box,
564 uint64_t *precedence
567 /* This function allows you to handle a ROOT as if it is a box.
568 * Of course, you can deallocate the ROOT by lsmash_destroy_box().
570 * Return the address of a given ROOT as a box. */
571 lsmash_box_t *lsmash_root_as_box
573 lsmash_root_t *root
576 /* This function allows you to handle the handle of a file as if it is a box.
577 * Of course, you can deallocate the handle of the file by lsmash_destroy_box().
579 * Return the address of the handle of a given file as a box. */
580 lsmash_box_t *lsmash_file_as_box
582 lsmash_file_t *file
585 /* Write a top level box and its children already added to a file.
586 * WARNING:
587 * You should not use this function as long as media data is incompletely written.
588 * That is before starting to write a media data or after finishing of writing that.
590 * Return 0 if successful.
591 * Return a negative value otherwise. */
592 int lsmash_write_top_level_box
594 lsmash_box_t *box
597 /* Export the data of a given box and its children as the binary string.
598 * The returned address is of the beginning of an allocated memory block.
599 * You can deallocate the memory block by lsmash_free().
601 * Note that some boxes cannot be exported since L-SMASH might skip the cache for them.
602 * Media Data Box is an unexportable example.
604 * Return the address to the beginning of the binary string if successful.
605 * Return NULL otherwise. */
606 uint8_t *lsmash_export_box
608 lsmash_box_t *box,
609 uint32_t *size
612 /****************************************************************************
613 * CODEC identifiers
614 ****************************************************************************/
615 typedef lsmash_box_type_t lsmash_codec_type_t;
617 #define LSMASH_CODEC_TYPE_INITIALIZER LSMASH_BOX_TYPE_INITIALIZER
618 #define LSMASH_CODEC_TYPE_UNSPECIFIED LSMASH_BOX_TYPE_UNSPECIFIED
620 #define DEFINE_ISOM_CODEC_TYPE( BOX_TYPE_NAME, BOX_TYPE_FOURCC ) \
621 static const lsmash_codec_type_t BOX_TYPE_NAME = LSMASH_ISO_BOX_TYPE_INITIALIZER( BOX_TYPE_FOURCC )
622 #define DEFINE_QTFF_CODEC_TYPE( BOX_TYPE_NAME, BOX_TYPE_FOURCC ) \
623 static const lsmash_codec_type_t BOX_TYPE_NAME = LSMASH_QTFF_BOX_TYPE_INITIALIZER( BOX_TYPE_FOURCC )
625 /* Audio CODEC identifiers */
626 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_AC_3_AUDIO, LSMASH_4CC( 'a', 'c', '-', '3' ) ); /* AC-3 audio */
627 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_ALAC_AUDIO, LSMASH_4CC( 'a', 'l', 'a', 'c' ) ); /* Apple lossless audio codec */
628 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_DRA1_AUDIO, LSMASH_4CC( 'd', 'r', 'a', '1' ) ); /* DRA Audio */
629 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_DTSC_AUDIO, LSMASH_4CC( 'd', 't', 's', 'c' ) ); /* DTS Coherent Acoustics audio */
630 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_DTSH_AUDIO, LSMASH_4CC( 'd', 't', 's', 'h' ) ); /* DTS-HD High Resolution Audio */
631 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_DTSL_AUDIO, LSMASH_4CC( 'd', 't', 's', 'l' ) ); /* DTS-HD Master Audio */
632 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_DTSE_AUDIO, LSMASH_4CC( 'd', 't', 's', 'e' ) ); /* DTS Express low bit rate audio, also known as DTS LBR */
633 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_EC_3_AUDIO, LSMASH_4CC( 'e', 'c', '-', '3' ) ); /* Enhanced AC-3 audio */
634 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_ENCA_AUDIO, LSMASH_4CC( 'e', 'n', 'c', 'a' ) ); /* Encrypted/Protected audio */
635 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_G719_AUDIO, LSMASH_4CC( 'g', '7', '1', '9' ) ); /* ITU-T Recommendation G.719 (2008) ); */
636 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_G726_AUDIO, LSMASH_4CC( 'g', '7', '2', '6' ) ); /* ITU-T Recommendation G.726 (1990) ); */
637 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_M4AE_AUDIO, LSMASH_4CC( 'm', '4', 'a', 'e' ) ); /* MPEG-4 Audio Enhancement */
638 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_MLPA_AUDIO, LSMASH_4CC( 'm', 'l', 'p', 'a' ) ); /* MLP Audio */
639 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_MP4A_AUDIO, LSMASH_4CC( 'm', 'p', '4', 'a' ) ); /* MPEG-4 Audio */
640 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_RAW_AUDIO, LSMASH_4CC( 'r', 'a', 'w', ' ' ) ); /* Uncompressed audio */
641 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_SAMR_AUDIO, LSMASH_4CC( 's', 'a', 'm', 'r' ) ); /* Narrowband AMR voice */
642 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_SAWB_AUDIO, LSMASH_4CC( 's', 'a', 'w', 'b' ) ); /* Wideband AMR voice */
643 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_SAWP_AUDIO, LSMASH_4CC( 's', 'a', 'w', 'p' ) ); /* Extended AMR-WB (AMR-WB+) ); */
644 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_SEVC_AUDIO, LSMASH_4CC( 's', 'e', 'v', 'c' ) ); /* EVRC Voice */
645 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_SQCP_AUDIO, LSMASH_4CC( 's', 'q', 'c', 'p' ) ); /* 13K Voice */
646 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_SSMV_AUDIO, LSMASH_4CC( 's', 's', 'm', 'v' ) ); /* SMV Voice */
647 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_TWOS_AUDIO, LSMASH_4CC( 't', 'w', 'o', 's' ) ); /* Uncompressed 16-bit audio */
649 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_23NI_AUDIO, LSMASH_4CC( '2', '3', 'n', 'i' ) ); /* 32-bit little endian integer uncompressed */
650 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_MAC3_AUDIO, LSMASH_4CC( 'M', 'A', 'C', '3' ) ); /* MACE 3:1 */
651 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_MAC6_AUDIO, LSMASH_4CC( 'M', 'A', 'C', '6' ) ); /* MACE 6:1 */
652 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_NONE_AUDIO, LSMASH_4CC( 'N', 'O', 'N', 'E' ) ); /* either 'raw ' or 'twos' */
653 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_QDM2_AUDIO, LSMASH_4CC( 'Q', 'D', 'M', '2' ) ); /* Qdesign music 2 */
654 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_QDMC_AUDIO, LSMASH_4CC( 'Q', 'D', 'M', 'C' ) ); /* Qdesign music 1 */
655 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_QCLP_AUDIO, LSMASH_4CC( 'Q', 'c', 'l', 'p' ) ); /* Qualcomm PureVoice */
656 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_AC_3_AUDIO, LSMASH_4CC( 'a', 'c', '-', '3' ) ); /* Digital Audio Compression Standard (AC-3, Enhanced AC-3) */
657 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_AGSM_AUDIO, LSMASH_4CC( 'a', 'g', 's', 'm' ) ); /* GSM */
658 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_ALAC_AUDIO, LSMASH_4CC( 'a', 'l', 'a', 'c' ) ); /* Apple lossless audio codec */
659 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_ALAW_AUDIO, LSMASH_4CC( 'a', 'l', 'a', 'w' ) ); /* a-Law 2:1 */
660 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_CDX2_AUDIO, LSMASH_4CC( 'c', 'd', 'x', '2' ) ); /* CD/XA 2:1 */
661 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_CDX4_AUDIO, LSMASH_4CC( 'c', 'd', 'x', '4' ) ); /* CD/XA 4:1 */
662 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_DVCA_AUDIO, LSMASH_4CC( 'd', 'v', 'c', 'a' ) ); /* DV Audio */
663 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_DVI_AUDIO, LSMASH_4CC( 'd', 'v', 'i', ' ' ) ); /* DVI (as used in RTP, 4:1 compression) */
664 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_FL32_AUDIO, LSMASH_4CC( 'f', 'l', '3', '2' ) ); /* 32-bit float */
665 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_FL64_AUDIO, LSMASH_4CC( 'f', 'l', '6', '4' ) ); /* 64-bit float */
666 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_IMA4_AUDIO, LSMASH_4CC( 'i', 'm', 'a', '4' ) ); /* IMA (International Multimedia Assocation, defunct, 4:1) */
667 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_IN24_AUDIO, LSMASH_4CC( 'i', 'n', '2', '4' ) ); /* 24-bit integer uncompressed */
668 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_IN32_AUDIO, LSMASH_4CC( 'i', 'n', '3', '2' ) ); /* 32-bit integer uncompressed */
669 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_LPCM_AUDIO, LSMASH_4CC( 'l', 'p', 'c', 'm' ) ); /* Uncompressed audio (various integer and float formats) */
670 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_MP4A_AUDIO, LSMASH_4CC( 'm', 'p', '4', 'a' ) ); /* MPEG-4 Audio */
671 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_RAW_AUDIO, LSMASH_4CC( 'r', 'a', 'w', ' ' ) ); /* 8-bit offset-binary uncompressed */
672 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_SOWT_AUDIO, LSMASH_4CC( 's', 'o', 'w', 't' ) ); /* 16-bit little endian uncompressed */
673 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_TWOS_AUDIO, LSMASH_4CC( 't', 'w', 'o', 's' ) ); /* 8-bit or 16-bit big endian uncompressed */
674 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_ULAW_AUDIO, LSMASH_4CC( 'u', 'l', 'a', 'w' ) ); /* uLaw 2:1 */
675 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_VDVA_AUDIO, LSMASH_4CC( 'v', 'd', 'v', 'a' ) ); /* DV audio (variable duration per video frame) */
676 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_FULLMP3_AUDIO, LSMASH_4CC( '.', 'm', 'p', '3' ) ); /* MPEG-1 layer 3, CBR & VBR (QT4.1 and later) */
677 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_MP3_AUDIO, 0x6D730055 ); /* MPEG-1 layer 3, CBR only (pre-QT4.1) */
678 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_ADPCM2_AUDIO, 0x6D730002 ); /* Microsoft ADPCM - ACM code 2 */
679 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_ADPCM17_AUDIO, 0x6D730011 ); /* DVI/Intel IMA ADPCM - ACM code 17 */
680 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_GSM49_AUDIO, 0x6D730031 ); /* Microsoft GSM 6.10 - ACM code 49 */
681 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_NOT_SPECIFIED, 0x00000000 ); /* either 'raw ' or 'twos' */
683 /* Video CODEC identifiers */
684 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_AVC1_VIDEO, LSMASH_4CC( 'a', 'v', 'c', '1' ) ); /* Advanced Video Coding
685 * Any sample must not contain any paramerter set and filler data. */
686 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_AVC2_VIDEO, LSMASH_4CC( 'a', 'v', 'c', '2' ) ); /* Advanced Video Coding
687 * Any sample must not contain any paramerter set and filler data.
688 * May only be used when Extractors or Aggregators are required to be supported. */
689 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_AVC3_VIDEO, LSMASH_4CC( 'a', 'v', 'c', '3' ) ); /* Advanced Video Coding
690 * It is allowed that sample contains parameter sets and filler data. */
691 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_AVC4_VIDEO, LSMASH_4CC( 'a', 'v', 'c', '4' ) ); /* Advanced Video Coding
692 * It is allowed that sample contains parameter sets and filler data.
693 * May only be used when Extractors or Aggregators are required to be supported. */
694 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_AVCP_VIDEO, LSMASH_4CC( 'a', 'v', 'c', 'p' ) ); /* Advanced Video Coding Parameters */
695 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_DRAC_VIDEO, LSMASH_4CC( 'd', 'r', 'a', 'c' ) ); /* Dirac Video Coder */
696 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_ENCV_VIDEO, LSMASH_4CC( 'e', 'n', 'c', 'v' ) ); /* Encrypted/protected video */
697 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_HVC1_VIDEO, LSMASH_4CC( 'h', 'v', 'c', '1' ) ); /* High Efficiency Video Coding
698 * The default and mandatory value of array_completeness is 1 for arrays of
699 * all types of parameter sets, and 0 for all other arrays.
700 * This means any sample must not contain any paramerter set and filler data. */
701 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_HEV1_VIDEO, LSMASH_4CC( 'h', 'e', 'v', '1' ) ); /* High Efficiency Video Coding
702 * The default value of array_completeness is 0 for all arrays.
703 * It is allowed that sample contains parameter sets and filler data. */
704 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_MJP2_VIDEO, LSMASH_4CC( 'm', 'j', 'p', '2' ) ); /* Motion JPEG 2000 */
705 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_MP4V_VIDEO, LSMASH_4CC( 'm', 'p', '4', 'v' ) ); /* MPEG-4 Visual */
706 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_MVC1_VIDEO, LSMASH_4CC( 'm', 'v', 'c', '1' ) ); /* Multiview coding */
707 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_MVC2_VIDEO, LSMASH_4CC( 'm', 'v', 'c', '2' ) ); /* Multiview coding */
708 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_S263_VIDEO, LSMASH_4CC( 's', '2', '6', '3' ) ); /* ITU H.263 video (3GPP format) */
709 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_SVC1_VIDEO, LSMASH_4CC( 's', 'v', 'c', '1' ) ); /* Scalable Video Coding */
710 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_VC_1_VIDEO, LSMASH_4CC( 'v', 'c', '-', '1' ) ); /* SMPTE VC-1 */
712 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_2VUY_VIDEO, LSMASH_4CC( '2', 'v', 'u', 'y' ) ); /* Uncompressed Y'CbCr, 8-bit-per-component 4:2:2
713 * |Cb(8)|Y'0(8)|Cr(8)|Y'1(8)| */
714 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_CFHD_VIDEO, LSMASH_4CC( 'C', 'F', 'H', 'D' ) ); /* CineForm High-Definition (HD) wavelet codec */
715 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_DV10_VIDEO, LSMASH_4CC( 'D', 'V', '1', '0' ) ); /* Digital Voodoo 10 bit Uncompressed 4:2:2 codec */
716 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_DVOO_VIDEO, LSMASH_4CC( 'D', 'V', 'O', 'O' ) ); /* Digital Voodoo 8 bit Uncompressed 4:2:2 codec */
717 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_DVOR_VIDEO, LSMASH_4CC( 'D', 'V', 'O', 'R' ) ); /* Digital Voodoo intermediate raw */
718 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_DVTV_VIDEO, LSMASH_4CC( 'D', 'V', 'T', 'V' ) ); /* Digital Voodoo intermediate 2vuy */
719 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_DVVT_VIDEO, LSMASH_4CC( 'D', 'V', 'V', 'T' ) ); /* Digital Voodoo intermediate v210 */
720 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_HD10_VIDEO, LSMASH_4CC( 'H', 'D', '1', '0' ) ); /* Digital Voodoo 10 bit Uncompressed 4:2:2 HD codec */
721 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_M105_VIDEO, LSMASH_4CC( 'M', '1', '0', '5' ) ); /* Internal format of video data supported by Matrox hardware; pixel organization is proprietary*/
722 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_PNTG_VIDEO, LSMASH_4CC( 'P', 'N', 'T', 'G' ) ); /* Apple MacPaint image format */
723 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_SVQ1_VIDEO, LSMASH_4CC( 'S', 'V', 'Q', '1' ) ); /* Sorenson Video 1 video */
724 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_SVQ3_VIDEO, LSMASH_4CC( 'S', 'V', 'Q', '3' ) ); /* Sorenson Video 3 video */
725 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_SHR0_VIDEO, LSMASH_4CC( 'S', 'h', 'r', '0' ) ); /* Generic SheerVideo codec */
726 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_SHR1_VIDEO, LSMASH_4CC( 'S', 'h', 'r', '1' ) ); /* SheerVideo RGB[A] 8b - at 8 bits/channel */
727 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_SHR2_VIDEO, LSMASH_4CC( 'S', 'h', 'r', '2' ) ); /* SheerVideo Y'CbCr[A] 8bv 4:4:4[:4] - at 8 bits/channel, in ITU-R BT.601-4 video range */
728 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_SHR3_VIDEO, LSMASH_4CC( 'S', 'h', 'r', '3' ) ); /* SheerVideo Y'CbCr 8bv 4:2:2 - 2:1 chroma subsampling, at 8 bits/channel, in ITU-R BT.601-4 video range */
729 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_SHR4_VIDEO, LSMASH_4CC( 'S', 'h', 'r', '4' ) ); /* SheerVideo Y'CbCr 8bw 4:2:2 - 2:1 chroma subsampling, at 8 bits/channel, with full-range luma and wide-range two's-complement chroma */
730 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_WRLE_VIDEO, LSMASH_4CC( 'W', 'R', 'L', 'E' ) ); /* Windows BMP image format */
731 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_APCH_VIDEO, LSMASH_4CC( 'a', 'p', 'c', 'h' ) ); /* Apple ProRes 422 High Quality */
732 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_APCN_VIDEO, LSMASH_4CC( 'a', 'p', 'c', 'n' ) ); /* Apple ProRes 422 Standard Definition */
733 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_APCS_VIDEO, LSMASH_4CC( 'a', 'p', 'c', 's' ) ); /* Apple ProRes 422 LT */
734 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_APCO_VIDEO, LSMASH_4CC( 'a', 'p', 'c', 'o' ) ); /* Apple ProRes 422 Proxy */
735 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_AP4H_VIDEO, LSMASH_4CC( 'a', 'p', '4', 'h' ) ); /* Apple ProRes 4444 */
736 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_CIVD_VIDEO, LSMASH_4CC( 'c', 'i', 'v', 'd' ) ); /* Cinepak Video */
737 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_DRAC_VIDEO, LSMASH_4CC( 'd', 'r', 'a', 'c' ) ); /* Dirac Video Coder */
738 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_DVC_VIDEO, LSMASH_4CC( 'd', 'v', 'c', ' ' ) ); /* DV NTSC format */
739 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_DVCP_VIDEO, LSMASH_4CC( 'd', 'v', 'c', 'p' ) ); /* DV PAL format */
740 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_DVPP_VIDEO, LSMASH_4CC( 'd', 'v', 'p', 'p' ) ); /* Panasonic DVCPro PAL format */
741 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_DV5N_VIDEO, LSMASH_4CC( 'd', 'v', '5', 'n' ) ); /* Panasonic DVCPro-50 NTSC format */
742 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_DV5P_VIDEO, LSMASH_4CC( 'd', 'v', '5', 'p' ) ); /* Panasonic DVCPro-50 PAL format */
743 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_DVH2_VIDEO, LSMASH_4CC( 'd', 'v', 'h', '2' ) ); /* Panasonic DVCPro-HD 1080p25 format */
744 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_DVH3_VIDEO, LSMASH_4CC( 'd', 'v', 'h', '3' ) ); /* Panasonic DVCPro-HD 1080p30 format */
745 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_DVH5_VIDEO, LSMASH_4CC( 'd', 'v', 'h', '5' ) ); /* Panasonic DVCPro-HD 1080i50 format */
746 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_DVH6_VIDEO, LSMASH_4CC( 'd', 'v', 'h', '6' ) ); /* Panasonic DVCPro-HD 1080i60 format */
747 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_DVHP_VIDEO, LSMASH_4CC( 'd', 'v', 'h', 'p' ) ); /* Panasonic DVCPro-HD 720p60 format */
748 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_DVHQ_VIDEO, LSMASH_4CC( 'd', 'v', 'h', 'q' ) ); /* Panasonic DVCPro-HD 720p50 format */
749 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_FLIC_VIDEO, LSMASH_4CC( 'f', 'l', 'i', 'c' ) ); /* Autodesk FLIC animation format */
750 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_GIF_VIDEO, LSMASH_4CC( 'g', 'i', 'f', ' ' ) ); /* GIF image format */
751 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_H261_VIDEO, LSMASH_4CC( 'h', '2', '6', '1' ) ); /* ITU H.261 video */
752 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_H263_VIDEO, LSMASH_4CC( 'h', '2', '6', '3' ) ); /* ITU H.263 video */
753 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_JPEG_VIDEO, LSMASH_4CC( 'j', 'p', 'e', 'g' ) ); /* JPEG image format */
754 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_MJPA_VIDEO, LSMASH_4CC( 'm', 'j', 'p', 'a' ) ); /* Motion-JPEG (format A) */
755 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_MJPB_VIDEO, LSMASH_4CC( 'm', 'j', 'p', 'b' ) ); /* Motion-JPEG (format B) */
756 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_PNG_VIDEO, LSMASH_4CC( 'p', 'n', 'g', ' ' ) ); /* W3C Portable Network Graphics (PNG) */
757 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_RAW_VIDEO, LSMASH_4CC( 'r', 'a', 'w', ' ' ) ); /* Uncompressed RGB */
758 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_RLE_VIDEO, LSMASH_4CC( 'r', 'l', 'e', ' ' ) ); /* Apple animation codec */
759 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_RPZA_VIDEO, LSMASH_4CC( 'r', 'p', 'z', 'a' ) ); /* Apple simple video 'road pizza' compression */
760 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_TGA_VIDEO, LSMASH_4CC( 't', 'g', 'a', ' ' ) ); /* Truvision Targa video format */
761 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_TIFF_VIDEO, LSMASH_4CC( 't', 'i', 'f', 'f' ) ); /* Tagged Image File Format (Adobe) */
762 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_ULRA_VIDEO, LSMASH_4CC( 'U', 'L', 'R', 'A' ) ); /* Ut Video RGBA 4:4:4:4 8bit full-range */
763 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_ULRG_VIDEO, LSMASH_4CC( 'U', 'L', 'R', 'G' ) ); /* Ut Video RGB 4:4:4 8bit full-range */
764 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_ULY0_VIDEO, LSMASH_4CC( 'U', 'L', 'Y', '0' ) ); /* Ut Video YCbCr (BT.601) 4:2:0 8bit limited */
765 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_ULY2_VIDEO, LSMASH_4CC( 'U', 'L', 'Y', '2' ) ); /* Ut Video YCbCr (BT.601) 4:2:2 8bit limited */
766 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_ULH0_VIDEO, LSMASH_4CC( 'U', 'L', 'H', '0' ) ); /* Ut Video YCbCr (BT.709) 4:2:0 8bit limited */
767 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_ULH2_VIDEO, LSMASH_4CC( 'U', 'L', 'H', '2' ) ); /* Ut Video YCbCr (BT.709) 4:2:2 8bit limited */
768 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_V210_VIDEO, LSMASH_4CC( 'v', '2', '1', '0' ) ); /* Uncompressed Y'CbCr, 10-bit-per-component 4:2:2
769 * |Cb0(10)|Y'0(10)|Cr0(10)|XX(2)|
770 * |Y'1(10)|Cb1(10)|Y'2(10)|XX(2)|
771 * |Cr1(10)|Y'3(10)|Cb2(10)|XX(2)|
772 * |Y'4(10)|Cr2(10)|Y'5(10)|XX(2)| (X is a zero bit) */
773 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_V216_VIDEO, LSMASH_4CC( 'v', '2', '1', '6' ) ); /* Uncompressed Y'CbCr, 10, 12, 14, or 16-bit-per-component 4:2:2
774 * |Cb(16 LE)|Y'0(16 LE)|Cr(16 LE)|Y'1(16 LE)| */
775 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_V308_VIDEO, LSMASH_4CC( 'v', '3', '0', '8' ) ); /* Uncompressed Y'CbCr, 8-bit-per-component 4:4:4
776 * |Cr(8)|Y'(8)|Cb(8)| */
777 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_V408_VIDEO, LSMASH_4CC( 'v', '4', '0', '8' ) ); /* Uncompressed Y'CbCrA, 8-bit-per-component 4:4:4:4
778 * |Cb(8)|Y'(8)|Cr(8)|A(8)| */
779 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_V410_VIDEO, LSMASH_4CC( 'v', '4', '1', '0' ) ); /* Uncompressed Y'CbCr, 10-bit-per-component 4:4:4
780 * |XX(2)|Cb(10)|Y'(10)|Cr(10)| (X is a zero bit) */
781 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_YUV2_VIDEO, LSMASH_4CC( 'y', 'u', 'v', '2' ) ); /* Uncompressed Y'CbCr, 8-bit-per-component 4:2:2
782 * |Y'0(8)|Cb(8)|Y'1(8)|Cr(8)| */
784 /* Text CODEC identifiers */
785 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_ENCT_TEXT, LSMASH_4CC( 'e', 'n', 'c', 't' ) ); /* Encrypted Text */
786 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_STPP_TEXT, LSMASH_4CC( 's', 't', 'p', 'p' ) ); /* Sub-titles (Timed Text) */
787 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_TX3G_TEXT, LSMASH_4CC( 't', 'x', '3', 'g' ) ); /* 3GPP Timed Text stream */
789 DEFINE_QTFF_CODEC_TYPE( QT_CODEC_TYPE_TEXT_TEXT, LSMASH_4CC( 't', 'e', 'x', 't' ) ); /* QuickTime Text Media */
791 /* Hint CODEC identifiers */
792 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_FDP_HINT, LSMASH_4CC( 'f', 'd', 'p', ' ' ) ); /* File delivery hints */
793 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_M2TS_HINT, LSMASH_4CC( 'm', '2', 't', 's' ) ); /* MPEG-2 transport stream for DMB */
794 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_PM2T_HINT, LSMASH_4CC( 'p', 'm', '2', 't' ) ); /* Protected MPEG-2 Transport */
795 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_PRTP_HINT, LSMASH_4CC( 'p', 'r', 't', 'p' ) ); /* Protected RTP Reception */
796 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_RM2T_HINT, LSMASH_4CC( 'r', 'm', '2', 't' ) ); /* MPEG-2 Transport Reception */
797 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_RRTP_HINT, LSMASH_4CC( 'r', 'r', 't', 'p' ) ); /* RTP reception */
798 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_RSRP_HINT, LSMASH_4CC( 'r', 's', 'r', 'p' ) ); /* SRTP Reception */
799 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_RTP_HINT, LSMASH_4CC( 'r', 't', 'p', ' ' ) ); /* RTP Hints */
800 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_SM2T_HINT, LSMASH_4CC( 's', 'm', '2', 't' ) ); /* MPEG-2 Transport Server */
801 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_SRTP_HINT, LSMASH_4CC( 's', 'r', 't', 'p' ) ); /* SRTP Hints */
803 /* Metadata CODEC identifiers */
804 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_IXSE_META, LSMASH_4CC( 'i', 'x', 's', 'e' ) ); /* DVB Track Level Index Track */
805 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_METT_META, LSMASH_4CC( 'm', 'e', 't', 't' ) ); /* Text timed metadata */
806 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_METX_META, LSMASH_4CC( 'm', 'e', 't', 'x' ) ); /* XML timed metadata */
807 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_MLIX_META, LSMASH_4CC( 'm', 'l', 'i', 'x' ) ); /* DVB Movie level index track */
808 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_OKSD_META, LSMASH_4CC( 'o', 'k', 's', 'd' ) ); /* OMA Keys */
809 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_SVCM_META, LSMASH_4CC( 's', 'v', 'c', 'M' ) ); /* SVC metadata */
810 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_TEXT_META, LSMASH_4CC( 't', 'e', 'x', 't' ) ); /* Textual meta-data with MIME type */
811 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_URIM_META, LSMASH_4CC( 'u', 'r', 'i', 'm' ) ); /* URI identified timed metadata */
812 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_XML_META, LSMASH_4CC( 'x', 'm', 'l', ' ' ) ); /* XML-formatted meta-data */
814 /* Other CODEC identifiers */
815 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_ENCS_SYSTEM, LSMASH_4CC( 'e', 'n', 'c', 's' ) ); /* Encrypted Systems stream */
816 DEFINE_ISOM_CODEC_TYPE( ISOM_CODEC_TYPE_MP4S_SYSTEM, LSMASH_4CC( 'm', 'p', '4', 's' ) ); /* MPEG-4 Systems */
818 DEFINE_QTFF_CODEC_TYPE( LSMASH_CODEC_TYPE_RAW, LSMASH_4CC( 'r', 'a', 'w', ' ' ) ); /* Either video or audio */
820 /* Check if the identifier of two CODECs is identical or not.
822 * Return 1 if the both CODEC identifiers are identical.
823 * Return 0 otherwise. */
824 int lsmash_check_codec_type_identical( lsmash_codec_type_t a, lsmash_codec_type_t b );
826 /****************************************************************************
827 * Summary of Stream Configuration
828 * This is L-SMASH's original structure.
829 ****************************************************************************/
830 typedef enum
832 LSMASH_SUMMARY_TYPE_UNKNOWN = 0,
833 LSMASH_SUMMARY_TYPE_VIDEO,
834 LSMASH_SUMMARY_TYPE_AUDIO,
835 } lsmash_summary_type;
837 typedef enum
839 LSMASH_CODEC_SPECIFIC_DATA_TYPE_UNSPECIFIED = -1, /* must be LSMASH_CODEC_SPECIFIC_FORMAT_UNSPECIFIED */
841 LSMASH_CODEC_SPECIFIC_DATA_TYPE_UNKNOWN = 0, /* must be LSMASH_CODEC_SPECIFIC_FORMAT_UNSTRUCTURED */
843 LSMASH_CODEC_SPECIFIC_DATA_TYPE_MP4SYS_DECODER_CONFIG,
845 LSMASH_CODEC_SPECIFIC_DATA_TYPE_ISOM_VIDEO_H264,
846 LSMASH_CODEC_SPECIFIC_DATA_TYPE_ISOM_VIDEO_HEVC,
847 LSMASH_CODEC_SPECIFIC_DATA_TYPE_ISOM_VIDEO_VC_1,
848 LSMASH_CODEC_SPECIFIC_DATA_TYPE_ISOM_AUDIO_AC_3,
849 LSMASH_CODEC_SPECIFIC_DATA_TYPE_ISOM_AUDIO_EC_3,
850 LSMASH_CODEC_SPECIFIC_DATA_TYPE_ISOM_AUDIO_DTS,
851 LSMASH_CODEC_SPECIFIC_DATA_TYPE_ISOM_AUDIO_ALAC,
853 LSMASH_CODEC_SPECIFIC_DATA_TYPE_ISOM_VIDEO_SAMPLE_SCALE,
854 LSMASH_CODEC_SPECIFIC_DATA_TYPE_ISOM_VIDEO_H264_BITRATE,
856 LSMASH_CODEC_SPECIFIC_DATA_TYPE_QT_VIDEO_COMMON, /* must be LSMASH_CODEC_SPECIFIC_FORMAT_STRUCTURED */
857 LSMASH_CODEC_SPECIFIC_DATA_TYPE_QT_AUDIO_COMMON, /* must be LSMASH_CODEC_SPECIFIC_FORMAT_STRUCTURED */
858 LSMASH_CODEC_SPECIFIC_DATA_TYPE_QT_AUDIO_FORMAT_SPECIFIC_FLAGS, /* must be LSMASH_CODEC_SPECIFIC_FORMAT_STRUCTURED */
859 LSMASH_CODEC_SPECIFIC_DATA_TYPE_QT_AUDIO_DECOMPRESSION_PARAMETERS, /* must be LSMASH_CODEC_SPECIFIC_FORMAT_UNSTRUCTURED */
861 LSMASH_CODEC_SPECIFIC_DATA_TYPE_QT_VIDEO_FIELD_INFO,
862 LSMASH_CODEC_SPECIFIC_DATA_TYPE_QT_VIDEO_PIXEL_FORMAT,
863 LSMASH_CODEC_SPECIFIC_DATA_TYPE_QT_VIDEO_SIGNIFICANT_BITS,
864 LSMASH_CODEC_SPECIFIC_DATA_TYPE_QT_VIDEO_GAMMA_LEVEL,
865 LSMASH_CODEC_SPECIFIC_DATA_TYPE_QT_AUDIO_CHANNEL_LAYOUT,
867 LSMASH_CODEC_SPECIFIC_DATA_TYPE_CODEC_GLOBAL_HEADER,
868 } lsmash_codec_specific_data_type;
870 typedef enum
872 LSMASH_CODEC_SPECIFIC_FORMAT_UNSPECIFIED = -1,
873 LSMASH_CODEC_SPECIFIC_FORMAT_STRUCTURED = 0,
874 LSMASH_CODEC_SPECIFIC_FORMAT_UNSTRUCTURED = 1
875 } lsmash_codec_specific_format;
877 typedef union
879 void *always_null; /* LSMASH_CODEC_SPECIFIC_FORMAT_UNSPECIFIED */
880 void *structured; /* LSMASH_CODEC_SPECIFIC_FORMAT_STRUCTURED */
881 uint8_t *unstructured; /* LSMASH_CODEC_SPECIFIC_FORMAT_UNSTRUCTURED */
882 } lsmash_codec_specific_data_t;
884 typedef void (*lsmash_codec_specific_destructor_t)( void * );
885 typedef struct
887 lsmash_codec_specific_data_type type;
888 lsmash_codec_specific_format format;
889 lsmash_codec_specific_data_t data;
890 uint32_t size;
891 lsmash_codec_specific_destructor_t destruct;
892 } lsmash_codec_specific_t;
894 typedef struct lsmash_codec_specific_list_tag lsmash_codec_specific_list_t;
896 typedef enum
898 LSMASH_CODEC_SUPPORT_FLAG_NONE = 0,
899 LSMASH_CODEC_SUPPORT_FLAG_MUX = 1 << 0, /* It's expected that L-SMASH can mux CODEC stream properly.
900 * If not flagged, L-SMASH may recognize and/or handle CODEC specific info incorrectly when muxing. */
901 LSMASH_CODEC_SUPPORT_FLAG_DEMUX = 1 << 1, /* It's expected that L-SMASH can demux CODEC stream properly.
902 * If not flagged, L-SMASH may recognize and/or handle CODEC specific info incorrectly when demuxing. */
903 LSMASH_CODEC_SUPPORT_FLAG_REMUX = LSMASH_CODEC_SUPPORT_FLAG_MUX | LSMASH_CODEC_SUPPORT_FLAG_DEMUX,
904 } lsmash_codec_support_flag;
906 #define LSMASH_BASE_SUMMARY \
907 lsmash_summary_type summary_type; \
908 lsmash_codec_type_t sample_type; \
909 lsmash_codec_specific_list_t *opaque; \
910 uint32_t max_au_length; /* buffer length for 1 access unit, typically max size of 1 audio/video frame */
912 typedef struct
914 LSMASH_BASE_SUMMARY
915 } lsmash_summary_t;
917 /* Allocate a summary by 'summary_type'.
918 * The allocated summary can be deallocated by lsmash_cleanup_summary().
920 * Return the address of an allocated summary if successful.
921 * Return NULL otherwise. */
922 lsmash_summary_t *lsmash_create_summary
924 lsmash_summary_type summary_type /* a type of summary you want */
927 /* Deallocate a given summary. */
928 void lsmash_cleanup_summary
930 lsmash_summary_t *summary /* the address of a summary you want to deallocate */
933 /* Allocate and append a new sample description to a track by 'summary'.
935 * Return the index of an allocated and appended sample description if successful.
936 * Return 0 otherwise. */
937 int lsmash_add_sample_entry
939 lsmash_root_t *root, /* the address of the ROOT containing a track to which you want to append a new sample description */
940 uint32_t track_ID, /* the track_ID of a track to which you want to append a new sample description */
941 void *summary /* the summary of a sample description you want to append */
944 /* Count the number of summaries in a track.
946 * Return the number of summaries in a track if no error.
947 * Return 0 otherwise. */
948 uint32_t lsmash_count_summary
950 lsmash_root_t *root, /* the address of the ROOT containing a track in which you want to count the number of summaries */
951 uint32_t track_ID /* the track_ID of a track in which you want to count the number of summaries */
954 /* Get the summary of a sample description you want in a track.
955 * The summary returned by this function is allocated internally, and can be deallocate by lsmash_cleanup_summary().
957 * Return the address of an allocated summary you want if successful.
958 * Return NULL otherwise. */
959 lsmash_summary_t *lsmash_get_summary
961 lsmash_root_t *root, /* the address of the ROOT containing a track which contains a sample description you want */
962 uint32_t track_ID, /* the track_ID of a track containing a sample description you want */
963 uint32_t description_number /* the index of a sample description you want */
966 /* Allocate and initialize a CODEC specific configuration by 'type' and 'format'.
967 * The allocated CODEC specific configuration can be deallocated by lsmash_destroy_codec_specific_data().
969 * Return the address of an allocated and initialized CODEC specific configuration if successful.
970 * Return NULL otherwise. */
971 lsmash_codec_specific_t *lsmash_create_codec_specific_data
973 lsmash_codec_specific_data_type type,
974 lsmash_codec_specific_format format
977 /* Deallocate a CODEC specific configuration. */
978 void lsmash_destroy_codec_specific_data
980 lsmash_codec_specific_t *specific /* the address of a CODEC specific configuration you want to deallocate */
983 /* Allocate a CODEC specific configuration which is a copy of 'specific', and append it to 'summary'.
985 * Return 0 if successful.
986 * Return a negative value otherwise. */
987 int lsmash_add_codec_specific_data
989 lsmash_summary_t *summary,
990 lsmash_codec_specific_t *specific
993 /* Count the number of CODEC specific configuration in a summary.
995 * Return the number of CODEC specific configuration in a summary if successful.
996 * Return 0 otherwise. */
997 uint32_t lsmash_count_codec_specific_data
999 lsmash_summary_t *summary /* the address of a summary in which you want to count the number of CODEC specific configuration */
1002 /* Get a CODEC specific configuration you want in a summary.
1004 * Return the address of a CODEC specific configuration if successful.
1005 * Return NULL otherwise. */
1006 lsmash_codec_specific_t *lsmash_get_codec_specific_data
1008 lsmash_summary_t *summary,
1009 uint32_t extension_number
1012 /* Convert a data format of CODEC specific configuration into another.
1013 * User can specify the same data format for the destination.
1014 * If so, a returned CODEC specific configuration is a copy of the source.
1016 * Return an allocated CODEC specific configuration by specified 'format' from 'specific' if successful.
1017 * Return NULL otherwise. */
1018 lsmash_codec_specific_t *lsmash_convert_codec_specific_format
1020 lsmash_codec_specific_t *specific, /* the address of a CODEC specific configuration as the source */
1021 lsmash_codec_specific_format format /* a data format of the destination */
1024 /* Compare two summaries.
1026 * Return 0 if the two summaries are identical.
1027 * Return 1 if the two summaries are different.
1028 * Return a negative value if there is any error. */
1029 int lsmash_compare_summary
1031 lsmash_summary_t *a,
1032 lsmash_summary_t *b
1035 /* Check status of CODEC support.
1037 * Return support flags of a given CODEC. */
1038 lsmash_codec_support_flag lsmash_check_codec_support
1040 lsmash_codec_type_t codec_type
1043 /****************************************************************************
1044 * Audio Description Layer
1045 ****************************************************************************/
1046 /* Audio Object Types */
1047 typedef enum
1049 MP4A_AUDIO_OBJECT_TYPE_NULL = 0,
1050 MP4A_AUDIO_OBJECT_TYPE_AAC_MAIN = 1, /* ISO/IEC 14496-3 subpart 4 */
1051 MP4A_AUDIO_OBJECT_TYPE_AAC_LC = 2, /* ISO/IEC 14496-3 subpart 4 */
1052 MP4A_AUDIO_OBJECT_TYPE_AAC_SSR = 3, /* ISO/IEC 14496-3 subpart 4 */
1053 MP4A_AUDIO_OBJECT_TYPE_AAC_LTP = 4, /* ISO/IEC 14496-3 subpart 4 */
1054 MP4A_AUDIO_OBJECT_TYPE_SBR = 5, /* ISO/IEC 14496-3 subpart 4 */
1055 MP4A_AUDIO_OBJECT_TYPE_AAC_scalable = 6, /* ISO/IEC 14496-3 subpart 4 */
1056 MP4A_AUDIO_OBJECT_TYPE_TwinVQ = 7, /* ISO/IEC 14496-3 subpart 4 */
1057 MP4A_AUDIO_OBJECT_TYPE_CELP = 8, /* ISO/IEC 14496-3 subpart 3 */
1058 MP4A_AUDIO_OBJECT_TYPE_HVXC = 9, /* ISO/IEC 14496-3 subpart 2 */
1059 MP4A_AUDIO_OBJECT_TYPE_TTSI = 12, /* ISO/IEC 14496-3 subpart 6 */
1060 MP4A_AUDIO_OBJECT_TYPE_Main_synthetic = 13, /* ISO/IEC 14496-3 subpart 5 */
1061 MP4A_AUDIO_OBJECT_TYPE_Wavetable_synthesis = 14, /* ISO/IEC 14496-3 subpart 5 */
1062 MP4A_AUDIO_OBJECT_TYPE_General_MIDI = 15, /* ISO/IEC 14496-3 subpart 5 */
1063 MP4A_AUDIO_OBJECT_TYPE_Algorithmic_Synthesis_Audio_FX = 16, /* ISO/IEC 14496-3 subpart 5 */
1064 MP4A_AUDIO_OBJECT_TYPE_ER_AAC_LC = 17, /* ISO/IEC 14496-3 subpart 4 */
1065 MP4A_AUDIO_OBJECT_TYPE_ER_AAC_LTP = 19, /* ISO/IEC 14496-3 subpart 4 */
1066 MP4A_AUDIO_OBJECT_TYPE_ER_AAC_scalable = 20, /* ISO/IEC 14496-3 subpart 4 */
1067 MP4A_AUDIO_OBJECT_TYPE_ER_Twin_VQ = 21, /* ISO/IEC 14496-3 subpart 4 */
1068 MP4A_AUDIO_OBJECT_TYPE_ER_BSAC = 22, /* ISO/IEC 14496-3 subpart 4 */
1069 MP4A_AUDIO_OBJECT_TYPE_ER_AAC_LD = 23, /* ISO/IEC 14496-3 subpart 4 */
1070 MP4A_AUDIO_OBJECT_TYPE_ER_CELP = 24, /* ISO/IEC 14496-3 subpart 3 */
1071 MP4A_AUDIO_OBJECT_TYPE_ER_HVXC = 25, /* ISO/IEC 14496-3 subpart 2 */
1072 MP4A_AUDIO_OBJECT_TYPE_ER_HILN = 26, /* ISO/IEC 14496-3 subpart 7 */
1073 MP4A_AUDIO_OBJECT_TYPE_ER_Parametric = 27, /* ISO/IEC 14496-3 subpart 2 and 7 */
1074 MP4A_AUDIO_OBJECT_TYPE_SSC = 28, /* ISO/IEC 14496-3 subpart 8 */
1075 MP4A_AUDIO_OBJECT_TYPE_PS = 29, /* ISO/IEC 14496-3 subpart 8 */
1076 MP4A_AUDIO_OBJECT_TYPE_MPEG_Surround = 30, /* ISO/IEC 23003-1 */
1077 MP4A_AUDIO_OBJECT_TYPE_ESCAPE = 31,
1078 MP4A_AUDIO_OBJECT_TYPE_Layer_1 = 32, /* ISO/IEC 14496-3 subpart 9 */
1079 MP4A_AUDIO_OBJECT_TYPE_Layer_2 = 33, /* ISO/IEC 14496-3 subpart 9 */
1080 MP4A_AUDIO_OBJECT_TYPE_Layer_3 = 34, /* ISO/IEC 14496-3 subpart 9 */
1081 MP4A_AUDIO_OBJECT_TYPE_DST = 35, /* ISO/IEC 14496-3 subpart 10 */
1082 MP4A_AUDIO_OBJECT_TYPE_ALS = 36, /* ISO/IEC 14496-3 subpart 11 */
1083 MP4A_AUDIO_OBJECT_TYPE_SLS = 37, /* ISO/IEC 14496-3 subpart 12 */
1084 MP4A_AUDIO_OBJECT_TYPE_SLS_non_core = 38, /* ISO/IEC 14496-3 subpart 12 */
1085 MP4A_AUDIO_OBJECT_TYPE_ER_AAC_ELD = 39, /* ISO/IEC 14496-3 subpart 4 */
1086 MP4A_AUDIO_OBJECT_TYPE_SMR_Simple = 40, /* ISO/IEC 14496-23 */
1087 MP4A_AUDIO_OBJECT_TYPE_SMR_Main = 41, /* ISO/IEC 14496-23 */
1088 MP4A_AUDIO_OBJECT_TYPE_SAOC = 43, /* ISO/IEC 23003-2 */
1089 } lsmash_mp4a_AudioObjectType;
1091 /* See ISO/IEC 14496-3 Signaling of SBR, SBR Signaling and Corresponding Decoder Behavior */
1092 typedef enum
1094 MP4A_AAC_SBR_NOT_SPECIFIED = 0x0, /* not mention to SBR presence. Implicit signaling. */
1095 MP4A_AAC_SBR_NONE, /* explicitly signals SBR does not present. Useless in general. */
1096 MP4A_AAC_SBR_BACKWARD_COMPATIBLE, /* explicitly signals SBR present. Recommended method to signal SBR. */
1097 MP4A_AAC_SBR_HIERARCHICAL /* SBR exists. SBR dedicated method. */
1098 } lsmash_mp4a_aac_sbr_mode;
1100 typedef struct
1102 LSMASH_BASE_SUMMARY
1103 lsmash_mp4a_AudioObjectType aot; /* detailed codec type
1104 * If neither ISOM_CODEC_TYPE_MP4A_AUDIO nor QT_CODEC_TYPE_MP4A_AUDIO, just ignored. */
1105 uint32_t frequency; /* the audio sampling rate (in Hz) at the default output playback
1106 * For some audio, this field is used as a nominal value.
1107 * For HE-AAC v1/SBR stream, this is base AAC's one.
1108 * For ISOM_CODEC_TYPE_AC_3_AUDIO and ISOM_CODEC_TYPE_EC_3_AUDIO, this shall be
1109 * equal to the sampling rate (in Hz) of the stream and the media timescale. */
1110 uint32_t channels; /* the number of audio channels at the default output playback
1111 * Even if the stream is HE-AAC v2/SBR+PS, this is base AAC's one. */
1112 uint32_t sample_size; /* For uncompressed audio,
1113 * the number of bits in each uncompressed sample for a single channel.
1114 * For some compressed audio, such as audio that uses MDCT,
1115 * N/A (not applicable), and may be set to 16. */
1116 uint32_t samples_in_frame; /* the number of decoded PCM samples in an audio frame at 'frequency'
1117 * Even if the stream is HE-AAC/aacPlus/SBR(+PS), this is base AAC's one, so 1024. */
1118 lsmash_mp4a_aac_sbr_mode sbr_mode; /* SBR treatment
1119 * Currently we always set this as mp4a_AAC_SBR_NOT_SPECIFIED (Implicit signaling).
1120 * User can set this for treatment in other way. */
1121 uint32_t bytes_per_frame; /* the number of bytes per audio frame
1122 * If variable, shall be set to 0. */
1123 } lsmash_audio_summary_t;
1125 /* Facilitate to make exdata (typically DecoderSpecificInfo or AudioSpecificConfig). */
1126 int lsmash_setup_AudioSpecificConfig
1128 lsmash_audio_summary_t* summary
1131 /****************************************************************************
1132 * Video Description Layer
1133 ****************************************************************************/
1134 /* Clean Aperture */
1135 typedef struct
1137 lsmash_rational_u32_t width;
1138 lsmash_rational_u32_t height;
1139 lsmash_rational_s32_t horizontal_offset;
1140 lsmash_rational_s32_t vertical_offset;
1141 } lsmash_clap_t;
1143 typedef struct
1145 lsmash_rational_u32_t top;
1146 lsmash_rational_u32_t left;
1147 lsmash_rational_u32_t bottom;
1148 lsmash_rational_u32_t right;
1149 } lsmash_crop_t;
1151 /* Video depth */
1152 typedef enum
1154 ISOM_DEPTH_TEMPLATE = 0x0018,
1156 /* H.264/AVC */
1157 AVC_DEPTH_COLOR_WITH_NO_ALPHA = 0x0018, /* color with no alpha */
1158 AVC_DEPTH_GRAYSCALE_WITH_NO_ALPHA = 0x0028, /* grayscale with no alpha */
1159 AVC_DEPTH_WITH_ALPHA = 0x0020, /* gray or color with alpha */
1161 /* QuickTime Video
1162 * (1-32) or (33-40 grayscale) */
1163 QT_VIDEO_DEPTH_COLOR_1 = 0x0001,
1164 QT_VIDEO_DEPTH_COLOR_2 = 0x0002,
1165 QT_VIDEO_DEPTH_COLOR_4 = 0x0004,
1166 QT_VIDEO_DEPTH_COLOR_8 = 0x0008,
1167 QT_VIDEO_DEPTH_COLOR_16 = 0x0010,
1168 QT_VIDEO_DEPTH_COLOR_24 = 0x0018,
1169 QT_VIDEO_DEPTH_COLOR_32 = 0x0020,
1170 QT_VIDEO_DEPTH_GRAYSCALE_1 = 0x0021,
1171 QT_VIDEO_DEPTH_GRAYSCALE_2 = 0x0022,
1172 QT_VIDEO_DEPTH_GRAYSCALE_4 = 0x0024,
1173 QT_VIDEO_DEPTH_GRAYSCALE_8 = 0x0028,
1175 /* QuickTime Uncompressed RGB */
1176 QT_VIDEO_DEPTH_555RGB = 0x0010,
1177 QT_VIDEO_DEPTH_24RGB = 0x0018,
1178 QT_VIDEO_DEPTH_32ARGB = 0x0020,
1179 } lsmash_video_depth;
1181 /* Index for the chromaticity coordinates of the color primaries */
1182 enum
1184 /* for ISO Base Media file format */
1185 ISOM_PRIMARIES_INDEX_ITU_R709_5 = 1, /* ITU-R BT.709-2/5, ITU-R BT.1361,
1186 * SMPTE 274M-1995, SMPTE 296M-1997,
1187 * IEC 61966-2-1 (sRGB or sYCC), IEC 61966-2-4 (xvYCC),
1188 * SMPTE RP 177M-1993 Annex B
1189 * green x = 0.300 y = 0.600
1190 * blue x = 0.150 y = 0.060
1191 * red x = 0.640 y = 0.330
1192 * white x = 0.3127 y = 0.3290 (CIE III. D65) */
1193 ISOM_PRIMARIES_INDEX_UNSPECIFIED = 2, /* Unspecified */
1194 ISOM_PRIMARIES_INDEX_ITU_R470M = 4, /* ITU-R BT.470-6 System M
1195 * green x = 0.21 y = 0.71
1196 * blue x = 0.14 y = 0.08
1197 * red x = 0.67 y = 0.33
1198 * white x = 0.310 y = 0.316 */
1199 ISOM_PRIMARIES_INDEX_ITU_R470BG = 5, /* EBU Tech. 3213 (1981), ITU-R BT.470-6 System B, G,
1200 * ITU-R BT.601-6 625, ITU-R BT.1358 625,
1201 * ITU-R BT.1700 625 PAL and 625 SECAM
1202 * green x = 0.29 y = 0.60
1203 * blue x = 0.15 y = 0.06
1204 * red x = 0.64 y = 0.33
1205 * white x = 0.3127 y = 0.3290 (CIE III. D65) */
1206 ISOM_PRIMARIES_INDEX_SMPTE_170M_2004 = 6, /* SMPTE C Primaries from SMPTE RP 145-1993, SMPTE 170M-2004,
1207 * ITU-R BT.601-6 525, ITU-R BT.1358 525,
1208 * ITU-R BT.1700 NTSC, SMPTE 170M-2004
1209 * green x = 0.310 y = 0.595
1210 * blue x = 0.155 y = 0.070
1211 * red x = 0.630 y = 0.340
1212 * white x = 0.3127 y = 0.3290 (CIE III. D65) */
1213 ISOM_PRIMARIES_INDEX_SMPTE_240M_1999 = 7, /* SMPTE 240M-1999
1214 * functionally the same as the value ISOM_PRIMARIES_INDEX_SMPTE_170M_2004 */
1216 /* for QuickTime file format */
1217 QT_PRIMARIES_INDEX_ITU_R709_2 = 1, /* the same as the value ISOM_PRIMARIES_INDEX_ITU_R709_5 */
1218 QT_PRIMARIES_INDEX_UNSPECIFIED = 2, /* Unspecified */
1219 QT_PRIMARIES_INDEX_EBU_3213 = 5, /* the same as the value ISOM_PRIMARIES_INDEX_ITU_R470BG */
1220 QT_PRIMARIES_INDEX_SMPTE_C = 6, /* the same as the value ISOM_PRIMARIES_INDEX_SMPTE_170M_2004 */
1223 /* Index for the opto-electronic transfer characteristic of the image color components */
1224 enum
1226 /* for ISO Base Media file format */
1227 ISOM_TRANSFER_INDEX_ITU_R709_5 = 1, /* ITU-R BT.709-2/5, ITU-R BT.1361
1228 * SMPTE 274M-1995, SMPTE 296M-1997,
1229 * SMPTE 293M-1996, SMPTE 170M-1994
1230 * vV = 1.099 * vLc^0.45 - 0.099 for 1 >= vLc >= 0.018
1231 * vV = 4.500 * vLc for 0.018 > vLc >= 0 */
1232 ISOM_TRANSFER_INDEX_UNSPECIFIED = 2, /* Unspecified */
1233 ISOM_TRANSFER_INDEX_ITU_R470M = 4, /* ITU-R BT.470-6 System M, ITU-R BT.1700 625 PAL and 625 SECAM
1234 * Assumed display gamma 2.2 */
1235 ISOM_TRANSFER_INDEX_ITU_R470BG = 5, /* ITU-R BT.470-6 System B, G
1236 * Assumed display gamma 2.8 */
1237 ISOM_TRANSFER_INDEX_SMPTE_170M_2004 = 6, /* ITU-R BT.601-6 525 or 625, ITU-R BT.1358 525 or 625,
1238 * ITU-R BT.1700 NTSC, SMPTE 170M-2004
1239 * functionally the same as the value ISOM_TRANSFER_INDEX_ITU_R709_5
1240 * vV = 1.099 * vLc^0.45 - 0.099 for 1 >= vLc >= 0.018
1241 * vV = 4.500 * vLc for 0.018 > vLc >= 0 */
1242 ISOM_TRANSFER_INDEX_SMPTE_240M_1999 = 7, /* SMPTE 240M-1995/1999, interim color implementation of SMPTE 274M-1995
1243 * vV = 1.1115 * vLc^0.45 - 0.1115 for 1 >= vLc >= 0.0228
1244 * vV = 4.0 * vLc for 0.0228 > vLc >= 0 */
1245 ISOM_TRANSFER_INDEX_LINEAR = 8, /* Linear transfer characteristics */
1246 ISOM_TRANSFER_INDEX_XVYCC = 11, /* IEC 61966-2-4 (xvYCC)
1247 * vV = 1.099 * vLc^0.45 - 0.099 for vLc >= 0.018
1248 * vV = 4.500 * vLc for 0.018 > vLc > -0.018
1249 * vV = -1.099 * (-vLc)^0.45 + 0.099 for -0.018 >= vLc */
1250 ISOM_TRANSFER_INDEX_ITU_R1361 = 12, /* ITU-R BT.1361
1251 * vV = 1.099 * vLc^0.45 - 0.099 for 1.33 > vLc >= 0.018
1252 * vV = 4.500 * vLc for 0.018 > vLc >= -0.0045
1253 * vV = -(1.099 * (-4 * vLc)^0.45 + 0.099) / 4 for -0.0045 > vLc >= -0.25 */
1254 ISOM_TRANSFER_INDEX_SRGB = 13, /* IEC 61966-2-1 (sRGB or sYCC)
1255 * vV = 1.055 * vLc^(1/2.4) - 0.055 for 1 > vLc >= 0.0031308
1256 * vV = 12.92 * vLc for 0.0031308 > vLc >= 0 */
1258 /* for QuickTime file format */
1259 QT_TRANSFER_INDEX_ITU_R709_2 = 1, /* the same as the value ISOM_TRANSFER_INDEX_ITU_R709_5 */
1260 QT_TRANSFER_INDEX_UNSPECIFIED = 2, /* Unspecified */
1261 QT_TRANSFER_INDEX_SMPTE_240M_1995 = 7, /* the same as the value ISOM_TRANSFER_INDEX_SMPTE_240M_1999 */
1264 /* Index for the matrix coefficients associated with derivation of luma and chroma signals from the green, blue, and red primaries */
1265 enum
1267 /* for ISO Base Media file format */
1268 ISOM_MATRIX_INDEX_NO_MATRIX = 0, /* No matrix transformation
1269 * IEC 61966-2-1 (sRGB) */
1270 ISOM_MATRIX_INDEX_ITU_R_709_5 = 1, /* ITU-R BT.709-2/5, ITU-R BT.1361,
1271 * SMPTE 274M-1995, SMPTE 296M-1997
1272 * IEC 61966-2-1 (sYCC), IEC 61966-2-4 xvYCC_709,
1273 * SMPTE RP 177M-1993 Annex B
1274 * vKr = 0.2126; vKb = 0.0722 */
1275 ISOM_MATRIX_INDEX_UNSPECIFIED = 2, /* Unspecified */
1276 ISOM_MATRIX_INDEX_USFCCT_47_CFR = 4, /* United States Federal Communications Commission Title 47 Code of Federal Regulations
1277 * vKr = 0.30; vKb = 0.11 */
1278 ISOM_MATRIX_INDEX_ITU_R470BG = 5, /* ITU-R BT.470-6 System B, G,
1279 * ITU-R BT.601-4/6 625, ITU-R BT.1358 625,
1280 * ITU-R BT.1700 625 PAL and 625 SECAM, IEC 61966-2-4 xvYCC601
1281 * vKr = 0.299; vKb = 0.114 */
1282 ISOM_MATRIX_INDEX_SMPTE_170M_2004 = 6, /* ITU-R BT.601-4/6 525, ITU-R BT.1358 525,
1283 * ITU-R BT.1700 NTSC,
1284 * SMPTE 170M-1994, SMPTE 293M-1996
1285 * functionally the same as the value ISOM_MATRIX_INDEX_ITU_R470BG
1286 * vKr = 0.299; vKb = 0.114 */
1287 ISOM_MATRIX_INDEX_SMPTE_240M_1999 = 7, /* SMPTE 240M-1995, interim color implementation of SMPTE 274M-1995
1288 * vKr = 0.212; vKb = 0.087 */
1289 ISOM_MATRIX_INDEX_YCGCO = 8, /* YCoCg */
1291 /* for QuickTime file format */
1292 QT_MATRIX_INDEX_ITU_R_709_2 = 1, /* the same as the value ISOM_MATRIX_INDEX_ITU_R_709_5 */
1293 QT_MATRIX_INDEX_UNSPECIFIED = 2, /* Unspecified */
1294 QT_MATRIX_INDEX_ITU_R_601_4 = 6, /* the same as the value ISOM_MATRIX_INDEX_SMPTE_170M_2004 */
1295 QT_MATRIX_INDEX_SMPTE_240M_1995 = 7 /* the same as the value ISOM_MATRIX_INDEX_SMPTE_240M_1999 */
1298 typedef struct
1300 LSMASH_BASE_SUMMARY
1301 // lsmash_mp4v_VideoObjectType vot; /* Detailed codec type. If not mp4v, just ignored. */
1302 uint32_t timescale; /* media timescale
1303 * User can't set this parameter manually. */
1304 uint32_t timebase; /* increment unit of timestamp
1305 * User can't set this parameter manually. */
1306 uint8_t vfr; /* whether a stream is assumed as variable frame rate
1307 * User can't set this parameter manually. */
1308 uint8_t sample_per_field; /* whether a stream may have a sample per field
1309 * User can't set this parameter manually. */
1310 uint32_t width; /* pixel counts of width samples have */
1311 uint32_t height; /* pixel counts of height samples have */
1312 char compressorname[33]; /* a 32-byte Pascal string containing the name of the compressor that created the image */
1313 lsmash_video_depth depth; /* data size of a pixel */
1314 lsmash_clap_t clap; /* clean aperture */
1315 uint32_t par_h; /* horizontal factor of pixel aspect ratio */
1316 uint32_t par_v; /* vertical factor of pixel aspect ratio */
1317 struct
1319 /* To omit to write these field, set zero value to all them. */
1320 uint16_t primaries_index; /* the chromaticity coordinates of the color primaries */
1321 uint16_t transfer_index; /* the opto-electronic transfer characteristic of the image color components */
1322 uint16_t matrix_index; /* the matrix coefficients associated with derivation of luma and chroma signals from the green, blue, and red primaries */
1323 uint8_t full_range;
1324 } color;
1325 } lsmash_video_summary_t;
1327 int lsmash_convert_crop_into_clap
1329 lsmash_crop_t crop,
1330 uint32_t width,
1331 uint32_t height,
1332 lsmash_clap_t *clap
1335 int lsmash_convert_clap_into_crop
1337 lsmash_clap_t clap,
1338 uint32_t width,
1339 uint32_t height,
1340 lsmash_crop_t *crop
1343 /****************************************************************************
1344 * Media Sample
1345 ****************************************************************************/
1346 typedef enum
1348 /* allow_ealier */
1349 QT_SAMPLE_EARLIER_PTS_ALLOWED = 1,
1350 /* leading */
1351 ISOM_SAMPLE_LEADING_UNKNOWN = 0,
1352 ISOM_SAMPLE_IS_UNDECODABLE_LEADING = 1,
1353 ISOM_SAMPLE_IS_NOT_LEADING = 2,
1354 ISOM_SAMPLE_IS_DECODABLE_LEADING = 3,
1355 /* independent */
1356 ISOM_SAMPLE_INDEPENDENCY_UNKNOWN = 0,
1357 ISOM_SAMPLE_IS_NOT_INDEPENDENT = 1,
1358 ISOM_SAMPLE_IS_INDEPENDENT = 2,
1359 /* disposable */
1360 ISOM_SAMPLE_DISPOSABLE_UNKNOWN = 0,
1361 ISOM_SAMPLE_IS_NOT_DISPOSABLE = 1,
1362 ISOM_SAMPLE_IS_DISPOSABLE = 2,
1363 /* redundant */
1364 ISOM_SAMPLE_REDUNDANCY_UNKNOWN = 0,
1365 ISOM_SAMPLE_HAS_REDUNDANCY = 1,
1366 ISOM_SAMPLE_HAS_NO_REDUNDANCY = 2,
1367 } lsmash_sample_dependency;
1369 typedef enum
1371 /* flags for ISO Base Media file format */
1372 ISOM_SAMPLE_RANDOM_ACCESS_FLAG_NONE = 0,
1373 ISOM_SAMPLE_RANDOM_ACCESS_FLAG_SYNC = 1 << 0, /* a sync sample */
1374 ISOM_SAMPLE_RANDOM_ACCESS_FLAG_RAP = 1 << 2, /* the first sample of a closed or an open GOP */
1375 ISOM_SAMPLE_RANDOM_ACCESS_FLAG_CLOSED = 1 << 3, /* a sample in a closed GOP
1376 * This flag shall be set together with ISOM_SAMPLE_RANDOM_ACCESS_FLAG_RAP. */
1377 ISOM_SAMPLE_RANDOM_ACCESS_FLAG_OPEN = 1 << 4, /* a sample in an open GOP
1378 * This flag shall be set together with ISOM_SAMPLE_RANDOM_ACCESS_FLAG_RAP. */
1379 ISOM_SAMPLE_RANDOM_ACCESS_FLAG_GDR = 1 << 5, /* a sample on gradual decoder refresh or random access recovery */
1380 ISOM_SAMPLE_RANDOM_ACCESS_FLAG_GDR_START = 1 << 6, /* a sample that is the starting point of gradual decoder refresh or random access recovery
1381 * This flag shall be set together with ISOM_SAMPLE_RANDOM_ACCESS_FLAG_GDR. */
1382 ISOM_SAMPLE_RANDOM_ACCESS_FLAG_GDR_END = 1 << 7, /* a sample that is the ending point of gradual decoder refresh or random access recovery
1383 * This flag shall be set together with ISOM_SAMPLE_RANDOM_ACCESS_FLAG_GDR. */
1385 ISOM_SAMPLE_RANDOM_ACCESS_FLAG_CLOSED_RAP /* the first sample of a closed GOP */
1386 = ISOM_SAMPLE_RANDOM_ACCESS_FLAG_RAP
1387 | ISOM_SAMPLE_RANDOM_ACCESS_FLAG_CLOSED,
1388 ISOM_SAMPLE_RANDOM_ACCESS_FLAG_OPEN_RAP /* the first sample of an open GOP */
1389 = ISOM_SAMPLE_RANDOM_ACCESS_FLAG_RAP
1390 | ISOM_SAMPLE_RANDOM_ACCESS_FLAG_OPEN,
1391 ISOM_SAMPLE_RANDOM_ACCESS_FLAG_POST_ROLL_START /* the post-roll starting point of random access recovery */
1392 = ISOM_SAMPLE_RANDOM_ACCESS_FLAG_GDR
1393 | ISOM_SAMPLE_RANDOM_ACCESS_FLAG_GDR_START,
1394 ISOM_SAMPLE_RANDOM_ACCESS_FLAG_PRE_ROLL_END /* the pre-roll ending point of random access recovery */
1395 = ISOM_SAMPLE_RANDOM_ACCESS_FLAG_GDR
1396 | ISOM_SAMPLE_RANDOM_ACCESS_FLAG_GDR_END,
1398 /* flags for QuickTime file format */
1399 QT_SAMPLE_RANDOM_ACCESS_FLAG_NONE = 0, /* alias of ISOM_SAMPLE_RANDOM_ACCESS_FLAG_NONE */
1400 QT_SAMPLE_RANDOM_ACCESS_FLAG_SYNC = ISOM_SAMPLE_RANDOM_ACCESS_FLAG_SYNC,
1401 QT_SAMPLE_RANDOM_ACCESS_FLAG_PARTIAL_SYNC = 1 << 1, /* partial sync sample
1402 * Partial sync sample is a sample
1403 * such that this sample and samples following in decoding order can be correctly decoded
1404 * using the first sample of the previous GOP and samples following in decoding order,
1405 * in addition, this sample and non-leading samples following in decoding order can be correctly decoded from this. */
1406 QT_SAMPLE_RANDOM_ACCESS_FLAG_RAP = ISOM_SAMPLE_RANDOM_ACCESS_FLAG_RAP,
1407 QT_SAMPLE_RANDOM_ACCESS_FLAG_CLOSED = ISOM_SAMPLE_RANDOM_ACCESS_FLAG_CLOSED,
1408 QT_SAMPLE_RANDOM_ACCESS_FLAG_OPEN = ISOM_SAMPLE_RANDOM_ACCESS_FLAG_OPEN,
1410 QT_SAMPLE_RANDOM_ACCESS_FLAG_CLOSED_RAP /* the first sample of a closed GOP */
1411 = QT_SAMPLE_RANDOM_ACCESS_FLAG_RAP
1412 | QT_SAMPLE_RANDOM_ACCESS_FLAG_CLOSED,
1413 QT_SAMPLE_RANDOM_ACCESS_FLAG_OPEN_RAP /* the first sample of an open GOP */
1414 = QT_SAMPLE_RANDOM_ACCESS_FLAG_RAP
1415 | QT_SAMPLE_RANDOM_ACCESS_FLAG_OPEN,
1416 } lsmash_random_access_flag;
1418 #define LSMASH_FLAGS_SATISFIED( x, y ) (((x) & (y)) == (y))
1419 #define LSMASH_IS_CLOSED_RAP( x ) LSMASH_FLAGS_SATISFIED( (x), ISOM_SAMPLE_RANDOM_ACCESS_FLAG_CLOSED_RAP )
1420 #define LSMASH_IS_OPEN_RAP( x ) LSMASH_FLAGS_SATISFIED( (x), ISOM_SAMPLE_RANDOM_ACCESS_FLAG_OPEN_RAP )
1421 #define LSMASH_IS_POST_ROLL_START( x ) LSMASH_FLAGS_SATISFIED( (x), ISOM_SAMPLE_RANDOM_ACCESS_FLAG_POST_ROLL_START )
1422 #define LSMASH_IS_PRE_ROLL_END( x ) LSMASH_FLAGS_SATISFIED( (x), ISOM_SAMPLE_RANDOM_ACCESS_FLAG_PRE_ROLL_END )
1424 typedef struct
1426 uint32_t identifier; /* the identifier of sample
1427 * If this identifier equals a certain identifier of random access recovery point,
1428 * then this sample is the random access recovery point of the earliest unestablished post-roll group. */
1429 uint32_t complete; /* the identifier of future random access recovery point, which is necessary for the recovery from its starting point to be completed
1430 * For muxing, this value is used only if (ra_flags & ISOM_SAMPLE_RANDOM_ACCESS_TYPE_POST_ROLL_START) is true.
1431 * The following is an example of use for gradual decoder refresh of H.264/AVC.
1432 * For each sample, set 'frame_num' to the 'identifier'.
1433 * For samples with recovery point SEI message, add ISOM_SAMPLE_RANDOM_ACCESS_TYPE_POST_ROLL_START to ra_flags
1434 * and set '(frame_num + recovery_frame_cnt) % MaxFrameNum' to the 'complete'.
1435 * The above-mentioned values are set appropriately, then L-SMASH will establish appropriate post-roll grouping. */
1436 } lsmash_post_roll_t;
1438 typedef struct
1440 uint32_t distance; /* the distance from the previous random access point or pre-roll starting point
1441 * of the random access recovery point to this sample.
1442 * For muxing, this value is used only if ra_flags is not set to ISOM_SAMPLE_RANDOM_ACCESS_TYPE_NONE
1443 * and LSMASH_IS_POST_ROLL_START( ra_flags ) is false.
1444 * Some derived specifications forbid using pre-roll settings and use post-roll settings instead (e.g. AVC uses only post-roll).
1445 * The following is an example of pre-roll distance for representing audio decoder delay derived from composition.
1446 * Typical AAC encoding uses a transform over consecutive sets of 2048 audio samples,
1447 * applied every 1024 audio samples (MDCTs are overlapped).
1448 * For correct audio to be decoded, both transforms for any period of 1024 audio samples are needed.
1449 * For this AAC stream, therefore, 'distance' of each sample shall be set to 1 (one AAC access unit).
1450 * Note: the number of priming audio sample i.e. encoder delay shall be represented by 'start_time' in an edit. */
1451 } lsmash_pre_roll_t;
1453 typedef struct
1455 uint8_t allow_earlier;
1456 uint8_t leading;
1457 uint8_t independent;
1458 uint8_t disposable;
1459 uint8_t redundant;
1460 lsmash_random_access_flag ra_flags;
1461 lsmash_post_roll_t post_roll;
1462 lsmash_pre_roll_t pre_roll;
1463 } lsmash_sample_property_t;
1465 typedef struct
1467 uint32_t length; /* size of sample data
1468 * Note: this is NOT always an allocated size. */
1469 uint8_t *data; /* sample data */
1470 uint64_t dts; /* Decoding TimeStamp in units of media timescale */
1471 uint64_t cts; /* Composition TimeStamp in units of media timescale */
1472 uint32_t index;
1473 lsmash_sample_property_t prop;
1474 } lsmash_sample_t;
1476 typedef struct
1478 uint64_t dts; /* Decoding TimeStamp in units of media timescale */
1479 uint64_t cts; /* Composition TimeStamp in units of media timescale */
1480 } lsmash_media_ts_t;
1482 typedef struct
1484 uint32_t sample_count;
1485 lsmash_media_ts_t *timestamp;
1486 } lsmash_media_ts_list_t;
1488 /* Allocate a sample and then allocate data of the allocated sample by 'size'.
1489 * If 'size' is set to 0, data of the allocated sample won't be allocated and will be set to NULL instead.
1490 * The allocated sample can be deallocated by lsmash_delete_sample().
1492 * Return the address of an allocated sample if successful.
1493 * Return NULL otherwise. */
1494 lsmash_sample_t *lsmash_create_sample
1496 uint32_t size /* size of sample data you request */
1499 /* Allocate data of a given allocated sample by 'size'.
1500 * If the sample data is already allocated, reallocate it by 'size'.
1502 * Return 0 if successful.
1503 * Return a negative value otherwise. */
1504 int lsmash_sample_alloc
1506 lsmash_sample_t *sample, /* the address of a sample you want to allocate its sample data */
1507 uint32_t size /* size of sample data you request */
1510 /* Deallocate a given sample. */
1511 void lsmash_delete_sample
1513 lsmash_sample_t *sample /* the address of a sample you want to deallocate */
1516 /* Append a sample to a track.
1517 * Note:
1518 * The appended sample will be deleted by lsmash_delete_sample() internally.
1519 * Users shall not deallocate the sample by lsmash_delete_sample() if successful to append the sample.
1521 * Return 0 if successful.
1522 * Return a negative value otherwise. */
1523 int lsmash_append_sample
1525 lsmash_root_t *root,
1526 uint32_t track_ID,
1527 lsmash_sample_t *sample
1530 /****************************************************************************
1531 * Media Layer
1532 ****************************************************************************/
1533 /* Media handler types */
1534 typedef enum
1536 ISOM_MEDIA_HANDLER_TYPE_3GPP_SCENE_DESCRIPTION = LSMASH_4CC( '3', 'g', 's', 'd' ),
1537 ISOM_MEDIA_HANDLER_TYPE_ID3_VERSION2_METADATA = LSMASH_4CC( 'I', 'D', '3', '2' ),
1538 ISOM_MEDIA_HANDLER_TYPE_AUXILIARY_VIDEO_TRACK = LSMASH_4CC( 'a', 'u', 'x', 'v' ),
1539 ISOM_MEDIA_HANDLER_TYPE_CPCM_AUXILIARY_METADATA = LSMASH_4CC( 'c', 'p', 'a', 'd' ),
1540 ISOM_MEDIA_HANDLER_TYPE_CLOCK_REFERENCE_STREAM = LSMASH_4CC( 'c', 'r', 's', 'm' ),
1541 ISOM_MEDIA_HANDLER_TYPE_DVB_MANDATORY_BASIC_DESCRIPTION = LSMASH_4CC( 'd', 'm', 'b', 'd' ),
1542 ISOM_MEDIA_HANDLER_TYPE_TV_ANYTIME = LSMASH_4CC( 'd', 't', 'v', 'a' ),
1543 ISOM_MEDIA_HANDLER_TYPE_BROADBAND_CONTENT_GUIDE = LSMASH_4CC( 'd', 't', 'v', 'a' ),
1544 ISOM_MEDIA_HANDLER_TYPE_FONT_DATA_STREAM = LSMASH_4CC( 'f', 'd', 's', 'm' ),
1545 ISOM_MEDIA_HANDLER_TYPE_GENERAL_MPEG4_SYSTEM_STREAM = LSMASH_4CC( 'g', 'e', 's', 'm' ),
1546 ISOM_MEDIA_HANDLER_TYPE_HINT_TRACK = LSMASH_4CC( 'h', 'i', 'n', 't' ),
1547 ISOM_MEDIA_HANDLER_TYPE_IPDC_ELECTRONIC_SERVICE_GUIDE = LSMASH_4CC( 'i', 'p', 'd', 'c' ),
1548 ISOM_MEDIA_HANDLER_TYPE_IPMP_STREAM = LSMASH_4CC( 'i', 'p', 's', 'm' ),
1549 ISOM_MEDIA_HANDLER_TYPE_MPEG7_STREAM = LSMASH_4CC( 'm', '7', 's', 'm' ),
1550 ISOM_MEDIA_HANDLER_TYPE_TIMED_METADATA_TRACK = LSMASH_4CC( 'm', 'e', 't', 'a' ),
1551 ISOM_MEDIA_HANDLER_TYPE_MPEGJ_STREAM = LSMASH_4CC( 'm', 'j', 's', 'm' ),
1552 ISOM_MEDIA_HANDLER_TYPE_MPEG21_DIGITAL_ITEM = LSMASH_4CC( 'm', 'p', '2', '1' ),
1553 ISOM_MEDIA_HANDLER_TYPE_OBJECT_CONTENT_INFO_STREAM = LSMASH_4CC( 'o', 'c', 's', 'm' ),
1554 ISOM_MEDIA_HANDLER_TYPE_OBJECT_DESCRIPTOR_STREAM = LSMASH_4CC( 'o', 'd', 's', 'm' ),
1555 ISOM_MEDIA_HANDLER_TYPE_SCENE_DESCRIPTION_STREAM = LSMASH_4CC( 's', 'd', 's', 'm' ),
1556 ISOM_MEDIA_HANDLER_TYPE_KEY_MANAGEMENT_MESSAGES = LSMASH_4CC( 's', 'k', 'm', 'm' ),
1557 ISOM_MEDIA_HANDLER_TYPE_AUDIO_TRACK = LSMASH_4CC( 's', 'o', 'u', 'n' ),
1558 ISOM_MEDIA_HANDLER_TYPE_TEXT_TRACK = LSMASH_4CC( 't', 'e', 'x', 't' ),
1559 ISOM_MEDIA_HANDLER_TYPE_PROPRIETARY_DESCRIPTIVE_METADATA = LSMASH_4CC( 'u', 'r', 'i', ' ' ),
1560 ISOM_MEDIA_HANDLER_TYPE_VIDEO_TRACK = LSMASH_4CC( 'v', 'i', 'd', 'e' ),
1561 } lsmash_media_type;
1563 /* ISO language codes */
1564 typedef enum
1566 #define LSMASH_PACK_ISO_LANGUAGE( a, b, c ) ((((a-0x60)&0x1f)<<10) | (((b-0x60)&0x1f)<<5) | ((c-0x60)&0x1f))
1567 ISOM_LANGUAGE_CODE_ENGLISH = LSMASH_PACK_ISO_LANGUAGE( 'e', 'n', 'g' ),
1568 ISOM_LANGUAGE_CODE_FRENCH = LSMASH_PACK_ISO_LANGUAGE( 'f', 'r', 'a' ),
1569 ISOM_LANGUAGE_CODE_GERMAN = LSMASH_PACK_ISO_LANGUAGE( 'd', 'e', 'u' ),
1570 ISOM_LANGUAGE_CODE_ITALIAN = LSMASH_PACK_ISO_LANGUAGE( 'i', 't', 'a' ),
1571 ISOM_LANGUAGE_CODE_DUTCH_M = LSMASH_PACK_ISO_LANGUAGE( 'd', 'u', 'm' ),
1572 ISOM_LANGUAGE_CODE_SWEDISH = LSMASH_PACK_ISO_LANGUAGE( 's', 'w', 'e' ),
1573 ISOM_LANGUAGE_CODE_SPANISH = LSMASH_PACK_ISO_LANGUAGE( 's', 'p', 'a' ),
1574 ISOM_LANGUAGE_CODE_DANISH = LSMASH_PACK_ISO_LANGUAGE( 'd', 'a', 'n' ),
1575 ISOM_LANGUAGE_CODE_PORTUGUESE = LSMASH_PACK_ISO_LANGUAGE( 'p', 'o', 'r' ),
1576 ISOM_LANGUAGE_CODE_NORWEGIAN = LSMASH_PACK_ISO_LANGUAGE( 'n', 'o', 'r' ),
1577 ISOM_LANGUAGE_CODE_HEBREW = LSMASH_PACK_ISO_LANGUAGE( 'h', 'e', 'b' ),
1578 ISOM_LANGUAGE_CODE_JAPANESE = LSMASH_PACK_ISO_LANGUAGE( 'j', 'p', 'n' ),
1579 ISOM_LANGUAGE_CODE_ARABIC = LSMASH_PACK_ISO_LANGUAGE( 'a', 'r', 'a' ),
1580 ISOM_LANGUAGE_CODE_FINNISH = LSMASH_PACK_ISO_LANGUAGE( 'f', 'i', 'n' ),
1581 ISOM_LANGUAGE_CODE_GREEK = LSMASH_PACK_ISO_LANGUAGE( 'e', 'l', 'l' ),
1582 ISOM_LANGUAGE_CODE_ICELANDIC = LSMASH_PACK_ISO_LANGUAGE( 'i', 's', 'l' ),
1583 ISOM_LANGUAGE_CODE_MALTESE = LSMASH_PACK_ISO_LANGUAGE( 'm', 'l', 't' ),
1584 ISOM_LANGUAGE_CODE_TURKISH = LSMASH_PACK_ISO_LANGUAGE( 't', 'u', 'r' ),
1585 ISOM_LANGUAGE_CODE_CROATIAN = LSMASH_PACK_ISO_LANGUAGE( 'h', 'r', 'v' ),
1586 ISOM_LANGUAGE_CODE_CHINESE = LSMASH_PACK_ISO_LANGUAGE( 'z', 'h', 'o' ),
1587 ISOM_LANGUAGE_CODE_URDU = LSMASH_PACK_ISO_LANGUAGE( 'u', 'r', 'd' ),
1588 ISOM_LANGUAGE_CODE_HINDI = LSMASH_PACK_ISO_LANGUAGE( 'h', 'i', 'n' ),
1589 ISOM_LANGUAGE_CODE_THAI = LSMASH_PACK_ISO_LANGUAGE( 't', 'h', 'a' ),
1590 ISOM_LANGUAGE_CODE_KOREAN = LSMASH_PACK_ISO_LANGUAGE( 'k', 'o', 'r' ),
1591 ISOM_LANGUAGE_CODE_LITHUANIAN = LSMASH_PACK_ISO_LANGUAGE( 'l', 'i', 't' ),
1592 ISOM_LANGUAGE_CODE_POLISH = LSMASH_PACK_ISO_LANGUAGE( 'p', 'o', 'l' ),
1593 ISOM_LANGUAGE_CODE_HUNGARIAN = LSMASH_PACK_ISO_LANGUAGE( 'h', 'u', 'n' ),
1594 ISOM_LANGUAGE_CODE_ESTONIAN = LSMASH_PACK_ISO_LANGUAGE( 'e', 's', 't' ),
1595 ISOM_LANGUAGE_CODE_LATVIAN = LSMASH_PACK_ISO_LANGUAGE( 'l', 'a', 'v' ),
1596 ISOM_LANGUAGE_CODE_SAMI = LSMASH_PACK_ISO_LANGUAGE( 's', 'm', 'i' ),
1597 ISOM_LANGUAGE_CODE_FAROESE = LSMASH_PACK_ISO_LANGUAGE( 'f', 'a', 'o' ),
1598 ISOM_LANGUAGE_CODE_RUSSIAN = LSMASH_PACK_ISO_LANGUAGE( 'r', 'u', 's' ),
1599 ISOM_LANGUAGE_CODE_DUTCH = LSMASH_PACK_ISO_LANGUAGE( 'n', 'l', 'd' ),
1600 ISOM_LANGUAGE_CODE_IRISH = LSMASH_PACK_ISO_LANGUAGE( 'g', 'l', 'e' ),
1601 ISOM_LANGUAGE_CODE_ALBANIAN = LSMASH_PACK_ISO_LANGUAGE( 's', 'q', 'i' ),
1602 ISOM_LANGUAGE_CODE_ROMANIAN = LSMASH_PACK_ISO_LANGUAGE( 'r', 'o', 'n' ),
1603 ISOM_LANGUAGE_CODE_CZECH = LSMASH_PACK_ISO_LANGUAGE( 'c', 'e', 's' ),
1604 ISOM_LANGUAGE_CODE_SLOVAK = LSMASH_PACK_ISO_LANGUAGE( 's', 'l', 'k' ),
1605 ISOM_LANGUAGE_CODE_SLOVENIA = LSMASH_PACK_ISO_LANGUAGE( 's', 'l', 'v' ),
1606 ISOM_LANGUAGE_CODE_YIDDISH = LSMASH_PACK_ISO_LANGUAGE( 'y', 'i', 'd' ),
1607 ISOM_LANGUAGE_CODE_SERBIAN = LSMASH_PACK_ISO_LANGUAGE( 's', 'r', 'p' ),
1608 ISOM_LANGUAGE_CODE_MACEDONIAN = LSMASH_PACK_ISO_LANGUAGE( 'm', 'k', 'd' ),
1609 ISOM_LANGUAGE_CODE_BULGARIAN = LSMASH_PACK_ISO_LANGUAGE( 'b', 'u', 'l' ),
1610 ISOM_LANGUAGE_CODE_UKRAINIAN = LSMASH_PACK_ISO_LANGUAGE( 'u', 'k', 'r' ),
1611 ISOM_LANGUAGE_CODE_BELARUSIAN = LSMASH_PACK_ISO_LANGUAGE( 'b', 'e', 'l' ),
1612 ISOM_LANGUAGE_CODE_UZBEK = LSMASH_PACK_ISO_LANGUAGE( 'u', 'z', 'b' ),
1613 ISOM_LANGUAGE_CODE_KAZAKH = LSMASH_PACK_ISO_LANGUAGE( 'k', 'a', 'z' ),
1614 ISOM_LANGUAGE_CODE_AZERBAIJANI = LSMASH_PACK_ISO_LANGUAGE( 'a', 'z', 'e' ),
1615 ISOM_LANGUAGE_CODE_ARMENIAN = LSMASH_PACK_ISO_LANGUAGE( 'h', 'y', 'e' ),
1616 ISOM_LANGUAGE_CODE_GEORGIAN = LSMASH_PACK_ISO_LANGUAGE( 'k', 'a', 't' ),
1617 ISOM_LANGUAGE_CODE_MOLDAVIAN = LSMASH_PACK_ISO_LANGUAGE( 'r', 'o', 'n' ),
1618 ISOM_LANGUAGE_CODE_KIRGHIZ = LSMASH_PACK_ISO_LANGUAGE( 'k', 'i', 'r' ),
1619 ISOM_LANGUAGE_CODE_TAJIK = LSMASH_PACK_ISO_LANGUAGE( 't', 'g', 'k' ),
1620 ISOM_LANGUAGE_CODE_TURKMEN = LSMASH_PACK_ISO_LANGUAGE( 't', 'u', 'k' ),
1621 ISOM_LANGUAGE_CODE_MONGOLIAN = LSMASH_PACK_ISO_LANGUAGE( 'm', 'o', 'n' ),
1622 ISOM_LANGUAGE_CODE_PASHTO = LSMASH_PACK_ISO_LANGUAGE( 'p', 'u', 's' ),
1623 ISOM_LANGUAGE_CODE_KURDISH = LSMASH_PACK_ISO_LANGUAGE( 'k', 'u', 'r' ),
1624 ISOM_LANGUAGE_CODE_KASHMIRI = LSMASH_PACK_ISO_LANGUAGE( 'k', 'a', 's' ),
1625 ISOM_LANGUAGE_CODE_SINDHI = LSMASH_PACK_ISO_LANGUAGE( 's', 'n', 'd' ),
1626 ISOM_LANGUAGE_CODE_TIBETAN = LSMASH_PACK_ISO_LANGUAGE( 'b', 'o', 'd' ),
1627 ISOM_LANGUAGE_CODE_NEPALI = LSMASH_PACK_ISO_LANGUAGE( 'n', 'e', 'p' ),
1628 ISOM_LANGUAGE_CODE_SANSKRIT = LSMASH_PACK_ISO_LANGUAGE( 's', 'a', 'n' ),
1629 ISOM_LANGUAGE_CODE_MARATHI = LSMASH_PACK_ISO_LANGUAGE( 'm', 'a', 'r' ),
1630 ISOM_LANGUAGE_CODE_BENGALI = LSMASH_PACK_ISO_LANGUAGE( 'b', 'e', 'n' ),
1631 ISOM_LANGUAGE_CODE_ASSAMESE = LSMASH_PACK_ISO_LANGUAGE( 'a', 's', 'm' ),
1632 ISOM_LANGUAGE_CODE_GUJARATI = LSMASH_PACK_ISO_LANGUAGE( 'g', 'u', 'j' ),
1633 ISOM_LANGUAGE_CODE_PUNJABI = LSMASH_PACK_ISO_LANGUAGE( 'p', 'a', 'n' ),
1634 ISOM_LANGUAGE_CODE_ORIYA = LSMASH_PACK_ISO_LANGUAGE( 'o', 'r', 'i' ),
1635 ISOM_LANGUAGE_CODE_MALAYALAM = LSMASH_PACK_ISO_LANGUAGE( 'm', 'a', 'l' ),
1636 ISOM_LANGUAGE_CODE_KANNADA = LSMASH_PACK_ISO_LANGUAGE( 'k', 'a', 'n' ),
1637 ISOM_LANGUAGE_CODE_TAMIL = LSMASH_PACK_ISO_LANGUAGE( 't', 'a', 'm' ),
1638 ISOM_LANGUAGE_CODE_TELUGU = LSMASH_PACK_ISO_LANGUAGE( 't', 'e', 'l' ),
1639 ISOM_LANGUAGE_CODE_SINHALESE = LSMASH_PACK_ISO_LANGUAGE( 's', 'i', 'n' ),
1640 ISOM_LANGUAGE_CODE_BURMESE = LSMASH_PACK_ISO_LANGUAGE( 'm', 'y', 'a' ),
1641 ISOM_LANGUAGE_CODE_KHMER = LSMASH_PACK_ISO_LANGUAGE( 'k', 'h', 'm' ),
1642 ISOM_LANGUAGE_CODE_LAO = LSMASH_PACK_ISO_LANGUAGE( 'l', 'a', 'o' ),
1643 ISOM_LANGUAGE_CODE_VIETNAMESE = LSMASH_PACK_ISO_LANGUAGE( 'v', 'i', 'e' ),
1644 ISOM_LANGUAGE_CODE_INDONESIAN = LSMASH_PACK_ISO_LANGUAGE( 'i', 'n', 'd' ),
1645 ISOM_LANGUAGE_CODE_TAGALOG = LSMASH_PACK_ISO_LANGUAGE( 't', 'g', 'l' ),
1646 ISOM_LANGUAGE_CODE_MALAY_ROMAN = LSMASH_PACK_ISO_LANGUAGE( 'm', 's', 'a' ),
1647 ISOM_LANGUAGE_CODE_MAYAY_ARABIC = LSMASH_PACK_ISO_LANGUAGE( 'm', 's', 'a' ),
1648 ISOM_LANGUAGE_CODE_AMHARIC = LSMASH_PACK_ISO_LANGUAGE( 'a', 'm', 'h' ),
1649 ISOM_LANGUAGE_CODE_OROMO = LSMASH_PACK_ISO_LANGUAGE( 'o', 'r', 'm' ),
1650 ISOM_LANGUAGE_CODE_SOMALI = LSMASH_PACK_ISO_LANGUAGE( 's', 'o', 'm' ),
1651 ISOM_LANGUAGE_CODE_SWAHILI = LSMASH_PACK_ISO_LANGUAGE( 's', 'w', 'a' ),
1652 ISOM_LANGUAGE_CODE_KINYARWANDA = LSMASH_PACK_ISO_LANGUAGE( 'k', 'i', 'n' ),
1653 ISOM_LANGUAGE_CODE_RUNDI = LSMASH_PACK_ISO_LANGUAGE( 'r', 'u', 'n' ),
1654 ISOM_LANGUAGE_CODE_CHEWA = LSMASH_PACK_ISO_LANGUAGE( 'n', 'y', 'a' ),
1655 ISOM_LANGUAGE_CODE_MALAGASY = LSMASH_PACK_ISO_LANGUAGE( 'm', 'l', 'g' ),
1656 ISOM_LANGUAGE_CODE_ESPERANTO = LSMASH_PACK_ISO_LANGUAGE( 'e', 'p', 'o' ),
1657 ISOM_LANGUAGE_CODE_WELSH = LSMASH_PACK_ISO_LANGUAGE( 'c', 'y', 'm' ),
1658 ISOM_LANGUAGE_CODE_BASQUE = LSMASH_PACK_ISO_LANGUAGE( 'e', 'u', 's' ),
1659 ISOM_LANGUAGE_CODE_CATALAN = LSMASH_PACK_ISO_LANGUAGE( 'c', 'a', 't' ),
1660 ISOM_LANGUAGE_CODE_LATIN = LSMASH_PACK_ISO_LANGUAGE( 'l', 'a', 't' ),
1661 ISOM_LANGUAGE_CODE_QUECHUA = LSMASH_PACK_ISO_LANGUAGE( 'q', 'u', 'e' ),
1662 ISOM_LANGUAGE_CODE_GUARANI = LSMASH_PACK_ISO_LANGUAGE( 'g', 'r', 'n' ),
1663 ISOM_LANGUAGE_CODE_AYMARA = LSMASH_PACK_ISO_LANGUAGE( 'a', 'y', 'm' ),
1664 ISOM_LANGUAGE_CODE_TATAR = LSMASH_PACK_ISO_LANGUAGE( 'c', 'r', 'h' ),
1665 ISOM_LANGUAGE_CODE_UIGHUR = LSMASH_PACK_ISO_LANGUAGE( 'u', 'i', 'g' ),
1666 ISOM_LANGUAGE_CODE_DZONGKHA = LSMASH_PACK_ISO_LANGUAGE( 'd', 'z', 'o' ),
1667 ISOM_LANGUAGE_CODE_JAVANESE = LSMASH_PACK_ISO_LANGUAGE( 'j', 'a', 'v' ),
1668 ISOM_LANGUAGE_CODE_UNDEFINED = LSMASH_PACK_ISO_LANGUAGE( 'u', 'n', 'd' ),
1669 } lsmash_iso_language_code;
1671 typedef struct
1673 lsmash_media_type handler_type; /* the nature of the media
1674 * You can't change handler_type through this parameter manually. */
1675 uint32_t timescale; /* media timescale: timescale for this media */
1676 uint64_t duration; /* the duration of this media, expressed in the media timescale
1677 * You can't set this parameter manually. */
1678 uint8_t roll_grouping; /* roll recovery grouping present
1679 * Require 'avc1' brand, or ISO Base Media File Format version 2 or later. */
1680 uint8_t rap_grouping; /* random access point grouping present
1681 * Require ISO Base Media File Format version 6 or later. */
1682 /* Use either type of language code. */
1683 uint16_t MAC_language; /* Macintosh language code for this media */
1684 uint16_t ISO_language; /* ISO 639-2/T language code for this media */
1685 /* human-readable name for the track type (for debugging and inspection purposes) */
1686 char *media_handler_name;
1687 char *data_handler_name;
1688 /* Any user shouldn't use the following parameters. */
1689 PRIVATE char media_handler_name_shadow[256];
1690 PRIVATE char data_handler_name_shadow[256];
1691 } lsmash_media_parameters_t;
1693 /* Set all the given media parameters to default. */
1694 void lsmash_initialize_media_parameters
1696 lsmash_media_parameters_t *param /* the address of the media parameters to which you want to set default value */
1699 /* Set media parameters to a track.
1701 * Return 0 if successful.
1702 * Return a negative value otherwise. */
1703 int lsmash_set_media_parameters
1705 lsmash_root_t *root, /* the address of a ROOT containing a track to which you want to set the media parameters */
1706 uint32_t track_ID, /* the track_ID of a track to which you want to set the media parameters */
1707 lsmash_media_parameters_t *param /* the address of the media parameters you want to set to a track. */
1710 /* Set the duration of the last sample to a track.
1712 * Return 0 if successful.
1713 * Return a negative value otherwise. */
1714 int lsmash_set_last_sample_delta
1716 lsmash_root_t *root,
1717 uint32_t track_ID,
1718 uint32_t sample_delta
1721 /* Flush samples in the internal pool in a track.
1722 * Users shall call this function for each track before calling lsmash_finish_movie() or lsmash_create_fragment_movie().
1724 * Return 0 if successful.
1725 * Return a negative value otherwise. */
1726 int lsmash_flush_pooled_samples
1728 lsmash_root_t *root,
1729 uint32_t track_ID,
1730 uint32_t last_sample_delta
1733 /* Update the modification time of a media to the most recent.
1734 * If the creation time of that media is larger than the modification time,
1735 * then override the creation one with the modification one.
1737 * Return 0 if successful.
1738 * Return a negative value otherwise. */
1739 int lsmash_update_media_modification_time
1741 lsmash_root_t *root,
1742 uint32_t track_ID
1745 /* Get the media parameters in a track.
1747 * Return 0 if successful.
1748 * Return a negative value otherwise. */
1749 int lsmash_get_media_parameters
1751 lsmash_root_t *root,
1752 uint32_t track_ID,
1753 lsmash_media_parameters_t *param
1756 /* Get the duration of a media.
1758 * Return the duration of a media if successful.
1759 * Return 0 otherwise. */
1760 uint64_t lsmash_get_media_duration
1762 lsmash_root_t *root,
1763 uint32_t track_ID
1766 /* Get the timescale of a media.
1768 * Return the timescale of a media if successful.
1769 * Return 0 otherwise. */
1770 uint32_t lsmash_get_media_timescale
1772 lsmash_root_t *root,
1773 uint32_t track_ID
1776 /* Get the duration of the last sample in a track.
1778 * Return the duration of the last sample in a track if successful.
1779 * Return 0 otherwise. */
1780 uint32_t lsmash_get_last_sample_delta
1782 lsmash_root_t *root,
1783 uint32_t track_ID
1786 /* Get the composition time offset of the first sample in a track.
1788 * Return the composition time offset of the first sample in a track if successful.
1789 * Return 0 otherwise. */
1790 uint32_t lsmash_get_start_time_offset
1792 lsmash_root_t *root,
1793 uint32_t track_ID
1796 /* Get the shift of composition timeline to decode timeline in a track.
1798 * Return the shift of composition timeline to decode timeline in a track. if successful.
1799 * Return 0 otherwise. */
1800 uint32_t lsmash_get_composition_to_decode_shift
1802 lsmash_root_t *root,
1803 uint32_t track_ID
1806 /* Pack a string of ISO 639-2/T language code into 16-bit data.
1808 * Return a packed 16-bit ISO 639-2/T language if successful.
1809 * Return 0 otherwise. */
1810 uint16_t lsmash_pack_iso_language
1812 char *iso_language /* a string of ISO 639-2/T language code */
1815 /****************************************************************************
1816 * Track Layer
1817 ****************************************************************************/
1818 /* Track mode */
1819 typedef enum
1821 /* In MP4 and/or ISO base media file format, if in a presentation all tracks have neither track_in_movie nor track_in_preview set,
1822 * then all tracks shall be treated as if both flags were set on all tracks. */
1823 ISOM_TRACK_ENABLED = 0x000001, /* Track_enabled: Indicates that the track is enabled.
1824 * A disabled track is treated as if it were not present. */
1825 ISOM_TRACK_IN_MOVIE = 0x000002, /* Track_in_movie: Indicates that the track is used in the presentation. */
1826 ISOM_TRACK_IN_PREVIEW = 0x000004, /* Track_in_preview: Indicates that the track is used when previewing the presentation. */
1828 QT_TRACK_IN_POSTER = 0x000008, /* Track_in_poster: Indicates that the track is used in the movie's poster. (only defined in QuickTime file format) */
1829 } lsmash_track_mode;
1831 typedef struct
1833 lsmash_track_mode mode;
1834 uint32_t track_ID; /* an integer that uniquely identifies the track
1835 * Don't set to value already used except for zero value.
1836 * Zero value don't override established track_ID. */
1837 uint64_t duration; /* the duration of this track expressed in the movie timescale units
1838 * If there is any edit, your setting is ignored. */
1839 int16_t alternate_group; /* an integer that specifies a group or collection of tracks
1840 * If this field is not 0, it should be the same for tracks that contain alternate data for one another
1841 * and different for tracks belonging to different such groups.
1842 * Only one track within an alternate group should be played or streamed at any one time.
1843 * Note: alternate_group is ignored when a file is read as an MPEG-4. */
1844 /* The following parameters are ignored when a file is read as an MPEG-4 or 3GPP file format. */
1845 int16_t video_layer; /* the front-to-back ordering of video tracks; tracks with lower numbers are closer to the viewer. */
1846 int16_t audio_volume; /* fixed point 8.8 number. 0x0100 is full volume. */
1847 int32_t matrix[9]; /* transformation matrix for the video
1848 * Each value represents, in order, a, b, u, c, d, v, x, y and w.
1849 * All the values in a matrix are stored as 16.16 fixed-point values,
1850 * except for u, v and w, which are stored as 2.30 fixed-point values.
1851 * Not all derived specifications use matrices.
1852 * If a matrix is used, the point (p, q) is transformed into (p', q') using the matrix as follows:
1853 * | a b u |
1854 * (p, q, 1) * | c d v | = z * (p', q', 1)
1855 * | x y w |
1856 * p' = (a * p + c * q + x) / z; q' = (b * p + d * q + y) / z; z = u * p + v * q + w
1857 * Note: transformation matrix is applied after scaling to display size up to display_width and display_height. */
1858 /* visual presentation region size */
1859 uint32_t display_width; /* visual presentation region size of horizontal direction as fixed point 16.16 number. */
1860 uint32_t display_height; /* visual presentation region size of vertical direction as fixed point 16.16 number. */
1861 /* */
1862 uint8_t aperture_modes; /* track aperture modes present
1863 * This feature is only available under QuickTime file format.
1864 * Automatically disabled if multiple sample description is present or scaling method is specified. */
1865 } lsmash_track_parameters_t;
1867 /* Explicit Timeline Map (Edit)
1868 * There are two types of timeline; one is the media timeline, the other is the presentation timeline (or the movie timeline).
1869 * An edit maps the presentation timeline to the media timeline.
1870 * Therefore, an edit can select any portion within the media and specify its playback speed.
1871 * The media within the track is played through the presentation timeline, so you can construct any complex presentation from a media by edits.
1872 * In the absence of any edit, there is an implicit one-to-one mapping of these timelines, and the presentation of a track starts at the beginning of the presentation.
1873 * Note: any edit doesn't restrict decoding and composition. So, if a sample in an edit need to decode from a sample in outside of that edit,
1874 * the decoder shall start to decode from there but player shall not display any sample in outside of that edit. */
1875 #define ISOM_EDIT_MODE_NORMAL (1<<16)
1876 #define ISOM_EDIT_MODE_DWELL 0
1877 #define ISOM_EDIT_MODE_EMPTY -1
1878 #define ISOM_EDIT_DURATION_UNKNOWN32 0xffffffff
1879 #define ISOM_EDIT_DURATION_UNKNOWN64 0xffffffffffffffff
1880 #define ISOM_EDIT_DURATION_IMPLICIT 0
1882 typedef struct
1884 uint64_t duration; /* the duration of this edit expressed in the movie timescale units
1885 * An edit can refer to the media within fragmented tracks.
1886 * The duration can be unknown at the time of creation of the initial movie due to various limiting factors that include
1887 * real-time generation of content, such as live streaming. In such a case it is recommended that the duration is set to
1888 * either ISOM_EDIT_DURATION_UNKNOWN32 (the maximum 32-bit unsigned integer), ISOM_EDIT_DURATION_UNKNOWN64 (the maximum
1889 * 64-bit unsigned integer) or ISOM_EDIT_DURATION_IMPLICIT.
1890 * If you have no interest in the duration of this edit but want to set the offset from media composition time to movie
1891 * presentation time, ISOM_EDIT_DURATION_IMPLICIT is useful for the provision of the offset for the movie and subsequent
1892 * movie fragments. The duration is expected to be constructed by demuxer. */
1893 int64_t start_time; /* the starting composition time within the media of this edit
1894 * If set to ISOM_EDIT_MODE_EMPTY (-1), it construct an empty edit, which doesn't select any portion within the media. */
1895 int32_t rate; /* the relative rate at which to play the media corresponding to this edit, expressed as 16.16 fixed-point number
1896 * If set to ISOM_EDIT_MODE_NORMAL (0x00010000), there is no rate change for timeline mapping.
1897 * If set to ISOM_EDIT_MODE_DWELL (0), the media at start_time is presented for the duration. */
1898 } lsmash_edit_t;
1900 /* Create a track in a movie.
1901 * Users can destroy the created track by lsmash_delete_track().
1902 * When a track is created, its track_ID is assigned automatically so that any duplication of track_ID may be avoided.
1904 * Return the current track_ID of a track created by this function if successful.
1905 * Return 0 otherwise. */
1906 uint32_t lsmash_create_track
1908 lsmash_root_t *root,
1909 lsmash_media_type media_type
1912 /* Destroy the track of a given track_ID in a movie. */
1913 void lsmash_delete_track
1915 lsmash_root_t *root,
1916 uint32_t track_ID
1919 /* Set all the given track parameters to default. */
1920 void lsmash_initialize_track_parameters
1922 lsmash_track_parameters_t *param
1925 /* Set track parameters to a track.
1927 * Return 0 if successful.
1928 * Return a negative value otherwise. */
1929 int lsmash_set_track_parameters
1931 lsmash_root_t *root,
1932 uint32_t track_ID,
1933 lsmash_track_parameters_t *param
1936 /* Update the duration of a track with a new duration of its last sample.
1938 * Return 0 if successful.
1939 * Return a negative value otherwise. */
1940 int lsmash_update_track_duration
1942 lsmash_root_t *root,
1943 uint32_t track_ID,
1944 uint32_t last_sample_delta
1947 /* Update the modification time of a track to the most recent.
1948 * If the creation time of that track is larger than the modification time,
1949 * then override the creation one with the modification one.
1951 * Return 0 if successful.
1952 * Return a negative value otherwise. */
1953 int lsmash_update_track_modification_time
1955 lsmash_root_t *root,
1956 uint32_t track_ID
1959 /* Get a track_ID by a track number.
1960 * A track number is given in created order in a movie.
1961 * If a track is removed, the track number of tracks with higher track number than one of just removed track will be decremented.
1963 * Return a track_ID if successful.
1964 * Return 0 otherwise. */
1965 uint32_t lsmash_get_track_ID
1967 lsmash_root_t *root,
1968 uint32_t track_number
1971 /* Get the track parameters in a track.
1973 * Return 0 if successful.
1974 * Return a negative value otherwise. */
1975 int lsmash_get_track_parameters
1977 lsmash_root_t *root,
1978 uint32_t track_ID,
1979 lsmash_track_parameters_t *param
1982 /* Get the duration of a track.
1984 * Return the duration of a track if successful.
1985 * Return 0 otherwise. */
1986 uint64_t lsmash_get_track_duration
1988 lsmash_root_t *root,
1989 uint32_t track_ID
1992 /* Create an explicit timeline map (edit) and append it into a track.
1993 * Users can destroy ALL created edits in a track by lsmash_delete_explicit_timeline_map().
1995 * Return 0 if successful.
1996 * Return a negative value otherwise. */
1997 int lsmash_create_explicit_timeline_map
1999 lsmash_root_t *root,
2000 uint32_t track_ID,
2001 lsmash_edit_t edit
2004 /* Destroy ALL created edits in a track.
2006 * Return 0 if successful.
2007 * Return a negative value otherwise. */
2008 int lsmash_delete_explicit_timeline_map
2010 lsmash_root_t *root,
2011 uint32_t track_ID
2014 /* Count the number of edits in a track.
2016 * Return the number of edits in a track if successful.
2017 * Return 0 otherwise. */
2018 uint32_t lsmash_count_explicit_timeline_map
2020 lsmash_root_t *root,
2021 uint32_t track_ID
2024 /* Get an edit in a track by an edit number.
2025 * An edit number is given in created order in a track.
2026 * If an edit is removed, the edit number of edits with higher edit number than one of just removed edit will be decremented.
2028 * Return 0 if successful.
2029 * Return a negative value otherwise. */
2030 int lsmash_get_explicit_timeline_map
2032 lsmash_root_t *root,
2033 uint32_t track_ID,
2034 uint32_t edit_number,
2035 lsmash_edit_t *edit
2038 /* Modify an edit in a track by an edit number.
2039 * An edit number is given in created order in a track.
2040 * If an edit is removed, the edit number of edits with higher edit number than one of just removed edit will be decremented.
2042 * Return 0 if successful.
2043 * Return a negative value otherwise. */
2044 int lsmash_modify_explicit_timeline_map
2046 lsmash_root_t *root,
2047 uint32_t track_ID,
2048 uint32_t edit_number,
2049 lsmash_edit_t edit
2052 /****************************************************************************
2053 * Movie Layer
2054 ****************************************************************************/
2055 typedef struct
2057 lsmash_brand_type major_brand; /* deprecated: the best used brand */
2058 lsmash_brand_type *brands; /* deprecated: the list of compatible brands */
2059 uint32_t number_of_brands; /* deprecated: the number of compatible brands used in the movie */
2060 uint32_t minor_version; /* deprecated: minor version of best used brand */
2061 double max_chunk_duration; /* deprecated: max duration per chunk in seconds. 0.5 is default value. */
2062 double max_async_tolerance; /* deprecated:
2063 * max tolerance, in seconds, for amount of interleaving asynchronization between tracks.
2064 * 2.0 is default value. At least twice of max_chunk_duration is used. */
2065 uint64_t max_chunk_size; /* deprecated: max size per chunk in bytes. 4*1024*1024 (4MiB) is default value. */
2066 uint64_t max_read_size; /* deprecated: max size of reading from a chunk at a time. 4*1024*1024 (4MiB) is default value. */
2067 uint32_t timescale; /* movie timescale: timescale for the entire presentation */
2068 uint64_t duration; /* the duration, expressed in movie timescale, of the longest track
2069 * You can't set this parameter manually. */
2070 uint32_t number_of_tracks; /* the number of tracks in the movie
2071 * You can't set this parameter manually. */
2072 /* The following parameters are recognized only when a file is read as an Apple MPEG-4 or QuickTime file format. */
2073 int32_t playback_rate; /* fixed point 16.16 number. 0x00010000 is normal forward playback and default value. */
2074 int32_t playback_volume; /* fixed point 8.8 number. 0x0100 is full volume and default value. */
2075 int32_t preview_time; /* the time value in the movie at which the preview begins */
2076 int32_t preview_duration; /* the duration of the movie preview in movie timescale units */
2077 int32_t poster_time; /* the time value of the time of the movie poster */
2078 /* Any user shouldn't use the following parameter. */
2079 PRIVATE lsmash_brand_type brands_shadow[50];
2080 } lsmash_movie_parameters_t;
2082 typedef int (*lsmash_adhoc_remux_callback)( void *param, uint64_t done, uint64_t total );
2083 typedef struct {
2084 uint64_t buffer_size;
2085 lsmash_adhoc_remux_callback func;
2086 void *param;
2087 } lsmash_adhoc_remux_t;
2089 /* Set all the given movie parameters to default. */
2090 void lsmash_initialize_movie_parameters
2092 lsmash_movie_parameters_t *param
2095 /* Set movie parameters to a movie.
2097 * Return 0 if successful.
2098 * Return a negative value otherwise. */
2099 int lsmash_set_movie_parameters
2101 lsmash_root_t *root,
2102 lsmash_movie_parameters_t *param
2105 /* Finalize a movie.
2106 * If the movie is not fragmented and 'remux' is set to non-NULL,
2107 * move overall necessary data to access and decode samples into the very front of the file at the end.
2108 * This is useful for progressive downloading.
2109 * Users shall call lsmash_flush_pooled_samples() for each track before calling this function.
2111 * Return 0 if successful.
2112 * Return a negative value otherwise. */
2113 int lsmash_finish_movie
2115 lsmash_root_t *root,
2116 lsmash_adhoc_remux_t *remux
2119 /* Update the modification time of a movie to the most recent.
2120 * If the creation time of that movie is larger than the modification time,
2121 * then override the creation one with the modification one.
2123 * Return 0 if successful.
2124 * Return a negative value otherwise. */
2125 int lsmash_update_movie_modification_time
2127 lsmash_root_t *root
2130 /* Get the movie parameters in a movie.
2132 * Return 0 if successful.
2133 * Return a negative value otherwise. */
2134 int lsmash_get_movie_parameters
2136 lsmash_root_t *root,
2137 lsmash_movie_parameters_t *param
2140 /* Get the timescale of a movie.
2142 * Return the timescale of a movie if successful.
2143 * Return 0 otherwise. */
2144 uint32_t lsmash_get_movie_timescale
2146 lsmash_root_t *root
2149 /****************************************************************************
2150 * Chapter list
2151 ****************************************************************************/
2152 /* Create a track as a chapter list referenced by another track.
2154 * Return 0 if successful.
2155 * Return a negative value otherwise. */
2156 int lsmash_create_reference_chapter_track
2158 lsmash_root_t *root,
2159 uint32_t track_ID,
2160 char *file_name
2163 /* Create and set a chapter list as a user data to a movie.
2164 * The created chapter list in a movie can be destroyed by lsmash_delete_tyrant_chapter().
2166 * Return 0 if successful.
2167 * Return a negative value otherwise. */
2168 int lsmash_set_tyrant_chapter
2170 lsmash_root_t *root,
2171 char *file_name,
2172 int add_bom
2175 /* Destroy a chapter list as a user data in a movie. */
2176 void lsmash_delete_tyrant_chapter
2178 lsmash_root_t *root
2181 /* Count chapters in the chapter list (moov.udta.chpl). */
2182 uint32_t lsmash_count_tyrant_chapter
2184 lsmash_root_t *root
2187 /* Retrieve a chapter entry from the chapter list (moov.udta.chpl).
2188 * Returned pointer is owned by the ROOT structure, so user shall not
2189 * modify or free it.
2191 * Return chapter title string if successful, otherwise NULL.
2193 char *lsmash_get_tyrant_chapter
2195 lsmash_root_t *root,
2196 uint32_t index, /* index of chapter ( >= 1) */
2197 double *timestamp /* timestamp of the chapter entry (in seconds) */
2200 /****************************************************************************
2201 * Fragments
2202 ****************************************************************************/
2203 /* Flush the current movie fragment and create a new movie fragment.
2204 * Users shall call lsmash_flush_pooled_samples() for each track before calling this function.
2206 * Return 0 if successful.
2207 * Return a negative value otherwise. */
2208 int lsmash_create_fragment_movie
2210 lsmash_root_t *root
2213 /* Create an empty duration track in the current movie fragment.
2214 * Don't specify track_ID any track fragment in the current movie fragment has.
2216 * Return 0 if successful.
2217 * Return a negative value otherwise. */
2218 int lsmash_create_fragment_empty_duration
2220 lsmash_root_t *root,
2221 uint32_t track_ID,
2222 uint32_t duration
2225 #ifdef LSMASH_DEMUXER_ENABLED
2226 /****************************************************************************
2227 * Dump / Print
2228 ****************************************************************************/
2229 /* Dump and print box structure of ROOT into the destination.
2231 * Return 0 if successful.
2232 * Return a negative value otherwise. */
2233 int lsmash_print_movie
2235 lsmash_root_t *root, /* the address of ROOT you want to dump and print */
2236 const char *filename /* the path of a file as the destination */
2239 /* Print a chapter list written as a user data on stdout.
2240 * This function might output BOM on Windows.
2242 * Return 0 if successful.
2243 * Return a negative value otherwise. */
2244 int lsmash_print_chapter_list
2246 lsmash_root_t *root
2249 /****************************************************************************
2250 * Timeline
2251 ****************************************************************************/
2252 /* Copy all edits from the source track to the destination track.
2254 * Return 0 if successful.
2255 * Return a negative value otherwise. */
2256 int lsmash_copy_timeline_map
2258 lsmash_root_t *dst,
2259 uint32_t dst_track_ID,
2260 lsmash_root_t *src,
2261 uint32_t src_track_ID
2264 /* Construct the timeline for a track.
2265 * The constructed timeline can be destructed by lsmash_destruct_timeline().
2267 * Return 0 if successful.
2268 * Return a negative value otherwise. */
2269 int lsmash_construct_timeline
2271 lsmash_root_t *root,
2272 uint32_t track_ID
2275 /* Destruct the timeline for a given track. */
2276 void lsmash_destruct_timeline
2278 lsmash_root_t *root,
2279 uint32_t track_ID
2282 /* Get the duration of the last sample from the media timeline for a track.
2284 * Return 0 if successful.
2285 * Return a negative value otherwise. */
2286 int lsmash_get_last_sample_delta_from_media_timeline
2288 lsmash_root_t *root,
2289 uint32_t track_ID,
2290 uint32_t *last_sample_delta /* the address of a variable to which the duration of the last sample will be set */
2293 /* Get the duration of a sample from the media timeline for a track.
2295 * Return 0 if successful.
2296 * Return a negative value otherwise. */
2297 int lsmash_get_sample_delta_from_media_timeline
2299 lsmash_root_t *root,
2300 uint32_t track_ID,
2301 uint32_t sample_number,
2302 uint32_t *sample_delta /* the address of a variable to which the duration of a sample will be set */
2305 /* Get the decoding timestamp of a sample from the media timeline for a track.
2307 * Return 0 if successful.
2308 * Return a negative value otherwise. */
2309 int lsmash_get_dts_from_media_timeline
2311 lsmash_root_t *root,
2312 uint32_t track_ID,
2313 uint32_t sample_number,
2314 uint64_t *dts /* the address of a variable to which a decoding timestamp will be set */
2317 /* Get the composition timestamp of a sample from the media timeline for a track.
2319 * Return 0 if successful.
2320 * Return a negative value otherwise. */
2321 int lsmash_get_cts_from_media_timeline
2323 lsmash_root_t *root,
2324 uint32_t track_ID,
2325 uint32_t sample_number,
2326 uint64_t *cts /* the address of a variable to which a composition timestamp will be set */
2329 /* Get the shift of composition timeline to decode timeline from the media timeline for a track.
2331 * Return 0 if successful.
2332 * Return a negative value otherwise. */
2333 int lsmash_get_composition_to_decode_shift_from_media_timeline
2335 lsmash_root_t *root,
2336 uint32_t track_ID,
2337 uint32_t *ctd_shift /* the address of a variable to which the shift of composition timeline to decode timeline will be set */
2340 /* Get the sample number which is the closest random accessible point to the sample
2341 * corresponding to a given sample number from the media timeline for a track.
2342 * This function tries to find the closest random accessible point from the past at the first.
2343 * If not found, try to find it from the future.
2344 * Note:
2345 * the closest random accessible point doesn't always guarantee that
2346 * the sample corresponding to a given number can be decodable correctly by decoding from there.
2348 * Return 0 if successful.
2349 * Return a negative value otherwise. */
2350 int lsmash_get_closest_random_accessible_point_from_media_timeline
2352 lsmash_root_t *root,
2353 uint32_t track_ID,
2354 uint32_t sample_number,
2355 uint32_t *rap_number /* the address of a variable to which the sample number of the closest random accessible point will be set */
2358 /* Get the detailed information of the closest random accessible point to the sample
2359 * corresponding to a given sample number from the media timeline for a track.
2360 * Note:
2361 * the closest random accessible point doesn't always guarantee that
2362 * the sample corresponding to a given number can be decodable correctly by decoding from there.
2364 * Return 0 if successful.
2365 * Return a negative value otherwise. */
2366 int lsmash_get_closest_random_accessible_point_detail_from_media_timeline
2368 lsmash_root_t *root,
2369 uint32_t track_ID,
2370 uint32_t sample_number,
2371 uint32_t *rap_number, /* the address of a variable to which the sample number of the closest random accessible point will be set */
2372 lsmash_random_access_flag *ra_flags, /* the address of a variable to which the flags of the closest random accessible point will be set */
2373 uint32_t *leading, /* the address of a variable to which the number of leading samples will be set */
2374 uint32_t *distance /* the address of a variable to which a distance from the closest random accessible point to a point which guarantees
2375 * that the sample corresponding to a given number can be decodable correctly by decoding from there will be set */
2378 /* Get the number of samples in the media timeline for a track.
2380 * Return the number of samples in a track if successful.
2381 * Return 0 otherwise. */
2382 uint32_t lsmash_get_sample_count_in_media_timeline
2384 lsmash_root_t *root,
2385 uint32_t track_ID
2388 /* Get the maximum size of sample in the media timeline for a track.
2390 * Return the maximum size of the samples in a track if successful.
2391 * Return 0 otherwise. */
2392 uint32_t lsmash_get_max_sample_size_in_media_timeline
2394 lsmash_root_t *root,
2395 uint32_t track_ID
2398 /* Get the duration of the media from the media timeline for a track.
2400 * Return the duration of the media in a track if successful.
2401 * Return 0 otherwise. */
2402 uint64_t lsmash_get_media_duration_from_media_timeline
2404 lsmash_root_t *root,
2405 uint32_t track_ID
2408 /* Allocate and get the sample corresponding to a given sample number from the media timeline for a track.
2409 * The allocated sample can be deallocated by lsmash_delete_sample().
2411 * Return the address of an allocated and gotten sample if successful.
2412 * Return NULL otherwise. */
2413 lsmash_sample_t *lsmash_get_sample_from_media_timeline
2415 lsmash_root_t *root,
2416 uint32_t track_ID,
2417 uint32_t sample_number
2420 /* Get the information of the sample correspondint to a given sample number from the media timeline for a track.
2421 * The information includes the size, timestamps and properties of the sample.
2423 * Return 0 if successful.
2424 * Return a negative value otherwise. */
2425 int lsmash_get_sample_info_from_media_timeline
2427 lsmash_root_t *root,
2428 uint32_t track_ID,
2429 uint32_t sample_number,
2430 lsmash_sample_t *sample
2433 /* Get the properties of the sample correspondint to a given sample number from the media timeline for a track.
2435 * Return 0 if successful.
2436 * Return a negative value otherwise. */
2437 int lsmash_get_sample_property_from_media_timeline
2439 lsmash_root_t *root,
2440 uint32_t track_ID,
2441 uint32_t sample_number,
2442 lsmash_sample_property_t *prop
2445 /* Check if the sample corresponding to a given sample number exists in the media timeline for a track.
2447 * Return 1 if the sample exists.
2448 * Return 0 otherwise. */
2449 int lsmash_check_sample_existence_in_media_timeline
2451 lsmash_root_t *root,
2452 uint32_t track_ID,
2453 uint32_t sample_number
2456 /* Set or change the decoding and composition timestamps in the media timeline for a track.
2457 * This function doesn't support for any LPCM track currently.
2459 * Return 0 if successful.
2460 * Return a negative value othewise. */
2461 int lsmash_set_media_timestamps
2463 lsmash_root_t *root,
2464 uint32_t track_ID,
2465 lsmash_media_ts_list_t *ts_list
2468 /* Allocate and get the decoding and composition timestamps from the media timeline for a track.
2469 * The allocated decoding and composition timestamps can be deallocated by lsmash_delete_media_timestamps().
2471 * Return 0 if successful.
2472 * Return a negative value othewise. */
2473 int lsmash_get_media_timestamps
2475 lsmash_root_t *root,
2476 uint32_t track_ID,
2477 lsmash_media_ts_list_t *ts_list
2480 /* Deallocate the decoding and composition timestamps in a given media timestamp list. */
2481 void lsmash_delete_media_timestamps
2483 lsmash_media_ts_list_t *ts_list
2486 /* Get the maximum composition delay derived from composition reordering.
2488 * Return 0 if successful.
2489 * Return a negative value otherwise. */
2490 int lsmash_get_max_sample_delay
2492 lsmash_media_ts_list_t *ts_list,
2493 uint32_t *max_sample_delay
2496 /* Sort decoding and composition timestamps in decoding order. */
2497 void lsmash_sort_timestamps_decoding_order
2499 lsmash_media_ts_list_t *ts_list
2502 /* Sort decoding and composition timestamps in composition order. */
2503 void lsmash_sort_timestamps_composition_order
2505 lsmash_media_ts_list_t *ts_list
2507 #endif
2509 /****************************************************************************
2510 * Tools for creating CODEC Specific Information Extensions (Magic Cookies)
2511 ****************************************************************************/
2512 /* MPEG-4 Systems Specific Information
2513 * Mandatory :
2514 * ISOM_CODEC_TYPE_MP4A_AUDIO
2515 * QT_CODEC_TYPE_MP4A_AUDIO
2516 * ISOM_CODEC_TYPE_MP4V_AUDIO
2517 * ISOM_CODEC_TYPE_MP4S_AUDIO */
2518 /* objectTypeIndication */
2519 typedef enum
2521 MP4SYS_OBJECT_TYPE_Forbidden = 0x00, /* Forbidden */
2522 MP4SYS_OBJECT_TYPE_Systems_ISO_14496_1 = 0x01, /* Systems ISO/IEC 14496-1
2523 * For all 14496-1 streams unless specifically indicated to the contrary.
2524 * Scene Description scenes, which are identified with StreamType=0x03, using
2525 * this object type value shall use the BIFSConfig. */
2526 MP4SYS_OBJECT_TYPE_Systems_ISO_14496_1_BIFSv2 = 0x02, /* Systems ISO/IEC 14496-1
2527 * This object type shall be used, with StreamType=0x03, for Scene
2528 * Description streams that use the BIFSv2Config.
2529 * Its use with other StreamTypes is reserved. */
2530 MP4SYS_OBJECT_TYPE_Interaction_Stream = 0x03, /* Interaction Stream */
2531 MP4SYS_OBJECT_TYPE_Extended_BIFS = 0x04, /* Extended BIFS
2532 * Used, with StreamType=0x03, for Scene Description streams that use the BIFSConfigEx;
2533 * its use with other StreamTypes is reserved.
2534 * (Was previously reserved for MUCommandStream but not used for that purpose.) */
2535 MP4SYS_OBJECT_TYPE_AFX_Stream = 0x05, /* AFX Stream
2536 * Used, with StreamType=0x03, for Scene Description streams that use the AFXConfig;
2537 * its use with other StreamTypes is reserved. */
2538 MP4SYS_OBJECT_TYPE_Font_Data_Stream = 0x06, /* Font Data Stream */
2539 MP4SYS_OBJECT_TYPE_Synthetised_Texture = 0x07, /* Synthetised Texture */
2540 MP4SYS_OBJECT_TYPE_Text_Stream = 0x08, /* Text Stream */
2541 MP4SYS_OBJECT_TYPE_Visual_ISO_14496_2 = 0x20, /* Visual ISO/IEC 14496-2
2542 * The actual object types are within the DecoderSpecificInfo and defined in 14496-2. */
2543 MP4SYS_OBJECT_TYPE_Visual_H264_ISO_14496_10 = 0x21, /* Visual ITU-T Recommendation H.264 | ISO/IEC 14496-10
2544 * The actual object types are within the DecoderSpecificInfo and defined in H.264 | 14496-10. */
2545 MP4SYS_OBJECT_TYPE_Parameter_Sets_H_264_ISO_14496_10 = 0x22, /* Parameter Sets for ITU-T Recommendation H.264 | ISO/IEC 14496-10
2546 * The actual object types are within the DecoderSpecificInfo and defined in H.264 | 14496-10. */
2547 MP4SYS_OBJECT_TYPE_Audio_ISO_14496_3 = 0x40, /* Audio ISO/IEC 14496-3 (MPEG-4 Audio)
2548 * The actual object types are defined in 14496-3 and are in the DecoderSpecificInfo as specified in 14496-3. */
2549 MP4SYS_OBJECT_TYPE_Visual_ISO_13818_2_Simple_Profile = 0x60, /* Visual ISO/IEC 13818-2 Simple Profile (MPEG-2 Video) */
2550 MP4SYS_OBJECT_TYPE_Visual_ISO_13818_2_Main_Profile = 0x61, /* Visual ISO/IEC 13818-2 Main Profile */
2551 MP4SYS_OBJECT_TYPE_Visual_ISO_13818_2_SNR_Profile = 0x62, /* Visual ISO/IEC 13818-2 SNR Profile */
2552 MP4SYS_OBJECT_TYPE_Visual_ISO_13818_2_Spatial_Profile = 0x63, /* Visual ISO/IEC 13818-2 Spatial Profile */
2553 MP4SYS_OBJECT_TYPE_Visual_ISO_13818_2_High_Profile = 0x64, /* Visual ISO/IEC 13818-2 High Profile */
2554 MP4SYS_OBJECT_TYPE_Visual_ISO_13818_2_422_Profile = 0x65, /* Visual ISO/IEC 13818-2 422 Profile */
2555 MP4SYS_OBJECT_TYPE_Audio_ISO_13818_7_Main_Profile = 0x66, /* Audio ISO/IEC 13818-7 Main Profile (MPEG-2 Audio)(AAC) */
2556 MP4SYS_OBJECT_TYPE_Audio_ISO_13818_7_LC_Profile = 0x67, /* Audio ISO/IEC 13818-7 LowComplexity Profile */
2557 MP4SYS_OBJECT_TYPE_Audio_ISO_13818_7_SSR_Profile = 0x68, /* Audio ISO/IEC 13818-7 Scaleable Sampling Rate Profile
2558 * For streams kinda 13818-7 the decoder specific information consists of the ADIF header if present
2559 * (or none if not present) and an access unit is a "raw_data_block()" as defined in 13818-7. */
2560 MP4SYS_OBJECT_TYPE_Audio_ISO_13818_3 = 0x69, /* Audio ISO/IEC 13818-3 (MPEG-2 BC-Audio)(redefined MPEG-1 Audio in MPEG-2)
2561 * For streams kinda 13818-3 the decoder specific information is empty since all necessary data is in the bitstream frames itself.
2562 * The access units in this case are the "frame()" bitstream element as is defined in 11172-3. */
2563 MP4SYS_OBJECT_TYPE_Visual_ISO_11172_2 = 0x6A, /* Visual ISO/IEC 11172-2 (MPEG-1 Video) */
2564 MP4SYS_OBJECT_TYPE_Audio_ISO_11172_3 = 0x6B, /* Audio ISO/IEC 11172-3 (MPEG-1 Audio) */
2565 MP4SYS_OBJECT_TYPE_Visual_ISO_10918_1 = 0x6C, /* Visual ISO/IEC 10918-1 (JPEG) */
2566 MP4SYS_OBJECT_TYPE_PNG = 0x6D, /* Portable Network Graphics */
2567 MP4SYS_OBJECT_TYPE_Visual_ISO_15444_1_JPEG2000 = 0x6E, /* Visual ISO/IEC 15444-1 (JPEG 2000) */
2569 /* FIXME: rename these symbols to be explaining, rather than based on four cc */
2570 MP4SYS_OBJECT_TYPE_EVRC_AUDIO = 0xA0, /* EVRC Voice */
2571 MP4SYS_OBJECT_TYPE_SSMV_AUDIO = 0xA1, /* SMV Voice */
2572 MP4SYS_OBJECT_TYPE_3GPP2_CMF = 0xA2, /* 3GPP2 Compact Multimedia Format (CMF) */
2573 MP4SYS_OBJECT_TYPE_VC_1_VIDEO = 0xA3, /* SMPTE VC-1 Video */
2574 MP4SYS_OBJECT_TYPE_DRAC_VIDEO = 0xA4, /* Dirac Video Coder */
2575 MP4SYS_OBJECT_TYPE_AC_3_AUDIO = 0xA5, /* AC-3 Audio */
2576 MP4SYS_OBJECT_TYPE_EC_3_AUDIO = 0xA6, /* Enhanced AC-3 audio */
2577 MP4SYS_OBJECT_TYPE_DRA1_AUDIO = 0xA7, /* DRA Audio */
2578 MP4SYS_OBJECT_TYPE_G719_AUDIO = 0xA8, /* ITU G.719 Audio */
2579 MP4SYS_OBJECT_TYPE_DTSC_AUDIO = 0xA9, /* DTS Coherent Acoustics audio */
2580 MP4SYS_OBJECT_TYPE_DTSH_AUDIO = 0xAA, /* DTS-HD High Resolution Audio */
2581 MP4SYS_OBJECT_TYPE_DTSL_AUDIO = 0xAB, /* DTS-HD Master Audio */
2582 MP4SYS_OBJECT_TYPE_DTSE_AUDIO = 0xAC, /* DTS Express low bit rate audio, also known as DTS LBR */
2583 MP4SYS_OBJECT_TYPE_SQCP_AUDIO = 0xE1, /* 13K Voice */
2585 MP4SYS_OBJECT_TYPE_NONE = 0xFF, /* no object type specified
2586 * Streams with this value with a StreamType indicating a systems stream (values 1,2,3,6,7,8,9)
2587 * shall be treated as if the ObjectTypeIndication had been set to 0x01. */
2588 } lsmash_mp4sys_object_type_indication;
2590 /* streamType */
2591 typedef enum
2593 MP4SYS_STREAM_TYPE_Forbidden = 0x00, /* Forbidden */
2594 MP4SYS_STREAM_TYPE_ObjectDescriptorStream = 0x01, /* ObjectDescriptorStream */
2595 MP4SYS_STREAM_TYPE_ClockReferenceStream = 0x02, /* ClockReferenceStream */
2596 MP4SYS_STREAM_TYPE_SceneDescriptionStream = 0x03, /* SceneDescriptionStream */
2597 MP4SYS_STREAM_TYPE_VisualStream = 0x04, /* VisualStream */
2598 MP4SYS_STREAM_TYPE_AudioStream = 0x05, /* AudioStream */
2599 MP4SYS_STREAM_TYPE_MPEG7Stream = 0x06, /* MPEG7Stream */
2600 MP4SYS_STREAM_TYPE_IPMPStream = 0x07, /* IPMPStream */
2601 MP4SYS_STREAM_TYPE_ObjectContentInfoStream = 0x08, /* ObjectContentInfoStream */
2602 MP4SYS_STREAM_TYPE_MPEGJStream = 0x09, /* MPEGJStream */
2603 MP4SYS_STREAM_TYPE_InteractionStream = 0x0A, /* Interaction Stream */
2604 MP4SYS_STREAM_TYPE_IPMPToolStream = 0x0B, /* IPMPToolStream */
2605 MP4SYS_STREAM_TYPE_FontDataStream = 0x0C, /* FontDataStream */
2606 MP4SYS_STREAM_TYPE_StreamingText = 0x0D, /* StreamingText */
2607 } lsmash_mp4sys_stream_type;
2609 /* MPEG-4 Systems Decoder Specific Information
2610 * an opaque container with information for a specific media decoder
2611 * The existence and semantics of decoder specific information depends on the values of streamType and objectTypeIndication. */
2612 typedef struct lsmash_mp4sys_decoder_specific_info_tag lsmash_mp4sys_decoder_specific_info_t;
2614 /* Note: bufferSizeDB, maxBitrate and avgBitrate are calculated internally when calling lsmash_finish_movie().
2615 * You need not to set up them manually when muxing streams by L-SMASH. */
2616 typedef struct
2618 lsmash_mp4sys_object_type_indication objectTypeIndication;
2619 lsmash_mp4sys_stream_type streamType;
2620 uint32_t bufferSizeDB; /* the size of the decoding buffer for this elementary stream in byte */
2621 uint32_t maxBitrate; /* the maximum bitrate in bits per second of the elementary stream in
2622 * any time window of one second duration */
2623 uint32_t avgBitrate; /* the average bitrate in bits per second of the elementary stream
2624 * Set to 0 if the stream is encoded as variable bitrate. */
2625 lsmash_mp4sys_decoder_specific_info_t *dsi; /* zero or one decoder specific information */
2626 } lsmash_mp4sys_decoder_parameters_t;
2628 int lsmash_set_mp4sys_decoder_specific_info
2630 lsmash_mp4sys_decoder_parameters_t *param,
2631 uint8_t *payload,
2632 uint32_t payload_length
2635 void lsmash_destroy_mp4sys_decoder_specific_info
2637 lsmash_mp4sys_decoder_parameters_t *param
2640 uint8_t *lsmash_create_mp4sys_decoder_config
2642 lsmash_mp4sys_decoder_parameters_t *param,
2643 uint32_t *data_length
2646 /* Return MP4SYS_OBJECT_TYPE_Forbidden if objectTypeIndication is not found or there is an error to find it. */
2647 lsmash_mp4sys_object_type_indication lsmash_mp4sys_get_object_type_indication
2649 lsmash_summary_t *summary
2652 /* Return -1 if any error.
2653 * Even if the decoder specific information is not found, it is not an error since no decoder specific information is allowed for some stream formats. */
2654 int lsmash_get_mp4sys_decoder_specific_info
2656 lsmash_mp4sys_decoder_parameters_t *param,
2657 uint8_t **payload,
2658 uint32_t *payload_length
2661 /* AC-3 Specific Information
2662 * Mandatory :
2663 * ISOM_CODEC_TYPE_AC_3_AUDIO
2665 * Unlike MPEG-4 Audio formats, the decoder does not require this for the initialization.
2666 * Each AC-3 sample is self-contained.
2667 * Users shall set the actual sample rate to 'frequency', which is a member of lsmash_audio_summary_t. */
2668 typedef struct
2670 uint8_t fscod; /* the same value as the fscod field in the AC-3 bitstream */
2671 uint8_t bsid; /* the same value as the bsid field in the AC-3 bitstream */
2672 uint8_t bsmod; /* the same value as the bsmod field in the AC-3 bitstream */
2673 uint8_t acmod; /* the same value as the acmod field in the AC-3 bitstream */
2674 uint8_t lfeon; /* the same value as the lfeon field in the AC-3 bitstream */
2675 uint8_t frmsizecod; /* the same value as the frmsizecod field in the AC-3 bitstream */
2676 } lsmash_ac3_specific_parameters_t;
2678 int lsmash_setup_ac3_specific_parameters_from_syncframe
2680 lsmash_ac3_specific_parameters_t *param,
2681 uint8_t *data,
2682 uint32_t data_length
2685 uint8_t *lsmash_create_ac3_specific_info
2687 lsmash_ac3_specific_parameters_t *param,
2688 uint32_t *data_length
2691 /* Enhanced AC-3 Specific Information
2692 * Mandatory :
2693 * ISOM_CODEC_TYPE_EC_3_AUDIO
2695 * Unlike MPEG-4 Audio formats, the decoder does not require this for the initialization.
2696 * Each Enhanced AC-3 sample is self-contained.
2697 * Note that this cannot document reduced sample rates (24000, 22050 or 16000 Hz).
2698 * Therefore, users shall set the actual sample rate to 'frequency', which is a member of lsmash_audio_summary_t. */
2699 typedef struct
2701 uint8_t fscod; /* the same value as the fscod field in the independent substream */
2702 uint8_t fscod2; /* deprecated: Any user must not use this. */
2703 uint8_t bsid; /* the same value as the bsid field in the independent substream */
2704 uint8_t bsmod; /* the same value as the bsmod field in the independent substream
2705 * If the bsmod field is not present in the independent substream, this field shall be set to 0. */
2706 uint8_t acmod; /* the same value as the acmod field in the independent substream */
2707 uint8_t lfeon; /* the same value as the lfeon field in the independent substream */
2708 uint8_t num_dep_sub; /* the number of dependent substreams that are associated with the independent substream */
2709 uint16_t chan_loc; /* channel locations of dependent substreams associated with the independent substream
2710 * This information is extracted from the chanmap field of each dependent substream. */
2711 } lsmash_eac3_substream_info_t;
2713 typedef struct
2715 uint16_t data_rate; /* the data rate of the Enhanced AC-3 bitstream in kbit/s
2716 * If the Enhanced AC-3 stream is variable bitrate, then this value indicates the maximum data rate of the stream. */
2717 uint8_t num_ind_sub; /* the number of independent substreams that are present in the Enhanced AC-3 bitstream
2718 * The value of this field is one less than the number of independent substreams present
2719 * and shall be in the range of 0 to 7, inclusive. */
2720 lsmash_eac3_substream_info_t independent_info[8];
2721 } lsmash_eac3_specific_parameters_t;
2723 int lsmash_setup_eac3_specific_parameters_from_frame
2725 lsmash_eac3_specific_parameters_t *param,
2726 uint8_t *data,
2727 uint32_t data_length
2730 uint16_t lsmash_eac3_get_chan_loc_from_chanmap
2732 uint16_t chanmap
2735 uint8_t *lsmash_create_eac3_specific_info
2737 lsmash_eac3_specific_parameters_t *param,
2738 uint32_t *data_length
2741 /* DTS Audio Specific Information
2742 * Mandatory :
2743 * ISOM_CODEC_TYPE_DTSC_AUDIO
2744 * ISOM_CODEC_TYPE_DTSH_AUDIO
2745 * ISOM_CODEC_TYPE_DTSL_AUDIO
2746 * ISOM_CODEC_TYPE_DTSE_AUDIO
2748 * Unlike MPEG-4 Audio formats, the decoder does not require this for the initialization.
2749 * Each DTS Audio sample is self-contained. */
2750 typedef enum
2752 DTS_CORE_SUBSTREAM_CORE_FLAG = 0x00000001,
2753 DTS_CORE_SUBSTREAM_XXCH_FLAG = 0x00000002,
2754 DTS_CORE_SUBSTREAM_X96_FLAG = 0x00000004,
2755 DTS_CORE_SUBSTREAM_XCH_FLAG = 0x00000008,
2756 DTS_EXT_SUBSTREAM_CORE_FLAG = 0x00000010,
2757 DTS_EXT_SUBSTREAM_XBR_FLAG = 0x00000020,
2758 DTS_EXT_SUBSTREAM_XXCH_FLAG = 0x00000040,
2759 DTS_EXT_SUBSTREAM_X96_FLAG = 0x00000080,
2760 DTS_EXT_SUBSTREAM_LBR_FLAG = 0x00000100,
2761 DTS_EXT_SUBSTREAM_XLL_FLAG = 0x00000200,
2762 } lsmash_dts_construction_flag;
2764 typedef struct lsmash_dts_reserved_box_tag lsmash_dts_reserved_box_t;
2766 typedef struct
2768 uint32_t DTSSamplingFrequency; /* the maximum sampling frequency stored in the compressed audio stream
2769 * 'frequency', which is a member of lsmash_audio_summary_t, shall be set according to DTSSamplingFrequency of either:
2770 * 48000 for original sampling frequencies of 24000Hz, 48000Hz, 96000Hz or 192000Hz;
2771 * 44100 for original sampling frequencies of 22050Hz, 44100Hz, 88200Hz or 176400Hz;
2772 * 32000 for original sampling frequencies of 16000Hz, 32000Hz, 64000Hz or 128000Hz. */
2773 uint32_t maxBitrate; /* the peak bit rate, in bits per second, of the audio elementary stream for the duration of the track,
2774 * including the core substream (if present) and all extension substreams.
2775 * If the stream is a constant bit rate, this parameter shall have the same value as avgBitrate.
2776 * If the maximum bit rate is unknown, this parameter shall be set to 0. */
2777 uint32_t avgBitrate; /* the average bit rate, in bits per second, of the audio elementary stream for the duration of the track,
2778 * including the core substream and any extension substream that may be present. */
2779 uint8_t pcmSampleDepth; /* the bit depth of the rendered audio
2780 * The value is 16 or 24 bits. */
2781 uint8_t FrameDuration; /* the number of audio samples decoded in a complete audio access unit at DTSSamplingFrequency
2782 * 0: 512, 1: 1024, 2: 2048, 3: 4096 */
2783 uint8_t StreamConstruction; /* complete information on the existence and of location of extensions in any synchronized frame */
2784 uint8_t CoreLFEPresent; /* the presence of an LFE channel in the core
2785 * 0: none
2786 * 1: LFE exists */
2787 uint8_t CoreLayout; /* the channel layout of the core within the core substream
2788 * If no core substream exists, this parameter shall be ignored and ChannelLayout or
2789 * RepresentationType shall be used to determine channel configuration. */
2790 uint16_t CoreSize; /* The size of a core substream AU in bytes.
2791 * If no core substream exists, CoreSize = 0. */
2792 uint8_t StereoDownmix; /* the presence of an embedded stereo downmix in the stream
2793 * 0: none
2794 * 1: embedded downmix present */
2795 uint8_t RepresentationType; /* This indicates special properties of the audio presentation.
2796 * 0: Audio asset designated for mixing with another audio asset
2797 * 2: Lt/Rt Encoded for matrix surround decoding
2798 * 3: Audio processed for headphone playback
2799 * otherwise: Reserved
2800 * If ChannelLayout != 0, this value shall be ignored. */
2801 uint16_t ChannelLayout; /* complete information on channels coded in the audio stream including core and extensions */
2802 uint8_t MultiAssetFlag; /* This flag shall set if the stream contains more than one asset.
2803 * 0: single asset
2804 * 1: multiple asset
2805 * When multiple assets exist, the remaining parameters only reflect the coding parameters of the first asset. */
2806 uint8_t LBRDurationMod; /* This flag indicates a special case of the LBR coding bandwidth, resulting in 1/3 or 2/3 band limiting.
2807 * If set to 1, LBR frame duration is 50 % larger than indicated in FrameDuration */
2808 lsmash_dts_reserved_box_t *box;
2809 } lsmash_dts_specific_parameters_t;
2811 int lsmash_setup_dts_specific_parameters_from_frame
2813 lsmash_dts_specific_parameters_t *param,
2814 uint8_t *data,
2815 uint32_t data_length
2818 uint8_t lsmash_dts_get_stream_construction
2820 lsmash_dts_construction_flag flags
2823 lsmash_dts_construction_flag lsmash_dts_get_construction_flags
2825 uint8_t stream_construction
2828 lsmash_codec_type_t lsmash_dts_get_codingname
2830 lsmash_dts_specific_parameters_t *param
2833 uint8_t *lsmash_create_dts_specific_info
2835 lsmash_dts_specific_parameters_t *param,
2836 uint32_t *data_length
2839 int lsmash_append_dts_reserved_box
2841 lsmash_dts_specific_parameters_t *param,
2842 uint8_t *box_data,
2843 uint32_t box_size
2846 void lsmash_remove_dts_reserved_box
2848 lsmash_dts_specific_parameters_t *param
2851 /* Apple Lossless Audio Specific Information
2852 * Mandatory :
2853 * ISOM_CODEC_TYPE_ALAC_AUDIO
2854 * QT_CODEC_TYPE_ALAC_AUDIO */
2855 typedef struct
2857 uint32_t frameLength; /* the frames per packet when no explicit frames per packet setting is present in the packet header
2858 * The encoder frames per packet can be explicitly set but for maximum compatibility,
2859 * the default encoder setting of 4096 should be used. */
2860 uint8_t bitDepth; /* the bit depth of the source PCM data (maximum value = 32) */
2861 uint8_t numChannels; /* the channel count (1 = mono, 2 = stereo, etc...)
2862 * When channel layout info is not provided in the Channel Layout extension,
2863 * a channel count > 2 describes a set of discreet channels with no specific ordering. */
2864 uint32_t maxFrameBytes; /* the maximum size of an Apple Lossless packet within the encoded stream
2865 * Value of 0 indicates unknown. */
2866 uint32_t avgBitrate; /* the average bit rate in bits per second of the Apple Lossless stream
2867 * Value of 0 indicates unknown. */
2868 uint32_t sampleRate; /* sample rate of the encoded stream */
2869 } lsmash_alac_specific_parameters_t;
2871 uint8_t *lsmash_create_alac_specific_info
2873 lsmash_alac_specific_parameters_t *param,
2874 uint32_t *data_length
2877 /* MPEG-4 Bitrate Information.
2878 * Optional :
2879 * ISOM_CODEC_TYPE_AVC1_VIDEO
2880 * ISOM_CODEC_TYPE_AVC2_VIDEO
2881 * ISOM_CODEC_TYPE_AVC3_VIDEO
2882 * ISOM_CODEC_TYPE_AVC4_VIDEO
2883 * ISOM_CODEC_TYPE_HVC1_VIDEO
2884 * ISOM_CODEC_TYPE_HEV1_VIDEO
2886 * Though you need not to set these fields manually since lsmash_finish_movie() calls the function
2887 * that calculates these values internally, these fields are optional.
2888 * Therefore, if you want to add this info, append this as an extension via LSMASH_CODEC_SPECIFIC_DATA_TYPE_ISOM_VIDEO_H264_BITRATE at least. */
2889 typedef struct
2891 uint32_t bufferSizeDB; /* the size of the decoding buffer for the elementary stream in bytes */
2892 uint32_t maxBitrate; /* the maximum rate in bits/second over any window of one second */
2893 uint32_t avgBitrate; /* the average rate in bits/second over the entire presentation */
2894 } lsmash_h264_bitrate_t;
2896 /* Appendability of NAL unit into Decoder Configuration Record */
2897 typedef enum
2899 DCR_NALU_APPEND_NEW_SAMPLE_ENTRY_REQUIRED = -3, /* A new sample description entry is needed because e.g. visual presentation size changes. */
2900 DCR_NALU_APPEND_NEW_DCR_REQUIRED = -2, /* A new Decoder Configuration Record is needed. */
2901 DCR_NALU_APPEND_ERROR = -1, /* something of errors */
2902 DCR_NALU_APPEND_DUPLICATED = 0, /* The same NAL unit is in the Decoder Configuration Record. */
2903 DCR_NALU_APPEND_POSSIBLE = 1, /* It is possible to append the NAL unit into the Decoder Configuration Record. */
2904 } lsmash_dcr_nalu_appendable;
2906 /* H.264/AVC Specific Information
2907 * Mandatory :
2908 * ISOM_CODEC_TYPE_AVC1_VIDEO
2909 * ISOM_CODEC_TYPE_AVC2_VIDEO
2910 * ISOM_CODEC_TYPE_AVC3_VIDEO
2911 * ISOM_CODEC_TYPE_AVC4_VIDEO
2913 * All members in lsmash_h264_specific_parameters_t except for lengthSizeMinusOne shall be automatically set up
2914 * when appending SPS NAL units by calling lsmash_append_h264_parameter_set(). */
2915 typedef enum
2917 H264_PARAMETER_SET_TYPE_SPS = 0, /* SPS (Sequence Parameter Set) */
2918 H264_PARAMETER_SET_TYPE_PPS = 1, /* PPS (Picture Parameter Set) */
2919 H264_PARAMETER_SET_TYPE_SPSEXT = 2, /* SPS Ext (Sequence Parameter Set Extension) */
2920 /* The number of the NAL unit types defined for AVC Decoder Configuration Record */
2921 H264_PARAMETER_SET_TYPE_NUM
2922 } lsmash_h264_parameter_set_type;
2924 typedef struct lsmash_h264_parameter_sets_tag lsmash_h264_parameter_sets_t;
2926 typedef struct
2928 uint8_t AVCProfileIndication; /* profile_idc in sequence parameter sets
2929 * This field must indicate a profile to which the stream associated with
2930 * this configuration record conforms.
2931 * Note: there is no profile to which the entire stream conforms, then
2932 * the entire stream must be split into two or more sub-streams with
2933 * separate configuration records in which these rules can be met. */
2934 uint8_t profile_compatibility; /* constraint_set_flags in sequence parameter sets
2935 * The each bit may only be set if all the included parameter sets set that flag. */
2936 uint8_t AVCLevelIndication; /* level_idc in sequence parameter sets
2937 * This field must indicate a level of capability equal to or greater than
2938 * the highest level indicated in the included parameter sets. */
2939 uint8_t lengthSizeMinusOne; /* the length in bytes of the NALUnitLength field prior to NAL unit
2940 * The value of this field shall be one of 0, 1, or 3
2941 * corresponding to a length encoded with 1, 2, or 4 bytes, respectively.
2942 * NALUnitLength indicates the size of a NAL unit measured in bytes,
2943 * and includes the size of both the one byte NAL header and the EBSP payload
2944 * but does not include the length field itself. */
2945 /* chroma format and bit depth information
2946 * These fields must be identical in all the parameter sets. */
2947 uint8_t chroma_format; /* chroma_format_idc in sequence parameter sets */
2948 uint8_t bit_depth_luma_minus8; /* bit_depth_luma_minus8 in sequence parameter sets */
2949 uint8_t bit_depth_chroma_minus8; /* bit_depth_chroma_minus8 in sequence parameter sets */
2950 /* a set of arrays to carry initialization NAL units
2951 * The NAL unit types are restricted to indicate SPS, PPS and SPS Ext NAL units only. */
2952 lsmash_h264_parameter_sets_t *parameter_sets;
2953 } lsmash_h264_specific_parameters_t;
2955 int lsmash_setup_h264_specific_parameters_from_access_unit
2957 lsmash_h264_specific_parameters_t *param,
2958 uint8_t *data,
2959 uint32_t data_length
2962 void lsmash_destroy_h264_parameter_sets
2964 lsmash_h264_specific_parameters_t *param
2967 lsmash_dcr_nalu_appendable lsmash_check_h264_parameter_set_appendable
2969 lsmash_h264_specific_parameters_t *param,
2970 lsmash_h264_parameter_set_type ps_type,
2971 void *ps_data,
2972 uint32_t ps_length
2975 int lsmash_append_h264_parameter_set
2977 lsmash_h264_specific_parameters_t *param,
2978 lsmash_h264_parameter_set_type ps_type,
2979 void *ps_data,
2980 uint32_t ps_length
2983 uint8_t *lsmash_create_h264_specific_info
2985 lsmash_h264_specific_parameters_t *param,
2986 uint32_t *data_length
2989 /* H.265/HEVC Specific Information
2990 * Mandatory :
2991 * ISOM_CODEC_TYPE_HVC1_VIDEO
2992 * ISOM_CODEC_TYPE_HEV1_VIDEO
2994 * All members in lsmash_hevc_specific_parameters_t except for avgFrameRate and lengthSizeMinusOne shall be
2995 * automatically set up when appending VPS and SPS NAL units by calling lsmash_append_hevc_dcr_nalu().
2996 * It is recommended that you should append VPS, SPS and PPS in this order so that a parameter set can reference
2997 * another parameter set. */
2998 typedef enum
3000 /* Parameter sets
3001 * When the CODEC identifier ISOM_CODEC_TYPE_HVC1_VIDEO is used, at least one parameter set for each array
3002 * of parameter set shall be in the configuration record. */
3003 HEVC_DCR_NALU_TYPE_VPS = 0, /* VPS (Video Parameter Set) */
3004 HEVC_DCR_NALU_TYPE_SPS = 1, /* SPS (Sequence Parameter Set) */
3005 HEVC_DCR_NALU_TYPE_PPS = 2, /* PPS (Picture Parameter Set) */
3006 /* SEI (Supplemental Enhancement Information)
3007 * Only the 'declarative' SEI messages that provide information about the stream as
3008 * a whole are allowed because SEIs themselves basically have no identifier and
3009 * no one can reference dynamically in a configuration record. */
3010 HEVC_DCR_NALU_TYPE_PREFIX_SEI = 3, /* Prefix SEI */
3011 HEVC_DCR_NALU_TYPE_SUFFIX_SEI = 4, /* Suffix SEI */
3012 /* The number of the NAL unit types defined for HEVC Decoder Configuration Record */
3013 HEVC_DCR_NALU_TYPE_NUM
3014 } lsmash_hevc_dcr_nalu_type;
3016 typedef struct lsmash_hevc_parameter_arrays_tag lsmash_hevc_parameter_arrays_t;
3018 typedef struct
3020 /* general profile, tier and level from VPS and/or SPS */
3021 uint8_t general_profile_space; /* general_profile_space
3022 * The value in all the parameter sets must be identical. */
3023 uint8_t general_tier_flag; /* general_tier_flag
3024 * The value must indicate a tier equal to or greater than the highest
3025 * tier indicated in all the parameter sets. */
3026 uint8_t general_profile_idc; /* general_profile_idc
3027 * The value must indicate a profile to which the stream associated with
3028 * this configuration record conforms.
3029 * Note: there is no profile to which the entire stream conforms, then
3030 * the entire stream must be split into two or more sub-streams with
3031 * separate configuration records in which these rules can be met. */
3032 uint32_t general_profile_compatibility_flags; /* general_profile_compatibility_flag[j] for j from 0 to 31
3033 * The each bit may only be set if all the parameter sets set that bit. */
3034 uint64_t general_constraint_indicator_flags; /* the 6 bytes starting with the byte containing the general_progressive_source_flag
3035 * The each bit may only be set if all the parameter sets set that bit. */
3036 uint8_t general_level_idc; /* general_level_idc
3037 * The value must indicate a level of capability equal to or greater
3038 * than the highest level indicated for the highest tier in all the
3039 * parameter sets. */
3040 /* */
3041 uint16_t min_spatial_segmentation_idc; /* min_spatial_segmentation_idc in VUI (Video Usability Information)
3042 * The value must indicate a level of spatial segmentation equal to
3043 * or less than the lowest level of spatial segmentation indicated in
3044 * all the parameter sets. */
3045 uint8_t parallelismType; /* parallelismType indicates the type of parallelism that is used to meet the
3046 * restrictions imposed by min_spatial_segmentation_idc when the value of
3047 * min_spatial_segmentation_idc is greater than 0.
3048 * For the stream to which this configuration record applies,
3049 * 0: mixed types of parallel decoding or parallelism type is unknown
3050 * 1: slice based parallel decoding
3051 * 2: tile based parallel decoding
3052 * 3: entropy coding synchronization based parallel decoding
3053 * (WPP: Wavefront Parallel Processing) */
3054 /* chroma format and bit depth information
3055 * These fields must be identical in all the parameter sets. */
3056 uint8_t chromaFormat; /* chroma_format_idc in sequence parameter sets */
3057 uint8_t bitDepthLumaMinus8; /* bit_depth_luma_minus8 in sequence parameter sets */
3058 uint8_t bitDepthChromaMinus8; /* bit_depth_chroma_minus8 in sequence parameter sets */
3059 /* miscellaneous */
3060 uint16_t avgFrameRate; /* the average frame rate in units of frames/(256 seconds)
3061 * Value 0 indicates an unspecified average frame rate. */
3062 uint8_t constantFrameRate; /* 0: the stream may or may not be of constant frame rate.
3063 * 1: that the stream to which this configuration record applies is of
3064 * constant frame rate
3065 * 2: the representation of each temporal layer in the stream is of
3066 * constant frame rate. */
3067 uint8_t numTemporalLayers; /* 0: it is unknown whether the stream is temporally scalable.
3068 * 1: the stream is not temporally scalable.
3069 * otherwise: the stream to which this configuration record applies is
3070 * temporally scalable and the contained number of temporal layers
3071 * (also referred to as temporal sublayer or sub-layer) is equal
3072 * is equal to numTemporalLayers. */
3073 uint8_t temporalIdNested; /* 0: at least one of the SPSs that are activated when the stream to which
3074 * this configuration record applies is decoded has sps_temporal_id_nesting_flag
3075 * equal to 0.
3076 * 1: all SPSs that are activated when the stream to which this configuration
3077 * record applies is decoded have sps_temporal_id_nesting_flag equal to 1
3078 * and temporal sub-layer up-switching to any higher temporal layer can be
3079 * performed at any sample.
3080 * Any step-wise temporal sub-layer access picture shall not be present in
3081 * the sequences to which this configuration record applies. */
3082 uint8_t lengthSizeMinusOne; /* the length in bytes of the NALUnitLength field prior to NAL unit
3083 * The value of this field shall be one of 0, 1, or 3
3084 * corresponding to a length encoded with 1, 2, or 4 bytes, respectively.
3085 * NALUnitLength indicates the size of a NAL unit measured in bytes,
3086 * and includes the size of both the one byte NAL header and the EBSP payload
3087 * but does not include the length field itself. */
3088 /* a set of arrays to carry initialization NAL units
3089 * The NAL unit types are restricted to indicate VPS, SPS, PPS, and SEI NAL units only. */
3090 lsmash_hevc_parameter_arrays_t *parameter_arrays;
3091 } lsmash_hevc_specific_parameters_t;
3093 int lsmash_setup_hevc_specific_parameters_from_access_unit
3095 lsmash_hevc_specific_parameters_t *param,
3096 uint8_t *data,
3097 uint32_t data_length
3100 void lsmash_destroy_hevc_parameter_arrays
3102 lsmash_hevc_specific_parameters_t *param
3105 lsmash_dcr_nalu_appendable lsmash_check_hevc_dcr_nalu_appendable
3107 lsmash_hevc_specific_parameters_t *param,
3108 lsmash_hevc_dcr_nalu_type ps_type,
3109 void *ps_data,
3110 uint32_t ps_length
3113 int lsmash_append_hevc_dcr_nalu
3115 lsmash_hevc_specific_parameters_t *param,
3116 lsmash_hevc_dcr_nalu_type ps_type,
3117 void *ps_data,
3118 uint32_t ps_length
3121 int lsmash_set_hevc_array_completeness
3123 lsmash_hevc_specific_parameters_t *param,
3124 lsmash_hevc_dcr_nalu_type ps_type,
3125 int array_completeness
3128 int lsmash_get_hevc_array_completeness
3130 lsmash_hevc_specific_parameters_t *param,
3131 lsmash_hevc_dcr_nalu_type ps_type,
3132 int *array_completeness
3135 uint8_t *lsmash_create_hevc_specific_info
3137 lsmash_hevc_specific_parameters_t *param,
3138 uint32_t *data_length
3141 /* VC-1 Specific Information
3142 * Mandatory :
3143 * ISOM_CODEC_TYPE_VC_1_VIDEO
3145 * We support only advanced profile at present. */
3146 typedef struct lsmash_vc1_header_tag lsmash_vc1_header_t;
3148 typedef struct
3150 /* Note: multiple_sequence, multiple_entry, slice_present and bframe_present shall be decided through overall VC-1 bitstream. */
3151 uint8_t profile; /* the encoding profile used in the VC-1 bitstream
3152 * 0: simple profile (not supported)
3153 * 4: main profile (not supported)
3154 * 12: advanced profile
3155 * Currently, only 12 for advanced profile is available. */
3156 uint8_t level; /* the highest encoding level used in the VC-1 bitstream */
3157 uint8_t cbr; /* 0: non-constant bitrate model
3158 * 1: constant bitrate model */
3159 uint8_t interlaced; /* 0: interlaced coding of frames is not used.
3160 * 1: frames may use interlaced coding. */
3161 uint8_t multiple_sequence; /* 0: the track contains no sequence headers (stored only in VC-1 specific info structure),
3162 * or
3163 * all sequence headers in the track are identical to the sequence header that is specified in the seqhdr field.
3164 * In this case, random access points are samples that contain an entry-point header.
3165 * 1: the track may contain Sequence headers that are different from the sequence header specified in the seqhdr field.
3166 * In this case, random access points are samples that contain both a sequence Header and an entry-point header. */
3167 uint8_t multiple_entry; /* 0: all entry-point headers in the track are identical to the entry-point header that is specified in the ephdr field.
3168 * 1: the track may contain entry-point headers that are different from the entry-point header specified in the ephdr field. */
3169 uint8_t slice_present; /* 0: frames are not coded as multiple slices.
3170 * 1: frames may be coded as multiple slices. */
3171 uint8_t bframe_present; /* 0: neither B-frames nor BI-frames are present in the track.
3172 * 1: B-frames or BI-frames may be present in the track. */
3173 uint32_t framerate; /* the rounded frame rate (frames per second) of the track
3174 * Should be set to 0xffffffff if the frame rate is not known, unspecified, or non-constant. */
3175 lsmash_vc1_header_t *seqhdr; /* a sequence header EBDU (mandatory) */
3176 lsmash_vc1_header_t *ephdr; /* an entry-point header EBDU (mandatory) */
3177 } lsmash_vc1_specific_parameters_t;
3179 int lsmash_setup_vc1_specific_parameters_from_access_unit
3181 lsmash_vc1_specific_parameters_t *param,
3182 uint8_t *data,
3183 uint32_t data_length
3186 void lsmash_destroy_vc1_headers
3188 lsmash_vc1_specific_parameters_t *param
3191 int lsmash_put_vc1_header
3193 lsmash_vc1_specific_parameters_t *param,
3194 void *hdr_data,
3195 uint32_t hdr_length
3198 uint8_t *lsmash_create_vc1_specific_info
3200 lsmash_vc1_specific_parameters_t *param,
3201 uint32_t *data_length
3204 /* Sample scaling
3205 * Without this extension, video samples are scaled into the visual presentation region to fill it. */
3206 typedef enum
3208 ISOM_SCALE_METHOD_FILL = 1,
3209 ISOM_SCALE_METHOD_HIDDEN = 2,
3210 ISOM_SCALE_METHOD_MEET = 3,
3211 ISOM_SCALE_METHOD_SLICE_X = 4,
3212 ISOM_SCALE_METHOD_SLICE_Y = 5,
3213 } lsmash_scale_method;
3215 typedef struct
3217 uint8_t constraint_flag; /* Upper 7-bits are reserved.
3218 * If this flag is set, all samples described by this sample entry shall be scaled
3219 * according to the method specified by the field 'scale_method'. */
3220 lsmash_scale_method scale_method; /* The semantics of the values for scale_method are as specified for the 'fit' attribute of regions in SMIL 1.0. */
3221 int16_t display_center_x;
3222 int16_t display_center_y;
3223 } lsmash_isom_sample_scale_t;
3225 /* QuickTime Video CODEC tools */
3226 typedef enum
3228 QT_COMPRESSION_QUALITY_LOSSLESS = 0x00000400, /* only valid for spatial compression */
3229 QT_COMPRESSION_QUALITY_MAX = 0x000003FF,
3230 QT_COMPRESSION_QUALITY_MIN = 0x00000000,
3231 QT_COMPRESSION_QUALITY_LOW = 0x00000100,
3232 QT_COMPRESSION_QUALITY_NORMAL = 0x00000200,
3233 QT_COMPRESSION_QUALITY_HIGH = 0x00000300
3234 } lsmash_qt_compression_quality;
3236 typedef struct
3238 uint32_t seed; /* Must be set to 0. */
3239 uint16_t flags; /* Must be set to 0x8000. */
3240 uint16_t size; /* the number of colors in the following color array
3241 * This is a zero-relative value;
3242 * setting this field to 0 means that there is one color in the array. */
3243 /* Color array
3244 * An array of colors. Each color is made of four unsigned 16-bit integers.
3245 * We support up to 256 elements. */
3246 struct
3248 uint16_t unused; /* Must be set to 0. */
3249 /* true color */
3250 uint16_t r; /* magnitude of red component */
3251 uint16_t g; /* magnitude of green component */
3252 uint16_t b; /* magnitude of blue component */
3253 } array[256];
3254 } lsmash_qt_color_table_t;
3256 typedef struct
3258 int16_t revision_level; /* version of the CODEC */
3259 int32_t vendor; /* whose CODEC */
3260 lsmash_qt_compression_quality temporalQuality; /* the temporal quality factor (0-1023) */
3261 lsmash_qt_compression_quality spatialQuality; /* the spatial quality factor (0-1024) */
3262 uint32_t horizontal_resolution; /* a 16.16 fixed-point number containing the horizontal resolution of the image in pixels per inch. */
3263 uint32_t vertical_resolution; /* a 16.16 fixed-point number containing the vertical resolution of the image in pixels per inch. */
3264 uint32_t dataSize; /* if known, the size of data for this descriptor */
3265 uint16_t frame_count; /* frame per sample */
3266 int16_t color_table_ID; /* color table ID
3267 * If this field is set to -1, the default color table should be used for the specified depth
3268 * If the color table ID is set to 0, a color table is contained within the sample description itself.
3269 * The color table immediately follows the color table ID field. */
3270 lsmash_qt_color_table_t color_table; /* a list of preferred colors for displaying the movie on devices that support only 256 colors */
3271 } lsmash_qt_video_common_t;
3273 typedef struct
3275 uint32_t level; /* A fixed-point 16.16 number indicating the gamma level at which the image was captured. */
3276 } lsmash_qt_gamma_t;
3278 typedef enum
3280 QT_FIELEDS_SCAN_PROGRESSIVE = 1, /* progressive scan */
3281 QT_FIELEDS_SCAN_INTERLACED = 2, /* 2:1 interlaced */
3282 } lsmash_qt_number_of_fields;
3284 /* field ordering for interlaced material */
3285 typedef enum
3287 QT_FIELD_ORDERINGS_UNKNOWN = 0,
3288 QT_FIELD_ORDERINGS_TEMPORAL_TOP_FIRST = 1,
3289 QT_FIELD_ORDERINGS_TEMPORAL_BOTTOM_FIRST = 6,
3290 QT_FIELD_ORDERINGS_SPATIAL_FIRST_LINE_EARLY = 9,
3291 QT_FIELD_ORDERINGS_SPATIAL_FIRST_LINE_LATE = 14
3292 } lsmash_qt_field_orderings;
3294 typedef struct
3296 lsmash_qt_number_of_fields fields;
3297 lsmash_qt_field_orderings detail;
3298 } lsmash_qt_field_info_t;
3300 /* the native pixel format */
3301 typedef enum
3303 QT_PIXEL_FORMAT_TYPE_1_MONOCHROME = 0x00000001, /* 1 bit indexed */
3304 QT_PIXEL_FORMAT_TYPE_2_INDEXED = 0x00000002, /* 2 bit indexed */
3305 QT_PIXEL_FORMAT_TYPE_4_INDEXED = 0x00000004, /* 4 bit indexed */
3306 QT_PIXEL_FORMAT_TYPE_8_INDEXED = 0x00000008, /* 8 bit indexed */
3307 QT_PIXEL_FORMAT_TYPE_1_INDEXED_GRAY_WHITE_IS_ZERO = 0x00000021, /* 1 bit indexed gray, white is zero */
3308 QT_PIXEL_FORMAT_TYPE_2_INDEXED_GRAY_WHITE_IS_ZERO = 0x00000022, /* 2 bit indexed gray, white is zero */
3309 QT_PIXEL_FORMAT_TYPE_4_INDEXED_GRAY_WHITE_IS_ZERO = 0x00000024, /* 4 bit indexed gray, white is zero */
3310 QT_PIXEL_FORMAT_TYPE_8_INDEXED_GRAY_WHITE_IS_ZERO = 0x00000028, /* 8 bit indexed gray, white is zero */
3311 QT_PIXEL_FORMAT_TYPE_16BE555 = 0x00000010, /* 16 bit BE RGB 555 */
3312 QT_PIXEL_FORMAT_TYPE_16LE555 = LSMASH_4CC( 'L', '5', '5', '5' ), /* 16 bit LE RGB 555 */
3313 QT_PIXEL_FORMAT_TYPE_16LE5551 = LSMASH_4CC( '5', '5', '5', '1' ), /* 16 bit LE RGB 5551 */
3314 QT_PIXEL_FORMAT_TYPE_16BE565 = LSMASH_4CC( 'B', '5', '6', '5' ), /* 16 bit BE RGB 565 */
3315 QT_PIXEL_FORMAT_TYPE_16LE565 = LSMASH_4CC( 'L', '5', '6', '5' ), /* 16 bit LE RGB 565 */
3316 QT_PIXEL_FORMAT_TYPE_24RGB = 0x00000018, /* 24 bit RGB */
3317 QT_PIXEL_FORMAT_TYPE_24BGR = LSMASH_4CC( '2', '4', 'B', 'G' ), /* 24 bit BGR */
3318 QT_PIXEL_FORMAT_TYPE_32ARGB = 0x00000020, /* 32 bit ARGB */
3319 QT_PIXEL_FORMAT_TYPE_32BGRA = LSMASH_4CC( 'B', 'G', 'R', 'A' ), /* 32 bit BGRA */
3320 QT_PIXEL_FORMAT_TYPE_32ABGR = LSMASH_4CC( 'A', 'B', 'G', 'R' ), /* 32 bit ABGR */
3321 QT_PIXEL_FORMAT_TYPE_32RGBA = LSMASH_4CC( 'R', 'G', 'B', 'A' ), /* 32 bit RGBA */
3322 QT_PIXEL_FORMAT_TYPE_64ARGB = LSMASH_4CC( 'b', '6', '4', 'a' ), /* 64 bit ARGB, 16-bit big-endian samples */
3323 QT_PIXEL_FORMAT_TYPE_48RGB = LSMASH_4CC( 'b', '4', '8', 'r' ), /* 48 bit RGB, 16-bit big-endian samples */
3324 QT_PIXEL_FORMAT_TYPE_32_ALPHA_GRAY = LSMASH_4CC( 'b', '3', '2', 'a' ), /* 32 bit AlphaGray, 16-bit big-endian samples, black is zero */
3325 QT_PIXEL_FORMAT_TYPE_16_GRAY = LSMASH_4CC( 'b', '1', '6', 'g' ), /* 16 bit Grayscale, 16-bit big-endian samples, black is zero */
3326 QT_PIXEL_FORMAT_TYPE_30RGB = LSMASH_4CC( 'R', '1', '0', 'k' ), /* 30 bit RGB, 10-bit big-endian samples, 2 unused padding bits (at least significant end) */
3327 QT_PIXEL_FORMAT_TYPE_422YpCbCr8 = LSMASH_4CC( '2', 'v', 'u', 'y' ), /* Component Y'CbCr 8-bit 4:2:2, ordered Cb Y'0 Cr Y'1 */
3328 QT_PIXEL_FORMAT_TYPE_4444YpCbCrA8 = LSMASH_4CC( 'v', '4', '0', '8' ), /* Component Y'CbCrA 8-bit 4:4:4:4, ordered Cb Y' Cr A */
3329 QT_PIXEL_FORMAT_TYPE_4444YpCbCrA8R = LSMASH_4CC( 'r', '4', '0', '8' ), /* Component Y'CbCrA 8-bit 4:4:4:4, rendering format. full range alpha, zero biased YUV, ordered A Y' Cb Cr */
3330 QT_PIXEL_FORMAT_TYPE_4444AYpCbCr8 = LSMASH_4CC( 'y', '4', '0', '8' ), /* Component Y'CbCrA 8-bit 4:4:4:4, ordered A Y' Cb Cr, full range alpha, video range Y'CbCr */
3331 QT_PIXEL_FORMAT_TYPE_4444AYpCbCr16 = LSMASH_4CC( 'y', '4', '1', '6' ), /* Component Y'CbCrA 16-bit 4:4:4:4, ordered A Y' Cb Cr, full range alpha, video range Y'CbCr, 16-bit little-endian samples */
3332 QT_PIXEL_FORMAT_TYPE_444YpCbCr8 = LSMASH_4CC( 'v', '3', '0', '8' ), /* Component Y'CbCr 8-bit 4:4:4 */
3333 QT_PIXEL_FORMAT_TYPE_422YpCbCr16 = LSMASH_4CC( 'v', '2', '1', '6' ), /* Component Y'CbCr 10,12,14,16-bit 4:2:2 */
3334 QT_PIXEL_FORMAT_TYPE_422YpCbCr10 = LSMASH_4CC( 'v', '2', '1', '0' ), /* Component Y'CbCr 10-bit 4:2:2 */
3335 QT_PIXEL_FORMAT_TYPE_444YpCbCr10 = LSMASH_4CC( 'v', '4', '1', '0' ), /* Component Y'CbCr 10-bit 4:4:4 */
3336 QT_PIXEL_FORMAT_TYPE_420YpCbCr8_PLANAR = LSMASH_4CC( 'y', '4', '2', '0' ), /* Planar Component Y'CbCr 8-bit 4:2:0 */
3337 QT_PIXEL_FORMAT_TYPE_420YpCbCr8_PLANAR_FULL_RANGE = LSMASH_4CC( 'f', '4', '2', '0' ), /* Planar Component Y'CbCr 8-bit 4:2:0, full range */
3338 QT_PIXEL_FORMAT_TYPE_422YpCbCr_4A_8_BIPLANAR = LSMASH_4CC( 'a', '2', 'v', 'y' ), /* First plane: Video-range Component Y'CbCr 8-bit 4:2:2, ordered Cb Y'0 Cr Y'1; second plane: alpha 8-bit 0-255 */
3339 QT_PIXEL_FORMAT_TYPE_420YpCbCr8_BIPLANAR_VIDEO_RANGE = LSMASH_4CC( '4', '2', '0', 'v' ), /* Bi-Planar Component Y'CbCr 8-bit 4:2:0, video-range (luma=[16,235] chroma=[16,240]) */
3340 QT_PIXEL_FORMAT_TYPE_420YpCbCr8_BIPLANAR_FULL_RANGE = LSMASH_4CC( '4', '2', '0', 'f' ), /* Bi-Planar Component Y'CbCr 8-bit 4:2:0, full-range (luma=[0,255] chroma=[1,255]) */
3341 QT_PIXEL_FORMAT_TYPE_422YpCbCr8_YUVS = LSMASH_4CC( 'y', 'u', 'v', 's' ), /* Component Y'CbCr 8-bit 4:2:2, ordered Y'0 Cb Y'1 Cr */
3342 QT_PIXEL_FORMAT_TYPE_422YpCbCr8_FULL_RANGE = LSMASH_4CC( 'y', 'u', 'v', 'f' ), /* Component Y'CbCr 8-bit 4:2:2, full range, ordered Y'0 Cb Y'1 Cr */
3344 /* Developer specific FourCCs (from dispatch 20) */
3345 QT_PIXEL_FORMAT_TYPE_SOFTVOUT_SOFTCODEC = LSMASH_4CC( 's', 'o', 'f', 't' ), /* Intermediary pixel format used by SoftVout and SoftCodec */
3346 QT_PIXEL_FORMAT_TYPE_VIEW_GRAPHICS = LSMASH_4CC( 'v', 'w', 'g', 'r' ), /* Intermediary pixel format used by View Graphics */
3347 QT_PIXEL_FORMAT_TYPE_SGI = LSMASH_4CC( 'S', 'G', 'V', 'C' ), /* Intermediary pixel format used by SGI */
3348 } lsmash_qt_pixel_format;
3350 typedef struct
3352 lsmash_qt_pixel_format pixel_format; /* the native pixel format of an image */
3353 } lsmash_qt_pixel_format_t;
3355 /* Significant Bits Extension
3356 * mandatory extension for 'v216' (Uncompressed Y'CbCr, 10, 12, 14, or 16-bit-per-component 4:2:2) */
3357 typedef struct
3359 uint8_t significantBits; /* the number of significant bits per component */
3360 } lsmash_qt_significant_bits_t;
3362 /* QuickTime Audio CODEC tools */
3363 typedef enum
3365 QT_AUDIO_COMPRESSION_ID_NOT_COMPRESSED = 0,
3366 QT_AUDIO_COMPRESSION_ID_FIXED_COMPRESSION = -1,
3367 QT_AUDIO_COMPRESSION_ID_VARIABLE_COMPRESSION = -2,
3368 QT_AUDIO_COMPRESSION_ID_TWO_TO_ONE = 1,
3369 QT_AUDIO_COMPRESSION_ID_EIGHT_TO_THREE = 2,
3370 QT_AUDIO_COMPRESSION_ID_THREE_TO_ONE = 3,
3371 QT_AUDIO_COMPRESSION_ID_SIX_TO_ONE = 4,
3372 QT_AUDIO_COMPRESSION_ID_SIX_TO_ONE_PACKET_SIZE = 8,
3373 QT_AUDIO_COMPRESSION_ID_THREE_TO_ONE_PACKET_SIZE = 16,
3374 } lsmash_qt_audio_compression_id;
3376 typedef struct
3378 int16_t revision_level; /* version of the CODEC */
3379 int32_t vendor; /* whose CODEC */
3380 lsmash_qt_audio_compression_id compression_ID;
3381 } lsmash_qt_audio_common_t;
3383 /* Audio Channel Layout
3384 * This CODEC specific extension is for
3385 * QuickTime Audio inside QuickTime file format
3386 * and
3387 * Apple Lossless Audio inside ISO Base Media file format.
3388 * When audio stream has 3 or more number of channels, this extension shall be present. */
3389 typedef enum
3391 QT_CHANNEL_LABEL_UNKNOWN = (signed)0xffffffff, /* unknown or unspecified other use */
3392 QT_CHANNEL_LABEL_UNUSED = 0, /* channel is present, but has no intended use or destination */
3393 QT_CHANNEL_LABEL_USE_COORDINATES = 100, /* channel is described by the coordinates fields. */
3395 QT_CHANNEL_LABEL_LEFT = 1,
3396 QT_CHANNEL_LABEL_RIGHT = 2,
3397 QT_CHANNEL_LABEL_CENTER = 3,
3398 QT_CHANNEL_LABEL_LFE_SCREEN = 4,
3399 QT_CHANNEL_LABEL_LEFT_SURROUND = 5, /* WAVE: "Back Left" */
3400 QT_CHANNEL_LABEL_RIGHT_SUROUND = 6, /* WAVE: "Back Right" */
3401 QT_CHANNEL_LABEL_LEFT_CENTER = 7,
3402 QT_CHANNEL_LABEL_RIGHT_CENTER = 8,
3403 QT_CHANNEL_LABEL_CENTER_SURROUND = 9, /* WAVE: "Back Center" or plain "Rear Surround" */
3404 QT_CHANNEL_LABEL_LEFT_SURROUND_DIRECT = 10, /* WAVE: "Side Left" */
3405 QT_CHANNEL_LABEL_RIGHT_SURROUND_DIRECT = 11, /* WAVE: "Side Right" */
3406 QT_CHANNEL_LABEL_TOP_CENTER_SURROUND = 12,
3407 QT_CHANNEL_LABEL_VERTICAL_HEIGHT_LEFT = 13, /* WAVE: "Top Front Left" */
3408 QT_CHANNEL_LABEL_VERTICAL_HEIGHT_CENTER = 14, /* WAVE: "Top Front Center" */
3409 QT_CHANNEL_LABEL_VERTICAL_HEIGHT_RIGHT = 15, /* WAVE: "Top Front Right" */
3411 QT_CHANNEL_LABEL_TOP_BACK_LEFT = 16,
3412 QT_CHANNEL_LABEL_TOP_BACK_CENTER = 17,
3413 QT_CHANNEL_LABEL_TOP_BACK_RIGHT = 18,
3415 QT_CHANNEL_LABEL_REAR_SURROUND_LEFT = 33,
3416 QT_CHANNEL_LABEL_REAR_SURROUND_RIGHT = 34,
3417 QT_CHANNEL_LABEL_LEFT_WIDE = 35,
3418 QT_CHANNEL_LABEL_RIGHT_WIDE = 36,
3419 QT_CHANNEL_LABEL_LFE2 = 37,
3420 QT_CHANNEL_LABEL_LEFT_TOTAL = 38, /* matrix encoded 4 channels */
3421 QT_CHANNEL_LABEL_RIGHT_TOTAL = 39, /* matrix encoded 4 channels */
3422 QT_CHANNEL_LABEL_HEARING_IMPAIRED = 40,
3423 QT_CHANNEL_LABEL_NARRATION = 41,
3424 QT_CHANNEL_LABEL_MONO = 42,
3425 QT_CHANNEL_LABEL_DIALOG_CENTRIC_MIX = 43,
3427 QT_CHANNEL_LABEL_CENTER_SURROUND_DIRECT = 44, /* back center, non diffuse */
3429 QT_CHANNEL_LABEL_HAPTIC = 45,
3431 /* first order ambisonic channels */
3432 QT_CHANNEL_LABEL_AMBISONIC_W = 200,
3433 QT_CHANNEL_LABEL_AMBISONIC_X = 201,
3434 QT_CHANNEL_LABEL_AMBISONIC_Y = 202,
3435 QT_CHANNEL_LABEL_AMBISONIC_Z = 203,
3437 /* Mid/Side Recording */
3438 QT_CHANNEL_LABEL_MS_MID = 204,
3439 QT_CHANNEL_LABEL_MS_SIDE = 205,
3441 /* X-Y Recording */
3442 QT_CHANNEL_LABEL_XY_X = 206,
3443 QT_CHANNEL_LABEL_XY_Y = 207,
3445 /* other */
3446 QT_CHANNEL_LABEL_HEADPHONES_LEFT = 301,
3447 QT_CHANNEL_LABEL_HEADPHONES_RIGHT = 302,
3448 QT_CHANNEL_LABEL_CLICK_TRACK = 304,
3449 QT_CHANNEL_LABEL_FOREIGN_LANGUAGE = 305,
3451 /* generic discrete channel */
3452 QT_CHANNEL_LABEL_DISCRETE = 400,
3454 /* numbered discrete channel */
3455 QT_CHANNEL_LABEL_DISCRETE_0 = (1<<16),
3456 QT_CHANNEL_LABEL_DISCRETE_1 = (1<<16) | 1,
3457 QT_CHANNEL_LABEL_DISCRETE_2 = (1<<16) | 2,
3458 QT_CHANNEL_LABEL_DISCRETE_3 = (1<<16) | 3,
3459 QT_CHANNEL_LABEL_DISCRETE_4 = (1<<16) | 4,
3460 QT_CHANNEL_LABEL_DISCRETE_5 = (1<<16) | 5,
3461 QT_CHANNEL_LABEL_DISCRETE_6 = (1<<16) | 6,
3462 QT_CHANNEL_LABEL_DISCRETE_7 = (1<<16) | 7,
3463 QT_CHANNEL_LABEL_DISCRETE_8 = (1<<16) | 8,
3464 QT_CHANNEL_LABEL_DISCRETE_9 = (1<<16) | 9,
3465 QT_CHANNEL_LABEL_DISCRETE_10 = (1<<16) | 10,
3466 QT_CHANNEL_LABEL_DISCRETE_11 = (1<<16) | 11,
3467 QT_CHANNEL_LABEL_DISCRETE_12 = (1<<16) | 12,
3468 QT_CHANNEL_LABEL_DISCRETE_13 = (1<<16) | 13,
3469 QT_CHANNEL_LABEL_DISCRETE_14 = (1<<16) | 14,
3470 QT_CHANNEL_LABEL_DISCRETE_15 = (1<<16) | 15,
3471 QT_CHANNEL_LABEL_DISCRETE_65535 = (1<<16) | 65535,
3472 } lsmash_channel_label;
3474 typedef enum
3476 QT_CHANNEL_BIT_LEFT = 1,
3477 QT_CHANNEL_BIT_RIGHT = 1<<1,
3478 QT_CHANNEL_BIT_CENTER = 1<<2,
3479 QT_CHANNEL_BIT_LFE_SCREEN = 1<<3,
3480 QT_CHANNEL_BIT_LEFT_SURROUND = 1<<4, /* WAVE: "Back Left" */
3481 QT_CHANNEL_BIT_RIGHT_SURROUND = 1<<5, /* WAVE: "Back Right" */
3482 QT_CHANNEL_BIT_LEFT_CENTER = 1<<6,
3483 QT_CHANNEL_BIT_RIGHT_CENTER = 1<<7,
3484 QT_CHANNEL_BIT_CENTER_SURROUND = 1<<8, /* WAVE: "Back Center" */
3485 QT_CHANNEL_BIT_LEFT_SURROUND_DIRECT = 1<<9, /* WAVE: "Side Left" */
3486 QT_CHANNEL_BIT_RIGHT_SURROUND_DIRECT = 1<<10, /* WAVE: "Side Right" */
3487 QT_CHANNEL_BIT_TOP_CENTER_SURROUND = 1<<11,
3488 QT_CHANNEL_BIT_VERTICAL_HEIGHT_LEFT = 1<<12, /* WAVE: "Top Front Left" */
3489 QT_CHANNEL_BIT_VERTICAL_HEIGHT_CENTER = 1<<13, /* WAVE: "Top Front Center" */
3490 QT_CHANNEL_BIT_VERTICAL_HEIGHT_RIGHT = 1<<14, /* WAVE: "Top Front Right" */
3491 QT_CHANNEL_BIT_TOP_BACK_LEFT = 1<<15,
3492 QT_CHANNEL_BIT_TOP_BACK_CENTER = 1<<16,
3493 QT_CHANNEL_BIT_TOP_BACK_RIGHT = 1<<17,
3494 QT_CHANNEL_BIT_FULL = 0x3ffff,
3495 } lsmash_channel_bitmap;
3497 typedef enum
3499 QT_CHANNEL_FLAGS_ALL_OFF = 0,
3500 QT_CHANNEL_FLAGS_RECTANGULAR_COORDINATES = 1,
3501 QT_CHANNEL_FLAGS_SPHERICAL_COORDINATES = 1<<1,
3502 QT_CHANNEL_FLAGS_METERS = 1<<2,
3503 } lsmash_channel_flags;
3505 typedef enum
3507 /* indices for accessing the coordinates array in Channel Descriptions */
3508 /* for rectangulare coordinates */
3509 QT_CHANNEL_COORDINATES_LEFT_RIGHT = 0, /* Negative is left and positive is right. */
3510 QT_CHANNEL_COORDINATES_BACK_FRONT = 1, /* Negative is back and positive is front. */
3511 QT_CHANNEL_COORDINATES_DOWN_UP = 2, /* Negative is below ground level, 0 is ground level, and positive is above ground level. */
3512 /* for spherical coordinates */
3513 QT_CHANNEL_COORDINATES_AZIMUTH = 0, /* 0 is front center, positive is right, negative is left. This is measured in degrees. */
3514 QT_CHANNEL_COORDINATES_ELEVATION = 1, /* +90 is zenith, 0 is horizontal, -90 is nadir. This is measured in degrees. */
3515 QT_CHANNEL_COORDINATES_DISTANCE = 2, /* The units are described by flags. */
3516 } lsmash_channel_coordinates_index;
3518 typedef enum
3520 /* channel abbreviations:
3521 * L - left
3522 * R - right
3523 * C - center
3524 * Ls - left surround
3525 * Rs - right surround
3526 * Cs - center surround
3527 * Rls - rear left surround
3528 * Rrs - rear right surround
3529 * Lw - left wide
3530 * Rw - right wide
3531 * Lsd - left surround direct
3532 * Rsd - right surround direct
3533 * Lc - left center
3534 * Rc - right center
3535 * Ts - top surround
3536 * Vhl - vertical height left
3537 * Vhc - vertical height center
3538 * Vhr - vertical height right
3539 * Lt - left matrix total. for matrix encoded stereo.
3540 * Rt - right matrix total. for matrix encoded stereo. */
3542 /* General layouts */
3543 QT_CHANNEL_LAYOUT_USE_CHANNEL_DESCRIPTIONS = 0, /* use the array of Channel Descriptions to define the mapping. */
3544 QT_CHANNEL_LAYOUT_USE_CHANNEL_BITMAP = 1<<16, /* use the bitmap to define the mapping. */
3546 QT_CHANNEL_LAYOUT_MONO = (100<<16) | 1, /* a standard mono stream */
3547 QT_CHANNEL_LAYOUT_STEREO = (101<<16) | 2, /* a standard stereo stream (L R) - implied playback */
3548 QT_CHANNEL_LAYOUT_STEREO_HEADPHONES = (102<<16) | 2, /* a standard stereo stream (L R) - implied headphone playback */
3549 QT_CHANNEL_LAYOUT_MATRIX_STEREO = (103<<16) | 2, /* a matrix encoded stereo stream (Lt, Rt) */
3550 QT_CHANNEL_LAYOUT_MID_SIDE = (104<<16) | 2, /* mid/side recording */
3551 QT_CHANNEL_LAYOUT_XY = (105<<16) | 2, /* coincident mic pair (often 2 figure 8's) */
3552 QT_CHANNEL_LAYOUT_BINAURAL = (106<<16) | 2, /* binaural stereo (left, right) */
3553 QT_CHANNEL_LAYOUT_AMBISONIC_B_FORMAT = (107<<16) | 4, /* W, X, Y, Z */
3555 QT_CHANNEL_LAYOUT_QUADRAPHONIC = (108<<16) | 4, /* front left, front right, back left, back right */
3557 QT_CHANNEL_LAYOUT_PENTAGONAL = (109<<16) | 5, /* left, right, rear left, rear right, center */
3559 QT_CHANNEL_LAYOUT_HEXAGONAL = (110<<16) | 6, /* left, right, rear left, rear right, center, rear */
3561 QT_CHANNEL_LAYOUT_OCTAGONAL = (111<<16) | 8, /* front left, front right, rear left, rear right,
3562 * front center, rear center, side left, side right */
3564 QT_CHANNEL_LAYOUT_CUBE = (112<<16) | 8, /* left, right, rear left, rear right,
3565 * top left, top right, top rear left, top rear right */
3567 /* MPEG defined layouts */
3568 QT_CHANNEL_LAYOUT_MPEG_1_0 = QT_CHANNEL_LAYOUT_MONO, /* C */
3569 QT_CHANNEL_LAYOUT_MPEG_2_0 = QT_CHANNEL_LAYOUT_STEREO, /* L R */
3570 QT_CHANNEL_LAYOUT_MPEG_3_0_A = (113<<16) | 3, /* L R C */
3571 QT_CHANNEL_LAYOUT_MPEG_3_0_B = (114<<16) | 3, /* C L R */
3572 QT_CHANNEL_LAYOUT_MPEG_4_0_A = (115<<16) | 4, /* L R C Cs */
3573 QT_CHANNEL_LAYOUT_MPEG_4_0_B = (116<<16) | 4, /* C L R Cs */
3574 QT_CHANNEL_LAYOUT_MPEG_5_0_A = (117<<16) | 5, /* L R C Ls Rs */
3575 QT_CHANNEL_LAYOUT_MPEG_5_0_B = (118<<16) | 5, /* L R Ls Rs C */
3576 QT_CHANNEL_LAYOUT_MPEG_5_0_C = (119<<16) | 5, /* L C R Ls Rs */
3577 QT_CHANNEL_LAYOUT_MPEG_5_0_D = (120<<16) | 5, /* C L R Ls Rs */
3578 QT_CHANNEL_LAYOUT_MPEG_5_1_A = (121<<16) | 6, /* L R C LFE Ls Rs */
3579 QT_CHANNEL_LAYOUT_MPEG_5_1_B = (122<<16) | 6, /* L R Ls Rs C LFE */
3580 QT_CHANNEL_LAYOUT_MPEG_5_1_C = (123<<16) | 6, /* L C R Ls Rs LFE */
3581 QT_CHANNEL_LAYOUT_MPEG_5_1_D = (124<<16) | 6, /* C L R Ls Rs LFE */
3582 QT_CHANNEL_LAYOUT_MPEG_6_1_A = (125<<16) | 7, /* L R C LFE Ls Rs Cs */
3583 QT_CHANNEL_LAYOUT_MPEG_7_1_A = (126<<16) | 8, /* L R C LFE Ls Rs Lc Rc */
3584 QT_CHANNEL_LAYOUT_MPEG_7_1_B = (127<<16) | 8, /* C Lc Rc L R Ls Rs LFE (doc: IS-13818-7 MPEG2-AAC Table 3.1) */
3585 QT_CHANNEL_LAYOUT_MPEG_7_1_C = (128<<16) | 8, /* L R C LFE Ls Rs Rls Rrs */
3586 QT_CHANNEL_LAYOUT_EMAGIC_DEFAULT_7_1 = (129<<16) | 8, /* L R Ls Rs C LFE Lc Rc */
3587 QT_CHANNEL_LAYOUT_SMPTE_DTV = (130<<16) | 8, /* L R C LFE Ls Rs Lt Rt */
3589 /* ITU defined layouts */
3590 QT_CHANNEL_LAYOUT_ITU_1_0 = QT_CHANNEL_LAYOUT_MONO, /* C */
3591 QT_CHANNEL_LAYOUT_ITU_2_0 = QT_CHANNEL_LAYOUT_STEREO, /* L R */
3593 QT_CHANNEL_LAYOUT_ITU_2_1 = (131<<16) | 3, /* L R Cs */
3594 QT_CHANNEL_LAYOUT_ITU_2_2 = (132<<16) | 4, /* L R Ls Rs */
3595 QT_CHANNEL_LAYOUT_ITU_3_0 = QT_CHANNEL_LAYOUT_MPEG_3_0_A, /* L R C */
3596 QT_CHANNEL_LAYOUT_ITU_3_1 = QT_CHANNEL_LAYOUT_MPEG_4_0_A, /* L R C Cs */
3598 QT_CHANNEL_LAYOUT_ITU_3_2 = QT_CHANNEL_LAYOUT_MPEG_5_0_A, /* L R C Ls Rs */
3599 QT_CHANNEL_LAYOUT_ITU_3_2_1 = QT_CHANNEL_LAYOUT_MPEG_5_1_A, /* L R C LFE Ls Rs */
3600 QT_CHANNEL_LAYOUT_ITU_3_4_1 = QT_CHANNEL_LAYOUT_MPEG_7_1_C, /* L R C LFE Ls Rs Rls Rrs */
3602 /* DVD defined layouts */
3603 QT_CHANNEL_LAYOUT_DVD_0 = QT_CHANNEL_LAYOUT_MONO, /* C (mono) */
3604 QT_CHANNEL_LAYOUT_DVD_1 = QT_CHANNEL_LAYOUT_STEREO, /* L R */
3605 QT_CHANNEL_LAYOUT_DVD_2 = QT_CHANNEL_LAYOUT_ITU_2_1, /* L R Cs */
3606 QT_CHANNEL_LAYOUT_DVD_3 = QT_CHANNEL_LAYOUT_ITU_2_2, /* L R Ls Rs */
3607 QT_CHANNEL_LAYOUT_DVD_4 = (133<<16) | 3, /* L R LFE */
3608 QT_CHANNEL_LAYOUT_DVD_5 = (134<<16) | 4, /* L R LFE Cs */
3609 QT_CHANNEL_LAYOUT_DVD_6 = (135<<16) | 5, /* L R LFE Ls Rs */
3610 QT_CHANNEL_LAYOUT_DVD_7 = QT_CHANNEL_LAYOUT_MPEG_3_0_A, /* L R C */
3611 QT_CHANNEL_LAYOUT_DVD_8 = QT_CHANNEL_LAYOUT_MPEG_4_0_A, /* L R C Cs */
3612 QT_CHANNEL_LAYOUT_DVD_9 = QT_CHANNEL_LAYOUT_MPEG_5_0_A, /* L R C Ls Rs */
3613 QT_CHANNEL_LAYOUT_DVD_10 = (136<<16) | 4, /* L R C LFE */
3614 QT_CHANNEL_LAYOUT_DVD_11 = (137<<16) | 5, /* L R C LFE Cs */
3615 QT_CHANNEL_LAYOUT_DVD_12 = QT_CHANNEL_LAYOUT_MPEG_5_1_A, /* L R C LFE Ls Rs */
3616 /* 13 through 17 are duplicates of 8 through 12. */
3617 QT_CHANNEL_LAYOUT_DVD_13 = QT_CHANNEL_LAYOUT_DVD_8, /* L R C Cs */
3618 QT_CHANNEL_LAYOUT_DVD_14 = QT_CHANNEL_LAYOUT_DVD_9, /* L R C Ls Rs */
3619 QT_CHANNEL_LAYOUT_DVD_15 = QT_CHANNEL_LAYOUT_DVD_10, /* L R C LFE */
3620 QT_CHANNEL_LAYOUT_DVD_16 = QT_CHANNEL_LAYOUT_DVD_11, /* L R C LFE Cs */
3621 QT_CHANNEL_LAYOUT_DVD_17 = QT_CHANNEL_LAYOUT_DVD_12, /* L R C LFE Ls Rs */
3622 QT_CHANNEL_LAYOUT_DVD_18 = (138<<16) | 5, /* L R Ls Rs LFE */
3623 QT_CHANNEL_LAYOUT_DVD_19 = QT_CHANNEL_LAYOUT_MPEG_5_0_B, /* L R Ls Rs C */
3624 QT_CHANNEL_LAYOUT_DVD_20 = QT_CHANNEL_LAYOUT_MPEG_5_1_B, /* L R Ls Rs C LFE */
3626 /* These are the symmetrical layouts. */
3627 QT_CHANNEL_LAYOUT_AUDIO_UNIT_4 = QT_CHANNEL_LAYOUT_QUADRAPHONIC,
3628 QT_CHANNEL_LAYOUT_AUDIO_UNIT_5 = QT_CHANNEL_LAYOUT_PENTAGONAL,
3629 QT_CHANNEL_LAYOUT_AUDIO_UNIT_6 = QT_CHANNEL_LAYOUT_HEXAGONAL,
3630 QT_CHANNEL_LAYOUT_AUDIO_UNIT_8 = QT_CHANNEL_LAYOUT_OCTAGONAL,
3631 /* These are the surround-based layouts. */
3632 QT_CHANNEL_LAYOUT_AUDIO_UNIT_5_0 = QT_CHANNEL_LAYOUT_MPEG_5_0_B, /* L R Ls Rs C */
3633 QT_CHANNEL_LAYOUT_AUDIO_UNIT_6_0 = (139<<16) | 6, /* L R Ls Rs C Cs */
3634 QT_CHANNEL_LAYOUT_AUDIO_UNIT_7_0 = (140<<16) | 7, /* L R Ls Rs C Rls Rrs */
3635 QT_CHANNEL_LAYOUT_AUDIO_UNIT_7_0_FRONT = (148<<16) | 7, /* L R Ls Rs C Lc Rc */
3636 QT_CHANNEL_LAYOUT_AUDIO_UNIT_5_1 = QT_CHANNEL_LAYOUT_MPEG_5_1_A, /* L R C LFE Ls Rs */
3637 QT_CHANNEL_LAYOUT_AUDIO_UNIT_6_1 = QT_CHANNEL_LAYOUT_MPEG_6_1_A, /* L R C LFE Ls Rs Cs */
3638 QT_CHANNEL_LAYOUT_AUDIO_UNIT_7_1 = QT_CHANNEL_LAYOUT_MPEG_7_1_C, /* L R C LFE Ls Rs Rls Rrs */
3639 QT_CHANNEL_LAYOUT_AUDIO_UNIT_7_1_FRONT = QT_CHANNEL_LAYOUT_MPEG_7_1_A, /* L R C LFE Ls Rs Lc Rc */
3641 QT_CHANNEL_LAYOUT_AAC_3_0 = QT_CHANNEL_LAYOUT_MPEG_3_0_B, /* C L R */
3642 QT_CHANNEL_LAYOUT_AAC_QUADRAPHONIC = QT_CHANNEL_LAYOUT_QUADRAPHONIC, /* L R Ls Rs */
3643 QT_CHANNEL_LAYOUT_AAC_4_0 = QT_CHANNEL_LAYOUT_MPEG_4_0_B, /* C L R Cs */
3644 QT_CHANNEL_LAYOUT_AAC_5_0 = QT_CHANNEL_LAYOUT_MPEG_5_0_D, /* C L R Ls Rs */
3645 QT_CHANNEL_LAYOUT_AAC_5_1 = QT_CHANNEL_LAYOUT_MPEG_5_1_D, /* C L R Ls Rs LFE */
3646 QT_CHANNEL_LAYOUT_AAC_6_0 = (141<<16) | 6, /* C L R Ls Rs Cs */
3647 QT_CHANNEL_LAYOUT_AAC_6_1 = (142<<16) | 7, /* C L R Ls Rs Cs LFE */
3648 QT_CHANNEL_LAYOUT_AAC_7_0 = (143<<16) | 7, /* C L R Ls Rs Rls Rrs */
3649 QT_CHANNEL_LAYOUT_AAC_7_1 = QT_CHANNEL_LAYOUT_MPEG_7_1_B, /* C Lc Rc L R Ls Rs LFE */
3650 QT_CHANNEL_LAYOUT_AAC_OCTAGONAL = (144<<16) | 8, /* C L R Ls Rs Rls Rrs Cs */
3652 QT_CHANNEL_LAYOUT_TMH_10_2_STD = (145<<16) | 16, /* L R C Vhc Lsd Rsd Ls Rs Vhl Vhr Lw Rw Csd Cs LFE1 LFE2 */
3653 QT_CHANNEL_LAYOUT_TMH_10_2_FULL = (146<<16) | 21, /* TMH_10_2_std plus: Lc Rc HI VI Haptic */
3655 QT_CHANNEL_LAYOUT_AC3_1_0_1 = (149<<16) | 2, /* C LFE */
3656 QT_CHANNEL_LAYOUT_AC3_3_0 = (150<<16) | 3, /* L C R */
3657 QT_CHANNEL_LAYOUT_AC3_3_1 = (151<<16) | 4, /* L C R Cs */
3658 QT_CHANNEL_LAYOUT_AC3_3_0_1 = (152<<16) | 4, /* L C R LFE */
3659 QT_CHANNEL_LAYOUT_AC3_2_1_1 = (153<<16) | 4, /* L R Cs LFE */
3660 QT_CHANNEL_LAYOUT_AC3_3_1_1 = (154<<16) | 5, /* L C R Cs LFE */
3662 QT_CHANNEL_LAYOUT_EAC_6_0_A = (155<<16) | 6, /* L C R Ls Rs Cs */
3663 QT_CHANNEL_LAYOUT_EAC_7_0_A = (156<<16) | 7, /* L C R Ls Rs Rls Rrs */
3665 QT_CHANNEL_LAYOUT_EAC3_6_1_A = (157<<16) | 7, /* L C R Ls Rs LFE Cs */
3666 QT_CHANNEL_LAYOUT_EAC3_6_1_B = (158<<16) | 7, /* L C R Ls Rs LFE Ts */
3667 QT_CHANNEL_LAYOUT_EAC3_6_1_C = (159<<16) | 7, /* L C R Ls Rs LFE Vhc */
3668 QT_CHANNEL_LAYOUT_EAC3_7_1_A = (160<<16) | 8, /* L C R Ls Rs LFE Rls Rrs */
3669 QT_CHANNEL_LAYOUT_EAC3_7_1_B = (161<<16) | 8, /* L C R Ls Rs LFE Lc Rc */
3670 QT_CHANNEL_LAYOUT_EAC3_7_1_C = (162<<16) | 8, /* L C R Ls Rs LFE Lsd Rsd */
3671 QT_CHANNEL_LAYOUT_EAC3_7_1_D = (163<<16) | 8, /* L C R Ls Rs LFE Lw Rw */
3672 QT_CHANNEL_LAYOUT_EAC3_7_1_E = (164<<16) | 8, /* L C R Ls Rs LFE Vhl Vhr */
3674 QT_CHANNEL_LAYOUT_EAC3_7_1_F = (165<<16) | 8, /* L C R Ls Rs LFE Cs Ts */
3675 QT_CHANNEL_LAYOUT_EAC3_7_1_G = (166<<16) | 8, /* L C R Ls Rs LFE Cs Vhc */
3676 QT_CHANNEL_LAYOUT_EAC3_7_1_H = (167<<16) | 8, /* L C R Ls Rs LFE Ts Vhc */
3678 QT_CHANNEL_LAYOUT_DTS_3_1 = (168<<16) | 4, /* C L R LFE */
3679 QT_CHANNEL_LAYOUT_DTS_4_1 = (169<<16) | 5, /* C L R Cs LFE */
3680 QT_CHANNEL_LAYOUT_DTS_6_0_A = (170<<16) | 6, /* Lc Rc L R Ls Rs */
3681 QT_CHANNEL_LAYOUT_DTS_6_0_B = (171<<16) | 6, /* C L R Rls Rrs Ts */
3682 QT_CHANNEL_LAYOUT_DTS_6_0_C = (172<<16) | 6, /* C Cs L R Rls Rrs */
3683 QT_CHANNEL_LAYOUT_DTS_6_1_A = (173<<16) | 7, /* Lc Rc L R Ls Rs LFE */
3684 QT_CHANNEL_LAYOUT_DTS_6_1_B = (174<<16) | 7, /* C L R Rls Rrs Ts LFE */
3685 QT_CHANNEL_LAYOUT_DTS_6_1_C = (175<<16) | 7, /* C Cs L R Rls Rrs LFE */
3686 QT_CHANNEL_LAYOUT_DTS_7_0 = (176<<16) | 7, /* Lc C Rc L R Ls Rs */
3687 QT_CHANNEL_LAYOUT_DTS_7_1 = (177<<16) | 8, /* Lc C Rc L R Ls Rs LFE */
3688 QT_CHANNEL_LAYOUT_DTS_8_0_A = (178<<16) | 8, /* Lc Rc L R Ls Rs Rls Rrs */
3689 QT_CHANNEL_LAYOUT_DTS_8_0_B = (179<<16) | 8, /* Lc C Rc L R Ls Cs Rs */
3690 QT_CHANNEL_LAYOUT_DTS_8_1_A = (180<<16) | 9, /* Lc Rc L R Ls Rs Rls Rrs LFE */
3691 QT_CHANNEL_LAYOUT_DTS_8_1_B = (181<<16) | 9, /* Lc C Rc L R Ls Cs Rs LFE */
3692 QT_CHANNEL_LAYOUT_DTS_6_1_D = (182<<16) | 7, /* C L R Ls Rs LFE Cs */
3694 QT_CHANNEL_LAYOUT_ALAC_MONO = QT_CHANNEL_LAYOUT_MONO, /* C */
3695 QT_CHANNEL_LAYOUT_ALAC_STEREO = QT_CHANNEL_LAYOUT_STEREO, /* L R */
3696 QT_CHANNEL_LAYOUT_ALAC_3_0 = QT_CHANNEL_LAYOUT_MPEG_3_0_B, /* C L R */
3697 QT_CHANNEL_LAYOUT_ALAC_4_0 = QT_CHANNEL_LAYOUT_MPEG_4_0_B, /* C L R Cs */
3698 QT_CHANNEL_LAYOUT_ALAC_5_0 = QT_CHANNEL_LAYOUT_MPEG_5_0_D, /* C L R Ls Rs */
3699 QT_CHANNEL_LAYOUT_ALAC_5_1 = QT_CHANNEL_LAYOUT_MPEG_5_1_D, /* C L R Ls Rs LFE */
3700 QT_CHANNEL_LAYOUT_ALAC_6_1 = QT_CHANNEL_LAYOUT_AAC_6_1, /* C L R Ls Rs Cs LFE */
3701 QT_CHANNEL_LAYOUT_ALAC_7_1 = QT_CHANNEL_LAYOUT_MPEG_7_1_B, /* C Lc Rc L R Ls Rs LFE */
3703 QT_CHANNEL_LAYOUT_DISCRETE_IN_ORDER = 147<<16, /* needs to be ORed with the actual number of channels */
3704 QT_CHANNEL_LAYOUT_UNKNOWN = (signed)0xffff0000, /* needs to be ORed with the actual number of channels */
3705 } lsmash_channel_layout_tag;
3707 typedef struct
3709 lsmash_channel_layout_tag channelLayoutTag; /* channel layout */
3710 lsmash_channel_bitmap channelBitmap; /* Only available when layout_tag is set to QT_CHANNEL_LAYOUT_USE_CHANNEL_BITMAP. */
3711 } lsmash_qt_audio_channel_layout_t;
3713 /* QuickTime Audio Format Specific Flags
3714 * Some values are ignored i.e. as if treated as unspecified when you specify certain CODECs.
3715 * For instance, you specify QT_CODEC_TYPE_SOWT_AUDIO, then all these values are ignored.
3716 * These values are basically used for QT_CODEC_TYPE_LPCM_AUDIO.
3717 * The endiannes value can be used for QT_CODEC_TYPE_FL32_AUDIO, QT_CODEC_TYPE_FL64_AUDIO, QT_CODEC_TYPE_IN24_AUDIO and QT_CODEC_TYPE_IN32_AUDIO. */
3718 typedef enum
3720 QT_AUDIO_FORMAT_FLAG_FLOAT = 1, /* Set for floating point, clear for integer. */
3721 QT_AUDIO_FORMAT_FLAG_BIG_ENDIAN = 1<<1, /* Set for big endian, clear for little endian. */
3722 QT_AUDIO_FORMAT_FLAG_SIGNED_INTEGER = 1<<2, /* Set for signed integer, clear for unsigned integer.
3723 * This is only valid if QT_AUDIO_FORMAT_FLAG_FLOAT is clear. */
3724 QT_AUDIO_FORMAT_FLAG_PACKED = 1<<3, /* Set if the sample bits occupy the entire available bits for the channel,
3725 * clear if they are high or low aligned within the channel. */
3726 QT_AUDIO_FORMAT_FLAG_ALIGNED_HIGH = 1<<4, /* Set if the sample bits are placed into the high bits of the channel, clear for low bit placement.
3727 * This is only valid if QT_AUDIO_FORMAT_FLAG_PACKED is clear. */
3728 QT_AUDIO_FORMAT_FLAG_NON_INTERLEAVED = 1<<5, /* Set if the samples for each channel are located contiguously and the channels are layed out end to end,
3729 * clear if the samples for each frame are layed out contiguously and the frames layed out end to end. */
3730 QT_AUDIO_FORMAT_FLAG_NON_MIXABLE = 1<<6, /* Set to indicate when a format is non-mixable.
3731 * Note that this flag is only used when interacting with the HAL's stream format information.
3732 * It is not a valid flag for any other uses. */
3733 QT_AUDIO_FORMAT_FLAG_ALL_CLEAR = 1<<31, /* Set if all the flags would be clear in order to preserve 0 as the wild card value. */
3735 QT_LPCM_FORMAT_FLAG_FLOAT = QT_AUDIO_FORMAT_FLAG_FLOAT,
3736 QT_LPCM_FORMAT_FLAG_BIG_ENDIAN = QT_AUDIO_FORMAT_FLAG_BIG_ENDIAN,
3737 QT_LPCM_FORMAT_FLAG_SIGNED_INTEGER = QT_AUDIO_FORMAT_FLAG_SIGNED_INTEGER,
3738 QT_LPCM_FORMAT_FLAG_PACKED = QT_AUDIO_FORMAT_FLAG_PACKED,
3739 QT_LPCM_FORMAT_FLAG_ALIGNED_HIGH = QT_AUDIO_FORMAT_FLAG_ALIGNED_HIGH,
3740 QT_LPCM_FORMAT_FLAG_NON_INTERLEAVED = QT_AUDIO_FORMAT_FLAG_NON_INTERLEAVED,
3741 QT_LPCM_FORMAT_FLAG_NON_MIXABLE = QT_AUDIO_FORMAT_FLAG_NON_MIXABLE,
3742 QT_LPCM_FORMAT_FLAG_ALL_CLEAR = QT_AUDIO_FORMAT_FLAG_ALL_CLEAR,
3744 /* These flags are set for Apple Lossless data that was sourced from N bit native endian signed integer data. */
3745 QT_ALAC_FORMAT_FLAG_16BIT_SOURCE_DATA = 1,
3746 QT_ALAC_FORMAT_FLAG_20BIT_SOURCE_DATA = 2,
3747 QT_ALAC_FORMAT_FLAG_24BIT_SOURCE_DATA = 3,
3748 QT_ALAC_FORMAT_FLAG_32BIT_SOURCE_DATA = 4,
3749 } lsmash_qt_audio_format_specific_flag;
3751 typedef struct
3753 lsmash_qt_audio_format_specific_flag format_flags;
3754 } lsmash_qt_audio_format_specific_flags_t;
3756 /* Global Header
3757 * Ut Video inside QuickTime file format requires this extension for storing CODEC specific information. */
3758 typedef struct
3760 uint32_t header_size;
3761 uint8_t *header_data;
3762 } lsmash_codec_global_header_t;
3764 /****************************************************************************
3765 * iTunes Metadata
3766 ****************************************************************************/
3767 typedef enum
3769 /* UTF String type */
3770 ITUNES_METADATA_ITEM_ALBUM_NAME = LSMASH_4CC( 0xA9, 'a', 'l', 'b' ), /* Album Name */
3771 ITUNES_METADATA_ITEM_ARTIST = LSMASH_4CC( 0xA9, 'A', 'R', 'T' ), /* Artist */
3772 ITUNES_METADATA_ITEM_USER_COMMENT = LSMASH_4CC( 0xA9, 'c', 'm', 't' ), /* User Comment */
3773 ITUNES_METADATA_ITEM_RELEASE_DATE = LSMASH_4CC( 0xA9, 'd', 'a', 'y' ), /* YYYY-MM-DD format string (may be incomplete, i.e. only year) */
3774 ITUNES_METADATA_ITEM_ENCODED_BY = LSMASH_4CC( 0xA9, 'e', 'n', 'c' ), /* Person or company that encoded the recording */
3775 ITUNES_METADATA_ITEM_USER_GENRE = LSMASH_4CC( 0xA9, 'g', 'e', 'n' ), /* User Genre user-specified string */
3776 ITUNES_METADATA_ITEM_GROUPING = LSMASH_4CC( 0xA9, 'g', 'r', 'p' ), /* Grouping */
3777 ITUNES_METADATA_ITEM_LYRICS = LSMASH_4CC( 0xA9, 'l', 'y', 'r' ), /* Lyrics */
3778 ITUNES_METADATA_ITEM_TITLE = LSMASH_4CC( 0xA9, 'n', 'a', 'm' ), /* Title / Song Name */
3779 ITUNES_METADATA_ITEM_TRACK_SUBTITLE = LSMASH_4CC( 0xA9, 's', 't', '3' ), /* Track Sub-Title */
3780 ITUNES_METADATA_ITEM_ENCODING_TOOL = LSMASH_4CC( 0xA9, 't', 'o', 'o' ), /* Software which encoded the recording */
3781 ITUNES_METADATA_ITEM_COMPOSER = LSMASH_4CC( 0xA9, 'w', 'r', 't' ), /* Composer */
3782 ITUNES_METADATA_ITEM_ALBUM_ARTIST = LSMASH_4CC( 'a', 'A', 'R', 'T' ), /* Artist for the whole album (if different than the individual tracks) */
3783 ITUNES_METADATA_ITEM_PODCAST_CATEGORY = LSMASH_4CC( 'c', 'a', 't', 'g' ), /* Podcast Category */
3784 ITUNES_METADATA_ITEM_COPYRIGHT = LSMASH_4CC( 'c', 'p', 'r', 't' ), /* Copyright */
3785 ITUNES_METADATA_ITEM_DESCRIPTION = LSMASH_4CC( 'd', 'e', 's', 'c' ), /* Description (limited to 255 bytes) */
3786 ITUNES_METADATA_ITEM_GROUPING_DRAFT = LSMASH_4CC( 'g', 'r', 'u', 'p' ), /* Grouping
3787 * Note: This identifier is defined in
3788 * iTunes Metadata Format Specification (Preliminary draft),
3789 * but not used by iTunes actually it seems.
3790 * We recommend you use ITUNES_METADATA_ITEM_GROUPING instead of this. */
3791 ITUNES_METADATA_ITEM_PODCAST_KEYWORD = LSMASH_4CC( 'k', 'e', 'y', 'w' ), /* Podcast Keywords */
3792 ITUNES_METADATA_ITEM_LONG_DESCRIPTION = LSMASH_4CC( 'l', 'd', 'e', 's' ), /* Long Description */
3793 ITUNES_METADATA_ITEM_PURCHASE_DATE = LSMASH_4CC( 'p', 'u', 'r', 'd' ), /* Purchase Date */
3794 ITUNES_METADATA_ITEM_TV_EPISODE_ID = LSMASH_4CC( 't', 'v', 'e', 'n' ), /* TV Episode ID */
3795 ITUNES_METADATA_ITEM_TV_NETWORK = LSMASH_4CC( 't', 'v', 'n', 'n' ), /* TV Network Name */
3796 ITUNES_METADATA_ITEM_TV_SHOW_NAME = LSMASH_4CC( 't', 'v', 's', 'h' ), /* TV Show Name */
3797 ITUNES_METADATA_ITEM_ITUNES_PURCHASE_ACCOUNT_ID = LSMASH_4CC( 'a', 'p', 'I', 'D' ), /* iTunes Account Used for Purchase */
3798 ITUNES_METADATA_ITEM_ITUNES_SORT_ALBUM = LSMASH_4CC( 's', 'o', 'a', 'l' ), /* Sort Album */
3799 ITUNES_METADATA_ITEM_ITUNES_SORT_ARTIST = LSMASH_4CC( 's', 'o', 'a', 'r' ), /* Sort Artist */
3800 ITUNES_METADATA_ITEM_ITUNES_SORT_ALBUM_ARTIST = LSMASH_4CC( 's', 'o', 'a', 'a' ), /* Sort Album Artist */
3801 ITUNES_METADATA_ITEM_ITUNES_SORT_COMPOSER = LSMASH_4CC( 's', 'o', 'c', 'o' ), /* Sort Composer */
3802 ITUNES_METADATA_ITEM_ITUNES_SORT_NAME = LSMASH_4CC( 's', 'o', 'n', 'm' ), /* Sort Name */
3803 ITUNES_METADATA_ITEM_ITUNES_SORT_SHOW = LSMASH_4CC( 's', 'o', 's', 'n' ), /* Sort Show */
3805 /* Integer type
3806 * (X): X means length of bytes */
3807 ITUNES_METADATA_ITEM_EPISODE_GLOBAL_ID = LSMASH_4CC( 'e', 'g', 'i', 'd' ), /* (1) Episode Global Unique ID */
3808 ITUNES_METADATA_ITEM_PREDEFINED_GENRE = LSMASH_4CC( 'g', 'n', 'r', 'e' ), /* (2) Pre-defined Genre / Enumerated value from ID3 tag set, plus 1 */
3809 ITUNES_METADATA_ITEM_PODCAST_URL = LSMASH_4CC( 'p', 'u', 'r', 'l' ), /* (?) Podcast URL */
3810 ITUNES_METADATA_ITEM_CONTENT_RATING = LSMASH_4CC( 'r', 't', 'n', 'g' ), /* (1) Content Rating / Does song have explicit content? 0: none, 2: clean, 4: explicit */
3811 ITUNES_METADATA_ITEM_MEDIA_TYPE = LSMASH_4CC( 's', 't', 'i', 'k' ), /* (1) Media Type */
3812 ITUNES_METADATA_ITEM_BEATS_PER_MINUTE = LSMASH_4CC( 't', 'm', 'p', 'o' ), /* (2) Beats Per Minute */
3813 ITUNES_METADATA_ITEM_TV_EPISODE = LSMASH_4CC( 't', 'v', 'e', 's' ), /* (4) TV Episode */
3814 ITUNES_METADATA_ITEM_TV_SEASON = LSMASH_4CC( 't', 'v', 's', 'n' ), /* (4) TV Season */
3815 ITUNES_METADATA_ITEM_ITUNES_ACCOUNT_TYPE = LSMASH_4CC( 'a', 'k', 'I', 'D' ), /* (1) iTunes Account Type / 0: iTunes, 1: AOL */
3816 ITUNES_METADATA_ITEM_ITUNES_ARTIST_ID = LSMASH_4CC( 'a', 't', 'I', 'D' ), /* (4) iTunes Artist ID */
3817 ITUNES_METADATA_ITEM_ITUNES_COMPOSER_ID = LSMASH_4CC( 'c', 'm', 'I', 'D' ), /* (4) iTunes Composer ID */
3818 ITUNES_METADATA_ITEM_ITUNES_CATALOG_ID = LSMASH_4CC( 'c', 'n', 'I', 'D' ), /* (4) iTunes Catalog ID */
3819 ITUNES_METADATA_ITEM_ITUNES_TV_GENRE_ID = LSMASH_4CC( 'g', 'e', 'I', 'D' ), /* (4) iTunes TV Genre ID */
3820 ITUNES_METADATA_ITEM_ITUNES_PLAYLIST_ID = LSMASH_4CC( 'p', 'l', 'I', 'D' ), /* (8) iTunes Playlist ID */
3821 ITUNES_METADATA_ITEM_ITUNES_COUNTRY_CODE = LSMASH_4CC( 's', 'f', 'I', 'D' ), /* (4) iTunes Country Code */
3823 /* Boolean type */
3824 ITUNES_METADATA_ITEM_DISC_COMPILATION = LSMASH_4CC( 'c', 'p', 'i', 'l' ), /* Disc Compilation / Is disc part of a compilation? 0: No, 1: Yes */
3825 ITUNES_METADATA_ITEM_HIGH_DEFINITION_VIDEO = LSMASH_4CC( 'h', 'd', 'v', 'd' ), /* High Definition Video / 0: No, 1: Yes */
3826 ITUNES_METADATA_ITEM_PODCAST = LSMASH_4CC( 'p', 'c', 's', 't' ), /* Podcast / 0: No, 1: Yes */
3827 ITUNES_METADATA_ITEM_GAPLESS_PLAYBACK = LSMASH_4CC( 'p', 'g', 'a', 'p' ), /* Gapless Playback / 0: insert gap, 1: no gap */
3829 /* Binary type */
3830 ITUNES_METADATA_ITEM_COVER_ART = LSMASH_4CC( 'c', 'o', 'v', 'r' ), /* One or more cover art images (JPEG/PNG/BMP data) */
3831 ITUNES_METADATA_ITEM_DISC_NUMBER = LSMASH_4CC( 'd', 'i', 's', 'k' ), /* Disc Number */
3832 ITUNES_METADATA_ITEM_TRACK_NUMBER = LSMASH_4CC( 't', 'r', 'k', 'n' ), /* Track Number */
3834 /* Custom type */
3835 ITUNES_METADATA_ITEM_CUSTOM = LSMASH_4CC( '-', '-', '-', '-' ), /* Custom */
3836 } lsmash_itunes_metadata_item;
3838 typedef enum
3840 ITUNES_METADATA_TYPE_NONE = 0,
3841 ITUNES_METADATA_TYPE_STRING = 1,
3842 ITUNES_METADATA_TYPE_INTEGER = 2,
3843 ITUNES_METADATA_TYPE_BOOLEAN = 3,
3844 ITUNES_METADATA_TYPE_BINARY = 4,
3845 } lsmash_itunes_metadata_type;
3847 typedef enum
3849 ITUNES_METADATA_SUBTYPE_IMPLICIT = 0, /* for use with tags for which no type needs to be indicated because only one type is allowed */
3850 ITUNES_METADATA_SUBTYPE_UTF8 = 1, /* without any count or null terminator */
3851 ITUNES_METADATA_SUBTYPE_UTF16 = 2, /* also known as UTF-16BE */
3852 ITUNES_METADATA_SUBTYPE_SJIS = 3, /* deprecated unless it is needed for special Japanese characters */
3853 ITUNES_METADATA_SUBTYPE_HTML = 6, /* the HTML file header specifies which HTML version */
3854 ITUNES_METADATA_SUBTYPE_XML = 7, /* the XML header must identify the DTD or schemas */
3855 ITUNES_METADATA_SUBTYPE_UUID = 8, /* also known as GUID; stored as 16 bytes in binary (valid as an ID) */
3856 ITUNES_METADATA_SUBTYPE_ISRC = 9, /* stored as UTF-8 text (valid as an ID) */
3857 ITUNES_METADATA_SUBTYPE_MI3P = 10, /* stored as UTF-8 text (valid as an ID) */
3858 ITUNES_METADATA_SUBTYPE_GIF = 12, /* (deprecated) a GIF image */
3859 ITUNES_METADATA_SUBTYPE_JPEG = 13, /* in a JFIF wrapper */
3860 ITUNES_METADATA_SUBTYPE_PNG = 14, /* in a PNG wrapper */
3861 ITUNES_METADATA_SUBTYPE_URL = 15, /* absolute, in UTF-8 characters */
3862 ITUNES_METADATA_SUBTYPE_DURATION = 16, /* in milliseconds, a 32-bit integer */
3863 ITUNES_METADATA_SUBTYPE_TIME = 17, /* in UTC, counting seconds since midnight on 1 January, 1904; 32 or 64 bits */
3864 ITUNES_METADATA_SUBTYPE_GENRES = 18, /* a list of values from the enumerated set */
3865 ITUNES_METADATA_SUBTYPE_INTEGER = 21, /* A signed big-endian integer in 1,2,3,4 or 8 bytes */
3866 ITUNES_METADATA_SUBTYPE_RIAAPA = 24, /* RIAA Parental advisory; -1=no, 1=yes, 0=unspecified. 8-bit integer */
3867 ITUNES_METADATA_SUBTYPE_UPC = 25, /* Universal Product Code, in text UTF-8 format (valid as an ID) */
3868 ITUNES_METADATA_SUBTYPE_BMP = 27, /* Windows bitmap format graphics */
3869 } lsmash_itunes_metadata_subtype;
3871 typedef union
3873 char *string; /* for ITUNES_METADATA_TYPE_STRING (UTF-8 string) */
3874 uint64_t integer; /* for ITUNES_METADATA_TYPE_INTEGER */
3875 lsmash_boolean_t boolean; /* for ITUNES_METADATA_TYPE_BOOLEAN */
3876 /* for ITUNES_METADATA_TYPE_BINARY */
3877 struct
3879 lsmash_itunes_metadata_subtype subtype;
3880 uint32_t size;
3881 uint8_t *data;
3882 } binary;
3883 } lsmash_itunes_metadata_value_t;
3885 typedef struct
3887 /* When 'item' is specified as ITUNES_METADATA_ITEM_CUSTOM, 'type' and 'meaning' is mandatory while 'name' is optionally valid.
3888 * Otherwise 'type', 'meaning' and 'name' are just ignored. 'value' is always mandatory. */
3889 lsmash_itunes_metadata_item item;
3890 lsmash_itunes_metadata_type type;
3891 lsmash_itunes_metadata_value_t value;
3892 char *meaning;
3893 char *name;
3894 } lsmash_itunes_metadata_t;
3896 /* Append an iTunes metadata to a movie.
3898 * Return 0 if successful.
3899 * Return a negative value otherwise. */
3900 int lsmash_set_itunes_metadata
3902 lsmash_root_t *root,
3903 lsmash_itunes_metadata_t metadata
3906 /* Count the number of iTunes metadata in a movie.
3908 * Return the number of iTunes metadata in a movie if successful.
3909 * Return 0 otherwise. */
3910 uint32_t lsmash_count_itunes_metadata
3912 lsmash_root_t *root
3915 /* Get an iTunes metadata in a movie.
3916 * String and/or binary fields in 'metadata' are allocated if successful.
3917 * You can deallocate the allocated fields by lsmash_free().
3918 * Also you can deallocate all of the allocated fields by lsmash_cleanup_itunes_metadata() at a time.
3920 * Return 0 if successful.
3921 * Return a negative value otherwise. */
3922 int lsmash_get_itunes_metadata
3924 lsmash_root_t *root,
3925 uint32_t metadata_number,
3926 lsmash_itunes_metadata_t *metadata
3929 /* Deallocate all of allocated fields in a given iTunes metadata at a time.
3930 * The deallocated fields are set to NULL.
3931 * Note: the given iTunes metadata itself is NOT deallocated by this function. */
3932 void lsmash_cleanup_itunes_metadata
3934 lsmash_itunes_metadata_t *metadata
3937 /****************************************************************************
3938 * Others
3939 ****************************************************************************/
3940 /* Set a copyright declaration to a track.
3941 * track_ID == 0 means copyright declaration applies to the entire presentation, not an entire track.
3943 * Return 0 if successful.
3944 * Return a negative value otherwise. */
3945 int lsmash_set_copyright
3947 lsmash_root_t *root,
3948 uint32_t track_ID,
3949 uint16_t ISO_language,
3950 char *notice
3953 int lsmash_create_object_descriptor
3955 lsmash_root_t *root
3958 #ifdef _WIN32
3959 /* Convert string encoded by ACP (ANSI CODE PAGE) to UTF-8.
3961 * Return the size of converted string (bytes) if successful.
3962 * Return 0 otherwise. */
3963 int lsmash_convert_ansi_to_utf8
3965 const char *string_ansi, /* string encoded by ACP */
3966 char *string_utf8, /* buffer for converted string from ACP */
3967 int max_length /* size of 'string_utf8' */
3969 #endif
3971 #undef PRIVATE
3973 #endif