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 /* FIXME: i'm not too sure about this include but it fixes compilation of
28 * video chromas -- dionoea */
29 #include "vlc_common.h"
30 #include <vlc_fourcc.h>
34 * This file defines the elementary streams format types
42 struct video_palette_t
44 int i_entries; /**< to keep the compatibility with ffmpeg's palette */
45 uint8_t palette[256][4]; /**< 4-byte RGBA/YUVA palette */
49 * audio replay gain description
51 #define AUDIO_REPLAY_GAIN_MAX (2)
52 #define AUDIO_REPLAY_GAIN_TRACK (0)
53 #define AUDIO_REPLAY_GAIN_ALBUM (1)
56 /* true if we have the peak value */
57 bool pb_peak[AUDIO_REPLAY_GAIN_MAX];
58 /* peak value where 1.0 means full sample value */
59 float pf_peak[AUDIO_REPLAY_GAIN_MAX];
61 /* true if we have the gain value */
62 bool pb_gain[AUDIO_REPLAY_GAIN_MAX];
63 /* gain value in dB */
64 float pf_gain[AUDIO_REPLAY_GAIN_MAX];
65 } audio_replay_gain_t;
68 * audio format description
72 vlc_fourcc_t i_format; /**< audio format fourcc */
73 unsigned int i_rate; /**< audio sample-rate */
75 /* Describes the channels configuration of the samples (ie. number of
76 * channels which are available in the buffer, and positions). */
77 uint32_t i_physical_channels;
79 /* Describes from which original channels, before downmixing, the
80 * buffer is derived. */
81 uint32_t i_original_channels;
83 /* Optional - for A/52, SPDIF and DTS types : */
84 /* Bytes used by one compressed frame, depends on bitrate. */
85 unsigned int i_bytes_per_frame;
87 /* Number of sampleframes contained in one compressed frame. */
88 unsigned int i_frame_length;
89 /* Please note that it may be completely arbitrary - buffers are not
90 * obliged to contain a integral number of so-called "frames". It's
91 * just here for the division :
92 * buffer_size = i_nb_samples * i_bytes_per_frame / i_frame_length
95 /* FIXME ? (used by the codecs) */
96 unsigned i_bitspersample;
97 unsigned i_blockalign;
98 uint8_t i_channels; /* must be <=32 */
102 #define AUDIO_FMT_S16_NE VLC_CODEC_S16N
103 #define AUDIO_FMT_U16_NE VLC_CODEC_U16N
106 * video format description
108 struct video_format_t
110 vlc_fourcc_t i_chroma; /**< picture chroma */
111 unsigned int i_aspect; /**< aspect ratio */
113 unsigned int i_width; /**< picture width */
114 unsigned int i_height; /**< picture height */
115 unsigned int i_x_offset; /**< start offset of visible area */
116 unsigned int i_y_offset; /**< start offset of visible area */
117 unsigned int i_visible_width; /**< width of visible area */
118 unsigned int i_visible_height; /**< height of visible area */
120 unsigned int i_bits_per_pixel; /**< number of bits per pixel */
122 unsigned int i_sar_num; /**< sample/pixel aspect ratio */
123 unsigned int i_sar_den;
125 unsigned int i_frame_rate; /**< frame rate numerator */
126 unsigned int i_frame_rate_base; /**< frame rate denominator */
128 int i_rmask, i_gmask, i_bmask; /**< color masks for RGB chroma */
129 int i_rrshift, i_lrshift;
130 int i_rgshift, i_lgshift;
131 int i_rbshift, i_lbshift;
132 video_palette_t *p_palette; /**< video palette from demuxer */
136 * Initialize a video_format_t structure with chroma 'i_chroma'
137 * \param p_src pointer to video_format_t structure
138 * \param i_chroma chroma value to use
140 static inline void video_format_Init( video_format_t *p_src, vlc_fourcc_t i_chroma )
142 memset( p_src, 0, sizeof( video_format_t ) );
143 p_src->i_chroma = i_chroma;
144 p_src->i_sar_num = p_src->i_sar_den = 1;
145 p_src->p_palette = NULL;
149 * Copy video_format_t including the palette
150 * \param p_dst video_format_t to copy to
151 * \param p_src video_format_t to copy from
153 static inline int video_format_Copy( video_format_t *p_dst, video_format_t *p_src )
155 memcpy( p_dst, p_src, sizeof( video_format_t ) );
156 if( p_src->p_palette )
158 p_dst->p_palette = (video_palette_t *) malloc( sizeof( video_palette_t ) );
159 if( !p_dst->p_palette )
161 memcpy( p_dst->p_palette, p_src->p_palette, sizeof( video_palette_t ) );
167 * Cleanup and free palette of this video_format_t
168 * \param p_src video_format_t structure to clean
170 static inline void video_format_Clean( video_format_t *p_src )
172 free( p_src->p_palette );
173 memset( p_src, 0, sizeof( video_format_t ) );
174 p_src->p_palette = NULL;
178 * subtitles format description
182 /* the character encoding of the text of the subtitle.
183 * all gettext recognized shorts can be used */
187 int i_x_origin; /**< x coordinate of the subtitle. 0 = left */
188 int i_y_origin; /**< y coordinate of the subtitle. 0 = top */
193 uint32_t palette[16+1];
195 /* the width of the original movie the spu was extracted from */
196 int i_original_frame_width;
197 /* the height of the original movie the spu was extracted from */
198 int i_original_frame_height;
213 * ES language definition
215 typedef struct extra_languages_t
218 char *psz_description;
222 * ES format definition
226 int i_cat; /**< ES category @see es_format_category_e */
227 vlc_fourcc_t i_codec; /**< FOURCC value as used in vlc */
228 vlc_fourcc_t i_original_fourcc; /**< original FOURCC from the container */
230 int i_id; /**< es identifier, where means
231 -1: let the core mark the right id
233 int i_group; /**< group identifier, where means:
235 >= 0 then a "group" (program) is created
237 int i_priority; /**< priority, where means:
238 -2 : mean not selectable by the users
239 -1 : mean not selected by default even
243 char *psz_language; /**< human readible language name */
244 char *psz_description; /**< human readible description of language */
245 int i_extra_languages; /**< length in bytes of extra language data pointer */
246 extra_languages_t *p_extra_languages; /**< extra language data needed by some decoders */
248 audio_format_t audio; /**< description of audio format */
249 audio_replay_gain_t audio_replay_gain; /*< audio replay gain information */
250 video_format_t video; /**< description of video format */
251 subs_format_t subs; /**< description of subtitle format */
253 unsigned int i_bitrate; /**< bitrate of this ES */
255 bool b_packetized; /**< wether the data is packetized (ie. not truncated) */
256 int i_extra; /**< length in bytes of extra data pointer */
257 void *p_extra; /**< extra data needed by some decoders or muxers */
262 enum es_format_category_e
272 * This function will fill all RGB shift from RGB masks.
274 VLC_EXPORT( void, video_format_FixRgb, ( video_format_t * ) );
277 * This funtion will initialize a es_format_t structure.
279 VLC_EXPORT( void, es_format_Init, ( es_format_t *, int i_cat, vlc_fourcc_t i_codec ) );
282 * This functions will copy a es_format_t.
284 VLC_EXPORT( int, es_format_Copy, ( es_format_t *p_dst, const es_format_t *p_src ) );
287 * This function will clean up a es_format_t and relasing all associated
289 * You can call it multiple times on the same structure.
291 VLC_EXPORT( void, es_format_Clean, ( es_format_t *fmt ) );