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