FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
isom.h
Go to the documentation of this file.
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 
32 #include "libavutil/spherical.h"
33 #include "libavutil/stereo3d.h"
34 
35 #include "avio.h"
36 #include "internal.h"
37 #include "dv.h"
38 
39 /* isom.c */
40 extern const AVCodecTag ff_mp4_obj_type[];
41 extern const AVCodecTag ff_codec_movvideo_tags[];
42 extern const AVCodecTag ff_codec_movaudio_tags[];
44 
45 int ff_mov_iso639_to_lang(const char lang[4], int mp4);
46 int ff_mov_lang_to_iso639(unsigned code, char to[4]);
47 
48 struct AVAESCTR;
49 
50 /* the QuickTime file format is quite convoluted...
51  * it has lots of index tables, each indexing something in another one...
52  * Here we just use what is needed to read the chunks
53  */
54 
55 typedef struct MOVStts {
56  unsigned int count;
57  int duration;
58 } MOVStts;
59 
60 typedef struct MOVStsc {
61  int first;
62  int count;
63  int id;
64 } MOVStsc;
65 
66 typedef struct MOVElst {
67  int64_t duration;
68  int64_t time;
69  float rate;
70 } MOVElst;
71 
72 typedef struct MOVDref {
73  uint32_t type;
74  char *path;
75  char *dir;
76  char volume[28];
77  char filename[64];
78  int16_t nlvl_to, nlvl_from;
79 } MOVDref;
80 
81 typedef struct MOVAtom {
82  uint32_t type;
83  int64_t size; /* total size (excluding the size and type fields) */
84 } MOVAtom;
85 
86 struct MOVParseTableEntry;
87 
88 typedef struct MOVFragment {
89  unsigned track_id;
90  uint64_t base_data_offset;
91  uint64_t moof_offset;
92  uint64_t implicit_offset;
93  unsigned stsd_id;
94  unsigned duration;
95  unsigned size;
96  unsigned flags;
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 MOVEncryptionIndex {
113  // Individual encrypted samples. If there are no elements, then the default
114  // settings will be used.
115  unsigned int nb_encrypted_samples;
117 
121  size_t* auxiliary_offsets; ///< Absolute seek position
124 
125 typedef struct MOVFragmentStreamInfo {
126  int id;
127  int64_t sidx_pts;
128  int64_t first_tfra_pts;
129  int64_t tfdt_dts;
133 
134 typedef struct MOVFragmentIndexItem {
135  int64_t moof_offset;
137  int current;
141 
142 typedef struct MOVFragmentIndex {
144  int complete;
145  int current;
146  int nb_items;
149 
150 typedef struct MOVIndexRange {
151  int64_t start;
152  int64_t end;
153 } MOVIndexRange;
154 
155 typedef struct MOVStreamContext {
158  int ffindex; ///< AVStream index
160  unsigned int chunk_count;
161  int64_t *chunk_offsets;
162  unsigned int stts_count;
164  unsigned int ctts_count;
165  unsigned int ctts_allocated_size;
167  unsigned int stsc_count;
169  unsigned int stsc_index;
171  unsigned int stps_count;
172  unsigned *stps_data; ///< partial sync sample for mpeg-2 open gop
174  unsigned int elst_count;
177  unsigned int sample_size; ///< may contain value calculated from stsd or value from stsz atom
178  unsigned int stsz_sample_size; ///< always contains sample size from stsz atom
179  unsigned int sample_count;
182  unsigned int keyframe_count;
183  int *keyframes;
185  int64_t time_offset; ///< time offset of the edit list entries
186  int64_t min_corrected_pts; ///< minimum Composition time shown by the edits excluding empty edits.
188  int64_t current_index;
191  unsigned int bytes_per_frame;
192  unsigned int samples_per_frame;
194  int pseudo_stream_id; ///< -1 means demux all ids
195  int16_t audio_cid; ///< stsd audio compression id
196  unsigned drefs_count;
198  int dref_id;
200  int width; ///< tkhd width
201  int height; ///< tkhd height
202  int dts_shift; ///< dts shift when ctts is negative
203  uint32_t palette[256];
205  int64_t data_size;
206  uint32_t tmcd_flags; ///< tmcd track flags
207  int64_t track_end; ///< used for dts generation in fragmented movie files
208  int start_pad; ///< amount of samples to skip due to enc-dec delay
209  unsigned int rap_group_count;
211 
214 
215  /** extradata array (and size) for multiple stsd */
220 
227  size_t coll_size;
228 
229  uint32_t format;
230 
231  int has_sidx; // If there is an sidx entry for this stream.
232  struct {
233  struct AVAESCTR* aes_ctr;
234  unsigned int per_sample_iv_size; // Either 0, 8, or 16.
237  } cenc;
239 
240 typedef struct MOVContext {
241  const AVClass *class; ///< class for private options
244  int64_t duration; ///< duration of the longest track
245  int found_moov; ///< 'moov' atom has been found
246  int found_mdat; ///< 'mdat' atom has been found
247  int found_hdlr_mdta; ///< 'hdlr' atom with type 'mdta' has been found
248  int trak_index; ///< Index of the current 'trak'
249  char **meta_keys;
250  unsigned meta_keys_count;
253  int isom; ///< 1 if file is ISO Media (mp4/3gp)
254  MOVFragment fragment; ///< current fragment in moof atom
256  unsigned trex_count;
257  int itunes_metadata; ///< metadata are itunes style
260  unsigned int nb_chapter_tracks;
266  int64_t next_root_atom; ///< offset of the next root atom
269  int *bitrates; ///< bitrates read before streams creation
276  unsigned int aax_mode; ///< 'aax' file has been detected
287  int32_t movie_display_matrix[3][3]; ///< display matrix from mvhd
288 } MOVContext;
289 
293 void ff_mp4_parse_es_descr(AVIOContext *pb, int *es_id);
294 
295 #define MP4ODescrTag 0x01
296 #define MP4IODescrTag 0x02
297 #define MP4ESDescrTag 0x03
298 #define MP4DecConfigDescrTag 0x04
299 #define MP4DecSpecificDescrTag 0x05
300 #define MP4SLDescrTag 0x06
301 
302 #define MOV_TFHD_BASE_DATA_OFFSET 0x01
303 #define MOV_TFHD_STSD_ID 0x02
304 #define MOV_TFHD_DEFAULT_DURATION 0x08
305 #define MOV_TFHD_DEFAULT_SIZE 0x10
306 #define MOV_TFHD_DEFAULT_FLAGS 0x20
307 #define MOV_TFHD_DURATION_IS_EMPTY 0x010000
308 #define MOV_TFHD_DEFAULT_BASE_IS_MOOF 0x020000
309 
310 #define MOV_TRUN_DATA_OFFSET 0x01
311 #define MOV_TRUN_FIRST_SAMPLE_FLAGS 0x04
312 #define MOV_TRUN_SAMPLE_DURATION 0x100
313 #define MOV_TRUN_SAMPLE_SIZE 0x200
314 #define MOV_TRUN_SAMPLE_FLAGS 0x400
315 #define MOV_TRUN_SAMPLE_CTS 0x800
316 
317 #define MOV_FRAG_SAMPLE_FLAG_DEGRADATION_PRIORITY_MASK 0x0000ffff
318 #define MOV_FRAG_SAMPLE_FLAG_IS_NON_SYNC 0x00010000
319 #define MOV_FRAG_SAMPLE_FLAG_PADDING_MASK 0x000e0000
320 #define MOV_FRAG_SAMPLE_FLAG_REDUNDANCY_MASK 0x00300000
321 #define MOV_FRAG_SAMPLE_FLAG_DEPENDED_MASK 0x00c00000
322 #define MOV_FRAG_SAMPLE_FLAG_DEPENDS_MASK 0x03000000
323 
324 #define MOV_FRAG_SAMPLE_FLAG_DEPENDS_NO 0x02000000
325 #define MOV_FRAG_SAMPLE_FLAG_DEPENDS_YES 0x01000000
326 
327 #define MOV_TKHD_FLAG_ENABLED 0x0001
328 #define MOV_TKHD_FLAG_IN_MOVIE 0x0002
329 #define MOV_TKHD_FLAG_IN_PREVIEW 0x0004
330 #define MOV_TKHD_FLAG_IN_POSTER 0x0008
331 
332 #define MOV_SAMPLE_DEPENDENCY_UNKNOWN 0x0
333 #define MOV_SAMPLE_DEPENDENCY_YES 0x1
334 #define MOV_SAMPLE_DEPENDENCY_NO 0x2
335 
336 
337 #define TAG_IS_AVCI(tag) \
338  ((tag) == MKTAG('a', 'i', '5', 'p') || \
339  (tag) == MKTAG('a', 'i', '5', 'q') || \
340  (tag) == MKTAG('a', 'i', '5', '2') || \
341  (tag) == MKTAG('a', 'i', '5', '3') || \
342  (tag) == MKTAG('a', 'i', '5', '5') || \
343  (tag) == MKTAG('a', 'i', '5', '6') || \
344  (tag) == MKTAG('a', 'i', '1', 'p') || \
345  (tag) == MKTAG('a', 'i', '1', 'q') || \
346  (tag) == MKTAG('a', 'i', '1', '2') || \
347  (tag) == MKTAG('a', 'i', '1', '3') || \
348  (tag) == MKTAG('a', 'i', '1', '5') || \
349  (tag) == MKTAG('a', 'i', '1', '6') || \
350  (tag) == MKTAG('a', 'i', 'v', 'x') || \
351  (tag) == MKTAG('A', 'V', 'i', 'n'))
352 
353 
355 
356 int ff_mov_read_stsd_entries(MOVContext *c, AVIOContext *pb, int entries);
357 void ff_mov_write_chan(AVIOContext *pb, int64_t channel_layout);
358 
359 #define FF_MOV_FLAG_MFRA_AUTO -1
360 #define FF_MOV_FLAG_MFRA_DTS 1
361 #define FF_MOV_FLAG_MFRA_PTS 2
362 
363 /**
364  * Compute codec id for 'lpcm' tag.
365  * See CoreAudioTypes and AudioStreamBasicDescription at Apple.
366  */
367 static inline enum AVCodecID ff_mov_get_lpcm_codec_id(int bps, int flags)
368 {
369  /* lpcm flags:
370  * 0x1 = float
371  * 0x2 = big-endian
372  * 0x4 = signed
373  */
374  return ff_get_pcm_codec_id(bps, flags & 1, flags & 2, flags & 4 ? -1 : 0);
375 }
376 
377 #endif /* AVFORMAT_ISOM_H */
int itunes_metadata
metadata are itunes style
Definition: isom.h:257
int * bitrates
bitrates read before streams creation
Definition: isom.h:269
int64_t current_index
Definition: isom.h:188
int64_t moof_offset
Definition: isom.h:135
size_t auxiliary_offsets_count
Definition: isom.h:122
Bytestream IO Context.
Definition: avio.h:161
Buffered I/O operations.
uint32_t tmcd_flags
tmcd track flags
Definition: isom.h:206
const AVCodecTag ff_mp4_obj_type[]
Definition: isom.c:34
unsigned int rap_group_count
Definition: isom.h:209
unsigned int elst_count
Definition: isom.h:174
MOVTrackExt * trex_data
Definition: isom.h:255
int export_all
Definition: isom.h:267
int64_t end
Definition: isom.h:152
unsigned track_id
Definition: isom.h:89
uint32_t format
Definition: isom.h:229
unsigned int samples_per_frame
Definition: isom.h:192
int dv_audio_container
Definition: isom.h:193
Definition: isom.h:55
float rate
Definition: isom.h:69
uint64_t base_data_offset
Definition: isom.h:90
int64_t duration
Definition: isom.h:67
size_t spherical_size
Definition: isom.h:224
unsigned int ctts_allocated_size
Definition: isom.h:165
unsigned int stsc_count
Definition: isom.h:167
int has_palette
Definition: isom.h:204
AVEncryptionInfo * default_encrypted_sample
Definition: isom.h:235
int allocated_size
Definition: isom.h:143
AVMasteringDisplayMetadata * mastering
Definition: isom.h:225
uint8_t * decryption_key
Definition: isom.h:284
This describes encryption info for a packet.
int ignore_chapters
Definition: isom.h:264
void * activation_bytes
Definition: isom.h:279
AVEncryptionInfo ** encrypted_samples
Definition: isom.h:116
int ff_mp4_read_dec_config_descr(AVFormatContext *fc, AVStream *st, AVIOContext *pb)
Definition: isom.c:498
int16_t audio_cid
stsd audio compression id
Definition: isom.h:195
char ** meta_keys
Definition: isom.h:249
int height
tkhd height
Definition: isom.h:201
uint32_t type
Definition: isom.h:82
MOVElst * elst_data
Definition: isom.h:173
MOVStsc * stsc_data
Definition: isom.h:168
int nb_items
Definition: isom.h:146
int ctts_index
Definition: isom.h:175
int complete
Definition: isom.h:144
unsigned stsd_id
Definition: isom.h:101
AVSphericalMapping * spherical
Definition: isom.h:223
int found_moov
'moov' atom has been found
Definition: isom.h:245
unsigned flags
Definition: isom.h:104
int isom
1 if file is ISO Media (mp4/3gp)
Definition: isom.h:253
int found_mdat
'mdat' atom has been found
Definition: isom.h:246
int width
tkhd width
Definition: isom.h:200
unsigned drefs_count
Definition: isom.h:196
Format I/O context.
Definition: avformat.h:1351
const AVCodecTag ff_codec_movvideo_tags[]
Definition: isom.c:75
char filename[64]
Definition: isom.h:77
MOVDref * drefs
Definition: isom.h:197
const AVCodecTag ff_codec_movaudio_tags[]
Definition: isom.c:312
uint8_t
int first
Definition: isom.h:61
size_t coll_size
Definition: isom.h:227
int ff_mp4_read_descr_len(AVIOContext *pb)
Definition: isom.c:451
Stereo 3D type: this structure describes how two videos are packed within a single video surface...
Definition: stereo3d.h:176
unsigned int sample_count
Definition: isom.h:179
int count
Definition: isom.h:62
int dts_shift
dts shift when ctts is negative
Definition: isom.h:202
unsigned int count
Definition: isom.h:108
int16_t nlvl_to
Definition: isom.h:78
char volume[28]
Definition: isom.h:76
int stsd_count
Definition: isom.h:219
int activation_bytes_size
Definition: isom.h:280
uint32_t tag
Definition: movenc.c:1466
int nb_frames_for_fps
Definition: isom.h:212
size_t * auxiliary_offsets
Absolute seek position.
Definition: isom.h:121
struct AVAESCTR * aes_ctr
Definition: isom.h:233
const AVCodecTag ff_codec_movsubtitle_tags[]
Definition: isom.c:369
#define flags(name, subs,...)
Definition: cbs_h2645.c:263
int current_sample
Definition: isom.h:187
int32_t movie_display_matrix[3][3]
display matrix from mvhd
Definition: isom.h:287
unsigned track_id
Definition: isom.h:100
const char * to
Definition: webvttdec.c:34
int64_t time_offset
time offset of the edit list entries
Definition: isom.h:185
unsigned int keyframe_count
Definition: isom.h:182
MOVIndexRange * index_ranges
Definition: isom.h:189
int64_t first_tfra_pts
Definition: isom.h:128
uint8_t * auxiliary_info_sizes
Definition: isom.h:118
int * extradata_size
Definition: isom.h:217
Content light level needed by to transmit HDR over HDMI (CTA-861.3).
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: avcodec.h:215
unsigned int ctts_count
Definition: isom.h:164
int64_t tfdt_dts
Definition: isom.h:129
int stsc_sample
Definition: isom.h:170
int atom_depth
Definition: isom.h:275
MOVIndexRange * current_index_range
Definition: isom.h:190
int * keyframes
Definition: isom.h:183
AVFormatContext * fc
Definition: isom.h:242
int handbrake_version
Definition: isom.h:258
int ctts_sample
Definition: isom.h:176
int keyframe_absent
Definition: isom.h:181
int16_t nlvl_from
Definition: isom.h:78
void * audible_fixed_key
Definition: isom.h:281
int64_t min_corrected_pts
minimum Composition time shown by the edits excluding empty edits.
Definition: isom.h:186
AVContentLightMetadata * coll
Definition: isom.h:226
uint8_t file_key[20]
Definition: isom.h:277
struct AVAES * aes_decrypt
Definition: isom.h:283
static const uint16_t fc[]
Definition: dcaenc.h:43
Spherical video.
MOVFragmentStreamInfo * stream_info
Definition: isom.h:139
char * dir
Definition: isom.h:75
int id
Definition: isom.h:63
uint8_t auxiliary_info_default_size
Definition: isom.h:120
int decryption_key_len
Definition: isom.h:285
int32_t
int audible_fixed_key_size
Definition: isom.h:282
int advanced_editlist
Definition: isom.h:263
char * path
Definition: isom.h:74
int time_scale
Definition: isom.h:184
Definition: isom.h:107
uint64_t moof_offset
Definition: isom.h:91
MOVStts * ctts_data
Definition: isom.h:166
unsigned size
Definition: isom.h:103
void ff_mov_write_chan(AVIOContext *pb, int64_t channel_layout)
Definition: isom.c:626
int ignore_editlist
Definition: isom.h:262
MOVFragmentIndexItem * item
Definition: isom.h:147
int64_t * chunk_offsets
Definition: isom.h:161
unsigned int index
Definition: isom.h:109
MOVFragmentIndex frag_index
Definition: isom.h:274
int ff_mov_read_esds(AVFormatContext *fc, AVIOContext *pb)
Definition: mov_esds.c:23
int64_t duration
duration of the longest track
Definition: isom.h:244
Stream structure.
Definition: avformat.h:874
unsigned duration
Definition: isom.h:102
DVDemuxContext * dv_demux
Definition: isom.h:251
int timecode_track
Definition: isom.h:199
int * sample_sizes
Definition: isom.h:180
unsigned duration
Definition: isom.h:94
MOVSbgp * rap_group
Definition: isom.h:210
int duration
Definition: isom.h:57
int * chapter_tracks
Definition: isom.h:259
unsigned int stsz_sample_size
always contains sample size from stsz atom
Definition: isom.h:178
unsigned trex_count
Definition: isom.h:256
int enable_drefs
Definition: isom.h:286
int64_t data_size
Definition: isom.h:205
int has_looked_for_mfra
Definition: isom.h:273
struct MOVStreamContext::@232 cenc
uint32_t type
Definition: isom.h:73
unsigned int count
Definition: isom.h:56
MOVStts * stts_data
Definition: isom.h:163
MOVEncryptionIndex * encryption_index
Definition: isom.h:131
Describe the class of an AVClass context structure.
Definition: log.h:67
enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags)
Select a PCM codec based on the given parameters.
Definition: utils.c:3135
unsigned int aax_mode
'aax' file has been detected
Definition: isom.h:276
Mastering display metadata capable of representing the color volume of the display used to master the...
MOVFragment fragment
current fragment in moof atom
Definition: isom.h:254
int64_t track_end
used for dts generation in fragmented movie files
Definition: isom.h:207
Definition: isom.h:81
static enum AVCodecID ff_mov_get_lpcm_codec_id(int bps, int flags)
Compute codec id for 'lpcm' tag.
Definition: isom.h:367
int use_mfra_for
Definition: isom.h:272
int64_t time
Definition: isom.h:68
int pb_is_copied
Definition: isom.h:157
int ff_mov_lang_to_iso639(unsigned code, char to[4])
Definition: isom.c:429
This structure describes how to handle spherical videos, outlining information about projection...
Definition: spherical.h:82
int ff_mov_read_stsd_entries(MOVContext *c, AVIOContext *pb, int entries)
Definition: mov.c:2445
int next_chunk
Definition: isom.h:159
AVFormatContext * dv_fctx
Definition: isom.h:252
unsigned int stsc_index
Definition: isom.h:169
int ff_mp4_read_descr(AVFormatContext *fc, AVIOContext *pb, int *tag)
Definition: isom.c:464
uint64_t implicit_offset
Definition: isom.h:92
AVStereo3D * stereo3d
Definition: isom.h:222
unsigned int per_sample_iv_size
Definition: isom.h:234
unsigned * stps_data
partial sync sample for mpeg-2 open gop
Definition: isom.h:172
int ff_mov_iso639_to_lang(const char lang[4], int mp4)
Definition: isom.c:402
int64_t sidx_pts
Definition: isom.h:127
int start_pad
amount of samples to skip due to enc-dec delay
Definition: isom.h:208
int trak_index
Index of the current 'trak'.
Definition: isom.h:248
int32_t * display_matrix
Definition: isom.h:221
AVIOContext * pb
Definition: isom.h:156
unsigned int bytes_per_frame
Definition: isom.h:191
unsigned flags
Definition: isom.h:96
int bitrates_count
Definition: isom.h:270
int64_t size
Definition: isom.h:83
int export_xmp
Definition: isom.h:268
int seek_individually
Definition: isom.h:265
static double c[64]
unsigned int stps_count
Definition: isom.h:171
unsigned int chunk_count
Definition: isom.h:160
Stereoscopic video.
unsigned bps
Definition: movenc.c:1467
int64_t start
Definition: isom.h:151
unsigned meta_keys_count
Definition: isom.h:250
uint32_t palette[256]
Definition: isom.h:203
unsigned stsd_id
Definition: isom.h:93
MOVEncryptionIndex * encryption_index
Definition: isom.h:236
unsigned int stts_count
Definition: isom.h:162
unsigned int sample_size
may contain value calculated from stsd or value from stsz atom
Definition: isom.h:177
uint8_t file_iv[20]
Definition: isom.h:278
int64_t next_root_atom
offset of the next root atom
Definition: isom.h:266
int last_stsd_index
Definition: isom.h:218
unsigned int nb_encrypted_samples
Definition: isom.h:115
unsigned int nb_chapter_tracks
Definition: isom.h:260
int time_scale
Definition: isom.h:243
void ff_mp4_parse_es_descr(AVIOContext *pb, int *es_id)
Definition: isom.c:473
Definition: isom.h:66
int pseudo_stream_id
-1 means demux all ids
Definition: isom.h:194
int ffindex
AVStream index.
Definition: isom.h:158
uint8_t ** extradata
extradata array (and size) for multiple stsd
Definition: isom.h:216
int use_absolute_path
Definition: isom.h:261
unsigned size
Definition: isom.h:95
int64_t duration_for_fps
Definition: isom.h:213
int moov_retry
Definition: isom.h:271
size_t auxiliary_info_sample_count
Definition: isom.h:119
int found_hdlr_mdta
'hdlr' atom with type 'mdta' has been found
Definition: isom.h:247
Definition: isom.h:60
int has_sidx
Definition: isom.h:231
Definition: isom.h:72