VLC  2.1.0-git
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
vlc_codecs.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * vlc_codecs.h: codec related structures needed by the demuxers and decoders
3  *****************************************************************************
4  * Copyright (C) 1999-2001 VLC authors and VideoLAN
5  * $Id: 0fdf690f869bbd074ad54cc8ddfb4136fce597d7 $
6  *
7  * Author: Gildas Bazin <gbazin@videolan.org>
8  *
9  * This program is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23 
24 #ifndef VLC_CODECS_H
25 #define VLC_CODECS_H 1
26 
27 #include <vlc_fourcc.h>
28 /**
29  * \file
30  * This file defines codec related structures needed by the demuxers and decoders
31  */
32 
33 /* Structures exported to the demuxers and decoders */
34 
35 #if !(defined _GUID_DEFINED || defined GUID_DEFINED)
36 #define GUID_DEFINED
37 typedef struct _GUID
38 {
39  uint32_t Data1;
40  uint16_t Data2;
41  uint16_t Data3;
42  uint8_t Data4[8];
44 #endif /* GUID_DEFINED */
45 
46 typedef GUID guid_t;
47 
48 #ifdef HAVE_ATTRIBUTE_PACKED
49 # define ATTR_PACKED __attribute__((__packed__))
50 #elif defined(__SUNPRO_C)
51 # pragma pack(1)
52 # define ATTR_PACKED
53 #elif defined(__APPLE__)
54 # pragma pack(push, 1)
55 # define ATTR_PACKED
56 #else
57 # error FIXME
58 #endif
59 
60 #ifndef _WAVEFORMATEX_
61 #define _WAVEFORMATEX_
62 typedef struct
65  uint16_t wFormatTag;
66  uint16_t nChannels;
67  uint32_t nSamplesPerSec;
68  uint32_t nAvgBytesPerSec;
69  uint16_t nBlockAlign;
70  uint16_t wBitsPerSample;
71  uint16_t cbSize;
73 #endif /* _WAVEFORMATEX_ */
74 
75 #ifndef _WAVEFORMATEXTENSIBLE_
76 #define _WAVEFORMATEXTENSIBLE_
77 typedef struct
80  WAVEFORMATEX Format;
81  union {
82  uint16_t wValidBitsPerSample;
83  uint16_t wSamplesPerBlock;
84  uint16_t wReserved;
85  } Samples;
86  uint32_t dwChannelMask;
87  GUID SubFormat;
89 #endif /* _WAVEFORMATEXTENSIBLE_ */
90 
91 #ifndef _WAVEHEADER_
92 #define _WAVEHEADER_
93 typedef struct
96  uint32_t MainChunkID;
97  uint32_t Length;
98  uint32_t ChunkTypeID;
99  uint32_t SubChunkID;
100  uint32_t SubChunkLength;
101  uint16_t Format;
102  uint16_t Modus;
103  uint32_t SampleFreq;
104  uint32_t BytesPerSec;
105  uint16_t BytesPerSample;
106  uint16_t BitsPerSample;
107  uint32_t DataChunkID;
108  uint32_t DataLength;
110 #endif /* _WAVEHEADER_ */
111 
112 #ifndef _VLC_BITMAPINFOHEADER_
113 #define _VLC_BITMAPINFOHEADER_
115 typedef struct
117 {
118  uint32_t biSize;
119  uint32_t biWidth;
120  uint32_t biHeight;
121  uint16_t biPlanes;
122  uint16_t biBitCount;
123  uint32_t biCompression;
124  uint32_t biSizeImage;
125  uint32_t biXPelsPerMeter;
126  uint32_t biYPelsPerMeter;
127  uint32_t biClrUsed;
128  uint32_t biClrImportant;
130 
131 typedef struct
133 {
134  VLC_BITMAPINFOHEADER bmiHeader;
135  int bmiColors[1];
137 #endif
138 
139 #ifndef _RECT32_
140 #define _RECT32_
141 typedef struct
143 {
144  int left, top, right, bottom;
146 #endif
147 
148 #ifndef _REFERENCE_TIME_
149 #define _REFERENCE_TIME_
150 typedef int64_t REFERENCE_TIME;
151 #endif
152 
153 #ifndef _VIDEOINFOHEADER_
154 #define _VIDEOINFOHEADER_
155 typedef struct
157 {
158  RECT32 rcSource;
159  RECT32 rcTarget;
160  uint32_t dwBitRate;
161  uint32_t dwBitErrorRate;
162  REFERENCE_TIME AvgTimePerFrame;
165 #endif
166 
167 #ifndef _RGBQUAD_
168 #define _RGBQUAD_
169 typedef struct
171 {
172  uint8_t rgbBlue;
173  uint8_t rgbGreen;
174  uint8_t rgbRed;
175  uint8_t rgbReserved;
177 #endif
178 
179 #ifndef _TRUECOLORINFO_
180 #define _TRUECOLORINFO_
181 typedef struct
183 {
184  uint32_t dwBitMasks[3];
185  RGBQUAD1 bmiColors[256];
187 #endif
188 
189 #ifndef _VIDEOINFO_
190 #define _VIDEOINFO_
191 typedef struct
193 {
194  RECT32 rcSource;
195  RECT32 rcTarget;
196  uint32_t dwBitRate;
197  uint32_t dwBitErrorRate;
198  REFERENCE_TIME AvgTimePerFrame;
199  VLC_BITMAPINFOHEADER bmiHeader;
200 
201  union
202  {
203  RGBQUAD1 bmiColors[256]; /* Colour palette */
204  uint32_t dwBitMasks[3]; /* True colour masks */
205  TRUECOLORINFO TrueColorInfo; /* Both of the above */
206  };
207 
208 } VIDEOINFO;
209 #endif
210 
211 #if defined(__SUNPRO_C)
212 # pragma pack()
213 #elif defined(__APPLE__) && !HAVE_ATTRIBUTE_PACKED
214 # pragma pack(pop)
215 #endif
216 
217 /* WAVE format wFormatTag IDs */
218 /* See http://msdn.microsoft.com/en-us/library/aa904731%28v=vs.80%29.aspx */
219 #define WAVE_FORMAT_UNKNOWN 0x0000 /* Microsoft Corporation */
220 #define WAVE_FORMAT_PCM 0x0001 /* Microsoft Corporation */
221 #define WAVE_FORMAT_ADPCM 0x0002 /* Microsoft Corporation */
222 #define WAVE_FORMAT_IEEE_FLOAT 0x0003 /* Microsoft Corporation */
223 #define WAVE_FORMAT_ALAW 0x0006 /* Microsoft Corporation */
224 #define WAVE_FORMAT_MULAW 0x0007 /* Microsoft Corporation */
225 #define WAVE_FORMAT_DTS_MS 0x0008 /* Microsoft Corporation */
226 #define WAVE_FORMAT_WMAS 0x000a /* WMA 9 Speech */
227 #define WAVE_FORMAT_IMA_ADPCM 0x0011 /* Intel Corporation */
228 #define WAVE_FORMAT_YAMAHA_ADPCM 0x0020 /* Yamaha */
229 #define WAVE_FORMAT_TRUESPEECH 0x0022 /* TrueSpeech */
230 #define WAVE_FORMAT_GSM610 0x0031 /* Microsoft Corporation */
231 #define WAVE_FORMAT_MSNAUDIO 0x0032 /* Microsoft Corporation */
232 #define WAVE_FORMAT_MSG723 0x0042 /* Microsoft G.723 [G723.1] */
233 #define WAVE_FORMAT_G726 0x0045 /* ITU-T standard */
234 #define WAVE_FORMAT_MPEG 0x0050 /* Microsoft Corporation */
235 #define WAVE_FORMAT_MPEGLAYER3 0x0055 /* ISO/MPEG Layer3 Format Tag */
236 #define WAVE_FORMAT_AMR_NB 0x0057 /* AMR NB */
237 #define WAVE_FORMAT_AMR_WB 0x0058 /* AMR Wideband */
238 #define WAVE_FORMAT_DOLBY_AC3_SPDIF 0x0092 /* Sonic Foundry */
240 #define WAVE_FORMAT_AAC 0x00FF /* */
241 #define WAVE_FORMAT_AAC_MS 0xa106 /* Microsoft AAC */
242 #define WAVE_FORMAT_SIPRO 0x0130 /* Sipro Lab Telecom Inc. */
244 #define WAVE_FORMAT_WMA1 0x0160 /* WMA version 1 */
245 #define WAVE_FORMAT_WMA2 0x0161 /* WMA (v2) 7, 8, 9 Series */
246 #define WAVE_FORMAT_WMAP 0x0162 /* WMA 9 Professional */
247 #define WAVE_FORMAT_WMAL 0x0163 /* WMA 9 Lossless */
249 #define WAVE_FORMAT_ULEAD_DV_AUDIO_NTSC 0x0215 /* Ulead */
250 #define WAVE_FORMAT_ULEAD_DV_AUDIO_PAL 0x0216 /* Ulead */
252 #define WAVE_FORMAT_ATRAC3 0x0270 /* Atrac3, != from MSDN doc */
253 #define WAVE_FORMAT_SONY_ATRAC3 0x0272 /* Atrac3, != from MSDN doc */
255 #define WAVE_FORMAT_INDEO_AUDIO 0x0402 /* Indeo Audio Coder */
257 #define WAVE_FORMAT_AAC_2 0x1601 /* Other AAC */
258 #define WAVE_FORMAT_AAC_LATM 0x1602 /* AAC/LATM */
260 #define WAVE_FORMAT_A52 0x2000 /* a52 */
261 #define WAVE_FORMAT_DTS 0x2001 /* DTS */
262 #define WAVE_FORMAT_FFMPEG_AAC 0x706D
263 #define WAVE_FORMAT_DIVIO_AAC 0x4143 /* Divio's AAC */
265 #define WAVE_FORMAT_GSM_AMR_FIXED 0x7A21 /* Fixed bitrate, no SID */
266 #define WAVE_FORMAT_GSM_AMR 0x7A22 /* Variable bitrate, including SID */
268 /* Need to check these */
269 #define WAVE_FORMAT_DK3 0x0061
270 #define WAVE_FORMAT_DK4 0x0062
272 /* At least FFmpeg use that ID: from libavformat/riff.c ('Vo' == 0x566f)
273  * { CODEC_ID_VORBIS, ('V'<<8)+'o' }, //HACK/FIXME, does vorbis in WAV/AVI have an (in)official id?
274  */
275 #define WAVE_FORMAT_VORBIS 0x566f
277 /* It seems that these IDs are used by braindead & obsolete VorbisACM encoder
278  * (Windows only)
279  * A few info is available except VorbisACM source (remember, Windows only)
280  * (available on http://svn.xiph.org), but it seems that vo3+ at least is
281  * made of Vorbis data encapsulated in Ogg container...
282  */
283 #define WAVE_FORMAT_VORB_1 0x674f
284 #define WAVE_FORMAT_VORB_2 0x6750
285 #define WAVE_FORMAT_VORB_3 0x6751
286 #define WAVE_FORMAT_VORB_1PLUS 0x676f
287 #define WAVE_FORMAT_VORB_2PLUS 0x6770
288 #define WAVE_FORMAT_VORB_3PLUS 0x6771
290 #define WAVE_FORMAT_G723_1 0xa100
292 #define WAVE_FORMAT_SPEEX 0xa109 /* Speex audio */
293 #define WAVE_FORMAT_FLAC 0xf1ac /* Xiph Flac */
295 #if !defined(WAVE_FORMAT_EXTENSIBLE)
296  #define WAVE_FORMAT_EXTENSIBLE 0xFFFE /* Microsoft */
297 #endif
298 
299 /* GUID SubFormat IDs */
300 /* We need both b/c const variables are not compile-time constants in C, giving
301  * us an error if we use the const GUID in an enum */
302 
303 #ifndef _KSDATAFORMAT_SUBTYPE_PCM_
304 #define _KSDATAFORMAT_SUBTYPE_PCM_ {0x00000001, 0x0000, 0x0010, {0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}}
305 static const GUID VLC_KSDATAFORMAT_SUBTYPE_PCM = {0xE923AABF, 0xCB58, 0x4471, {0xA1, 0x19, 0xFF, 0xFA, 0x01, 0xE4, 0xCE, 0x62}};
306 #define KSDATAFORMAT_SUBTYPE_PCM VLC_KSDATAFORMAT_SUBTYPE_PCM
307 #endif
308 
309 #ifndef _KSDATAFORMAT_SUBTYPE_UNKNOWN_
310 #define _KSDATAFORMAT_SUBTYPE_UNKNOWN_ {0x00000000, 0x0000, 0x0000, {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}}
311 static const GUID VLC_KSDATAFORMAT_SUBTYPE_UNKNOWN = {0x00000000, 0x0000, 0x0000, {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}};
312 #define KSDATAFORMAT_SUBTYPE_UNKNOWN VLC_KSDATAFORMAT_SUBTYPE_UNKNOWN
313 #endif
314 
315 /* Microsoft speaker definitions */
316 #define WAVE_SPEAKER_FRONT_LEFT 0x1
317 #define WAVE_SPEAKER_FRONT_RIGHT 0x2
318 #define WAVE_SPEAKER_FRONT_CENTER 0x4
319 #define WAVE_SPEAKER_LOW_FREQUENCY 0x8
320 #define WAVE_SPEAKER_BACK_LEFT 0x10
321 #define WAVE_SPEAKER_BACK_RIGHT 0x20
322 #define WAVE_SPEAKER_FRONT_LEFT_OF_CENTER 0x40
323 #define WAVE_SPEAKER_FRONT_RIGHT_OF_CENTER 0x80
324 #define WAVE_SPEAKER_BACK_CENTER 0x100
325 #define WAVE_SPEAKER_SIDE_LEFT 0x200
326 #define WAVE_SPEAKER_SIDE_RIGHT 0x400
327 #define WAVE_SPEAKER_TOP_CENTER 0x800
328 #define WAVE_SPEAKER_TOP_FRONT_LEFT 0x1000
329 #define WAVE_SPEAKER_TOP_FRONT_CENTER 0x2000
330 #define WAVE_SPEAKER_TOP_FRONT_RIGHT 0x4000
331 #define WAVE_SPEAKER_TOP_BACK_LEFT 0x8000
332 #define WAVE_SPEAKER_TOP_BACK_CENTER 0x10000
333 #define WAVE_SPEAKER_TOP_BACK_RIGHT 0x20000
334 #define WAVE_SPEAKER_RESERVED 0x80000000
336 static const struct
337 {
338  uint16_t i_tag;
340  const char *psz_name;
341 }
343 {
344  { WAVE_FORMAT_PCM, VLC_FOURCC( 'a', 'r', 'a', 'w' ), "Raw audio" },
345  { WAVE_FORMAT_PCM, VLC_CODEC_S8, "PCM S8 audio" },
346  { WAVE_FORMAT_PCM, VLC_CODEC_S16L, "PCM S16L audio" },
347  { WAVE_FORMAT_PCM, VLC_CODEC_S24L, "PCM S24L audio" },
348  { WAVE_FORMAT_PCM, VLC_CODEC_S32L, "PCM S32L audio" },
350  { WAVE_FORMAT_IEEE_FLOAT, VLC_FOURCC( 'a', 'f', 'l', 't' ), "IEEE Float audio" },
351  { WAVE_FORMAT_IEEE_FLOAT, VLC_CODEC_F32L, "PCM 32 (Float) audio" },
352  { WAVE_FORMAT_IEEE_FLOAT, VLC_CODEC_F64L, "PCM 64 (Float) audio" },
353  { WAVE_FORMAT_ALAW, VLC_CODEC_ALAW, "A-Law" },
354  { WAVE_FORMAT_MULAW, VLC_CODEC_MULAW, "Mu-Law" },
357  { WAVE_FORMAT_TRUESPEECH, VLC_CODEC_TRUESPEECH, "Truespeech" },
358  { WAVE_FORMAT_GSM610, VLC_CODEC_GSM_MS, "Microsoft WAV GSM" },
359  { WAVE_FORMAT_G726, VLC_CODEC_ADPCM_G726, "G.726 ADPCM" },
360  { WAVE_FORMAT_G723_1, VLC_CODEC_G723_1, "G.723.1" },
361  { WAVE_FORMAT_MSG723, VLC_CODEC_G723_1, "Microsoft G.723 [G723.1]" },
362  { WAVE_FORMAT_MPEGLAYER3, VLC_CODEC_MPGA, "Mpeg Audio" },
363  { WAVE_FORMAT_MPEG, VLC_CODEC_MPGA, "Mpeg Audio" },
364  { WAVE_FORMAT_AMR_NB, VLC_CODEC_AMR_NB, "AMR NB" },
365  { WAVE_FORMAT_AMR_WB, VLC_CODEC_AMR_WB, "AMR Wideband" },
366  { WAVE_FORMAT_SIPRO, VLC_CODEC_SIPR, "Sipr Audio" },
367  { WAVE_FORMAT_A52, VLC_CODEC_A52, "A/52" },
368  { WAVE_FORMAT_WMA1, VLC_CODEC_WMA1, "Window Media Audio v1" },
369  { WAVE_FORMAT_WMA2, VLC_CODEC_WMA2, "Window Media Audio v2" },
370  { WAVE_FORMAT_WMAP, VLC_CODEC_WMAP, "Window Media Audio 9 Professional" },
371  { WAVE_FORMAT_WMAL, VLC_CODEC_WMAL, "Window Media Audio 9 Lossless" },
372  { WAVE_FORMAT_WMAS, VLC_CODEC_WMAS, "Window Media Audio 9 Speech" },
373  { WAVE_FORMAT_ATRAC3, VLC_CODEC_ATRAC3, "Sony Atrac3" },
374  { WAVE_FORMAT_SONY_ATRAC3,VLC_CODEC_ATRAC3, "Sony Atrac3" },
375  { WAVE_FORMAT_DK3, VLC_FOURCC( 'm', 's', 0x00,0x61), "Duck DK3" },
376  { WAVE_FORMAT_DK4, VLC_FOURCC( 'm', 's', 0x00,0x62), "Duck DK4" },
377  { WAVE_FORMAT_DTS, VLC_CODEC_DTS, "DTS Coherent Acoustics" },
378  { WAVE_FORMAT_DTS_MS, VLC_CODEC_DTS, "DTS Coherent Acoustics" },
379  { WAVE_FORMAT_DIVIO_AAC, VLC_CODEC_MP4A, "MPEG-4 Audio (Divio)" },
380  { WAVE_FORMAT_AAC, VLC_CODEC_MP4A, "MPEG-4 Audio" },
381  { WAVE_FORMAT_AAC_2, VLC_CODEC_MP4A, "MPEG-4 Audio" },
382  { WAVE_FORMAT_AAC_LATM, VLC_CODEC_MP4A, "MPEG-4 Audio" },
383  { WAVE_FORMAT_FFMPEG_AAC, VLC_CODEC_MP4A, "MPEG-4 Audio" },
384  { WAVE_FORMAT_AAC_MS, VLC_CODEC_MP4A, "MPEG-4 Audio" },
385  { WAVE_FORMAT_VORBIS, VLC_CODEC_VORBIS, "Vorbis Audio" },
386  { WAVE_FORMAT_VORB_1, VLC_FOURCC( 'v', 'o', 'r', '1' ), "Vorbis 1 Audio" },
387  { WAVE_FORMAT_VORB_1PLUS, VLC_FOURCC( 'v', 'o', '1', '+' ), "Vorbis 1+ Audio" },
388  { WAVE_FORMAT_VORB_2, VLC_FOURCC( 'v', 'o', 'r', '2' ), "Vorbis 2 Audio" },
389  { WAVE_FORMAT_VORB_2PLUS, VLC_FOURCC( 'v', 'o', '2', '+' ), "Vorbis 2+ Audio" },
390  { WAVE_FORMAT_VORB_3, VLC_FOURCC( 'v', 'o', 'r', '3' ), "Vorbis 3 Audio" },
391  { WAVE_FORMAT_VORB_3PLUS, VLC_FOURCC( 'v', 'o', '3', '+' ), "Vorbis 3+ Audio" },
392  { WAVE_FORMAT_SPEEX, VLC_CODEC_SPEEX, "Speex Audio" },
393  { WAVE_FORMAT_FLAC, VLC_CODEC_FLAC, "FLAC Audio" },
394  { WAVE_FORMAT_GSM_AMR_FIXED, VLC_CODEC_AMR_NB, "GSM-AMR Audio CBR, no SID" },
395  { WAVE_FORMAT_GSM_AMR, VLC_CODEC_AMR_NB, "GSM-AMR Audio VBR, SID" },
398  { WAVE_FORMAT_INDEO_AUDIO, VLC_CODEC_INDEO_AUDIO, "Indeo Audio Coder" },
399  { WAVE_FORMAT_UNKNOWN, VLC_FOURCC( 'u', 'n', 'd', 'f' ), "Unknown" }
400 };
401 
402 static inline void wf_tag_to_fourcc( uint16_t i_tag, vlc_fourcc_t *fcc,
403  const char **ppsz_name )
404 {
405  int i;
406  for( i = 0; wave_format_tag_to_fourcc[i].i_tag != 0; i++ )
407  {
408  if( wave_format_tag_to_fourcc[i].i_tag == i_tag ) break;
409  }
410  if( fcc ) *fcc = wave_format_tag_to_fourcc[i].i_fourcc;
411  if( ppsz_name ) *ppsz_name = wave_format_tag_to_fourcc[i].psz_name;
412 }
413 
414 static inline void fourcc_to_wf_tag( vlc_fourcc_t fcc, uint16_t *pi_tag )
415 {
416  int i;
417  for( i = 0; wave_format_tag_to_fourcc[i].i_tag != 0; i++ )
418  {
419  if( wave_format_tag_to_fourcc[i].i_fourcc == fcc ) break;
420  }
421  if( pi_tag ) *pi_tag = wave_format_tag_to_fourcc[i].i_tag;
422 }
423 
424 /* If wFormatTag is WAVEFORMATEXTENSIBLE, we must look at the SubFormat tag
425  * to determine the actual format. Microsoft has stopped giving out wFormatTag
426  * assignments in lieu of letting 3rd parties generate their own GUIDs
427  */
428 static const struct
429 {
430  GUID guid_tag;
432  const char *psz_name;
433 }
435 {
436  { _KSDATAFORMAT_SUBTYPE_PCM_, VLC_FOURCC( 'p', 'c', 'm', ' ' ), "PCM" },
437  { _KSDATAFORMAT_SUBTYPE_UNKNOWN_, VLC_FOURCC( 'u', 'n', 'd', 'f' ), "Unknown" }
438 };
439 
440 /* compares two GUIDs, returns 1 if identical, 0 otherwise */
441 static inline int guidcmp( const GUID *s1, const GUID *s2 )
442 {
443  return( s1->Data1 == s2->Data1 && s1->Data2 == s2->Data2 &&
444  s1->Data3 == s2->Data3 && !memcmp( s1->Data4, s2->Data4, 8 ) );
445 }
446 
447 static inline void sf_tag_to_fourcc( GUID *guid_tag,
448  vlc_fourcc_t *fcc, const char **ppsz_name )
449 {
450  int i;
451 
452  for( i = 0; !guidcmp( &sub_format_tag_to_fourcc[i].guid_tag,
454  {
455  if( guidcmp( &sub_format_tag_to_fourcc[i].guid_tag, guid_tag ) ) break;
456  }
457  if( fcc ) *fcc = sub_format_tag_to_fourcc[i].i_fourcc;
458  if( ppsz_name ) *ppsz_name = sub_format_tag_to_fourcc[i].psz_name;
459 }
460 
461 #endif /* "codecs.h" */