include/vlc_es.h

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