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 #ifndef VLC_ES_H
  25 #define VLC_ES_H 1
  26
  27 #include <vlc_fourcc.h>
  28
  29 /**
  30  * \file
  31  * This file defines the elementary streams format types
  32  */
  33
  34 /**
  35  * video palette data
  36  * \see video_format_t
  37  * \see subs_format_t
  38  */
  39 struct video_palette_t
  40 {
  41     int i_entries;      /**< to keep the compatibility with ffmpeg's palette */
  42     uint8_t palette[256][4];                   /**< 4-byte RGBA/YUVA palette */
  43 };
  44
  45 /**
  46  * audio replay gain description
  47  */
  48 #define AUDIO_REPLAY_GAIN_MAX (2)
  49 #define AUDIO_REPLAY_GAIN_TRACK (0)
  50 #define AUDIO_REPLAY_GAIN_ALBUM (1)
  51 typedef struct
  52 {
  53     /* true if we have the peak value */
  54     bool pb_peak[AUDIO_REPLAY_GAIN_MAX];
  55     /* peak value where 1.0 means full sample value */
  56     float      pf_peak[AUDIO_REPLAY_GAIN_MAX];
  57
  58     /* true if we have the gain value */
  59     bool pb_gain[AUDIO_REPLAY_GAIN_MAX];
  60     /* gain value in dB */
  61     float      pf_gain[AUDIO_REPLAY_GAIN_MAX];
  62 } audio_replay_gain_t;
  63
  64 /**
  65  * audio format description
  66  */
  67 struct audio_format_t
  68 {
  69     vlc_fourcc_t i_format;                          /**< audio format fourcc */
  70     unsigned int i_rate;                              /**< audio sample-rate */
  71
  72     /* Describes the channels configuration of the samples (ie. number of
  73      * channels which are available in the buffer, and positions). */
  74     uint32_t     i_physical_channels;
  75
  76     /* Describes from which original channels, before downmixing, the
  77      * buffer is derived. */
  78     uint32_t     i_original_channels;
  79
  80     /* Optional - for A/52, SPDIF and DTS types : */
  81     /* Bytes used by one compressed frame, depends on bitrate. */
  82     unsigned int i_bytes_per_frame;
  83
  84     /* Number of sampleframes contained in one compressed frame. */
  85     unsigned int i_frame_length;
  86     /* Please note that it may be completely arbitrary - buffers are not
  87      * obliged to contain a integral number of so-called "frames". It's
  88      * just here for the division :
  89      * buffer_size = i_nb_samples * i_bytes_per_frame / i_frame_length
  90      */
  91
  92     /* FIXME ? (used by the codecs) */
  93     unsigned     i_bitspersample;
  94     unsigned     i_blockalign;
  95     uint8_t      i_channels; /* must be <=32 */
  96 };
  97
  98 /**
  99  * video format description
 100  */
 101 struct video_format_t
 102 {
 103     vlc_fourcc_t i_chroma;                               /**< picture chroma */
 104
 105     unsigned int i_width;                                 /**< picture width */
 106     unsigned int i_height;                               /**< picture height */
 107     unsigned int i_x_offset;               /**< start offset of visible area */
 108     unsigned int i_y_offset;               /**< start offset of visible area */
 109     unsigned int i_visible_width;                 /**< width of visible area */
 110     unsigned int i_visible_height;               /**< height of visible area */
 111
 112     unsigned int i_bits_per_pixel;             /**< number of bits per pixel */
 113
 114     unsigned int i_sar_num;                   /**< sample/pixel aspect ratio */
 115     unsigned int i_sar_den;
 116
 117     unsigned int i_frame_rate;                     /**< frame rate numerator */
 118     unsigned int i_frame_rate_base;              /**< frame rate denominator */
 119
 120     uint32_t i_rmask, i_gmask, i_bmask;          /**< color masks for RGB chroma */
 121     int i_rrshift, i_lrshift;
 122     int i_rgshift, i_lgshift;
 123     int i_rbshift, i_lbshift;
 124     video_palette_t *p_palette;              /**< video palette from demuxer */
 125 };
 126
 127 /**
 128  * Initialize a video_format_t structure with chroma 'i_chroma'
 129  * \param p_src pointer to video_format_t structure
 130  * \param i_chroma chroma value to use
 131  */
 132 static inline void video_format_Init( video_format_t *p_src, vlc_fourcc_t i_chroma )
 133 {
 134     memset( p_src, 0, sizeof( video_format_t ) );
 135     p_src->i_chroma = i_chroma;
 136     p_src->i_sar_num = p_src->i_sar_den = 1;
 137     p_src->p_palette = NULL;
 138 }
 139
 140 /**
 141  * Copy video_format_t including the palette
 142  * \param p_dst video_format_t to copy to
 143  * \param p_src video_format_t to copy from
 144  */
 145 static inline int video_format_Copy( video_format_t *p_dst, const video_format_t *p_src )
 146 {
 147     memcpy( p_dst, p_src, sizeof( *p_dst ) );
 148     if( p_src->p_palette )
 149     {
 150         p_dst->p_palette = (video_palette_t *) malloc( sizeof( video_palette_t ) );
 151         if( !p_dst->p_palette )
 152             return VLC_ENOMEM;
 153         memcpy( p_dst->p_palette, p_src->p_palette, sizeof( *p_dst->p_palette ) );
 154     }
 155     return VLC_SUCCESS;
 156 }
 157
 158 /**
 159  * Cleanup and free palette of this video_format_t
 160  * \param p_src video_format_t structure to clean
 161  */
 162 static inline void video_format_Clean( video_format_t *p_src )
 163 {
 164     free( p_src->p_palette );
 165     memset( p_src, 0, sizeof( video_format_t ) );
 166     p_src->p_palette = NULL;
 167 }
 168
 169 /**
 170  * It will fill up a video_format_tvideo_format_t using the given arguments.
 171  * Becarefull that the video_format_t must already be initialized.
 172  */
 173 VLC_EXPORT( void, video_format_Setup, ( video_format_t *, vlc_fourcc_t i_chroma, int i_width, int i_height, int i_sar_num, int i_sar_den ) );
 174
 175 /**
 176  * This function will check if the first video format is similar
 177  * to the second one.
 178  */
 179 VLC_EXPORT( bool, video_format_IsSimilar, ( const video_format_t *, const video_format_t * ) );
 180
 181 /**
 182  * subtitles format description
 183  */
 184 struct subs_format_t
 185 {
 186     /* the character encoding of the text of the subtitle.
 187      * all gettext recognized shorts can be used */
 188     char *psz_encoding;
 189
 190
 191     int  i_x_origin; /**< x coordinate of the subtitle. 0 = left */
 192     int  i_y_origin; /**< y coordinate of the subtitle. 0 = top */
 193
 194     struct
 195     {
 196         /*  */
 197         uint32_t palette[16+1];
 198
 199         /* the width of the original movie the spu was extracted from */
 200         int i_original_frame_width;
 201         /* the height of the original movie the spu was extracted from */
 202         int i_original_frame_height;
 203     } spu;
 204
 205     struct
 206     {
 207         int i_id;
 208     } dvb;
 209     struct
 210     {
 211         int i_magazine;
 212         int i_page;
 213     } teletext;
 214 };
 215
 216 /**
 217  * ES language definition
 218  */
 219 typedef struct extra_languages_t
 220 {
 221         char *psz_language;
 222         char *psz_description;
 223 } extra_languages_t;
 224
 225 /**
 226  * ES format definition
 227  */
 228 struct es_format_t
 229 {
 230     int             i_cat;              /**< ES category @see es_format_category_e */
 231     vlc_fourcc_t    i_codec;            /**< FOURCC value as used in vlc */
 232     vlc_fourcc_t    i_original_fourcc;  /**< original FOURCC from the container */
 233
 234     int             i_id;       /**< es identifier, where means
 235                                     -1: let the core mark the right id
 236                                     >=0: valid id */
 237     int             i_group;    /**< group identifier, where means:
 238                                     -1 : standalone
 239                                     >= 0 then a "group" (program) is created
 240                                         for each value */
 241     int             i_priority; /**< priority, where means:
 242                                     -2 : mean not selectable by the users
 243                                     -1 : mean not selected by default even
 244                                          when no other stream
 245                                     >=0: priority */
 246
 247     char            *psz_language;        /**< human readible language name */
 248     char            *psz_description;     /**< human readible description of language */
 249     int             i_extra_languages;    /**< length in bytes of extra language data pointer */
 250     extra_languages_t *p_extra_languages; /**< extra language data needed by some decoders */
 251
 252     audio_format_t  audio;    /**< description of audio format */
 253     audio_replay_gain_t audio_replay_gain; /*< audio replay gain information */
 254     video_format_t video;     /**< description of video format */
 255     subs_format_t  subs;      /**< description of subtitle format */
 256
 257     unsigned int   i_bitrate; /**< bitrate of this ES */
 258     int      i_profile;       /**< codec specific information (like real audio flavor, mpeg audio layer, h264 profile ...) */
 259     int      i_level;         /**< codec specific information: indicates maximum restrictions on the stream (resolution, bitrate, codec features ...) */
 260
 261     bool     b_packetized;  /**< wether the data is packetized (ie. not truncated) */
 262     int     i_extra;        /**< length in bytes of extra data pointer */
 263     void    *p_extra;       /**< extra data needed by some decoders or muxers */
 264
 265 };
 266
 267 /** ES Categories */
 268 enum es_format_category_e
 269 {
 270     UNKNOWN_ES = 0x00,
 271     VIDEO_ES   = 0x01,
 272     AUDIO_ES   = 0x02,
 273     SPU_ES     = 0x03,
 274     NAV_ES     = 0x04,
 275 };
 276
 277 /**
 278  * This function will fill all RGB shift from RGB masks.
 279  */
 280 VLC_EXPORT( void, video_format_FixRgb, ( video_format_t * ) );
 281
 282 /**
 283  * This function will initialize a es_format_t structure.
 284  */
 285 VLC_EXPORT( void, es_format_Init, ( es_format_t *, int i_cat, vlc_fourcc_t i_codec ) );
 286
 287 /**
 288  * This function will initialize a es_format_t structure from a video_format_t.
 289  */
 290 VLC_EXPORT( void, es_format_InitFromVideo, ( es_format_t *, const video_format_t * ) );
 291
 292 /**
 293  * This functions will copy a es_format_t.
 294  */
 295 VLC_EXPORT( int, es_format_Copy, ( es_format_t *p_dst, const es_format_t *p_src ) );
 296
 297 /**
 298  * This function will clean up a es_format_t and relasing all associated
 299  * resources.
 300  * You can call it multiple times on the same structure.
 301  */
 302 VLC_EXPORT( void, es_format_Clean, ( es_format_t *fmt ) );
 303
 304 /**
 305  * This function will check if the first ES format is similar
 306  * to the second one.
 307  *
 308  * All descriptive fields are ignored.
 309  */
 310 VLC_EXPORT( bool, es_format_IsSimilar, ( const es_format_t *, const es_format_t * ) );
 311
 312 #endif