vlc_es.h 17.6 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

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

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

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 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;

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. */
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. */
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 142 143 144

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

#define AOUT_CHAN_PHYSMASK          0xFFFF
#define AOUT_CHAN_MAX               9

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

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

195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
/**
 * 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,
#define COLOR_SRGB COLOR_BT709
} 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 */,
    TRANSFER_FUNC_BT709,
#define TRANSFER_FUNC_BT2020 TRANSFER_FUNC_BT709
} video_transfer_func_t;

/**
 * Video color space (i.e. YCbCr matrices)
 */
typedef enum video_color_space_t
{
    COLOR_SPACE_UNDEF,
    COLOR_SPACE_BT601_LIMITED,
#define COLOR_SPACE_BT601 COLOR_SPACE_BT601_LIMITED
    COLOR_SPACE_BT601_FULL,
    COLOR_SPACE_BT709_LIMITED,
#define COLOR_SPACE_BT709 COLOR_SPACE_BT709_LIMITED
    COLOR_SPACE_BT709_FULL,
    COLOR_SPACE_BT2020_LIMITED,
#define COLOR_SPACE_BT2020 COLOR_SPACE_BT2020_LIMITED
} video_color_space_t;

237
/**
238
 * video format description
239 240 241 242 243 244 245 246 247 248 249 250 251 252
 */
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 */

253 254 255
    unsigned int i_sar_num;                   /**< sample/pixel aspect ratio */
    unsigned int i_sar_den;

256 257
    unsigned int i_frame_rate;                     /**< frame rate numerator */
    unsigned int i_frame_rate_base;              /**< frame rate denominator */
258

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
259
    uint32_t i_rmask, i_gmask, i_bmask;      /**< color masks for RGB chroma */
260 261 262
    int i_rrshift, i_lrshift;
    int i_rgshift, i_lgshift;
    int i_rbshift, i_lbshift;
263
    video_palette_t *p_palette;              /**< video palette from demuxer */
264
    video_orientation_t orientation;                /**< picture orientation */
265 266 267
    video_color_primaries_t primaries;                  /**< color primaries */
    video_transfer_func_t transfer;                   /**< transfer function */
    video_color_space_t space;                        /**< YCbCr color space */
268 269
};

Jean-Paul Saman's avatar
Jean-Paul Saman committed
270 271 272 273 274
/**
 * 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
 */
275 276 277 278 279 280 281 282
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;
    p_src->i_sar_num = p_src->i_sar_den = 1;
    p_src->p_palette = NULL;
}

Jean-Paul Saman's avatar
Jean-Paul Saman committed
283 284 285 286 287
/**
 * 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
 */
288
static inline int video_format_Copy( video_format_t *p_dst, const video_format_t *p_src )
289
{
290
    memcpy( p_dst, p_src, sizeof( *p_dst ) );
291 292 293 294 295
    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;
296
        memcpy( p_dst->p_palette, p_src->p_palette, sizeof( *p_dst->p_palette ) );
297 298
    }
    return VLC_SUCCESS;
299
}
300

Jean-Paul Saman's avatar
Jean-Paul Saman committed
301 302 303 304
/**
 * Cleanup and free palette of this video_format_t
 * \param p_src video_format_t structure to clean
 */
305 306 307 308 309 310
static inline void video_format_Clean( video_format_t *p_src )
{
    free( p_src->p_palette );
    memset( p_src, 0, sizeof( video_format_t ) );
}

311
/**
312 313
 * It will fill up a video_format_t using the given arguments.
 * Note that the video_format_t must already be initialized.
314
 */
315 316 317
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 );
318

319 320 321
/**
 * It will copy the crop properties from a video_format_t to another.
 */
322
VLC_API void video_format_CopyCrop( video_format_t *, const video_format_t * );
323

324 325 326
/**
 * It will compute the crop/ar properties when scaling.
 */
327
VLC_API void video_format_ScaleCropAr( video_format_t *, const video_format_t * );
328

329 330 331 332
/**
 * 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).
 */
333 334
VLC_API void video_format_ApplyRotation(video_format_t * /*restrict*/ out,
                                        const video_format_t *in);
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351

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

352 353 354 355
/**
 * This function will check if the first video format is similar
 * to the second one.
 */
356
VLC_API bool video_format_IsSimilar( const video_format_t *, const video_format_t * );
357

Laurent Aimar's avatar
Laurent Aimar committed
358 359 360
/**
 * It prints details about the given video_format_t
 */
