include/vlc_es.h

   1 /*****************************************************************************
   2  * vlc_es.h: Elementary stream formats descriptions
   3  *****************************************************************************
   4  * Copyright (C) 1999-2012 VLC authors and VideoLAN
   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 it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * 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     uint16_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 /* Values available for audio channels */
  99 #define AOUT_CHAN_CENTER            0x1
 100 #define AOUT_CHAN_LEFT              0x2
 101 #define AOUT_CHAN_RIGHT             0x4
 102 #define AOUT_CHAN_REARCENTER        0x10
 103 #define AOUT_CHAN_REARLEFT          0x20
 104 #define AOUT_CHAN_REARRIGHT         0x40
 105 #define AOUT_CHAN_MIDDLELEFT        0x100
 106 #define AOUT_CHAN_MIDDLERIGHT       0x200
 107 #define AOUT_CHAN_LFE               0x1000
 108
 109 #define AOUT_CHANS_FRONT  (AOUT_CHAN_LEFT       | AOUT_CHAN_RIGHT)
 110 #define AOUT_CHANS_MIDDLE (AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT)
 111 #define AOUT_CHANS_REAR   (AOUT_CHAN_REARLEFT   | AOUT_CHAN_REARRIGHT)
 112 #define AOUT_CHANS_CENTER (AOUT_CHAN_CENTER     | AOUT_CHAN_REARCENTER)
 113
 114 #define AOUT_CHANS_STEREO AOUT_CHANS_2_0
 115 #define AOUT_CHANS_2_0    (AOUT_CHANS_FRONT)
 116 #define AOUT_CHANS_2_1    (AOUT_CHANS_FRONT | AOUT_CHAN_LFE)
 117 #define AOUT_CHANS_3_0    (AOUT_CHANS_FRONT | AOUT_CHAN_CENTER)
 118 #define AOUT_CHANS_3_1    (AOUT_CHANS_3_0   | AOUT_CHAN_LFE)
 119 #define AOUT_CHANS_4_0    (AOUT_CHANS_FRONT | AOUT_CHANS_REAR)
 120 #define AOUT_CHANS_4_1    (AOUT_CHANS_4_0   | AOUT_CHAN_LFE)
 121 #define AOUT_CHANS_5_0    (AOUT_CHANS_4_0   | AOUT_CHAN_CENTER)
 122 #define AOUT_CHANS_5_1    (AOUT_CHANS_5_0   | AOUT_CHAN_LFE)
 123 #define AOUT_CHANS_6_0    (AOUT_CHANS_4_0   | AOUT_CHANS_MIDDLE)
 124 #define AOUT_CHANS_7_0    (AOUT_CHANS_6_0   | AOUT_CHAN_CENTER)
 125 #define AOUT_CHANS_7_1    (AOUT_CHANS_5_1   | AOUT_CHANS_MIDDLE)
 126 #define AOUT_CHANS_8_1    (AOUT_CHANS_7_1   | AOUT_CHAN_REARCENTER)
 127
 128 #define AOUT_CHANS_4_0_MIDDLE (AOUT_CHANS_FRONT | AOUT_CHANS_MIDDLE)
 129 #define AOUT_CHANS_4_CENTER_REAR (AOUT_CHANS_FRONT | AOUT_CHANS_CENTER)
 130 #define AOUT_CHANS_5_0_MIDDLE (AOUT_CHANS_4_0_MIDDLE | AOUT_CHAN_CENTER)
 131 #define AOUT_CHANS_6_1_MIDDLE (AOUT_CHANS_5_0_MIDDLE | AOUT_CHAN_REARCENTER | AOUT_CHAN_LFE)
 132
 133 /* Values available for original channels only */
 134 #define AOUT_CHAN_DOLBYSTEREO       0x10000
 135 #define AOUT_CHAN_DUALMONO          0x20000
 136 #define AOUT_CHAN_REVERSESTEREO     0x40000
 137
 138 #define AOUT_CHAN_PHYSMASK          0xFFFF
 139 #define AOUT_CHAN_MAX               9
 140
 141 /**
 142  * Picture orientation.
 143  */
 144 typedef enum video_orientation_t
 145 {
 146     ORIENT_TOP_LEFT = 0, /**< Top line represents top, left column left. */
 147     ORIENT_TOP_RIGHT, /**< Flipped horizontally */
 148     ORIENT_BOTTOM_LEFT, /**< Flipped vertically */
 149     ORIENT_BOTTOM_RIGHT, /**< Rotated 180 degrees */
 150     ORIENT_LEFT_TOP, /**< Transposed */
 151     ORIENT_LEFT_BOTTOM, /**< Rotated 90 degrees clockwise */
 152     ORIENT_RIGHT_TOP, /**< Rotated 90 degrees anti-clockwise */
 153     ORIENT_RIGHT_BOTTOM, /**< Anti-transposed */
 154
 155     ORIENT_NORMAL      = ORIENT_TOP_LEFT,
 156     ORIENT_HFLIPPED    = ORIENT_TOP_RIGHT,
 157     ORIENT_VFLIPPED    = ORIENT_BOTTOM_LEFT,
 158     ORIENT_ROTATED_180 = ORIENT_BOTTOM_RIGHT,
 159     ORIENT_ROTATED_270 = ORIENT_LEFT_BOTTOM,
 160     ORIENT_ROTATED_90  = ORIENT_RIGHT_TOP,
 161 } video_orientation_t;
 162 /** Convert EXIF orientation to enum video_orientation_t */
 163 #define ORIENT_FROM_EXIF(exif) ((0x01324675U >> (4 * ((exif) - 1))) & 7)
 164 /** Convert enum video_orientation_t to EXIF */
 165 #define ORIENT_TO_EXIF(orient) ((0x12435867U >> (4 * (orient))) & 15)
 166 /** If the orientation is natural or mirrored */
 167 #define ORIENT_IS_MIRROR(orient) parity(orient)
 168 /** If the orientation swaps dimensions */
 169 #define ORIENT_IS_SWAP(orient) (((orient) & 4) != 0)
 170 /** Applies horizontal flip to an orientation */
 171 #define ORIENT_HFLIP(orient) ((orient) ^ 1)
 172 /** Applies vertical flip to an orientation */
 173 #define ORIENT_VFLIP(orient) ((orient) ^ 2)
 174 /** Applies horizontal flip to an orientation */
 175 #define ORIENT_ROTATE_180(orient) ((orient) ^ 3)
 176
 177 /**
 178  * video format description
 179  */
 180 struct video_format_t
 181 {
 182     vlc_fourcc_t i_chroma;                               /**< picture chroma */
 183
 184     unsigned int i_width;                                 /**< picture width */
 185     unsigned int i_height;                               /**< picture height */
 186     unsigned int i_x_offset;               /**< start offset of visible area */
 187     unsigned int i_y_offset;               /**< start offset of visible area */
 188     unsigned int i_visible_width;                 /**< width of visible area */
 189     unsigned int i_visible_height;               /**< height of visible area */
 190
 191     unsigned int i_bits_per_pixel;             /**< number of bits per pixel */
 192
 193     unsigned int i_sar_num;                   /**< sample/pixel aspect ratio */
 194     unsigned int i_sar_den;
 195
 196     unsigned int i_frame_rate;                     /**< frame rate numerator */
 197     unsigned int i_frame_rate_base;              /**< frame rate denominator */
 198
 199     uint32_t i_rmask, i_gmask, i_bmask;          /**< color masks for RGB chroma */
 200     int i_rrshift, i_lrshift;
 201     int i_rgshift, i_lgshift;
 202     int i_rbshift, i_lbshift;
 203     video_palette_t *p_palette;              /**< video palette from demuxer */
 204     video_orientation_t orientation;                /**< picture orientation */
 205 };
 206
 207 /**
 208  * Initialize a video_format_t structure with chroma 'i_chroma'
 209  * \param p_src pointer to video_format_t structure
 210  * \param i_chroma chroma value to use
 211  */
 212 static inline void video_format_Init( video_format_t *p_src, vlc_fourcc_t i_chroma )
 213 {
 214     memset( p_src, 0, sizeof( video_format_t ) );
 215     p_src->i_chroma = i_chroma;
 216     p_src->i_sar_num = p_src->i_sar_den = 1;
 217     p_src->p_palette = NULL;
 218 }
 219
 220 /**
 221  * Copy video_format_t including the palette
 222  * \param p_dst video_format_t to copy to
 223  * \param p_src video_format_t to copy from
 224  */
 225 static inline int video_format_Copy( video_format_t *p_dst, const video_format_t *p_src )
 226 {
 227     memcpy( p_dst, p_src, sizeof( *p_dst ) );
 228     if( p_src->p_palette )
 229     {
 230         p_dst->p_palette = (video_palette_t *) malloc( sizeof( video_palette_t ) );
 231         if( !p_dst->p_palette )
 232             return VLC_ENOMEM;
 233         memcpy( p_dst->p_palette, p_src->p_palette, sizeof( *p_dst->p_palette ) );
 234     }
 235     return VLC_SUCCESS;
 236 }
 237
 238 /**
 239  * Cleanup and free palette of this video_format_t
 240  * \param p_src video_format_t structure to clean
 241  */
 242 static inline void video_format_Clean( video_format_t *p_src )
 243 {
 244     free( p_src->p_palette );
 245     memset( p_src, 0, sizeof( video_format_t ) );
 246     p_src->p_palette = NULL;
 247 }
 248
 249 /**
 250  * It will fill up a video_format_t using the given arguments.
 251  * Note that the video_format_t must already be initialized.
 252  */
 253 VLC_API 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 );
 254
 255 /**
 256  * It will copy the crop properties from a video_format_t to another.
 257  */
 258 VLC_API void video_format_CopyCrop( video_format_t *, const video_format_t * );
 259
 260 /**
 261  * It will compute the crop/ar properties when scaling.
 262  */
 263 VLC_API void video_format_ScaleCropAr( video_format_t *, const video_format_t * );
 264
 265 /**
 266  * This function will check if the first video format is similar
 267  * to the second one.
 268  */
 269 VLC_API bool video_format_IsSimilar( const video_format_t *, const video_format_t * );
 270
 271 /**
 272  * It prints details about the given video_format_t
 273  */
 274 VLC_API void video_format_Print( vlc_object_t *, const char *, const video_format_t * );
 275
 276 /**
 277  * subtitles format description
 278  */
 279 struct subs_format_t
 280 {
 281     /* the character encoding of the text of the subtitle.
 282      * all gettext recognized shorts can be used */
 283     char *psz_encoding;
 284
 285
 286     int  i_x_origin; /**< x coordinate of the subtitle. 0 = left */
 287     int  i_y_origin; /**< y coordinate of the subtitle. 0 = top */
 288
 289     struct
 290     {
 291         /*  */
 292         uint32_t palette[16+1];
 293
 294         /* the width of the original movie the spu was extracted from */
 295         int i_original_frame_width;
 296         /* the height of the original movie the spu was extracted from */
 297         int i_original_frame_height;
 298     } spu;
 299
 300     struct
 301     {
 302         int i_id;
 303     } dvb;
 304     struct
 305     {
 306         int i_magazine;
 307         int i_page;
 308     } teletext;
 309 };
 310
 311 /**
 312  * ES language definition
 313  */
 314 typedef struct extra_languages_t
 315 {
 316         char *psz_language;
 317         char *psz_description;
 318 } extra_languages_t;
 319
 320 /**
 321  * ES format definition
 322  */
 323 struct es_format_t
 324 {
 325     int             i_cat;              /**< ES category @see es_format_category_e */
 326     vlc_fourcc_t    i_codec;            /**< FOURCC value as used in vlc */
 327     vlc_fourcc_t    i_original_fourcc;  /**< original FOURCC from the container */
 328
 329     int             i_id;       /**< es identifier, where means
 330                                     -1: let the core mark the right id
 331                                     >=0: valid id */
 332     int             i_group;    /**< group identifier, where means:
 333                                     -1 : standalone
 334                                     >= 0 then a "group" (program) is created
 335                                         for each value */
 336     int             i_priority; /**< priority, where means:
 337                                     -2 : mean not selectable by the users
 338                                     -1 : mean not selected by default even
 339                                          when no other stream
 340                                     >=0: priority */
 341
 342     char            *psz_language;        /**< human readible language name */
 343     char            *psz_description;     /**< human readible description of language */
 344     int             i_extra_languages;    /**< length in bytes of extra language data pointer */
 345     extra_languages_t *p_extra_languages; /**< extra language data needed by some decoders */
 346
 347     audio_format_t  audio;    /**< description of audio format */
 348     audio_replay_gain_t audio_replay_gain; /*< audio replay gain information */
 349     video_format_t video;     /**< description of video format */
 350     subs_format_t  subs;      /**< description of subtitle format */
 351
 352     unsigned int   i_bitrate; /**< bitrate of this ES */
 353     int      i_profile;       /**< codec specific information (like real audio flavor, mpeg audio layer, h264 profile ...) */
 354     int      i_level;         /**< codec specific information: indicates maximum restrictions on the stream (resolution, bitrate, codec features ...) */
 355
 356     bool     b_packetized;  /**< whether the data is packetized (ie. not truncated) */
 357     int     i_extra;        /**< length in bytes of extra data pointer */
 358     void    *p_extra;       /**< extra data needed by some decoders or muxers */
 359
 360 };
 361
 362 /** ES Categories */
 363 enum es_format_category_e
 364 {
 365     UNKNOWN_ES = 0x00,
 366     VIDEO_ES   = 0x01,
 367     AUDIO_ES   = 0x02,
 368     SPU_ES     = 0x03,
 369     NAV_ES     = 0x04,
 370 };
 371
 372 /**
 373  * This function will fill all RGB shift from RGB masks.
 374  */
 375 VLC_API void video_format_FixRgb( video_format_t * );
 376
 377 /**
 378  * This function will initialize a es_format_t structure.
 379  */
 380 VLC_API void es_format_Init( es_format_t *, int i_cat, vlc_fourcc_t i_codec );
 381
 382 /**
 383  * This function will initialize a es_format_t structure from a video_format_t.
 384  */
 385 VLC_API void es_format_InitFromVideo( es_format_t *, const video_format_t * );
 386
 387 /**
 388  * This functions will copy a es_format_t.
 389  */
 390 VLC_API int es_format_Copy( es_format_t *p_dst, const es_format_t *p_src );
 391
 392 /**
 393  * This function will clean up a es_format_t and release all associated
 394  * resources.
 395  * You can call it multiple times on the same structure.
 396  */
 397 VLC_API void es_format_Clean( es_format_t *fmt );
 398
 399 /**
 400  * This function will check if the first ES format is similar
 401  * to the second one.
 402  *
 403  * All descriptive fields are ignored.
 404  */
 405 VLC_API bool es_format_IsSimilar( const es_format_t *, const es_format_t * );
 406
 407 #endif