vlc_es.h 14.3 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_fourcc.h>
28

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

/**
 * video palette data
36
 * \see video_format_t
37 38 39
 * \see subs_format_t
 */
struct video_palette_t
40
{
41
    int i_entries;      /**< to keep the compatibility with ffmpeg's palette */
42
    uint8_t palette[256][4];                   /**< 4-byte RGBA/YUVA palette */
43
};
44

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

    /* true if we have the gain value */
59
    bool pb_gain[AUDIO_REPLAY_GAIN_MAX];
60 61 62 63
    /* gain value in dB */
    float      pf_gain[AUDIO_REPLAY_GAIN_MAX];
} audio_replay_gain_t;

64 65 66 67 68 69 70
/**
 * audio format description
 */
struct audio_format_t
{
    vlc_fourcc_t i_format;                          /**< audio format fourcc */
    unsigned int i_rate;                              /**< audio sample-rate */
71 72 73

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

    /* Describes from which original channels, before downmixing, the
     * buffer is derived. */
78
    uint32_t     i_original_channels;
79 80 81

    /* Optional - for A/52, SPDIF and DTS types : */
    /* Bytes used by one compressed frame, depends on bitrate. */
82
    unsigned int i_bytes_per_frame;
83 84

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

98 99 100 101 102 103 104 105 106 107 108 109 110 111
/* 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)
112
#define AOUT_CHANS_CENTER (AOUT_CHAN_CENTER     | AOUT_CHAN_REARCENTER)
113

114 115 116 117 118
#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)
119
#define AOUT_CHANS_4_0    (AOUT_CHANS_FRONT | AOUT_CHANS_REAR)
120 121 122 123 124 125
#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)
126
#define AOUT_CHANS_8_1    (AOUT_CHANS_7_1   | AOUT_CHAN_REARCENTER)
127 128 129 130

#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)
131 132 133 134 135 136 137 138 139

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

140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
/**
 * 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,
    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)

176
/**
177
 * video format description
178 179 180 181 182 183 184 185 186 187 188 189 190 191
 */
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 */

192 193 194
    unsigned int i_sar_num;                   /**< sample/pixel aspect ratio */
    unsigned int i_sar_den;

195 196
    unsigned int i_frame_rate;                     /**< frame rate numerator */
    unsigned int i_frame_rate_base;              /**< frame rate denominator */
197

Pierre's avatar
Pierre committed
198
    uint32_t i_rmask, i_gmask, i_bmask;          /**< color masks for RGB chroma */
199 200 201
    int i_rrshift, i_lrshift;
    int i_rgshift, i_lgshift;
    int i_rbshift, i_lbshift;
202
    video_palette_t *p_palette;              /**< video palette from demuxer */
203
    video_orientation_t orientation;                /**< picture orientation */
204 205
};

Jean-Paul Saman's avatar
Jean-Paul Saman committed
206 207 208 209 210
/**
 * 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
 */
211 212 213 214 215 216 217 218
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
219 220 221 222 223
/**
 * 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
 */
224
static inline int video_format_Copy( video_format_t *p_dst, const video_format_t *p_src )
225
{
226
    memcpy( p_dst, p_src, sizeof( *p_dst ) );
227 228 229 230 231
    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;
232
        memcpy( p_dst->p_palette, p_src->p_palette, sizeof( *p_dst->p_palette ) );
233 234
    }
    return VLC_SUCCESS;
235
}
236

Jean-Paul Saman's avatar
Jean-Paul Saman committed
237 238 239 240
/**
 * Cleanup and free palette of this video_format_t
 * \param p_src video_format_t structure to clean
 */
241 242 243 244 245 246 247
static inline void video_format_Clean( video_format_t *p_src )
{
    free( p_src->p_palette );
    memset( p_src, 0, sizeof( video_format_t ) );
    p_src->p_palette = NULL;
}

248
/**
249 250
 * It will fill up a video_format_t using the given arguments.
 * Note that the video_format_t must already be initialized.
251
 */
252
VLC_API void video_format_Setup( video_format_t *, vlc_fourcc_t i_chroma, int i_width, int i_height, int i_sar_num, int i_sar_den );
253

254 255 256
/**
 * It will copy the crop properties from a video_format_t to another.
 */
257
VLC_API void video_format_CopyCrop( video_format_t *, const video_format_t * );
258

259 260 261
/**
 * It will compute the crop/ar properties when scaling.
 */
262
VLC_API void video_format_ScaleCropAr( video_format_t *, const video_format_t * );
263

