git.sesse.net Git - vlc/blob - 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_fourcc.h>
  28 #include <vlc_text_style.h>
  29
  30 /**
  31  * \file
  32  * This file defines the elementary streams format types
  33  */
  34
  35 /**
  36  * video palette data
  37  * \see video_format_t
  38  * \see subs_format_t
  39  */
  40 #define VIDEO_PALETTE_COLORS_MAX 256
  41
  42 struct video_palette_t
  43 {
  44     int i_entries;      /**< to keep the compatibility with libavcodec's palette */
  45     uint8_t palette[VIDEO_PALETTE_COLORS_MAX][4];  /**< 4-byte RGBA/YUVA palette */
  46 };
  47
  48 /**
  49  * audio replay gain description
  50  */
  51 #define AUDIO_REPLAY_GAIN_MAX (2)
  52 #define AUDIO_REPLAY_GAIN_TRACK (0)
  53 #define AUDIO_REPLAY_GAIN_ALBUM (1)
  54 typedef struct
  55 {
  56     /* true if we have the peak value */
  57     bool pb_peak[AUDIO_REPLAY_GAIN_MAX];
  58     /* peak value where 1.0 means full sample value */
  59     float      pf_peak[AUDIO_REPLAY_GAIN_MAX];
  60
  61     /* true if we have the gain value */
  62     bool pb_gain[AUDIO_REPLAY_GAIN_MAX];
  63     /* gain value in dB */
  64     float      pf_gain[AUDIO_REPLAY_GAIN_MAX];
  65 } audio_replay_gain_t;
  66
  67 /**
  68  * audio format description
  69  */
  70 struct audio_format_t
  71 {
  72     vlc_fourcc_t i_format;                          /**< audio format fourcc */
  73     unsigned int i_rate;                              /**< audio sample-rate */
  74
  75     /* Describes the channels configuration of the samples (ie. number of
  76      * channels which are available in the buffer, and positions). */
  77     uint16_t     i_physical_channels;
  78
  79     /* Describes from which original channels, before downmixing, the
  80      * buffer is derived. */
  81     uint32_t     i_original_channels;
  82
  83     /* Optional - for A/52, SPDIF and DTS types : */
  84     /* Bytes used by one compressed frame, depends on bitrate. */
  85     unsigned int i_bytes_per_frame;
  86
  87     /* Number of sampleframes contained in one compressed frame. */
  88     unsigned int i_frame_length;
  89     /* Please note that it may be completely arbitrary - buffers are not
  90      * obliged to contain a integral number of so-called "frames". It's
  91      * just here for the division :
  92      * buffer_size = i_nb_samples * i_bytes_per_frame / i_frame_length
  93      */
  94
  95     /* FIXME ? (used by the codecs) */
  96     unsigned     i_bitspersample;
  97     unsigned     i_blockalign;
  98     uint8_t      i_channels; /* must be <=32 */
  99 };
 100
 101 /* Values available for audio channels */
 102 #define AOUT_CHAN_CENTER            0x1
 103 #define AOUT_CHAN_LEFT              0x2
 104 #define AOUT_CHAN_RIGHT             0x4
 105 #define AOUT_CHAN_REARCENTER        0x10
 106 #define AOUT_CHAN_REARLEFT          0x20
 107 #define AOUT_CHAN_REARRIGHT         0x40
 108 #define AOUT_CHAN_MIDDLELEFT        0x100
 109 #define AOUT_CHAN_MIDDLERIGHT       0x200
 110 #define AOUT_CHAN_LFE               0x1000
 111
 112 #define AOUT_CHANS_FRONT  (AOUT_CHAN_LEFT       | AOUT_CHAN_RIGHT)
 113 #define AOUT_CHANS_MIDDLE (AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT)
 114 #define AOUT_CHANS_REAR   (AOUT_CHAN_REARLEFT   | AOUT_CHAN_REARRIGHT)
 115 #define AOUT_CHANS_CENTER (AOUT_CHAN_CENTER     | AOUT_CHAN_REARCENTER)
 116
 117 #define AOUT_CHANS_STEREO AOUT_CHANS_2_0
 118 #define AOUT_CHANS_2_0    (AOUT_CHANS_FRONT)
 119 #define AOUT_CHANS_2_1    (AOUT_CHANS_FRONT | AOUT_CHAN_LFE)
 120 #define AOUT_CHANS_3_0    (AOUT_CHANS_FRONT | AOUT_CHAN_CENTER)
 121 #define AOUT_CHANS_3_1    (AOUT_CHANS_3_0   | AOUT_CHAN_LFE)
 122 #define AOUT_CHANS_4_0    (AOUT_CHANS_FRONT | AOUT_CHANS_REAR)
 123 #define AOUT_CHANS_4_1    (AOUT_CHANS_4_0   | AOUT_CHAN_LFE)
 124 #define AOUT_CHANS_5_0    (AOUT_CHANS_4_0   | AOUT_CHAN_CENTER)
 125 #define AOUT_CHANS_5_1    (AOUT_CHANS_5_0   | AOUT_CHAN_LFE)
 126 #define AOUT_CHANS_6_0    (AOUT_CHANS_4_0   | AOUT_CHANS_MIDDLE)
 127 #define AOUT_CHANS_7_0    (AOUT_CHANS_6_0   | AOUT_CHAN_CENTER)
 128 #define AOUT_CHANS_7_1    (AOUT_CHANS_5_1   | AOUT_CHANS_MIDDLE)
 129 #define AOUT_CHANS_8_1    (AOUT_CHANS_7_1   | AOUT_CHAN_REARCENTER)
 130
 131 #define AOUT_CHANS_4_0_MIDDLE (AOUT_CHANS_FRONT | AOUT_CHANS_MIDDLE)
 132 #define AOUT_CHANS_4_CENTER_REAR (AOUT_CHANS_FRONT | AOUT_CHANS_CENTER)
 133 #define AOUT_CHANS_5_0_MIDDLE (AOUT_CHANS_4_0_MIDDLE | AOUT_CHAN_CENTER)
 134 #define AOUT_CHANS_6_1_MIDDLE (AOUT_CHANS_5_0_MIDDLE | AOUT_CHAN_REARCENTER | AOUT_CHAN_LFE)
 135
 136 /* Values available for original channels only */
 137 #define AOUT_CHAN_DOLBYSTEREO       0x10000
 138 #define AOUT_CHAN_DUALMONO          0x20000
 139 #define AOUT_CHAN_REVERSESTEREO     0x40000
 140
 141 #define AOUT_CHAN_PHYSMASK          0xFFFF
 142 #define AOUT_CHAN_MAX               9
 143
 144 /**
 145  * Picture orientation.
 146  */
 147 typedef enum video_orientation_t
 148 {
 149     ORIENT_TOP_LEFT = 0, /**< Top line represents top, left column left. */
 150     ORIENT_TOP_RIGHT, /**< Flipped horizontally */
 151     ORIENT_BOTTOM_LEFT, /**< Flipped vertically */
 152     ORIENT_BOTTOM_RIGHT, /**< Rotated 180 degrees */
 153     ORIENT_LEFT_TOP, /**< Transposed */
 154     ORIENT_LEFT_BOTTOM, /**< Rotated 90 degrees clockwise */
 155     ORIENT_RIGHT_TOP, /**< Rotated 90 degrees anti-clockwise */
 156     ORIENT_RIGHT_BOTTOM, /**< Anti-transposed */
 157
 158     ORIENT_NORMAL      = ORIENT_TOP_LEFT,
 159     ORIENT_TRANSPOSED  = ORIENT_LEFT_TOP,
 160     ORIENT_ANTI_TRANSPOSED = ORIENT_RIGHT_BOTTOM,
 161     ORIENT_HFLIPPED    = ORIENT_TOP_RIGHT,
 162     ORIENT_VFLIPPED    = ORIENT_BOTTOM_LEFT,
 163     ORIENT_ROTATED_180 = ORIENT_BOTTOM_RIGHT,
 164     ORIENT_ROTATED_270 = ORIENT_LEFT_BOTTOM,
 165     ORIENT_ROTATED_90  = ORIENT_RIGHT_TOP,
 166 } video_orientation_t;
 167 /** Convert EXIF orientation to enum video_orientation_t */
 168 #define ORIENT_FROM_EXIF(exif) ((0x01324675U >> (4 * ((exif) - 1))) & 7)
 169 /** Convert enum video_orientation_t to EXIF */
 170 #define ORIENT_TO_EXIF(orient) ((0x12435867U >> (4 * (orient))) & 15)
 171 /** If the orientation is natural or mirrored */
 172 #define ORIENT_IS_MIRROR(orient) parity(orient)
 173 /** If the orientation swaps dimensions */
 174 #define ORIENT_IS_SWAP(orient) (((orient) & 4) != 0)
 175 /** Applies horizontal flip to an orientation */
 176 #define ORIENT_HFLIP(orient) ((orient) ^ 1)
 177 /** Applies vertical flip to an orientation */
 178 #define ORIENT_VFLIP(orient) ((orient) ^ 2)
 179 /** Applies horizontal flip to an orientation */
 180 #define ORIENT_ROTATE_180(orient) ((orient) ^ 3)
 181
 182 typedef enum video_transform_t
 183 {
 184     TRANSFORM_IDENTITY       = ORIENT_NORMAL,
 185     TRANSFORM_HFLIP          = ORIENT_HFLIPPED,
 186     TRANSFORM_VFLIP          = ORIENT_VFLIPPED,
 187     TRANSFORM_R180           = ORIENT_ROTATED_180,
 188     TRANSFORM_R270           = ORIENT_ROTATED_270,
 189     TRANSFORM_R90            = ORIENT_ROTATED_90,
 190     TRANSFORM_TRANSPOSE      = ORIENT_TRANSPOSED,
 191     TRANSFORM_ANTI_TRANSPOSE = ORIENT_ANTI_TRANSPOSED
 192 } video_transform_t;
 193
 194 /**
 195  * video format description
 196  */
 197 struct video_format_t
 198 {
 199     vlc_fourcc_t i_chroma;                               /**< picture chroma */
 200
 201     unsigned int i_width;                                 /**< picture width */
 202     unsigned int i_height;                               /**< picture height */
 203     unsigned int i_x_offset;               /**< start offset of visible area */
 204     unsigned int i_y_offset;               /**< start offset of visible area */
 205     unsigned int i_visible_width;                 /**< width of visible area */
 206     unsigned int i_visible_height;               /**< height of visible area */
 207
 208     unsigned int i_bits_per_pixel;             /**< number of bits per pixel */
 209
 210     unsigned int i_sar_num;                   /**< sample/pixel aspect ratio */
 211     unsigned int i_sar_den;
 212
 213     unsigned int i_frame_rate;                     /**< frame rate numerator */
 214     unsigned int i_frame_rate_base;              /**< frame rate denominator */
 215
 216     uint32_t i_rmask, i_gmask, i_bmask;      /**< color masks for RGB chroma */
 217     int i_rrshift, i_lrshift;
 218     int i_rgshift, i_lgshift;
 219     int i_rbshift, i_lbshift;
 220     video_palette_t *p_palette;              /**< video palette from demuxer */
 221     video_orientation_t orientation;                /**< picture orientation */
 222 };
 223
 224 /**
 225  * Initialize a video_format_t structure with chroma 'i_chroma'
 226  * \param p_src pointer to video_format_t structure
 227  * \param i_chroma chroma value to use
 228  */
 229 static inline void video_format_Init( video_format_t *p_src, vlc_fourcc_t i_chroma )
 230 {
 231     memset( p_src, 0, sizeof( video_format_t ) );
 232     p_src->i_chroma = i_chroma;
 233     p_src->i_sar_num = p_src->i_sar_den = 1;
 234     p_src->p_palette = NULL;
 235 }
 236
 237 /**
 238  * Copy video_format_t including the palette
 239  * \param p_dst video_format_t to copy to
 240  * \param p_src video_format_t to copy from
 241  */
 242 static inline int video_format_Copy( video_format_t *p_dst, const video_format_t *p_src )
 243 {
 244     memcpy( p_dst, p_src, sizeof( *p_dst ) );
 245     if( p_src->p_palette )
 246     {
 247         p_dst->p_palette = (video_palette_t *) malloc( sizeof( video_palette_t ) );
 248         if( !p_dst->p_palette )
 249             return VLC_ENOMEM;
 250         memcpy( p_dst->p_palette, p_src->p_palette, sizeof( *p_dst->p_palette ) );
 251     }
 252     return VLC_SUCCESS;
 253 }
 254
 255 /**
 256  * Cleanup and free palette of this video_format_t
 257  * \param p_src video_format_t structure to clean
 258  */
 259 static inline void video_format_Clean( video_format_t *p_src )
 260 {
 261     free( p_src->p_palette );
 262     memset( p_src, 0, sizeof( video_format_t ) );
 263     p_src->p_palette = NULL;
 264 }
 265
 266 /**
 267  * It will fill up a video_format_t using the given arguments.
 268  * Note that the video_format_t must already be initialized.
 269  */
 270 VLC_API void video_format_Setup( video_format_t *, vlc_fourcc_t i_chroma,
 271     int i_width, int i_height, int i_visible_width, int i_visible_height,
 272     int i_sar_num, int i_sar_den );
 273
 274 /**
 275  * It will copy the crop properties from a video_format_t to another.
 276  */
 277 VLC_API void video_format_CopyCrop( video_format_t *, const video_format_t * );
 278
 279 /**
 280  * It will compute the crop/ar properties when scaling.
 281  */
 282 VLC_API void video_format_ScaleCropAr( video_format_t *, const video_format_t * );
 283
 284 /**
 285  * This function "normalizes" the formats orientation, by switching the a/r according to the orientation,
 286  * producing a format whose orientation is ORIENT_NORMAL. It makes a shallow copy (pallette is not alloc'ed).
 287  */
 288 VLC_API void video_format_ApplyRotation(video_format_t * /*restrict*/ out,
 289                                         const video_format_t *in);
 290
 291 /**
 292  * This function applies the transform operation to fmt.
 293  */
 294 VLC_API void video_format_TransformBy(video_format_t *fmt, video_transform_t transform);
 295
 296 /**
 297  * This function applies the transforms necessary to fmt so that the resulting fmt
 298  * has the dst_orientation.
 299  */
 300 VLC_API void video_format_TransformTo(video_format_t *fmt, video_orientation_t dst_orientation);
 301
 302 /**
 303  * Returns the operation required to transform src into dst.
 304  */
 305 VLC_API video_transform_t video_format_GetTransform(video_orientation_t src, video_orientation_t dst);
 306
 307 /**
 308  * This function will check if the first video format is similar
 309  * to the second one.
 310  */
 311 VLC_API bool video_format_IsSimilar( const video_format_t *, const video_format_t * );
 312
 313 /**
 314  * It prints details about the given video_format_t
 315  */
 316 VLC_API void video_format_Print( vlc_object_t *, const char *, const video_format_t * );
 317
 318
 319 static inline video_transform_t transform_Inverse( video_transform_t transform )
 320 {
 321     switch ( transform ) {
 322         case TRANSFORM_R90:
 323             return TRANSFORM_R270;
 324         case TRANSFORM_R270:
 325             return TRANSFORM_R90;
 326         default:
 327             return transform;
 328     }
 329 }
 330 /**
 331  * subtitles format description
 332  */
 333 struct subs_format_t
 334 {
 335     /* the character encoding of the text of the subtitle.
 336      * all gettext recognized shorts can be used */
 337     char *psz_encoding;
 338
 339
 340     int  i_x_origin; /**< x coordinate of the subtitle. 0 = left */
 341     int  i_y_origin; /**< y coordinate of the subtitle. 0 = top */
 342
 343     struct
 344     {
 345         /*  */
 346         uint32_t palette[16+1];
 347
 348         /* the width of the original movie the spu was extracted from */
 349         int i_original_frame_width;
 350         /* the height of the original movie the spu was extracted from */
 351         int i_original_frame_height;
 352     } spu;
 353
 354     struct
 355     {
 356         int i_id;
 357     } dvb;
 358     struct
 359     {
 360         int i_magazine;
 361         int i_page;
 362     } teletext;
 363
 364     text_style_t *p_style; /* Default styles to use */
 365 };
 366
 367 /**
 368  * ES language definition
 369  */
 370 typedef struct extra_languages_t
 371 {
 372         char *psz_language;
 373         char *psz_description;
 374 } extra_languages_t;
 375
 376 /**
 377  * ES format definition
 378  */
 379 #define ES_PRIORITY_NOT_SELECTABLE  -2
 380 #define ES_PRIORITY_NOT_DEFAULTABLE -1
 381 #define ES_PRIORITY_SELECTABLE_MIN   0
 382 #define ES_PRIORITY_MIN ES_PRIORITY_NOT_SELECTABLE
 383 struct es_format_t
 384 {
 385     int             i_cat;              /**< ES category @see es_format_category_e */
 386     vlc_fourcc_t    i_codec;            /**< FOURCC value as used in vlc */
 387     vlc_fourcc_t    i_original_fourcc;  /**< original FOURCC from the container */
 388
 389     int             i_id;       /**< es identifier, where means
 390                                     -1: let the core mark the right id
 391                                     >=0: valid id */
 392     int             i_group;    /**< group identifier, where means:
 393                                     -1 : standalone
 394                                     >= 0 then a "group" (program) is created
 395                                         for each value */
 396     int             i_priority; /**< priority, where means:
 397                                     -2 : mean not selectable by the users
 398                                     -1 : mean not selected by default even
 399                                          when no other stream
 400                                     >=0: priority */
 401
 402     char            *psz_language;        /**< human readible language name */
 403     char            *psz_description;     /**< human readible description of language */
 404     unsigned        i_extra_languages;    /**< length in bytes of extra language data pointer */
 405     extra_languages_t *p_extra_languages; /**< extra language data needed by some decoders */
 406
 407     audio_format_t  audio;    /**< description of audio format */
 408     audio_replay_gain_t audio_replay_gain; /*< audio replay gain information */
 409     video_format_t video;     /**< description of video format */
 410     subs_format_t  subs;      /**< description of subtitle format */
 411
 412     unsigned int   i_bitrate; /**< bitrate of this ES */
 413     int      i_profile;       /**< codec specific information (like real audio flavor, mpeg audio layer, h264 profile ...) */
 414     int      i_level;         /**< codec specific information: indicates maximum restrictions on the stream (resolution, bitrate, codec features ...) */
 415
 416     bool     b_packetized;  /**< whether the data is packetized (ie. not truncated) */
 417     int     i_extra;        /**< length in bytes of extra data pointer */
 418     void    *p_extra;       /**< extra data needed by some decoders or muxers */
 419
 420 };
 421
 422 /** ES Categories */
 423 enum es_format_category_e
 424 {
 425     UNKNOWN_ES = 0x00,
 426     VIDEO_ES,
 427     AUDIO_ES,
 428     SPU_ES,
 429     NAV_ES,
 430 };
 431 #define ES_CATEGORY_COUNT (NAV_ES + 1)
 432
 433 /**
 434  * This function will fill all RGB shift from RGB masks.
 435  */
 436 VLC_API void video_format_FixRgb( video_format_t * );
 437
 438 /**
 439  * This function will initialize a es_format_t structure.
 440  */
 441 VLC_API void es_format_Init( es_format_t *, int i_cat, vlc_fourcc_t i_codec );
 442
 443 /**
 444  * This function will initialize a es_format_t structure from a video_format_t.
 445  */
 446 VLC_API void es_format_InitFromVideo( es_format_t *, const video_format_t * );
 447
 448 /**
 449  * This functions will copy a es_format_t.
 450  */
 451 VLC_API int es_format_Copy( es_format_t *p_dst, const es_format_t *p_src );
 452
 453 /**
 454  * This function will clean up a es_format_t and release all associated
 455  * resources.
 456  * You can call it multiple times on the same structure.
 457  */
 458 VLC_API void es_format_Clean( es_format_t *fmt );
 459
 460 /**
 461  * This function will check if the first ES format is similar
 462  * to the second one.
 463  *
 464  * All descriptive fields are ignored.
 465  */
 466 VLC_API bool es_format_IsSimilar( const es_format_t *, const es_format_t * );
 467
 468 #endif