1 /*****************************************************************************
2 * vlc_es.h: Elementary stream formats descriptions
3 *****************************************************************************
4 * Copyright (C) 1999-2012 VLC authors and VideoLAN
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
27 #include <vlc_fourcc.h>
28 #include <vlc_text_style.h>
32 * This file defines the elementary streams format types
40 struct video_palette_t
42 int i_entries; /**< to keep the compatibility with libavcodec's palette */
43 uint8_t palette[256][4]; /**< 4-byte RGBA/YUVA palette */
47 * audio replay gain description
49 #define AUDIO_REPLAY_GAIN_MAX (2)
50 #define AUDIO_REPLAY_GAIN_TRACK (0)
51 #define AUDIO_REPLAY_GAIN_ALBUM (1)
54 /* true if we have the peak value */
55 bool pb_peak[AUDIO_REPLAY_GAIN_MAX];
56 /* peak value where 1.0 means full sample value */
57 float pf_peak[AUDIO_REPLAY_GAIN_MAX];
59 /* true if we have the gain value */
60 bool pb_gain[AUDIO_REPLAY_GAIN_MAX];
61 /* gain value in dB */
62 float pf_gain[AUDIO_REPLAY_GAIN_MAX];
63 } audio_replay_gain_t;
66 * audio format description
70 vlc_fourcc_t i_format; /**< audio format fourcc */
71 unsigned int i_rate; /**< audio sample-rate */
73 /* Describes the channels configuration of the samples (ie. number of
74 * channels which are available in the buffer, and positions). */
75 uint16_t i_physical_channels;
77 /* Describes from which original channels, before downmixing, the
78 * buffer is derived. */
79 uint32_t i_original_channels;
81 /* Optional - for A/52, SPDIF and DTS types : */
82 /* Bytes used by one compressed frame, depends on bitrate. */
83 unsigned int i_bytes_per_frame;
85 /* Number of sampleframes contained in one compressed frame. */
86 unsigned int i_frame_length;
87 /* Please note that it may be completely arbitrary - buffers are not
88 * obliged to contain a integral number of so-called "frames". It's
89 * just here for the division :
90 * buffer_size = i_nb_samples * i_bytes_per_frame / i_frame_length
93 /* FIXME ? (used by the codecs) */
94 unsigned i_bitspersample;
95 unsigned i_blockalign;
96 uint8_t i_channels; /* must be <=32 */
99 /* Values available for audio channels */
100 #define AOUT_CHAN_CENTER 0x1
101 #define AOUT_CHAN_LEFT 0x2
102 #define AOUT_CHAN_RIGHT 0x4
103 #define AOUT_CHAN_REARCENTER 0x10
104 #define AOUT_CHAN_REARLEFT 0x20
105 #define AOUT_CHAN_REARRIGHT 0x40
106 #define AOUT_CHAN_MIDDLELEFT 0x100
107 #define AOUT_CHAN_MIDDLERIGHT 0x200
108 #define AOUT_CHAN_LFE 0x1000
110 #define AOUT_CHANS_FRONT (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)
111 #define AOUT_CHANS_MIDDLE (AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT)
112 #define AOUT_CHANS_REAR (AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT)
113 #define AOUT_CHANS_CENTER (AOUT_CHAN_CENTER | AOUT_CHAN_REARCENTER)
115 #define AOUT_CHANS_STEREO AOUT_CHANS_2_0
116 #define AOUT_CHANS_2_0 (AOUT_CHANS_FRONT)
117 #define AOUT_CHANS_2_1 (AOUT_CHANS_FRONT | AOUT_CHAN_LFE)
118 #define AOUT_CHANS_3_0 (AOUT_CHANS_FRONT | AOUT_CHAN_CENTER)
119 #define AOUT_CHANS_3_1 (AOUT_CHANS_3_0 | AOUT_CHAN_LFE)
120 #define AOUT_CHANS_4_0 (AOUT_CHANS_FRONT | AOUT_CHANS_REAR)
121 #define AOUT_CHANS_4_1 (AOUT_CHANS_4_0 | AOUT_CHAN_LFE)
122 #define AOUT_CHANS_5_0 (AOUT_CHANS_4_0 | AOUT_CHAN_CENTER)
123 #define AOUT_CHANS_5_1 (AOUT_CHANS_5_0 | AOUT_CHAN_LFE)
124 #define AOUT_CHANS_6_0 (AOUT_CHANS_4_0 | AOUT_CHANS_MIDDLE)
125 #define AOUT_CHANS_7_0 (AOUT_CHANS_6_0 | AOUT_CHAN_CENTER)
126 #define AOUT_CHANS_7_1 (AOUT_CHANS_5_1 | AOUT_CHANS_MIDDLE)
127 #define AOUT_CHANS_8_1 (AOUT_CHANS_7_1 | AOUT_CHAN_REARCENTER)
129 #define AOUT_CHANS_4_0_MIDDLE (AOUT_CHANS_FRONT | AOUT_CHANS_MIDDLE)
130 #define AOUT_CHANS_4_CENTER_REAR (AOUT_CHANS_FRONT | AOUT_CHANS_CENTER)
131 #define AOUT_CHANS_5_0_MIDDLE (AOUT_CHANS_4_0_MIDDLE | AOUT_CHAN_CENTER)
132 #define AOUT_CHANS_6_1_MIDDLE (AOUT_CHANS_5_0_MIDDLE | AOUT_CHAN_REARCENTER | AOUT_CHAN_LFE)
134 /* Values available for original channels only */
135 #define AOUT_CHAN_DOLBYSTEREO 0x10000
136 #define AOUT_CHAN_DUALMONO 0x20000
137 #define AOUT_CHAN_REVERSESTEREO 0x40000
139 #define AOUT_CHAN_PHYSMASK 0xFFFF
140 #define AOUT_CHAN_MAX 9
143 * Picture orientation.
145 typedef enum video_orientation_t
147 ORIENT_TOP_LEFT = 0, /**< Top line represents top, left column left. */
148 ORIENT_TOP_RIGHT, /**< Flipped horizontally */
149 ORIENT_BOTTOM_LEFT, /**< Flipped vertically */
150 ORIENT_BOTTOM_RIGHT, /**< Rotated 180 degrees */
151 ORIENT_LEFT_TOP, /**< Transposed */
152 ORIENT_LEFT_BOTTOM, /**< Rotated 90 degrees clockwise */
153 ORIENT_RIGHT_TOP, /**< Rotated 90 degrees anti-clockwise */
154 ORIENT_RIGHT_BOTTOM, /**< Anti-transposed */
156 ORIENT_NORMAL = ORIENT_TOP_LEFT,
157 ORIENT_TRANSPOSED = ORIENT_LEFT_TOP,
158 ORIENT_ANTI_TRANSPOSED = ORIENT_RIGHT_BOTTOM,
159 ORIENT_HFLIPPED = ORIENT_TOP_RIGHT,
160 ORIENT_VFLIPPED = ORIENT_BOTTOM_LEFT,
161 ORIENT_ROTATED_180 = ORIENT_BOTTOM_RIGHT,
162 ORIENT_ROTATED_270 = ORIENT_LEFT_BOTTOM,
163 ORIENT_ROTATED_90 = ORIENT_RIGHT_TOP,
164 } video_orientation_t;
165 /** Convert EXIF orientation to enum video_orientation_t */
166 #define ORIENT_FROM_EXIF(exif) ((0x01324675U >> (4 * ((exif) - 1))) & 7)
167 /** Convert enum video_orientation_t to EXIF */
168 #define ORIENT_TO_EXIF(orient) ((0x12435867U >> (4 * (orient))) & 15)
169 /** If the orientation is natural or mirrored */
170 #define ORIENT_IS_MIRROR(orient) parity(orient)
171 /** If the orientation swaps dimensions */
172 #define ORIENT_IS_SWAP(orient) (((orient) & 4) != 0)
173 /** Applies horizontal flip to an orientation */
174 #define ORIENT_HFLIP(orient) ((orient) ^ 1)
175 /** Applies vertical flip to an orientation */
176 #define ORIENT_VFLIP(orient) ((orient) ^ 2)
177 /** Applies horizontal flip to an orientation */
178 #define ORIENT_ROTATE_180(orient) ((orient) ^ 3)
180 typedef enum video_transform_t
182 TRANSFORM_IDENTITY = ORIENT_NORMAL,
183 TRANSFORM_HFLIP = ORIENT_HFLIPPED,
184 TRANSFORM_VFLIP = ORIENT_VFLIPPED,
185 TRANSFORM_R180 = ORIENT_ROTATED_180,
186 TRANSFORM_R270 = ORIENT_ROTATED_270,
187 TRANSFORM_R90 = ORIENT_ROTATED_90,
188 TRANSFORM_TRANSPOSE = ORIENT_TRANSPOSED,
189 TRANSFORM_ANTI_TRANSPOSE = ORIENT_ANTI_TRANSPOSED
193 * video format description
195 struct video_format_t
197 vlc_fourcc_t i_chroma; /**< picture chroma */
199 unsigned int i_width; /**< picture width */
200 unsigned int i_height; /**< picture height */
201 unsigned int i_x_offset; /**< start offset of visible area */
202 unsigned int i_y_offset; /**< start offset of visible area */
203 unsigned int i_visible_width; /**< width of visible area */
204 unsigned int i_visible_height; /**< height of visible area */
206 unsigned int i_bits_per_pixel; /**< number of bits per pixel */
208 unsigned int i_sar_num; /**< sample/pixel aspect ratio */
209 unsigned int i_sar_den;
211 unsigned int i_frame_rate; /**< frame rate numerator */
212 unsigned int i_frame_rate_base; /**< frame rate denominator */
214 uint32_t i_rmask, i_gmask, i_bmask; /**< color masks for RGB chroma */
215 int i_rrshift, i_lrshift;
216 int i_rgshift, i_lgshift;
217 int i_rbshift, i_lbshift;
218 video_palette_t *p_palette; /**< video palette from demuxer */
219 video_orientation_t orientation; /**< picture orientation */
223 * Initialize a video_format_t structure with chroma 'i_chroma'
224 * \param p_src pointer to video_format_t structure
225 * \param i_chroma chroma value to use
227 static inline void video_format_Init( video_format_t *p_src, vlc_fourcc_t i_chroma )
229 memset( p_src, 0, sizeof( video_format_t ) );
230 p_src->i_chroma = i_chroma;
231 p_src->i_sar_num = p_src->i_sar_den = 1;
232 p_src->p_palette = NULL;
236 * Copy video_format_t including the palette
237 * \param p_dst video_format_t to copy to
238 * \param p_src video_format_t to copy from
240 static inline int video_format_Copy( video_format_t *p_dst, const video_format_t *p_src )
242 memcpy( p_dst, p_src, sizeof( *p_dst ) );
243 if( p_src->p_palette )
245 p_dst->p_palette = (video_palette_t *) malloc( sizeof( video_palette_t ) );
246 if( !p_dst->p_palette )
248 memcpy( p_dst->p_palette, p_src->p_palette, sizeof( *p_dst->p_palette ) );
254 * Cleanup and free palette of this video_format_t
255 * \param p_src video_format_t structure to clean
257 static inline void video_format_Clean( video_format_t *p_src )
259 free( p_src->p_palette );
260 memset( p_src, 0, sizeof( video_format_t ) );
261 p_src->p_palette = NULL;
265 * It will fill up a video_format_t using the given arguments.
266 * Note that the video_format_t must already be initialized.
268 VLC_API void video_format_Setup( video_format_t *, vlc_fourcc_t i_chroma,
269 int i_width, int i_height, int i_visible_width, int i_visible_height,
270 int i_sar_num, int i_sar_den );
273 * It will copy the crop properties from a video_format_t to another.
275 VLC_API void video_format_CopyCrop( video_format_t *, const video_format_t * );
278 * It will compute the crop/ar properties when scaling.
280 VLC_API void video_format_ScaleCropAr( video_format_t *, const video_format_t * );
283 * This function "normalizes" the formats orientation, by switching the a/r according to the orientation,
284 * producing a format whose orientation is ORIENT_NORMAL. It makes a shallow copy (pallette is not alloc'ed).
286 VLC_API void video_format_ApplyRotation(video_format_t *restrict out, const video_format_t *restrict in);
289 * This function applies the transform operation to fmt.
291 VLC_API void video_format_TransformBy(video_format_t *fmt, video_transform_t transform);
294 * This function applies the transforms necessary to fmt so that the resulting fmt
295 * has the dst_orientation.
297 VLC_API void video_format_TransformTo(video_format_t *fmt, video_orientation_t dst_orientation);
300 * Returns the operation required to transform src into dst.
302 VLC_API video_transform_t video_format_GetTransform(video_orientation_t src, video_orientation_t dst);
305 * This function will check if the first video format is similar
308 VLC_API bool video_format_IsSimilar( const video_format_t *, const video_format_t * );
311 * It prints details about the given video_format_t
313 VLC_API void video_format_Print( vlc_object_t *, const char *, const video_format_t * );
316 static inline video_transform_t transform_Inverse( video_transform_t transform )
318 switch ( transform ) {
320 return TRANSFORM_R270;
322 return TRANSFORM_R90;
328 * subtitles format description
332 /* the character encoding of the text of the subtitle.
333 * all gettext recognized shorts can be used */
337 int i_x_origin; /**< x coordinate of the subtitle. 0 = left */
338 int i_y_origin; /**< y coordinate of the subtitle. 0 = top */
343 uint32_t palette[16+1];
345 /* the width of the original movie the spu was extracted from */
346 int i_original_frame_width;
347 /* the height of the original movie the spu was extracted from */
348 int i_original_frame_height;
361 text_style_t *p_style; /* Default styles to use */
365 * ES language definition
367 typedef struct extra_languages_t
370 char *psz_description;
374 * ES format definition
376 #define ES_PRIORITY_NOT_SELECTABLE -2
377 #define ES_PRIORITY_NOT_DEFAULTABLE -1
378 #define ES_PRIORITY_SELECTABLE_MIN 0
379 #define ES_PRIORITY_MIN ES_PRIORITY_NOT_SELECTABLE
382 int i_cat; /**< ES category @see es_format_category_e */
383 vlc_fourcc_t i_codec; /**< FOURCC value as used in vlc */
384 vlc_fourcc_t i_original_fourcc; /**< original FOURCC from the container */
386 int i_id; /**< es identifier, where means
387 -1: let the core mark the right id
389 int i_group; /**< group identifier, where means:
391 >= 0 then a "group" (program) is created
393 int i_priority; /**< priority, where means:
394 -2 : mean not selectable by the users
395 -1 : mean not selected by default even
399 char *psz_language; /**< human readible language name */
400 char *psz_description; /**< human readible description of language */
401 int i_extra_languages; /**< length in bytes of extra language data pointer */
402 extra_languages_t *p_extra_languages; /**< extra language data needed by some decoders */
404 audio_format_t audio; /**< description of audio format */
405 audio_replay_gain_t audio_replay_gain; /*< audio replay gain information */
406 video_format_t video; /**< description of video format */
407 subs_format_t subs; /**< description of subtitle format */
409 unsigned int i_bitrate; /**< bitrate of this ES */
410 int i_profile; /**< codec specific information (like real audio flavor, mpeg audio layer, h264 profile ...) */
411 int i_level; /**< codec specific information: indicates maximum restrictions on the stream (resolution, bitrate, codec features ...) */
413 bool b_packetized; /**< whether the data is packetized (ie. not truncated) */
414 int i_extra; /**< length in bytes of extra data pointer */
415 void *p_extra; /**< extra data needed by some decoders or muxers */
420 enum es_format_category_e
430 * This function will fill all RGB shift from RGB masks.
432 VLC_API void video_format_FixRgb( video_format_t * );
435 * This function will initialize a es_format_t structure.
437 VLC_API void es_format_Init( es_format_t *, int i_cat, vlc_fourcc_t i_codec );
440 * This function will initialize a es_format_t structure from a video_format_t.
442 VLC_API void es_format_InitFromVideo( es_format_t *, const video_format_t * );
445 * This functions will copy a es_format_t.
447 VLC_API int es_format_Copy( es_format_t *p_dst, const es_format_t *p_src );
450 * This function will clean up a es_format_t and release all associated
452 * You can call it multiple times on the same structure.
454 VLC_API void es_format_Clean( es_format_t *fmt );
457 * This function will check if the first ES format is similar
460 * All descriptive fields are ignored.
462 VLC_API bool es_format_IsSimilar( const es_format_t *, const es_format_t * );