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