vlc_es.h 22.4 KB
Newer Older
1
/*****************************************************************************
Gildas Bazin's avatar
 
Gildas Bazin committed
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

31
/**
Gildas Bazin's avatar
 
Gildas Bazin committed
32 33
 * \file
 * This file defines the elementary streams format types
34
 */
Gildas Bazin's avatar
 
Gildas Bazin committed
35 36 37

/**
 * video palette data
38
 * \see video_format_t
Gildas Bazin's avatar
 
Gildas Bazin committed
39 40
 * \see subs_format_t
 */
41 42
#define VIDEO_PALETTE_COLORS_MAX 256

Gildas Bazin's avatar
 
Gildas Bazin committed
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 */
Gildas Bazin's avatar
 
Gildas Bazin committed
47
};
48

49 50 51 52 53 54 55 56 57
/**
 * 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 */
58
    bool pb_peak[AUDIO_REPLAY_GAIN_MAX];
59 60 61 62
    /* peak value where 1.0 means full sample value */
    float      pf_peak[AUDIO_REPLAY_GAIN_MAX];

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

Gildas Bazin's avatar
 
Gildas Bazin committed
68 69 70 71 72 73 74
/**
 * audio format description
 */
struct audio_format_t
{
    vlc_fourcc_t i_format;                          /**< audio format fourcc */
    unsigned int i_rate;                              /**< audio sample-rate */
75 76 77

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

    /* Describes from which original channels, before downmixing, the
     * buffer is derived. */
Gildas Bazin's avatar
 
Gildas Bazin committed
82
    uint32_t     i_original_channels;
83 84 85

    /* Optional - for A/52, SPDIF and DTS types : */
    /* Bytes used by one compressed frame, depends on bitrate. */
Gildas Bazin's avatar
 
Gildas Bazin committed
86
    unsigned int i_bytes_per_frame;
87 88

    /* Number of sampleframes contained in one compressed frame. */
Jean-Paul Saman's avatar
Jean-Paul Saman committed
89
    unsigned int i_frame_length;
90 91 92 93 94 95 96
    /* 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) */
97 98
    unsigned     i_bitspersample;
    unsigned     i_blockalign;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
99
    uint8_t      i_channels; /* must be <=32 */
100 101
};

102 103 104 105 106 107 108 109 110 111 112 113 114 115
/* 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)
116
#define AOUT_CHANS_CENTER (AOUT_CHAN_CENTER     | AOUT_CHAN_REARCENTER)
117

118 119 120 121 122
#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)
123
#define AOUT_CHANS_4_0    (AOUT_CHANS_FRONT | AOUT_CHANS_REAR)
124 125 126 127 128 129
#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)
130
#define AOUT_CHANS_8_1    (AOUT_CHANS_7_1   | AOUT_CHAN_REARCENTER)
131 132 133 134

#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)
135
#define AOUT_CHANS_6_1_MIDDLE (AOUT_CHANS_5_0_MIDDLE | AOUT_CHAN_REARCENTER | AOUT_CHAN_LFE)
136 137 138 139 140 141

/* Values available for original channels only */
#define AOUT_CHAN_DOLBYSTEREO       0x10000
#define AOUT_CHAN_DUALMONO          0x20000

#define AOUT_CHAN_PHYSMASK          0xFFFF
Thomas Guillem's avatar
Thomas Guillem committed
142 143
/* Maximum number of mapped channels (or the maximum of bits set in
 * i_physical_channels) */
144
#define AOUT_CHAN_MAX               9
Thomas Guillem's avatar
Thomas Guillem committed
145 146
/* Maximum number of unmapped channels */
#define INPUT_CHAN_MAX              64
147

148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
/**
 * 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,
163 164
    ORIENT_TRANSPOSED  = ORIENT_LEFT_TOP,
    ORIENT_ANTI_TRANSPOSED = ORIENT_RIGHT_BOTTOM,
165 166 167 168 169 170 171
    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 */
172
#define ORIENT_FROM_EXIF(exif) ((0x57642310U >> (4 * ((exif) - 1))) & 7)
173
/** Convert enum video_orientation_t to EXIF */
174
#define ORIENT_TO_EXIF(orient) ((0x76853421U >> (4 * (orient))) & 15)
175 176 177 178 179 180 181 182 183 184 185
/** 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)

186 187
typedef enum video_transform_t
{
188
    TRANSFORM_IDENTITY       = ORIENT_NORMAL,
189 190 191 192 193 194 195 196 197
    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;

198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
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;

222 223 224 225 226 227 228 229 230 231 232
/**
 * 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;

233 234 235 236 237 238 239 240 241 242 243
/**
 * 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,
244 245 246 247 248 249 250 251
    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
252 253 254 255 256 257 258 259 260 261
} 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 */,
262 263
    TRANSFER_FUNC_BT470_BG,
    TRANSFER_FUNC_BT470_M,
264
    TRANSFER_FUNC_BT709,
265
    TRANSFER_FUNC_SMPTE_ST2084,
266
    TRANSFER_FUNC_SMPTE_240,
