vlc_es.h 22.2 KB
Newer Older
1
/*****************************************************************************
2
 * vlc_es.h: Elementary stream formats descriptions
3
 *****************************************************************************
4
 * Copyright (C) 1999-2012 VLC authors and VideoLAN
5
 * $Id$
6 7 8
 *
 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
9 10 11
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
12 13 14 15
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
16 17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
18
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
19 20 21
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 23
 *****************************************************************************/

24 25
#ifndef VLC_ES_H
#define VLC_ES_H 1
26

27
#include <vlc_common.h>
28
#include <vlc_fourcc.h>
29
#include <vlc_text_style.h>
30
#include <vlc_viewpoint.h>
31

32
/**
33 34
 * \file
 * This file defines the elementary streams format types
35
 */
36 37 38

/**
 * video palette data
39
 * \see video_format_t
40 41
 * \see subs_format_t
 */
42 43
#define VIDEO_PALETTE_COLORS_MAX 256

44
struct video_palette_t
45
{
46
    int i_entries;      /**< to keep the compatibility with libavcodec's palette */
47
    uint8_t palette[VIDEO_PALETTE_COLORS_MAX][4];  /**< 4-byte RGBA/YUVA palette */
48
};
49

50 51 52 53 54 55 56 57 58
/**
 * audio replay gain description
 */
#define AUDIO_REPLAY_GAIN_MAX (2)
#define AUDIO_REPLAY_GAIN_TRACK (0)
#define AUDIO_REPLAY_GAIN_ALBUM (1)
typedef struct
{
    /* true if we have the peak value */
59
    bool pb_peak[AUDIO_REPLAY_GAIN_MAX];
60 61 62 63
    /* peak value where 1.0 means full sample value */
    float      pf_peak[AUDIO_REPLAY_GAIN_MAX];

    /* true if we have the gain value */
64
    bool pb_gain[AUDIO_REPLAY_GAIN_MAX];
65 66 67 68
    /* gain value in dB */
    float      pf_gain[AUDIO_REPLAY_GAIN_MAX];
} audio_replay_gain_t;

69 70 71 72 73 74 75 76 77 78

/**
 * Audio channel type
 */
typedef enum audio_channel_type_t
{
    AUDIO_CHANNEL_TYPE_BITMAP,
    AUDIO_CHANNEL_TYPE_AMBISONICS,
} audio_channel_type_t;

79 80 81 82 83 84 85
/**
 * audio format description
 */
struct audio_format_t
{
    vlc_fourcc_t i_format;                          /**< audio format fourcc */
    unsigned int i_rate;                              /**< audio sample-rate */
86 87 88

    /* Describes the channels configuration of the samples (ie. number of
     * channels which are available in the buffer, and positions). */
89
    uint16_t     i_physical_channels;
90

91 92 93 94
    /* Describes the chan mode, either set from the input
     * (demux/codec/packetizer) or overridden by the user, used by audio
     * filters. */
    uint16_t     i_chan_mode;
95

96 97 98
    /* Channel type */
    audio_channel_type_t channel_type;

99 100
    /* Optional - for A/52, SPDIF and DTS types : */
    /* Bytes used by one compressed frame, depends on bitrate. */
101
    unsigned int i_bytes_per_frame;
102 103

    /* Number of sampleframes contained in one compressed frame. */
Jean-Paul Saman's avatar
Jean-Paul Saman committed
104
    unsigned int i_frame_length;
105 106 107 108 109 110 111
    /* Please note that it may be completely arbitrary - buffers are not
     * obliged to contain a integral number of so-called "frames". It's
     * just here for the division :
     * buffer_size = i_nb_samples * i_bytes_per_frame / i_frame_length
     */

    /* FIXME ? (used by the codecs) */
112 113
    unsigned     i_bitspersample;
    unsigned     i_blockalign;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
114
    uint8_t      i_channels; /* must be <=32 */
115 116
};

117 118 119 120 121 122 123 124 125 126 127 128 129 130
/* Values available for audio channels */
#define AOUT_CHAN_CENTER            0x1
#define AOUT_CHAN_LEFT              0x2
#define AOUT_CHAN_RIGHT             0x4
#define AOUT_CHAN_REARCENTER        0x10
#define AOUT_CHAN_REARLEFT          0x20
#define AOUT_CHAN_REARRIGHT         0x40
#define AOUT_CHAN_MIDDLELEFT        0x100
#define AOUT_CHAN_MIDDLERIGHT       0x200
#define AOUT_CHAN_LFE               0x1000

