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_common.h>
  28 #include <vlc_fourcc.h>
  29 #include <vlc_text_style.h>
  30
  31 /**
  32  * \file
  33  * This file defines the elementary streams format types
  34  */
  35
  36 /**
  37  * video palette data
  38  * \see video_format_t
  39  * \see subs_format_t
  40  */
  41 #define VIDEO_PALETTE_COLORS_MAX 256
  42
  43 struct video_palette_t
  44 {
  45     int i_entries;      /**< to keep the compatibility with libavcodec's palette */
  46     uint8_t palette[VIDEO_PALETTE_COLORS_MAX][4];  /**< 4-byte RGBA/YUVA palette */
  47 };
  48
  49 /**
  50  * audio replay gain description
  51  */
  52 #define AUDIO_REPLAY_GAIN_MAX (2)
  53 #define AUDIO_REPLAY_GAIN_TRACK (0)
  54 #define AUDIO_REPLAY_GAIN_ALBUM (1)
  55 typedef struct
  56 {
  57     /* true if we have the peak value */
  58     bool pb_peak[AUDIO_REPLAY_GAIN_MAX];
  59     /* peak value where 1.0 means full sample value */
  60     float      pf_peak[AUDIO_REPLAY_GAIN_MAX];
  61
  62     /* true if we have the gain value */
  63     bool pb_gain[AUDIO_REPLAY_GAIN_MAX];
  64     /* gain value in dB */
  65     float      pf_gain[AUDIO_REPLAY_GAIN_MAX];
  66 } audio_replay_gain_t;
  67
  68 /**
  69  * audio format description
  70  */
  71 struct audio_format_t
  72 {
  73     vlc_fourcc_t i_format;                          /**< audio format fourcc */
  74     unsigned int i_rate;                              /**< audio sample-rate */
  75
  76     /* Describes the channels configuration of the samples (ie. number of
  77      * channels which are available in the buffer, and positions). */
  78     uint16_t     i_physical_channels;
  79
  80     /* Describes from which original channels, before downmixing, the
  81      * buffer is derived. */
  82     uint32_t     i_original_channels;
  83
  84     /* Optional - for A/52, SPDIF and DTS types : */
  85     /* Bytes used by one compressed frame, depends on bitrate. */
  86     unsigned int i_bytes_per_frame;
  87
  88     /* Number of sampleframes contained in one compressed frame. */
  89     unsigned int i_frame_length;
  90     /* Please note that it may be completely arbitrary - buffers are not
  91      * obliged to contain a integral number of so-called "frames". It's
  92      * just here for the division :
  93      * buffer_size = i_nb_samples * i_bytes_per_frame / i_frame_length
  94      */
  95
  96     /* FIXME ? (used by the codecs) */
  97     unsigned     i_bitspersample;
  98     unsigned     i_blockalign;
  99     uint8_t      i_channels; /* must be <=32 */
 100 };
 101
 102 /* Values available for audio channels */
 103 #define AOUT_CHAN_CENTER            0x1
 104 #define AOUT_CHAN_LEFT              0x2
 105 #define AOUT_CHAN_RIGHT             0x4
 106 #define AOUT_CHAN_REARCENTER        0x10
 107 #define AOUT_CHAN_REARLEFT          0x20
 108 #define AOUT_CHAN_REARRIGHT         0x40
 109 #define AOUT_CHAN_MIDDLELEFT        0x100
 110 #define AOUT_CHAN_MIDDLERIGHT       0x200
 111 #define AOUT_CHAN_LFE               0x1000
 112
 113 #define AOUT_CHANS_FRONT  (AOUT_CHAN_LEFT       | AOUT_CHAN_RIGHT)
 114 #define AOUT_CHANS_MIDDLE (AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT)
 115 #define AOUT_CHANS_REAR   (AOUT_CHAN_REARLEFT   | AOUT_CHAN_REARRIGHT)
 116 #define AOUT_CHANS_CENTER (AOUT_CHAN_CENTER     | AOUT_CHAN_REARCENTER)
 117
 118 #define AOUT_CHANS_STEREO AOUT_CHANS_2_0
 119 #define AOUT_CHANS_2_0    (AOUT_CHANS_FRONT)
 120 #define AOUT_CHANS_2_1    (AOUT_CHANS_FRONT | AOUT_CHAN_LFE)
 121 #define AOUT_CHANS_3_0    (AOUT_CHANS_FRONT | AOUT_CHAN_CENTER)
 122 #define AOUT_CHANS_3_1    (AOUT_CHANS_3_0   | AOUT_CHAN_LFE)
 123 #define AOUT_CHANS_4_0    (AOUT_CHANS_FRONT | AOUT_CHANS_REAR)
 124 #define AOUT_CHANS_4_1    (AOUT_CHANS_4_0   | AOUT_CHAN_LFE)
 125 #define AOUT_CHANS_5_0    (AOUT_CHANS_4_0   | AOUT_CHAN_CENTER)
 126 #define AOUT_CHANS_5_1    (AOUT_CHANS_5_0   | AOUT_CHAN_LFE)
 127 #define AOUT_CHANS_6_0    (AOUT_CHANS_4_0   | AOUT_CHANS_MIDDLE)
 128 #define AOUT_CHANS_7_0    (AOUT_CHANS_6_0   | AOUT_CHAN_CENTER)
 129 #define AOUT_CHANS_7_1    (AOUT_CHANS_5_1   | AOUT_CHANS_MIDDLE)
 130 #define AOUT_CHANS_8_1    (AOUT_CHANS_7_1   | AOUT_CHAN_REARCENTER)
 131
 132 #define AOUT_CHANS_4_0_MIDDLE (AOUT_CHANS_FRONT | AOUT_CHANS_MIDDLE)
 133 #define AOUT_CHANS_4_CENTER_REAR (AOUT_CHANS_FRONT | AOUT_CHANS_CENTER)
 134 #define AOUT_CHANS_5_0_MIDDLE (AOUT_CHANS_4_0_MIDDLE | AOUT_CHAN_CENTER)
 135 #define AOUT_CHANS_6_1_MIDDLE (AOUT_CHANS_5_0_MIDDLE | AOUT_CHAN_REARCENTER | AOUT_CHAN_LFE)
 136
 137 /* Values available for original channels only */
 138 #define AOUT_CHAN_DOLBYSTEREO       0x10000
 139 #define AOUT_CHAN_DUALMONO          0x20000
 140 #define AOUT_CHAN_REVERSESTEREO     0x40000
 141
 142 #define AOUT_CHAN_PHYSMASK          0xFFFF
 143 #define AOUT_CHAN_MAX               9
 144
 145 /**
 146  * Picture orientation.
 147  */
 148 typedef enum video_orientation_t
 149 {
 150     ORIENT_TOP_LEFT = 0, /**< Top line represents top, left column left. */
 151     ORIENT_TOP_RIGHT, /**< Flipped horizontally */
 152     ORIENT_BOTTOM_LEFT, /**< Flipped vertically */
 153     ORIENT_BOTTOM_RIGHT, /**< Rotated 180 degrees */
 154     ORIENT_LEFT_TOP, /**< Transposed */
 155     ORIENT_LEFT_BOTTOM, /**< Rotated 90 degrees clockwise */
 156     ORIENT_RIGHT_TOP, /**< Rotated 90 degrees anti-clockwise */
 157     ORIENT_RIGHT_BOTTOM, /**< Anti-transposed */
 158
 159     ORIENT_NORMAL      = ORIENT_TOP_LEFT,
 160     ORIENT_TRANSPOSED  = ORIENT_LEFT_TOP,
 161     ORIENT_ANTI_TRANSPOSED = ORIENT_RIGHT_BOTTOM,
 162     ORIENT_HFLIPPED    = ORIENT_TOP_RIGHT,
 163     ORIENT_VFLIPPED    = ORIENT_BOTTOM_LEFT,
 164     ORIENT_ROTATED_180 = ORIENT_BOTTOM_RIGHT,
 165     ORIENT_ROTATED_270 = ORIENT_LEFT_BOTTOM,
 166     ORIENT_ROTATED_90  = ORIENT_RIGHT_TOP,
 167 } video_orientation_t;
 168 /** Convert EXIF orientation to enum video_orientation_t */
 169 #define ORIENT_FROM_EXIF(exif) ((0x01324675U >> (4 * ((exif) - 1))) & 7)
 170 /** Convert enum video_orientation_t to EXIF */
 171 #define ORIENT_TO_EXIF(orient) ((0x12435867U >> (4 * (orient))) & 15)
 172 /** If the orientation is natural or mirrored */
 173 #define ORIENT_IS_MIRROR(orient) parity(orient)
 174 /** If the orientation swaps dimensions */
 175 #define ORIENT_IS_SWAP(orient) (((orient) & 4) != 0)
 176 /** Applies horizontal flip to an orientation */
 177 #define ORIENT_HFLIP(orient) ((orient) ^ 1)
 178 /** Applies vertical flip to an orientation */
 179 #define ORIENT_VFLIP(orient) ((orient) ^ 2)
 180 /** Applies horizontal flip to an orientation */
 181 #define ORIENT_ROTATE_180(orient) ((orient) ^ 3)
 182
 183 typedef enum video_transform_t
 184 {
 185     TRANSFORM_IDENTITY       = ORIENT_NORMAL,
 186     TRANSFORM_HFLIP          = ORIENT_HFLIPPED,
 187     TRANSFORM_VFLIP          = ORIENT_VFLIPPED,
 188     TRANSFORM_R180           = ORIENT_ROTATED_180,
 189     TRANSFORM_R270           = ORIENT_ROTATED_270,
 190     TRANSFORM_R90            = ORIENT_ROTATED_90,
 191     TRANSFORM_TRANSPOSE      = ORIENT_TRANSPOSED,
 192     TRANSFORM_ANTI_TRANSPOSE = ORIENT_ANTI_TRANSPOSED
 193 } video_transform_t;
 194
 195 /**
 196  * video format description
 197  */
 198 struct video_format_t
 199 {
 200     vlc_fourcc_t i_chroma;                               /**< picture chroma */
 201
 202     unsigned int i_width;                                 /**< picture width */
 203     unsigned int i_height;                               /**< picture height */
 204     unsigned int i_x_offset;               /**< start offset of visible area */
 205     unsigned int i_y_offset;               /**< start offset of visible area */
 206     unsigned int i_visible_width;                 /**< width of visible area */
 207     unsigned int i_visible_height;               /**< height of visible area */
 208
 209     unsigned int i_bits_per_pixel;             /**< number of bits per pixel */
 210
 211     unsigned int i_sar_num;                   /**< sample/pixel aspect ratio */
 212     unsigned int i_sar_den;
 213
 214     unsigned int i_frame_rate;                     /**< frame rate numerator */
 215     unsigned int i_frame_rate_base;              /**< frame rate denominator */
 216
 217     uint32_t i_rmask, i_gmask, i_bmask;      /**< color masks for RGB chroma */
 218     int i_rrshift, i_lrshift;
 219     int i_rgshift, i_lgshift;
 220     int i_rbshift, i_lbshift;
 221     video_palette_t *p_palette;              /**< video palette from demuxer */
 222     video_orientation_t orientation;                /**< picture orientation */
 223 };
 224
 225 /**
 226  * Initialize a video_format_t structure with chroma 'i_chroma'
 227  * \param p_src pointer to video_format_t structure
 228  * \param i_chroma chroma value to use
 229  */
 230 static inline void video_format_Init( video_format_t *p_src, vlc_fourcc_t i_chroma )
 231 {
 232     memset( p_src, 0, sizeof( video_format_t ) );
 233     p_src->i_chroma = i_chroma;
 234     p_src->i_sar_num = p_src->i_sar_den = 1;
 235     p_src->p_palette = NULL;
 236 }
 237
 238 /**
 239  * Copy video_format_t including the palette
 240  * \param p_dst video_format_t to copy to
 241  * \param p_src video_format_t to copy from
 242  */
 243 static inline int video_format_Copy( video_format_t *p_dst, const video_format_t *p_src )
 244 {
 245     memcpy( p_dst, p_src, sizeof( *p_dst ) );
 246     if( p_src->p_palette )
 247     {
 248         p_dst->p_palette = (video_palette_t *) malloc( sizeof( video_palette_t ) );
 249         if( !p_dst->p_palette )
 250             return VLC_ENOMEM;
 251         memcpy( p_dst->p_palette, p_src->p_palette, sizeof( *p_dst->p_palette ) );
 252     }
 253     return VLC_SUCCESS;
 254 }
 255
 256 /**
 257  * Cleanup and free palette of this video_format_t
 258  * \param p_src video_format_t structure to clean
 259  */
 260 static inline void video_format_Clean( video_format_t *p_src )
 261 {
 262     free( p_src->p_palette );
 263     memset( p_src, 0, sizeof( video_format_t ) );
 264     p_src->p_palette = NULL;
 265 }
 266
 267 /**
 268  * It will fill up a video_format_t using the given arguments.
 269  * Note that the video_format_t must already be initialized.
 270  */
 271 VLC_API void video_format_Setup( video_format_t *, vlc_fourcc_t i_chroma,
 272     int i_width, int i_height, int i_visible_width, int i_visible_height,
 273     int i_sar_num, int i_sar_den );
 274
 275 /**
 276  * It will copy the crop properties from a video_format_t to another.
 277  */
 278 VLC_API void video_format_CopyCrop( video_format_t *, const video_format_t * );
 279
 280 /**
 281  * It will compute the crop/ar properties when scaling.
 282  */
 283 VLC_API void video_format_ScaleCropAr( video_format_t *, const video_format_t * );
 284
 285 /**
 286  * This function "normalizes" the formats orientation, by switching the a/r according to the orientation,
 287  * producing a format whose orientation is ORIENT_NORMAL. It makes a shallow copy (pallette is not alloc'ed).
 288  */
 289 VLC_API void video_format_ApplyRotation(video_format_t * /*restrict*/ out,
 290                                         const video_format_t *in);
 291
 292 /**
 293  * This function applies the transform operation to fmt.
 294  */
 295 VLC_API void video_format_TransformBy(video_format_t *fmt, video_transform_t transform);
 296
 297 /**
 298  * This function applies the transforms necessary to fmt so that the resulting fmt
 299  * has the dst_orientation.
 300  */
 301 VLC_API void video_format_TransformTo(video_format_t *fmt, video_orientation_t dst_orientation);
 302
 303 /**
 304  * Returns the operation required to transform src into dst.
 305  */
 306 VLC_API video_transform_t video_format_GetTransform(video_orientation_t src, video_orientation_t dst);
 307
 308 /**
 309  * This function will check if the first video format is similar
 310  * to the second one.
 311  */
 312 VLC_API bool video_format_IsSimilar( const video_format_t *, const video_format_t * );
 313
 314 /**
 315  * It prints details about the given video_format_t
 316  */
 317 VLC_API void video_format_Print( vlc_object_t *, const char *, const video_format_t * );
 318
 319
 320 static inline video_transform_t transform_Inverse( video_transform_t transform )
 321 {
 322     switch ( transform ) {
 323         case TRANSFORM_R90:
 324             return TRANSFORM_R270;
 325         case TRANSFORM_R270:
 326             return TRANSFORM_R90;
 327         default:
 328             return transform;
 329     }
 330 }
 331 /**
 332  * subtitles format description
 333  */
 334 struct subs_format_t
 335 {
 336     /* the character encoding of the text of the subtitle.
 337      * all gettext recognized shorts can be used */
 338     char *psz_encoding;
 339
 340
 341     int  i_x_origin; /**< x coordinate of the subtitle. 0 = left */
 342     int  i_y_origin; /**< y coordinate of the subtitle. 0 = top */
 343
 344     struct
 345     {
 346         /*  */
 347         uint32_t palette[16+1];
 348
 349         /* the width of the original movie the spu was extracted from */
 350         int i_original_frame_width;
 351         /* the height of the original movie the spu was extracted from */
 352         int i_original_frame_height;
 353     } spu;
 354
 355     struct
 356     {
 357         int i_id;
 358     } dvb;
 359     struct
 360     {
 361         int i_magazine;
 362         int i_page;
 363     } teletext;
 364
 365     text_style_t *p_style; /* Default styles to use */
 366 };
 367
 368 /**
 369  * ES language definition
 370  */
 371 typedef struct extra_languages_t
 372 {
 373         char *psz_language;
 374         char *psz_description;
 375 } extra_languages_t;
 376
 377 /**
 378  * ES format definition
 379  */
 380 #define ES_PRIORITY_NOT_SELECTABLE  -2
 381 #define ES_PRIORITY_NOT_DEFAULTABLE -1
 382 #define ES_PRIORITY_SELECTABLE_MIN   0
 383 #define ES_PRIORITY_MIN ES_PRIORITY_NOT_SELECTABLE
 384 struct es_format_t
 385 {
 386     int             i_cat;              /**< ES category @see es_format_category_e */
 387     vlc_fourcc_t    i_codec;            /**< FOURCC value as used in vlc */
 388     vlc_fourcc_t    i_original_fourcc;  /**< original FOURCC from the container */
 389
 390     int             i_id;       /**< es identifier, where means
 391                                     -1: let the core mark the right id
 392                                     >=0: valid id */
 393     int             i_group;    /**< group identifier, where means:
 394                                     -1 : standalone
 395                                     >= 0 then a "group" (program) is created
 396                                         for each value */
 397     int             i_priority; /**< priority, where means:
 398                                     -2 : mean not selectable by the users
 399                                     -1 : mean not selected by default even
 400                                          when no other stream
 401                                     >=0: priority */
 402
 403     char            *psz_language;        /**< human-readable language name */
 404     char            *psz_description;     /**< human-readable description of language */
 405     unsigned        i_extra_languages;    /**< length in bytes of extra language data pointer */
 406     extra_languages_t *p_extra_languages; /**< extra language data needed by some decoders */
 407
 408     audio_format_t  audio;    /**< description of audio format */
 409     audio_replay_gain_t audio_replay_gain; /*< audio replay gain information */
 410     video_format_t video;     /**< description of video format */
 411     subs_format_t  subs;      /**< description of subtitle format */
 412
 413     unsigned int   i_bitrate; /**< bitrate of this ES */
 414     int      i_profile;       /**< codec specific information (like real audio flavor, mpeg audio layer, h264 profile ...) */
 415     int      i_level;         /**< codec specific information: indicates maximum restrictions on the stream (resolution, bitrate, codec features ...) */
 416
 417     bool     b_packetized;  /**< whether the data is packetized (ie. not truncated) */
 418     int     i_extra;        /**< length in bytes of extra data pointer */
 419     void    *p_extra;       /**< extra data needed by some decoders or muxers */
 420
 421 };
 422
 423 /** ES Categories */
 424 enum es_format_category_e
 425 {
 426     UNKNOWN_ES = 0x00,
 427     VIDEO_ES,
 428     AUDIO_ES,
 429     SPU_ES,
 430     NAV_ES,
 431 };
 432 #define ES_CATEGORY_COUNT (NAV_ES + 1)
 433
 434 /**
 435  * This function will fill all RGB shift from RGB masks.
 436  */
 437 VLC_API void video_format_FixRgb( video_format_t * );
 438
 439 /**
 440  * This function will initialize a es_format_t structure.
 441  */
 442 VLC_API void es_format_Init( es_format_t *, int i_cat, vlc_fourcc_t i_codec );
 443
 444 /**
 445  * This function will initialize a es_format_t structure from a video_format_t.
 446  */
 447 VLC_API void es_format_InitFromVideo( es_format_t *, const video_format_t * );
 448
 449 /**
 450  * This functions will copy a es_format_t.
 451  */
 452 VLC_API int es_format_Copy( es_format_t *p_dst, const es_format_t *p_src );
 453
 454 /**
 455  * This function will clean up a es_format_t and release all associated
 456  * resources.
 457  * You can call it multiple times on the same structure.
 458  */
 459 VLC_API void es_format_Clean( es_format_t *fmt );
 460
 461 /**
 462  * This function will check if the first ES format is similar
 463  * to the second one.
 464  *
 465  * All descriptive fields are ignored.
 466  */
 467 VLC_API bool es_format_IsSimilar( const es_format_t *, const es_format_t * );
 468
 469 #endif