lavf/mov: add support for sidx fragment indexes
[ffmpeg.git] / libavformat / isom.h
1 /*
2  * ISO Media common code
3  * copyright (c) 2001 Fabrice Bellard
4  * copyright (c) 2002 Francois Revol <revol@free.fr>
5  * copyright (c) 2006 Baptiste Coudurier <baptiste.coudurier@free.fr>
6  *
7  * This file is part of FFmpeg.
8  *
9  * FFmpeg is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * FFmpeg is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with FFmpeg; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  */
23
24 #ifndef AVFORMAT_ISOM_H
25 #define AVFORMAT_ISOM_H
26
27 #include "avio.h"
28 #include "internal.h"
29 #include "dv.h"
30
31 /* isom.c */
32 extern const AVCodecTag ff_mp4_obj_type[];
33 extern const AVCodecTag ff_codec_movvideo_tags[];
34 extern const AVCodecTag ff_codec_movaudio_tags[];
35 extern const AVCodecTag ff_codec_movsubtitle_tags[];
36
37 int ff_mov_iso639_to_lang(const char lang[4], int mp4);
38 int ff_mov_lang_to_iso639(unsigned code, char to[4]);
39
40 /* the QuickTime file format is quite convoluted...
41  * it has lots of index tables, each indexing something in another one...
42  * Here we just use what is needed to read the chunks
43  */
44
45 typedef struct MOVStts {
46     int count;
47     int duration;
48 } MOVStts;
49
50 typedef struct MOVStsc {
51     int first;
52     int count;
53     int id;
54 } MOVStsc;
55
56 typedef struct MOVElst {
57     int64_t duration;
58     int64_t time;
59     float rate;
60 } MOVElst;
61
62 typedef struct MOVDref {
63     uint32_t type;
64     char *path;
65     char *dir;
66     char volume[28];
67     char filename[64];
68     int16_t nlvl_to, nlvl_from;
69 } MOVDref;
70
71 typedef struct MOVAtom {
72     uint32_t type;
73     int64_t size; /* total size (excluding the size and type fields) */
74 } MOVAtom;
75
76 struct MOVParseTableEntry;
77
78 typedef struct MOVFragment {
79     unsigned track_id;
80     uint64_t base_data_offset;
81     uint64_t moof_offset;
82     uint64_t implicit_offset;
83     unsigned stsd_id;
84     unsigned duration;
85     unsigned size;
86     unsigned flags;
87     int64_t time;
88 } MOVFragment;
89
90 typedef struct MOVTrackExt {
91     unsigned track_id;
92     unsigned stsd_id;
93     unsigned duration;
94     unsigned size;
95     unsigned flags;
96 } MOVTrackExt;
97
98 typedef struct MOVSbgp {
99     unsigned int count;
100     unsigned int index;
101 } MOVSbgp;
102
103 typedef struct MOVFragmentIndexItem {
104     int64_t moof_offset;
105     int64_t time;
106     int headers_read;
107 } MOVFragmentIndexItem;
108
109 typedef struct MOVFragmentIndex {
110     unsigned track_id;
111     unsigned item_count;
112     unsigned current_item;
113     MOVFragmentIndexItem *items;
114 } MOVFragmentIndex;
115
116 typedef struct MOVStreamContext {
117     AVIOContext *pb;
118     int pb_is_copied;
119     int ffindex;          ///< AVStream index
120     int next_chunk;
121     unsigned int chunk_count;
122     int64_t *chunk_offsets;
123     unsigned int stts_count;
124     MOVStts *stts_data;
125     unsigned int ctts_count;
126     MOVStts *ctts_data;
127     unsigned int stsc_count;
128     MOVStsc *stsc_data;
129     unsigned int stps_count;
130     unsigned *stps_data;  ///< partial sync sample for mpeg-2 open gop
131     MOVElst *elst_data;
132     unsigned int elst_count;
133     int ctts_index;
134     int ctts_sample;
135     unsigned int sample_size; ///< may contain value calculated from stsd or value from stsz atom
136     unsigned int stsz_sample_size; ///< always contains sample size from stsz atom
137     unsigned int sample_count;
138     int *sample_sizes;
139     int keyframe_absent;
140     unsigned int keyframe_count;
141     int *keyframes;
142     int time_scale;
143     int64_t time_offset;  ///< time offset of the edit list entries
144     int current_sample;
145     unsigned int bytes_per_frame;
146     unsigned int samples_per_frame;
147     int dv_audio_container;
148     int pseudo_stream_id; ///< -1 means demux all ids
149     int16_t audio_cid;    ///< stsd audio compression id
150     unsigned drefs_count;
151     MOVDref *drefs;
152     int dref_id;
153     int timecode_track;
154     int wrong_dts;        ///< dts are wrong due to huge ctts offset (iMovie files)
155     int width;            ///< tkhd width
156     int height;           ///< tkhd height
157     int dts_shift;        ///< dts shift when ctts is negative
158     uint32_t palette[256];
159     int has_palette;
160     int64_t data_size;
161     uint32_t tmcd_flags;  ///< tmcd track flags
162     int64_t track_end;    ///< used for dts generation in fragmented movie files
163     int start_pad;        ///< amount of samples to skip due to enc-dec delay
164     unsigned int rap_group_count;
165     MOVSbgp *rap_group;
166
167     int nb_frames_for_fps;
168     int64_t duration_for_fps;
169
170     int32_t *display_matrix;
171 } MOVStreamContext;
172
173 typedef struct MOVContext {
174     const AVClass *class; ///< class for private options
175     AVFormatContext *fc;
176     int time_scale;
177     int64_t duration;     ///< duration of the longest track
178     int found_moov;       ///< 'moov' atom has been found
179     int found_mdat;       ///< 'mdat' atom has been found
180     DVDemuxContext *dv_demux;
181     AVFormatContext *dv_fctx;
182     int isom;             ///< 1 if file is ISO Media (mp4/3gp)
183     MOVFragment fragment; ///< current fragment in moof atom
184     MOVTrackExt *trex_data;
185     unsigned trex_count;
186     int itunes_metadata;  ///< metadata are itunes style
187     int chapter_track;
188     int use_absolute_path;
189     int ignore_editlist;
190     int seek_individually;
191     int64_t next_root_atom; ///< offset of the next root atom
192     int export_all;
193     int export_xmp;
194     int *bitrates;          ///< bitrates read before streams creation
195     int bitrates_count;
196     int moov_retry;
197     int use_mfra_for;
198     int has_looked_for_mfra;
199     MOVFragmentIndex** fragment_index_data;
200     unsigned fragment_index_count;
201     int fragment_index_complete;
202     int atom_depth;
203     unsigned int aax_mode;  ///< 'aax' file has been detected
204     uint8_t file_key[20];
205     uint8_t file_iv[20];
206     void *activation_bytes;
207     int activation_bytes_size;
208     void *audible_fixed_key;
209     int audible_fixed_key_size;
210     struct AVAES *aes_decrypt;
211 } MOVContext;
212
213 int ff_mp4_read_descr_len(AVIOContext *pb);
214 int ff_mp4_read_descr(AVFormatContext *fc, AVIOContext *pb, int *tag);
215 int ff_mp4_read_dec_config_descr(AVFormatContext *fc, AVStream *st, AVIOContext *pb);
216 void ff_mp4_parse_es_descr(AVIOContext *pb, int *es_id);
217
218 #define MP4ODescrTag                    0x01
219 #define MP4IODescrTag                   0x02
220 #define MP4ESDescrTag                   0x03
221 #define MP4DecConfigDescrTag            0x04
222 #define MP4DecSpecificDescrTag          0x05
223 #define MP4SLDescrTag                   0x06
224
225 #define MOV_TFHD_BASE_DATA_OFFSET       0x01
226 #define MOV_TFHD_STSD_ID                0x02
227 #define MOV_TFHD_DEFAULT_DURATION       0x08
228 #define MOV_TFHD_DEFAULT_SIZE           0x10
229 #define MOV_TFHD_DEFAULT_FLAGS          0x20
230 #define MOV_TFHD_DURATION_IS_EMPTY  0x010000
231 #define MOV_TFHD_DEFAULT_BASE_IS_MOOF 0x020000
232
233 #define MOV_TRUN_DATA_OFFSET            0x01
234 #define MOV_TRUN_FIRST_SAMPLE_FLAGS     0x04
235 #define MOV_TRUN_SAMPLE_DURATION       0x100
236 #define MOV_TRUN_SAMPLE_SIZE           0x200
237 #define MOV_TRUN_SAMPLE_FLAGS          0x400
238 #define MOV_TRUN_SAMPLE_CTS            0x800
239
240 #define MOV_FRAG_SAMPLE_FLAG_DEGRADATION_PRIORITY_MASK 0x0000ffff
241 #define MOV_FRAG_SAMPLE_FLAG_IS_NON_SYNC               0x00010000
242 #define MOV_FRAG_SAMPLE_FLAG_PADDING_MASK              0x000e0000
243 #define MOV_FRAG_SAMPLE_FLAG_REDUNDANCY_MASK           0x00300000
244 #define MOV_FRAG_SAMPLE_FLAG_DEPENDED_MASK             0x00c00000
245 #define MOV_FRAG_SAMPLE_FLAG_DEPENDS_MASK              0x03000000
246
247 #define MOV_FRAG_SAMPLE_FLAG_DEPENDS_NO                0x02000000
248 #define MOV_FRAG_SAMPLE_FLAG_DEPENDS_YES               0x01000000
249
250 #define MOV_TKHD_FLAG_ENABLED       0x0001
251 #define MOV_TKHD_FLAG_IN_MOVIE      0x0002
252 #define MOV_TKHD_FLAG_IN_PREVIEW    0x0004
253 #define MOV_TKHD_FLAG_IN_POSTER     0x0008
254
255 #define TAG_IS_AVCI(tag)                    \
256     ((tag) == MKTAG('a', 'i', '5', 'p') ||  \
257      (tag) == MKTAG('a', 'i', '5', 'q') ||  \
258      (tag) == MKTAG('a', 'i', '5', '2') ||  \
259      (tag) == MKTAG('a', 'i', '5', '3') ||  \
260      (tag) == MKTAG('a', 'i', '5', '5') ||  \
261      (tag) == MKTAG('a', 'i', '5', '6') ||  \
262      (tag) == MKTAG('a', 'i', '1', 'p') ||  \
263      (tag) == MKTAG('a', 'i', '1', 'q') ||  \
264      (tag) == MKTAG('a', 'i', '1', '2') ||  \
265      (tag) == MKTAG('a', 'i', '1', '3') ||  \
266      (tag) == MKTAG('a', 'i', '1', '5') ||  \
267      (tag) == MKTAG('a', 'i', '1', '6') ||  \
268      (tag) == MKTAG('a', 'i', 'v', 'x') ||  \
269      (tag) == MKTAG('A', 'V', 'i', 'n'))
270
271
272 int ff_mov_read_esds(AVFormatContext *fc, AVIOContext *pb);
273 enum AVCodecID ff_mov_get_lpcm_codec_id(int bps, int flags);
274
275 int ff_mov_read_stsd_entries(MOVContext *c, AVIOContext *pb, int entries);
276 void ff_mov_write_chan(AVIOContext *pb, int64_t channel_layout);
277
278 #define FF_MOV_FLAG_MFRA_AUTO -1
279 #define FF_MOV_FLAG_MFRA_DTS 1
280 #define FF_MOV_FLAG_MFRA_PTS 2
281
282 #endif /* AVFORMAT_ISOM_H */