264 265 266 267
/**
 * This function will check if the first video format is similar
 * to the second one.
 */
268
VLC_API bool video_format_IsSimilar( const video_format_t *, const video_format_t * );
269

Laurent Aimar's avatar
Laurent Aimar committed
270 271 272
/**
 * It prints details about the given video_format_t
 */
273
VLC_API void video_format_Print( vlc_object_t *, const char *, const video_format_t * );
Laurent Aimar's avatar
Laurent Aimar committed
274

275
/**
276
 * subtitles format description
277
 */
278
struct subs_format_t
279
{
280 281
    /* the character encoding of the text of the subtitle.
     * all gettext recognized shorts can be used */
282 283
    char *psz_encoding;

284 285 286 287

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

288 289
    struct
    {
290
        /*  */
291
        uint32_t palette[16+1];
292 293

        /* the width of the original movie the spu was extracted from */
Antoine Cellerier's avatar
Antoine Cellerier committed
294
        int i_original_frame_width;
295
        /* the height of the original movie the spu was extracted from */
Antoine Cellerier's avatar
Antoine Cellerier committed
296
        int i_original_frame_height;
297
    } spu;
298 299 300 301 302

    struct
    {
        int i_id;
    } dvb;
303 304 305 306 307
    struct
    {
        int i_magazine;
        int i_page;
    } teletext;
308
};
309 310

/**
Jean-Paul Saman's avatar
Jean-Paul Saman committed
311
 * ES language definition
312
 */
Christophe Mutricy's avatar
Christophe Mutricy committed
313 314 315 316 317 318
typedef struct extra_languages_t
{
        char *psz_language;
        char *psz_description;
} extra_languages_t;

Jean-Paul Saman's avatar
Jean-Paul Saman committed
319 320 321
/**
 * ES format definition
 */
322
struct es_format_t
323
{
324 325 326
    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
327 328 329 330 331 332 333

    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
334
                                        for each value */
Jean-Paul Saman's avatar
Jean-Paul Saman committed
335 336
    int             i_priority; /**< priority, where means:
                                    -2 : mean not selectable by the users
337
                                    -1 : mean not selected by default even
Jean-Paul Saman's avatar
Jean-Paul Saman committed
338
                                         when no other stream
339
                                    >=0: priority */
340

Jean-Paul Saman's avatar
Jean-Paul Saman committed
341 342 343 344
    char            *psz_language;        /**< human readible language name */
    char            *psz_description;     /**< human readible description of language */
    int             i_extra_languages;    /**< length in bytes of extra language data pointer */
    extra_languages_t *p_extra_languages; /**< extra language data needed by some decoders */
Christophe Mutricy's avatar
Christophe Mutricy committed
345

Jean-Paul Saman's avatar
Jean-Paul Saman committed
346 347 348 349
    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 */
350

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

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

359
};
360

Jean-Paul Saman's avatar
Jean-Paul Saman committed
361
/** ES Categories */
362
enum es_format_category_e
363
{
364 365 366 367 368 369
    UNKNOWN_ES = 0x00,
    VIDEO_ES   = 0x01,
    AUDIO_ES   = 0x02,
    SPU_ES     = 0x03,
    NAV_ES     = 0x04,
};
370

371 372 373
/**
 * This function will fill all RGB shift from RGB masks.
 */
374
VLC_API void video_format_FixRgb( video_format_t * );
375

376
/**
Laurent Aimar's avatar
Laurent Aimar committed
377
 * This function will initialize a es_format_t structure.
378
 */
379
VLC_API void es_format_Init( es_format_t *, int i_cat, vlc_fourcc_t i_codec );
380

381 382 383
/**
 * This function will initialize a es_format_t structure from a video_format_t.
 */
384
VLC_API void es_format_InitFromVideo( es_format_t *, const video_format_t * );
385

386 387 388
/**
 * This functions will copy a es_format_t.
 */
389
VLC_API int es_format_Copy( es_format_t *p_dst, const es_format_t *p_src );
390

391
/**
392
 * This function will clean up a es_format_t and release all associated
393 394 395
 * resources.
 * You can call it multiple times on the same structure.
 */
396
VLC_API void es_format_Clean( es_format_t *fmt );
397

398 399 400 401 402 403
/**
 * This function will check if the first ES format is similar
 * to the second one.
 *
 * All descriptive fields are ignored.
 */
404
VLC_API bool es_format_IsSimilar( const es_format_t *, const es_format_t * );
405

406
#endif