Signedness fix
[vlc.git] / include / vlc_es.h
blobd020d134ac7442f0568b5a67edc70b2220190c6e
1 /*****************************************************************************
2 * vlc_es.h: Elementary stream formats descriptions
3 *****************************************************************************
4 * Copyright (C) 1999-2001 the VideoLAN team
5 * $Id$
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 *****************************************************************************/
24 #ifndef _VLC_ES_H
25 #define _VLC_ES_H 1
27 /* FIXME: i'm not too sure about this include but it fixes compilation of
28 * video chromas -- dionoea */
29 #include "vlc_common.h"
31 /**
32 * \file
33 * This file defines the elementary streams format types
36 /**
37 * video palette data
38 * \see video_format_t
39 * \see subs_format_t
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 */
47 /**
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)
53 typedef struct
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;
66 /**
67 * audio format description
69 struct audio_format_t
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 */
98 uint8_t i_flavor;
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')
104 #else
105 # define AUDIO_FMT_S16_NE VLC_FOURCC('s','1','6','l')
106 # define AUDIO_FMT_U16_NE VLC_FOURCC('u','1','6','l')
107 #endif
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 * subtitles format description
142 struct subs_format_t
144 /* the character encoding of the text of the subtitle.
145 * all gettext recognized shorts can be used */
146 char *psz_encoding;
149 int i_x_origin; /**< x coordinate of the subtitle. 0 = left */
150 int i_y_origin; /**< y coordinate of the subtitle. 0 = top */
152 struct
154 /* */
155 uint32_t palette[16+1];
157 /* the width of the original movie the spu was extracted from */
158 int i_original_frame_width;
159 /* the height of the original movie the spu was extracted from */
160 int i_original_frame_height;
161 } spu;
163 struct
165 int i_id;
166 } dvb;
170 * ES definition
172 typedef struct extra_languages_t
174 char *psz_language;
175 char *psz_description;
176 } extra_languages_t;
179 struct es_format_t
181 int i_cat;
182 vlc_fourcc_t i_codec;
184 int i_id; /* -1: let the core mark the right id
185 >=0: valid id */
186 int i_group; /* -1 : standalone
187 >= 0 then a "group" (program) is created
188 for each value */
189 int i_priority; /* -2 : mean not selectable by the users
190 -1 : mean not selected by default even
191 when no other stream
192 >=0: priority */
194 char *psz_language;
195 char *psz_description;
196 int i_extra_languages;
197 extra_languages_t *p_extra_languages;
199 audio_format_t audio;
200 audio_replay_gain_t audio_replay_gain;
201 video_format_t video;
202 subs_format_t subs;
204 unsigned int i_bitrate;
206 bool b_packetized; /* wether the data is packetized
207 (ie. not truncated) */
208 int i_extra;
209 void *p_extra;
213 /* ES Categories */
214 #define UNKNOWN_ES 0x00
215 #define VIDEO_ES 0x01
216 #define AUDIO_ES 0x02
217 #define SPU_ES 0x03
218 #define NAV_ES 0x04
220 static inline void es_format_Init( es_format_t *fmt,
221 int i_cat, vlc_fourcc_t i_codec )
223 fmt->i_cat = i_cat;
224 fmt->i_codec = i_codec;
225 fmt->i_id = -1;
226 fmt->i_group = 0;
227 fmt->i_priority = 0;
228 fmt->psz_language = NULL;
229 fmt->psz_description = NULL;
231 fmt->i_extra_languages = 0;
232 fmt->p_extra_languages = NULL;
234 memset( &fmt->audio, 0, sizeof(audio_format_t) );
235 memset( &fmt->audio_replay_gain, 0, sizeof(audio_replay_gain_t) );
236 memset( &fmt->video, 0, sizeof(video_format_t) );
237 memset( &fmt->subs, 0, sizeof(subs_format_t) );
239 fmt->b_packetized = true;
240 fmt->i_bitrate = 0;
241 fmt->i_extra = 0;
242 fmt->p_extra = NULL;
245 static inline int es_format_Copy( es_format_t *dst, const es_format_t *src )
247 int i;
248 memcpy( dst, src, sizeof( es_format_t ) );
249 if( src->psz_language )
250 dst->psz_language = strdup( src->psz_language );
251 if( src->psz_description )
252 dst->psz_description = strdup( src->psz_description );
253 if( src->i_extra > 0 )
255 dst->i_extra = src->i_extra;
256 dst->p_extra = malloc( src->i_extra );
257 memcpy( dst->p_extra, src->p_extra, src->i_extra );
259 else
261 dst->i_extra = 0;
262 dst->p_extra = NULL;
265 if( src->subs.psz_encoding )
266 dst->subs.psz_encoding = strdup( src->subs.psz_encoding );
268 if( src->video.p_palette )
270 dst->video.p_palette =
271 (video_palette_t*)malloc( sizeof( video_palette_t ) );
272 memcpy( dst->video.p_palette, src->video.p_palette,
273 sizeof( video_palette_t ) );
276 dst->i_extra_languages = src->i_extra_languages;
277 if( dst->i_extra_languages )
278 dst->p_extra_languages = (extra_languages_t*)
279 malloc(dst->i_extra_languages * sizeof(*dst->p_extra_languages ));
280 for( i = 0; i < dst->i_extra_languages; i++ ) {
281 if( src->p_extra_languages[i].psz_language )
282 dst->p_extra_languages[i].psz_language = strdup( src->p_extra_languages[i].psz_language );
283 else
284 dst->p_extra_languages[i].psz_language = NULL;
285 if( src->p_extra_languages[i].psz_description )
286 dst->p_extra_languages[i].psz_description = strdup( src->p_extra_languages[i].psz_description );
287 else
288 dst->p_extra_languages[i].psz_description = NULL;
290 return VLC_SUCCESS;
293 static inline void es_format_Clean( es_format_t *fmt )
295 free( fmt->psz_language );
296 free( fmt->psz_description );
298 if( fmt->i_extra > 0 ) free( fmt->p_extra );
300 free( fmt->video.p_palette );
301 free( fmt->subs.psz_encoding );
303 if( fmt->i_extra_languages > 0 && fmt->p_extra_languages )
305 int i;
306 for( i = 0; i < fmt->i_extra_languages; i++ )
308 free( fmt->p_extra_languages[i].psz_language );
309 free( fmt->p_extra_languages[i].psz_description );
311 free( fmt->p_extra_languages );
314 /* es_format_Clean can be called multiple times */
315 memset( fmt, 0, sizeof(*fmt) );
317 #endif