vlc_es.h 10.8 KB
Newer Older
1
/*****************************************************************************
2
 * vlc_es.h: Elementary stream formats descriptions
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
4
 * Copyright (C) 1999-2001 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
    uint32_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
 * video format description
100 101 102 103 104 105 106 107 108 109 110 111 112 113
 */
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 */

114 115 116
    unsigned int i_sar_num;                   /**< sample/pixel aspect ratio */
    unsigned int i_sar_den;

117 118
    unsigned int i_frame_rate;                     /**< frame rate numerator */
    unsigned int i_frame_rate_base;              /**< frame rate denominator */
119

Pierre's avatar
Pierre committed
120
    uint32_t i_rmask, i_gmask, i_bmask;          /**< color masks for RGB chroma */
121 122 123
    int i_rrshift, i_lrshift;
    int i_rgshift, i_lgshift;
    int i_rbshift, i_lbshift;
124
    video_palette_t *p_palette;              /**< video palette from demuxer */
125 126
};

Jean-Paul Saman's avatar
Jean-Paul Saman committed
127 128 129 130 131
/**
 * 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
 */
132 133 134 135 136 137 138 139
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
140 141 142 143 144
/**
 * 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
 */
145
static inline int video_format_Copy( video_format_t *p_dst, const video_format_t *p_src )
146
{
147
    memcpy( p_dst, p_src, sizeof( *p_dst ) );
148 149 150 151 152
    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;
153
        memcpy( p_dst->p_palette, p_src->p_palette, sizeof( *p_dst->p_palette ) );
154 155
    }
    return VLC_SUCCESS;
156
}
157

Jean-Paul Saman's avatar
Jean-Paul Saman committed
158 159 160 161
/**
 * Cleanup and free palette of this video_format_t
 * \param p_src video_format_t structure to clean
 */
162 163 164 165 166 167 168
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;
}

169
/**
170 171
 * It will fill up a video_format_t using the given arguments.
 * Note that the video_format_t must already be initialized.
172
 */
173
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 );
174

175 176 177
/**
 * It will copy the crop properties from a video_format_t to another.
 */
178
VLC_API void video_format_CopyCrop( video_format_t *, const video_format_t * );
179

180 181 182
/**
 * It will compute the crop/ar properties when scaling.
 */
183
VLC_API void video_format_ScaleCropAr( video_format_t *, const video_format_t * );
184

185 186 187 188
/**
 * This function will check if the first video format is similar
 * to the second one.
 */
189
VLC_API bool video_format_IsSimilar( const video_format_t *, const video_format_t * );
190

Laurent Aimar's avatar
Laurent Aimar committed
191 192 193
/**
 * It prints details about the given video_format_t
 */
194
VLC_API void video_format_Print( vlc_object_t *, const char *, const video_format_t * );
Laurent Aimar's avatar
Laurent Aimar committed
195

196
/**
197
 * subtitles format description
198
 */
199
struct subs_format_t
200
{
201 202
    /* the character encoding of the text of the subtitle.
     * all gettext recognized shorts can be used */
203 204
    char *psz_encoding;

205 206 207 208

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

209 210
    struct
    {
211
        /*  */
212
        uint32_t palette[16+1];
213 214

        /* the width of the original movie the spu was extracted from */
Antoine Cellerier's avatar
Antoine Cellerier committed
215
        int i_original_frame_width;
216
        /* the height of the original movie the spu was extracted from */
Antoine Cellerier's avatar
Antoine Cellerier committed
217
        int i_original_frame_height;
218
    } spu;
219 220 221 222 223

    struct
    {
        int i_id;
    } dvb;
224 225 226 227 228
    struct
    {
        int i_magazine;
        int i_page;
    } teletext;
229
};
230 231

/**
Jean-Paul Saman's avatar
Jean-Paul Saman committed
232
 * ES language definition
233
 */
Christophe Mutricy's avatar
Christophe Mutricy committed
234 235 236 237 238 239
typedef struct extra_languages_t
{
        char *psz_language;
        char *psz_description;
} extra_languages_t;

Jean-Paul Saman's avatar
Jean-Paul Saman committed
240 241 242
/**
 * ES format definition
 */
243
struct es_format_t
244
{
245 246 247
    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
248 249 250 251 252 253 254

    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
255
                                        for each value */
Jean-Paul Saman's avatar
Jean-Paul Saman committed
256 257
    int             i_priority; /**< priority, where means:
                                    -2 : mean not selectable by the users
258
                                    -1 : mean not selected by default even
Jean-Paul Saman's avatar
Jean-Paul Saman committed
259
                                         when no other stream
260
                                    >=0: priority */
261

Jean-Paul Saman's avatar
Jean-Paul Saman committed
262 263 264 265
    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
266

Jean-Paul Saman's avatar
Jean-Paul Saman committed
267 268 269 270
    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 */
271

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

Jean-Paul Saman's avatar
Jean-Paul Saman committed
276 277 278
    bool     b_packetized;  /**< wether the data is packetized (ie. not truncated) */
    int     i_extra;        /**< length in bytes of extra data pointer */
    void    *p_extra;       /**< extra data needed by some decoders or muxers */
279

280
};
281

Jean-Paul Saman's avatar
Jean-Paul Saman committed
282
/** ES Categories */
283
enum es_format_category_e
284
{
285 286 287 288 289 290
    UNKNOWN_ES = 0x00,
    VIDEO_ES   = 0x01,
    AUDIO_ES   = 0x02,
    SPU_ES     = 0x03,
    NAV_ES     = 0x04,
};
291

292 293 294
/**
 * This function will fill all RGB shift from RGB masks.
 */
295
VLC_API void video_format_FixRgb( video_format_t * );
296

297
/**
Laurent Aimar's avatar
Laurent Aimar committed
298
 * This function will initialize a es_format_t structure.
299
 */
300
VLC_API void es_format_Init( es_format_t *, int i_cat, vlc_fourcc_t i_codec );
301

302 303 304
/**
 * This function will initialize a es_format_t structure from a video_format_t.
 */
305
VLC_API void es_format_InitFromVideo( es_format_t *, const video_format_t * );
306

307 308 309
/**
 * This functions will copy a es_format_t.
 */
310
VLC_API int es_format_Copy( es_format_t *p_dst, const es_format_t *p_src );
311

312
/**
313
 * This function will clean up a es_format_t and release all associated
314 315 316
 * resources.
 * You can call it multiple times on the same structure.
 */
317
VLC_API void es_format_Clean( es_format_t *fmt );
318

319 320 321 322 323 324
/**
 * This function will check if the first ES format is similar
 * to the second one.
 *
 * All descriptive fields are ignored.
 */
325
VLC_API bool es_format_IsSimilar( const es_format_t *, const es_format_t * );
326

327
#endif