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