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