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