avformat/mov: add support for reading Mastering Display Metadata Box
[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     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     MOVStts *ctts_data;
141     unsigned int stsc_count;
142     MOVStsc *stsc_data;
143     int stsc_index;
144     int stsc_sample;
145     unsigned int stps_count;
146     unsigned *stps_data;  ///< partial sync sample for mpeg-2 open gop
147     MOVElst *elst_data;
148     unsigned int elst_count;
149     int ctts_index;
150     int ctts_sample;
151     unsigned int sample_size; ///< may contain value calculated from stsd or value from stsz atom
152     unsigned int stsz_sample_size; ///< always contains sample size from stsz atom
153     unsigned int sample_count;
154     int *sample_sizes;
155     int keyframe_absent;
156     unsigned int keyframe_count;
157     int *keyframes;
158     int time_scale;
159     int64_t time_offset;  ///< time offset of the edit list entries
160     int current_sample;
161     int64_t current_index;
162     MOVIndexRange* index_ranges;
163     MOVIndexRange* current_index_range;
164     unsigned int bytes_per_frame;
165     unsigned int samples_per_frame;
166     int dv_audio_container;
167     int pseudo_stream_id; ///< -1 means demux all ids
168     int16_t audio_cid;    ///< stsd audio compression id
169     unsigned drefs_count;
170     MOVDref *drefs;
171     int dref_id;
172     int timecode_track;
173     int width;            ///< tkhd width
174     int height;           ///< tkhd height
175     int dts_shift;        ///< dts shift when ctts is negative
176     uint32_t palette[256];
177     int has_palette;
178     int64_t data_size;
179     uint32_t tmcd_flags;  ///< tmcd track flags
180     int64_t track_end;    ///< used for dts generation in fragmented movie files
181     int start_pad;        ///< amount of samples to skip due to enc-dec delay
182     unsigned int rap_group_count;
183     MOVSbgp *rap_group;
184
185     int nb_frames_for_fps;
186     int64_t duration_for_fps;
187
188     /** extradata array (and size) for multiple stsd */
189     uint8_t **extradata;
190     int *extradata_size;
191     int last_stsd_index;
192     int stsd_count;
193
194     int32_t *display_matrix;
195     AVStereo3D *stereo3d;
196     AVSphericalMapping *spherical;
197     size_t spherical_size;
198     AVMasteringDisplayMetadata *mastering;
199
200     uint32_t format;
201
202     int has_sidx;  // If there is an sidx entry for this stream.
203     struct {
204         int use_subsamples;
205         uint8_t* auxiliary_info;
206         uint8_t* auxiliary_info_end;
207         uint8_t* auxiliary_info_pos;
208         uint8_t auxiliary_info_default_size;
209         uint8_t* auxiliary_info_sizes;
210         size_t auxiliary_info_sizes_count;
211         int64_t auxiliary_info_index;
212         struct AVAESCTR* aes_ctr;
213     } cenc;
214 } MOVStreamContext;
215
216 typedef struct MOVContext {
217     const AVClass *class; ///< class for private options
218     AVFormatContext *fc;
219     int time_scale;
220     int64_t duration;     ///< duration of the longest track
221     int found_moov;       ///< 'moov' atom has been found
222     int found_mdat;       ///< 'mdat' atom has been found
223     int found_hdlr_mdta;  ///< 'hdlr' atom with type 'mdta' has been found
224     int trak_index;       ///< Index of the current 'trak'
225     char **meta_keys;
226     unsigned meta_keys_count;
227     DVDemuxContext *dv_demux;
228     AVFormatContext *dv_fctx;
229     int isom;             ///< 1 if file is ISO Media (mp4/3gp)
230     MOVFragment fragment; ///< current fragment in moof atom
231     MOVTrackExt *trex_data;
232     unsigned trex_count;
233     int itunes_metadata;  ///< metadata are itunes style
234     int handbrake_version;
235     int *chapter_tracks;
236     unsigned int nb_chapter_tracks;
237     int use_absolute_path;
238     int ignore_editlist;
239     int advanced_editlist;
240     int ignore_chapters;
241     int seek_individually;
242     int64_t next_root_atom; ///< offset of the next root atom
243     int export_all;
244     int export_xmp;
245     int *bitrates;          ///< bitrates read before streams creation
246     int bitrates_count;
247     int moov_retry;
248     int use_mfra_for;
249     int has_looked_for_mfra;
250     MOVFragmentIndex** fragment_index_data;
251     unsigned fragment_index_count;
252     int fragment_index_complete;
253     int atom_depth;
254     unsigned int aax_mode;  ///< 'aax' file has been detected
255     uint8_t file_key[20];
256     uint8_t file_iv[20];
257     void *activation_bytes;
258     int activation_bytes_size;
259     void *audible_fixed_key;
260     int audible_fixed_key_size;
261     struct AVAES *aes_decrypt;
262     uint8_t *decryption_key;
263     int decryption_key_len;
264     int enable_drefs;
265     int32_t movie_display_matrix[3][3]; ///< display matrix from mvhd
266 } MOVContext;
267
268 int ff_mp4_read_descr_len(AVIOContext *pb);
269 int ff_mp4_read_descr(AVFormatContext *fc, AVIOContext *pb, int *tag);
270 int ff_mp4_read_dec_config_descr(AVFormatContext *fc, AVStream *st, AVIOContext *pb);
271 void ff_mp4_parse_es_descr(AVIOContext *pb, int *es_id);
272
273 #define MP4ODescrTag                    0x01
274 #define MP4IODescrTag                   0x02
275 #define MP4ESDescrTag                   0x03
276 #define MP4DecConfigDescrTag            0x04
277 #define MP4DecSpecificDescrTag          0x05
278 #define MP4SLDescrTag                   0x06
279
280 #define MOV_TFHD_BASE_DATA_OFFSET       0x01
281 #define MOV_TFHD_STSD_ID                0x02
282 #define MOV_TFHD_DEFAULT_DURATION       0x08
283 #define MOV_TFHD_DEFAULT_SIZE           0x10
284 #define MOV_TFHD_DEFAULT_FLAGS          0x20
285 #define MOV_TFHD_DURATION_IS_EMPTY  0x010000
286 #define MOV_TFHD_DEFAULT_BASE_IS_MOOF 0x020000
287
288 #define MOV_TRUN_DATA_OFFSET            0x01
289 #define MOV_TRUN_FIRST_SAMPLE_FLAGS     0x04
290 #define MOV_TRUN_SAMPLE_DURATION       0x100
291 #define MOV_TRUN_SAMPLE_SIZE           0x200
292 #define MOV_TRUN_SAMPLE_FLAGS          0x400
293 #define MOV_TRUN_SAMPLE_CTS            0x800
294
295 #define MOV_FRAG_SAMPLE_FLAG_DEGRADATION_PRIORITY_MASK 0x0000ffff
296 #define MOV_FRAG_SAMPLE_FLAG_IS_NON_SYNC               0x00010000
297 #define MOV_FRAG_SAMPLE_FLAG_PADDING_MASK              0x000e0000
298 #define MOV_FRAG_SAMPLE_FLAG_REDUNDANCY_MASK           0x00300000
299 #define MOV_FRAG_SAMPLE_FLAG_DEPENDED_MASK             0x00c00000
300 #define MOV_FRAG_SAMPLE_FLAG_DEPENDS_MASK              0x03000000
301
302 #define MOV_FRAG_SAMPLE_FLAG_DEPENDS_NO                0x02000000
303 #define MOV_FRAG_SAMPLE_FLAG_DEPENDS_YES               0x01000000
304
305 #define MOV_TKHD_FLAG_ENABLED       0x0001
306 #define MOV_TKHD_FLAG_IN_MOVIE      0x0002
307 #define MOV_TKHD_FLAG_IN_PREVIEW    0x0004
308 #define MOV_TKHD_FLAG_IN_POSTER     0x0008
309
310 #define TAG_IS_AVCI(tag)                    \
311     ((tag) == MKTAG('a', 'i', '5', 'p') ||  \
312      (tag) == MKTAG('a', 'i', '5', 'q') ||  \
313      (tag) == MKTAG('a', 'i', '5', '2') ||  \
314      (tag) == MKTAG('a', 'i', '5', '3') ||  \
315      (tag) == MKTAG('a', 'i', '5', '5') ||  \
316      (tag) == MKTAG('a', 'i', '5', '6') ||  \
317      (tag) == MKTAG('a', 'i', '1', 'p') ||  \
318      (tag) == MKTAG('a', 'i', '1', 'q') ||  \
319      (tag) == MKTAG('a', 'i', '1', '2') ||  \
320      (tag) == MKTAG('a', 'i', '1', '3') ||  \
321      (tag) == MKTAG('a', 'i', '1', '5') ||  \
322      (tag) == MKTAG('a', 'i', '1', '6') ||  \
323      (tag) == MKTAG('a', 'i', 'v', 'x') ||  \
324      (tag) == MKTAG('A', 'V', 'i', 'n'))
325
326
327 int ff_mov_read_esds(AVFormatContext *fc, AVIOContext *pb);
328 enum AVCodecID ff_mov_get_lpcm_codec_id(int bps, int flags);
329
330 int ff_mov_read_stsd_entries(MOVContext *c, AVIOContext *pb, int entries);
331 void ff_mov_write_chan(AVIOContext *pb, int64_t channel_layout);
332
333 #define FF_MOV_FLAG_MFRA_AUTO -1
334 #define FF_MOV_FLAG_MFRA_DTS 1
335 #define FF_MOV_FLAG_MFRA_PTS 2
336
337 #endif /* AVFORMAT_ISOM_H */