#define AOUT_CHANS_FRONT  (AOUT_CHAN_LEFT       | AOUT_CHAN_RIGHT)
#define AOUT_CHANS_MIDDLE (AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT)
#define AOUT_CHANS_REAR   (AOUT_CHAN_REARLEFT   | AOUT_CHAN_REARRIGHT)
131
#define AOUT_CHANS_CENTER (AOUT_CHAN_CENTER     | AOUT_CHAN_REARCENTER)
132

133 134 135 136 137
#define AOUT_CHANS_STEREO AOUT_CHANS_2_0
#define AOUT_CHANS_2_0    (AOUT_CHANS_FRONT)
#define AOUT_CHANS_2_1    (AOUT_CHANS_FRONT | AOUT_CHAN_LFE)
#define AOUT_CHANS_3_0    (AOUT_CHANS_FRONT | AOUT_CHAN_CENTER)
#define AOUT_CHANS_3_1    (AOUT_CHANS_3_0   | AOUT_CHAN_LFE)
138
#define AOUT_CHANS_4_0    (AOUT_CHANS_FRONT | AOUT_CHANS_REAR)
139 140 141 142 143 144
#define AOUT_CHANS_4_1    (AOUT_CHANS_4_0   | AOUT_CHAN_LFE)
#define AOUT_CHANS_5_0    (AOUT_CHANS_4_0   | AOUT_CHAN_CENTER)
#define AOUT_CHANS_5_1    (AOUT_CHANS_5_0   | AOUT_CHAN_LFE)
#define AOUT_CHANS_6_0    (AOUT_CHANS_4_0   | AOUT_CHANS_MIDDLE)
#define AOUT_CHANS_7_0    (AOUT_CHANS_6_0   | AOUT_CHAN_CENTER)
#define AOUT_CHANS_7_1    (AOUT_CHANS_5_1   | AOUT_CHANS_MIDDLE)
145
#define AOUT_CHANS_8_1    (AOUT_CHANS_7_1   | AOUT_CHAN_REARCENTER)
146 147 148 149

#define AOUT_CHANS_4_0_MIDDLE (AOUT_CHANS_FRONT | AOUT_CHANS_MIDDLE)
#define AOUT_CHANS_4_CENTER_REAR (AOUT_CHANS_FRONT | AOUT_CHANS_CENTER)
#define AOUT_CHANS_5_0_MIDDLE (AOUT_CHANS_4_0_MIDDLE | AOUT_CHAN_CENTER)
150
#define AOUT_CHANS_6_1_MIDDLE (AOUT_CHANS_5_0_MIDDLE | AOUT_CHAN_REARCENTER | AOUT_CHAN_LFE)
151

Thomas Guillem's avatar
Thomas Guillem committed
152 153
/* Maximum number of mapped channels (or the maximum of bits set in
 * i_physical_channels) */
154
#define AOUT_CHAN_MAX               9
Thomas Guillem's avatar
Thomas Guillem committed
155 156
/* Maximum number of unmapped channels */
#define INPUT_CHAN_MAX              64
157

158 159 160 161
/* Values available for i_chan_mode only */
#define AOUT_CHANMODE_DUALMONO    0x1
#define AOUT_CHANMODE_DOLBYSTEREO 0x2

162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
/**
 * Picture orientation.
 */
