1 /*****************************************************************************
2 * vlc_es.h: Elementary stream formats descriptions
3 *****************************************************************************
4 * Copyright (C) 1999-2001 VideoLAN
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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
29 * This file defines the elementary streams format types
37 struct video_palette_t
39 int i_entries; /**< to keep the compatibility with ffmpeg's palette */
40 uint8_t palette[256][4]; /**< 4-byte RGBA/YUVA palette */
44 * audio format description
48 vlc_fourcc_t i_format; /**< audio format fourcc */
49 unsigned int i_rate; /**< audio sample-rate */
51 /* Describes the channels configuration of the samples (ie. number of
52 * channels which are available in the buffer, and positions). */
53 uint32_t i_physical_channels;
55 /* Describes from which original channels, before downmixing, the
56 * buffer is derived. */
57 uint32_t i_original_channels;
59 /* Optional - for A/52, SPDIF and DTS types : */
60 /* Bytes used by one compressed frame, depends on bitrate. */
61 unsigned int i_bytes_per_frame;
63 /* Number of sampleframes contained in one compressed frame. */
64 unsigned int i_frame_length;
65 /* Please note that it may be completely arbitrary - buffers are not
66 * obliged to contain a integral number of so-called "frames". It's
67 * just here for the division :
68 * buffer_size = i_nb_samples * i_bytes_per_frame / i_frame_length
71 /* FIXME ? (used by the codecs) */
77 #ifdef WORDS_BIGENDIAN
78 # define AUDIO_FMT_S16_NE VLC_FOURCC('s','1','6','b')
79 # define AUDIO_FMT_U16_NE VLC_FOURCC('u','1','6','b')
81 # define AUDIO_FMT_S16_NE VLC_FOURCC('s','1','6','l')
82 # define AUDIO_FMT_U16_NE VLC_FOURCC('u','1','6','l')
86 * video format description
90 vlc_fourcc_t i_chroma; /**< picture chroma */
91 unsigned int i_aspect; /**< aspect ratio */
93 unsigned int i_width; /**< picture width */
94 unsigned int i_height; /**< picture height */
95 unsigned int i_x_offset; /**< start offset of visible area */
96 unsigned int i_y_offset; /**< start offset of visible area */
97 unsigned int i_visible_width; /**< width of visible area */
98 unsigned int i_visible_height; /**< height of visible area */
100 unsigned int i_bits_per_pixel; /**< number of bits per pixel */
102 unsigned int i_sar_num; /**< sample/pixel aspect ratio */
103 unsigned int i_sar_den;
105 unsigned int i_frame_rate; /**< frame rate numerator */
106 unsigned int i_frame_rate_base; /**< frame rate denominator */
108 int i_rmask, i_gmask, i_bmask; /**< color masks for RGB chroma */
109 video_palette_t *p_palette; /**< video palette from demuxer */
113 * subtitles format description
117 /* the character encoding of the text of the subtitle.
118 * all gettext recognized shorts can be used */
122 int i_x_origin; /**< x coordinate of the subtitle. 0 = left */
123 int i_y_origin; /**< y coordinate of the subtitle. 0 = top */
128 uint32_t palette[16+1];
130 /* the width of the original movie the spu was extracted from */
131 int i_original_frame_width;
132 /* the height of the original movie the spu was extracted from */
133 int i_original_frame_height;
148 vlc_fourcc_t i_codec;
150 int i_id; /* -1: let the core mark the right id
152 int i_group; /* -1 : standalone
153 >= 0 then a "group" (program) is created
155 int i_priority; /* -2 : mean not selectable by the users
156 -1 : mean not selected by default even
160 char *psz_description;
162 audio_format_t audio;
163 video_format_t video;
168 vlc_bool_t b_packetized; /* wether the data is packetized
169 (ie. not truncated) */
176 #define UNKNOWN_ES 0x00
177 #define VIDEO_ES 0x01
178 #define AUDIO_ES 0x02
182 static inline void es_format_Init( es_format_t *fmt,
183 int i_cat, vlc_fourcc_t i_codec )
186 fmt->i_codec = i_codec;
190 fmt->psz_language = NULL;
191 fmt->psz_description = NULL;
193 memset( &fmt->audio, 0, sizeof(audio_format_t) );
194 memset( &fmt->video, 0, sizeof(video_format_t) );
195 memset( &fmt->subs, 0, sizeof(subs_format_t) );
197 fmt->b_packetized = VLC_TRUE;
203 static inline void es_format_Copy( es_format_t *dst, es_format_t *src )
205 memcpy( dst, src, sizeof( es_format_t ) );
206 if( src->psz_language )
207 dst->psz_language = strdup( src->psz_language );
208 if( src->psz_description )
209 dst->psz_description = strdup( src->psz_description );
210 if( src->i_extra > 0 )
212 dst->i_extra = src->i_extra;
213 dst->p_extra = malloc( src->i_extra );
214 memcpy( dst->p_extra, src->p_extra, src->i_extra );
222 if( src->subs.psz_encoding )
223 dst->subs.psz_encoding = strdup( src->subs.psz_encoding );
225 if( src->video.p_palette )
227 dst->video.p_palette =
228 (video_palette_t*)malloc( sizeof( video_palette_t ) );
229 memcpy( dst->video.p_palette, src->video.p_palette,
230 sizeof( video_palette_t ) );
234 static inline void es_format_Clean( es_format_t *fmt )
236 if( fmt->psz_language ) free( fmt->psz_language );
237 fmt->psz_language = NULL;
239 if( fmt->psz_description ) free( fmt->psz_description );
240 fmt->psz_description = NULL;
242 if( fmt->i_extra > 0 ) free( fmt->p_extra );
243 fmt->i_extra = 0; fmt->p_extra = NULL;
245 if( fmt->video.p_palette ) free( fmt->video.p_palette );
246 fmt->video.p_palette = NULL;
248 if( fmt->subs.psz_encoding ) free( fmt->subs.psz_encoding );
249 fmt->subs.psz_encoding = NULL;