include/vlc_es.h

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