361
VLC_API void video_format_Print( vlc_object_t *, const char *, const video_format_t * );
Laurent Aimar's avatar
Laurent Aimar committed
362

363 364 365 366 367 368 369 370 371 372 373 374

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;
    }
}
375
/**
376
 * subtitles format description
377
 */
378
struct subs_format_t
379
{
380 381
    /* the character encoding of the text of the subtitle.
     * all gettext recognized shorts can be used */
382 383
    char *psz_encoding;

384 385 386 387

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

388 389
    struct
    {
390
        /*  */
391
        uint32_t palette[16+1];
392 393

        /* the width of the original movie the spu was extracted from */
Antoine Cellerier's avatar
Antoine Cellerier committed
394
        int i_original_frame_width;
395
        /* the height of the original movie the spu was extracted from */
Antoine Cellerier's avatar
Antoine Cellerier committed
396
        int i_original_frame_height;
397
    } spu;
398 399 400 401 402

    struct
    {
        int i_id;
    } dvb;
403 404 405 406 407
    struct
    {
        int i_magazine;
        int i_page;
    } teletext;
408 409

    text_style_t *p_style; /* Default styles to use */
410
};
411 412

/**
Jean-Paul Saman's avatar
Jean-Paul Saman committed
413
 * ES language definition
414
 */
Christophe Mutricy's avatar
Christophe Mutricy committed
415 416 417 418 419 420
typedef struct extra_languages_t
{
        char *psz_language;
        char *psz_description;
} extra_languages_t;

Jean-Paul Saman's avatar
Jean-Paul Saman committed
421 422 423
/**
 * ES format definition
 */
424 425 426 427
#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
428
struct es_format_t
429
{
430 431 432
    int             i_cat;              /**< ES category @see es_format_category_e */
    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
433 434 435 436 437 438 439

    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
440
                                        for each value */
Jean-Paul Saman's avatar
Jean-Paul Saman committed
441 442
    int             i_priority; /**< priority, where means:
                                    -2 : mean not selectable by the users
443
                                    -1 : mean not selected by default even
Jean-Paul Saman's avatar
Jean-Paul Saman committed
444
                                         when no other stream
445
                                    >=0: priority */
446

447 448
    char            *psz_language;        /**< human-readable language name */
    char            *psz_description;     /**< human-readable description of language */
449
    unsigned        i_extra_languages;    /**< length in bytes of extra language data pointer */
Jean-Paul Saman's avatar
Jean-Paul Saman committed
450
    extra_languages_t *p_extra_languages; /**< extra language data needed by some decoders */
Christophe Mutricy's avatar
Christophe Mutricy committed
451

Jean-Paul Saman's avatar
Jean-Paul Saman committed
452 453 454 455
    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 */
456

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

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

465
};
466

Jean-Paul Saman's avatar
Jean-Paul Saman committed
467
/** ES Categories */
468
enum es_format_category_e
469
{
470
    UNKNOWN_ES = 0x00,
471 472 473 474
    VIDEO_ES,
    AUDIO_ES,
    SPU_ES,
    NAV_ES,
475
};
476
#define ES_CATEGORY_COUNT (NAV_ES + 1)
477

478 479 480
/**
 * This function will fill all RGB shift from RGB masks.
 */
481
VLC_API void video_format_FixRgb( video_format_t * );
482

483
/**
Laurent Aimar's avatar
Laurent Aimar committed
484
 * This function will initialize a es_format_t structure.
485
 */
486
VLC_API void es_format_Init( es_format_t *, int i_cat, vlc_fourcc_t i_codec );
487

488 489 490
/**
 * This function will initialize a es_format_t structure from a video_format_t.
 */
491
VLC_API void es_format_InitFromVideo( es_format_t *, const video_format_t * );
492

493 494 495
/**
 * This functions will copy a es_format_t.
 */
496
VLC_API int es_format_Copy( es_format_t *p_dst, const es_format_t *p_src );
497

498
/**
499
 * This function will clean up a es_format_t and release all associated
500 501 502
 * resources.
 * You can call it multiple times on the same structure.
 */
503
VLC_API void es_format_Clean( es_format_t *fmt );
504

505 506 507 508 509 510
/**
 * This function will check if the first ES format is similar
 * to the second one.
 *
 * All descriptive fields are ignored.
 */
511
VLC_API bool es_format_IsSimilar( const es_format_t *, const es_format_t * );
512

513
#endif