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>
31 * This file defines the elementary streams format types
39 struct video_palette_t
41 int i_entries
; /**< to keep the compatibility with ffmpeg's palette */
42 uint8_t palette
[256][4]; /**< 4-byte RGBA/YUVA palette */
46 * audio replay gain description
48 #define AUDIO_REPLAY_GAIN_MAX (2)
49 #define AUDIO_REPLAY_GAIN_TRACK (0)
50 #define AUDIO_REPLAY_GAIN_ALBUM (1)
53 /* true if we have the peak value */
54 bool pb_peak
[AUDIO_REPLAY_GAIN_MAX
];
55 /* peak value where 1.0 means full sample value */
56 float pf_peak
[AUDIO_REPLAY_GAIN_MAX
];
58 /* true if we have the gain value */
59 bool pb_gain
[AUDIO_REPLAY_GAIN_MAX
];
60 /* gain value in dB */
61 float pf_gain
[AUDIO_REPLAY_GAIN_MAX
];
62 } audio_replay_gain_t
;
65 * audio format description
69 vlc_fourcc_t i_format
; /**< audio format fourcc */
70 unsigned int i_rate
; /**< audio sample-rate */
72 /* Describes the channels configuration of the samples (ie. number of
73 * channels which are available in the buffer, and positions). */
74 uint16_t i_physical_channels
;
76 /* Describes from which original channels, before downmixing, the
77 * buffer is derived. */
78 uint32_t i_original_channels
;
80 /* Optional - for A/52, SPDIF and DTS types : */
81 /* Bytes used by one compressed frame, depends on bitrate. */
82 unsigned int i_bytes_per_frame
;
84 /* Number of sampleframes contained in one compressed frame. */
85 unsigned int i_frame_length
;
86 /* Please note that it may be completely arbitrary - buffers are not
87 * obliged to contain a integral number of so-called "frames". It's
88 * just here for the division :
89 * buffer_size = i_nb_samples * i_bytes_per_frame / i_frame_length
92 /* FIXME ? (used by the codecs) */
93 unsigned i_bitspersample
;
94 unsigned i_blockalign
;
95 uint8_t i_channels
; /* must be <=32 */
98 /* Values available for audio channels */
99 #define AOUT_CHAN_CENTER 0x1
100 #define AOUT_CHAN_LEFT 0x2
101 #define AOUT_CHAN_RIGHT 0x4
102 #define AOUT_CHAN_REARCENTER 0x10
103 #define AOUT_CHAN_REARLEFT 0x20
104 #define AOUT_CHAN_REARRIGHT 0x40
105 #define AOUT_CHAN_MIDDLELEFT 0x100
106 #define AOUT_CHAN_MIDDLERIGHT 0x200
107 #define AOUT_CHAN_LFE 0x1000
109 #define AOUT_CHANS_FRONT (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)
110 #define AOUT_CHANS_MIDDLE (AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT)
111 #define AOUT_CHANS_REAR (AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT)
112 #define AOUT_CHANS_CENTER (AOUT_CHAN_CENTER | AOUT_CHAN_REARCENTER)
114 #define AOUT_CHANS_STEREO AOUT_CHANS_2_0
115 #define AOUT_CHANS_2_0 (AOUT_CHANS_FRONT)
116 #define AOUT_CHANS_2_1 (AOUT_CHANS_FRONT | AOUT_CHAN_LFE)
117 #define AOUT_CHANS_3_0 (AOUT_CHANS_FRONT | AOUT_CHAN_CENTER)
118 #define AOUT_CHANS_3_1 (AOUT_CHANS_3_0 | AOUT_CHAN_LFE)
119 #define AOUT_CHANS_4_0 (AOUT_CHANS_FRONT | AOUT_CHANS_REAR)
120 #define AOUT_CHANS_4_1 (AOUT_CHANS_4_0 | AOUT_CHAN_LFE)
121 #define AOUT_CHANS_5_0 (AOUT_CHANS_4_0 | AOUT_CHAN_CENTER)
122 #define AOUT_CHANS_5_1 (AOUT_CHANS_5_0 | AOUT_CHAN_LFE)
123 #define AOUT_CHANS_6_0 (AOUT_CHANS_4_0 | AOUT_CHANS_MIDDLE)
124 #define AOUT_CHANS_7_0 (AOUT_CHANS_6_0 | AOUT_CHAN_CENTER)
125 #define AOUT_CHANS_7_1 (AOUT_CHANS_5_1 | AOUT_CHANS_MIDDLE)
127 #define AOUT_CHANS_4_0_MIDDLE (AOUT_CHANS_FRONT | AOUT_CHANS_MIDDLE)
128 #define AOUT_CHANS_4_CENTER_REAR (AOUT_CHANS_FRONT | AOUT_CHANS_CENTER)
129 #define AOUT_CHANS_5_0_MIDDLE (AOUT_CHANS_4_0_MIDDLE | AOUT_CHAN_CENTER)
131 /* Values available for original channels only */
132 #define AOUT_CHAN_DOLBYSTEREO 0x10000
133 #define AOUT_CHAN_DUALMONO 0x20000
134 #define AOUT_CHAN_REVERSESTEREO 0x40000
136 #define AOUT_CHAN_PHYSMASK 0xFFFF
137 #define AOUT_CHAN_MAX 9
140 * Picture orientation.
142 typedef enum video_orientation_t
144 ORIENT_TOP_LEFT
= 0, /**< Top line represents top, left column left. */
145 ORIENT_TOP_RIGHT
, /**< Flipped horizontally */
146 ORIENT_BOTTOM_LEFT
, /**< Flipped vertically */
147 ORIENT_BOTTOM_RIGHT
, /**< Rotated 180 degrees */
148 ORIENT_LEFT_TOP
, /**< Transposed */
149 ORIENT_LEFT_BOTTOM
, /**< Rotated 90 degrees clockwise */
150 ORIENT_RIGHT_TOP
, /**< Rotated 90 degrees anti-clockwise */
151 ORIENT_RIGHT_BOTTOM
, /**< Anti-transposed */
153 ORIENT_NORMAL
= ORIENT_TOP_LEFT
,
154 ORIENT_HFLIPPED
= ORIENT_TOP_RIGHT
,
155 ORIENT_VFLIPPED
= ORIENT_BOTTOM_LEFT
,
156 ORIENT_ROTATED_180
= ORIENT_BOTTOM_RIGHT
,
157 ORIENT_ROTATED_270
= ORIENT_LEFT_BOTTOM
,
158 ORIENT_ROTATED_90
= ORIENT_RIGHT_TOP
,
159 } video_orientation_t
;
160 /** Convert EXIF orientation to enum video_orientation_t */
161 #define ORIENT_FROM_EXIF(exif) ((0x01324675U >> (4 * ((exif) - 1))) & 7)
162 /** Convert enum video_orientation_t to EXIF */
163 #define ORIENT_TO_EXIF(orient) ((0x12435867U >> (4 * (orient))) & 15)
164 /** If the orientation is natural or mirrored */
165 #define ORIENT_IS_MIRROR(orient) parity(orient)
166 /** If the orientation swaps dimensions */
167 #define ORIENT_IS_SWAP(orient) (((orient) & 4) != 0)
168 /** Applies horizontal flip to an orientation */
169 #define ORIENT_HFLIP(orient) ((orient) ^ 1)
170 /** Applies vertical flip to an orientation */
171 #define ORIENT_VFLIP(orient) ((orient) ^ 2)
172 /** Applies horizontal flip to an orientation */
173 #define ORIENT_ROTATE_180(orient) ((orient) ^ 3)
176 * video format description
178 struct video_format_t
180 vlc_fourcc_t i_chroma
; /**< picture chroma */
182 unsigned int i_width
; /**< picture width */
183 unsigned int i_height
; /**< picture height */
184 unsigned int i_x_offset
; /**< start offset of visible area */
185 unsigned int i_y_offset
; /**< start offset of visible area */
186 unsigned int i_visible_width
; /**< width of visible area */
187 unsigned int i_visible_height
; /**< height of visible area */
189 unsigned int i_bits_per_pixel
; /**< number of bits per pixel */
191 unsigned int i_sar_num
; /**< sample/pixel aspect ratio */
192 unsigned int i_sar_den
;
194 unsigned int i_frame_rate
; /**< frame rate numerator */
195 unsigned int i_frame_rate_base
; /**< frame rate denominator */
197 uint32_t i_rmask
, i_gmask
, i_bmask
; /**< color masks for RGB chroma */
198 int i_rrshift
, i_lrshift
;
199 int i_rgshift
, i_lgshift
;
200 int i_rbshift
, i_lbshift
;
201 video_palette_t
*p_palette
; /**< video palette from demuxer */
202 video_orientation_t orientation
; /**< picture orientation */
206 * Initialize a video_format_t structure with chroma 'i_chroma'
207 * \param p_src pointer to video_format_t structure
208 * \param i_chroma chroma value to use
210 static inline void video_format_Init( video_format_t
*p_src
, vlc_fourcc_t i_chroma
)
212 memset( p_src
, 0, sizeof( video_format_t
) );
213 p_src
->i_chroma
= i_chroma
;
214 p_src
->i_sar_num
= p_src
->i_sar_den
= 1;
215 p_src
->p_palette
= NULL
;
219 * Copy video_format_t including the palette
220 * \param p_dst video_format_t to copy to
221 * \param p_src video_format_t to copy from
223 static inline int video_format_Copy( video_format_t
*p_dst
, const video_format_t
*p_src
)
225 memcpy( p_dst
, p_src
, sizeof( *p_dst
) );
226 if( p_src
->p_palette
)
228 p_dst
->p_palette
= (video_palette_t
*) malloc( sizeof( video_palette_t
) );
229 if( !p_dst
->p_palette
)
231 memcpy( p_dst
->p_palette
, p_src
->p_palette
, sizeof( *p_dst
->p_palette
) );
237 * Cleanup and free palette of this video_format_t
238 * \param p_src video_format_t structure to clean
240 static inline void video_format_Clean( video_format_t
*p_src
)
242 free( p_src
->p_palette
);
243 memset( p_src
, 0, sizeof( video_format_t
) );
244 p_src
->p_palette
= NULL
;
248 * It will fill up a video_format_t using the given arguments.
249 * Note that the video_format_t must already be initialized.
251 VLC_API
void video_format_Setup( video_format_t
*, vlc_fourcc_t i_chroma
, int i_width
, int i_height
, int i_sar_num
, int i_sar_den
);
254 * It will copy the crop properties from a video_format_t to another.
256 VLC_API
void video_format_CopyCrop( video_format_t
*, const video_format_t
* );
259 * It will compute the crop/ar properties when scaling.
261 VLC_API
void video_format_ScaleCropAr( video_format_t
*, const video_format_t
* );
264 * This function will check if the first video format is similar
267 VLC_API
bool video_format_IsSimilar( const video_format_t
*, const video_format_t
* );
270 * It prints details about the given video_format_t
272 VLC_API
void video_format_Print( vlc_object_t
*, const char *, const video_format_t
* );
275 * subtitles format description
279 /* the character encoding of the text of the subtitle.
280 * all gettext recognized shorts can be used */
284 int i_x_origin
; /**< x coordinate of the subtitle. 0 = left */
285 int i_y_origin
; /**< y coordinate of the subtitle. 0 = top */
290 uint32_t palette
[16+1];
292 /* the width of the original movie the spu was extracted from */
293 int i_original_frame_width
;
294 /* the height of the original movie the spu was extracted from */
295 int i_original_frame_height
;
310 * ES language definition
312 typedef struct extra_languages_t
315 char *psz_description
;
319 * ES format definition
323 int i_cat
; /**< ES category @see es_format_category_e */
324 vlc_fourcc_t i_codec
; /**< FOURCC value as used in vlc */
325 vlc_fourcc_t i_original_fourcc
; /**< original FOURCC from the container */
327 int i_id
; /**< es identifier, where means
328 -1: let the core mark the right id
330 int i_group
; /**< group identifier, where means:
332 >= 0 then a "group" (program) is created
334 int i_priority
; /**< priority, where means:
335 -2 : mean not selectable by the users
336 -1 : mean not selected by default even
340 char *psz_language
; /**< human readible language name */
341 char *psz_description
; /**< human readible description of language */
342 int i_extra_languages
; /**< length in bytes of extra language data pointer */
343 extra_languages_t
*p_extra_languages
; /**< extra language data needed by some decoders */
345 audio_format_t audio
; /**< description of audio format */
346 audio_replay_gain_t audio_replay_gain
; /*< audio replay gain information */
347 video_format_t video
; /**< description of video format */
348 subs_format_t subs
; /**< description of subtitle format */
350 unsigned int i_bitrate
; /**< bitrate of this ES */
351 int i_profile
; /**< codec specific information (like real audio flavor, mpeg audio layer, h264 profile ...) */
352 int i_level
; /**< codec specific information: indicates maximum restrictions on the stream (resolution, bitrate, codec features ...) */
354 bool b_packetized
; /**< whether the data is packetized (ie. not truncated) */
355 int i_extra
; /**< length in bytes of extra data pointer */
356 void *p_extra
; /**< extra data needed by some decoders or muxers */
361 enum es_format_category_e
371 * This function will fill all RGB shift from RGB masks.
373 VLC_API
void video_format_FixRgb( video_format_t
* );
376 * This function will initialize a es_format_t structure.
378 VLC_API
void es_format_Init( es_format_t
*, int i_cat
, vlc_fourcc_t i_codec
);
381 * This function will initialize a es_format_t structure from a video_format_t.
383 VLC_API
void es_format_InitFromVideo( es_format_t
*, const video_format_t
* );
386 * This functions will copy a es_format_t.
388 VLC_API
int es_format_Copy( es_format_t
*p_dst
, const es_format_t
*p_src
);
391 * This function will clean up a es_format_t and release all associated
393 * You can call it multiple times on the same structure.
395 VLC_API
void es_format_Clean( es_format_t
*fmt
);
398 * This function will check if the first ES format is similar
401 * All descriptive fields are ignored.
403 VLC_API
bool es_format_IsSimilar( const es_format_t
*, const es_format_t
* );