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_viewpoint.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 /**
  70  * Audio channel type
  71  */
  72 typedef enum audio_channel_type_t
  73 {
  74     AUDIO_CHANNEL_TYPE_BITMAP,
  75     AUDIO_CHANNEL_TYPE_AMBISONICS,
  76 } audio_channel_type_t;
  77
  78 /**
  79  * audio format description
  80  */
  81 struct audio_format_t
  82 {
  83     vlc_fourcc_t i_format;                          /**< audio format fourcc */
  84     unsigned int i_rate;                              /**< audio sample-rate */
  85
  86     /* Describes the channels configuration of the samples (ie. number of
  87      * channels which are available in the buffer, and positions). */
  88     uint16_t     i_physical_channels;
  89
  90     /* Describes the chan mode, either set from the input
  91      * (demux/codec/packetizer) or overridden by the user, used by audio
  92      * filters. */
  93     uint16_t     i_chan_mode;
  94
  95     /* Channel type */
  96     audio_channel_type_t channel_type;
  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 };
 115
 116 /* Values available for audio channels */
 117 #define AOUT_CHAN_CENTER            0x1
 118 #define AOUT_CHAN_LEFT              0x2
 119 #define AOUT_CHAN_RIGHT             0x4
 120 #define AOUT_CHAN_REARCENTER        0x10
 121 #define AOUT_CHAN_REARLEFT          0x20
 122 #define AOUT_CHAN_REARRIGHT         0x40
 123 #define AOUT_CHAN_MIDDLELEFT        0x100
 124 #define AOUT_CHAN_MIDDLERIGHT       0x200
 125 #define AOUT_CHAN_LFE               0x1000
 126
 127 #define AOUT_CHANS_FRONT  (AOUT_CHAN_LEFT       | AOUT_CHAN_RIGHT)
 128 #define AOUT_CHANS_MIDDLE (AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT)
 129 #define AOUT_CHANS_REAR   (AOUT_CHAN_REARLEFT   | AOUT_CHAN_REARRIGHT)
 130 #define AOUT_CHANS_CENTER (AOUT_CHAN_CENTER     | AOUT_CHAN_REARCENTER)
 131
 132 #define AOUT_CHANS_STEREO AOUT_CHANS_2_0
 133 #define AOUT_CHANS_2_0    (AOUT_CHANS_FRONT)
 134 #define AOUT_CHANS_2_1    (AOUT_CHANS_FRONT | AOUT_CHAN_LFE)
 135 #define AOUT_CHANS_3_0    (AOUT_CHANS_FRONT | AOUT_CHAN_CENTER)
 136 #define AOUT_CHANS_3_1    (AOUT_CHANS_3_0   | AOUT_CHAN_LFE)
 137 #define AOUT_CHANS_4_0    (AOUT_CHANS_FRONT | AOUT_CHANS_REAR)
 138 #define AOUT_CHANS_4_1    (AOUT_CHANS_4_0   | AOUT_CHAN_LFE)
 139 #define AOUT_CHANS_5_0    (AOUT_CHANS_4_0   | AOUT_CHAN_CENTER)
 140 #define AOUT_CHANS_5_1    (AOUT_CHANS_5_0   | AOUT_CHAN_LFE)
 141 #define AOUT_CHANS_6_0    (AOUT_CHANS_4_0   | AOUT_CHANS_MIDDLE)
 142 #define AOUT_CHANS_7_0    (AOUT_CHANS_6_0   | AOUT_CHAN_CENTER)
 143 #define AOUT_CHANS_7_1    (AOUT_CHANS_5_1   | AOUT_CHANS_MIDDLE)
 144 #define AOUT_CHANS_8_1    (AOUT_CHANS_7_1   | AOUT_CHAN_REARCENTER)
 145
 146 #define AOUT_CHANS_4_0_MIDDLE (AOUT_CHANS_FRONT | AOUT_CHANS_MIDDLE)
 147 #define AOUT_CHANS_4_CENTER_REAR (AOUT_CHANS_FRONT | AOUT_CHANS_CENTER)
 148 #define AOUT_CHANS_5_0_MIDDLE (AOUT_CHANS_4_0_MIDDLE | AOUT_CHAN_CENTER)
 149 #define AOUT_CHANS_6_1_MIDDLE (AOUT_CHANS_5_0_MIDDLE | AOUT_CHAN_REARCENTER | AOUT_CHAN_LFE)
 150
 151 /* Maximum number of mapped channels (or the maximum of bits set in
 152  * i_physical_channels) */
 153 #define AOUT_CHAN_MAX               9
 154 /* Maximum number of unmapped channels */
 155 #define INPUT_CHAN_MAX              64
 156
 157 static const uint16_t vlc_chan_maps[] =
 158 {
 159     0,
 160     AOUT_CHAN_CENTER,
 161     AOUT_CHANS_2_0,
 162     AOUT_CHANS_3_0,
 163     AOUT_CHANS_4_0,
 164     AOUT_CHANS_5_0,
 165     AOUT_CHANS_5_1,
 166     AOUT_CHANS_7_0,
 167     AOUT_CHANS_7_1,
 168     AOUT_CHANS_8_1,
 169 };
 170
 171 /* Values available for i_chan_mode only */
 172 #define AOUT_CHANMODE_DUALMONO    0x1
 173 #define AOUT_CHANMODE_DOLBYSTEREO 0x2
 174
 175 /**
 176  * Picture orientation.
 177  */
 178 typedef enum video_orientation_t
 179 {
 180     ORIENT_TOP_LEFT = 0, /**< Top line represents top, left column left. */
 181     ORIENT_TOP_RIGHT, /**< Flipped horizontally */
 182     ORIENT_BOTTOM_LEFT, /**< Flipped vertically */
 183     ORIENT_BOTTOM_RIGHT, /**< Rotated 180 degrees */
 184     ORIENT_LEFT_TOP, /**< Transposed */
 185     ORIENT_LEFT_BOTTOM, /**< Rotated 90 degrees clockwise */
 186     ORIENT_RIGHT_TOP, /**< Rotated 90 degrees anti-clockwise */
 187     ORIENT_RIGHT_BOTTOM, /**< Anti-transposed */
 188
 189     ORIENT_NORMAL      = ORIENT_TOP_LEFT,
 190     ORIENT_TRANSPOSED  = ORIENT_LEFT_TOP,
 191     ORIENT_ANTI_TRANSPOSED = ORIENT_RIGHT_BOTTOM,
 192     ORIENT_HFLIPPED    = ORIENT_TOP_RIGHT,
 193     ORIENT_VFLIPPED    = ORIENT_BOTTOM_LEFT,
 194     ORIENT_ROTATED_180 = ORIENT_BOTTOM_RIGHT,
 195     ORIENT_ROTATED_270 = ORIENT_LEFT_BOTTOM,
 196     ORIENT_ROTATED_90  = ORIENT_RIGHT_TOP,
 197 } video_orientation_t;
 198 /** Convert EXIF orientation to enum video_orientation_t */
 199 #define ORIENT_FROM_EXIF(exif) ((0x57642310U >> (4 * ((exif) - 1))) & 7)
 200 /** Convert enum video_orientation_t to EXIF */
 201 #define ORIENT_TO_EXIF(orient) ((0x76853421U >> (4 * (orient))) & 15)
 202 /** If the orientation is natural or mirrored */
 203 #define ORIENT_IS_MIRROR(orient) parity(orient)
 204 /** If the orientation swaps dimensions */
 205 #define ORIENT_IS_SWAP(orient) (((orient) & 4) != 0)
 206 /** Applies horizontal flip to an orientation */
 207 #define ORIENT_HFLIP(orient) ((orient) ^ 1)
 208 /** Applies vertical flip to an orientation */
 209 #define ORIENT_VFLIP(orient) ((orient) ^ 2)
 210 /** Applies horizontal flip to an orientation */
 211 #define ORIENT_ROTATE_180(orient) ((orient) ^ 3)
 212
 213 typedef enum video_transform_t
 214 {
 215     TRANSFORM_IDENTITY       = ORIENT_NORMAL,
 216     TRANSFORM_HFLIP          = ORIENT_HFLIPPED,
 217     TRANSFORM_VFLIP          = ORIENT_VFLIPPED,
 218     TRANSFORM_R180           = ORIENT_ROTATED_180,
 219     TRANSFORM_R270           = ORIENT_ROTATED_270,
 220     TRANSFORM_R90            = ORIENT_ROTATED_90,
 221     TRANSFORM_TRANSPOSE      = ORIENT_TRANSPOSED,
 222     TRANSFORM_ANTI_TRANSPOSE = ORIENT_ANTI_TRANSPOSED
 223 } video_transform_t;
 224
 225 typedef enum video_multiview_mode_t
 226 {
 227     /* No stereoscopy: 2D picture. */
 228     MULTIVIEW_2D = 0,
 229
 230     /* Side-by-side with left eye first. */
 231     MULTIVIEW_STEREO_SBS,
 232
 233     /* Top-bottom with left eye first. */
 234     MULTIVIEW_STEREO_TB,
 235
 236     /* Row sequential with left eye first. */
 237     MULTIVIEW_STEREO_ROW,
 238
 239     /* Column sequential with left eye first. */
 240     MULTIVIEW_STEREO_COL,
 241
 242     /* Frame sequential with left eye first. */
 243     MULTIVIEW_STEREO_FRAME,
 244
 245     /* Checkerboard pattern with left eye first. */
 246     MULTIVIEW_STEREO_CHECKERBOARD,
 247
 248 #define MULTIVIEW_STEREO_MAX  MULTIVIEW_STEREO_CHECKERBOARD
 249 } video_multiview_mode_t;
 250
 251 /**
 252  * Video projection mode.
 253  */
 254 typedef enum video_projection_mode_t
 255 {
 256     PROJECTION_MODE_RECTANGULAR = 0,
 257     PROJECTION_MODE_EQUIRECTANGULAR,
 258
 259     PROJECTION_MODE_CUBEMAP_LAYOUT_STANDARD = 0x100,
 260 } video_projection_mode_t;
 261
 262 /**
 263  * Video color primaries (a.k.a. chromacities)
 264  */
 265 typedef enum video_color_primaries_t
 266 {
 267     COLOR_PRIMARIES_UNDEF,
 268     COLOR_PRIMARIES_BT601_525,
 269     COLOR_PRIMARIES_BT601_625,
 270     COLOR_PRIMARIES_BT709,
 271     COLOR_PRIMARIES_BT2020,
 272     COLOR_PRIMARIES_DCI_P3,
 273     COLOR_PRIMARIES_FCC1953,
 274 #define COLOR_PRIMARIES_SRGB            COLOR_PRIMARIES_BT709
 275 #define COLOR_PRIMARIES_SMTPE_170       COLOR_PRIMARIES_BT601_525
 276 #define COLOR_PRIMARIES_SMTPE_240       COLOR_PRIMARIES_BT601_525 /* Only differs from 1e10-4 in white Y */
 277 #define COLOR_PRIMARIES_SMTPE_RP145     COLOR_PRIMARIES_BT601_525
 278 #define COLOR_PRIMARIES_EBU_3213        COLOR_PRIMARIES_BT601_625
 279 #define COLOR_PRIMARIES_BT470_BG        COLOR_PRIMARIES_BT601_625
 280 #define COLOR_PRIMARIES_BT470_M         COLOR_PRIMARIES_FCC1953
 281 #define COLOR_PRIMARIES_MAX             COLOR_PRIMARIES_FCC1953
 282 } video_color_primaries_t;
 283
 284 /**
 285  * Video transfer functions
 286  */
 287 typedef enum video_transfer_func_t
 288 {
 289     TRANSFER_FUNC_UNDEF,
 290     TRANSFER_FUNC_LINEAR,
 291     TRANSFER_FUNC_SRGB /*< Gamma 2.2 */,
 292     TRANSFER_FUNC_BT470_BG,
 293     TRANSFER_FUNC_BT470_M,
 294     TRANSFER_FUNC_BT709,
 295     TRANSFER_FUNC_SMPTE_ST2084,
 296     TRANSFER_FUNC_SMPTE_240,
 297     TRANSFER_FUNC_HLG,
 298 #define TRANSFER_FUNC_BT2020            TRANSFER_FUNC_BT709
 299 #define TRANSFER_FUNC_SMPTE_170         TRANSFER_FUNC_BT709
 300 #define TRANSFER_FUNC_SMPTE_274         TRANSFER_FUNC_BT709
 301 #define TRANSFER_FUNC_SMPTE_293         TRANSFER_FUNC_BT709
 302 #define TRANSFER_FUNC_SMPTE_296         TRANSFER_FUNC_BT709
 303 #define TRANSFER_FUNC_ARIB_B67          TRANSFER_FUNC_HLG
 304 #define TRANSFER_FUNC_MAX               TRANSFER_FUNC_HLG
 305 } video_transfer_func_t;
 306
 307 /**
 308  * Video color space (i.e. YCbCr matrices)
 309  */
 310 typedef enum video_color_space_t
 311 {
 312     COLOR_SPACE_UNDEF,
 313     COLOR_SPACE_BT601,
 314     COLOR_SPACE_BT709,
 315     COLOR_SPACE_BT2020,
 316 #define COLOR_SPACE_SRGB      COLOR_SPACE_BT709
 317 #define COLOR_SPACE_SMPTE_170 COLOR_SPACE_BT601
 318 #define COLOR_SPACE_SMPTE_240 COLOR_SPACE_SMPTE_170
 319 #define COLOR_SPACE_MAX       COLOR_SPACE_BT2020
 320 } video_color_space_t;
 321
 322 /**
 323  * Video chroma location
 324  */
 325 typedef enum video_chroma_location_t
 326 {
 327     CHROMA_LOCATION_UNDEF,
 328     CHROMA_LOCATION_LEFT,   /*< Most common in MPEG-2 Video, H.264/265 */
 329     CHROMA_LOCATION_CENTER, /*< Most common in MPEG-1 Video, JPEG */
 330     CHROMA_LOCATION_TOP_LEFT,
 331     CHROMA_LOCATION_TOP_CENTER,
 332     CHROMA_LOCATION_BOTTOM_LEFT,
 333     CHROMA_LOCATION_BOTTOM_CENTER,
 334 #define CHROMA_LOCATION_MAX CHROMA_LOCATION_BOTTOM_CENTER
 335 } video_chroma_location_t;
 336
 337 typedef enum video_color_range_t
 338 {
 339     COLOR_RANGE_UNDEF,
 340     COLOR_RANGE_FULL,
 341     COLOR_RANGE_LIMITED,
 342 #define COLOR_RANGE_STUDIO COLOR_RANGE_LIMITED
 343 #define COLOR_RANGE_MAX    COLOR_RANGE_LIMITED
 344 } video_color_range_t;
 345
 346 /**
 347  * video format description
 348  */
 349 struct video_format_t
 350 {
 351     vlc_fourcc_t i_chroma;                               /**< picture chroma */
 352
 353     unsigned int i_width;                                 /**< picture width */
 354     unsigned int i_height;                               /**< picture height */
 355     unsigned int i_x_offset;               /**< start offset of visible area */
 356     unsigned int i_y_offset;               /**< start offset of visible area */
 357     unsigned int i_visible_width;                 /**< width of visible area */
 358     unsigned int i_visible_height;               /**< height of visible area */
 359
 360     unsigned int i_bits_per_pixel;             /**< number of bits per pixel */
 361
 362     unsigned int i_sar_num;                   /**< sample/pixel aspect ratio */
 363     unsigned int i_sar_den;
 364
 365     unsigned int i_frame_rate;                     /**< frame rate numerator */
 366     unsigned int i_frame_rate_base;              /**< frame rate denominator */
 367
 368     uint32_t i_rmask, i_gmask, i_bmask;      /**< color masks for RGB chroma */
 369     video_palette_t *p_palette;              /**< video palette from demuxer */
 370     video_orientation_t orientation;                /**< picture orientation */
 371     video_color_primaries_t primaries;                  /**< color primaries */
 372     video_transfer_func_t transfer;                   /**< transfer function */
 373     video_color_space_t space;                        /**< YCbCr color space */
 374     video_color_range_t color_range;            /**< 0-255 instead of 16-235 */
 375     video_chroma_location_t chroma_location;      /**< YCbCr chroma location */
 376
 377     video_multiview_mode_t multiview_mode;        /** Multiview mode, 2D, 3D */
 378     bool b_multiview_right_eye_first;   /** Multiview left or right eye first*/
 379     bool b_multiview_left_eye;
 380
 381     video_projection_mode_t projection_mode;            /**< projection mode */
 382     vlc_viewpoint_t pose;
 383     struct {
 384         /* similar to SMPTE ST 2086 mastering display color volume */
 385         uint16_t primaries[3*2]; /* G,B,R / x,y */
 386         uint16_t white_point[2]; /* x,y */
 387         uint32_t max_luminance;
 388         uint32_t min_luminance;
 389     } mastering;
 390     struct {
 391         /* similar to CTA-861.3 content light level */
 392         uint16_t MaxCLL;  /* max content light level */
 393         uint16_t MaxFALL; /* max frame average light level */
 394     } lighting;
 395     uint32_t i_cubemap_padding; /**< padding in pixels of the cube map faces */
 396 };
 397
 398 /**
 399  * Initialize a video_format_t structure with chroma 'i_chroma'
 400  * \param p_src pointer to video_format_t structure
 401  * \param i_chroma chroma value to use
 402  */
 403 static inline void video_format_Init( video_format_t *p_src, vlc_fourcc_t i_chroma )
 404 {
 405     memset( p_src, 0, sizeof( video_format_t ) );
 406     p_src->i_chroma = i_chroma;
 407     vlc_viewpoint_init( &p_src->pose );
 408 }
 409
 410 /**
 411  * Copy video_format_t including the palette
 412  * \param p_dst video_format_t to copy to
 413  * \param p_src video_format_t to copy from
 414  */
 415 static inline int video_format_Copy( video_format_t *p_dst, const video_format_t *p_src )
 416 {
 417     memcpy( p_dst, p_src, sizeof( *p_dst ) );
 418     if( p_src->p_palette )
 419     {
 420         p_dst->p_palette = (video_palette_t *) malloc( sizeof( video_palette_t ) );
 421         if( !p_dst->p_palette )
 422             return VLC_ENOMEM;
 423         memcpy( p_dst->p_palette, p_src->p_palette, sizeof( *p_dst->p_palette ) );
 424     }
 425     return VLC_SUCCESS;
 426 }
 427
 428 static inline void video_format_AdjustColorSpace( video_format_t *p_fmt )
 429 {
 430     if ( p_fmt->primaries == COLOR_PRIMARIES_UNDEF )
 431     {
 432         if ( p_fmt->i_visible_height > 576 ) // HD
 433             p_fmt->primaries = COLOR_PRIMARIES_BT709;
 434         else if ( p_fmt->i_visible_height > 525 ) // PAL
 435             p_fmt->primaries = COLOR_PRIMARIES_BT601_625;
 436         else
 437             p_fmt->primaries = COLOR_PRIMARIES_BT601_525;
 438     }
 439
 440     if ( p_fmt->transfer == TRANSFER_FUNC_UNDEF )
 441     {
 442         if ( p_fmt->i_visible_height > 576 ) // HD
 443             p_fmt->transfer = TRANSFER_FUNC_BT709;
 444         else
 445             p_fmt->transfer = TRANSFER_FUNC_SRGB;
 446     }
 447
 448     if ( p_fmt->space == COLOR_SPACE_UNDEF )
 449     {
 450         if ( p_fmt->i_visible_height > 576 ) // HD
 451             p_fmt->space = COLOR_SPACE_BT709;
 452         else
 453             p_fmt->space = COLOR_SPACE_BT601;
 454     }
 455
 456     if ( p_fmt->color_range == COLOR_RANGE_UNDEF )
 457     {
 458         if ( vlc_fourcc_IsYUV(p_fmt->i_chroma) )
 459             p_fmt->color_range = COLOR_RANGE_LIMITED;
 460         else
 461             p_fmt->color_range = COLOR_RANGE_FULL;
 462     }
 463 }
 464
 465 /**
 466  * Cleanup and free palette of this video_format_t
 467  * \param p_src video_format_t structure to clean
 468  */
 469 static inline void video_format_Clean( video_format_t *p_src )
 470 {
 471     free( p_src->p_palette );
 472     memset( p_src, 0, sizeof( video_format_t ) );
 473 }
 474
 475 /**
 476  * It will fill up a video_format_t using the given arguments.
 477  * Note that the video_format_t must already be initialized.
 478  */
 479 VLC_API void video_format_Setup( video_format_t *, vlc_fourcc_t i_chroma,
 480     int i_width, int i_height, int i_visible_width, int i_visible_height,
 481     int i_sar_num, int i_sar_den );
 482
 483 /**
 484  * It will copy the crop properties from a video_format_t to another.
 485  */
 486 VLC_API void video_format_CopyCrop( video_format_t *, const video_format_t * );
 487
 488 /**
 489  * It will compute the crop/ar properties when scaling.
 490  */
 491 VLC_API void video_format_ScaleCropAr( video_format_t *, const video_format_t * );
 492
 493 /**
 494  * This function "normalizes" the formats orientation, by switching the a/r according to the orientation,
 495  * producing a format whose orientation is ORIENT_NORMAL. It makes a shallow copy (pallette is not alloc'ed).
 496  */
 497 VLC_API void video_format_ApplyRotation(video_format_t * /*restrict*/ out,
 498                                         const video_format_t *in);
 499
 500 /**
 501  * This function applies the transform operation to fmt.
 502  */
 503 VLC_API void video_format_TransformBy(video_format_t *fmt, video_transform_t transform);
 504
 505 /**
 506  * This function applies the transforms necessary to fmt so that the resulting fmt
 507  * has the dst_orientation.
 508  */
 509 VLC_API void video_format_TransformTo(video_format_t *fmt, video_orientation_t dst_orientation);
 510
 511 /**
 512  * Returns the operation required to transform src into dst.
 513  */
 514 VLC_API video_transform_t video_format_GetTransform(video_orientation_t src, video_orientation_t dst);
 515
 516 /**
 517  * This function will check if the first video format is similar
 518  * to the second one.
 519  */
 520 VLC_API bool video_format_IsSimilar( const video_format_t *, const video_format_t * );
 521
 522 /**
 523  * It prints details about the given video_format_t
 524  */
 525 VLC_API void video_format_Print( vlc_object_t *, const char *, const video_format_t * );
 526
 527
 528 static inline video_transform_t transform_Inverse( video_transform_t transform )
 529 {
 530     switch ( transform ) {
 531         case TRANSFORM_R90:
 532             return TRANSFORM_R270;
 533         case TRANSFORM_R270:
 534             return TRANSFORM_R90;
 535         default:
 536             return transform;
 537     }
 538 }
 539 /**
 540  * subtitles format description
 541  */
 542 struct subs_format_t
 543 {
 544     /* the character encoding of the text of the subtitle.
 545      * all gettext recognized shorts can be used */
 546     char *psz_encoding;
 547
 548
 549     int  i_x_origin; /**< x coordinate of the subtitle. 0 = left */
 550     int  i_y_origin; /**< y coordinate of the subtitle. 0 = top */
 551
 552     struct
 553     {
 554         /*  */
 555         uint32_t palette[16+1];
 556
 557         /* the width of the original movie the spu was extracted from */
 558         int i_original_frame_width;
 559         /* the height of the original movie the spu was extracted from */
 560         int i_original_frame_height;
 561     } spu;
 562
 563     struct
 564     {
 565         int i_id;
 566     } dvb;
 567     struct
 568     {
 569         int i_magazine;
 570         int i_page;
 571     } teletext;
 572     struct
 573     {
 574         uint8_t i_channel;
 575         /* Reorder depth of transport video, -1 for no reordering */
 576         int i_reorder_depth;
 577     } cc;
 578 };
 579
 580 #define SPU_PALETTE_DEFINED  0xbeefbeef
 581
 582 /**
 583  * ES language definition
 584  */
 585 typedef struct extra_languages_t
 586 {
 587         char *psz_language;
 588         char *psz_description;
 589 } extra_languages_t;
 590
 591 /** ES Categories */
 592 enum es_format_category_e
 593 {
 594     UNKNOWN_ES = 0x00,
 595     VIDEO_ES,
 596     AUDIO_ES,
 597     SPU_ES,
 598     DATA_ES,
 599 };
 600 #define ES_CATEGORY_COUNT (DATA_ES + 1)
 601
 602 /**
 603  * ES format definition
 604  */
 605 #define ES_PRIORITY_NOT_SELECTABLE  -2
 606 #define ES_PRIORITY_NOT_DEFAULTABLE -1
 607 #define ES_PRIORITY_SELECTABLE_MIN   0
 608 #define ES_PRIORITY_MIN ES_PRIORITY_NOT_SELECTABLE
 609 struct es_format_t
 610 {
 611     enum es_format_category_e i_cat;    /**< ES category */
 612     vlc_fourcc_t    i_codec;            /**< FOURCC value as used in vlc */
 613     vlc_fourcc_t    i_original_fourcc;  /**< original FOURCC from the container */
 614
 615     int             i_id;       /**< es identifier, where means
 616                                     -1: let the core mark the right id
 617                                     >=0: valid id */
 618     int             i_group;    /**< group identifier, where means:
 619                                     -1 : standalone
 620                                     >= 0 then a "group" (program) is created
 621                                         for each value */
 622     int             i_priority; /**< priority, where means:
 623                                     -2 : mean not selectable by the users
 624                                     -1 : mean not selected by default even
 625                                          when no other stream
 626                                     >=0: priority */
 627
 628     char            *psz_language;        /**< human-readable language name */
 629     char            *psz_description;     /**< human-readable description of language */
 630     unsigned        i_extra_languages;    /**< length in bytes of extra language data pointer */
 631     extra_languages_t *p_extra_languages; /**< extra language data needed by some decoders */
 632
 633     union {
 634         struct {
 635             audio_format_t  audio;    /**< description of audio format */
 636             audio_replay_gain_t audio_replay_gain; /*< audio replay gain information */
 637         };
 638         video_format_t video;     /**< description of video format */
 639         subs_format_t  subs;      /**< description of subtitle format */
 640     };
 641
 642     unsigned int   i_bitrate; /**< bitrate of this ES */
 643     int      i_profile;       /**< codec specific information (like real audio flavor, mpeg audio layer, h264 profile ...) */
 644     int      i_level;         /**< codec specific information: indicates maximum restrictions on the stream (resolution, bitrate, codec features ...) */
 645
 646     bool     b_packetized;  /**< whether the data is packetized (ie. not truncated) */
 647     int     i_extra;        /**< length in bytes of extra data pointer */
 648     void    *p_extra;       /**< extra data needed by some decoders or muxers */
 649
 650 };
 651
 652 /**
 653  * This function will fill all RGB shift from RGB masks.
 654  */
 655 VLC_API void video_format_FixRgb( video_format_t * );
 656
 657 /**
 658  * This function will initialize a es_format_t structure.
 659  */
 660 VLC_API void es_format_Init( es_format_t *, int i_cat, vlc_fourcc_t i_codec );
 661
 662 /**
 663  * This function will initialize a es_format_t structure from a video_format_t.
 664  */
 665 VLC_API void es_format_InitFromVideo( es_format_t *, const video_format_t * );
 666
 667 /**
 668  * This functions will copy a es_format_t.
 669  */
 670 VLC_API int es_format_Copy( es_format_t *p_dst, const es_format_t *p_src );
 671
 672 /**
 673  * This function will clean up a es_format_t and release all associated
 674  * resources.
 675  * You can call it multiple times on the same structure.
 676  */
 677 VLC_API void es_format_Clean( es_format_t *fmt );
 678
 679 /**
 680  * This function will check if the first ES format is similar
 681  * to the second one.
 682  *
 683  * All descriptive fields are ignored.
 684  */
 685 VLC_API bool es_format_IsSimilar( const es_format_t *, const es_format_t * );
 686
 687 /**
 688  * Changes ES format to another category
 689  * Format must have been properly initialized
 690  */
 691 static inline void es_format_Change( es_format_t *fmt, int i_cat, vlc_fourcc_t i_codec )
 692 {
 693     es_format_Clean( fmt );
 694     es_format_Init( fmt, i_cat, i_codec );
 695 }
 696
 697 /**
 698  * Increase the ES track id reference count.
 699  *
 700  * Any held ES tracks must be released with vlc_es_id_Release().
 701  *
 702  * @param id pointer to the ES id
 703  * @return the same ES pointer, for convenience
 704  */
 705 VLC_API vlc_es_id_t *
 706 vlc_es_id_Hold(vlc_es_id_t *es);
 707
 708 /**
 709  * Decrease the ES track id reference count.
 710  *
 711  * @param id pointer to the ES track id
 712  */
 713 VLC_API void
 714 vlc_es_id_Release(vlc_es_id_t *id);
 715
 716 /**
 717  * Get the ES track input id
 718  *
 719  * @param id pointer to the ES track id
 720  * @return the ES track input id (always valid)
 721  */
 722 VLC_API int
 723 vlc_es_id_GetInputId(vlc_es_id_t *id);
 724
 725 /**
 726  * Get the ES category
 727  *
 728  * @param id pointer to the ES track id
 729  * @return the es track category (always valid)
 730  */
 731 VLC_API enum es_format_category_e
 732 vlc_es_id_GetCat(vlc_es_id_t *id);
 733
 734 #endif