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) ((0x57642310U >> (4 * ((exif) - 1))) & 7)
 170 /** Convert enum video_orientation_t to EXIF */
 171 #define ORIENT_TO_EXIF(orient) ((0x76853421U >> (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 typedef enum video_multiview_mode_t
 196 {
 197     /* No stereoscopy: 2D picture. */
 198     MULTIVIEW_2D = 0,
 199
 200     /* Side-by-side with left eye first. */
 201     MULTIVIEW_STEREO_SBS,
 202
 203     /* Top-bottom with left eye first. */
 204     MULTIVIEW_STEREO_TB,
 205
 206     /* Row sequential with left eye first. */
 207     MULTIVIEW_STEREO_ROW,
 208
 209     /* Column sequential with left eye first. */
 210     MULTIVIEW_STEREO_COL,
 211
 212     /* Frame sequential with left eye first. */
 213     MULTIVIEW_STEREO_FRAME,
 214
 215     /* Checkerboard pattern with left eye first. */
 216     MULTIVIEW_STEREO_CHECKERBOARD,
 217 } video_multiview_mode_t;
 218
 219 /**
 220  * Video projection mode.
 221  */
 222 typedef enum video_projection_mode_t
 223 {
 224     PROJECTION_MODE_RECTANGULAR = 0,
 225     PROJECTION_MODE_EQUIRECTANGULAR,
 226
 227     PROJECTION_MODE_CUBEMAP_LAYOUT_STANDARD = 0x100,
 228 } video_projection_mode_t;
 229
 230 /**
 231  * Video color primaries (a.k.a. chromacities)
 232  */
 233 typedef enum video_color_primaries_t
 234 {
 235     COLOR_PRIMARIES_UNDEF,
 236     COLOR_PRIMARIES_BT601_525,
 237     COLOR_PRIMARIES_BT601_625,
 238     COLOR_PRIMARIES_BT709,
 239     COLOR_PRIMARIES_BT2020,
 240     COLOR_PRIMARIES_DCI_P3,
 241     COLOR_PRIMARIES_FCC1953,
 242 #define COLOR_PRIMARIES_SRGB            COLOR_PRIMARIES_BT709
 243 #define COLOR_PRIMARIES_SMTPE_170       COLOR_PRIMARIES_BT601_525
 244 #define COLOR_PRIMARIES_SMTPE_240       COLOR_PRIMARIES_BT601_525 /* Only differs from 1e10-4 in white Y */
 245 #define COLOR_PRIMARIES_SMTPE_RP145     COLOR_PRIMARIES_BT601_525
 246 #define COLOR_PRIMARIES_EBU_3213        COLOR_PRIMARIES_BT601_625
 247 #define COLOR_PRIMARIES_BT470_BG        COLOR_PRIMARIES_BT601_625
 248 #define COLOR_PRIMARIES_BT470_M         COLOR_PRIMARIES_FCC1953
 249 } video_color_primaries_t;
 250
 251 /**
 252  * Video transfer functions
 253  */
 254 typedef enum video_transfer_func_t
 255 {
 256     TRANSFER_FUNC_UNDEF,
 257     TRANSFER_FUNC_LINEAR,
 258     TRANSFER_FUNC_SRGB /*< Gamma 2.2 */,
 259     TRANSFER_FUNC_BT470_BG,
 260     TRANSFER_FUNC_BT470_M,
 261     TRANSFER_FUNC_BT709,
 262     TRANSFER_FUNC_SMPTE_ST2084,
 263     TRANSFER_FUNC_SMPTE_240,
 264     TRANSFER_FUNC_HLG,
 265 #define TRANSFER_FUNC_BT2020            TRANSFER_FUNC_BT709
 266 #define TRANSFER_FUNC_SMPTE_170         TRANSFER_FUNC_BT709
 267 #define TRANSFER_FUNC_SMPTE_274         TRANSFER_FUNC_BT709
 268 #define TRANSFER_FUNC_SMPTE_293         TRANSFER_FUNC_BT709
 269 #define TRANSFER_FUNC_SMPTE_296         TRANSFER_FUNC_BT709
 270 #define TRANSFER_FUNC_ARIB_B67          TRANSFER_FUNC_HLG
 271 } video_transfer_func_t;
 272
 273 /**
 274  * Video color space (i.e. YCbCr matrices)
 275  */
 276 typedef enum video_color_space_t
 277 {
 278     COLOR_SPACE_UNDEF,
 279     COLOR_SPACE_BT601,
 280     COLOR_SPACE_BT709,
 281     COLOR_SPACE_BT2020,
 282 #define COLOR_SPACE_SRGB      COLOR_SPACE_BT709
 283 #define COLOR_SPACE_SMPTE_170 COLOR_SPACE_BT601
 284 #define COLOR_SPACE_SMPTE_240 COLOR_SPACE_SMPTE_170
 285 } video_color_space_t;
 286
 287 /**
 288  * Video chroma location
 289  */
 290 typedef enum video_chroma_location_t
 291 {
 292     CHROMA_LOCATION_UNDEF,
 293     CHROMA_LOCATION_LEFT,   /*< Most common in MPEG-2 Video, H.264/265 */
 294     CHROMA_LOCATION_CENTER, /*< Most common in MPEG-1 Video, JPEG */
 295     CHROMA_LOCATION_TOP_LEFT,
 296     CHROMA_LOCATION_TOP_CENTER,
 297     CHROMA_LOCATION_BOTTOM_LEFT,
 298     CHROMA_LOCATION_BOTTOM_CENTER,
 299 } video_chroma_location_t;
 300
 301 #define FIELD_OF_VIEW_DEGREES_DEFAULT  80.f
 302 #define FIELD_OF_VIEW_DEGREES_MAX 150.f
 303 #define FIELD_OF_VIEW_DEGREES_MIN 20.f
 304
 305 /**
 306  * video format description
 307  */
 308 struct video_format_t
 309 {
 310     vlc_fourcc_t i_chroma;                               /**< picture chroma */
 311
 312     unsigned int i_width;                                 /**< picture width */
 313     unsigned int i_height;                               /**< picture height */
 314     unsigned int i_x_offset;               /**< start offset of visible area */
 315     unsigned int i_y_offset;               /**< start offset of visible area */
 316     unsigned int i_visible_width;                 /**< width of visible area */
 317     unsigned int i_visible_height;               /**< height of visible area */
 318
 319     unsigned int i_bits_per_pixel;             /**< number of bits per pixel */
 320
 321     unsigned int i_sar_num;                   /**< sample/pixel aspect ratio */
 322     unsigned int i_sar_den;
 323
 324     unsigned int i_frame_rate;                     /**< frame rate numerator */
 325     unsigned int i_frame_rate_base;              /**< frame rate denominator */
 326
 327     uint32_t i_rmask, i_gmask, i_bmask;      /**< color masks for RGB chroma */
 328     int i_rrshift, i_lrshift;
 329     int i_rgshift, i_lgshift;
 330     int i_rbshift, i_lbshift;
 331     video_palette_t *p_palette;              /**< video palette from demuxer */
 332     video_orientation_t orientation;                /**< picture orientation */
 333     video_color_primaries_t primaries;                  /**< color primaries */
 334     video_transfer_func_t transfer;                   /**< transfer function */
 335     video_color_space_t space;                        /**< YCbCr color space */
 336     bool b_color_range_full;                    /**< 0-255 instead of 16-235 */
 337     video_chroma_location_t chroma_location;      /**< YCbCr chroma location */
 338
 339     video_multiview_mode_t multiview_mode;        /** Multiview mode, 2D, 3D */
 340
 341     video_projection_mode_t projection_mode;            /**< projection mode */
 342     struct {
 343         float f_yaw_degrees;       /**< view point yaw in degrees ]-180;180] */
 344         float f_pitch_degrees;     /**< view point pitch in degrees ]-90;90] */
 345         float f_roll_degrees;     /**< view point roll in degrees ]-180;180] */
 346         float f_fov_degrees;          /**< view point fov in degrees ]0;180[ */
 347     } pose;
 348     struct {
 349         /* similar to SMPTE ST 2086 mastering display color volume */
 350         uint16_t primaries[3*2]; /* G,B,R / x,y */
 351         uint16_t white_point[2]; /* x,y */
 352         uint32_t max_luminance;
 353         uint32_t min_luminance;
 354     } mastering;
 355     struct {
 356         /* similar to CTA-861.3 content light level */
 357         uint16_t MaxCLL;  /* max content light level */
 358         uint16_t MaxFALL; /* max frame average light level */
 359     } lighting;
 360     uint32_t i_cubemap_padding; /**< padding in pixels of the cube map faces */
 361 };
 362
 363 /**
 364  * Initialize a video_format_t structure with chroma 'i_chroma'
 365  * \param p_src pointer to video_format_t structure
 366  * \param i_chroma chroma value to use
 367  */
 368 static inline void video_format_Init( video_format_t *p_src, vlc_fourcc_t i_chroma )
 369 {
 370     memset( p_src, 0, sizeof( video_format_t ) );
 371     p_src->i_chroma = i_chroma;
 372     p_src->pose.f_fov_degrees = FIELD_OF_VIEW_DEGREES_DEFAULT;
 373 }
 374
 375 /**
 376  * Copy video_format_t including the palette
 377  * \param p_dst video_format_t to copy to
 378  * \param p_src video_format_t to copy from
 379  */
 380 static inline int video_format_Copy( video_format_t *p_dst, const video_format_t *p_src )
 381 {
 382     memcpy( p_dst, p_src, sizeof( *p_dst ) );
 383     if( p_src->p_palette )
 384     {
 385         p_dst->p_palette = (video_palette_t *) malloc( sizeof( video_palette_t ) );
 386         if( !p_dst->p_palette )
 387             return VLC_ENOMEM;
 388         memcpy( p_dst->p_palette, p_src->p_palette, sizeof( *p_dst->p_palette ) );
 389     }
 390     return VLC_SUCCESS;
 391 }
 392
 393 static inline void video_format_AdjustColorSpace( video_format_t *p_fmt )
 394 {
 395     if ( p_fmt->primaries == COLOR_PRIMARIES_UNDEF )
 396     {
 397         if ( p_fmt->i_visible_height > 576 ) // HD
 398             p_fmt->primaries = COLOR_PRIMARIES_BT709;
 399         else if ( p_fmt->i_visible_height > 525 ) // PAL
 400             p_fmt->primaries = COLOR_PRIMARIES_BT601_625;
 401         else
 402             p_fmt->primaries = COLOR_PRIMARIES_BT601_525;
 403     }
 404
 405     if ( p_fmt->transfer == TRANSFER_FUNC_UNDEF )
 406     {
 407         if ( p_fmt->i_visible_height > 576 ) // HD
 408             p_fmt->transfer = TRANSFER_FUNC_BT709;
 409         else
 410             p_fmt->transfer = TRANSFER_FUNC_SRGB;
 411     }
 412
 413     if ( p_fmt->space == COLOR_SPACE_UNDEF )
 414     {
 415         if ( p_fmt->i_visible_height > 576 ) // HD
 416             p_fmt->space = COLOR_SPACE_BT709;
 417         else
 418             p_fmt->space = COLOR_SPACE_BT601;
 419     }
 420 }
 421
 422 /**
 423  * Cleanup and free palette of this video_format_t
 424  * \param p_src video_format_t structure to clean
 425  */
 426 static inline void video_format_Clean( video_format_t *p_src )
 427 {
 428     free( p_src->p_palette );
 429     memset( p_src, 0, sizeof( video_format_t ) );
 430 }
 431
 432 /**
 433  * It will fill up a video_format_t using the given arguments.
 434  * Note that the video_format_t must already be initialized.
 435  */
 436 VLC_API void video_format_Setup( video_format_t *, vlc_fourcc_t i_chroma,
 437     int i_width, int i_height, int i_visible_width, int i_visible_height,
 438     int i_sar_num, int i_sar_den );
 439
 440 /**
 441  * It will copy the crop properties from a video_format_t to another.
 442  */
 443 VLC_API void video_format_CopyCrop( video_format_t *, const video_format_t * );
 444
 445 /**
 446  * It will compute the crop/ar properties when scaling.
 447  */
 448 VLC_API void video_format_ScaleCropAr( video_format_t *, const video_format_t * );
 449
 450 /**
 451  * This function "normalizes" the formats orientation, by switching the a/r according to the orientation,
 452  * producing a format whose orientation is ORIENT_NORMAL. It makes a shallow copy (pallette is not alloc'ed).
 453  */
 454 VLC_API void video_format_ApplyRotation(video_format_t * /*restrict*/ out,
 455                                         const video_format_t *in);
 456
 457 /**
 458  * This function applies the transform operation to fmt.
 459  */
 460 VLC_API void video_format_TransformBy(video_format_t *fmt, video_transform_t transform);
 461
 462 /**
 463  * This function applies the transforms necessary to fmt so that the resulting fmt
 464  * has the dst_orientation.
 465  */
 466 VLC_API void video_format_TransformTo(video_format_t *fmt, video_orientation_t dst_orientation);
 467
 468 /**
 469  * Returns the operation required to transform src into dst.
 470  */
 471 VLC_API video_transform_t video_format_GetTransform(video_orientation_t src, video_orientation_t dst);
 472
 473 /**
 474  * This function will check if the first video format is similar
 475  * to the second one.
 476  */
 477 VLC_API bool video_format_IsSimilar( const video_format_t *, const video_format_t * );
 478
 479 /**
 480  * It prints details about the given video_format_t
 481  */
 482 VLC_API void video_format_Print( vlc_object_t *, const char *, const video_format_t * );
 483
 484
 485 static inline video_transform_t transform_Inverse( video_transform_t transform )
 486 {
 487     switch ( transform ) {
 488         case TRANSFORM_R90:
 489             return TRANSFORM_R270;
 490         case TRANSFORM_R270:
 491             return TRANSFORM_R90;
 492         default:
 493             return transform;
 494     }
 495 }
 496 /**
 497  * subtitles format description
 498  */
 499 struct subs_format_t
 500 {
 501     /* the character encoding of the text of the subtitle.
 502      * all gettext recognized shorts can be used */
 503     char *psz_encoding;
 504
 505
 506     int  i_x_origin; /**< x coordinate of the subtitle. 0 = left */
 507     int  i_y_origin; /**< y coordinate of the subtitle. 0 = top */
 508
 509     struct
 510     {
 511         /*  */
 512         uint32_t palette[16+1];
 513
 514         /* the width of the original movie the spu was extracted from */
 515         int i_original_frame_width;
 516         /* the height of the original movie the spu was extracted from */
 517         int i_original_frame_height;
 518     } spu;
 519
 520     struct
 521     {
 522         int i_id;
 523     } dvb;
 524     struct
 525     {
 526         int i_magazine;
 527         int i_page;
 528     } teletext;
 529     struct
 530     {
 531         uint8_t i_reorder_depth; /* Reorder depth or transport video */
 532     } cc;
 533
 534     text_style_t *p_style; /* Default styles to use */
 535 };
 536
 537 /**
 538  * ES language definition
 539  */
 540 typedef struct extra_languages_t
 541 {
 542         char *psz_language;
 543         char *psz_description;
 544 } extra_languages_t;
 545
 546 /**
 547  * ES format definition
 548  */
 549 #define ES_PRIORITY_NOT_SELECTABLE  -2
 550 #define ES_PRIORITY_NOT_DEFAULTABLE -1
 551 #define ES_PRIORITY_SELECTABLE_MIN   0
 552 #define ES_PRIORITY_MIN ES_PRIORITY_NOT_SELECTABLE
 553 struct es_format_t
 554 {
 555     int             i_cat;              /**< ES category @see es_format_category_e */
 556     vlc_fourcc_t    i_codec;            /**< FOURCC value as used in vlc */
 557     vlc_fourcc_t    i_original_fourcc;  /**< original FOURCC from the container */
 558
 559     int             i_id;       /**< es identifier, where means
 560                                     -1: let the core mark the right id
 561                                     >=0: valid id */
 562     int             i_group;    /**< group identifier, where means:
 563                                     -1 : standalone
 564                                     >= 0 then a "group" (program) is created
 565                                         for each value */
 566     int             i_priority; /**< priority, where means:
 567                                     -2 : mean not selectable by the users
 568                                     -1 : mean not selected by default even
 569                                          when no other stream
 570                                     >=0: priority */
 571
 572     char            *psz_language;        /**< human-readable language name */
 573     char            *psz_description;     /**< human-readable description of language */
 574     unsigned        i_extra_languages;    /**< length in bytes of extra language data pointer */
 575     extra_languages_t *p_extra_languages; /**< extra language data needed by some decoders */
 576
 577     union {
 578         struct {
 579             audio_format_t  audio;    /**< description of audio format */
 580             audio_replay_gain_t audio_replay_gain; /*< audio replay gain information */
 581         };
 582         video_format_t video;     /**< description of video format */
 583         subs_format_t  subs;      /**< description of subtitle format */
 584     };
 585
 586     unsigned int   i_bitrate; /**< bitrate of this ES */
 587     int      i_profile;       /**< codec specific information (like real audio flavor, mpeg audio layer, h264 profile ...) */
 588     int      i_level;         /**< codec specific information: indicates maximum restrictions on the stream (resolution, bitrate, codec features ...) */
 589
 590     bool     b_packetized;  /**< whether the data is packetized (ie. not truncated) */
 591     int     i_extra;        /**< length in bytes of extra data pointer */
 592     void    *p_extra;       /**< extra data needed by some decoders or muxers */
 593
 594 };
 595
 596 /** ES Categories */
 597 enum es_format_category_e
 598 {
 599     UNKNOWN_ES = 0x00,
 600     VIDEO_ES,
 601     AUDIO_ES,
 602     SPU_ES,
 603     NAV_ES,
 604 };
 605 #define ES_CATEGORY_COUNT (NAV_ES + 1)
 606
 607 /**
 608  * This function will fill all RGB shift from RGB masks.
 609  */
 610 VLC_API void video_format_FixRgb( video_format_t * );
 611
 612 /**
 613  * This function will initialize a es_format_t structure.
 614  */
 615 VLC_API void es_format_Init( es_format_t *, int i_cat, vlc_fourcc_t i_codec );
 616
 617 /**
 618  * This function will initialize a es_format_t structure from a video_format_t.
 619  */
 620 VLC_API void es_format_InitFromVideo( es_format_t *, const video_format_t * );
 621
 622 /**
 623  * This functions will copy a es_format_t.
 624  */
 625 VLC_API int es_format_Copy( es_format_t *p_dst, const es_format_t *p_src );
 626
 627 /**
 628  * This function will clean up a es_format_t and release all associated
 629  * resources.
 630  * You can call it multiple times on the same structure.
 631  */
 632 VLC_API void es_format_Clean( es_format_t *fmt );
 633
 634 /**
 635  * This function will check if the first ES format is similar
 636  * to the second one.
 637  *
 638  * All descriptive fields are ignored.
 639  */
 640 VLC_API bool es_format_IsSimilar( const es_format_t *, const es_format_t * );
 641
 642 #endif