1 /*****************************************************************************
2 * vlc_es.h: Elementary stream formats descriptions
3 *****************************************************************************
4 * Copyright (C) 1999-2001 the VideoLAN team
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
27 #include <vlc_fourcc.h>
31 * This file defines the elementary streams format types
39 struct video_palette_t
41 int i_entries; /**< to keep the compatibility with ffmpeg's palette */
42 uint8_t palette[256][4]; /**< 4-byte RGBA/YUVA palette */
46 * audio replay gain description
48 #define AUDIO_REPLAY_GAIN_MAX (2)
49 #define AUDIO_REPLAY_GAIN_TRACK (0)
50 #define AUDIO_REPLAY_GAIN_ALBUM (1)
53 /* true if we have the peak value */
54 bool pb_peak[AUDIO_REPLAY_GAIN_MAX];
55 /* peak value where 1.0 means full sample value */
56 float pf_peak[AUDIO_REPLAY_GAIN_MAX];
58 /* true if we have the gain value */
59 bool pb_gain[AUDIO_REPLAY_GAIN_MAX];
60 /* gain value in dB */
61 float pf_gain[AUDIO_REPLAY_GAIN_MAX];
62 } audio_replay_gain_t;
65 * audio format description
69 vlc_fourcc_t i_format; /**< audio format fourcc */
70 unsigned int i_rate; /**< audio sample-rate */
72 /* Describes the channels configuration of the samples (ie. number of
73 * channels which are available in the buffer, and positions). */
74 uint32_t i_physical_channels;
76 /* Describes from which original channels, before downmixing, the
77 * buffer is derived. */
78 uint32_t i_original_channels;
80 /* Optional - for A/52, SPDIF and DTS types : */
81 /* Bytes used by one compressed frame, depends on bitrate. */
82 unsigned int i_bytes_per_frame;
84 /* Number of sampleframes contained in one compressed frame. */
85 unsigned int i_frame_length;
86 /* Please note that it may be completely arbitrary - buffers are not
87 * obliged to contain a integral number of so-called "frames". It's
88 * just here for the division :
89 * buffer_size = i_nb_samples * i_bytes_per_frame / i_frame_length
92 /* FIXME ? (used by the codecs) */
93 unsigned i_bitspersample;
94 unsigned i_blockalign;
95 uint8_t i_channels; /* must be <=32 */
100 * video format description
102 struct video_format_t
104 vlc_fourcc_t i_chroma; /**< picture chroma */
106 unsigned int i_width; /**< picture width */
107 unsigned int i_height; /**< picture height */
108 unsigned int i_x_offset; /**< start offset of visible area */
109 unsigned int i_y_offset; /**< start offset of visible area */
110 unsigned int i_visible_width; /**< width of visible area */
111 unsigned int i_visible_height; /**< height of visible area */
113 unsigned int i_bits_per_pixel; /**< number of bits per pixel */
115 unsigned int i_sar_num; /**< sample/pixel aspect ratio */
116 unsigned int i_sar_den;
118 unsigned int i_frame_rate; /**< frame rate numerator */
119 unsigned int i_frame_rate_base; /**< frame rate denominator */
121 uint32_t i_rmask, i_gmask, i_bmask; /**< color masks for RGB chroma */
122 int i_rrshift, i_lrshift;
123 int i_rgshift, i_lgshift;
124 int i_rbshift, i_lbshift;
125 video_palette_t *p_palette; /**< video palette from demuxer */
129 * Initialize a video_format_t structure with chroma 'i_chroma'
130 * \param p_src pointer to video_format_t structure
131 * \param i_chroma chroma value to use
133 static inline void video_format_Init( video_format_t *p_src, vlc_fourcc_t i_chroma )
135 memset( p_src, 0, sizeof( video_format_t ) );
136 p_src->i_chroma = i_chroma;
137 p_src->i_sar_num = p_src->i_sar_den = 1;
138 p_src->p_palette = NULL;
142 * Copy video_format_t including the palette
143 * \param p_dst video_format_t to copy to
144 * \param p_src video_format_t to copy from
146 static inline int video_format_Copy( video_format_t *p_dst, const video_format_t *p_src )
148 memcpy( p_dst, p_src, sizeof( *p_dst ) );
149 if( p_src->p_palette )
151 p_dst->p_palette = (video_palette_t *) malloc( sizeof( video_palette_t ) );
152 if( !p_dst->p_palette )
154 memcpy( p_dst->p_palette, p_src->p_palette, sizeof( *p_dst->p_palette ) );
160 * Cleanup and free palette of this video_format_t
161 * \param p_src video_format_t structure to clean
163 static inline void video_format_Clean( video_format_t *p_src )
165 free( p_src->p_palette );
166 memset( p_src, 0, sizeof( video_format_t ) );
167 p_src->p_palette = NULL;
171 * It will fill up a video_format_tvideo_format_t using the given arguments.
172 * Becarefull that the video_format_t must already be initialized.
174 VLC_EXPORT( 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 ) );
177 * This function will check if the first video format is similar
180 VLC_EXPORT( bool, video_format_IsSimilar, ( const video_format_t *, const video_format_t * ) );
183 * subtitles format description
187 /* the character encoding of the text of the subtitle.
188 * all gettext recognized shorts can be used */
192 int i_x_origin; /**< x coordinate of the subtitle. 0 = left */
193 int i_y_origin; /**< y coordinate of the subtitle. 0 = top */
198 uint32_t palette[16+1];
200 /* the width of the original movie the spu was extracted from */
201 int i_original_frame_width;
202 /* the height of the original movie the spu was extracted from */
203 int i_original_frame_height;
218 * ES language definition
220 typedef struct extra_languages_t
223 char *psz_description;
227 * ES format definition
231 int i_cat; /**< ES category @see es_format_category_e */
232 vlc_fourcc_t i_codec; /**< FOURCC value as used in vlc */
233 vlc_fourcc_t i_original_fourcc; /**< original FOURCC from the container */
235 int i_id; /**< es identifier, where means
236 -1: let the core mark the right id
238 int i_group; /**< group identifier, where means:
240 >= 0 then a "group" (program) is created
242 int i_priority; /**< priority, where means:
243 -2 : mean not selectable by the users
244 -1 : mean not selected by default even
248 char *psz_language; /**< human readible language name */
249 char *psz_description; /**< human readible description of language */
250 int i_extra_languages; /**< length in bytes of extra language data pointer */
251 extra_languages_t *p_extra_languages; /**< extra language data needed by some decoders */
253 audio_format_t audio; /**< description of audio format */
254 audio_replay_gain_t audio_replay_gain; /*< audio replay gain information */
255 video_format_t video; /**< description of video format */
256 subs_format_t subs; /**< description of subtitle format */
258 unsigned int i_bitrate; /**< bitrate of this ES */
260 bool b_packetized; /**< wether the data is packetized (ie. not truncated) */
261 int i_extra; /**< length in bytes of extra data pointer */
262 void *p_extra; /**< extra data needed by some decoders or muxers */
267 enum es_format_category_e
277 * This function will fill all RGB shift from RGB masks.
279 VLC_EXPORT( void, video_format_FixRgb, ( video_format_t * ) );
282 * This function will initialize a es_format_t structure.
284 VLC_EXPORT( void, es_format_Init, ( es_format_t *, int i_cat, vlc_fourcc_t i_codec ) );
287 * This function will initialize a es_format_t structure from a video_format_t.
289 VLC_EXPORT( void, es_format_InitFromVideo, ( es_format_t *, const video_format_t * ) );
292 * This functions will copy a es_format_t.
294 VLC_EXPORT( int, es_format_Copy, ( es_format_t *p_dst, const es_format_t *p_src ) );
297 * This function will clean up a es_format_t and relasing all associated
299 * You can call it multiple times on the same structure.
301 VLC_EXPORT( void, es_format_Clean, ( es_format_t *fmt ) );
304 * This function will check if the first ES format is similar
307 * All descriptive fields are ignored.
309 VLC_EXPORT( bool, es_format_IsSimilar, ( const es_format_t *, const es_format_t * ) );