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