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