267
    TRANSFER_FUNC_HLG,
268 269 270 271 272
#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
273
#define TRANSFER_FUNC_ARIB_B67          TRANSFER_FUNC_HLG
274 275 276 277 278 279 280 281
} video_transfer_func_t;

/**
 * Video color space (i.e. YCbCr matrices)
 */
typedef enum video_color_space_t
{
    COLOR_SPACE_UNDEF,
282 283 284
    COLOR_SPACE_BT601,
    COLOR_SPACE_BT709,
    COLOR_SPACE_BT2020,
285 286 287
#define COLOR_SPACE_SRGB      COLOR_SPACE_BT709
#define COLOR_SPACE_SMPTE_170 COLOR_SPACE_BT601
#define COLOR_SPACE_SMPTE_240 COLOR_SPACE_SMPTE_170
288 289
} video_color_space_t;

290 291 292 293 294 295 296 297 298 299 300 301 302 303
/**
 * 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;

304
#define FIELD_OF_VIEW_DEGREES_DEFAULT  80.f
305 306
#define FIELD_OF_VIEW_DEGREES_MAX 150.f
#define FIELD_OF_VIEW_DEGREES_MIN 20.f
307

308
/**
Gildas Bazin's avatar
 
Gildas Bazin committed
309
 * video format description
310 311 312 313 314 315 316 317 318 319 320 321 322 323
 */
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 */

324 325 326
    unsigned int i_sar_num;                   /**< sample/pixel aspect ratio */
    unsigned int i_sar_den;

327 328
    unsigned int i_frame_rate;                     /**< frame rate numerator */
    unsigned int i_frame_rate_base;              /**< frame rate denominator */
Gildas Bazin's avatar
 
Gildas Bazin committed
329

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
330
    uint32_t i_rmask, i_gmask, i_bmask;      /**< color masks for RGB chroma */
331 332 333
    int i_rrshift, i_lrshift;
    int i_rgshift, i_lgshift;
    int i_rbshift, i_lbshift;
Gildas Bazin's avatar
 
Gildas Bazin committed
334
    video_palette_t *p_palette;              /**< video palette from demuxer */
335
    video_orientation_t orientation;                /**< picture orientation */
336 337 338
    video_color_primaries_t primaries;                  /**< color primaries */
    video_transfer_func_t transfer;                   /**< transfer function */
    video_color_space_t space;                        /**< YCbCr color space */
339
    bool b_color_range_full;                    /**< 0-255 instead of 16-235 */
340
    video_chroma_location_t chroma_location;      /**< YCbCr chroma location */
341

342 343
    video_multiview_mode_t multiview_mode;        /** Multiview mode, 2D, 3D */

344
    video_projection_mode_t projection_mode;            /**< projection mode */
345 346 347 348 349 350
    struct {
        float f_yaw_degrees;       /**< view point yaw in degrees ]-180;180] */
        float f_pitch_degrees;     /**< view point pitch in degrees ]-90;90] */
        float f_roll_degrees;     /**< view point roll in degrees ]-180;180] */
        float f_fov_degrees;          /**< view point fov in degrees ]0;180[ */
    } pose;
351 352 353 354 355 356 357 358 359 360 361
    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 */
362
    } lighting;
363
    uint32_t i_cubemap_padding; /**< padding in pixels of the cube map faces */
364 365
};

Jean-Paul Saman's avatar
Jean-Paul Saman committed
366 367 368 369 370
/**
 * 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
 */
371 372 373 374
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;
375
    p_src->pose.f_fov_degrees = FIELD_OF_VIEW_DEGREES_DEFAULT;
376 377
}

Jean-Paul Saman's avatar
Jean-Paul Saman committed
378 379 380 381 382
/**
 * 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
 */
383
static inline int video_format_Copy( video_format_t *p_dst, const video_format_t *p_src )
384
{
385
    memcpy( p_dst, p_src, sizeof( *p_dst ) );
386 387 388 389 390
    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;
391
        memcpy( p_dst->p_palette, p_src->p_palette, sizeof( *p_dst->p_palette ) );
392 393
    }
    return VLC_SUCCESS;
394
}
395

396 397 398 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
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
425 426 427 428
/**
 * Cleanup and free palette of this video_format_t
 * \param p_src video_format_t structure to clean
 */
429 430 431 432 433 434
static inline void video_format_Clean( video_format_t *p_src )
{
    free( p_src->p_palette );
    memset( p_src, 0, sizeof( video_format_t ) );
}

435
/**
436 437
 * It will fill up a video_format_t using the given arguments.
 * Note that the video_format_t must already be initialized.
438
 */
439 440 441
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 );
442

443 444 445
/**
 * It will copy the crop properties from a video_format_t to another.
 */
446
VLC_API void video_format_CopyCrop( video_format_t *, const video_format_t * );
447

448 449 450
/**
 * It will compute the crop/ar properties when scaling.
 */
451
VLC_API void video_format_ScaleCropAr( video_format_t *, const video_format_t * );
452

453 454 455 456
/**
 * 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).
 */
