lavf/mov: improve `tref/chap` chapter handling
[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 struct AVAESCTR;
41
42 /* the QuickTime file format is quite convoluted...
43  * it has lots of index tables, each indexing something in another one...
44  * Here we just use what is needed to read the chunks
45  */
46
47 typedef struct MOVStts {
48     int count;
49     int duration;
50 } MOVStts;
51
52 typedef struct MOVStsc {
53     int first;
54     int count;
55     int id;
56 } MOVStsc;
57
58 typedef struct MOVElst {
59     int64_t duration;
60     int64_t time;
61     float rate;
62 } MOVElst;
63
64 typedef struct MOVDref {
65     uint32_t type;
66     char *path;
67     char *dir;
68     char volume[28];
69     char filename[64];
70     int16_t nlvl_to, nlvl_from;
71 } MOVDref;
72
73 typedef struct MOVAtom {
74     uint32_t type;
75     int64_t size; /* total size (excluding the size and type fields) */
76 } MOVAtom;
77
78 struct MOVParseTableEntry;
79
80 typedef struct MOVFragment {
81     unsigned track_id;
82     uint64_t base_data_offset;
83     uint64_t moof_offset;
84     uint64_t implicit_offset;
85     unsigned stsd_id;
86     unsigned duration;
87     unsigned size;
88     unsigned flags;
89     int64_t time;
90 } MOVFragment;
91
92 typedef struct MOVTrackExt {
93     unsigned track_id;
94     unsigned stsd_id;
95     unsigned duration;
96     unsigned size;
97     unsigned flags;
98 } MOVTrackExt;
99
100 typedef struct MOVSbgp {
101     unsigned int count;
102     unsigned int index;
103 } MOVSbgp;
104
105 typedef struct MOVFragmentIndexItem {
106     int64_t moof_offset;
107     int64_t time;
108     int headers_read;
109 } MOVFragmentIndexItem;
110
111 typedef struct MOVFragmentIndex {
112     unsigned track_id;
113     unsigned item_count;
114     unsigned current_item;
115     MOVFragmentIndexItem *items;
116 } MOVFragmentIndex;
117
118 typedef struct MOVStreamContext {
119     AVIOContext *pb;
120     int pb_is_copied;
121     int ffindex;          ///< AVStream index
122     int next_chunk;
123     unsigned int chunk_count;
124     int64_t *chunk_offsets;
125     unsigned int stts_count;
126     MOVStts *stts_data;
127     unsigned int ctts_count;
128     MOVStts *ctts_data;
129     unsigned int stsc_count;
130     MOVStsc *stsc_data;
131     int stsc_index;
132     int stsc_sample;
133     unsigned int stps_count;
134     unsigned *stps_data;  ///< partial sync sample for mpeg-2 open gop
135     MOVElst *elst_data;
136     unsigned int elst_count;
137     int ctts_index;
138     int ctts_sample;
139     unsigned int sample_size; ///< may contain value calculated from stsd or value from stsz atom
140     unsigned int stsz_sample_size; ///< always contains sample size from stsz atom
141     unsigned int sample_count;
142     int *sample_sizes;
143     int keyframe_absent;
144     unsigned int keyframe_count;
145     int *keyframes;
146     int time_scale;
147     int64_t time_offset;  ///< time offset of the edit list entries
148     int current_sample;
149     unsigned int bytes_per_frame;
150     unsigned int samples_per_frame;
151     int dv_audio_container;
152     int pseudo_stream_id; ///< -1 means demux all ids
153     int16_t audio_cid;    ///< stsd audio compression id
154     unsigned drefs_count;
155     MOVDref *drefs;
156     int dref_id;
157     int timecode_track;
158     int width;            ///< tkhd width
159     int height;           ///< tkhd height
160     int dts_shift;        ///< dts shift when ctts is negative
161     uint32_t palette[256];
162     int has_palette;
163     int64_t data_size;
164     uint32_t tmcd_flags;  ///< tmcd track flags
165     int64_t track_end;    ///< used for dts generation in fragmented movie files
166     int start_pad;        ///< amount of samples to skip due to enc-dec delay
167     unsigned int rap_group_count;
168     MOVSbgp *rap_group;
169
170     int nb_frames_for_fps;
171     int64_t duration_for_fps;
172
173     /** extradata array (and size) for multiple stsd */
174     uint8_t **extradata;
175     int *extradata_size;
176     int last_stsd_index;
177     int stsd_count;
178
179     int32_t *display_matrix;
180     uint32_t format;
181
182     struct {
183         int use_subsamples;
184         uint8_t* auxiliary_info;
185         uint8_t* auxiliary_info_end;
186         uint8_t* auxiliary_info_pos;
187         uint8_t auxiliary_info_default_size;
188         uint8_t* auxiliary_info_sizes;
189         size_t auxiliary_info_sizes_count;
190         struct AVAESCTR* aes_ctr;
191     } cenc;
192 } MOVStreamContext;
193
194 typedef struct MOVContext {
195     const AVClass *class; ///< class for private options
196     AVFormatContext *fc;
197     int time_scale;
198     int64_t duration;     ///< duration of the longest track
199     int found_moov;       ///< 'moov' atom has been found
200     int found_mdat;       ///< 'mdat' atom has been found
201     int found_hdlr_mdta;  ///< 'hdlr' atom with type 'mdta' has been found
202     int trak_index;       ///< Index of the current 'trak'
203     char **meta_keys;
204     unsigned meta_keys_count;
205     DVDemuxContext *dv_demux;
206     AVFormatContext *dv_fctx;
207     int isom;             ///< 1 if file is ISO Media (mp4/3gp)
208     MOVFragment fragment; ///< current fragment in moof atom
209     MOVTrackExt *trex_data;
210     unsigned trex_count;
211     int itunes_metadata;  ///< metadata are itunes style
212     int handbrake_version;
213     int *chapter_tracks;
214     unsigned int nb_chapter_tracks;
215     int use_absolute_path;
216     int ignore_editlist;
217     int ignore_chapters;
218     int seek_individually;
219     int64_t next_root_atom; ///< offset of the next root atom
220     int export_all;
221     int export_xmp;
222     int *bitrates;          ///< bitrates read before streams creation
223     int bitrates_count;
224     int moov_retry;
225     int use_mfra_for;
226     int has_looked_for_mfra;
227     MOVFragmentIndex** fragment_index_data;
228     unsigned fragment_index_count;
229     int fragment_index_complete;
230     int atom_depth;
231     unsigned int aax_mode;  ///< 'aax' file has been detected
232     uint8_t file_key[20];
233     uint8_t file_iv[20];
234     void *activation_bytes;
235     int activation_bytes_size;
236     void *audible_fixed_key;
237     int audible_fixed_key_size;
238     struct AVAES *aes_decrypt;
239     uint8_t *decryption_key;
240     int decryption_key_len;
241     int enable_drefs;
242 } MOVContext;
243
244 int ff_mp4_read_descr_len(AVIOContext *pb);
245 int ff_mp4_read_descr(AVFormatContext *fc, AVIOContext *pb, int *tag);
246 int ff_mp4_read_dec_config_descr(AVFormatContext *fc, AVStream *st, AVIOContext *pb);
247 void ff_mp4_parse_es_descr(AVIOContext *pb, int *es_id);
248
249 #define MP4ODescrTag                    0x01
250 #define MP4IODescrTag                   0x02
251 #define MP4ESDescrTag                   0x03
252 #define MP4DecConfigDescrTag            0x04
253 #define MP4DecSpecificDescrTag          0x05
254 #define MP4SLDescrTag                   0x06
255
256 #define MOV_TFHD_BASE_DATA_OFFSET       0x01
257 #define MOV_TFHD_STSD_ID                0x02
258 #define MOV_TFHD_DEFAULT_DURATION       0x08
259 #define MOV_TFHD_DEFAULT_SIZE           0x10
260 #define MOV_TFHD_DEFAULT_FLAGS          0x20
261 #define MOV_TFHD_DURATION_IS_EMPTY  0x010000
262 #define MOV_TFHD_DEFAULT_BASE_IS_MOOF 0x020000
263
264 #define MOV_TRUN_DATA_OFFSET            0x01
265 #define MOV_TRUN_FIRST_SAMPLE_FLAGS     0x04
266 #define MOV_TRUN_SAMPLE_DURATION       0x100
267 #define MOV_TRUN_SAMPLE_SIZE           0x200
268 #define MOV_TRUN_SAMPLE_FLAGS          0x400
269 #define MOV_TRUN_SAMPLE_CTS            0x800
270
271 #define MOV_FRAG_SAMPLE_FLAG_DEGRADATION_PRIORITY_MASK 0x0000ffff
272 #define MOV_FRAG_SAMPLE_FLAG_IS_NON_SYNC               0x00010000
273 #define MOV_FRAG_SAMPLE_FLAG_PADDING_MASK              0x000e0000
274 #define MOV_FRAG_SAMPLE_FLAG_REDUNDANCY_MASK           0x00300000
275 #define MOV_FRAG_SAMPLE_FLAG_DEPENDED_MASK             0x00c00000
276 #define MOV_FRAG_SAMPLE_FLAG_DEPENDS_MASK              0x03000000
277
278 #define MOV_FRAG_SAMPLE_FLAG_DEPENDS_NO                0x02000000
279 #define MOV_FRAG_SAMPLE_FLAG_DEPENDS_YES               0x01000000
280
281 #define MOV_TKHD_FLAG_ENABLED       0x0001
282 #define MOV_TKHD_FLAG_IN_MOVIE      0x0002
283 #define MOV_TKHD_FLAG_IN_PREVIEW    0x0004
284 #define MOV_TKHD_FLAG_IN_POSTER     0x0008
285
286 #define TAG_IS_AVCI(tag)                    \
287     ((tag) == MKTAG('a', 'i', '5', 'p') ||  \
288      (tag) == MKTAG('a', 'i', '5', 'q') ||  \
289      (tag) == MKTAG('a', 'i', '5', '2') ||  \
290      (tag) == MKTAG('a', 'i', '5', '3') ||  \
291      (tag) == MKTAG('a', 'i', '5', '5') ||  \
292      (tag) == MKTAG('a', 'i', '5', '6') ||  \
293      (tag) == MKTAG('a', 'i', '1', 'p') ||  \
294      (tag) == MKTAG('a', 'i', '1', 'q') ||  \
295      (tag) == MKTAG('a', 'i', '1', '2') ||  \
296      (tag) == MKTAG('a', 'i', '1', '3') ||  \
297      (tag) == MKTAG('a', 'i', '1', '5') ||  \
298      (tag) == MKTAG('a', 'i', '1', '6') ||  \
299      (tag) == MKTAG('a', 'i', 'v', 'x') ||  \
300      (tag) == MKTAG('A', 'V', 'i', 'n'))
301
302
303 int ff_mov_read_esds(AVFormatContext *fc, AVIOContext *pb);
304 enum AVCodecID ff_mov_get_lpcm_codec_id(int bps, int flags);
305
306 int ff_mov_read_stsd_entries(MOVContext *c, AVIOContext *pb, int entries);
307 void ff_mov_write_chan(AVIOContext *pb, int64_t channel_layout);
308
309 #define FF_MOV_FLAG_MFRA_AUTO -1
310 #define FF_MOV_FLAG_MFRA_DTS 1
311 #define FF_MOV_FLAG_MFRA_PTS 2
312
313 #endif /* AVFORMAT_ISOM_H */