typedef enum video_orientation_t
{
    ORIENT_TOP_LEFT = 0, /**< Top line represents top, left column left. */
    ORIENT_TOP_RIGHT, /**< Flipped horizontally */
    ORIENT_BOTTOM_LEFT, /**< Flipped vertically */
    ORIENT_BOTTOM_RIGHT, /**< Rotated 180 degrees */
    ORIENT_LEFT_TOP, /**< Transposed */
    ORIENT_LEFT_BOTTOM, /**< Rotated 90 degrees clockwise */
    ORIENT_RIGHT_TOP, /**< Rotated 90 degrees anti-clockwise */
    ORIENT_RIGHT_BOTTOM, /**< Anti-transposed */

    ORIENT_NORMAL      = ORIENT_TOP_LEFT,
177 178
    ORIENT_TRANSPOSED  = ORIENT_LEFT_TOP,
    ORIENT_ANTI_TRANSPOSED = ORIENT_RIGHT_BOTTOM,
179 180 181 182 183 184 185
    ORIENT_HFLIPPED    = ORIENT_TOP_RIGHT,
    ORIENT_VFLIPPED    = ORIENT_BOTTOM_LEFT,
    ORIENT_ROTATED_180 = ORIENT_BOTTOM_RIGHT,
    ORIENT_ROTATED_270 = ORIENT_LEFT_BOTTOM,
    ORIENT_ROTATED_90  = ORIENT_RIGHT_TOP,
} video_orientation_t;
/** Convert EXIF orientation to enum video_orientation_t */
186
#define ORIENT_FROM_EXIF(exif) ((0x57642310U >> (4 * ((exif) - 1))) & 7)
187
/** Convert enum video_orientation_t to EXIF */
188
#define ORIENT_TO_EXIF(orient) ((0x76853421U >> (4 * (orient))) & 15)
189 190 191 192 193 194 195 196 197 198 199
/** If the orientation is natural or mirrored */
#define ORIENT_IS_MIRROR(orient) parity(orient)
/** If the orientation swaps dimensions */
#define ORIENT_IS_SWAP(orient) (((orient) & 4) != 0)
/** Applies horizontal flip to an orientation */
#define ORIENT_HFLIP(orient) ((orient) ^ 1)
/** Applies vertical flip to an orientation */
#define ORIENT_VFLIP(orient) ((orient) ^ 2)
/** Applies horizontal flip to an orientation */
#define ORIENT_ROTATE_180(orient) ((orient) ^ 3)

200 201
typedef enum video_transform_t
{
202
    TRANSFORM_IDENTITY       = ORIENT_NORMAL,
203 204 205 206 207 208 209 210 211
    TRANSFORM_HFLIP          = ORIENT_HFLIPPED,
    TRANSFORM_VFLIP          = ORIENT_VFLIPPED,
    TRANSFORM_R180           = ORIENT_ROTATED_180,
    TRANSFORM_R270           = ORIENT_ROTATED_270,
    TRANSFORM_R90            = ORIENT_ROTATED_90,
    TRANSFORM_TRANSPOSE      = ORIENT_TRANSPOSED,
    TRANSFORM_ANTI_TRANSPOSE = ORIENT_ANTI_TRANSPOSED
} video_transform_t;

212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
typedef enum video_multiview_mode_t
{
    /* No stereoscopy: 2D picture. */
    MULTIVIEW_2D = 0,

    /* Side-by-side with left eye first. */
    MULTIVIEW_STEREO_SBS,

    /* Top-bottom with left eye first. */
    MULTIVIEW_STEREO_TB,

    /* Row sequential with left eye first. */
    MULTIVIEW_STEREO_ROW,

    /* Column sequential with left eye first. */
    MULTIVIEW_STEREO_COL,

    /* Frame sequential with left eye first. */
    MULTIVIEW_STEREO_FRAME,

    /* Checkerboard pattern with left eye first. */
    MULTIVIEW_STEREO_CHECKERBOARD,
} video_multiview_mode_t;

236 237 238 239 240 241 242 243 244 245 246
/**
 * Video projection mode.
 */
typedef enum video_projection_mode_t
{
    PROJECTION_MODE_RECTANGULAR = 0,
    PROJECTION_MODE_EQUIRECTANGULAR,

    PROJECTION_MODE_CUBEMAP_LAYOUT_STANDARD = 0x100,
} video_projection_mode_t;

247 248 249 250 251 252 253 254 255 256 257
/**
 * Video color primaries (a.k.a. chromacities)
 */
typedef enum video_color_primaries_t
{
    COLOR_PRIMARIES_UNDEF,
    COLOR_PRIMARIES_BT601_525,
    COLOR_PRIMARIES_BT601_625,
    COLOR_PRIMARIES_BT709,
    COLOR_PRIMARIES_BT2020,
    COLOR_PRIMARIES_DCI_P3,
258 259 260 261 262 263 264 265
    COLOR_PRIMARIES_FCC1953,
#define COLOR_PRIMARIES_SRGB            COLOR_PRIMARIES_BT709
#define COLOR_PRIMARIES_SMTPE_170       COLOR_PRIMARIES_BT601_525
#define COLOR_PRIMARIES_SMTPE_240       COLOR_PRIMARIES_BT601_525 /* Only differs from 1e10-4 in white Y */
#define COLOR_PRIMARIES_SMTPE_RP145     COLOR_PRIMARIES_BT601_525
#define COLOR_PRIMARIES_EBU_3213        COLOR_PRIMARIES_BT601_625
#define COLOR_PRIMARIES_BT470_BG        COLOR_PRIMARIES_BT601_625
#define COLOR_PRIMARIES_BT470_M         COLOR_PRIMARIES_FCC1953
266 267 268 269 270 271 272 273 274 275
} video_color_primaries_t;

