vlc_codecs.h

Go to the documentation of this file.
00001 /*****************************************************************************
00002  * codecs.h: codec related structures needed by the demuxers and decoders
00003  *****************************************************************************
00004  * Copyright (C) 1999-2001 the VideoLAN team
00005  * $Id: 6c087da247c783853216142549def12140d09c09 $
00006  *
00007  * Author: Gildas Bazin <gbazin@videolan.org>
00008  *
00009  * This program is free software; you can redistribute it and/or modify
00010  * it under the terms of the GNU General Public License as published by
00011  * the Free Software Foundation; either version 2 of the License, or
00012  * (at your option) any later version.
00013  *
00014  * This program is distributed in the hope that it will be useful,
00015  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00017  * GNU General Public License for more details.
00018  *
00019  * You should have received a copy of the GNU General Public License
00020  * along with this program; if not, write to the Free Software
00021  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
00022  *****************************************************************************/
00023 
00024 #ifndef VLC_CODECS_H
00025 #define VLC_CODECS_H 1
00026 
00027 #include <vlc_fourcc.h>
00028 /**
00029  * \file
00030  * This file defines codec related structures needed by the demuxers and decoders
00031  */
00032 
00033 /* Structures exported to the demuxers and decoders */
00034 
00035 #if !(defined _GUID_DEFINED || defined GUID_DEFINED)
00036 #define GUID_DEFINED
00037 typedef struct _GUID
00038 {
00039     uint32_t Data1;
00040     uint16_t Data2;
00041     uint16_t Data3;
00042     uint8_t  Data4[8];
00043 } GUID, *REFGUID, *LPGUID;
00044 #endif /* GUID_DEFINED */
00045 
00046 #ifdef HAVE_ATTRIBUTE_PACKED
00047 #   define ATTR_PACKED __attribute__((__packed__))
00048 #elif defined(__SUNPRO_C)
00049 #   pragma pack(1)
00050 #   define ATTR_PACKED
00051 #else
00052 #   error FIXME
00053 #endif
00054 
00055 #ifndef _WAVEFORMATEX_
00056 #define _WAVEFORMATEX_
00057 typedef struct
00058 ATTR_PACKED
00059 _WAVEFORMATEX {
00060     uint16_t   wFormatTag;
00061     uint16_t   nChannels;
00062     uint32_t   nSamplesPerSec;
00063     uint32_t   nAvgBytesPerSec;
00064     uint16_t   nBlockAlign;
00065     uint16_t   wBitsPerSample;
00066     uint16_t   cbSize;
00067 } WAVEFORMATEX, *PWAVEFORMATEX, *NPWAVEFORMATEX, *LPWAVEFORMATEX;
00068 #endif /* _WAVEFORMATEX_ */
00069 
00070 #ifndef _WAVEFORMATEXTENSIBLE_
00071 #define _WAVEFORMATEXTENSIBLE_
00072 typedef struct
00073 ATTR_PACKED
00074 _WAVEFORMATEXTENSIBLE {
00075     WAVEFORMATEX Format;
00076     union {
00077         uint16_t wValidBitsPerSample;
00078         uint16_t wSamplesPerBlock;
00079         uint16_t wReserved;
00080     } Samples;
00081     uint32_t     dwChannelMask;
00082     GUID SubFormat;
00083 } WAVEFORMATEXTENSIBLE, *PWAVEFORMATEXTENSIBLE;
00084 #endif /* _WAVEFORMATEXTENSIBLE_ */
00085 
00086 #ifndef _WAVEHEADER_
00087 #define _WAVEHEADER_
00088 typedef struct
00089 ATTR_PACKED
00090 _WAVEHEADER {
00091     uint32_t MainChunkID;
00092     uint32_t Length;
00093     uint32_t ChunkTypeID;
00094     uint32_t SubChunkID;
00095     uint32_t SubChunkLength;
00096     uint16_t Format;
00097     uint16_t Modus;
00098     uint32_t SampleFreq;
00099     uint32_t BytesPerSec;
00100     uint16_t BytesPerSample;
00101     uint16_t BitsPerSample;
00102     uint32_t DataChunkID;
00103     uint32_t DataLength;
00104 } WAVEHEADER;
00105 #endif /* _WAVEHEADER_ */
00106 
00107 #if !defined(_BITMAPINFOHEADER_) && !defined(WIN32)
00108 #define _BITMAPINFOHEADER_
00109 typedef struct
00110 ATTR_PACKED
00111 {
00112     uint32_t   biSize;
00113     uint32_t   biWidth;
00114     uint32_t   biHeight;
00115     uint16_t   biPlanes;
00116     uint16_t   biBitCount;
00117     uint32_t   biCompression;
00118     uint32_t   biSizeImage;
00119     uint32_t   biXPelsPerMeter;
00120     uint32_t   biYPelsPerMeter;
00121     uint32_t   biClrUsed;
00122     uint32_t   biClrImportant;
00123 } BITMAPINFOHEADER, *PBITMAPINFOHEADER, *LPBITMAPINFOHEADER;
00124 
00125 typedef struct
00126 ATTR_PACKED
00127 {
00128     BITMAPINFOHEADER bmiHeader;
00129     int        bmiColors[1];
00130 } BITMAPINFO, *LPBITMAPINFO;
00131 #endif
00132 
00133 #ifndef _RECT32_
00134 #define _RECT32_
00135 typedef struct
00136 ATTR_PACKED
00137 {
00138     int left, top, right, bottom;
00139 } RECT32;
00140 #endif
00141 
00142 #ifndef _REFERENCE_TIME_
00143 #define _REFERENCE_TIME_
00144 typedef int64_t REFERENCE_TIME;
00145 #endif
00146 
00147 #ifndef _VIDEOINFOHEADER_
00148 #define _VIDEOINFOHEADER_
00149 typedef struct
00150 ATTR_PACKED
00151 {
00152     RECT32            rcSource;
00153     RECT32            rcTarget;
00154     uint32_t          dwBitRate;
00155     uint32_t          dwBitErrorRate;
00156     REFERENCE_TIME    AvgTimePerFrame;
00157     BITMAPINFOHEADER  bmiHeader;
00158 } VIDEOINFOHEADER;
00159 #endif
00160 
00161 #ifndef _RGBQUAD_
00162 #define _RGBQUAD_
00163 typedef struct
00164 ATTR_PACKED
00165 {
00166     uint8_t rgbBlue;
00167     uint8_t rgbGreen;
00168     uint8_t rgbRed;
00169     uint8_t rgbReserved;
00170 } RGBQUAD1;
00171 #endif
00172 
00173 #ifndef _TRUECOLORINFO_
00174 #define _TRUECOLORINFO_
00175 typedef struct
00176 ATTR_PACKED
00177 {
00178     uint32_t dwBitMasks[3];
00179     RGBQUAD1 bmiColors[256];
00180 } TRUECOLORINFO;
00181 #endif
00182 
00183 #ifndef _VIDEOINFO_
00184 #define _VIDEOINFO_
00185 typedef struct
00186 ATTR_PACKED
00187 {
00188     RECT32            rcSource;
00189     RECT32            rcTarget;
00190     uint32_t          dwBitRate;
00191     uint32_t          dwBitErrorRate;
00192     REFERENCE_TIME    AvgTimePerFrame;
00193     BITMAPINFOHEADER  bmiHeader;
00194 
00195     union
00196     {
00197         RGBQUAD1 bmiColors[256]; /* Colour palette */
00198         uint32_t dwBitMasks[3]; /* True colour masks */
00199         TRUECOLORINFO TrueColorInfo; /* Both of the above */
00200     };
00201 
00202 } VIDEOINFO;
00203 #endif
00204 
00205 #if defined(__SUNPRO_C)
00206 #   pragma pack()
00207 #endif
00208 
00209 /* WAVE format wFormatTag IDs */
00210 #define WAVE_FORMAT_UNKNOWN             0x0000 /* Microsoft Corporation */
00211 #define WAVE_FORMAT_PCM                 0x0001 /* Microsoft Corporation */
00212 #define WAVE_FORMAT_ADPCM               0x0002 /* Microsoft Corporation */
00213 #define WAVE_FORMAT_IEEE_FLOAT          0x0003 /* Microsoft Corporation */
00214 #define WAVE_FORMAT_ALAW                0x0006 /* Microsoft Corporation */
00215 #define WAVE_FORMAT_MULAW               0x0007 /* Microsoft Corporation */
00216 #define WAVE_FORMAT_DTS_MS              0x0008 /* Microsoft Corporation */
00217 #define WAVE_FORMAT_WMAS                0x000a /* WMA 9 Speech */
00218 #define WAVE_FORMAT_IMA_ADPCM           0x0011 /* Intel Corporation */
00219 #define WAVE_FORMAT_TRUESPEECH          0x0022 /* TrueSpeech */
00220 #define WAVE_FORMAT_GSM610              0x0031 /* Microsoft Corporation */
00221 #define WAVE_FORMAT_MSNAUDIO            0x0032 /* Microsoft Corporation */
00222 #define WAVE_FORMAT_G726                0x0045 /* ITU-T standard  */
00223 #define WAVE_FORMAT_MPEG                0x0050 /* Microsoft Corporation */
00224 #define WAVE_FORMAT_MPEGLAYER3          0x0055 /* ISO/MPEG Layer3 Format Tag */
00225 #define WAVE_FORMAT_DOLBY_AC3_SPDIF     0x0092 /* Sonic Foundry */
00226 
00227 #define WAVE_FORMAT_A52                 0x2000
00228 #define WAVE_FORMAT_DTS                 0x2001
00229 #define WAVE_FORMAT_WMA1                0x0160 /* WMA version 1 */
00230 #define WAVE_FORMAT_WMA2                0x0161 /* WMA (v2) 7, 8, 9 Series */
00231 #define WAVE_FORMAT_WMAP                0x0162 /* WMA 9 Professional */
00232 #define WAVE_FORMAT_WMAL                0x0163 /* WMA 9 Lossless */
00233 #define WAVE_FORMAT_DIVIO_AAC           0x4143
00234 #define WAVE_FORMAT_AAC                 0x00FF
00235 #define WAVE_FORMAT_FFMPEG_AAC          0x706D
00236 
00237 /* Need to check these */
00238 #define WAVE_FORMAT_DK3                 0x0061
00239 #define WAVE_FORMAT_DK4                 0x0062
00240 
00241 /* At least FFmpeg use that ID: from libavformat/riff.c ('Vo' == 0x566f)
00242  * { CODEC_ID_VORBIS, ('V'<<8)+'o' }, //HACK/FIXME, does vorbis in WAV/AVI have an (in)official id?
00243  */
00244 #define WAVE_FORMAT_VORBIS              0x566f
00245 
00246 /* It seems that these IDs are used by braindead & obsolete VorbisACM encoder
00247  * (Windows only)
00248  * A few info is available except VorbisACM source (remember, Windows only)
00249  * (available on http://svn.xiph.org), but it seems that vo3+ at least is
00250  * made of Vorbis data encapsulated in Ogg container...
00251  */
00252 #define WAVE_FORMAT_VORB_1              0x674f
00253 #define WAVE_FORMAT_VORB_2              0x6750
00254 #define WAVE_FORMAT_VORB_3              0x6751
00255 #define WAVE_FORMAT_VORB_1PLUS          0x676f
00256 #define WAVE_FORMAT_VORB_2PLUS          0x6770
00257 #define WAVE_FORMAT_VORB_3PLUS          0x6771
00258 
00259 #define WAVE_FORMAT_SPEEX               0xa109 /* Speex audio */
00260 
00261 
00262 #if !defined(WAVE_FORMAT_EXTENSIBLE)
00263 #define WAVE_FORMAT_EXTENSIBLE          0xFFFE /* Microsoft */
00264 #endif
00265 
00266 /* GUID SubFormat IDs */
00267 /* We need both b/c const variables are not compile-time constants in C, giving
00268  * us an error if we use the const GUID in an enum */
00269 
00270 #ifndef _KSDATAFORMAT_SUBTYPE_PCM_
00271 #define _KSDATAFORMAT_SUBTYPE_PCM_ {0x00000001, 0x0000, 0x0010, {0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}}
00272 static const GUID VLC_KSDATAFORMAT_SUBTYPE_PCM = {0xE923AABF, 0xCB58, 0x4471, {0xA1, 0x19, 0xFF, 0xFA, 0x01, 0xE4, 0xCE, 0x62}};
00273 #define KSDATAFORMAT_SUBTYPE_PCM VLC_KSDATAFORMAT_SUBTYPE_PCM
00274 #endif
00275 
00276 #ifndef _KSDATAFORMAT_SUBTYPE_UNKNOWN_
00277 #define _KSDATAFORMAT_SUBTYPE_UNKNOWN_ {0x00000000, 0x0000, 0x0000, {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}}
00278 static const GUID VLC_KSDATAFORMAT_SUBTYPE_UNKNOWN = {0x00000000, 0x0000, 0x0000, {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}};
00279 #define KSDATAFORMAT_SUBTYPE_UNKNOWN VLC_KSDATAFORMAT_SUBTYPE_UNKNOWN
00280 #endif
00281 
00282 /* Microsoft speaker definitions */
00283 #define WAVE_SPEAKER_FRONT_LEFT             0x1
00284 #define WAVE_SPEAKER_FRONT_RIGHT            0x2
00285 #define WAVE_SPEAKER_FRONT_CENTER           0x4
00286 #define WAVE_SPEAKER_LOW_FREQUENCY          0x8
00287 #define WAVE_SPEAKER_BACK_LEFT              0x10
00288 #define WAVE_SPEAKER_BACK_RIGHT             0x20
00289 #define WAVE_SPEAKER_FRONT_LEFT_OF_CENTER   0x40
00290 #define WAVE_SPEAKER_FRONT_RIGHT_OF_CENTER  0x80
00291 #define WAVE_SPEAKER_BACK_CENTER            0x100
00292 #define WAVE_SPEAKER_SIDE_LEFT              0x200
00293 #define WAVE_SPEAKER_SIDE_RIGHT             0x400
00294 #define WAVE_SPEAKER_TOP_CENTER             0x800
00295 #define WAVE_SPEAKER_TOP_FRONT_LEFT         0x1000
00296 #define WAVE_SPEAKER_TOP_FRONT_CENTER       0x2000
00297 #define WAVE_SPEAKER_TOP_FRONT_RIGHT        0x4000
00298 #define WAVE_SPEAKER_TOP_BACK_LEFT          0x8000
00299 #define WAVE_SPEAKER_TOP_BACK_CENTER        0x10000
00300 #define WAVE_SPEAKER_TOP_BACK_RIGHT         0x20000
00301 #define WAVE_SPEAKER_RESERVED               0x80000000
00302 
00303 static const struct
00304 {
00305     uint16_t     i_tag;
00306     vlc_fourcc_t i_fourcc;
00307     const char  *psz_name;
00308 }
00309 wave_format_tag_to_fourcc[] =
00310 {
00311     { WAVE_FORMAT_PCM,        VLC_FOURCC( 'a', 'r', 'a', 'w' ), "Raw audio" },
00312     { WAVE_FORMAT_PCM,        VLC_CODEC_S8,                     "PCM S8 audio" },
00313     { WAVE_FORMAT_PCM,        VLC_CODEC_S16L,                   "PCM S16L audio" },
00314     { WAVE_FORMAT_PCM,        VLC_CODEC_S24L,                   "PCM S24L audio" },
00315     { WAVE_FORMAT_PCM,        VLC_CODEC_S32L,                   "PCM S32L audio" },
00316     { WAVE_FORMAT_ADPCM,      VLC_CODEC_ADPCM_MS,               "ADPCM" },
00317     { WAVE_FORMAT_IEEE_FLOAT, VLC_FOURCC( 'a', 'f', 'l', 't' ), "IEEE Float audio" },
00318     { WAVE_FORMAT_IEEE_FLOAT, VLC_CODEC_F32L,                   "PCM 32 (Float) audio" },
00319     { WAVE_FORMAT_IEEE_FLOAT, VLC_CODEC_F64L,                   "PCM 64 (Float) audio" },
00320     { WAVE_FORMAT_ALAW,       VLC_CODEC_ALAW,                   "A-Law" },
00321     { WAVE_FORMAT_MULAW,      VLC_CODEC_MULAW,                  "Mu-Law" },
00322     { WAVE_FORMAT_IMA_ADPCM,  VLC_CODEC_ADPCM_IMA_WAV,          "Ima-ADPCM" },
00323     { WAVE_FORMAT_TRUESPEECH, VLC_FOURCC(0x22, 0x0, 0x0, 0x0 ), "Truespeech" },
00324     { WAVE_FORMAT_GSM610,     VLC_CODEC_GSM_MS,                 "Microsoft WAV GSM" },
00325     { WAVE_FORMAT_G726,       VLC_CODEC_ADPCM_G726,             "G.726 ADPCM" },
00326     { WAVE_FORMAT_MPEGLAYER3, VLC_CODEC_MPGA,                   "Mpeg Audio" },
00327     { WAVE_FORMAT_MPEG,       VLC_CODEC_MPGA,                   "Mpeg Audio" },
00328     { WAVE_FORMAT_A52,        VLC_CODEC_A52,                    "A/52" },
00329     { WAVE_FORMAT_WMA1,       VLC_CODEC_WMA1,                   "Window Media Audio v1" },
00330     { WAVE_FORMAT_WMA2,       VLC_CODEC_WMA2,                   "Window Media Audio v2" },
00331     { WAVE_FORMAT_WMAP,       VLC_CODEC_WMAP,                   "Window Media Audio 9 Professional" },
00332     { WAVE_FORMAT_WMAL,       VLC_CODEC_WMAL,                   "Window Media Audio 9 Lossless" },
00333     { WAVE_FORMAT_WMAS,       VLC_CODEC_WMAS,                   "Window Media Audio 9 Speech" },
00334     { WAVE_FORMAT_DK3,        VLC_FOURCC( 'm', 's', 0x00,0x61), "Duck DK3" },
00335     { WAVE_FORMAT_DK4,        VLC_FOURCC( 'm', 's', 0x00,0x62), "Duck DK4" },
00336     { WAVE_FORMAT_DTS,        VLC_CODEC_DTS,                    "DTS Coherent Acoustics" },
00337     { WAVE_FORMAT_DTS_MS,     VLC_CODEC_DTS,                    "DTS Coherent Acoustics" },
00338     { WAVE_FORMAT_DIVIO_AAC,  VLC_CODEC_MP4A,                   "MPEG-4 Audio (Divio)" },
00339     { WAVE_FORMAT_AAC,        VLC_CODEC_MP4A,                   "MPEG-4 Audio" },
00340     { WAVE_FORMAT_FFMPEG_AAC, VLC_CODEC_MP4A,                   "MPEG-4 Audio" },
00341     { WAVE_FORMAT_VORBIS,     VLC_CODEC_VORBIS,                 "Vorbis Audio" },
00342     { WAVE_FORMAT_VORB_1,     VLC_FOURCC( 'v', 'o', 'r', '1' ), "Vorbis 1 Audio" },
00343     { WAVE_FORMAT_VORB_1PLUS, VLC_FOURCC( 'v', 'o', '1', '+' ), "Vorbis 1+ Audio" },
00344     { WAVE_FORMAT_VORB_2,     VLC_FOURCC( 'v', 'o', 'r', '2' ), "Vorbis 2 Audio" },
00345     { WAVE_FORMAT_VORB_2PLUS, VLC_FOURCC( 'v', 'o', '2', '+' ), "Vorbis 2+ Audio" },
00346     { WAVE_FORMAT_VORB_3,     VLC_FOURCC( 'v', 'o', 'r', '3' ), "Vorbis 3 Audio" },
00347     { WAVE_FORMAT_VORB_3PLUS, VLC_FOURCC( 'v', 'o', '3', '+' ), "Vorbis 3+ Audio" },
00348     { WAVE_FORMAT_SPEEX,      VLC_CODEC_SPEEX,                  "Speex Audio" },
00349     { WAVE_FORMAT_UNKNOWN,    VLC_FOURCC( 'u', 'n', 'd', 'f' ), "Unknown" }
00350 };
00351 
00352 static inline void wf_tag_to_fourcc( uint16_t i_tag, vlc_fourcc_t *fcc,
00353                                      const char **ppsz_name )
00354 {
00355     int i;
00356     for( i = 0; wave_format_tag_to_fourcc[i].i_tag != 0; i++ )
00357     {
00358         if( wave_format_tag_to_fourcc[i].i_tag == i_tag ) break;
00359     }
00360     if( fcc ) *fcc = wave_format_tag_to_fourcc[i].i_fourcc;
00361     if( ppsz_name ) *ppsz_name = wave_format_tag_to_fourcc[i].psz_name;
00362 }
00363 
00364 static inline void fourcc_to_wf_tag( vlc_fourcc_t fcc, uint16_t *pi_tag )
00365 {
00366     int i;
00367     for( i = 0; wave_format_tag_to_fourcc[i].i_tag != 0; i++ )
00368     {
00369         if( wave_format_tag_to_fourcc[i].i_fourcc == fcc ) break;
00370     }
00371     if( pi_tag ) *pi_tag = wave_format_tag_to_fourcc[i].i_tag;
00372 }
00373 
00374 /* If wFormatTag is WAVEFORMATEXTENSIBLE, we must look at the SubFormat tag
00375  * to determine the actual format.  Microsoft has stopped giving out wFormatTag
00376  * assignments in lieu of letting 3rd parties generate their own GUIDs
00377  */
00378 static const struct
00379 {
00380     GUID         guid_tag;
00381     vlc_fourcc_t i_fourcc;
00382     const char  *psz_name;
00383 }
00384 sub_format_tag_to_fourcc[] =
00385 {
00386     { _KSDATAFORMAT_SUBTYPE_PCM_, VLC_FOURCC( 'p', 'c', 'm', ' ' ), "PCM" },
00387     { _KSDATAFORMAT_SUBTYPE_UNKNOWN_, VLC_FOURCC( 'u', 'n', 'd', 'f' ), "Unknown" }
00388 };
00389 
00390 /* compares two GUIDs, returns 1 if identical, 0 otherwise */
00391 static inline int guidcmp( const GUID *s1, const GUID *s2 )
00392 {
00393     return( s1->Data1 == s2->Data1 && s1->Data2 == s2->Data2 &&
00394             s1->Data3 == s2->Data3 && !memcmp( s1->Data4, s2->Data4, 8 ) );
00395 }
00396 
00397 static inline void sf_tag_to_fourcc( GUID *guid_tag,
00398                                      vlc_fourcc_t *fcc, const char **ppsz_name )
00399 {
00400     int i;
00401 
00402     for( i = 0; !guidcmp( &sub_format_tag_to_fourcc[i].guid_tag,
00403                           &KSDATAFORMAT_SUBTYPE_UNKNOWN ); i++ )
00404     {
00405         if( guidcmp( &sub_format_tag_to_fourcc[i].guid_tag, guid_tag ) ) break;
00406     }
00407     if( fcc ) *fcc = sub_format_tag_to_fourcc[i].i_fourcc;
00408     if( ppsz_name ) *ppsz_name = sub_format_tag_to_fourcc[i].psz_name;
00409 }
00410 
00411 #endif /* "codecs.h" */