include/vlc_codecs.h

   1 /*****************************************************************************
   2  * codecs.h: codec related structures needed by the demuxers and decoders
   3  *****************************************************************************
   4  * Copyright (C) 1999-2001 the VideoLAN team
   5  * $Id$
   6  *
   7  * Author: Gildas Bazin <gbazin@videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 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 General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, 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];
  43 } GUID, *REFGUID, *LPGUID;
  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 #else
  54 #   error FIXME
  55 #endif
  56
  57 #ifndef _WAVEFORMATEX_
  58 #define _WAVEFORMATEX_
  59 typedef struct
  60 ATTR_PACKED
  61 _WAVEFORMATEX {
  62     uint16_t   wFormatTag;
  63     uint16_t   nChannels;
  64     uint32_t   nSamplesPerSec;
  65     uint32_t   nAvgBytesPerSec;
  66     uint16_t   nBlockAlign;
  67     uint16_t   wBitsPerSample;
  68     uint16_t   cbSize;
  69 } WAVEFORMATEX, *PWAVEFORMATEX, *NPWAVEFORMATEX, *LPWAVEFORMATEX;
  70 #endif /* _WAVEFORMATEX_ */
  71
  72 #ifndef _WAVEFORMATEXTENSIBLE_
  73 #define _WAVEFORMATEXTENSIBLE_
  74 typedef struct
  75 ATTR_PACKED
  76 _WAVEFORMATEXTENSIBLE {
  77     WAVEFORMATEX Format;
  78     union {
  79         uint16_t wValidBitsPerSample;
  80         uint16_t wSamplesPerBlock;
  81         uint16_t wReserved;
  82     } Samples;
  83     uint32_t     dwChannelMask;
  84     GUID SubFormat;
  85 } WAVEFORMATEXTENSIBLE, *PWAVEFORMATEXTENSIBLE;
  86 #endif /* _WAVEFORMATEXTENSIBLE_ */
  87
  88 #ifndef _WAVEHEADER_
  89 #define _WAVEHEADER_
  90 typedef struct
  91 ATTR_PACKED
  92 _WAVEHEADER {
  93     uint32_t MainChunkID;
  94     uint32_t Length;
  95     uint32_t ChunkTypeID;
  96     uint32_t SubChunkID;
  97     uint32_t SubChunkLength;
  98     uint16_t Format;
  99     uint16_t Modus;
 100     uint32_t SampleFreq;
 101     uint32_t BytesPerSec;
 102     uint16_t BytesPerSample;
 103     uint16_t BitsPerSample;
 104     uint32_t DataChunkID;
 105     uint32_t DataLength;
 106 } WAVEHEADER;
 107 #endif /* _WAVEHEADER_ */
 108
 109 #if !defined(_BITMAPINFOHEADER_) && !defined(WIN32)
 110 #define _BITMAPINFOHEADER_
 111 typedef struct
 112 ATTR_PACKED
 113 {
 114     uint32_t   biSize;
 115     uint32_t   biWidth;
 116     uint32_t   biHeight;
 117     uint16_t   biPlanes;
 118     uint16_t   biBitCount;
 119     uint32_t   biCompression;
 120     uint32_t   biSizeImage;
 121     uint32_t   biXPelsPerMeter;
 122     uint32_t   biYPelsPerMeter;
 123     uint32_t   biClrUsed;
 124     uint32_t   biClrImportant;
 125 } BITMAPINFOHEADER, *PBITMAPINFOHEADER, *LPBITMAPINFOHEADER;
 126
 127 typedef struct
 128 ATTR_PACKED
 129 {
 130     BITMAPINFOHEADER bmiHeader;
 131     int        bmiColors[1];
 132 } BITMAPINFO, *LPBITMAPINFO;
 133 #endif
 134
 135 #ifndef _RECT32_
 136 #define _RECT32_
 137 typedef struct
 138 ATTR_PACKED
 139 {
 140     int left, top, right, bottom;
 141 } RECT32;
 142 #endif
 143
 144 #ifndef _REFERENCE_TIME_
 145 #define _REFERENCE_TIME_
 146 typedef int64_t REFERENCE_TIME;
 147 #endif
 148
 149 #ifndef _VIDEOINFOHEADER_
 150 #define _VIDEOINFOHEADER_
 151 typedef struct
 152 ATTR_PACKED
 153 {
 154     RECT32            rcSource;
 155     RECT32            rcTarget;
 156     uint32_t          dwBitRate;
 157     uint32_t          dwBitErrorRate;
 158     REFERENCE_TIME    AvgTimePerFrame;
 159     BITMAPINFOHEADER  bmiHeader;
 160 } VIDEOINFOHEADER;
 161 #endif
 162
 163 #ifndef _RGBQUAD_
 164 #define _RGBQUAD_
 165 typedef struct
 166 ATTR_PACKED
 167 {
 168     uint8_t rgbBlue;
 169     uint8_t rgbGreen;
 170     uint8_t rgbRed;
 171     uint8_t rgbReserved;
 172 } RGBQUAD1;
 173 #endif
 174
 175 #ifndef _TRUECOLORINFO_
 176 #define _TRUECOLORINFO_
 177 typedef struct
 178 ATTR_PACKED
 179 {
 180     uint32_t dwBitMasks[3];
 181     RGBQUAD1 bmiColors[256];
 182 } TRUECOLORINFO;
 183 #endif
 184
 185 #ifndef _VIDEOINFO_
 186 #define _VIDEOINFO_
 187 typedef struct
 188 ATTR_PACKED
 189 {
 190     RECT32            rcSource;
 191     RECT32            rcTarget;
 192     uint32_t          dwBitRate;
 193     uint32_t          dwBitErrorRate;
 194     REFERENCE_TIME    AvgTimePerFrame;
 195     BITMAPINFOHEADER  bmiHeader;
 196
 197     union
 198     {
 199         RGBQUAD1 bmiColors[256]; /* Colour palette */
 200         uint32_t dwBitMasks[3]; /* True colour masks */
 201         TRUECOLORINFO TrueColorInfo; /* Both of the above */
 202     };
 203
 204 } VIDEOINFO;
 205 #endif
 206
 207 #if defined(__SUNPRO_C)
 208 #   pragma pack()
 209 #endif
 210
 211 /* WAVE format wFormatTag IDs */
 212 /* See http://msdn.microsoft.com/en-us/library/aa904731%28v=vs.80%29.aspx */
 213 #define WAVE_FORMAT_UNKNOWN             0x0000 /* Microsoft Corporation */
 214 #define WAVE_FORMAT_PCM                 0x0001 /* Microsoft Corporation */
 215 #define WAVE_FORMAT_ADPCM               0x0002 /* Microsoft Corporation */
 216 #define WAVE_FORMAT_IEEE_FLOAT          0x0003 /* Microsoft Corporation */
 217 #define WAVE_FORMAT_ALAW                0x0006 /* Microsoft Corporation */
 218 #define WAVE_FORMAT_MULAW               0x0007 /* Microsoft Corporation */
 219 #define WAVE_FORMAT_DTS_MS              0x0008 /* Microsoft Corporation */
 220 #define WAVE_FORMAT_WMAS                0x000a /* WMA 9 Speech */
 221 #define WAVE_FORMAT_IMA_ADPCM           0x0011 /* Intel Corporation */
 222 #define WAVE_FORMAT_TRUESPEECH          0x0022 /* TrueSpeech */
 223 #define WAVE_FORMAT_GSM610              0x0031 /* Microsoft Corporation */
 224 #define WAVE_FORMAT_MSNAUDIO            0x0032 /* Microsoft Corporation */
 225 #define WAVE_FORMAT_G726                0x0045 /* ITU-T standard  */
 226 #define WAVE_FORMAT_MPEG                0x0050 /* Microsoft Corporation */
 227 #define WAVE_FORMAT_MPEGLAYER3          0x0055 /* ISO/MPEG Layer3 Format Tag */
 228 #define WAVE_FORMAT_AMR_NB              0x0057 /* AMR NB */
 229 #define WAVE_FORMAT_AMR_WB              0x0058 /* AMR Wideband */
 230 #define WAVE_FORMAT_DOLBY_AC3_SPDIF     0x0092 /* Sonic Foundry */
 231
 232 #define WAVE_FORMAT_AAC                 0x00FF /* */
 233 #define WAVE_FORMAT_SIPRO               0x0130 /* Sipro Lab Telecom Inc. */
 234
 235 #define WAVE_FORMAT_WMA1                0x0160 /* WMA version 1 */
 236 #define WAVE_FORMAT_WMA2                0x0161 /* WMA (v2) 7, 8, 9 Series */
 237 #define WAVE_FORMAT_WMAP                0x0162 /* WMA 9 Professional */
 238 #define WAVE_FORMAT_WMAL                0x0163 /* WMA 9 Lossless */
 239
 240 #define WAVE_FORMAT_AAC_2               0x1601 /* Other AAC */
 241 #define WAVE_FORMAT_AAC_LATM            0x1602 /* AAC/LATM */
 242
 243 #define WAVE_FORMAT_A52                 0x2000 /* a52 */
 244 #define WAVE_FORMAT_DTS                 0x2001 /* DTS */
 245 #define WAVE_FORMAT_FFMPEG_AAC          0x706D
 246 #define WAVE_FORMAT_DIVIO_AAC           0x4143 /* Divio's AAC */
 247
 248 /* Need to check these */
 249 #define WAVE_FORMAT_DK3                 0x0061
 250 #define WAVE_FORMAT_DK4                 0x0062
 251
 252 /* At least FFmpeg use that ID: from libavformat/riff.c ('Vo' == 0x566f)
 253  * { CODEC_ID_VORBIS, ('V'<<8)+'o' }, //HACK/FIXME, does vorbis in WAV/AVI have an (in)official id?
 254  */
 255 #define WAVE_FORMAT_VORBIS              0x566f
 256
 257 /* It seems that these IDs are used by braindead & obsolete VorbisACM encoder
 258  * (Windows only)
 259  * A few info is available except VorbisACM source (remember, Windows only)
 260  * (available on http://svn.xiph.org), but it seems that vo3+ at least is
 261  * made of Vorbis data encapsulated in Ogg container...
 262  */
 263 #define WAVE_FORMAT_VORB_1              0x674f
 264 #define WAVE_FORMAT_VORB_2              0x6750
 265 #define WAVE_FORMAT_VORB_3              0x6751
 266 #define WAVE_FORMAT_VORB_1PLUS          0x676f
 267 #define WAVE_FORMAT_VORB_2PLUS          0x6770
 268 #define WAVE_FORMAT_VORB_3PLUS          0x6771
 269
 270 #define WAVE_FORMAT_SPEEX               0xa109 /* Speex audio */
 271
 272 #if !defined(WAVE_FORMAT_EXTENSIBLE)
 273   #define WAVE_FORMAT_EXTENSIBLE          0xFFFE /* Microsoft */
 274 #endif
 275
 276 /* GUID SubFormat IDs */
 277 /* We need both b/c const variables are not compile-time constants in C, giving
 278  * us an error if we use the const GUID in an enum */
 279
 280 #ifndef _KSDATAFORMAT_SUBTYPE_PCM_
 281 #define _KSDATAFORMAT_SUBTYPE_PCM_ {0x00000001, 0x0000, 0x0010, {0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}}
 282 static const GUID VLC_KSDATAFORMAT_SUBTYPE_PCM = {0xE923AABF, 0xCB58, 0x4471, {0xA1, 0x19, 0xFF, 0xFA, 0x01, 0xE4, 0xCE, 0x62}};
 283 #define KSDATAFORMAT_SUBTYPE_PCM VLC_KSDATAFORMAT_SUBTYPE_PCM
 284 #endif
 285
 286 #ifndef _KSDATAFORMAT_SUBTYPE_UNKNOWN_
 287 #define _KSDATAFORMAT_SUBTYPE_UNKNOWN_ {0x00000000, 0x0000, 0x0000, {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}}
 288 static const GUID VLC_KSDATAFORMAT_SUBTYPE_UNKNOWN = {0x00000000, 0x0000, 0x0000, {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}};
 289 #define KSDATAFORMAT_SUBTYPE_UNKNOWN VLC_KSDATAFORMAT_SUBTYPE_UNKNOWN
 290 #endif
 291
 292 /* Microsoft speaker definitions */
 293 #define WAVE_SPEAKER_FRONT_LEFT             0x1
 294 #define WAVE_SPEAKER_FRONT_RIGHT            0x2
 295 #define WAVE_SPEAKER_FRONT_CENTER           0x4
 296 #define WAVE_SPEAKER_LOW_FREQUENCY          0x8
 297 #define WAVE_SPEAKER_BACK_LEFT              0x10
 298 #define WAVE_SPEAKER_BACK_RIGHT             0x20
 299 #define WAVE_SPEAKER_FRONT_LEFT_OF_CENTER   0x40
 300 #define WAVE_SPEAKER_FRONT_RIGHT_OF_CENTER  0x80
 301 #define WAVE_SPEAKER_BACK_CENTER            0x100
 302 #define WAVE_SPEAKER_SIDE_LEFT              0x200
 303 #define WAVE_SPEAKER_SIDE_RIGHT             0x400
 304 #define WAVE_SPEAKER_TOP_CENTER             0x800
 305 #define WAVE_SPEAKER_TOP_FRONT_LEFT         0x1000
 306 #define WAVE_SPEAKER_TOP_FRONT_CENTER       0x2000
 307 #define WAVE_SPEAKER_TOP_FRONT_RIGHT        0x4000
 308 #define WAVE_SPEAKER_TOP_BACK_LEFT          0x8000
 309 #define WAVE_SPEAKER_TOP_BACK_CENTER        0x10000
 310 #define WAVE_SPEAKER_TOP_BACK_RIGHT         0x20000
 311 #define WAVE_SPEAKER_RESERVED               0x80000000
 312
 313 static const struct
 314 {
 315     uint16_t     i_tag;
 316     vlc_fourcc_t i_fourcc;
 317     const char  *psz_name;
 318 }
 319 wave_format_tag_to_fourcc[] =
 320 {
 321     { WAVE_FORMAT_PCM,        VLC_FOURCC( 'a', 'r', 'a', 'w' ), "Raw audio" },
 322     { WAVE_FORMAT_PCM,        VLC_CODEC_S8,                     "PCM S8 audio" },
 323     { WAVE_FORMAT_PCM,        VLC_CODEC_S16L,                   "PCM S16L audio" },
 324     { WAVE_FORMAT_PCM,        VLC_CODEC_S24L,                   "PCM S24L audio" },
 325     { WAVE_FORMAT_PCM,        VLC_CODEC_S32L,                   "PCM S32L audio" },
 326     { WAVE_FORMAT_ADPCM,      VLC_CODEC_ADPCM_MS,               "ADPCM" },
 327     { WAVE_FORMAT_IEEE_FLOAT, VLC_FOURCC( 'a', 'f', 'l', 't' ), "IEEE Float audio" },
 328     { WAVE_FORMAT_IEEE_FLOAT, VLC_CODEC_F32L,                   "PCM 32 (Float) audio" },
 329     { WAVE_FORMAT_IEEE_FLOAT, VLC_CODEC_F64L,                   "PCM 64 (Float) audio" },
 330     { WAVE_FORMAT_ALAW,       VLC_CODEC_ALAW,                   "A-Law" },
 331     { WAVE_FORMAT_MULAW,      VLC_CODEC_MULAW,                  "Mu-Law" },
 332     { WAVE_FORMAT_IMA_ADPCM,  VLC_CODEC_ADPCM_IMA_WAV,          "Ima-ADPCM" },
 333     { WAVE_FORMAT_TRUESPEECH, VLC_FOURCC(0x22, 0x0, 0x0, 0x0 ), "Truespeech" },
 334     { WAVE_FORMAT_GSM610,     VLC_CODEC_GSM_MS,                 "Microsoft WAV GSM" },
 335     { WAVE_FORMAT_G726,       VLC_CODEC_ADPCM_G726,             "G.726 ADPCM" },
 336     { WAVE_FORMAT_MPEGLAYER3, VLC_CODEC_MPGA,                   "Mpeg Audio" },
 337     { WAVE_FORMAT_MPEG,       VLC_CODEC_MPGA,                   "Mpeg Audio" },
 338     { WAVE_FORMAT_AMR_NB,     VLC_CODEC_AMR_NB,                 "AMR NB" },
 339     { WAVE_FORMAT_AMR_WB,     VLC_CODEC_AMR_WB,                 "AMR Wideband" },
 340     { WAVE_FORMAT_SIPRO,      VLC_CODEC_SIPR,                   "Sipr Audio" },
 341     { WAVE_FORMAT_A52,        VLC_CODEC_A52,                    "A/52" },
 342     { WAVE_FORMAT_WMA1,       VLC_CODEC_WMA1,                   "Window Media Audio v1" },
 343     { WAVE_FORMAT_WMA2,       VLC_CODEC_WMA2,                   "Window Media Audio v2" },
 344     { WAVE_FORMAT_WMAP,       VLC_CODEC_WMAP,                   "Window Media Audio 9 Professional" },
 345     { WAVE_FORMAT_WMAL,       VLC_CODEC_WMAL,                   "Window Media Audio 9 Lossless" },
 346     { WAVE_FORMAT_WMAS,       VLC_CODEC_WMAS,                   "Window Media Audio 9 Speech" },
 347     { WAVE_FORMAT_DK3,        VLC_FOURCC( 'm', 's', 0x00,0x61), "Duck DK3" },
 348     { WAVE_FORMAT_DK4,        VLC_FOURCC( 'm', 's', 0x00,0x62), "Duck DK4" },
 349     { WAVE_FORMAT_DTS,        VLC_CODEC_DTS,                    "DTS Coherent Acoustics" },
 350     { WAVE_FORMAT_DTS_MS,     VLC_CODEC_DTS,                    "DTS Coherent Acoustics" },
 351     { WAVE_FORMAT_DIVIO_AAC,  VLC_CODEC_MP4A,                   "MPEG-4 Audio (Divio)" },
 352     { WAVE_FORMAT_AAC,        VLC_CODEC_MP4A,                   "MPEG-4 Audio" },
 353     { WAVE_FORMAT_AAC_2,      VLC_CODEC_MP4A,                   "MPEG-4 Audio" },
 354     { WAVE_FORMAT_AAC_LATM,   VLC_CODEC_MP4A,                   "MPEG-4 Audio" },
 355     { WAVE_FORMAT_FFMPEG_AAC, VLC_CODEC_MP4A,                   "MPEG-4 Audio" },
 356     { WAVE_FORMAT_VORBIS,     VLC_CODEC_VORBIS,                 "Vorbis Audio" },
 357     { WAVE_FORMAT_VORB_1,     VLC_FOURCC( 'v', 'o', 'r', '1' ), "Vorbis 1 Audio" },
 358     { WAVE_FORMAT_VORB_1PLUS, VLC_FOURCC( 'v', 'o', '1', '+' ), "Vorbis 1+ Audio" },
 359     { WAVE_FORMAT_VORB_2,     VLC_FOURCC( 'v', 'o', 'r', '2' ), "Vorbis 2 Audio" },
 360     { WAVE_FORMAT_VORB_2PLUS, VLC_FOURCC( 'v', 'o', '2', '+' ), "Vorbis 2+ Audio" },
 361     { WAVE_FORMAT_VORB_3,     VLC_FOURCC( 'v', 'o', 'r', '3' ), "Vorbis 3 Audio" },
 362     { WAVE_FORMAT_VORB_3PLUS, VLC_FOURCC( 'v', 'o', '3', '+' ), "Vorbis 3+ Audio" },
 363     { WAVE_FORMAT_SPEEX,      VLC_CODEC_SPEEX,                  "Speex Audio" },
 364     { WAVE_FORMAT_UNKNOWN,    VLC_FOURCC( 'u', 'n', 'd', 'f' ), "Unknown" }
 365 };
 366
 367 static inline void wf_tag_to_fourcc( uint16_t i_tag, vlc_fourcc_t *fcc,
 368                                      const char **ppsz_name )
 369 {
 370     int i;
 371     for( i = 0; wave_format_tag_to_fourcc[i].i_tag != 0; i++ )
 372     {
 373         if( wave_format_tag_to_fourcc[i].i_tag == i_tag ) break;
 374     }
 375     if( fcc ) *fcc = wave_format_tag_to_fourcc[i].i_fourcc;
 376     if( ppsz_name ) *ppsz_name = wave_format_tag_to_fourcc[i].psz_name;
 377 }
 378
 379 static inline void fourcc_to_wf_tag( vlc_fourcc_t fcc, uint16_t *pi_tag )
 380 {
 381     int i;
 382     for( i = 0; wave_format_tag_to_fourcc[i].i_tag != 0; i++ )
 383     {
 384         if( wave_format_tag_to_fourcc[i].i_fourcc == fcc ) break;
 385     }
 386     if( pi_tag ) *pi_tag = wave_format_tag_to_fourcc[i].i_tag;
 387 }
 388
 389 /* If wFormatTag is WAVEFORMATEXTENSIBLE, we must look at the SubFormat tag
 390  * to determine the actual format.  Microsoft has stopped giving out wFormatTag
 391  * assignments in lieu of letting 3rd parties generate their own GUIDs
 392  */
 393 static const struct
 394 {
 395     GUID         guid_tag;
 396     vlc_fourcc_t i_fourcc;
 397     const char  *psz_name;
 398 }
 399 sub_format_tag_to_fourcc[] =
 400 {
 401     { _KSDATAFORMAT_SUBTYPE_PCM_, VLC_FOURCC( 'p', 'c', 'm', ' ' ), "PCM" },
 402     { _KSDATAFORMAT_SUBTYPE_UNKNOWN_, VLC_FOURCC( 'u', 'n', 'd', 'f' ), "Unknown" }
 403 };
 404
 405 /* compares two GUIDs, returns 1 if identical, 0 otherwise */
 406 static inline int guidcmp( const GUID *s1, const GUID *s2 )
 407 {
 408     return( s1->Data1 == s2->Data1 && s1->Data2 == s2->Data2 &&
 409             s1->Data3 == s2->Data3 && !memcmp( s1->Data4, s2->Data4, 8 ) );
 410 }
 411
 412 static inline void sf_tag_to_fourcc( GUID *guid_tag,
 413                                      vlc_fourcc_t *fcc, const char **ppsz_name )
 414 {
 415     int i;
 416
 417     for( i = 0; !guidcmp( &sub_format_tag_to_fourcc[i].guid_tag,
 418                           &KSDATAFORMAT_SUBTYPE_UNKNOWN ); i++ )
 419     {
 420         if( guidcmp( &sub_format_tag_to_fourcc[i].guid_tag, guid_tag ) ) break;
 421     }
 422     if( fcc ) *fcc = sub_format_tag_to_fourcc[i].i_fourcc;
 423     if( ppsz_name ) *ppsz_name = sub_format_tag_to_fourcc[i].psz_name;
 424 }
 425
 426 #endif /* "codecs.h" */