/**
 * Video transfer functions
 */
typedef enum video_transfer_func_t
{
    TRANSFER_FUNC_UNDEF,
    TRANSFER_FUNC_LINEAR,
    TRANSFER_FUNC_SRGB /*< Gamma 2.2 */,
276 277
    TRANSFER_FUNC_BT470_BG,
    TRANSFER_FUNC_BT470_M,
278
    TRANSFER_FUNC_BT709,
279
    TRANSFER_FUNC_SMPTE_ST2084,
280
    TRANSFER_FUNC_SMPTE_240,
281
    TRANSFER_FUNC_HLG,
282 283 284 285 286
#define TRANSFER_FUNC_BT2020            TRANSFER_FUNC_BT709
#define TRANSFER_FUNC_SMPTE_170         TRANSFER_FUNC_BT709
#define TRANSFER_FUNC_SMPTE_274         TRANSFER_FUNC_BT709
#define TRANSFER_FUNC_SMPTE_293         TRANSFER_FUNC_BT709
#define TRANSFER_FUNC_SMPTE_296         TRANSFER_FUNC_BT709
287
#define TRANSFER_FUNC_ARIB_B67          TRANSFER_FUNC_HLG
288 289 290 291 292 293 294 295
} video_transfer_func_t;

/**
 * Video color space (i.e. YCbCr matrices)
 */
typedef enum video_color_space_t
{
    COLOR_SPACE_UNDEF,
296 297 298
    COLOR_SPACE_BT601,
    COLOR_SPACE_BT709,
    COLOR_SPACE_BT2020,
299 300 301
#define COLOR_SPACE_SRGB      COLOR_SPACE_BT709
#define COLOR_SPACE_SMPTE_170 COLOR_SPACE_BT601
#define COLOR_SPACE_SMPTE_240 COLOR_SPACE_SMPTE_170
302 303
} video_color_space_t;

304 305 306 307 308 309 310 311 312 313 314 315 316 317
/**
 * Video chroma location
 */
typedef enum video_chroma_location_t
{
    CHROMA_LOCATION_UNDEF,
    CHROMA_LOCATION_LEFT,   /*< Most common in MPEG-2 Video, H.264/265 */
    CHROMA_LOCATION_CENTER, /*< Most common in MPEG-1 Video, JPEG */
    CHROMA_LOCATION_TOP_LEFT,
    CHROMA_LOCATION_TOP_CENTER,
    CHROMA_LOCATION_BOTTOM_LEFT,
    CHROMA_LOCATION_BOTTOM_CENTER,
} video_chroma_location_t;

318
/**
319
 * video format description
320 321 322 323 324 325 326 327 328 329 330 331 332 333
 */
struct video_format_t
{
    vlc_fourcc_t i_chroma;                               /**< picture chroma */

    unsigned int i_width;                                 /**< picture width */
    unsigned int i_height;                               /**< picture height */
    unsigned int i_x_offset;               /**< start offset of visible area */
    unsigned int i_y_offset;               /**< start offset of visible area */
    unsigned int i_visible_width;                 /**< width of visible area */
    unsigned int i_visible_height;               /**< height of visible area */

