* all : preliminary mp4 (and some mov) demux plugin. I've not enabled
[vlc.git] / plugins / mp4 / libmp4.h
1 /*****************************************************************************
2  * libmp4.h : LibMP4 library for mp4 module for vlc
3  *****************************************************************************
4  * Copyright (C) 2001 VideoLAN
5  * $Id: libmp4.h,v 1.1 2002/07/17 21:37:27 fenrir Exp $
6  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
7  * 
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  * 
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
21  *****************************************************************************/
22
23
24
25 /* XXX It's not the same than VLC_FOURCC */
26 #define MP4_FOURCC( a, b, c, d ) \
27     ( ((u32)d) | ( ((u32)c) << 8 ) | ( ((u32)b) << 16 ) | ( ((u32)a) << 24 ) )
28         
29
30 #define FOURCC_uuid MP4_FOURCC( 'u', 'u', 'i', 'd' )
31
32 #define FOURCC_ftyp MP4_FOURCC( 'f', 't', 'y', 'p' )
33 #define FOURCC_moov MP4_FOURCC( 'm', 'o', 'o', 'v' )
34 #define FOURCC_cmov MP4_FOURCC( 'c', 'm', 'o', 'v' )
35 #define FOURCC_dcom MP4_FOURCC( 'd', 'c', 'o', 'm' )
36 #define FOURCC_cmvd MP4_FOURCC( 'c', 'm', 'v', 'd' )
37     
38 #define FOURCC_moof MP4_FOURCC( 'm', 'o', 'o', 'f' )
39 #define FOURCC_mdat MP4_FOURCC( 'm', 'd', 'a', 't' )
40 #define FOURCC_skip MP4_FOURCC( 's', 'k', 'i', 'p' )
41 #define FOURCC_free MP4_FOURCC( 'f', 'r', 'e', 'e' )
42 #define FOURCC_udta MP4_FOURCC( 'u', 'd', 't', 'a' )
43 #define FOURCC_wide MP4_FOURCC( 'w', 'i', 'd', 'e' )
44
45 #define FOURCC_trak MP4_FOURCC( 't', 'r', 'a', 'k' )
46 #define FOURCC_mvhd MP4_FOURCC( 'm', 'v', 'h', 'd' )
47 #define FOURCC_tkhd MP4_FOURCC( 't', 'k', 'h', 'd' )
48 #define FOURCC_tref MP4_FOURCC( 't', 'r', 'e', 'f' )
49 #define FOURCC_mdia MP4_FOURCC( 'm', 'd', 'i', 'a' )
50 #define FOURCC_mdhd MP4_FOURCC( 'm', 'd', 'h', 'd' )
51 #define FOURCC_hdlr MP4_FOURCC( 'h', 'd', 'l', 'r' )
52 #define FOURCC_minf MP4_FOURCC( 'm', 'i', 'n', 'f' )
53 #define FOURCC_vmhd MP4_FOURCC( 'v', 'm', 'h', 'd' )
54 #define FOURCC_smhd MP4_FOURCC( 's', 'm', 'h', 'd' )
55 #define FOURCC_hmhd MP4_FOURCC( 'h', 'm', 'h', 'd' )
56 #define FOURCC_dinf MP4_FOURCC( 'd', 'i', 'n', 'f' )
57 #define FOURCC_url  MP4_FOURCC( 'u', 'r', 'l', ' ' )
58 #define FOURCC_urn  MP4_FOURCC( 'u', 'r', 'n', ' ' )
59 #define FOURCC_dref MP4_FOURCC( 'd', 'r', 'e', 'f' )
60 #define FOURCC_stbl MP4_FOURCC( 's', 't', 'b', 'l' )
61 #define FOURCC_stts MP4_FOURCC( 's', 't', 't', 's' )
62 #define FOURCC_ctts MP4_FOURCC( 'c', 't', 't', 's' )
63 #define FOURCC_stsd MP4_FOURCC( 's', 't', 's', 'd' )
64 #define FOURCC_stsz MP4_FOURCC( 's', 't', 's', 'z' )
65 #define FOURCC_stz2 MP4_FOURCC( 's', 't', 'z', '2' )
66 #define FOURCC_stsc MP4_FOURCC( 's', 't', 's', 'c' )
67 #define FOURCC_stco MP4_FOURCC( 's', 't', 'c', 'o' )
68 #define FOURCC_co64 MP4_FOURCC( 'c', 'o', '6', '4' )
69 #define FOURCC_stss MP4_FOURCC( 's', 't', 's', 's' )
70 #define FOURCC_stsh MP4_FOURCC( 's', 't', 's', 'h' )
71 #define FOURCC_stdp MP4_FOURCC( 's', 't', 'd', 'p' )
72 #define FOURCC_padb MP4_FOURCC( 'p', 'a', 'd', 'b' )
73 #define FOURCC_edts MP4_FOURCC( 'e', 'd', 't', 's' )
74 #define FOURCC_elst MP4_FOURCC( 'e', 'l', 's', 't' )
75 #define FOURCC_udta MP4_FOURCC( 'u', 'd', 't', 'a' )
76 #define FOURCC_mvex MP4_FOURCC( 'm', 'v', 'e', 'x' )
77 #define FOURCC_trex MP4_FOURCC( 't', 'r', 'e', 'x' )
78 #define FOURCC_mfhd MP4_FOURCC( 'm', 'f', 'h', 'd' )
79 #define FOURCC_traf MP4_FOURCC( 't', 'r', 'a', 'f' )
80 #define FOURCC_tfhd MP4_FOURCC( 't', 'f', 'h', 'd' )
81 #define FOURCC_trun MP4_FOURCC( 't', 'r', 'u', 'n' )
82 #define FOURCC_cprt MP4_FOURCC( 'c', 'p', 'r', 't' )
83 #define FOURCC_iods MP4_FOURCC( 'i', 'o', 'd', 's' )
84
85 #define FOURCC_nmhd MP4_FOURCC( 'n', 'm', 'h', 'd' )
86 #define FOURCC_mp4v MP4_FOURCC( 'm', 'p', '4', 'v' )
87 #define FOURCC_mp4a MP4_FOURCC( 'm', 'p', '4', 'a' )
88 #define FOURCC_mp4s MP4_FOURCC( 'm', 'p', '4', 's' )
89 #define FOURCC_vide MP4_FOURCC( 'v', 'i', 'd', 'e' )
90 #define FOURCC_soun MP4_FOURCC( 's', 'o', 'u', 'n' )
91 #define FOURCC_hint MP4_FOURCC( 'h', 'i', 'n', 't' )
92     
93 #define FOURCC_dpnd MP4_FOURCC( 'd', 'p', 'n', 'd' )
94 #define FOURCC_ipir MP4_FOURCC( 'i', 'p', 'i', 'r' )
95 #define FOURCC_mpod MP4_FOURCC( 'm', 'p', 'o', 'd' )
96 #define FOURCC_hnti MP4_FOURCC( 'h', 'n', 't', 'i' )
97 #define FOURCC_rtp  MP4_FOURCC( 'r', 't', 'p', ' ' )
98
99 #define FOURCC_isom MP4_FOURCC( 'i', 's', 'o', 'm' )
100 #define FOURCC_esds MP4_FOURCC( 'e', 's', 'd', 's' )
101
102 #define FOURCC_zlib MP4_FOURCC( 'z', 'l', 'i', 'b' )
103 #define FOURCC_SVQ1 MP4_FOURCC( 'S', 'V', 'Q', '1' )
104 #define FOURCC__mp3 MP4_FOURCC( '.', 'm', 'p', '3' )
105 #define FOURCC_3IV1 MP4_FOURCC( '3', 'I', 'V', '1' )
106 #define FOURCC_h263 MP4_FOURCC( 'h', '2', '6', '3' )
107 #define FOURCC_DIVX MP4_FOURCC( 'D', 'I', 'V', 'X' )
108
109     
110 /*
111 #define FOURCC_  MP4_FOURCC( '', '', '', '' )
112 */    
113 /* Do you want some debug information on all read boxes ? */
114 #define MP4_VERBOSE  1
115
116 /* memory stream and file stream object */
117
118 typedef struct MP4_Stream_s
119 {
120     int b_memory;   /* do we uses a memory buffer */
121
122     input_thread_t *p_input;
123     
124     off_t i_start; /* in the buffer position for memory stream */
125     off_t i_stop;
126     u8  *p_buffer;
127
128 } MP4_Stream_t;
129     
130 struct MP4_Box_s;
131
132
133 /* uuid Universal Unique IDentifiers */
134 typedef struct UUID_s 
135 {
136     u8 b[16];
137 } UUID_t;
138
139 /* specific structure for all boxes */
140
141 typedef struct MP4_Box_data_ftyp_s
142 {
143     u32 i_major_brand;
144     u32 i_minor_version;
145
146     u32 i_compatible_brands_count;
147     u32 *i_compatible_brands;
148
149 } MP4_Box_data_ftyp_t;
150
151 typedef struct MP4_Box_data_mvhd_s
152 {
153     u8  i_version;
154     u32 i_flags;
155         
156     u64 i_creation_time;
157     u64 i_modification_time;
158     u32 i_timescale;
159     u64 i_duration;
160
161     s32 i_rate;
162     s16 i_volume;
163     s16 i_reserved1;
164     u32 i_reserved2[2];
165     s32 i_matrix[9];
166     u32 i_predefined[6];
167     u32 i_next_track_id;
168
169 } MP4_Box_data_mvhd_t;
170
171 #define MP4_TRACK_ENABLED    0x000001
172 #define MP4_TRACK_IN_MOVIE   0x000002
173 #define MP4_TRACK_IN_PREVIEW 0x000004
174 typedef struct MP4_Box_data_tkhd_s
175 {
176     u8  i_version;
177     u32 i_flags;
178         
179     u64 i_creation_time;
180     u64 i_modification_time;
181     u32 i_track_ID;
182     u32 i_reserved;
183     u64 i_duration;
184     
185     u32 i_reserved2[2];
186     s16 i_layer;
187     s16 i_predefined;
188     
189     s16 i_volume;
190     u16 i_reserved3;
191     s32 i_matrix[9];
192     s32 i_width;
193     s32 i_height;
194     
195 } MP4_Box_data_tkhd_t;
196
197 typedef struct MP4_Box_data_mdhd_s
198 {
199     u8  i_version;
200     u32 i_flags;
201         
202     u64 i_creation_time;
203     u64 i_modification_time;
204     u32 i_timescale;
205     u64 i_duration;
206
207     /* one bit for pad */
208     /* unsigned int(5)[3] language difference with 0x60*/
209     unsigned char i_language[3]; 
210     u16 i_predefined;
211
212 } MP4_Box_data_mdhd_t;
213
214 typedef struct MP4_Box_data_hdlr_s
215 {
216     u8  i_version;
217     u32 i_flags;
218     
219     u32 i_predefined;
220     u32 i_handler_type; /* "vide" "soun" "hint" "odsm" 
221                            "crsm" "sdsm" "m7sm" "ocsm" 
222                            "ipsm" "mjsm" */
223     
224     unsigned char *psz_name; /* in UTF-8 */
225
226 } MP4_Box_data_hdlr_t;
227
228 typedef struct MP4_Box_data_vmhd_s
229 {
230     u8  i_version;
231     u32 i_flags;
232     
233     s16 i_graphics_mode;
234     s16 i_opcolor[3];    
235
236 } MP4_Box_data_vmhd_t;
237
238 typedef struct MP4_Box_data_smhd_s
239 {
240     u8  i_version;
241     u32 i_flags;
242     
243     s16 i_balance;
244     s16 i_reserved;
245
246 } MP4_Box_data_smhd_t;
247
248 typedef struct MP4_Box_data_hmhd_s
249 {
250     u8  i_version;
251     u32 i_flags;
252        
253     u16 i_max_PDU_size;
254     u16 i_avg_PDU_size;
255     u32 i_max_bitrate;
256     u32 i_avg_bitrate;
257     u32 i_reserved;
258
259 } MP4_Box_data_hmhd_t;
260
261 typedef struct MP4_Box_data_url_s
262 {
263     u8  i_version;
264     u32 i_flags;
265     
266     unsigned char *psz_location;
267     
268 } MP4_Box_data_url_t;
269
270 typedef struct MP4_Box_data_urn_s
271 {
272     u8  i_version;
273     u32 i_flags;
274
275     unsigned char *psz_name;
276     unsigned char *psz_location;
277     
278 } MP4_Box_data_urn_t;
279
280 typedef struct MP4_Box_data_dref_s
281 {
282     u8  i_version;
283     u32 i_flags;
284
285     u32 i_entry_count;
286 /* XXX it's also a container with i_entry_count entry */
287 } MP4_Box_data_dref_t;
288
289 typedef struct MP4_Box_data_stts_s
290 {
291     u8  i_version;
292     u32 i_flags;
293
294     u32 i_entry_count;
295     u32 *i_sample_count; /* these are array */
296     s32 *i_sample_delta;
297
298 } MP4_Box_data_stts_t;
299
300 typedef struct MP4_Box_data_ctts_s
301 {
302     u8  i_version;
303     u32 i_flags;
304     
305     u32 i_entry_count;
306
307     u32 *i_sample_count; /* these are array */
308     s32 *i_sample_offset;
309
310 } MP4_Box_data_ctts_t;
311
312
313 typedef struct MP4_Box_data_sample_soun_s
314 {
315     u8  i_reserved1[6];
316     u16 i_data_reference_index;
317
318     u32 i_reserved2[2];
319     u16 i_channelcount;
320     u16 i_samplesize;
321     u16 i_predefined;
322     u16 i_reserved3;
323     u16 i_sampleratehi; /* timescale of track */
324     u16 i_sampleratelo;
325     
326 } MP4_Box_data_sample_soun_t;
327
328 typedef struct MP4_Box_data_sample_mp4a_s
329 {
330     u8  i_reserved1[6];
331     u16 i_data_reference_index;
332
333     u32 i_reserved2[2];
334     u16 i_channelcount;
335     u16 i_samplesize;
336     u16 i_predefined;
337     u16 i_reserved3;
338     u16 i_sampleratehi; /* timescale of track */
339     u16 i_sampleratelo;
340     
341 } MP4_Box_data_sample_mp4a_t;
342
343
344 typedef struct MP4_Box_data_sample_vide_s
345 {
346     u8  i_reserved1[6];
347     u16 i_data_reference_index;
348
349     u16 i_predefined1;
350     u16 i_reserved2;
351     u32 i_predefined2[3];
352
353     s16 i_width;
354     s16 i_height;
355
356     u32 i_horizresolution;
357     u32 i_vertresolution;
358
359     u32 i_reserved3;
360     u16 i_predefined3;
361     
362     u8  i_compressorname[32];
363     s16 i_depth;
364
365     s16 i_predefined4;
366     
367 } MP4_Box_data_sample_vide_t;
368
369 typedef struct MP4_Box_data_sample_mp4v_s
370 {
371     u8  i_reserved1[6];
372     u16 i_data_reference_index;
373
374     u16 i_predefined1;
375     u16 i_reserved2;
376     u32 i_predefined2[3];
377
378     s16 i_width;
379     s16 i_height;
380
381     u32 i_horizresolution;
382     u32 i_vertresolution;
383
384     u32 i_reserved3;
385     u16 i_predefined3;
386     
387     u8  i_compressorname[32];
388     s16 i_depth;
389
390     s16 i_predefined4;
391     
392 } MP4_Box_data_sample_mp4v_t;
393
394
395
396 typedef struct MP4_Box_data_sample_hint_s
397 {
398     u8  i_reserved1[6];
399     u16 i_data_reference_index;
400
401     u8 *p_data;
402
403 } MP4_Box_data_sample_hint_t;
404
405 typedef struct MP4_Box_data_moviehintinformation_rtp_s
406 {
407     u32 i_description_format;
408     unsigned char *psz_text;
409
410 } MP4_Box_data_moviehintinformation_rtp_t;
411
412
413
414 typedef struct MP4_Box_data_stsd_s
415 {
416     u8  i_version;
417     u32 i_flags;
418     
419     u32 i_entry_count;
420
421     /* it contains SampleEntry handled as if it was Box */
422     
423 } MP4_Box_data_stsd_t;
424
425
426 typedef struct MP4_Box_data_stsz_s
427 {
428     u8  i_version;
429     u32 i_flags;
430
431     u32 i_sample_size;
432     u32 i_sample_count;
433    
434     u32 *i_entry_size; /* array , empty if i_sample_size != 0 */
435
436 } MP4_Box_data_stsz_t;
437
438 typedef struct MP4_Box_data_stz2_s
439 {
440     u8  i_version;
441     u32 i_flags;
442
443     u32 i_sample_size; /* 24 bits */
444     u8  i_field_size;
445     u32 i_sample_count;
446
447     u32 *i_entry_size; /* array: unsigned int(i_field_size) entry_size */
448
449 } MP4_Box_data_stz2_t;
450
451 typedef struct MP4_Box_data_stsc_s
452 {
453     u8  i_version;
454     u32 i_flags;
455
456     u32 i_entry_count;
457
458     u32 *i_first_chunk; /* theses are arrays */
459     u32 *i_samples_per_chunk;
460     u32 *i_sample_description_index;
461     
462 } MP4_Box_data_stsc_t;
463
464
465 typedef struct MP4_Box_data_co64_s
466 {
467     u8  i_version;
468     u32 i_flags;
469
470     u32 i_entry_count;
471     
472     u64 *i_chunk_offset;
473
474 } MP4_Box_data_co64_t;
475
476
477 typedef struct MP4_Box_data_stss_s
478 {
479     u8  i_version;
480     u32 i_flags;
481     
482     u32 i_entry_count;
483     
484     u32 *i_sample_number;
485     
486 } MP4_Box_data_stss_t;
487
488 typedef struct MP4_Box_data_stsh_s
489 {
490     u8  i_version;
491     u32 i_flags;
492
493     u32 i_entry_count;
494     
495     u32 *i_shadowed_sample_number;
496     u32 *i_sync_sample_number;
497
498 } MP4_Box_data_stsh_t;
499
500 typedef struct MP4_Box_data_stdp_s
501 {
502     u8  i_version;
503     u32 i_flags;
504
505     u16 *i_priority;
506
507 } MP4_Box_data_stdp_t;
508
509 typedef struct MP4_Box_data_padb_s
510 {
511     u8  i_version;
512     u32 i_flags;
513
514     u32 i_sample_count;
515
516     u16 *i_reserved1;   /* 1bit  */
517     u16 *i_pad2;        /* 3bits */
518     u16 *i_reserved2;   /* 1bit  */
519     u16 *i_pad1;        /* 3bits */
520     
521
522 } MP4_Box_data_padb_t;
523
524
525 typedef struct MP4_Box_data_elst_s
526 {
527     u8  i_version;
528     u32 i_flags;
529
530     u32 i_entry_count;
531
532     u64 *i_segment_duration;
533     s64 *i_media_time;
534     u16 *i_media_rate_integer;
535     u16 *i_media_rate_fraction;
536
537     
538 } MP4_Box_data_elst_t;
539
540 typedef struct MP4_Box_data_cprt_s
541 {
542     u8  i_version;
543     u32 i_flags;
544     /* 1 pad bit */
545     unsigned char i_language[3];
546     
547     unsigned char *psz_notice;
548 } MP4_Box_data_cprt_t;
549
550
551 /* DecoderConfigDescriptor */
552 typedef struct MP4_descriptor_decoder_config_s
553 {
554     u8  i_objectTypeIndication;
555     u8  i_streamType;
556     int b_upStream;
557     int i_buffer_sizeDB;
558     int i_max_bitrate;
559     int i_avg_bitrate;
560     
561     int i_decoder_specific_info_len;
562     u8  *p_decoder_specific_info;
563     /* some other stuff */
564     
565 } MP4_descriptor_decoder_config_t;
566
567 typedef struct MP4_descriptor_SL_config_s
568 {
569     
570 } MP4_descriptor_SL_config_t;
571
572
573 typedef struct MP4_descriptor_ES_s
574 {
575     u16 i_ES_ID;
576     int b_stream_dependence;
577     int b_url;
578     int b_OCRstream;
579     int i_stream_priority;
580
581     int i_depend_on_ES_ID; /* if b_stream_dependence set */
582
583     unsigned char *psz_URL;
584
585     u16 i_OCR_ES_ID;       /* if b_OCRstream */
586     MP4_descriptor_decoder_config_t *p_decConfigDescr;
587     
588     MP4_descriptor_SL_config_t *p_slConfigDescr;
589
590     /* some other stuff ... */
591
592 } MP4_descriptor_ES_t;
593
594 /* ES descriptor */
595 typedef struct MP4_Box_data_esds_s
596 {
597     u8  i_version;
598     u32 i_flags;
599     
600     MP4_descriptor_ES_t es_descriptor;
601     
602 } MP4_Box_data_esds_t;
603
604
605 typedef struct MP4_Box_data_dcom_s
606 {
607     u32 i_algorithm; /* fourcc */
608     
609 } MP4_Box_data_dcom_t;
610
611 typedef struct MP4_Box_data_cmvd_s
612 {
613     u32 i_uncompressed_size;
614     u32 i_compressed_size;
615
616     int b_compressed; /* Set to 1 if compressed data, 0 if uncompressed */
617     u8 *p_data;
618
619 } MP4_Box_data_cmvd_t;
620
621 typedef struct MP4_Box_data_cmov_s
622 {
623     struct MP4_Box_s *p_moov; /* uncompressed moov */
624     
625 } MP4_Box_data_cmov_t;
626
627 /*
628 typedef struct MP4_Box_data_cmov_s
629 {
630     u8  i_version;
631     u32 i_flags;
632
633 } MP4_Box_data__t;
634
635 */
636
637 typedef union MP4_Box_data_s
638 {
639     MP4_Box_data_ftyp_t *p_ftyp;
640     MP4_Box_data_mvhd_t *p_mvhd;
641     MP4_Box_data_tkhd_t *p_tkhd;
642     MP4_Box_data_mdhd_t *p_mdhd;
643     MP4_Box_data_hdlr_t *p_hdlr;
644     MP4_Box_data_vmhd_t *p_vmhd;
645     MP4_Box_data_smhd_t *p_smhd;
646     MP4_Box_data_hmhd_t *p_hmhd;
647     MP4_Box_data_url_t  *p_url;
648     MP4_Box_data_urn_t  *p_urn;
649     MP4_Box_data_dref_t *p_dref;
650     MP4_Box_data_stts_t *p_stts;
651     MP4_Box_data_ctts_t *p_ctts;
652     MP4_Box_data_stsd_t *p_stsd;
653         MP4_Box_data_sample_vide_t *p_sample_vide;
654         MP4_Box_data_sample_vide_t *p_sample_mp4v;
655         MP4_Box_data_sample_soun_t *p_sample_soun;
656         MP4_Box_data_sample_soun_t *p_sample_mp4a;
657         MP4_Box_data_sample_hint_t *p_sample_hint;
658
659         MP4_Box_data_esds_t *p_esds;
660
661     MP4_Box_data_stsz_t *p_stsz;
662     MP4_Box_data_stz2_t *p_stz2;
663     MP4_Box_data_stsc_t *p_stsc;
664     MP4_Box_data_co64_t *p_co64;
665     MP4_Box_data_stss_t *p_stss;
666     MP4_Box_data_stsh_t *p_stsh;
667     MP4_Box_data_stdp_t *p_stdp;
668     MP4_Box_data_padb_t *p_padb;
669     MP4_Box_data_elst_t *p_elst;
670     MP4_Box_data_cprt_t *p_cprt;
671
672     MP4_Box_data_dcom_t *p_dcom;
673     MP4_Box_data_cmvd_t *p_cmvd;
674     MP4_Box_data_cmov_t *p_cmov;
675
676     MP4_Box_data_moviehintinformation_rtp_t p_moviehintinformation_rtp;
677     
678     void                *p_data; /* for unknow type */
679 } MP4_Box_data_t;
680
681
682
683 /* the most basic structure */
684 typedef struct MP4_Box_s
685 {
686     off_t   i_pos;      /* absolute position */
687     
688     u32     i_type;
689     u32     i_shortsize;
690
691     UUID_t  i_uuid;  /* Set if i_type == "uuid" */
692     
693     u64     i_size; /* always set so use it */
694
695     MP4_Box_data_t   data;   /* union of pointers on extended data depending on i_type (or i_usertype) */
696
697     struct MP4_Box_s *p_father; /* pointer on the father Box */
698
699     struct MP4_Box_s *p_first;  /* pointer on the first child Box */
700     struct MP4_Box_s *p_last;
701
702     struct MP4_Box_s *p_next;   /* pointer on the next boxes at the same level */
703
704 } MP4_Box_t;
705
706 /*---------------------------------------------------------------------------*/
707 /****----------------------- High level functions ------------------------****/
708 /*---------------------------------------------------------------------------*/
709
710 /*****************************************************************************
711  * Function for manipulate stream easily
712  *****************************************************************************/
713
714 off_t MP4_TellAbsolute( input_thread_t *p_input );
715 int   MP4_SeekAbsolute( input_thread_t *p_input, off_t i_pos);
716 int   MP4_ReadData( input_thread_t *p_input, u8 *p_buff, int i_size );
717
718 /*****************************************************************************
719  * MP4_ReadRoot : Parse the entire file, and create all boxes in memory
720  *****************************************************************************
721  *  The first box is a virtual box "root" and is the father for all first 
722  *  level boxes 
723  *
724  *  RETURN : 1 if succes and 0 if it failed
725  *****************************************************************************/
726 int MP4_ReadBoxRoot( input_thread_t *p_input, MP4_Box_t *p_root );
727
728 /*****************************************************************************
729  * MP4_FreeBox : free memory allocated after read with MP4_ReadBox
730  *               this, means also children boxes
731  * XXX : all children have to be allocated by a malloc !! and 
732  *         p_box isn't freeing  
733  *****************************************************************************/
734 void MP4_FreeBox( input_thread_t *p_input, MP4_Box_t *p_box );
735
736 /*****************************************************************************
737  * MP4_DumpBoxStructure: print the structure of the p_box
738  *****************************************************************************/
739 void MP4_DumpBoxStructure( input_thread_t *p_input, MP4_Box_t *p_box );
740
741 /*****************************************************************************
742  * MP4_CountBox: given a box, count how many child have the requested type 
743  * FIXME : support GUUID 
744  *****************************************************************************/
745 int MP4_CountBox( MP4_Box_t *p_box, u32 i_type );
746     
747 /*****************************************************************************
748  * MP4_FindBox:  find first box with i_type child of p_box
749  *      return NULL if not found
750  *****************************************************************************/
751 MP4_Box_t *MP4_FindBox( MP4_Box_t *p_box, u32 i_type );
752
753 /*****************************************************************************
754  * MP4_FindNextBox:  find next box with thesame type and at the same level 
755  *                  than p_box
756  *****************************************************************************/
757 MP4_Box_t *MP4_FindNextBox( MP4_Box_t *p_box );
758
759 /*****************************************************************************
760  * MP4_FindNbBox:  find the box i_number 
761  *****************************************************************************/
762 MP4_Box_t *MP4_FindNbBox( MP4_Box_t *p_box, u32 i_number );
763    
764
765 /*---------------------------------------------------------------------------*/
766 /****----------------------- Lower level functions -----------------------****/
767 /****                                                                     ****/
768 /****------Use them only when you known what they really do and need------****/  
769 /****                                                                     ****/
770 /****---------------------------------------------------------------------****/
771 /*---------------------------------------------------------------------------*/
772
773
774 /****  ------- First some function to make abstract from input --------  */
775
776 /****************************************************************************
777  * MP4_InputStream create an stram with an input
778  *
779  ****************************************************************************/
780 MP4_Stream_t *MP4_InputStream( input_thread_t *p_input );
781
782 /****************************************************************************
783  * MP4_MemoryStream create a memory stream
784  * if p_buffer == NULL, will allocate a buffer of i_size, else 
785  *     it uses p_buffer XXX you have to unallocate yourself !
786  *
787  ****************************************************************************/
788 MP4_Stream_t *MP4_MemoryStream( input_thread_t *p_input,
789                                 int i_size, u8 *p_buffer );
790
791 /****************************************************************************
792  * MP4_ReadStream read from a MP4_Stream_t
793  *
794  ****************************************************************************/
795 int MP4_ReadStream( MP4_Stream_t *p_stream, u8 *p_buff, int i_size );
796
797 /****************************************************************************
798  * MP4_PeekStream guess it ;)
799  *
800  ****************************************************************************/
801 int MP4_PeekStream( MP4_Stream_t *p_stream, u8 **pp_peek, int i_size );
802     
803 /****************************************************************************
804  * MP4_TellStream give absolute position in the stream
805  * XXX for a memory stream give position from begining of the buffer
806  ****************************************************************************/
807 off_t MP4_TellStream( MP4_Stream_t *p_stream );
808
809 /****************************************************************************
810  * MP4_SeekStream seek in a MP4_Stream_t
811  *
812  ****************************************************************************/
813 int MP4_SeekStream( MP4_Stream_t *p_stream, off_t i_pos);
814
815
816
817 /*****************************************************************************
818  * MP4_ReadBox : parse the actual box and the children if they exist
819  *  
820  *  RETURN : 1 if succes and 0 if it failed
821  *****************************************************************************/
822 int MP4_ReadBox( MP4_Stream_t *p_stream, MP4_Box_t *p_box, MP4_Box_t *p_father );
823
824
825 /*****************************************************************************
826  * MP4_ReadBoxCommon : Load only common parameters for all boxes 
827  *****************************************************************************
828  * p_box need to be an already allocated MP4_Box_t, and all data 
829  *  will only be peek not read
830  *
831  * RETURN : 0 if it fail, 1 otherwise
832  *****************************************************************************/
833 int MP4_ReadBoxCommon( MP4_Stream_t *p_stream, MP4_Box_t *p_box );
834
835
836 /*****************************************************************************
837  * MP4_MP4_GotoBox : Go to this particular box 
838  *****************************************************************************
839  * RETURN : 0 if it fail, 1 otherwise
840  *****************************************************************************/
841 int MP4_GotoBox( MP4_Stream_t *p_stream, MP4_Box_t *p_box );
842
843     
844 /*****************************************************************************
845  * MP4_MP4_NextBox : Go to the next box wiithin p_box->p_father 
846  *****************************************************************************
847  * if p_box == NULL, go to the next box in witch we are( at the begining ).
848  *****************************************************************************/
849 int MP4_NextBox( MP4_Stream_t *p_stream, MP4_Box_t *p_box );
850
851