1/*****************************************************************************
2 * vlc_es.h: Elementary stream formats descriptions
3 *****************************************************************************
4 * Copyright (C) 1999-2012 VLC authors and VideoLAN
5 * $Id: 3c8e04e1b15740166df2e0b2d9a651ffb2c5bc2f $
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_common.h>
28#include <vlc_fourcc.h>
29#include <vlc_text_style.h>
30#include <vlc_viewpoint.h>
31
32/**
33 * \file
34 * This file defines the elementary streams format types
35 */
36
37/**
38 * video palette data
39 * \see video_format_t
40 * \see subs_format_t
41 */
42#define VIDEO_PALETTE_COLORS_MAX 256
43
44struct video_palette_t
45{
46 int i_entries; /**< to keep the compatibility with libavcodec's palette */
47 uint8_t palette[VIDEO_PALETTE_COLORS_MAX][4]; /**< 4-byte RGBA/YUVA palette */
48};
49
50/**
51 * audio replay gain description
52 */
53#define AUDIO_REPLAY_GAIN_MAX (2)
54#define AUDIO_REPLAY_GAIN_TRACK (0)
55#define AUDIO_REPLAY_GAIN_ALBUM (1)
56typedef struct
57{
58 /* true if we have the peak value */
59 bool pb_peak[AUDIO_REPLAY_GAIN_MAX];
60 /* peak value where 1.0 means full sample value */
61 float pf_peak[AUDIO_REPLAY_GAIN_MAX];
62
63 /* true if we have the gain value */
64 bool pb_gain[AUDIO_REPLAY_GAIN_MAX];
65 /* gain value in dB */
66 float pf_gain[AUDIO_REPLAY_GAIN_MAX];
67} audio_replay_gain_t;
68
69
70/**
71 * Audio channel type
72 */
73typedef enum audio_channel_type_t
74{
75 AUDIO_CHANNEL_TYPE_BITMAP,
76 AUDIO_CHANNEL_TYPE_AMBISONICS,
77} audio_channel_type_t;
78
79/**
80 * audio format description
81 */
82struct audio_format_t
83{
84 vlc_fourcc_t i_format; /**< audio format fourcc */
85 unsigned int i_rate; /**< audio sample-rate */
86
87 /* Describes the channels configuration of the samples (ie. number of
88 * channels which are available in the buffer, and positions). */
89 uint16_t i_physical_channels;
90
91 /* Describes the chan mode, either set from the input
92 * (demux/codec/packetizer) or overridden by the user, used by audio
93 * filters. */
94 uint16_t i_chan_mode;
95
96 /* Channel type */
97 audio_channel_type_t channel_type;
98
99 /* Optional - for A/52, SPDIF and DTS types : */
100 /* Bytes used by one compressed frame, depends on bitrate. */
101 unsigned int i_bytes_per_frame;
102
103 /* Number of sampleframes contained in one compressed frame. */
104 unsigned int i_frame_length;
105 /* Please note that it may be completely arbitrary - buffers are not
106 * obliged to contain a integral number of so-called "frames". It's
107 * just here for the division :
108 * buffer_size = i_nb_samples * i_bytes_per_frame / i_frame_length
109 */
110
111 /* FIXME ? (used by the codecs) */
112 unsigned i_bitspersample;
113 unsigned i_blockalign;
114 uint8_t i_channels; /* must be <=32 */
115};
116
117/* Values available for audio channels */
118#define AOUT_CHAN_CENTER 0x1
119#define AOUT_CHAN_LEFT 0x2
120#define AOUT_CHAN_RIGHT 0x4
121#define AOUT_CHAN_REARCENTER 0x10
122#define AOUT_CHAN_REARLEFT 0x20
123#define AOUT_CHAN_REARRIGHT 0x40
124#define AOUT_CHAN_MIDDLELEFT 0x100
125#define AOUT_CHAN_MIDDLERIGHT 0x200
126#define AOUT_CHAN_LFE 0x1000
127
128#define AOUT_CHANS_FRONT (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)
129#define AOUT_CHANS_MIDDLE (AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT)
130#define AOUT_CHANS_REAR (AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT)
131#define AOUT_CHANS_CENTER (AOUT_CHAN_CENTER | AOUT_CHAN_REARCENTER)
132
133#define AOUT_CHANS_STEREO AOUT_CHANS_2_0
134#define AOUT_CHANS_2_0 (AOUT_CHANS_FRONT)
135#define AOUT_CHANS_2_1 (AOUT_CHANS_FRONT | AOUT_CHAN_LFE)
136#define AOUT_CHANS_3_0 (AOUT_CHANS_FRONT | AOUT_CHAN_CENTER)
137#define AOUT_CHANS_3_1 (AOUT_CHANS_3_0 | AOUT_CHAN_LFE)
138#define AOUT_CHANS_4_0 (AOUT_CHANS_FRONT | AOUT_CHANS_REAR)
139#define AOUT_CHANS_4_1 (AOUT_CHANS_4_0 | AOUT_CHAN_LFE)
140#define AOUT_CHANS_5_0 (AOUT_CHANS_4_0 | AOUT_CHAN_CENTER)
141#define AOUT_CHANS_5_1 (AOUT_CHANS_5_0 | AOUT_CHAN_LFE)
142#define AOUT_CHANS_6_0 (AOUT_CHANS_4_0 | AOUT_CHANS_MIDDLE)
143#define AOUT_CHANS_7_0 (AOUT_CHANS_6_0 | AOUT_CHAN_CENTER)
144#define AOUT_CHANS_7_1 (AOUT_CHANS_5_1 | AOUT_CHANS_MIDDLE)
145#define AOUT_CHANS_8_1 (AOUT_CHANS_7_1 | AOUT_CHAN_REARCENTER)
146
147#define AOUT_CHANS_4_0_MIDDLE (AOUT_CHANS_FRONT | AOUT_CHANS_MIDDLE)
148#define AOUT_CHANS_4_CENTER_REAR (AOUT_CHANS_FRONT | AOUT_CHANS_CENTER)
149#define AOUT_CHANS_5_0_MIDDLE (AOUT_CHANS_4_0_MIDDLE | AOUT_CHAN_CENTER)
150#define AOUT_CHANS_6_1_MIDDLE (AOUT_CHANS_5_0_MIDDLE | AOUT_CHAN_REARCENTER | AOUT_CHAN_LFE)
151
152/* Maximum number of mapped channels (or the maximum of bits set in
153 * i_physical_channels) */
154#define AOUT_CHAN_MAX 9
155/* Maximum number of unmapped channels */
156#define INPUT_CHAN_MAX 64
157
158/* Values available for i_chan_mode only */
159#define AOUT_CHANMODE_DUALMONO 0x1
160#define AOUT_CHANMODE_DOLBYSTEREO 0x2
161
162/**
163 * Picture orientation.
164 */
165typedef enum video_orientation_t
166{
167 ORIENT_TOP_LEFT = 0, /**< Top line represents top, left column left. */
168 ORIENT_TOP_RIGHT, /**< Flipped horizontally */
169 ORIENT_BOTTOM_LEFT, /**< Flipped vertically */
170 ORIENT_BOTTOM_RIGHT, /**< Rotated 180 degrees */
171 ORIENT_LEFT_TOP, /**< Transposed */
172 ORIENT_LEFT_BOTTOM, /**< Rotated 90 degrees clockwise */
173 ORIENT_RIGHT_TOP, /**< Rotated 90 degrees anti-clockwise */
174 ORIENT_RIGHT_BOTTOM, /**< Anti-transposed */
175
176 ORIENT_NORMAL = ORIENT_TOP_LEFT,
177 ORIENT_TRANSPOSED = ORIENT_LEFT_TOP,
178 ORIENT_ANTI_TRANSPOSED = ORIENT_RIGHT_BOTTOM,
179 ORIENT_HFLIPPED = ORIENT_TOP_RIGHT,
180 ORIENT_VFLIPPED = ORIENT_BOTTOM_LEFT,
181 ORIENT_ROTATED_180 = ORIENT_BOTTOM_RIGHT,
182 ORIENT_ROTATED_270 = ORIENT_LEFT_BOTTOM,
183 ORIENT_ROTATED_90 = ORIENT_RIGHT_TOP,
184} video_orientation_t;
185/** Convert EXIF orientation to enum video_orientation_t */
186#define ORIENT_FROM_EXIF(exif) ((0x57642310U >> (4 * ((exif) - 1))) & 7)
187/** Convert enum video_orientation_t to EXIF */
188#define ORIENT_TO_EXIF(orient) ((0x76853421U >> (4 * (orient))) & 15)
189/** If the orientation is natural or mirrored */
190#define ORIENT_IS_MIRROR(orient) parity(orient)
191/** If the orientation swaps dimensions */
192#define ORIENT_IS_SWAP(orient) (((orient) & 4) != 0)
193/** Applies horizontal flip to an orientation */
194#define ORIENT_HFLIP(orient) ((orient) ^ 1)
195/** Applies vertical flip to an orientation */
196#define ORIENT_VFLIP(orient) ((orient) ^ 2)
197/** Applies horizontal flip to an orientation */
198#define ORIENT_ROTATE_180(orient) ((orient) ^ 3)
199
200typedef enum video_transform_t
201{
202 TRANSFORM_IDENTITY = ORIENT_NORMAL,
203 TRANSFORM_HFLIP = ORIENT_HFLIPPED,
204 TRANSFORM_VFLIP = ORIENT_VFLIPPED,
205 TRANSFORM_R180 = ORIENT_ROTATED_180,
206 TRANSFORM_R270 = ORIENT_ROTATED_270,
207 TRANSFORM_R90 = ORIENT_ROTATED_90,
208 TRANSFORM_TRANSPOSE = ORIENT_TRANSPOSED,
209 TRANSFORM_ANTI_TRANSPOSE = ORIENT_ANTI_TRANSPOSED
210} video_transform_t;
211
212typedef enum video_multiview_mode_t
213{
214 /* No stereoscopy: 2D picture. */
215 MULTIVIEW_2D = 0,
216
217 /* Side-by-side with left eye first. */
218 MULTIVIEW_STEREO_SBS,
219
220 /* Top-bottom with left eye first. */
221 MULTIVIEW_STEREO_TB,
222
223 /* Row sequential with left eye first. */
224 MULTIVIEW_STEREO_ROW,
225
226 /* Column sequential with left eye first. */
227 MULTIVIEW_STEREO_COL,
228
229 /* Frame sequential with left eye first. */
230 MULTIVIEW_STEREO_FRAME,
231
232 /* Checkerboard pattern with left eye first. */
233 MULTIVIEW_STEREO_CHECKERBOARD,
234} video_multiview_mode_t;
235
236/**
237 * Video projection mode.
238 */
239typedef enum video_projection_mode_t
240{
241 PROJECTION_MODE_RECTANGULAR = 0,
242 PROJECTION_MODE_EQUIRECTANGULAR,
243
244 PROJECTION_MODE_CUBEMAP_LAYOUT_STANDARD = 0x100,
245} video_projection_mode_t;
246
247/**
248 * Video color primaries (a.k.a. chromacities)
249 */
250typedef enum video_color_primaries_t
251{
252 COLOR_PRIMARIES_UNDEF,
253 COLOR_PRIMARIES_BT601_525,
254 COLOR_PRIMARIES_BT601_625,
255 COLOR_PRIMARIES_BT709,
256 COLOR_PRIMARIES_BT2020,
257 COLOR_PRIMARIES_DCI_P3,
258 COLOR_PRIMARIES_FCC1953,
259#define COLOR_PRIMARIES_SRGB COLOR_PRIMARIES_BT709
260#define COLOR_PRIMARIES_SMTPE_170 COLOR_PRIMARIES_BT601_525
261#define COLOR_PRIMARIES_SMTPE_240 COLOR_PRIMARIES_BT601_525 /* Only differs from 1e10-4 in white Y */
262#define COLOR_PRIMARIES_SMTPE_RP145 COLOR_PRIMARIES_BT601_525
263#define COLOR_PRIMARIES_EBU_3213 COLOR_PRIMARIES_BT601_625
264#define COLOR_PRIMARIES_BT470_BG COLOR_PRIMARIES_BT601_625
265#define COLOR_PRIMARIES_BT470_M COLOR_PRIMARIES_FCC1953
266#define COLOR_PRIMARIES_MAX COLOR_PRIMARIES_FCC1953
267} video_color_primaries_t;
268
269/**
270 * Video transfer functions
271 */
272typedef enum video_transfer_func_t
273{
274 TRANSFER_FUNC_UNDEF,
275 TRANSFER_FUNC_LINEAR,
276 TRANSFER_FUNC_SRGB /*< Gamma 2.2 */,
277 TRANSFER_FUNC_BT470_BG,
278 TRANSFER_FUNC_BT470_M,
279 TRANSFER_FUNC_BT709,
280 TRANSFER_FUNC_SMPTE_ST2084,
281 TRANSFER_FUNC_SMPTE_240,
282 TRANSFER_FUNC_HLG,
283#define TRANSFER_FUNC_BT2020 TRANSFER_FUNC_BT709
284#define TRANSFER_FUNC_SMPTE_170 TRANSFER_FUNC_BT709
285#define TRANSFER_FUNC_SMPTE_274 TRANSFER_FUNC_BT709
286#define TRANSFER_FUNC_SMPTE_293 TRANSFER_FUNC_BT709
287#define TRANSFER_FUNC_SMPTE_296 TRANSFER_FUNC_BT709
288#define TRANSFER_FUNC_ARIB_B67 TRANSFER_FUNC_HLG
289#define TRANSFER_FUNC_MAX TRANSFER_FUNC_HLG
290} video_transfer_func_t;
291
292/**
293 * Video color space (i.e. YCbCr matrices)
294 */
295typedef enum video_color_space_t
296{
297 COLOR_SPACE_UNDEF,
298 COLOR_SPACE_BT601,
299 COLOR_SPACE_BT709,
300 COLOR_SPACE_BT2020,
301#define COLOR_SPACE_SRGB COLOR_SPACE_BT709
302#define COLOR_SPACE_SMPTE_170 COLOR_SPACE_BT601
303#define COLOR_SPACE_SMPTE_240 COLOR_SPACE_SMPTE_170
304#define COLOR_SPACE_MAX COLOR_SPACE_BT2020
305} video_color_space_t;
306
307/**
308 * Video chroma location
309 */
310typedef enum video_chroma_location_t
311{
312 CHROMA_LOCATION_UNDEF,
313 CHROMA_LOCATION_LEFT, /*< Most common in MPEG-2 Video, H.264/265 */
314 CHROMA_LOCATION_CENTER, /*< Most common in MPEG-1 Video, JPEG */
315 CHROMA_LOCATION_TOP_LEFT,
316 CHROMA_LOCATION_TOP_CENTER,
317 CHROMA_LOCATION_BOTTOM_LEFT,
318 CHROMA_LOCATION_BOTTOM_CENTER,
319#define CHROMA_LOCATION_MAX CHROMA_LOCATION_BOTTOM_CENTER
320} video_chroma_location_t;
321
322/**
323 * video format description
324 */
325struct video_format_t
326{
327 vlc_fourcc_t i_chroma; /**< picture chroma */
328
329 unsigned int i_width; /**< picture width */
330 unsigned int i_height; /**< picture height */
331 unsigned int i_x_offset; /**< start offset of visible area */
332 unsigned int i_y_offset; /**< start offset of visible area */
333 unsigned int i_visible_width; /**< width of visible area */
334 unsigned int i_visible_height; /**< height of visible area */
335
336 unsigned int i_bits_per_pixel; /**< number of bits per pixel */
337
338 unsigned int i_sar_num; /**< sample/pixel aspect ratio */
339 unsigned int i_sar_den;
340
341 unsigned int i_frame_rate; /**< frame rate numerator */
342 unsigned int i_frame_rate_base; /**< frame rate denominator */
343
344 uint32_t i_rmask, i_gmask, i_bmask; /**< color masks for RGB chroma */
345 int i_rrshift, i_lrshift;
346 int i_rgshift, i_lgshift;
347 int i_rbshift, i_lbshift;
348 video_palette_t *p_palette; /**< video palette from demuxer */
349 video_orientation_t orientation; /**< picture orientation */
350 video_color_primaries_t primaries; /**< color primaries */
351 video_transfer_func_t transfer; /**< transfer function */
352 video_color_space_t space; /**< YCbCr color space */
353 bool b_color_range_full; /**< 0-255 instead of 16-235 */
354 video_chroma_location_t chroma_location; /**< YCbCr chroma location */
355
356 video_multiview_mode_t multiview_mode; /** Multiview mode, 2D, 3D */
357
358 video_projection_mode_t projection_mode; /**< projection mode */
359 vlc_viewpoint_t pose;
360 struct {
361 /* similar to SMPTE ST 2086 mastering display color volume */
362 uint16_t primaries[3*2]; /* G,B,R / x,y */
363 uint16_t white_point[2]; /* x,y */
364 uint32_t max_luminance;
365 uint32_t min_luminance;
366 } mastering;
367 struct {
368 /* similar to CTA-861.3 content light level */
369 uint16_t MaxCLL; /* max content light level */
370 uint16_t MaxFALL; /* max frame average light level */
371 } lighting;
372 uint32_t i_cubemap_padding; /**< padding in pixels of the cube map faces */
373};
374
375/**
376 * Initialize a video_format_t structure with chroma 'i_chroma'
377 * \param p_src pointer to video_format_t structure
378 * \param i_chroma chroma value to use
379 */
380static inline void video_format_Init( video_format_t *p_src, vlc_fourcc_t i_chroma )
381{
382 memset( s: p_src, c: 0, n: sizeof( video_format_t ) );
383 p_src->i_chroma = i_chroma;
384 vlc_viewpoint_init( p_vp: &p_src->pose );
385}
386
387/**
388 * Copy video_format_t including the palette
389 * \param p_dst video_format_t to copy to
390 * \param p_src video_format_t to copy from
391 */
392static inline int video_format_Copy( video_format_t *p_dst, const video_format_t *p_src )
393{
394 memcpy( dest: p_dst, src: p_src, n: sizeof( *p_dst ) );
395 if( p_src->p_palette )
396 {
397 p_dst->p_palette = (video_palette_t *) malloc( size: sizeof( video_palette_t ) );
398 if( !p_dst->p_palette )
399 return VLC_ENOMEM;
400 memcpy( dest: p_dst->p_palette, src: p_src->p_palette, n: sizeof( *p_dst->p_palette ) );
401 }
402 return VLC_SUCCESS;
403}
404
405static inline void video_format_AdjustColorSpace( video_format_t *p_fmt )
406{
407 if ( p_fmt->primaries == COLOR_PRIMARIES_UNDEF )
408 {
409 if ( p_fmt->i_visible_height > 576 ) // HD
410 p_fmt->primaries = COLOR_PRIMARIES_BT709;
411 else if ( p_fmt->i_visible_height > 525 ) // PAL
412 p_fmt->primaries = COLOR_PRIMARIES_BT601_625;
413 else
414 p_fmt->primaries = COLOR_PRIMARIES_BT601_525;
415 }
416
417 if ( p_fmt->transfer == TRANSFER_FUNC_UNDEF )
418 {
419 if ( p_fmt->i_visible_height > 576 ) // HD
420 p_fmt->transfer = TRANSFER_FUNC_BT709;
421 else
422 p_fmt->transfer = TRANSFER_FUNC_SRGB;
423 }
424
425 if ( p_fmt->space == COLOR_SPACE_UNDEF )
426 {
427 if ( p_fmt->i_visible_height > 576 ) // HD
428 p_fmt->space = COLOR_SPACE_BT709;
429 else
430 p_fmt->space = COLOR_SPACE_BT601;
431 }
432}
433
434/**
435 * Cleanup and free palette of this video_format_t
436 * \param p_src video_format_t structure to clean
437 */
438static inline void video_format_Clean( video_format_t *p_src )
439{
440 free( ptr: p_src->p_palette );
441 memset( s: p_src, c: 0, n: sizeof( video_format_t ) );
442}
443
444/**
445 * It will fill up a video_format_t using the given arguments.
446 * Note that the video_format_t must already be initialized.
447 */
448VLC_API void video_format_Setup( video_format_t *, vlc_fourcc_t i_chroma,
449 int i_width, int i_height, int i_visible_width, int i_visible_height,
450 int i_sar_num, int i_sar_den );
451
452/**
453 * It will copy the crop properties from a video_format_t to another.
454 */
455VLC_API void video_format_CopyCrop( video_format_t *, const video_format_t * );
456
457/**
458 * It will compute the crop/ar properties when scaling.
459 */
460VLC_API void video_format_ScaleCropAr( video_format_t *, const video_format_t * );
461
462/**
463 * This function "normalizes" the formats orientation, by switching the a/r according to the orientation,
464 * producing a format whose orientation is ORIENT_NORMAL. It makes a shallow copy (pallette is not alloc'ed).
465 */
466VLC_API void video_format_ApplyRotation(video_format_t * /*restrict*/ out,
467 const video_format_t *in);
468
469/**
470 * This function applies the transform operation to fmt.
471 */
472VLC_API void video_format_TransformBy(video_format_t *fmt, video_transform_t transform);
473
474/**
475 * This function applies the transforms necessary to fmt so that the resulting fmt
476 * has the dst_orientation.
477 */
478VLC_API void video_format_TransformTo(video_format_t *fmt, video_orientation_t dst_orientation);
479
480/**
481 * Returns the operation required to transform src into dst.
482 */
483VLC_API video_transform_t video_format_GetTransform(video_orientation_t src, video_orientation_t dst);
484
485/**
486 * This function will check if the first video format is similar
487 * to the second one.
488 */
489VLC_API bool video_format_IsSimilar( const video_format_t *, const video_format_t * );
490
491/**
492 * It prints details about the given video_format_t
493 */
494VLC_API void video_format_Print( vlc_object_t *, const char *, const video_format_t * );
495
496
497static inline video_transform_t transform_Inverse( video_transform_t transform )
498{
499 switch ( transform ) {
500 case TRANSFORM_R90:
501 return TRANSFORM_R270;
502 case TRANSFORM_R270:
503 return TRANSFORM_R90;
504 default:
505 return transform;
506 }
507}
508/**
509 * subtitles format description
510 */
511struct subs_format_t
512{
513 /* the character encoding of the text of the subtitle.
514 * all gettext recognized shorts can be used */
515 char *psz_encoding;
516
517
518 int i_x_origin; /**< x coordinate of the subtitle. 0 = left */
519 int i_y_origin; /**< y coordinate of the subtitle. 0 = top */
520
521 struct
522 {
523 /* */
524 uint32_t palette[16+1]; /* CLUT Palette AYVU */
525
526 /* the width of the original movie the spu was extracted from */
527 int i_original_frame_width;
528 /* the height of the original movie the spu was extracted from */
529 int i_original_frame_height;
530 } spu;
531
532 struct
533 {
534 int i_id;
535 } dvb;
536 struct
537 {
538 int i_magazine;
539 int i_page;
540 } teletext;
541 struct
542 {
543 uint8_t i_channel;
544 /* Reorder depth of transport video, -1 for no reordering */
545 int i_reorder_depth;
546 } cc;
547
548 text_style_t *p_style; /* Default styles to use */
549};
550
551#define SPU_PALETTE_DEFINED 0xbeefbeef
552
553/**
554 * ES language definition
555 */
556typedef struct extra_languages_t
557{
558 char *psz_language;
559 char *psz_description;
560} extra_languages_t;
561
562/** ES Categories */
563enum es_format_category_e
564{
565 UNKNOWN_ES = 0x00,
566 VIDEO_ES,
567 AUDIO_ES,
568 SPU_ES,
569 DATA_ES,
570};
571#define ES_CATEGORY_COUNT (DATA_ES + 1)
572
573/**
574 * ES format definition
575 */
576#define ES_PRIORITY_NOT_SELECTABLE -2
577#define ES_PRIORITY_NOT_DEFAULTABLE -1
578#define ES_PRIORITY_SELECTABLE_MIN 0
579#define ES_PRIORITY_MIN ES_PRIORITY_NOT_SELECTABLE
580struct es_format_t
581{
582 enum es_format_category_e i_cat; /**< ES category */
583 vlc_fourcc_t i_codec; /**< FOURCC value as used in vlc */
584 vlc_fourcc_t i_original_fourcc; /**< original FOURCC from the container */
585
586 int i_id; /**< es identifier, where means
587 -1: let the core mark the right id
588 >=0: valid id */
589 int i_group; /**< group identifier, where means:
590 -1 : standalone
591 >= 0 then a "group" (program) is created
592 for each value */
593 int i_priority; /**< priority, where means:
594 -2 : mean not selectable by the users
595 -1 : mean not selected by default even
596 when no other stream
597 >=0: priority */
598
599 char *psz_language; /**< human-readable language name */
600 char *psz_description; /**< human-readable description of language */
601 unsigned i_extra_languages; /**< length in bytes of extra language data pointer */
602 extra_languages_t *p_extra_languages; /**< extra language data needed by some decoders */
603
604 union {
605 struct {
606 audio_format_t audio; /**< description of audio format */
607 audio_replay_gain_t audio_replay_gain; /*< audio replay gain information */
608 };
609 video_format_t video; /**< description of video format */
610 subs_format_t subs; /**< description of subtitle format */
611 };
612
613 unsigned int i_bitrate; /**< bitrate of this ES */
614 int i_profile; /**< codec specific information (like real audio flavor, mpeg audio layer, h264 profile ...) */
615 int i_level; /**< codec specific information: indicates maximum restrictions on the stream (resolution, bitrate, codec features ...) */
616
617 bool b_packetized; /**< whether the data is packetized (ie. not truncated) */
618 int i_extra; /**< length in bytes of extra data pointer */
619 void *p_extra; /**< extra data needed by some decoders or muxers */
620
621};
622
623/**
624 * This function will fill all RGB shift from RGB masks.
625 */
626VLC_API void video_format_FixRgb( video_format_t * );
627
628/**
629 * This function will initialize a es_format_t structure.
630 */
631VLC_API void es_format_Init( es_format_t *, int i_cat, vlc_fourcc_t i_codec );
632
633/**
634 * This function will initialize a es_format_t structure from a video_format_t.
635 */
636VLC_API void es_format_InitFromVideo( es_format_t *, const video_format_t * );
637
638/**
639 * This functions will copy a es_format_t.
640 */
641VLC_API int es_format_Copy( es_format_t *p_dst, const es_format_t *p_src );
642
643/**
644 * This function will clean up a es_format_t and release all associated
645 * resources.
646 * You can call it multiple times on the same structure.
647 */
648VLC_API void es_format_Clean( es_format_t *fmt );
649
650/**
651 * This function will check if the first ES format is similar
652 * to the second one.
653 *
654 * All descriptive fields are ignored.
655 */
656VLC_API bool es_format_IsSimilar( const es_format_t *, const es_format_t * );
657
658/**
659 * Changes ES format to another category
660 * Format must have been properly initialized
661 */
662static inline void es_format_Change( es_format_t *fmt, int i_cat, vlc_fourcc_t i_codec )
663{
664 es_format_Clean( fmt );
665 es_format_Init( fmt, i_cat, i_codec );
666}
667
668#endif
669

source code of include/vlc/plugins/vlc_es.h