    unsigned int i_bits_per_pixel;             /**< number of bits per pixel */

334 335 336
    unsigned int i_sar_num;                   /**< sample/pixel aspect ratio */
    unsigned int i_sar_den;

337 338
    unsigned int i_frame_rate;                     /**< frame rate numerator */
    unsigned int i_frame_rate_base;              /**< frame rate denominator */
339

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
340
    uint32_t i_rmask, i_gmask, i_bmask;      /**< color masks for RGB chroma */
341 342 343
    int i_rrshift, i_lrshift;
    int i_rgshift, i_lgshift;
    int i_rbshift, i_lbshift;
344
    video_palette_t *p_palette;              /**< video palette from demuxer */
345
    video_orientation_t orientation;                /**< picture orientation */
346 347 348
    video_color_primaries_t primaries;                  /**< color primaries */
    video_transfer_func_t transfer;                   /**< transfer function */
    video_color_space_t space;                        /**< YCbCr color space */
349
    bool b_color_range_full;                    /**< 0-255 instead of 16-235 */
350
    video_chroma_location_t chroma_location;      /**< YCbCr chroma location */
351

352 353
    video_multiview_mode_t multiview_mode;        /** Multiview mode, 2D, 3D */

354
    video_projection_mode_t projection_mode;            /**< projection mode */
355
    vlc_viewpoint_t pose;
356 357 358 359 360 361 362 363 364 365 366
    struct {
        /* similar to SMPTE ST 2086 mastering display color volume */
        uint16_t primaries[3*2]; /* G,B,R / x,y */
        uint16_t white_point[2]; /* x,y */
        uint32_t max_luminance;
        uint32_t min_luminance;
    } mastering;
    struct {
        /* similar to CTA-861.3 content light level */
        uint16_t MaxCLL;  /* max content light level */
        uint16_t MaxFALL; /* max frame average light level */
367
    } lighting;
368
    uint32_t i_cubemap_padding; /**< padding in pixels of the cube map faces */
369 370
};

Jean-Paul Saman's avatar
Jean-Paul Saman committed
371 372 373 374 375
/**
 * Initialize a video_format_t structure with chroma 'i_chroma'
 * \param p_src pointer to video_format_t structure
 * \param i_chroma chroma value to use
 */
376 377 378 379
static inline void video_format_Init( video_format_t *p_src, vlc_fourcc_t i_chroma )
{
    memset( p_src, 0, sizeof( video_format_t ) );
    p_src->i_chroma = i_chroma;
380
    vlc_viewpoint_init( &p_src->pose );
381 382
}

Jean-Paul Saman's avatar
Jean-Paul Saman committed
383 384 385 386 387
/**
 * Copy video_format_t including the palette
 * \param p_dst video_format_t to copy to
 * \param p_src video_format_t to copy from
 */
388
static inline int video_format_Copy( video_format_t *p_dst, const video_format_t *p_src )
389
{
390
    memcpy( p_dst, p_src, sizeof( *p_dst ) );
391 392 393 394 395
    if( p_src->p_palette )
    {
        p_dst->p_palette = (video_palette_t *) malloc( sizeof( video_palette_t ) );
        if( !p_dst->p_palette )
            return VLC_ENOMEM;
396
        memcpy( p_dst->p_palette, p_src->p_palette, sizeof( *p_dst->p_palette ) );
397 398
    }
    return VLC_SUCCESS;
399
}
400

401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
static inline void video_format_AdjustColorSpace( video_format_t *p_fmt )
{
    if ( p_fmt->primaries == COLOR_PRIMARIES_UNDEF )
    {
        if ( p_fmt->i_visible_height > 576 ) // HD
            p_fmt->primaries = COLOR_PRIMARIES_BT709;
        else if ( p_fmt->i_visible_height > 525 ) // PAL
            p_fmt->primaries = COLOR_PRIMARIES_BT601_625;
        else
            p_fmt->primaries = COLOR_PRIMARIES_BT601_525;
    }

    if ( p_fmt->transfer == TRANSFER_FUNC_UNDEF )
    {
        if ( p_fmt->i_visible_height > 576 ) // HD
            p_fmt->transfer = TRANSFER_FUNC_BT709;
        else
            p_fmt->transfer = TRANSFER_FUNC_SRGB;
    }

    if ( p_fmt->space == COLOR_SPACE_UNDEF )
    {
        if ( p_fmt->i_visible_height > 576 ) // HD
            p_fmt->space = COLOR_SPACE_BT709;
        else
            p_fmt->space = COLOR_SPACE_BT601;
    }
}

Jean-Paul Saman's avatar
Jean-Paul Saman committed
430 431 432 433
/**
 * Cleanup and free palette of this video_format_t
 * \param p_src video_format_t structure to clean
 */
434 435 436 437 438 439
static inline void video_format_Clean( video_format_t *p_src )
{
    free( p_src->p_palette );
    memset( p_src, 0, sizeof( video_format_t ) );
}

440
/**
441 442
 * It will fill up a video_format_t using the given arguments.
 * Note that the video_format_t must already be initialized.
443
 */
444 445 446
VLC_API void video_format_Setup( video_format_t *, vlc_fourcc_t i_chroma,
    int i_width, int i_height, int i_visible_width, int i_visible_height,
    int i_sar_num, int i_sar_den );
