gst/matroska/: Try to fix up broken matroska files containing subtitle streams with...
[platform/upstream/gst-plugins-good.git] / gst / matroska / matroska-ids.h
1 /* GStreamer Matroska muxer/demuxer
2  * (c) 2003 Ronald Bultje <rbultje@ronald.bitfreak.net>
3  *
4  * matroska-ids.h: matroska file/stream data IDs
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public
17  * License along with this library; if not, write to the
18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19  * Boston, MA 02111-1307, USA.
20  */
21
22 #ifndef __GST_MATROSKA_IDS_H__
23 #define __GST_MATROSKA_IDS_H__
24
25 #include <gst/gst.h>
26
27 #include "ebml-ids.h"
28
29 /*
30  * Matroska element IDs. max. 32-bit.
31  */
32
33 /* toplevel segment */
34 #define GST_MATROSKA_ID_SEGMENT    0x18538067
35
36 /* matroska top-level master IDs */
37 #define GST_MATROSKA_ID_INFO       0x1549A966
38 #define GST_MATROSKA_ID_TRACKS     0x1654AE6B
39 #define GST_MATROSKA_ID_CUES       0x1C53BB6B
40 #define GST_MATROSKA_ID_TAGS       0x1254C367
41 #define GST_MATROSKA_ID_SEEKHEAD   0x114D9B74
42 #define GST_MATROSKA_ID_CLUSTER    0x1F43B675
43
44 /* IDs in the info master */
45 #define GST_MATROSKA_ID_TIMECODESCALE 0x2AD7B1
46 #define GST_MATROSKA_ID_DURATION   0x4489
47 #define GST_MATROSKA_ID_WRITINGAPP 0x5741
48 #define GST_MATROSKA_ID_MUXINGAPP  0x4D80
49 #define GST_MATROSKA_ID_DATEUTC    0x4461
50 #define GST_MATROSKA_ID_SEGMENTUID 0x73A4
51
52 /* ID in the tracks master */
53 #define GST_MATROSKA_ID_TRACKENTRY 0xAE
54
55 /* IDs in the trackentry master */
56 #define GST_MATROSKA_ID_TRACKNUMBER 0xD7
57 #define GST_MATROSKA_ID_TRACKUID   0x73C5
58 #define GST_MATROSKA_ID_TRACKTYPE  0x83
59 #define GST_MATROSKA_ID_TRACKAUDIO 0xE1
60 #define GST_MATROSKA_ID_TRACKVIDEO 0xE0
61 #define GST_MATROSKA_ID_CODECID    0x86
62 #define GST_MATROSKA_ID_CODECPRIVATE 0x63A2
63 #define GST_MATROSKA_ID_CODECNAME  0x258688
64 #define GST_MATROSKA_ID_CODECINFOURL 0x3B4040
65 #define GST_MATROSKA_ID_CODECDOWNLOADURL 0x26B240
66 #define GST_MATROSKA_ID_TRACKNAME  0x536E
67 #define GST_MATROSKA_ID_TRACKLANGUAGE 0x22B59C
68 #define GST_MATROSKA_ID_TRACKFLAGENABLED 0xB9
69 #define GST_MATROSKA_ID_TRACKFLAGDEFAULT 0x88
70 #define GST_MATROSKA_ID_TRACKFLAGLACING 0x9C
71 #define GST_MATROSKA_ID_TRACKMINCACHE 0x6DE7
72 #define GST_MATROSKA_ID_TRACKMAXCACHE 0x6DF8
73 #define GST_MATROSKA_ID_TRACKDEFAULTDURATION 0x23E383
74
75 /* IDs in the trackvideo master */
76 #define GST_MATROSKA_ID_VIDEOFRAMERATE 0x2383E3
77 #define GST_MATROSKA_ID_VIDEODISPLAYWIDTH 0x54B0
78 #define GST_MATROSKA_ID_VIDEODISPLAYHEIGHT 0x54BA
79 #define GST_MATROSKA_ID_VIDEOPIXELWIDTH 0xB0
80 #define GST_MATROSKA_ID_VIDEOPIXELHEIGHT 0xBA
81 #define GST_MATROSKA_ID_VIDEOFLAGINTERLACED 0x9A
82 #define GST_MATROSKA_ID_VIDEOSTEREOMODE 0x53B9
83 #define GST_MATROSKA_ID_VIDEOASPECTRATIO 0x54B3
84 #define GST_MATROSKA_ID_VIDEOCOLOURSPACE 0x2EB524
85
86 /* IDs in the trackaudio master */
87 #define GST_MATROSKA_ID_AUDIOSAMPLINGFREQ 0xB5
88 #define GST_MATROSKA_ID_AUDIOBITDEPTH 0x6264
89 #define GST_MATROSKA_ID_AUDIOCHANNELS 0x9F
90
91 /* ID in the cues master */
92 #define GST_MATROSKA_ID_POINTENTRY 0xBB
93
94 /* IDs in the pointentry master */
95 #define GST_MATROSKA_ID_CUETIME    0xB3
96 #define GST_MATROSKA_ID_CUETRACKPOSITION 0xB7
97
98 /* IDs in the cuetrackposition master */
99 #define GST_MATROSKA_ID_CUETRACK   0xF7
100 #define GST_MATROSKA_ID_CUECLUSTERPOSITION 0xF1
101
102 /* IDs in the tags master */
103 #define GST_MATROSKA_ID_TAG        0x7373
104
105 /* in the tag master */
106 #define GST_MATROSKA_ID_SIMPLETAG  0x67C8
107
108 /* in the simpletag master */
109 #define GST_MATROSKA_ID_TAGNAME    0x45A3
110 #define GST_MATROSKA_ID_TAGSTRING  0x4487
111
112 /* IDs in the seekhead master */
113 #define GST_MATROSKA_ID_SEEKENTRY  0x4DBB
114
115 /* IDs in the seekpoint master */
116 #define GST_MATROSKA_ID_SEEKID     0x53AB
117 #define GST_MATROSKA_ID_SEEKPOSITION 0x53AC
118
119 /* IDs in the cluster master */
120 #define GST_MATROSKA_ID_CLUSTERTIMECODE 0xE7
121 #define GST_MATROSKA_ID_BLOCKGROUP 0xA0
122 #define GST_MATROSKA_ID_SIMPLEBLOCK 0xA3
123 #define GST_MATROSKA_ID_REFERENCEBLOCK 0xFB
124
125 /* IDs in the blockgroup master */
126 #define GST_MATROSKA_ID_BLOCK      0xA1
127 #define GST_MATROSKA_ID_BLOCKDURATION 0x9B
128
129 /*
130  * Matroska Codec IDs. Strings.
131  */
132
133 #define GST_MATROSKA_CODEC_ID_VIDEO_VFW_FOURCC   "V_MS/VFW/FOURCC"
134 #define GST_MATROSKA_CODEC_ID_VIDEO_UNCOMPRESSED "V_UNCOMPRESSED"
135 #define GST_MATROSKA_CODEC_ID_VIDEO_MPEG4_SP     "V_MPEG4/ISO/SP"
136 #define GST_MATROSKA_CODEC_ID_VIDEO_MPEG4_ASP    "V_MPEG4/ISO/ASP"
137 #define GST_MATROSKA_CODEC_ID_VIDEO_MPEG4_AP     "V_MPEG4/ISO/AP"
138 #define GST_MATROSKA_CODEC_ID_VIDEO_MPEG4_AVC    "V_MPEG4/ISO/AVC"
139 #define GST_MATROSKA_CODEC_ID_VIDEO_MSMPEG4V3    "V_MPEG4/MS/V3"
140 #define GST_MATROSKA_CODEC_ID_VIDEO_MPEG1        "V_MPEG1"
141 #define GST_MATROSKA_CODEC_ID_VIDEO_MPEG2        "V_MPEG2"
142 #define GST_MATROSKA_CODEC_ID_VIDEO_MJPEG        "V_MJPEG"
143 #define GST_MATROSKA_CODEC_ID_VIDEO_REALVIDEO1   "V_REAL/RV10"
144 #define GST_MATROSKA_CODEC_ID_VIDEO_REALVIDEO2   "V_REAL/RV20"
145 #define GST_MATROSKA_CODEC_ID_VIDEO_REALVIDEO3   "V_REAL/RV30"
146 #define GST_MATROSKA_CODEC_ID_VIDEO_REALVIDEO4   "V_REAL/RV40"
147 #define GST_MATROSKA_CODEC_ID_VIDEO_THEORA       "V_THEORA"
148 /* TODO: Quicktime */
149
150 #define GST_MATROSKA_CODEC_ID_AUDIO_MPEG1_L1     "A_MPEG/L1"
151 #define GST_MATROSKA_CODEC_ID_AUDIO_MPEG1_L2     "A_MPEG/L2"
152 #define GST_MATROSKA_CODEC_ID_AUDIO_MPEG1_L3     "A_MPEG/L3"
153 #define GST_MATROSKA_CODEC_ID_AUDIO_PCM_INT_BE   "A_PCM/INT/BIG"
154 #define GST_MATROSKA_CODEC_ID_AUDIO_PCM_INT_LE   "A_PCM/INT/LIT"
155 #define GST_MATROSKA_CODEC_ID_AUDIO_PCM_FLOAT    "A_PCM/FLOAT/IEEE"
156 #define GST_MATROSKA_CODEC_ID_AUDIO_AC3          "A_AC3"
157 #define GST_MATROSKA_CODEC_ID_AUDIO_DTS          "A_DTS"
158 #define GST_MATROSKA_CODEC_ID_AUDIO_VORBIS       "A_VORBIS"
159 #define GST_MATROSKA_CODEC_ID_AUDIO_ACM          "A_MS/ACM"
160 #define GST_MATROSKA_CODEC_ID_AUDIO_MPEG2        "A_AAC/MPEG2/"
161 #define GST_MATROSKA_CODEC_ID_AUDIO_MPEG4        "A_AAC/MPEG4/"
162 #define GST_MATROSKA_CODEC_ID_AUDIO_TTA          "A_TTA1"
163 #define GST_MATROSKA_CODEC_ID_AUDIO_WAVPACK4     "A_WAVPACK4"
164 #define GST_MATROSKA_CODEC_ID_AUDIO_REAL_14_4    "A_REAL/28_8"
165 #define GST_MATROSKA_CODEC_ID_AUDIO_REAL_28_8    "A_REAL/28_8"
166 #define GST_MATROSKA_CODEC_ID_AUDIO_REAL_COOK    "A_REAL/COOK"
167 #define GST_MATROSKA_CODEC_ID_AUDIO_REAL_SIPR    "A_REAL/SIPR"
168 #define GST_MATROSKA_CODEC_ID_AUDIO_REAL_RALF    "A_REAL/RALF"
169 #define GST_MATROSKA_CODEC_ID_AUDIO_REAL_ATRC    "A_REAL/ATRC"
170
171 /* TODO: AC3-9/10 (?), Musepack, Quicktime */
172
173 #define GST_MATROSKA_CODEC_ID_SUBTITLE_UTF8      "S_TEXT/UTF8"
174 #define GST_MATROSKA_CODEC_ID_SUBTITLE_SSA       "S_TEXT/SSA"
175 #define GST_MATROSKA_CODEC_ID_SUBTITLE_ASS       "S_TEXT/ASS" 
176 #define GST_MATROSKA_CODEC_ID_SUBTITLE_USF       "S_TEXT/USF"
177
178 /*
179  * Matrodka tags. Strings.
180  */
181
182 #define GST_MATROSKA_TAG_ID_TITLE    "TITLE"
183 #define GST_MATROSKA_TAG_ID_AUTHOR   "AUTHOR"
184 #define GST_MATROSKA_TAG_ID_ALBUM    "ALBUM"
185 #define GST_MATROSKA_TAG_ID_COMMENTS "COMMENTS"
186 #define GST_MATROSKA_TAG_ID_BITSPS   "BITSPS"
187 #define GST_MATROSKA_TAG_ID_ENCODER  "ENCODER"
188 #define GST_MATROSKA_TAG_ID_DATE     "DATE"
189 #define GST_MATROSKA_TAG_ID_ISRC     "ISRC"
190 #define GST_MATROSKA_TAG_ID_COPYRIGHT "COPYRIGHT"
191
192 /*
193  * Enumerations for various types (mapping from binary
194  * value to what it actually means).
195  */
196
197 typedef enum {
198   GST_MATROSKA_TRACK_TYPE_VIDEO    = 0x1,
199   GST_MATROSKA_TRACK_TYPE_AUDIO    = 0x2,
200   GST_MATROSKA_TRACK_TYPE_COMPLEX  = 0x3,
201   GST_MATROSKA_TRACK_TYPE_LOGO     = 0x10,
202   GST_MATROSKA_TRACK_TYPE_SUBTITLE = 0x11,
203   GST_MATROSKA_TRACK_TYPE_CONTROL  = 0x20,
204 } GstMatroskaTrackType;
205
206 typedef enum {
207   GST_MATROSKA_EYE_MODE_MONO  = 0x0,
208   GST_MATROSKA_EYE_MODE_RIGHT = 0x1,
209   GST_MATROSKA_EYE_MODE_LEFT  = 0x2,
210   GST_MATROSKA_EYE_MODE_BOTH  = 0x3,
211 } GstMatroskaEyeMode;
212
213 typedef enum {
214   GST_MATROSKA_ASPECT_RATIO_MODE_FREE  = 0x0,
215   GST_MATROSKA_ASPECT_RATIO_MODE_KEEP  = 0x1,
216   GST_MATROSKA_ASPECT_RATIO_MODE_FIXED = 0x2,
217 } GstMatroskaAspectRatioMode;
218
219 /*
220  * These aren't in any way "matroska-form" things,
221  * it's just something I use in the muxer/demuxer.
222  */
223
224 typedef enum {
225   GST_MATROSKA_TRACK_ENABLED = (1<<0),
226   GST_MATROSKA_TRACK_DEFAULT = (1<<1),
227   GST_MATROSKA_TRACK_LACING  = (1<<2),
228   GST_MATROSKA_TRACK_SHIFT   = (1<<16)
229 } GstMatroskaTrackFlags;
230
231 typedef enum {
232   GST_MATROSKA_VIDEOTRACK_INTERLACED = (GST_MATROSKA_TRACK_SHIFT<<0)
233 } GstMatroskaVideoTrackFlags;
234
235 typedef struct _GstMatroskaTrackContext {
236   GstPad       *pad;
237   GstCaps      *caps;
238   guint         index;
239
240   /* some often-used info */
241   gchar        *codec_id, *codec_name, *name, *language;
242   gpointer      codec_priv;
243   guint         codec_priv_size;
244   GstMatroskaTrackType type;
245   guint         uid, num;
246   GstMatroskaTrackFlags flags;
247   guint64       default_duration;
248   guint64       pos;
249
250   gboolean      set_discont; /* TRUE = set DISCONT flag on next buffer */
251
252   /* Special flag for Vorbis and Theora, for which we need to send
253    * codec_priv first before sending any data, and just testing
254    * for time == 0 is not enough to detect that. Used by demuxer */
255   gboolean      send_xiph_headers;
256
257   /* Special counter for muxer to skip the first N vorbis/theora headers -
258    * they are put into codec private data, not muxed into the stream */
259   guint         xiph_headers_to_skip;
260 } GstMatroskaTrackContext;
261
262 typedef struct _GstMatroskaTrackVideoContext {
263   GstMatroskaTrackContext parent;
264
265   guint         pixel_width, pixel_height,
266                 display_width, display_height;
267   GstMatroskaEyeMode eye_mode;
268   GstMatroskaAspectRatioMode asr_mode;
269   guint32       fourcc;
270 } GstMatroskaTrackVideoContext;
271
272 typedef struct _GstMatroskaTrackAudioContext {
273   GstMatroskaTrackContext parent;
274
275   guint         samplerate, channels, bitdepth;
276 } GstMatroskaTrackAudioContext;
277
278 typedef struct _GstMatroskaTrackComplexContext {
279   GstMatroskaTrackContext parent;
280
281   /* nothing special goes here, apparently */
282 } GstMatroskaTrackComplexContext;
283
284 typedef struct _GstMatroskaTrackSubtitleContext {
285   GstMatroskaTrackContext parent;
286
287   gboolean    check_utf8;     /* buffers should be valid UTF-8 */
288   gboolean    invalid_utf8;   /* work around broken files      */
289 } GstMatroskaTrackSubtitleContext;
290
291 typedef struct _GstMatroskaIndex {
292   guint64        pos;   /* of the corresponding *cluster*! */
293   guint16        track; /* reference to 'num' */
294   guint64        time;  /* in nanoseconds */
295 } GstMatroskaIndex;
296
297 typedef struct _Wavpack4Header {
298   guchar  ck_id [4];     /* "wvpk"                                         */
299   guint32 ck_size;       /* size of entire frame (minus 8, of course)      */
300   guint16 version;       /* 0x403 for now                                  */
301   guint8  track_no;      /* track number (0 if not used, like now)         */
302   guint8  index_no;      /* remember these? (0 if not used, like now)      */
303   guint32 total_samples; /* for entire file (-1 if unknown)                */
304   guint32 block_index;   /* index of first sample in block (to file begin) */
305   guint32 block_samples; /* # samples in this block                        */
306   guint32 flags;         /* various flags for id and decoding              */
307   guint32 crc;           /* crc for actual decoded data                    */
308 } Wavpack4Header;
309
310 gboolean gst_matroska_track_init_video_context    (GstMatroskaTrackContext ** p_context);
311 gboolean gst_matroska_track_init_audio_context    (GstMatroskaTrackContext ** p_context);
312 gboolean gst_matroska_track_init_subtitle_context (GstMatroskaTrackContext ** p_context);
313 gboolean gst_matroska_track_init_complex_context  (GstMatroskaTrackContext ** p_context);
314
315 #endif /* __GST_MATROSKA_IDS_H__ */