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"
33 * This file defines the elementary streams format types
41 struct video_palette_t
43 int i_entries; /**< to keep the compatibility with ffmpeg's palette */
44 uint8_t palette[256][4]; /**< 4-byte RGBA/YUVA palette */
48 * audio replay gain description
50 #define AUDIO_REPLAY_GAIN_MAX (2)
51 #define AUDIO_REPLAY_GAIN_TRACK (0)
52 #define AUDIO_REPLAY_GAIN_ALBUM (1)
55 /* true if we have the peak value */
56 bool pb_peak[AUDIO_REPLAY_GAIN_MAX];
57 /* peak value where 1.0 means full sample value */
58 float pf_peak[AUDIO_REPLAY_GAIN_MAX];
60 /* true if we have the gain value */
61 bool pb_gain[AUDIO_REPLAY_GAIN_MAX];
62 /* gain value in dB */
63 float pf_gain[AUDIO_REPLAY_GAIN_MAX];
64 } audio_replay_gain_t;
67 * audio format description
71 vlc_fourcc_t i_format; /**< audio format fourcc */
72 unsigned int i_rate; /**< audio sample-rate */
74 /* Describes the channels configuration of the samples (ie. number of
75 * channels which are available in the buffer, and positions). */
76 uint32_t i_physical_channels;
78 /* Describes from which original channels, before downmixing, the
79 * buffer is derived. */
80 uint32_t i_original_channels;
82 /* Optional - for A/52, SPDIF and DTS types : */
83 /* Bytes used by one compressed frame, depends on bitrate. */
84 unsigned int i_bytes_per_frame;
86 /* Number of sampleframes contained in one compressed frame. */
87 unsigned int i_frame_length;
88 /* Please note that it may be completely arbitrary - buffers are not
89 * obliged to contain a integral number of so-called "frames". It's
90 * just here for the division :
91 * buffer_size = i_nb_samples * i_bytes_per_frame / i_frame_length
94 /* FIXME ? (used by the codecs) */
95 unsigned i_bitspersample;
96 unsigned i_blockalign;
97 uint8_t i_channels; /* must be <=32 */
101 #ifdef WORDS_BIGENDIAN
102 # define AUDIO_FMT_S16_NE VLC_FOURCC('s','1','6','b')
103 # define AUDIO_FMT_U16_NE VLC_FOURCC('u','1','6','b')
105 # define AUDIO_FMT_S16_NE VLC_FOURCC('s','1','6','l')
106 # define AUDIO_FMT_U16_NE VLC_FOURCC('u','1','6','l')
110 * video format description
112 struct video_format_t
114 vlc_fourcc_t i_chroma; /**< picture chroma */
115 unsigned int i_aspect; /**< aspect ratio */
117 unsigned int i_width; /**< picture width */
118 unsigned int i_height; /**< picture height */
119 unsigned int i_x_offset; /**< start offset of visible area */
120 unsigned int i_y_offset; /**< start offset of visible area */
121 unsigned int i_visible_width; /**< width of visible area */
122 unsigned int i_visible_height; /**< height of visible area */
124 unsigned int i_bits_per_pixel; /**< number of bits per pixel */
126 unsigned int i_sar_num; /**< sample/pixel aspect ratio */
127 unsigned int i_sar_den;
129 unsigned int i_frame_rate; /**< frame rate numerator */
130 unsigned int i_frame_rate_base; /**< frame rate denominator */
132 int i_rmask, i_gmask, i_bmask; /**< color masks for RGB chroma */
133 int i_rrshift, i_lrshift;
134 int i_rgshift, i_lgshift;
135 int i_rbshift, i_lbshift;
136 video_palette_t *p_palette; /**< video palette from demuxer */
140 * Initialize a video_format_t structure with chroma 'i_chroma'
141 * \param p_src pointer to video_format_t structure
142 * \param i_chroma chroma value to use
144 static inline void video_format_Init( video_format_t *p_src, vlc_fourcc_t i_chroma )
146 memset( p_src, 0, sizeof( video_format_t ) );
147 p_src->i_chroma = i_chroma;
148 p_src->i_sar_num = p_src->i_sar_den = 1;
149 p_src->p_palette = NULL;
153 * Copy video_format_t including the palette
154 * \param p_dst video_format_t to copy to
155 * \param p_src video_format_t to copy from
157 static inline int video_format_Copy( video_format_t *p_dst, video_format_t *p_src )
159 memcpy( p_dst, p_src, sizeof( video_format_t ) );
160 if( p_src->p_palette )
162 p_dst->p_palette = (video_palette_t *) malloc( sizeof( video_palette_t ) );
163 if( !p_dst->p_palette )
165 memcpy( p_dst->p_palette, p_src->p_palette, sizeof( video_palette_t ) );
171 * Cleanup and free palette of this video_format_t
172 * \param p_src video_format_t structure to clean
174 static inline void video_format_Clean( video_format_t *p_src )
176 free( p_src->p_palette );
177 memset( p_src, 0, sizeof( video_format_t ) );
178 p_src->p_palette = NULL;
182 * subtitles format description
186 /* the character encoding of the text of the subtitle.
187 * all gettext recognized shorts can be used */
191 int i_x_origin; /**< x coordinate of the subtitle. 0 = left */
192 int i_y_origin; /**< y coordinate of the subtitle. 0 = top */
197 uint32_t palette[16+1];
199 /* the width of the original movie the spu was extracted from */
200 int i_original_frame_width;
201 /* the height of the original movie the spu was extracted from */
202 int i_original_frame_height;
217 * ES language definition
219 typedef struct extra_languages_t
222 char *psz_description;
226 * ES format definition
230 int i_cat; /**< ES category @see es_format_category_e */
231 vlc_fourcc_t i_codec; /**< FOURCC value as used in vlc */
233 int i_id; /**< es identifier, where means
234 -1: let the core mark the right id
236 int i_group; /**< group identifier, where means:
238 >= 0 then a "group" (program) is created
240 int i_priority; /**< priority, where means:
241 -2 : mean not selectable by the users
242 -1 : mean not selected by default even
246 char *psz_language; /**< human readible language name */
247 char *psz_description; /**< human readible description of language */
248 int i_extra_languages; /**< length in bytes of extra language data pointer */
249 extra_languages_t *p_extra_languages; /**< extra language data needed by some decoders */
251 audio_format_t audio; /**< description of audio format */
252 audio_replay_gain_t audio_replay_gain; /*< audio replay gain information */
253 video_format_t video; /**< description of video format */
254 subs_format_t subs; /**< description of subtitle format */
256 unsigned int i_bitrate; /**< bitrate of this ES */
258 bool b_packetized; /**< wether the data is packetized (ie. not truncated) */
259 int i_extra; /**< length in bytes of extra data pointer */
260 void *p_extra; /**< extra data needed by some decoders or muxers */
265 enum es_format_category_e
275 * This function will fill all RGB shift from RGB masks.
277 VLC_EXPORT( void, video_format_FixRgb, ( video_format_t * ) );
280 * This funtion will initialize a es_format_t structure.
282 VLC_EXPORT( void, es_format_Init, ( es_format_t *, int i_cat, vlc_fourcc_t i_codec ) );
285 * This functions will copy a es_format_t.
287 VLC_EXPORT( int, es_format_Copy, ( es_format_t *p_dst, const es_format_t *p_src ) );
290 * This function will clean up a es_format_t and relasing all associated
292 * You can call it multiple times on the same structure.
294 VLC_EXPORT( void, es_format_Clean, ( es_format_t *fmt ) );