447

448 449 450
/**
 * It will copy the crop properties from a video_format_t to another.
 */
451
VLC_API void video_format_CopyCrop( video_format_t *, const video_format_t * );
452

453 454 455
/**
 * It will compute the crop/ar properties when scaling.
 */
456
VLC_API void video_format_ScaleCropAr( video_format_t *, const video_format_t * );
457

458 459 460 461
/**
 * This function "normalizes" the formats orientation, by switching the a/r according to the orientation,
 * producing a format whose orientation is ORIENT_NORMAL. It makes a shallow copy (pallette is not alloc'ed).
 */
462 463
VLC_API void video_format_ApplyRotation(video_format_t * /*restrict*/ out,
                                        const video_format_t *in);
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480

/**
 * This function applies the transform operation to fmt.
 */
VLC_API void video_format_TransformBy(video_format_t *fmt, video_transform_t transform);

/**
 * This function applies the transforms necessary to fmt so that the resulting fmt
 * has the dst_orientation.
 */
VLC_API void video_format_TransformTo(video_format_t *fmt, video_orientation_t dst_orientation);

/**
 * Returns the operation required to transform src into dst.
 */
VLC_API video_transform_t video_format_GetTransform(video_orientation_t src, video_orientation_t dst);

481 482 483 484
/**
 * This function will check if the first video format is similar
 * to the second one.
 */
485
VLC_API bool video_format_IsSimilar( const video_format_t *, const video_format_t * );
486

Laurent Aimar's avatar
Laurent Aimar committed
487 488 489
/**
 * It prints details about the given video_format_t
 */
490
VLC_API void video_format_Print( vlc_object_t *, const char *, const video_format_t * );
Laurent Aimar's avatar
Laurent Aimar committed
491

492 493 494 495 496 497 498 499 500 501 502 503

static inline video_transform_t transform_Inverse( video_transform_t transform )
{
    switch ( transform ) {
        case TRANSFORM_R90:
            return TRANSFORM_R270;
        case TRANSFORM_R270:
            return TRANSFORM_R90;
        default:
            return transform;
    }
}
504
/**
505
 * subtitles format description
506
 */
507
struct subs_format_t
508
{
509 510
    /* the character encoding of the text of the subtitle.
     * all gettext recognized shorts can be used */
511 512
    char *psz_encoding;

513 514 515 516

    int  i_x_origin; /**< x coordinate of the subtitle. 0 = left */
    int  i_y_origin; /**< y coordinate of the subtitle. 0 = top */

517 518
    struct
    {
519
        /*  */
520
        uint32_t palette[16+1];
521 522

        /* the width of the original movie the spu was extracted from */
Antoine Cellerier's avatar
Antoine Cellerier committed
523
        int i_original_frame_width;
524
        /* the height of the original movie the spu was extracted from */
Antoine Cellerier's avatar
Antoine Cellerier committed
525
        int i_original_frame_height;
526
    } spu;
527 528 529 530 531

    struct
    {
        int i_id;
    } dvb;
532 533 534 535 536
    struct
    {
        int i_magazine;
        int i_page;
    } teletext;
537 538
    struct
    {
539
        uint8_t i_channel;
540 541
        /* Reorder depth of transport video, -1 for no reordering */
        int i_reorder_depth;
542
    } cc;
543 544

    text_style_t *p_style; /* Default styles to use */
545
};
546

547 548
#define SPU_PALETTE_DEFINED  0xbeefbeef

549
/**
Jean-Paul Saman's avatar
Jean-Paul Saman committed
550
 * ES language definition
551
 */
Christophe Mutricy's avatar
Christophe Mutricy committed
552 553 554 555 556 557
typedef struct extra_languages_t
{
        char *psz_language;
        char *psz_description;
} extra_languages_t;

558 559 560 561 562 563 564
/** ES Categories */
enum es_format_category_e
{
    UNKNOWN_ES = 0x00,
    VIDEO_ES,
    AUDIO_ES,
    SPU_ES,
565
    DATA_ES,
566
};
567
#define ES_CATEGORY_COUNT (DATA_ES + 1)
568

Jean-Paul Saman's avatar
Jean-Paul Saman committed
569 570 571
/**
 * ES format definition
 */
