split some common code from the mkv demuxer that will be useful to the muxer
[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 MATROSKA_H
23 #define MATROSKA_H
24
25 #include "avcodec.h"
26
27 /* EBML version supported */
28 #define EBML_VERSION 1
29
30 /* top-level master-IDs */
31 #define EBML_ID_HEADER             0x1A45DFA3
32
33 /* IDs in the HEADER master */
34 #define EBML_ID_EBMLVERSION        0x4286
35 #define EBML_ID_EBMLREADVERSION    0x42F7
36 #define EBML_ID_EBMLMAXIDLENGTH    0x42F2
37 #define EBML_ID_EBMLMAXSIZELENGTH  0x42F3
38 #define EBML_ID_DOCTYPE            0x4282
39 #define EBML_ID_DOCTYPEVERSION     0x4287
40 #define EBML_ID_DOCTYPEREADVERSION 0x4285
41
42 /* general EBML types */
43 #define EBML_ID_VOID               0xEC
44
45 /*
46  * Matroska element IDs. max. 32-bit.
47  */
48
49 /* toplevel segment */
50 #define MATROSKA_ID_SEGMENT    0x18538067
51
52 /* matroska top-level master IDs */
53 #define MATROSKA_ID_INFO       0x1549A966
54 #define MATROSKA_ID_TRACKS     0x1654AE6B
55 #define MATROSKA_ID_CUES       0x1C53BB6B
56 #define MATROSKA_ID_TAGS       0x1254C367
57 #define MATROSKA_ID_SEEKHEAD   0x114D9B74
58 #define MATROSKA_ID_CLUSTER    0x1F43B675
59
60 /* IDs in the info master */
61 #define MATROSKA_ID_TIMECODESCALE 0x2AD7B1
62 #define MATROSKA_ID_DURATION   0x4489
63 #define MATROSKA_ID_TITLE      0x7BA9
64 #define MATROSKA_ID_WRITINGAPP 0x5741
65 #define MATROSKA_ID_MUXINGAPP  0x4D80
66 #define MATROSKA_ID_DATEUTC    0x4461
67
68 /* ID in the tracks master */
69 #define MATROSKA_ID_TRACKENTRY 0xAE
70
71 /* IDs in the trackentry master */
72 #define MATROSKA_ID_TRACKNUMBER 0xD7
73 #define MATROSKA_ID_TRACKUID   0x73C5
74 #define MATROSKA_ID_TRACKTYPE  0x83
75 #define MATROSKA_ID_TRACKAUDIO 0xE1
76 #define MATROSKA_ID_TRACKVIDEO 0xE0
77 #define MATROSKA_ID_CODECID    0x86
78 #define MATROSKA_ID_CODECPRIVATE 0x63A2
79 #define MATROSKA_ID_CODECNAME  0x258688
80 #define MATROSKA_ID_CODECINFOURL 0x3B4040
81 #define MATROSKA_ID_CODECDOWNLOADURL 0x26B240
82 #define MATROSKA_ID_TRACKNAME  0x536E
83 #define MATROSKA_ID_TRACKLANGUAGE 0x22B59C
84 #define MATROSKA_ID_TRACKFLAGENABLED 0xB9
85 #define MATROSKA_ID_TRACKFLAGDEFAULT 0x88
86 #define MATROSKA_ID_TRACKFLAGLACING 0x9C
87 #define MATROSKA_ID_TRACKMINCACHE 0x6DE7
88 #define MATROSKA_ID_TRACKMAXCACHE 0x6DF8
89 #define MATROSKA_ID_TRACKDEFAULTDURATION 0x23E383
90
91 /* IDs in the trackvideo master */
92 #define MATROSKA_ID_VIDEOFRAMERATE 0x2383E3
93 #define MATROSKA_ID_VIDEODISPLAYWIDTH 0x54B0
94 #define MATROSKA_ID_VIDEODISPLAYHEIGHT 0x54BA
95 #define MATROSKA_ID_VIDEOPIXELWIDTH 0xB0
96 #define MATROSKA_ID_VIDEOPIXELHEIGHT 0xBA
97 #define MATROSKA_ID_VIDEOFLAGINTERLACED 0x9A
98 #define MATROSKA_ID_VIDEOSTEREOMODE 0x53B9
99 #define MATROSKA_ID_VIDEOASPECTRATIO 0x54B3
100 #define MATROSKA_ID_VIDEOCOLOURSPACE 0x2EB524
101
102 /* IDs in the trackaudio master */
103 #define MATROSKA_ID_AUDIOSAMPLINGFREQ 0xB5
104 #define MATROSKA_ID_AUDIOOUTSAMPLINGFREQ 0x78B5
105
106 #define MATROSKA_ID_AUDIOBITDEPTH 0x6264
107 #define MATROSKA_ID_AUDIOCHANNELS 0x9F
108
109 /* ID in the cues master */
110 #define MATROSKA_ID_POINTENTRY 0xBB
111
112 /* IDs in the pointentry master */
113 #define MATROSKA_ID_CUETIME    0xB3
114 #define MATROSKA_ID_CUETRACKPOSITION 0xB7
115
116 /* IDs in the cuetrackposition master */
117 #define MATROSKA_ID_CUETRACK   0xF7
118 #define MATROSKA_ID_CUECLUSTERPOSITION 0xF1
119
120 /* IDs in the tags master */
121 /* TODO */
122
123 /* IDs in the seekhead master */
124 #define MATROSKA_ID_SEEKENTRY  0x4DBB
125
126 /* IDs in the seekpoint master */
127 #define MATROSKA_ID_SEEKID     0x53AB
128 #define MATROSKA_ID_SEEKPOSITION 0x53AC
129
130 /* IDs in the cluster master */
131 #define MATROSKA_ID_CLUSTERTIMECODE 0xE7
132 #define MATROSKA_ID_BLOCKGROUP 0xA0
133 #define MATROSKA_ID_SIMPLEBLOCK 0xA3
134
135 /* IDs in the blockgroup master */
136 #define MATROSKA_ID_BLOCK      0xA1
137 #define MATROSKA_ID_BLOCKDURATION 0x9B
138 #define MATROSKA_ID_BLOCKREFERENCE 0xFB
139
140 typedef enum {
141   MATROSKA_TRACK_TYPE_VIDEO    = 0x1,
142   MATROSKA_TRACK_TYPE_AUDIO    = 0x2,
143   MATROSKA_TRACK_TYPE_COMPLEX  = 0x3,
144   MATROSKA_TRACK_TYPE_LOGO     = 0x10,
145   MATROSKA_TRACK_TYPE_SUBTITLE = 0x11,
146   MATROSKA_TRACK_TYPE_CONTROL  = 0x20,
147 } MatroskaTrackType;
148
149 typedef enum {
150   MATROSKA_EYE_MODE_MONO  = 0x0,
151   MATROSKA_EYE_MODE_RIGHT = 0x1,
152   MATROSKA_EYE_MODE_LEFT  = 0x2,
153   MATROSKA_EYE_MODE_BOTH  = 0x3,
154 } MatroskaEyeMode;
155
156 typedef enum {
157   MATROSKA_ASPECT_RATIO_MODE_FREE  = 0x0,
158   MATROSKA_ASPECT_RATIO_MODE_KEEP  = 0x1,
159   MATROSKA_ASPECT_RATIO_MODE_FIXED = 0x2,
160 } MatroskaAspectRatioMode;
161
162 /*
163  * These aren't in any way "matroska-form" things,
164  * it's just something I use in the muxer/demuxer.
165  */
166
167 typedef enum {
168   MATROSKA_TRACK_ENABLED = (1<<0),
169   MATROSKA_TRACK_DEFAULT = (1<<1),
170   MATROSKA_TRACK_LACING  = (1<<2),
171   MATROSKA_TRACK_REAL_V  = (1<<4),
172   MATROSKA_TRACK_SHIFT   = (1<<16)
173 } MatroskaTrackFlags;
174
175 typedef enum {
176   MATROSKA_VIDEOTRACK_INTERLACED = (MATROSKA_TRACK_SHIFT<<0)
177 } MatroskaVideoTrackFlags;
178
179 /*
180  * Matroska Codec IDs. Strings.
181  */
182
183 typedef struct CodecTags{
184     const char *str;
185     enum CodecID id;
186 }CodecTags;
187
188 #define MATROSKA_CODEC_ID_VIDEO_VFW_FOURCC   "V_MS/VFW/FOURCC"
189 #define MATROSKA_CODEC_ID_AUDIO_ACM          "A_MS/ACM"
190
191 /* max. depth in the EBML tree structure */
192 #define EBML_MAX_DEPTH 16
193
194 extern CodecTags ff_mkv_codec_tags[];
195
196 #endif /* MATROSKA_H */