VLC  2.1.0-git
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
vlc_es.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * vlc_es.h: Elementary stream formats descriptions
3  *****************************************************************************
4  * Copyright (C) 1999-2012 VLC authors and VideoLAN
5  * $Id: 23312c66c8f68041884f96e05a81a763dfaa53a9 $
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23 
24 #ifndef VLC_ES_H
25 #define VLC_ES_H 1
26 
27 #include <vlc_fourcc.h>
28 
29 /**
30  * \file
31  * This file defines the elementary streams format types
32  */
33 
34 /**
35  * video palette data
36  * \see video_format_t
37  * \see subs_format_t
38  */
39 struct video_palette_t
40 {
41  int i_entries; /**< to keep the compatibility with ffmpeg's palette */
42  uint8_t palette[256][4]; /**< 4-byte RGBA/YUVA palette */
43 };
44 
45 /**
46  * audio replay gain description
47  */
48 #define AUDIO_REPLAY_GAIN_MAX (2)
49 #define AUDIO_REPLAY_GAIN_TRACK (0)
50 #define AUDIO_REPLAY_GAIN_ALBUM (1)
51 typedef struct
52 {
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];
57 
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;
63 
64 /**
65  * audio format description
66  */
67 struct audio_format_t
68 {
69  vlc_fourcc_t i_format; /**< audio format fourcc */
70  unsigned int i_rate; /**< audio sample-rate */
71 
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;
75 
76  /* Describes from which original channels, before downmixing, the
77  * buffer is derived. */
78  uint32_t i_original_channels;
79 
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;
83 
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
90  */
91 
92  /* FIXME ? (used by the codecs) */
93  unsigned i_bitspersample;
94  unsigned i_blockalign;
95  uint8_t i_channels; /* must be <=32 */
96 };
97 
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
108 
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)
113 
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)
126 #define AOUT_CHANS_8_1 (AOUT_CHANS_7_1 | AOUT_CHAN_REARCENTER)
127 
128 #define AOUT_CHANS_4_0_MIDDLE (AOUT_CHANS_FRONT | AOUT_CHANS_MIDDLE)
129 #define AOUT_CHANS_4_CENTER_REAR (AOUT_CHANS_FRONT | AOUT_CHANS_CENTER)
130 #define AOUT_CHANS_5_0_MIDDLE (AOUT_CHANS_4_0_MIDDLE | AOUT_CHAN_CENTER)
131 
132 /* Values available for original channels only */
133 #define AOUT_CHAN_DOLBYSTEREO 0x10000
134 #define AOUT_CHAN_DUALMONO 0x20000
135 #define AOUT_CHAN_REVERSESTEREO 0x40000
136 
137 #define AOUT_CHAN_PHYSMASK 0xFFFF
138 #define AOUT_CHAN_MAX 9
139 
140 /**
141  * Picture orientation.
142  */
143 typedef enum video_orientation_t
144 {
145  ORIENT_TOP_LEFT = 0, /**< Top line represents top, left column left. */
146  ORIENT_TOP_RIGHT, /**< Flipped horizontally */
147  ORIENT_BOTTOM_LEFT, /**< Flipped vertically */
148  ORIENT_BOTTOM_RIGHT, /**< Rotated 180 degrees */
149  ORIENT_LEFT_TOP, /**< Transposed */
150  ORIENT_LEFT_BOTTOM, /**< Rotated 90 degrees clockwise */
151  ORIENT_RIGHT_TOP, /**< Rotated 90 degrees anti-clockwise */
152  ORIENT_RIGHT_BOTTOM, /**< Anti-transposed */
153 
154  ORIENT_NORMAL = ORIENT_TOP_LEFT,
155  ORIENT_HFLIPPED = ORIENT_TOP_RIGHT,
156  ORIENT_VFLIPPED = ORIENT_BOTTOM_LEFT,
157  ORIENT_ROTATED_180 = ORIENT_BOTTOM_RIGHT,
158  ORIENT_ROTATED_270 = ORIENT_LEFT_BOTTOM,
159  ORIENT_ROTATED_90 = ORIENT_RIGHT_TOP,
160 } video_orientation_t;
161 /** Convert EXIF orientation to enum video_orientation_t */
162 #define ORIENT_FROM_EXIF(exif) ((0x01324675U >> (4 * ((exif) - 1))) & 7)
163 /** Convert enum video_orientation_t to EXIF */
164 #define ORIENT_TO_EXIF(orient) ((0x12435867U >> (4 * (orient))) & 15)
165 /** If the orientation is natural or mirrored */
166 #define ORIENT_IS_MIRROR(orient) parity(orient)
167 /** If the orientation swaps dimensions */
168 #define ORIENT_IS_SWAP(orient) (((orient) & 4) != 0)
169 /** Applies horizontal flip to an orientation */
170 #define ORIENT_HFLIP(orient) ((orient) ^ 1)
171 /** Applies vertical flip to an orientation */
172 #define ORIENT_VFLIP(orient) ((orient) ^ 2)
173 /** Applies horizontal flip to an orientation */
174 #define ORIENT_ROTATE_180(orient) ((orient) ^ 3)
175 
176 /**
177  * video format description
178  */
179 struct video_format_t
180 {
181  vlc_fourcc_t i_chroma; /**< picture chroma */
182 
183  unsigned int i_width; /**< picture width */
184  unsigned int i_height; /**< picture height */
185  unsigned int i_x_offset; /**< start offset of visible area */
186  unsigned int i_y_offset; /**< start offset of visible area */
187  unsigned int i_visible_width; /**< width of visible area */
188  unsigned int i_visible_height; /**< height of visible area */
189 
190  unsigned int i_bits_per_pixel; /**< number of bits per pixel */
191 
192  unsigned int i_sar_num; /**< sample/pixel aspect ratio */
193  unsigned int i_sar_den;
194 
195  unsigned int i_frame_rate; /**< frame rate numerator */
196  unsigned int i_frame_rate_base; /**< frame rate denominator */
197 
198  uint32_t i_rmask, i_gmask, i_bmask; /**< color masks for RGB chroma */
199  int i_rrshift, i_lrshift;
200  int i_rgshift, i_lgshift;
201  int i_rbshift, i_lbshift;
202  video_palette_t *p_palette; /**< video palette from demuxer */
203  video_orientation_t orientation; /**< picture orientation */
204 };
205 
206 /**
207  * Initialize a video_format_t structure with chroma 'i_chroma'
208  * \param p_src pointer to video_format_t structure
209  * \param i_chroma chroma value to use
210  */
211 static inline void video_format_Init( video_format_t *p_src, vlc_fourcc_t i_chroma )
212 {
213  memset( p_src, 0, sizeof( video_format_t ) );
214  p_src->i_chroma = i_chroma;
215  p_src->i_sar_num = p_src->i_sar_den = 1;
216  p_src->p_palette = NULL;
217 }
218 
219 /**
220  * Copy video_format_t including the palette
221  * \param p_dst video_format_t to copy to
222  * \param p_src video_format_t to copy from
223  */
224 static inline int video_format_Copy( video_format_t *p_dst, const video_format_t *p_src )
225 {
226  memcpy( p_dst, p_src, sizeof( *p_dst ) );
227  if( p_src->p_palette )
228  {
229  p_dst->p_palette = (video_palette_t *) malloc( sizeof( video_palette_t ) );
230  if( !p_dst->p_palette )
231  return VLC_ENOMEM;
232  memcpy( p_dst->p_palette, p_src->p_palette, sizeof( *p_dst->p_palette ) );
233  }
234  return VLC_SUCCESS;
235 }
236 
237 /**
238  * Cleanup and free palette of this video_format_t
239  * \param p_src video_format_t structure to clean
240  */
241 static inline void video_format_Clean( video_format_t *p_src )
242 {
243  free( p_src->p_palette );
244  memset( p_src, 0, sizeof( video_format_t ) );
245  p_src->p_palette = NULL;
246 }
247 
248 /**
249  * It will fill up a video_format_t using the given arguments.
250  * Note that the video_format_t must already be initialized.
251  */
252 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 );
253 
254 /**
255  * It will copy the crop properties from a video_format_t to another.
256  */
257 VLC_API void video_format_CopyCrop( video_format_t *, const video_format_t * );
258 
259 /**
260  * It will compute the crop/ar properties when scaling.
261  */
262 VLC_API void video_format_ScaleCropAr( video_format_t *, const video_format_t * );
263 
264 /**
265  * This function will check if the first video format is similar
266  * to the second one.
267  */
268 VLC_API bool video_format_IsSimilar( const video_format_t *, const video_format_t * );
269 
270 /**
271  * It prints details about the given video_format_t
272  */
273 VLC_API void video_format_Print( vlc_object_t *, const char *, const video_format_t * );
274 
275 /**
276  * subtitles format description
277  */
278 struct subs_format_t
279 {
280  /* the character encoding of the text of the subtitle.
281  * all gettext recognized shorts can be used */
282  char *psz_encoding;
283 
284 
285  int i_x_origin; /**< x coordinate of the subtitle. 0 = left */
286  int i_y_origin; /**< y coordinate of the subtitle. 0 = top */
287 
288  struct
289  {
290  /* */
291  uint32_t palette[16+1];
292 
293  /* the width of the original movie the spu was extracted from */
294  int i_original_frame_width;
295  /* the height of the original movie the spu was extracted from */
296  int i_original_frame_height;
297  } spu;
298 
299  struct
300  {
301  int i_id;
302  } dvb;
303  struct
304  {
305  int i_magazine;
306  int i_page;
307  } teletext;
308 };
309 
310 /**
311  * ES language definition
312  */
313 typedef struct extra_languages_t
314 {
315  char *psz_language;
316  char *psz_description;
317 } extra_languages_t;
318 
319 /**
320  * ES format definition
321  */
322 struct es_format_t
323 {
324  int i_cat; /**< ES category @see es_format_category_e */
325  vlc_fourcc_t i_codec; /**< FOURCC value as used in vlc */
326  vlc_fourcc_t i_original_fourcc; /**< original FOURCC from the container */
327 
328  int i_id; /**< es identifier, where means
329  -1: let the core mark the right id
330  >=0: valid id */
331  int i_group; /**< group identifier, where means:
332  -1 : standalone
333  >= 0 then a "group" (program) is created
334  for each value */
335  int i_priority; /**< priority, where means:
336  -2 : mean not selectable by the users
337  -1 : mean not selected by default even
338  when no other stream
339  >=0: priority */
340 
341  char *psz_language; /**< human readible language name */
342  char *psz_description; /**< human readible description of language */
343  int i_extra_languages; /**< length in bytes of extra language data pointer */
344  extra_languages_t *p_extra_languages; /**< extra language data needed by some decoders */
345 
346  audio_format_t audio; /**< description of audio format */
347  audio_replay_gain_t audio_replay_gain; /*< audio replay gain information */
348  video_format_t video; /**< description of video format */
349  subs_format_t subs; /**< description of subtitle format */
350 
351  unsigned int i_bitrate; /**< bitrate of this ES */
352  int i_profile; /**< codec specific information (like real audio flavor, mpeg audio layer, h264 profile ...) */
353  int i_level; /**< codec specific information: indicates maximum restrictions on the stream (resolution, bitrate, codec features ...) */
354 
355  bool b_packetized; /**< whether the data is packetized (ie. not truncated) */
356  int i_extra; /**< length in bytes of extra data pointer */
357  void *p_extra; /**< extra data needed by some decoders or muxers */
358 
359 };
360 
361 /** ES Categories */
362 enum es_format_category_e
363 {
364  UNKNOWN_ES = 0x00,
365  VIDEO_ES = 0x01,
366  AUDIO_ES = 0x02,
367  SPU_ES = 0x03,
368  NAV_ES = 0x04,
369 };
370 
371 /**
372  * This function will fill all RGB shift from RGB masks.
373  */
374 VLC_API void video_format_FixRgb( video_format_t * );
375 
376 /**
377  * This function will initialize a es_format_t structure.
378  */
379 VLC_API void es_format_Init( es_format_t *, int i_cat, vlc_fourcc_t i_codec );
380 
381 /**
382  * This function will initialize a es_format_t structure from a video_format_t.
383  */
384 VLC_API void es_format_InitFromVideo( es_format_t *, const video_format_t * );
385 
386 /**
387  * This functions will copy a es_format_t.
388  */
389 VLC_API int es_format_Copy( es_format_t *p_dst, const es_format_t *p_src );
390 
391 /**
392  * This function will clean up a es_format_t and release all associated
393  * resources.
394  * You can call it multiple times on the same structure.
395  */
396 VLC_API void es_format_Clean( es_format_t *fmt );
397 
398 /**
399  * This function will check if the first ES format is similar
400  * to the second one.
401  *
402  * All descriptive fields are ignored.
403  */
404 VLC_API bool es_format_IsSimilar( const es_format_t *, const es_format_t * );
405 
406 #endif
Generated by   doxygen 1.8.1.2