git.sesse.net Git - vlc/blob - include/vlc_es.h

   1 /*****************************************************************************
   2  * vlc_es.h: Elementary stream formats descriptions
   3  *****************************************************************************
   4  * Copyright (C) 1999-2001 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   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_ES_H
  29 #define _VLC_ES_H 1
  30
  31 #ifdef WORDS_BIGENDIAN
  32 #   define VLC_FOURCC( a, b, c, d ) \
  33         ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
  34            | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
  35 #   define VLC_TWOCC( a, b ) \
  36         ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
  37
  38 #else
  39 #   define VLC_FOURCC( a, b, c, d ) \
  40         ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
  41            | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
  42 #   define VLC_TWOCC( a, b ) \
  43         ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
  44
  45 #endif
  46
  47 /**
  48  * \file
  49  * This file defines the elementary streams format types
  50  */
  51
  52 /**
  53  * video palette data
  54  * \see video_format_t
  55  * \see subs_format_t
  56  */
  57 struct video_palette_t
  58 {
  59     int i_entries;      /**< to keep the compatibility with ffmpeg's palette */
  60     uint8_t palette[256][4];                   /**< 4-byte RGBA/YUVA palette */
  61 };
  62
  63 /**
  64  * audio replay gain description
  65  */
  66 #define AUDIO_REPLAY_GAIN_MAX (2)
  67 #define AUDIO_REPLAY_GAIN_TRACK (0)
  68 #define AUDIO_REPLAY_GAIN_ALBUM (1)
  69 typedef struct
  70 {
  71     /* true if we have the peak value */
  72     bool pb_peak[AUDIO_REPLAY_GAIN_MAX];
  73     /* peak value where 1.0 means full sample value */
  74     float      pf_peak[AUDIO_REPLAY_GAIN_MAX];
  75
  76     /* true if we have the gain value */
  77     bool pb_gain[AUDIO_REPLAY_GAIN_MAX];
  78     /* gain value in dB */
  79     float      pf_gain[AUDIO_REPLAY_GAIN_MAX];
  80 } audio_replay_gain_t;
  81
  82 /**
  83  * audio format description
  84  */
  85 struct audio_format_t
  86 {
  87     vlc_fourcc_t i_format;                          /**< audio format fourcc */
  88     unsigned int i_rate;                              /**< audio sample-rate */
  89
  90     /* Describes the channels configuration of the samples (ie. number of
  91      * channels which are available in the buffer, and positions). */
  92     uint32_t     i_physical_channels;
  93
  94     /* Describes from which original channels, before downmixing, the
  95      * buffer is derived. */
  96     uint32_t     i_original_channels;
  97
  98     /* Optional - for A/52, SPDIF and DTS types : */
  99     /* Bytes used by one compressed frame, depends on bitrate. */
 100     unsigned int i_bytes_per_frame;
 101
 102     /* Number of sampleframes contained in one compressed frame. */
 103     unsigned int i_frame_length;
 104     /* Please note that it may be completely arbitrary - buffers are not
 105      * obliged to contain a integral number of so-called "frames". It's
 106      * just here for the division :
 107      * buffer_size = i_nb_samples * i_bytes_per_frame / i_frame_length
 108      */
 109
 110     /* FIXME ? (used by the codecs) */
 111     unsigned     i_bitspersample;
 112     unsigned     i_blockalign;
 113     uint8_t      i_channels; /* must be <=32 */
 114     uint8_t      i_flavor;
 115 };
 116
 117 #ifdef WORDS_BIGENDIAN
 118 #   define AUDIO_FMT_S16_NE VLC_FOURCC('s','1','6','b')
 119 #   define AUDIO_FMT_U16_NE VLC_FOURCC('u','1','6','b')
 120 #else
 121 #   define AUDIO_FMT_S16_NE VLC_FOURCC('s','1','6','l')
 122 #   define AUDIO_FMT_U16_NE VLC_FOURCC('u','1','6','l')
 123 #endif
 124
 125 /**
 126  * video format description
 127  */
 128 struct video_format_t
 129 {
 130     vlc_fourcc_t i_chroma;                               /**< picture chroma */
 131     unsigned int i_aspect;                                 /**< aspect ratio */
 132
 133     unsigned int i_width;                                 /**< picture width */
 134     unsigned int i_height;                               /**< picture height */
 135     unsigned int i_x_offset;               /**< start offset of visible area */
 136     unsigned int i_y_offset;               /**< start offset of visible area */
 137     unsigned int i_visible_width;                 /**< width of visible area */
 138     unsigned int i_visible_height;               /**< height of visible area */
 139
 140     unsigned int i_bits_per_pixel;             /**< number of bits per pixel */
 141
 142     unsigned int i_sar_num;                   /**< sample/pixel aspect ratio */
 143     unsigned int i_sar_den;
 144
 145     unsigned int i_frame_rate;                     /**< frame rate numerator */
 146     unsigned int i_frame_rate_base;              /**< frame rate denominator */
 147
 148     int i_rmask, i_gmask, i_bmask;          /**< color masks for RGB chroma */
 149     video_palette_t *p_palette;              /**< video palette from demuxer */
 150 };
 151
 152 /**
 153  * subtitles format description
 154  */
 155 struct subs_format_t
 156 {
 157     /* the character encoding of the text of the subtitle.
 158      * all gettext recognized shorts can be used */
 159     char *psz_encoding;
 160
 161
 162     int  i_x_origin; /**< x coordinate of the subtitle. 0 = left */
 163     int  i_y_origin; /**< y coordinate of the subtitle. 0 = top */
 164
 165     struct
 166     {
 167         /*  */
 168         uint32_t palette[16+1];
 169
 170         /* the width of the original movie the spu was extracted from */
 171         int i_original_frame_width;
 172         /* the height of the original movie the spu was extracted from */
 173         int i_original_frame_height;
 174     } spu;
 175
 176     struct
 177     {
 178         int i_id;
 179     } dvb;
 180 };
 181
 182 /**
 183  * ES definition
 184  */
 185 typedef struct extra_languages_t
 186 {
 187         char *psz_language;
 188         char *psz_description;
 189 } extra_languages_t;
 190
 191
 192 struct es_format_t
 193 {
 194     int             i_cat;
 195     vlc_fourcc_t    i_codec;
 196
 197     int             i_id;       /* -1: let the core mark the right id
 198                                    >=0: valid id */
 199     int             i_group;    /* -1 : standalone
 200                                    >= 0 then a "group" (program) is created
 201                                         for each value */
 202     int             i_priority; /*  -2 : mean not selectable by the users
 203                                     -1 : mean not selected by default even
 204                                         when no other stream
 205                                     >=0: priority */
 206
 207     char            *psz_language;
 208     char            *psz_description;
 209     int             i_extra_languages;
 210     extra_languages_t *p_extra_languages;
 211
 212     audio_format_t  audio;
 213     audio_replay_gain_t audio_replay_gain;
 214     video_format_t video;
 215     subs_format_t  subs;
 216
 217     unsigned int   i_bitrate;
 218
 219     bool     b_packetized; /* wether the data is packetized
 220                                     (ie. not truncated) */
 221     int     i_extra;
 222     void    *p_extra;
 223
 224 };
 225
 226 /* ES Categories */
 227 #define UNKNOWN_ES      0x00
 228 #define VIDEO_ES        0x01
 229 #define AUDIO_ES        0x02
 230 #define SPU_ES          0x03
 231 #define NAV_ES          0x04
 232
 233 static inline void es_format_Init( es_format_t *fmt,
 234                                    int i_cat, vlc_fourcc_t i_codec )
 235 {
 236     fmt->i_cat                  = i_cat;
 237     fmt->i_codec                = i_codec;
 238     fmt->i_id                   = -1;
 239     fmt->i_group                = 0;
 240     fmt->i_priority             = 0;
 241     fmt->psz_language           = NULL;
 242     fmt->psz_description        = NULL;
 243
 244     fmt->i_extra_languages      = 0;
 245     fmt->p_extra_languages      = NULL;
 246
 247     memset( &fmt->audio, 0, sizeof(audio_format_t) );
 248     memset( &fmt->audio_replay_gain, 0, sizeof(audio_replay_gain_t) );
 249     memset( &fmt->video, 0, sizeof(video_format_t) );
 250     memset( &fmt->subs, 0, sizeof(subs_format_t) );
 251
 252     fmt->b_packetized           = true;
 253     fmt->i_bitrate              = 0;
 254     fmt->i_extra                = 0;
 255     fmt->p_extra                = NULL;
 256 }
 257
 258 static inline int es_format_Copy( es_format_t *dst, const es_format_t *src )
 259 {
 260     int i;
 261     memcpy( dst, src, sizeof( es_format_t ) );
 262     if( src->psz_language )
 263          dst->psz_language = strdup( src->psz_language );
 264     if( src->psz_description )
 265         dst->psz_description = strdup( src->psz_description );
 266     if( src->i_extra > 0 )
 267     {
 268         dst->i_extra = src->i_extra;
 269         dst->p_extra = malloc( src->i_extra );
 270         memcpy( dst->p_extra, src->p_extra, src->i_extra );
 271     }
 272     else
 273     {
 274         dst->i_extra = 0;
 275         dst->p_extra = NULL;
 276     }
 277
 278     if( src->subs.psz_encoding )
 279         dst->subs.psz_encoding = strdup( src->subs.psz_encoding );
 280
 281     if( src->video.p_palette )
 282     {
 283         dst->video.p_palette =
 284             (video_palette_t*)malloc( sizeof( video_palette_t ) );
 285         memcpy( dst->video.p_palette, src->video.p_palette,
 286                 sizeof( video_palette_t ) );
 287     }
 288
 289     dst->i_extra_languages = src->i_extra_languages;
 290     if( dst->i_extra_languages )
 291         dst->p_extra_languages = (extra_languages_t*)
 292             malloc(dst->i_extra_languages * sizeof(*dst->p_extra_languages ));
 293     for( i = 0; i < dst->i_extra_languages; i++ ) {
 294         if( src->p_extra_languages[i].psz_language )
 295             dst->p_extra_languages[i].psz_language = strdup( src->p_extra_languages[i].psz_language );
 296         else
 297             dst->p_extra_languages[i].psz_language = NULL;
 298         if( src->p_extra_languages[i].psz_description )
 299             dst->p_extra_languages[i].psz_description = strdup( src->p_extra_languages[i].psz_description );
 300         else
 301             dst->p_extra_languages[i].psz_description = NULL;
 302     }
 303     return VLC_SUCCESS;
 304 }
 305
 306 static inline void es_format_Clean( es_format_t *fmt )
 307 {
 308     free( fmt->psz_language );
 309     free( fmt->psz_description );
 310
 311     if( fmt->i_extra > 0 ) free( fmt->p_extra );
 312
 313     free( fmt->video.p_palette );
 314     free( fmt->subs.psz_encoding );
 315
 316     if( fmt->i_extra_languages > 0 && fmt->p_extra_languages )
 317     {
 318         int i;
 319         for( i = 0; i < fmt->i_extra_languages; i++ )
 320         {
 321             free( fmt->p_extra_languages[i].psz_language );
 322             free( fmt->p_extra_languages[i].psz_description );
 323         }
 324         free( fmt->p_extra_languages );
 325     }
 326
 327     /* es_format_Clean can be called multiple times */
 328     memset( fmt, 0, sizeof(*fmt) );
 329 }
 330 #endif