572 573 574 575
#define ES_PRIORITY_NOT_SELECTABLE  -2
#define ES_PRIORITY_NOT_DEFAULTABLE -1
#define ES_PRIORITY_SELECTABLE_MIN   0
#define ES_PRIORITY_MIN ES_PRIORITY_NOT_SELECTABLE
576
struct es_format_t
577
{
578
    enum es_format_category_e i_cat;    /**< ES category */
579 580
    vlc_fourcc_t    i_codec;            /**< FOURCC value as used in vlc */
    vlc_fourcc_t    i_original_fourcc;  /**< original FOURCC from the container */
Jean-Paul Saman's avatar
Jean-Paul Saman committed
581 582 583 584 585 586 587

    int             i_id;       /**< es identifier, where means
                                    -1: let the core mark the right id
                                    >=0: valid id */
    int             i_group;    /**< group identifier, where means:
                                    -1 : standalone
                                    >= 0 then a "group" (program) is created
588
                                        for each value */
Jean-Paul Saman's avatar
Jean-Paul Saman committed
589 590
    int             i_priority; /**< priority, where means:
                                    -2 : mean not selectable by the users
591
                                    -1 : mean not selected by default even
Jean-Paul Saman's avatar
Jean-Paul Saman committed
592
                                         when no other stream
593
                                    >=0: priority */
594

595 596
    char            *psz_language;        /**< human-readable language name */
    char            *psz_description;     /**< human-readable description of language */
597
    unsigned        i_extra_languages;    /**< length in bytes of extra language data pointer */
Jean-Paul Saman's avatar
Jean-Paul Saman committed
598
    extra_languages_t *p_extra_languages; /**< extra language data needed by some decoders */
Christophe Mutricy's avatar
Christophe Mutricy committed
599

600 601 602 603 604 605 606 607
    union {
        struct {
            audio_format_t  audio;    /**< description of audio format */
            audio_replay_gain_t audio_replay_gain; /*< audio replay gain information */
        };
        video_format_t video;     /**< description of video format */
        subs_format_t  subs;      /**< description of subtitle format */
    };
608

Jean-Paul Saman's avatar
Jean-Paul Saman committed
609
    unsigned int   i_bitrate; /**< bitrate of this ES */
610
    int      i_profile;       /**< codec specific information (like real audio flavor, mpeg audio layer, h264 profile ...) */
Rafaël Carré's avatar
Rafaël Carré committed
611
    int      i_level;         /**< codec specific information: indicates maximum restrictions on the stream (resolution, bitrate, codec features ...) */
612

Konstantin Pavlov's avatar
Konstantin Pavlov committed
613
    bool     b_packetized;  /**< whether the data is packetized (ie. not truncated) */
Jean-Paul Saman's avatar
Jean-Paul Saman committed
614 615
    int     i_extra;        /**< length in bytes of extra data pointer */
    void    *p_extra;       /**< extra data needed by some decoders or muxers */
616

617
};
618

619 620 621
/**
 * This function will fill all RGB shift from RGB masks.
 */
622
VLC_API void video_format_FixRgb( video_format_t * );
623

624
/**
Laurent Aimar's avatar
Laurent Aimar committed
625
 * This function will initialize a es_format_t structure.
626
 */
627
VLC_API void es_format_Init( es_format_t *, int i_cat, vlc_fourcc_t i_codec );
628

629 630 631
/**
 * This function will initialize a es_format_t structure from a video_format_t.
 */
632
VLC_API void es_format_InitFromVideo( es_format_t *, const video_format_t * );
633

634 635 636
/**
 * This functions will copy a es_format_t.
 */
637
VLC_API int es_format_Copy( es_format_t *p_dst, const es_format_t *p_src );
638

639
/**
640
 * This function will clean up a es_format_t and release all associated
641 642 643
 * resources.
 * You can call it multiple times on the same structure.
 */
644
VLC_API void es_format_Clean( es_format_t *fmt );
645

646 647 648 649 650 651
/**
 * This function will check if the first ES format is similar
 * to the second one.
 *
 * All descriptive fields are ignored.
 */
652
VLC_API bool es_format_IsSimilar( const es_format_t *, const es_format_t * );
653

654 655 656 657 658 659 660 661 662 663
/**
 * Changes ES format to another category
 * Format must have been properly initialized
 */
static inline void es_format_Change( es_format_t *fmt, int i_cat, vlc_fourcc_t i_codec )
{
    es_format_Clean( fmt );
    es_format_Init( fmt, i_cat, i_codec );
}

664
#endif