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