e01b9de2205302c0f5b491f174c2a6e4d96ba758
[ffmpeg.git] / libavformat / matroska.h
1 /*
2  * Matroska constants
3  * Copyright (c) 2003-2004 The ffmpeg Project
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #ifndef AVFORMAT_MATROSKA_H
23 #define AVFORMAT_MATROSKA_H
24
25 #include "libavcodec/avcodec.h"
26 #include "metadata.h"
27 #include "internal.h"
28
29 /* EBML version supported */
30 #define EBML_VERSION 1
31
32 /* top-level master-IDs */
33 #define EBML_ID_HEADER             0x1A45DFA3
34
35 /* IDs in the HEADER master */
36 #define EBML_ID_EBMLVERSION        0x4286
37 #define EBML_ID_EBMLREADVERSION    0x42F7
38 #define EBML_ID_EBMLMAXIDLENGTH    0x42F2
39 #define EBML_ID_EBMLMAXSIZELENGTH  0x42F3
40 #define EBML_ID_DOCTYPE            0x4282
41 #define EBML_ID_DOCTYPEVERSION     0x4287
42 #define EBML_ID_DOCTYPEREADVERSION 0x4285
43
44 /* general EBML types */
45 #define EBML_ID_VOID               0xEC
46 #define EBML_ID_CRC32              0xBF
47
48 /*
49  * Matroska element IDs, max. 32 bits
50  */
51
52 /* toplevel segment */
53 #define MATROSKA_ID_SEGMENT    0x18538067
54
55 /* Matroska top-level master IDs */
56 #define MATROSKA_ID_INFO       0x1549A966
57 #define MATROSKA_ID_TRACKS     0x1654AE6B
58 #define MATROSKA_ID_CUES       0x1C53BB6B
59 #define MATROSKA_ID_TAGS       0x1254C367
60 #define MATROSKA_ID_SEEKHEAD   0x114D9B74
61 #define MATROSKA_ID_ATTACHMENTS 0x1941A469
62 #define MATROSKA_ID_CLUSTER    0x1F43B675
63 #define MATROSKA_ID_CHAPTERS   0x1043A770
64
65 /* IDs in the info master */
66 #define MATROSKA_ID_TIMECODESCALE 0x2AD7B1
67 #define MATROSKA_ID_DURATION   0x4489
68 #define MATROSKA_ID_TITLE      0x7BA9
69 #define MATROSKA_ID_WRITINGAPP 0x5741
70 #define MATROSKA_ID_MUXINGAPP  0x4D80
71 #define MATROSKA_ID_DATEUTC    0x4461
72 #define MATROSKA_ID_SEGMENTUID 0x73A4
73
74 /* ID in the tracks master */
75 #define MATROSKA_ID_TRACKENTRY 0xAE
76
77 /* IDs in the trackentry master */
78 #define MATROSKA_ID_TRACKNUMBER 0xD7
79 #define MATROSKA_ID_TRACKUID   0x73C5
80 #define MATROSKA_ID_TRACKTYPE  0x83
81 #define MATROSKA_ID_TRACKVIDEO     0xE0
82 #define MATROSKA_ID_TRACKAUDIO     0xE1
83 #define MATROSKA_ID_TRACKOPERATION 0xE2
84 #define MATROSKA_ID_TRACKCOMBINEPLANES 0xE3
85 #define MATROSKA_ID_TRACKPLANE         0xE4
86 #define MATROSKA_ID_TRACKPLANEUID      0xE5
87 #define MATROSKA_ID_TRACKPLANETYPE     0xE6
88 #define MATROSKA_ID_CODECID    0x86
89 #define MATROSKA_ID_CODECPRIVATE 0x63A2
90 #define MATROSKA_ID_CODECNAME  0x258688
91 #define MATROSKA_ID_CODECINFOURL 0x3B4040
92 #define MATROSKA_ID_CODECDOWNLOADURL 0x26B240
93 #define MATROSKA_ID_CODECDECODEALL 0xAA
94 #define MATROSKA_ID_CODECDELAY 0x56AA
95 #define MATROSKA_ID_SEEKPREROLL 0x56BB
96 #define MATROSKA_ID_TRACKNAME  0x536E
97 #define MATROSKA_ID_TRACKLANGUAGE 0x22B59C
98 #define MATROSKA_ID_TRACKFLAGENABLED 0xB9
99 #define MATROSKA_ID_TRACKFLAGDEFAULT 0x88
100 #define MATROSKA_ID_TRACKFLAGFORCED 0x55AA
101 #define MATROSKA_ID_TRACKFLAGLACING 0x9C
102 #define MATROSKA_ID_TRACKMINCACHE 0x6DE7
103 #define MATROSKA_ID_TRACKMAXCACHE 0x6DF8
104 #define MATROSKA_ID_TRACKDEFAULTDURATION 0x23E383
105 #define MATROSKA_ID_TRACKCONTENTENCODINGS 0x6D80
106 #define MATROSKA_ID_TRACKCONTENTENCODING 0x6240
107 #define MATROSKA_ID_TRACKTIMECODESCALE 0x23314F
108 #define MATROSKA_ID_TRACKMAXBLKADDID 0x55EE
109
110 /* IDs in the trackvideo master */
111 #define MATROSKA_ID_VIDEOFRAMERATE 0x2383E3
112 #define MATROSKA_ID_VIDEODISPLAYWIDTH 0x54B0
113 #define MATROSKA_ID_VIDEODISPLAYHEIGHT 0x54BA
114 #define MATROSKA_ID_VIDEOPIXELWIDTH 0xB0
115 #define MATROSKA_ID_VIDEOPIXELHEIGHT 0xBA
116 #define MATROSKA_ID_VIDEOPIXELCROPB 0x54AA
117 #define MATROSKA_ID_VIDEOPIXELCROPT 0x54BB
118 #define MATROSKA_ID_VIDEOPIXELCROPL 0x54CC
119 #define MATROSKA_ID_VIDEOPIXELCROPR 0x54DD
120 #define MATROSKA_ID_VIDEODISPLAYUNIT 0x54B2
121 #define MATROSKA_ID_VIDEOFLAGINTERLACED 0x9A
122 #define MATROSKA_ID_VIDEOSTEREOMODE 0x53B8
123 #define MATROSKA_ID_VIDEOALPHAMODE 0x53C0
124 #define MATROSKA_ID_VIDEOASPECTRATIO 0x54B3
125 #define MATROSKA_ID_VIDEOCOLORSPACE 0x2EB524
126
127 /* IDs in the trackaudio master */
128 #define MATROSKA_ID_AUDIOSAMPLINGFREQ 0xB5
129 #define MATROSKA_ID_AUDIOOUTSAMPLINGFREQ 0x78B5
130
131 #define MATROSKA_ID_AUDIOBITDEPTH 0x6264
132 #define MATROSKA_ID_AUDIOCHANNELS 0x9F
133
134 /* IDs in the content encoding master */
135 #define MATROSKA_ID_ENCODINGORDER 0x5031
136 #define MATROSKA_ID_ENCODINGSCOPE 0x5032
137 #define MATROSKA_ID_ENCODINGTYPE 0x5033
138 #define MATROSKA_ID_ENCODINGCOMPRESSION 0x5034
139 #define MATROSKA_ID_ENCODINGCOMPALGO 0x4254
140 #define MATROSKA_ID_ENCODINGCOMPSETTINGS 0x4255
141
142 #define MATROSKA_ID_ENCODINGENCRYPTION 0x5035
143 #define MATROSKA_ID_ENCODINGENCAESSETTINGS 0x47E7
144 #define MATROSKA_ID_ENCODINGENCALGO 0x47E1
145 #define MATROSKA_ID_ENCODINGENCKEYID 0x47E2
146 #define MATROSKA_ID_ENCODINGSIGALGO 0x47E5
147 #define MATROSKA_ID_ENCODINGSIGHASHALGO 0x47E6
148 #define MATROSKA_ID_ENCODINGSIGKEYID 0x47E4
149 #define MATROSKA_ID_ENCODINGSIGNATURE 0x47E3
150
151 /* ID in the cues master */
152 #define MATROSKA_ID_POINTENTRY 0xBB
153
154 /* IDs in the pointentry master */
155 #define MATROSKA_ID_CUETIME    0xB3
156 #define MATROSKA_ID_CUETRACKPOSITION 0xB7
157
158 /* IDs in the cuetrackposition master */
159 #define MATROSKA_ID_CUETRACK   0xF7
160 #define MATROSKA_ID_CUECLUSTERPOSITION 0xF1
161 #define MATROSKA_ID_CUERELATIVEPOSITION 0xF0
162 #define MATROSKA_ID_CUEDURATION 0xB2
163 #define MATROSKA_ID_CUEBLOCKNUMBER 0x5378
164
165 /* IDs in the tags master */
166 #define MATROSKA_ID_TAG                 0x7373
167 #define MATROSKA_ID_SIMPLETAG           0x67C8
168 #define MATROSKA_ID_TAGNAME             0x45A3
169 #define MATROSKA_ID_TAGSTRING           0x4487
170 #define MATROSKA_ID_TAGLANG             0x447A
171 #define MATROSKA_ID_TAGDEFAULT          0x4484
172 #define MATROSKA_ID_TAGDEFAULT_BUG      0x44B4
173 #define MATROSKA_ID_TAGTARGETS          0x63C0
174 #define MATROSKA_ID_TAGTARGETS_TYPE       0x63CA
175 #define MATROSKA_ID_TAGTARGETS_TYPEVALUE  0x68CA
176 #define MATROSKA_ID_TAGTARGETS_TRACKUID   0x63C5
177 #define MATROSKA_ID_TAGTARGETS_CHAPTERUID 0x63C4
178 #define MATROSKA_ID_TAGTARGETS_ATTACHUID  0x63C6
179
180 /* IDs in the seekhead master */
181 #define MATROSKA_ID_SEEKENTRY  0x4DBB
182
183 /* IDs in the seekpoint master */
184 #define MATROSKA_ID_SEEKID     0x53AB
185 #define MATROSKA_ID_SEEKPOSITION 0x53AC
186
187 /* IDs in the cluster master */
188 #define MATROSKA_ID_CLUSTERTIMECODE 0xE7
189 #define MATROSKA_ID_CLUSTERPOSITION 0xA7
190 #define MATROSKA_ID_CLUSTERPREVSIZE 0xAB
191 #define MATROSKA_ID_BLOCKGROUP 0xA0
192 #define MATROSKA_ID_BLOCKADDITIONS 0x75A1
193 #define MATROSKA_ID_BLOCKMORE 0xA6
194 #define MATROSKA_ID_BLOCKADDID 0xEE
195 #define MATROSKA_ID_BLOCKADDITIONAL 0xA5
196 #define MATROSKA_ID_SIMPLEBLOCK 0xA3
197
198 /* IDs in the blockgroup master */
199 #define MATROSKA_ID_BLOCK      0xA1
200 #define MATROSKA_ID_BLOCKDURATION 0x9B
201 #define MATROSKA_ID_BLOCKREFERENCE 0xFB
202 #define MATROSKA_ID_CODECSTATE 0xA4
203 #define MATROSKA_ID_DISCARDPADDING 0x75A2
204
205 /* IDs in the attachments master */
206 #define MATROSKA_ID_ATTACHEDFILE        0x61A7
207 #define MATROSKA_ID_FILEDESC            0x467E
208 #define MATROSKA_ID_FILENAME            0x466E
209 #define MATROSKA_ID_FILEMIMETYPE        0x4660
210 #define MATROSKA_ID_FILEDATA            0x465C
211 #define MATROSKA_ID_FILEUID             0x46AE
212
213 /* IDs in the chapters master */
214 #define MATROSKA_ID_EDITIONENTRY        0x45B9
215 #define MATROSKA_ID_CHAPTERATOM         0xB6
216 #define MATROSKA_ID_CHAPTERTIMESTART    0x91
217 #define MATROSKA_ID_CHAPTERTIMEEND      0x92
218 #define MATROSKA_ID_CHAPTERDISPLAY      0x80
219 #define MATROSKA_ID_CHAPSTRING          0x85
220 #define MATROSKA_ID_CHAPLANG            0x437C
221 #define MATROSKA_ID_EDITIONUID          0x45BC
222 #define MATROSKA_ID_EDITIONFLAGHIDDEN   0x45BD
223 #define MATROSKA_ID_EDITIONFLAGDEFAULT  0x45DB
224 #define MATROSKA_ID_EDITIONFLAGORDERED  0x45DD
225 #define MATROSKA_ID_CHAPTERUID          0x73C4
226 #define MATROSKA_ID_CHAPTERFLAGHIDDEN   0x98
227 #define MATROSKA_ID_CHAPTERFLAGENABLED  0x4598
228 #define MATROSKA_ID_CHAPTERPHYSEQUIV    0x63C3
229
230 typedef enum {
231   MATROSKA_TRACK_TYPE_NONE     = 0x0,
232   MATROSKA_TRACK_TYPE_VIDEO    = 0x1,
233   MATROSKA_TRACK_TYPE_AUDIO    = 0x2,
234   MATROSKA_TRACK_TYPE_COMPLEX  = 0x3,
235   MATROSKA_TRACK_TYPE_LOGO     = 0x10,
236   MATROSKA_TRACK_TYPE_SUBTITLE = 0x11,
237   MATROSKA_TRACK_TYPE_CONTROL  = 0x20,
238   MATROSKA_TRACK_TYPE_METADATA = 0x21,
239 } MatroskaTrackType;
240
241 typedef enum {
242   MATROSKA_TRACK_ENCODING_COMP_ZLIB        = 0,
243   MATROSKA_TRACK_ENCODING_COMP_BZLIB       = 1,
244   MATROSKA_TRACK_ENCODING_COMP_LZO         = 2,
245   MATROSKA_TRACK_ENCODING_COMP_HEADERSTRIP = 3,
246 } MatroskaTrackEncodingCompAlgo;
247
248 typedef enum {
249   MATROSKA_VIDEO_STEREOMODE_TYPE_MONO               = 0,
250   MATROSKA_VIDEO_STEREOMODE_TYPE_LEFT_RIGHT         = 1,
251   MATROSKA_VIDEO_STEREOMODE_TYPE_BOTTOM_TOP         = 2,
252   MATROSKA_VIDEO_STEREOMODE_TYPE_TOP_BOTTOM         = 3,
253   MATROSKA_VIDEO_STEREOMODE_TYPE_CHECKERBOARD_RL    = 4,
254   MATROSKA_VIDEO_STEREOMODE_TYPE_CHECKERBOARD_LR    = 5,
255   MATROSKA_VIDEO_STEREOMODE_TYPE_ROW_INTERLEAVED_RL = 6,
256   MATROSKA_VIDEO_STEREOMODE_TYPE_ROW_INTERLEAVED_LR = 7,
257   MATROSKA_VIDEO_STEREOMODE_TYPE_COL_INTERLEAVED_RL = 8,
258   MATROSKA_VIDEO_STEREOMODE_TYPE_COL_INTERLEAVED_LR = 9,
259   MATROSKA_VIDEO_STEREOMODE_TYPE_ANAGLYPH_CYAN_RED  = 10,
260   MATROSKA_VIDEO_STEREOMODE_TYPE_RIGHT_LEFT         = 11,
261   MATROSKA_VIDEO_STEREOMODE_TYPE_ANAGLYPH_GREEN_MAG = 12,
262   MATROSKA_VIDEO_STEREOMODE_TYPE_BOTH_EYES_BLOCK_LR = 13,
263   MATROSKA_VIDEO_STEREOMODE_TYPE_BOTH_EYES_BLOCK_RL = 14,
264 } MatroskaVideoStereoModeType;
265
266 /*
267  * Matroska Codec IDs, strings
268  */
269
270 typedef struct CodecTags{
271     char str[22];
272     enum AVCodecID id;
273 }CodecTags;
274
275 /* max. depth in the EBML tree structure */
276 #define EBML_MAX_DEPTH 16
277
278 #define MATROSKA_VIDEO_STEREO_MODE_COUNT  15
279 #define MATROSKA_VIDEO_STEREO_PLANE_COUNT  3
280
281 extern const CodecTags ff_mkv_codec_tags[];
282 extern const CodecMime ff_mkv_mime_tags[];
283 extern const AVMetadataConv ff_mkv_metadata_conv[];
284 extern const char * const ff_matroska_video_stereo_mode[MATROSKA_VIDEO_STEREO_MODE_COUNT];
285 extern const char * const ff_matroska_video_stereo_plane[MATROSKA_VIDEO_STEREO_PLANE_COUNT];
286
287 /* AVStream Metadata tag keys for WebM Dash Manifest */
288 #define INITIALIZATION_RANGE "webm_dash_manifest_initialization_range"
289 #define CUES_START "webm_dash_manifest_cues_start"
290 #define CUES_END "webm_dash_manifest_cues_end"
291 #define FILENAME "webm_dash_manifest_file_name"
292 #define BANDWIDTH "webm_dash_manifest_bandwidth"
293 #define DURATION "webm_dash_manifest_duration"
294 #define CLUSTER_KEYFRAME "webm_dash_manifest_cluster_keyframe"
295 #define CUE_TIMESTAMPS "webm_dash_manifest_cue_timestamps"
296 #define TRACK_NUMBER "webm_dash_manifest_track_number"
297 #define CODEC_PRIVATE_SIZE "webm_dash_manifest_codec_priv_size"
298
299 #endif /* AVFORMAT_MATROSKA_H */