gst/matroska/: Add support for VOBSUB subtitle tracks and zlib-compressed tracks...
[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 #define GST_MATROSKA_ID_CONTENTENCODINGS 0x6D80
75
76 /* IDs in the trackvideo master */
77 #define GST_MATROSKA_ID_VIDEOFRAMERATE 0x2383E3
78 #define GST_MATROSKA_ID_VIDEODISPLAYWIDTH 0x54B0
79 #define GST_MATROSKA_ID_VIDEODISPLAYHEIGHT 0x54BA
80 #define GST_MATROSKA_ID_VIDEOPIXELWIDTH 0xB0
81 #define GST_MATROSKA_ID_VIDEOPIXELHEIGHT 0xBA
82 #define GST_MATROSKA_ID_VIDEOFLAGINTERLACED 0x9A
83 #define GST_MATROSKA_ID_VIDEOSTEREOMODE 0x53B9
84 #define GST_MATROSKA_ID_VIDEOASPECTRATIO 0x54B3
85 #define GST_MATROSKA_ID_VIDEOCOLOURSPACE 0x2EB524
86
87 /* IDs in the trackaudio master */
88 #define GST_MATROSKA_ID_AUDIOSAMPLINGFREQ 0xB5
89 #define GST_MATROSKA_ID_AUDIOBITDEPTH 0x6264
90 #define GST_MATROSKA_ID_AUDIOCHANNELS 0x9F
91
92 /* ID in the cues master */
93 #define GST_MATROSKA_ID_POINTENTRY 0xBB
94
95 /* IDs in the pointentry master */
96 #define GST_MATROSKA_ID_CUETIME    0xB3
97 #define GST_MATROSKA_ID_CUETRACKPOSITION 0xB7
98
99 /* IDs in the cuetrackposition master */
100 #define GST_MATROSKA_ID_CUETRACK   0xF7
101 #define GST_MATROSKA_ID_CUECLUSTERPOSITION 0xF1
102
103 /* IDs in the tags master */
104 #define GST_MATROSKA_ID_TAG        0x7373
105
106 /* in the tag master */
107 #define GST_MATROSKA_ID_SIMPLETAG  0x67C8
108
109 /* in the simpletag master */
110 #define GST_MATROSKA_ID_TAGNAME    0x45A3
111 #define GST_MATROSKA_ID_TAGSTRING  0x4487
112
113 /* IDs in the seekhead master */
114 #define GST_MATROSKA_ID_SEEKENTRY  0x4DBB
115
116 /* IDs in the seekpoint master */
117 #define GST_MATROSKA_ID_SEEKID     0x53AB
118 #define GST_MATROSKA_ID_SEEKPOSITION 0x53AC
119
120 /* IDs in the cluster master */
121 #define GST_MATROSKA_ID_CLUSTERTIMECODE 0xE7
122 #define GST_MATROSKA_ID_BLOCKGROUP 0xA0
123 #define GST_MATROSKA_ID_SIMPLEBLOCK 0xA3
124 #define GST_MATROSKA_ID_REFERENCEBLOCK 0xFB
125
126 /* IDs in the blockgroup master */
127 #define GST_MATROSKA_ID_BLOCK      0xA1
128 #define GST_MATROSKA_ID_BLOCKDURATION 0x9B
129
130 /* IDs in the contentencodings master */
131 #define GST_MATROSKA_ID_CONTENTENCODING 0x6240
132
133 /* IDS IN THE CONTENTENCODING MASTER */
134 #define GST_MATROSKA_ID_CONTENTENCODINGORDER 0X5031
135 #define GST_MATROSKA_ID_CONTENTENCODINGSCOPE 0X5032
136 #define GST_MATROSKA_ID_CONTENTENCODINGTYPE  0X5033
137 #define GST_MATROSKA_ID_CONTENTCOMPRESSION   0X5034
138 #define GST_MATROSKA_ID_CONTENTENCRYPTION    0X5035
139
140 /* IDS IN THE CONTENTCOMPRESSION MASTER */
141 #define GST_MATROSKA_ID_CONTENTCOMPALGO      0X4254
142 #define GST_MATROSKA_ID_CONTENTCOMPSETTINGS  0X4255
143
144
145 /*
146  * Matroska Codec IDs. Strings.
147  */
148
149 #define GST_MATROSKA_CODEC_ID_VIDEO_VFW_FOURCC   "V_MS/VFW/FOURCC"
150 #define GST_MATROSKA_CODEC_ID_VIDEO_UNCOMPRESSED "V_UNCOMPRESSED"
151 #define GST_MATROSKA_CODEC_ID_VIDEO_MPEG4_SP     "V_MPEG4/ISO/SP"
152 #define GST_MATROSKA_CODEC_ID_VIDEO_MPEG4_ASP    "V_MPEG4/ISO/ASP"
153 #define GST_MATROSKA_CODEC_ID_VIDEO_MPEG4_AP     "V_MPEG4/ISO/AP"
154 #define GST_MATROSKA_CODEC_ID_VIDEO_MPEG4_AVC    "V_MPEG4/ISO/AVC"
155 #define GST_MATROSKA_CODEC_ID_VIDEO_MSMPEG4V3    "V_MPEG4/MS/V3"
156 #define GST_MATROSKA_CODEC_ID_VIDEO_MPEG1        "V_MPEG1"
157 #define GST_MATROSKA_CODEC_ID_VIDEO_MPEG2        "V_MPEG2"
158 #define GST_MATROSKA_CODEC_ID_VIDEO_MJPEG        "V_MJPEG"
159 #define GST_MATROSKA_CODEC_ID_VIDEO_REALVIDEO1   "V_REAL/RV10"
160 #define GST_MATROSKA_CODEC_ID_VIDEO_REALVIDEO2   "V_REAL/RV20"
161 #define GST_MATROSKA_CODEC_ID_VIDEO_REALVIDEO3   "V_REAL/RV30"
162 #define GST_MATROSKA_CODEC_ID_VIDEO_REALVIDEO4   "V_REAL/RV40"
163 #define GST_MATROSKA_CODEC_ID_VIDEO_THEORA       "V_THEORA"
164 /* TODO: Quicktime */
165
166 #define GST_MATROSKA_CODEC_ID_AUDIO_MPEG1_L1     "A_MPEG/L1"
167 #define GST_MATROSKA_CODEC_ID_AUDIO_MPEG1_L2     "A_MPEG/L2"
168 #define GST_MATROSKA_CODEC_ID_AUDIO_MPEG1_L3     "A_MPEG/L3"
169 #define GST_MATROSKA_CODEC_ID_AUDIO_PCM_INT_BE   "A_PCM/INT/BIG"
170 #define GST_MATROSKA_CODEC_ID_AUDIO_PCM_INT_LE   "A_PCM/INT/LIT"
171 #define GST_MATROSKA_CODEC_ID_AUDIO_PCM_FLOAT    "A_PCM/FLOAT/IEEE"
172 #define GST_MATROSKA_CODEC_ID_AUDIO_AC3          "A_AC3"
173 #define GST_MATROSKA_CODEC_ID_AUDIO_DTS          "A_DTS"
174 #define GST_MATROSKA_CODEC_ID_AUDIO_VORBIS       "A_VORBIS"
175 #define GST_MATROSKA_CODEC_ID_AUDIO_FLAC         "A_FLAC"
176 #define GST_MATROSKA_CODEC_ID_AUDIO_ACM          "A_MS/ACM"
177 #define GST_MATROSKA_CODEC_ID_AUDIO_MPEG2        "A_AAC/MPEG2/"
178 #define GST_MATROSKA_CODEC_ID_AUDIO_MPEG4        "A_AAC/MPEG4/"
179 #define GST_MATROSKA_CODEC_ID_AUDIO_TTA          "A_TTA1"
180 #define GST_MATROSKA_CODEC_ID_AUDIO_WAVPACK4     "A_WAVPACK4"
181 #define GST_MATROSKA_CODEC_ID_AUDIO_REAL_14_4    "A_REAL/28_8"
182 #define GST_MATROSKA_CODEC_ID_AUDIO_REAL_28_8    "A_REAL/28_8"
183 #define GST_MATROSKA_CODEC_ID_AUDIO_REAL_COOK    "A_REAL/COOK"
184 #define GST_MATROSKA_CODEC_ID_AUDIO_REAL_SIPR    "A_REAL/SIPR"
185 #define GST_MATROSKA_CODEC_ID_AUDIO_REAL_RALF    "A_REAL/RALF"
186 #define GST_MATROSKA_CODEC_ID_AUDIO_REAL_ATRC    "A_REAL/ATRC"
187
188 /* TODO: AC3-9/10 (?), Musepack, Quicktime */
189
190 #define GST_MATROSKA_CODEC_ID_SUBTITLE_UTF8      "S_TEXT/UTF8"
191 #define GST_MATROSKA_CODEC_ID_SUBTITLE_SSA       "S_TEXT/SSA"
192 #define GST_MATROSKA_CODEC_ID_SUBTITLE_ASS       "S_TEXT/ASS" 
193 #define GST_MATROSKA_CODEC_ID_SUBTITLE_USF       "S_TEXT/USF"
194 #define GST_MATROSKA_CODEC_ID_SUBTITLE_VOBSUB    "S_VOBSUB"
195
196 /*
197  * Matrodka tags. Strings.
198  */
199
200 #define GST_MATROSKA_TAG_ID_TITLE    "TITLE"
201 #define GST_MATROSKA_TAG_ID_AUTHOR   "AUTHOR"
202 #define GST_MATROSKA_TAG_ID_ALBUM    "ALBUM"
203 #define GST_MATROSKA_TAG_ID_COMMENTS "COMMENTS"
204 #define GST_MATROSKA_TAG_ID_BITSPS   "BITSPS"
205 #define GST_MATROSKA_TAG_ID_ENCODER  "ENCODER"
206 #define GST_MATROSKA_TAG_ID_DATE     "DATE"
207 #define GST_MATROSKA_TAG_ID_ISRC     "ISRC"
208 #define GST_MATROSKA_TAG_ID_COPYRIGHT "COPYRIGHT"
209
210 /*
211  * Enumerations for various types (mapping from binary
212  * value to what it actually means).
213  */
214
215 typedef enum {
216   GST_MATROSKA_TRACK_TYPE_VIDEO    = 0x1,
217   GST_MATROSKA_TRACK_TYPE_AUDIO    = 0x2,
218   GST_MATROSKA_TRACK_TYPE_COMPLEX  = 0x3,
219   GST_MATROSKA_TRACK_TYPE_LOGO     = 0x10,
220   GST_MATROSKA_TRACK_TYPE_SUBTITLE = 0x11,
221   GST_MATROSKA_TRACK_TYPE_CONTROL  = 0x20,
222 } GstMatroskaTrackType;
223
224 typedef enum {
225   GST_MATROSKA_EYE_MODE_MONO  = 0x0,
226   GST_MATROSKA_EYE_MODE_RIGHT = 0x1,
227   GST_MATROSKA_EYE_MODE_LEFT  = 0x2,
228   GST_MATROSKA_EYE_MODE_BOTH  = 0x3,
229 } GstMatroskaEyeMode;
230
231 typedef enum {
232   GST_MATROSKA_ASPECT_RATIO_MODE_FREE  = 0x0,
233   GST_MATROSKA_ASPECT_RATIO_MODE_KEEP  = 0x1,
234   GST_MATROSKA_ASPECT_RATIO_MODE_FIXED = 0x2,
235 } GstMatroskaAspectRatioMode;
236
237 /*
238  * These aren't in any way "matroska-form" things,
239  * it's just something I use in the muxer/demuxer.
240  */
241
242 typedef enum {
243   GST_MATROSKA_TRACK_ENABLED = (1<<0),
244   GST_MATROSKA_TRACK_DEFAULT = (1<<1),
245   GST_MATROSKA_TRACK_LACING  = (1<<2),
246   GST_MATROSKA_TRACK_SHIFT   = (1<<16)
247 } GstMatroskaTrackFlags;
248
249 typedef enum {
250   GST_MATROSKA_VIDEOTRACK_INTERLACED = (GST_MATROSKA_TRACK_SHIFT<<0)
251 } GstMatroskaVideoTrackFlags;
252
253 typedef struct _GstMatroskaTrackContext {
254   GstPad       *pad;
255   GstCaps      *caps;
256   guint         index;
257
258   /* some often-used info */
259   gchar        *codec_id, *codec_name, *name, *language;
260   gpointer      codec_priv;
261   guint         codec_priv_size;
262   GstMatroskaTrackType type;
263   guint         uid, num;
264   GstMatroskaTrackFlags flags;
265   guint64       default_duration;
266   guint64       pos;
267
268   gboolean      set_discont; /* TRUE = set DISCONT flag on next buffer */
269
270   /* Special flag for Vorbis and Theora, for which we need to send
271    * codec_priv first before sending any data, and just testing
272    * for time == 0 is not enough to detect that. Used by demuxer */
273   gboolean      send_xiph_headers;
274
275   /* Special flag for Flac, for which we need to reconstruct the header
276    * buffer from the codec_priv data before sending any data, and just
277    * testing for time == 0 is not enough to detect that. Used by demuxer */
278   gboolean      send_flac_headers;
279
280   /* Special counter for muxer to skip the first N vorbis/theora headers -
281    * they are put into codec private data, not muxed into the stream */
282   guint         xiph_headers_to_skip;
283
284   /* Tags to send after newsegment event */
285   GstTagList   *pending_tags;
286
287   /* A GArray of GstMatroskaTrackEncoding structures which contain the
288    * encoding (compression/encryption) settings for this track, if any */
289   GArray       *encodings;
290 } GstMatroskaTrackContext;
291
292 typedef struct _GstMatroskaTrackVideoContext {
293   GstMatroskaTrackContext parent;
294
295   guint         pixel_width, pixel_height,
296                 display_width, display_height;
297   GstMatroskaEyeMode eye_mode;
298   GstMatroskaAspectRatioMode asr_mode;
299   guint32       fourcc;
300 } GstMatroskaTrackVideoContext;
301
302 typedef struct _GstMatroskaTrackAudioContext {
303   GstMatroskaTrackContext parent;
304
305   guint         samplerate, channels, bitdepth;
306 } GstMatroskaTrackAudioContext;
307
308 typedef struct _GstMatroskaTrackComplexContext {
309   GstMatroskaTrackContext parent;
310
311   /* nothing special goes here, apparently */
312 } GstMatroskaTrackComplexContext;
313
314 typedef struct _GstMatroskaTrackSubtitleContext {
315   GstMatroskaTrackContext parent;
316
317   gboolean    check_utf8;     /* buffers should be valid UTF-8 */
318   gboolean    invalid_utf8;   /* work around broken files      */
319 } GstMatroskaTrackSubtitleContext;
320
321 typedef struct _GstMatroskaIndex {
322   guint64        pos;   /* of the corresponding *cluster*! */
323   guint16        track; /* reference to 'num' */
324   guint64        time;  /* in nanoseconds */
325 } GstMatroskaIndex;
326
327 typedef struct _Wavpack4Header {
328   guchar  ck_id [4];     /* "wvpk"                                         */
329   guint32 ck_size;       /* size of entire frame (minus 8, of course)      */
330   guint16 version;       /* 0x403 for now                                  */
331   guint8  track_no;      /* track number (0 if not used, like now)         */
332   guint8  index_no;      /* remember these? (0 if not used, like now)      */
333   guint32 total_samples; /* for entire file (-1 if unknown)                */
334   guint32 block_index;   /* index of first sample in block (to file begin) */
335   guint32 block_samples; /* # samples in this block                        */
336   guint32 flags;         /* various flags for id and decoding              */
337   guint32 crc;           /* crc for actual decoded data                    */
338 } Wavpack4Header;
339
340 typedef struct _GstMatroskaTrackEncoding {
341   guint   order;
342   guint   scope     : 3;
343   guint   type      : 1;
344   guint   comp_algo : 2;
345   guint8 *comp_settings;
346   guint   comp_settings_length;
347 } GstMatroskaTrackEncoding;
348
349 gboolean gst_matroska_track_init_video_context    (GstMatroskaTrackContext ** p_context);
350 gboolean gst_matroska_track_init_audio_context    (GstMatroskaTrackContext ** p_context);
351 gboolean gst_matroska_track_init_subtitle_context (GstMatroskaTrackContext ** p_context);
352 gboolean gst_matroska_track_init_complex_context  (GstMatroskaTrackContext ** p_context);
353
354 #endif /* __GST_MATROSKA_IDS_H__ */