457 458
VLC_API void video_format_ApplyRotation(video_format_t * /*restrict*/ out,
                                        const video_format_t *in);
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475

/**
 * 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);

476 477 478 479
/**
 * This function will check if the first video format is similar
 * to the second one.
 */
480
VLC_API bool video_format_IsSimilar( const video_format_t *, const video_format_t * );
481

Laurent Aimar's avatar
Laurent Aimar committed
482 483 484
/**
 * It prints details about the given video_format_t
 */
485
VLC_API void video_format_Print( vlc_object_t *, const char *, const video_format_t * );
Laurent Aimar's avatar
Laurent Aimar committed
486

487 488 489 490 491 492 493 494 495 496 497 498

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;
    }
}
499
/**
Gildas Bazin's avatar
 
Gildas Bazin committed
500
 * subtitles format description
501
 */
502
struct subs_format_t
503
{
504 505
    /* the character encoding of the text of the subtitle.
     * all gettext recognized shorts can be used */
506 507
    char *psz_encoding;

508 509 510 511

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

512 513
    struct
    {
514
        /*  */
515
        uint32_t palette[16+1];
516 517

        /* the width of the original movie the spu was extracted from */
Antoine Cellerier's avatar
Antoine Cellerier committed
518
        int i_original_frame_width;
519
        /* the height of the original movie the spu was extracted from */
Antoine Cellerier's avatar
Antoine Cellerier committed
520
        int i_original_frame_height;
521
    } spu;
522 523 524 525 526

    struct
    {
        int i_id;
    } dvb;
527 528 529 530 531
    struct
    {
        int i_magazine;
        int i_page;
    } teletext;
532 533 534 535
    struct
    {
        uint8_t i_reorder_depth; /* Reorder depth or transport video */
    } cc;
536 537

    text_style_t *p_style; /* Default styles to use */
538
};
539

540 541
#define SPU_PALETTE_DEFINED  0xbeefbeef

542
/**
Jean-Paul Saman's avatar
Jean-Paul Saman committed
543
 * ES language definition
544
 */
Christophe Mutricy's avatar
Christophe Mutricy committed
545 546 547 548 549 550
typedef struct extra_languages_t
{
        char *psz_language;
        char *psz_description;
} extra_languages_t;

551 552 553 554 555 556 557 558 559 560 561
/** ES Categories */
enum es_format_category_e
{
    UNKNOWN_ES = 0x00,
    VIDEO_ES,
    AUDIO_ES,
    SPU_ES,
    NAV_ES,
};
#define ES_CATEGORY_COUNT (NAV_ES + 1)

Jean-Paul Saman's avatar
Jean-Paul Saman committed
562 563 564
/**
 * ES format definition
 */
565 566 567 568
#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
569
struct es_format_t
570
{
571
    enum es_format_category_e i_cat;    /**< ES category */
572 573
    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
574 575 576 577 578 579 580

    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
581
                                        for each value */
Jean-Paul Saman's avatar
Jean-Paul Saman committed
582 583
    int             i_priority; /**< priority, where means:
                                    -2 : mean not selectable by the users
584
                                    -1 : mean not selected by default even
Jean-Paul Saman's avatar
Jean-Paul Saman committed
585
                                         when no other stream
586
                                    >=0: priority */
587

588 589
    char            *psz_language;        /**< human-readable language name */
    char            *psz_description;     /**< human-readable description of language */
590
    unsigned        i_extra_languages;    /**< length in bytes of extra language data pointer */
Jean-Paul Saman's avatar
Jean-Paul Saman committed
591
    extra_languages_t *p_extra_languages; /**< extra language data needed by some decoders */
Christophe Mutricy's avatar
Christophe Mutricy committed
592

593 594 595 596 597 598 599 600
    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 */
    };
601

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

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

610
};
611

612 613 614
/**
 * This function will fill all RGB shift from RGB masks.
 */
615
VLC_API void video_format_FixRgb( video_format_t * );
616

617
/**
Laurent Aimar's avatar
Laurent Aimar committed
618
 * This function will initialize a es_format_t structure.
619
 */
620
VLC_API void es_format_Init( es_format_t *, int i_cat, vlc_fourcc_t i_codec );
621

622 623 624
/**
 * This function will initialize a es_format_t structure from a video_format_t.
 */
625
VLC_API void es_format_InitFromVideo( es_format_t *, const video_format_t * );
626

627 628 629
/**
 * This functions will copy a es_format_t.
 */
630
VLC_API int es_format_Copy( es_format_t *p_dst, const es_format_t *p_src );
631

632
/**
633
 * This function will clean up a es_format_t and release all associated
634 635 636
 * resources.
 * You can call it multiple times on the same structure.
 */
637
VLC_API void es_format_Clean( es_format_t *fmt );
638

639 640 641 642 643 644
/**
 * This function will check if the first ES format is similar
 * to the second one.
 *
 * All descriptive fields are ignored.
 */
645
VLC_API bool es_format_IsSimilar( const es_format_t *, const es_format_t * );
646

647 648 649 650 651 652 653 654 655 656
/**
 * 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 );
}

657
#endif