matroskadec: Add support for parsing Matroska ContentEncKeyID
[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_TRACKNAME  0x536E
95 #define MATROSKA_ID_TRACKLANGUAGE 0x22B59C
96 #define MATROSKA_ID_TRACKFLAGENABLED 0xB9
97 #define MATROSKA_ID_TRACKFLAGDEFAULT 0x88
98 #define MATROSKA_ID_TRACKFLAGFORCED 0x55AA
99 #define MATROSKA_ID_TRACKFLAGLACING 0x9C
100 #define MATROSKA_ID_TRACKMINCACHE 0x6DE7
101 #define MATROSKA_ID_TRACKMAXCACHE 0x6DF8
102 #define MATROSKA_ID_TRACKDEFAULTDURATION 0x23E383
103 #define MATROSKA_ID_TRACKCONTENTENCODINGS 0x6D80
104 #define MATROSKA_ID_TRACKCONTENTENCODING 0x6240
105 #define MATROSKA_ID_TRACKTIMECODESCALE 0x23314F
106 #define MATROSKA_ID_TRACKMAXBLKADDID 0x55EE
107
108 /* IDs in the trackvideo master */
109 #define MATROSKA_ID_VIDEOFRAMERATE 0x2383E3
110 #define MATROSKA_ID_VIDEODISPLAYWIDTH 0x54B0
111 #define MATROSKA_ID_VIDEODISPLAYHEIGHT 0x54BA
112 #define MATROSKA_ID_VIDEOPIXELWIDTH 0xB0
113 #define MATROSKA_ID_VIDEOPIXELHEIGHT 0xBA
114 #define MATROSKA_ID_VIDEOPIXELCROPB 0x54AA
115 #define MATROSKA_ID_VIDEOPIXELCROPT 0x54BB
116 #define MATROSKA_ID_VIDEOPIXELCROPL 0x54CC
117 #define MATROSKA_ID_VIDEOPIXELCROPR 0x54DD
118 #define MATROSKA_ID_VIDEODISPLAYUNIT 0x54B2
119 #define MATROSKA_ID_VIDEOFLAGINTERLACED 0x9A
120 #define MATROSKA_ID_VIDEOSTEREOMODE 0x53B8
121 #define MATROSKA_ID_VIDEOALPHAMODE 0x53C0
122 #define MATROSKA_ID_VIDEOASPECTRATIO 0x54B3
123 #define MATROSKA_ID_VIDEOCOLORSPACE 0x2EB524
124
125 /* IDs in the trackaudio master */
126 #define MATROSKA_ID_AUDIOSAMPLINGFREQ 0xB5
127 #define MATROSKA_ID_AUDIOOUTSAMPLINGFREQ 0x78B5
128
129 #define MATROSKA_ID_AUDIOBITDEPTH 0x6264
130 #define MATROSKA_ID_AUDIOCHANNELS 0x9F
131
132 /* IDs in the content encoding master */
133 #define MATROSKA_ID_ENCODINGORDER 0x5031
134 #define MATROSKA_ID_ENCODINGSCOPE 0x5032
135 #define MATROSKA_ID_ENCODINGTYPE 0x5033
136 #define MATROSKA_ID_ENCODINGCOMPRESSION 0x5034
137 #define MATROSKA_ID_ENCODINGCOMPALGO 0x4254
138 #define MATROSKA_ID_ENCODINGCOMPSETTINGS 0x4255
139
140 #define MATROSKA_ID_ENCODINGENCRYPTION 0x5035
141 #define MATROSKA_ID_ENCODINGENCAESSETTINGS 0x47E7
142 #define MATROSKA_ID_ENCODINGENCALGO 0x47E1
143 #define MATROSKA_ID_ENCODINGENCKEYID 0x47E2
144 #define MATROSKA_ID_ENCODINGSIGALGO 0x47E5
145 #define MATROSKA_ID_ENCODINGSIGHASHALGO 0x47E6
146 #define MATROSKA_ID_ENCODINGSIGKEYID 0x47E4
147 #define MATROSKA_ID_ENCODINGSIGNATURE 0x47E3
148
149 /* ID in the cues master */
150 #define MATROSKA_ID_POINTENTRY 0xBB
151
152 /* IDs in the pointentry master */
153 #define MATROSKA_ID_CUETIME    0xB3
154 #define MATROSKA_ID_CUETRACKPOSITION 0xB7
155
156 /* IDs in the cuetrackposition master */
157 #define MATROSKA_ID_CUETRACK   0xF7
158 #define MATROSKA_ID_CUECLUSTERPOSITION 0xF1
159 #define MATROSKA_ID_CUEBLOCKNUMBER 0x5378
160
161 /* IDs in the tags master */
162 #define MATROSKA_ID_TAG                 0x7373
163 #define MATROSKA_ID_SIMPLETAG           0x67C8
164 #define MATROSKA_ID_TAGNAME             0x45A3
165 #define MATROSKA_ID_TAGSTRING           0x4487
166 #define MATROSKA_ID_TAGLANG             0x447A
167 #define MATROSKA_ID_TAGDEFAULT          0x4484
168 #define MATROSKA_ID_TAGDEFAULT_BUG      0x44B4
169 #define MATROSKA_ID_TAGTARGETS          0x63C0
170 #define MATROSKA_ID_TAGTARGETS_TYPE       0x63CA
171 #define MATROSKA_ID_TAGTARGETS_TYPEVALUE  0x68CA
172 #define MATROSKA_ID_TAGTARGETS_TRACKUID   0x63C5
173 #define MATROSKA_ID_TAGTARGETS_CHAPTERUID 0x63C4
174 #define MATROSKA_ID_TAGTARGETS_ATTACHUID  0x63C6
175
176 /* IDs in the seekhead master */
177 #define MATROSKA_ID_SEEKENTRY  0x4DBB
178
179 /* IDs in the seekpoint master */
180 #define MATROSKA_ID_SEEKID     0x53AB
181 #define MATROSKA_ID_SEEKPOSITION 0x53AC
182
183 /* IDs in the cluster master */
184 #define MATROSKA_ID_CLUSTERTIMECODE 0xE7
185 #define MATROSKA_ID_CLUSTERPOSITION 0xA7
186 #define MATROSKA_ID_CLUSTERPREVSIZE 0xAB
187 #define MATROSKA_ID_BLOCKGROUP 0xA0
188 #define MATROSKA_ID_BLOCKADDITIONS 0x75A1
189 #define MATROSKA_ID_BLOCKMORE 0xA6
190 #define MATROSKA_ID_BLOCKADDID 0xEE
191 #define MATROSKA_ID_BLOCKADDITIONAL 0xA5
192 #define MATROSKA_ID_SIMPLEBLOCK 0xA3
193
194 /* IDs in the blockgroup master */
195 #define MATROSKA_ID_BLOCK      0xA1
196 #define MATROSKA_ID_BLOCKDURATION 0x9B
197 #define MATROSKA_ID_BLOCKREFERENCE 0xFB
198
199 /* IDs in the attachments master */
200 #define MATROSKA_ID_ATTACHEDFILE        0x61A7
201 #define MATROSKA_ID_FILEDESC            0x467E
202 #define MATROSKA_ID_FILENAME            0x466E
203 #define MATROSKA_ID_FILEMIMETYPE        0x4660
204 #define MATROSKA_ID_FILEDATA            0x465C
205 #define MATROSKA_ID_FILEUID             0x46AE
206
207 /* IDs in the chapters master */
208 #define MATROSKA_ID_EDITIONENTRY        0x45B9
209 #define MATROSKA_ID_CHAPTERATOM         0xB6
210 #define MATROSKA_ID_CHAPTERTIMESTART    0x91
211 #define MATROSKA_ID_CHAPTERTIMEEND      0x92
212 #define MATROSKA_ID_CHAPTERDISPLAY      0x80
213 #define MATROSKA_ID_CHAPSTRING          0x85
214 #define MATROSKA_ID_CHAPLANG            0x437C
215 #define MATROSKA_ID_EDITIONUID          0x45BC
216 #define MATROSKA_ID_EDITIONFLAGHIDDEN   0x45BD
217 #define MATROSKA_ID_EDITIONFLAGDEFAULT  0x45DB
218 #define MATROSKA_ID_EDITIONFLAGORDERED  0x45DD
219 #define MATROSKA_ID_CHAPTERUID          0x73C4
220 #define MATROSKA_ID_CHAPTERFLAGHIDDEN   0x98
221 #define MATROSKA_ID_CHAPTERFLAGENABLED  0x4598
222 #define MATROSKA_ID_CHAPTERPHYSEQUIV    0x63C3
223
224 typedef enum {
225   MATROSKA_TRACK_TYPE_NONE     = 0x0,
226   MATROSKA_TRACK_TYPE_VIDEO    = 0x1,
227   MATROSKA_TRACK_TYPE_AUDIO    = 0x2,
228   MATROSKA_TRACK_TYPE_COMPLEX  = 0x3,
229   MATROSKA_TRACK_TYPE_LOGO     = 0x10,
230   MATROSKA_TRACK_TYPE_SUBTITLE = 0x11,
231   MATROSKA_TRACK_TYPE_CONTROL  = 0x20,
232 } MatroskaTrackType;
233
234 typedef enum {
235   MATROSKA_TRACK_ENCODING_COMP_ZLIB        = 0,
236   MATROSKA_TRACK_ENCODING_COMP_BZLIB       = 1,
237   MATROSKA_TRACK_ENCODING_COMP_LZO         = 2,
238   MATROSKA_TRACK_ENCODING_COMP_HEADERSTRIP = 3,
239 } MatroskaTrackEncodingCompAlgo;
240
241 typedef enum {
242   MATROSKA_VIDEO_STEREOMODE_TYPE_MONO               = 0,
243   MATROSKA_VIDEO_STEREOMODE_TYPE_LEFT_RIGHT         = 1,
244   MATROSKA_VIDEO_STEREOMODE_TYPE_BOTTOM_TOP         = 2,
245   MATROSKA_VIDEO_STEREOMODE_TYPE_TOP_BOTTOM         = 3,
246   MATROSKA_VIDEO_STEREOMODE_TYPE_CHECKERBOARD_RL    = 4,
247   MATROSKA_VIDEO_STEREOMODE_TYPE_CHECKERBOARD_LR    = 5,
248   MATROSKA_VIDEO_STEREOMODE_TYPE_ROW_INTERLEAVED_RL = 6,
249   MATROSKA_VIDEO_STEREOMODE_TYPE_ROW_INTERLEAVED_LR = 7,
250   MATROSKA_VIDEO_STEREOMODE_TYPE_COL_INTERLEAVED_RL = 8,
251   MATROSKA_VIDEO_STEREOMODE_TYPE_COL_INTERLEAVED_LR = 9,
252   MATROSKA_VIDEO_STEREOMODE_TYPE_ANAGLYPH_CYAN_RED  = 10,
253   MATROSKA_VIDEO_STEREOMODE_TYPE_RIGHT_LEFT         = 11,
254   MATROSKA_VIDEO_STEREOMODE_TYPE_ANAGLYPH_GREEN_MAG = 12,
255   MATROSKA_VIDEO_STEREOMODE_TYPE_BOTH_EYES_BLOCK_LR = 13,
256   MATROSKA_VIDEO_STEREOMODE_TYPE_BOTH_EYES_BLOCK_RL = 14,
257 } MatroskaVideoStereoModeType;
258
259 /*
260  * Matroska Codec IDs, strings
261  */
262
263 typedef struct CodecTags{
264     char str[20];
265     enum AVCodecID id;
266 }CodecTags;
267
268 /* max. depth in the EBML tree structure */
269 #define EBML_MAX_DEPTH 16
270
271 #define MATROSKA_VIDEO_STEREO_MODE_COUNT  15
272 #define MATROSKA_VIDEO_STEREO_PLANE_COUNT  3
273
274 extern const CodecTags ff_mkv_codec_tags[];
275 extern const CodecMime ff_mkv_mime_tags[];
276 extern const AVMetadataConv ff_mkv_metadata_conv[];
277 extern const char * const ff_matroska_video_stereo_mode[MATROSKA_VIDEO_STEREO_MODE_COUNT];
278 extern const char * const ff_matroska_video_stereo_plane[MATROSKA_VIDEO_STEREO_PLANE_COUNT];
279
280 #endif /* AVFORMAT_MATROSKA_H */