videolan/vlc
1
Fork 0
mirror of https://code.videolan.org/videolan/vlc synced 2024-09-28 23:09:59 +02:00
Code Releases Activity
0385fc7e54
vlc/include/vlc_es.h
Niklas Haas ea89d080ad vlc_es: add ICC profile struct 
We store the ICC profile as part of the (ancillary) data allocation,
using a trailing unsized array. This is because we need to copy it in
and out of various libraries anyway, to avoid having to expose things
like AVBufferRef.

The (as of writing) current ICC specification can be found at
https://www.color.org/specification/ICC.1-2022-05.pdf
2022-06-03 11:11:46 +00:00

841 lines
27 KiB
C
Raw Blame History

/*****************************************************************************
* vlc_es.h: Elementary stream formats descriptions
*****************************************************************************
* Copyright (C) 1999-2012 VLC authors and VideoLAN
*
* Authors: Laurent Aimar <fenrir@via.ecp.fr>
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
#ifndef VLC_ES_H
#define VLC_ES_H 1
#include <vlc_common.h>
#include <vlc_fourcc.h>
#include <vlc_viewpoint.h>
/**
* \file
* This file defines the elementary streams format types
*/
/**
* video palette data
* \see video_format_t
* \see subs_format_t
*/
#define VIDEO_PALETTE_COLORS_MAX 256
struct video_palette_t
{
int i_entries; /**< number of in-use palette entries */
uint8_t palette[VIDEO_PALETTE_COLORS_MAX][4]; /**< 4-byte RGBA/YUVA palette */
};
/**
* audio replay gain description
*/
#define AUDIO_REPLAY_GAIN_MAX (2)
#define AUDIO_REPLAY_GAIN_TRACK (0)
#define AUDIO_REPLAY_GAIN_ALBUM (1)
typedef struct
{
/* true if we have the peak value */
bool pb_peak[AUDIO_REPLAY_GAIN_MAX];
/* peak value where 1.0 means full sample value */
float pf_peak[AUDIO_REPLAY_GAIN_MAX];
/* true if we have the gain value */
bool pb_gain[AUDIO_REPLAY_GAIN_MAX];
/* gain value in dB */
float pf_gain[AUDIO_REPLAY_GAIN_MAX];
} audio_replay_gain_t;
/**
* Audio channel type
*/
typedef enum audio_channel_type_t
{
AUDIO_CHANNEL_TYPE_BITMAP,
AUDIO_CHANNEL_TYPE_AMBISONICS,
} audio_channel_type_t;
/**
* audio format description
*/
struct audio_format_t
{
vlc_fourcc_t i_format; /**< audio format fourcc */
unsigned int i_rate; /**< audio sample-rate */
/* Describes the channels configuration of the samples (ie. number of
* channels which are available in the buffer, and positions). */
uint16_t i_physical_channels;
/* Describes the chan mode, either set from the input
* (demux/codec/packetizer) or overridden by the user, used by audio
* filters. */
uint16_t i_chan_mode;
/* Channel type */
audio_channel_type_t channel_type;
/* Optional - for A/52, SPDIF and DTS types : */
/* Bytes used by one compressed frame, depends on bitrate. */
unsigned int i_bytes_per_frame;
/* Number of sampleframes contained in one compressed frame. */
unsigned int i_frame_length;
/* Please note that it may be completely arbitrary - buffers are not
* obliged to contain a integral number of so-called "frames". It's
* just here for the division :
* buffer_size = i_nb_samples * i_bytes_per_frame / i_frame_length
*/
/* FIXME ? (used by the codecs) */
unsigned i_bitspersample;
unsigned i_blockalign;
uint8_t i_channels; /* must be <=32 */
};
/* Values available for audio channels */
#define AOUT_CHAN_CENTER 0x1
#define AOUT_CHAN_LEFT 0x2
#define AOUT_CHAN_RIGHT 0x4
#define AOUT_CHAN_REARCENTER 0x10
#define AOUT_CHAN_REARLEFT 0x20
#define AOUT_CHAN_REARRIGHT 0x40
#define AOUT_CHAN_MIDDLELEFT 0x100
#define AOUT_CHAN_MIDDLERIGHT 0x200
#define AOUT_CHAN_LFE 0x1000
#define AOUT_CHANS_FRONT (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)
#define AOUT_CHANS_MIDDLE (AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT)
#define AOUT_CHANS_REAR (AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT)
#define AOUT_CHANS_CENTER (AOUT_CHAN_CENTER | AOUT_CHAN_REARCENTER)
#define AOUT_CHANS_STEREO AOUT_CHANS_2_0
#define AOUT_CHANS_2_0 (AOUT_CHANS_FRONT)
#define AOUT_CHANS_2_1 (AOUT_CHANS_FRONT | AOUT_CHAN_LFE)
#define AOUT_CHANS_3_0 (AOUT_CHANS_FRONT | AOUT_CHAN_CENTER)
#define AOUT_CHANS_3_1 (AOUT_CHANS_3_0 | AOUT_CHAN_LFE)
#define AOUT_CHANS_4_0 (AOUT_CHANS_FRONT | AOUT_CHANS_REAR)
#define AOUT_CHANS_4_1 (AOUT_CHANS_4_0 | AOUT_CHAN_LFE)
#define AOUT_CHANS_5_0 (AOUT_CHANS_4_0 | AOUT_CHAN_CENTER)
#define AOUT_CHANS_5_1 (AOUT_CHANS_5_0 | AOUT_CHAN_LFE)
#define AOUT_CHANS_6_0 (AOUT_CHANS_4_0 | AOUT_CHANS_MIDDLE)
#define AOUT_CHANS_7_0 (AOUT_CHANS_6_0 | AOUT_CHAN_CENTER)
#define AOUT_CHANS_7_1 (AOUT_CHANS_5_1 | AOUT_CHANS_MIDDLE)
#define AOUT_CHANS_8_1 (AOUT_CHANS_7_1 | AOUT_CHAN_REARCENTER)
#define AOUT_CHANS_4_0_MIDDLE (AOUT_CHANS_FRONT | AOUT_CHANS_MIDDLE)
#define AOUT_CHANS_4_CENTER_REAR (AOUT_CHANS_FRONT | AOUT_CHANS_CENTER)
#define AOUT_CHANS_5_0_MIDDLE (AOUT_CHANS_4_0_MIDDLE | AOUT_CHAN_CENTER)
#define AOUT_CHANS_6_1_MIDDLE (AOUT_CHANS_5_0_MIDDLE | AOUT_CHAN_REARCENTER | AOUT_CHAN_LFE)
/* Maximum number of mapped channels (or the maximum of bits set in
* i_physical_channels) */
#define AOUT_CHAN_MAX 9
/* Maximum number of unmapped channels */
#define INPUT_CHAN_MAX 64
static const uint16_t vlc_chan_maps[] =
{
0,
AOUT_CHAN_CENTER,
AOUT_CHANS_2_0,
AOUT_CHANS_3_0,
AOUT_CHANS_4_0,
AOUT_CHANS_5_0,
AOUT_CHANS_5_1,
AOUT_CHANS_7_0,
AOUT_CHANS_7_1,
AOUT_CHANS_8_1,
};
/* Values available for i_chan_mode only */
#define AOUT_CHANMODE_DUALMONO 0x1
#define AOUT_CHANMODE_DOLBYSTEREO 0x2
#define AOUT_CHANMODE_BINAURAL 0x4
/**
* Picture orientation.
*/
typedef enum video_orientation_t
{
ORIENT_TOP_LEFT = 0, /**< Top line represents top, left column left. */
ORIENT_TOP_RIGHT, /**< Flipped horizontally */
ORIENT_BOTTOM_LEFT, /**< Flipped vertically */
ORIENT_BOTTOM_RIGHT, /**< Rotated 180 degrees */
ORIENT_LEFT_TOP, /**< Transposed */
ORIENT_LEFT_BOTTOM, /**< Rotated 90 degrees anti-clockwise */
ORIENT_RIGHT_TOP, /**< Rotated 90 degrees clockwise */
ORIENT_RIGHT_BOTTOM, /**< Anti-transposed */
#define ORIENT_MAX ((size_t)ORIENT_RIGHT_BOTTOM)
ORIENT_NORMAL = ORIENT_TOP_LEFT,
ORIENT_TRANSPOSED = ORIENT_LEFT_TOP,
ORIENT_ANTI_TRANSPOSED = ORIENT_RIGHT_BOTTOM,
ORIENT_HFLIPPED = ORIENT_TOP_RIGHT,
ORIENT_VFLIPPED = ORIENT_BOTTOM_LEFT,
ORIENT_ROTATED_180 = ORIENT_BOTTOM_RIGHT,
ORIENT_ROTATED_270 = ORIENT_LEFT_BOTTOM,
ORIENT_ROTATED_90 = ORIENT_RIGHT_TOP,
} video_orientation_t;
/** Convert EXIF orientation to enum video_orientation_t */
#define ORIENT_FROM_EXIF(exif) ((0x57642310U >> (4 * ((exif) - 1))) & 7)
/** Convert enum video_orientation_t to EXIF */
#define ORIENT_TO_EXIF(orient) ((0x76853421U >> (4 * (orient))) & 15)
/** If the orientation is natural or mirrored */
#define ORIENT_IS_MIRROR(orient) parity(orient)
/** If the orientation swaps dimensions */
#define ORIENT_IS_SWAP(orient) (((orient) & 4) != 0)
/** Applies horizontal flip to an orientation */
#define ORIENT_HFLIP(orient) ((orient) ^ 1)
/** Applies vertical flip to an orientation */
#define ORIENT_VFLIP(orient) ((orient) ^ 2)
/** Applies 180 degree rotation to an orientation */
#define ORIENT_ROTATE_180(orient) ((orient) ^ 3)
typedef enum video_transform_t
{
TRANSFORM_IDENTITY = ORIENT_NORMAL,
TRANSFORM_HFLIP = ORIENT_HFLIPPED,
TRANSFORM_VFLIP = ORIENT_VFLIPPED,
TRANSFORM_R180 = ORIENT_ROTATED_180,
TRANSFORM_R270 = ORIENT_ROTATED_270,
TRANSFORM_R90 = ORIENT_ROTATED_90,
TRANSFORM_TRANSPOSE = ORIENT_TRANSPOSED,
TRANSFORM_ANTI_TRANSPOSE = ORIENT_ANTI_TRANSPOSED
} video_transform_t;
typedef enum video_multiview_mode_t
{
/* No stereoscopy: 2D picture. */
MULTIVIEW_2D = 0,
/* Side-by-side with left eye first. */
MULTIVIEW_STEREO_SBS,
/* Top-bottom with left eye first. */
MULTIVIEW_STEREO_TB,
/* Row sequential with left eye first. */
MULTIVIEW_STEREO_ROW,
/* Column sequential with left eye first. */
MULTIVIEW_STEREO_COL,
/* Frame sequential with left eye first. */
MULTIVIEW_STEREO_FRAME,
/* Checkerboard pattern with left eye first. */
MULTIVIEW_STEREO_CHECKERBOARD,
#define MULTIVIEW_STEREO_MAX MULTIVIEW_STEREO_CHECKERBOARD
} video_multiview_mode_t;
/**
* Video projection mode.
*/
typedef enum video_projection_mode_t
{
PROJECTION_MODE_RECTANGULAR = 0,
PROJECTION_MODE_EQUIRECTANGULAR,
PROJECTION_MODE_CUBEMAP_LAYOUT_STANDARD = 0x100,
} video_projection_mode_t;
/**
* Video color primaries (a.k.a. chromacities)
*/
typedef enum video_color_primaries_t
{
COLOR_PRIMARIES_UNDEF,
COLOR_PRIMARIES_BT601_525,
COLOR_PRIMARIES_BT601_625,
COLOR_PRIMARIES_BT709,
COLOR_PRIMARIES_BT2020,
COLOR_PRIMARIES_DCI_P3,
COLOR_PRIMARIES_FCC1953,
#define COLOR_PRIMARIES_SRGB COLOR_PRIMARIES_BT709
#define COLOR_PRIMARIES_SMTPE_170 COLOR_PRIMARIES_BT601_525
#define COLOR_PRIMARIES_SMTPE_240 COLOR_PRIMARIES_BT601_525 /* Only differs from 1e10-4 in white Y */
#define COLOR_PRIMARIES_SMTPE_RP145 COLOR_PRIMARIES_BT601_525
#define COLOR_PRIMARIES_EBU_3213 COLOR_PRIMARIES_BT601_625
#define COLOR_PRIMARIES_BT470_BG COLOR_PRIMARIES_BT601_625
#define COLOR_PRIMARIES_BT470_M COLOR_PRIMARIES_FCC1953
#define COLOR_PRIMARIES_MAX COLOR_PRIMARIES_FCC1953
} video_color_primaries_t;
/**
* Video transfer functions
*/
typedef enum video_transfer_func_t
{
TRANSFER_FUNC_UNDEF,
TRANSFER_FUNC_LINEAR,
TRANSFER_FUNC_SRGB /**< Gamma 2.2 */,
TRANSFER_FUNC_BT470_BG,
TRANSFER_FUNC_BT470_M,
TRANSFER_FUNC_BT709,
TRANSFER_FUNC_SMPTE_ST2084,
TRANSFER_FUNC_SMPTE_240,
TRANSFER_FUNC_HLG,
#define TRANSFER_FUNC_BT2020 TRANSFER_FUNC_BT709
#define TRANSFER_FUNC_SMPTE_170 TRANSFER_FUNC_BT709
#define TRANSFER_FUNC_SMPTE_274 TRANSFER_FUNC_BT709
#define TRANSFER_FUNC_SMPTE_293 TRANSFER_FUNC_BT709
#define TRANSFER_FUNC_SMPTE_296 TRANSFER_FUNC_BT709
#define TRANSFER_FUNC_ARIB_B67 TRANSFER_FUNC_HLG
#define TRANSFER_FUNC_MAX TRANSFER_FUNC_HLG
} video_transfer_func_t;
/**
* Video color space (i.e. YCbCr matrices)
*/
typedef enum video_color_space_t
{
COLOR_SPACE_UNDEF,
COLOR_SPACE_BT601,
COLOR_SPACE_BT709,
COLOR_SPACE_BT2020,
#define COLOR_SPACE_SRGB COLOR_SPACE_BT709
#define COLOR_SPACE_SMPTE_170 COLOR_SPACE_BT601
#define COLOR_SPACE_SMPTE_240 COLOR_SPACE_SMPTE_170
#define COLOR_SPACE_MAX COLOR_SPACE_BT2020
} video_color_space_t;
/**
* Video chroma location
*/
typedef enum video_chroma_location_t
{
CHROMA_LOCATION_UNDEF,
CHROMA_LOCATION_LEFT, /**< Most common in MPEG-2 Video, H.264/265 */
CHROMA_LOCATION_CENTER, /**< Most common in MPEG-1 Video, JPEG */
CHROMA_LOCATION_TOP_LEFT,
CHROMA_LOCATION_TOP_CENTER,
CHROMA_LOCATION_BOTTOM_LEFT,
CHROMA_LOCATION_BOTTOM_CENTER,
#define CHROMA_LOCATION_MAX CHROMA_LOCATION_BOTTOM_CENTER
} video_chroma_location_t;
typedef enum video_color_range_t
{
COLOR_RANGE_UNDEF,
COLOR_RANGE_FULL,
COLOR_RANGE_LIMITED,
#define COLOR_RANGE_STUDIO COLOR_RANGE_LIMITED
#define COLOR_RANGE_MAX COLOR_RANGE_LIMITED
} video_color_range_t;
/**
* video format description
*/
struct video_format_t
{
vlc_fourcc_t i_chroma; /**< picture chroma */
unsigned int i_width; /**< picture width */
unsigned int i_height; /**< picture height */
unsigned int i_x_offset; /**< start offset of visible area */
unsigned int i_y_offset; /**< start offset of visible area */
unsigned int i_visible_width; /**< width of visible area */
unsigned int i_visible_height; /**< height of visible area */
unsigned int i_bits_per_pixel; /**< number of bits per pixel */
unsigned int i_sar_num; /**< sample/pixel aspect ratio */
unsigned int i_sar_den;
unsigned int i_frame_rate; /**< frame rate numerator */
unsigned int i_frame_rate_base; /**< frame rate denominator */
uint32_t i_rmask, i_gmask, i_bmask; /**< color masks for RGB chroma */
video_palette_t *p_palette; /**< video palette from demuxer */
video_orientation_t orientation; /**< picture orientation */
video_color_primaries_t primaries; /**< color primaries */
video_transfer_func_t transfer; /**< transfer function */
video_color_space_t space; /**< YCbCr color space */
video_color_range_t color_range; /**< 0-255 instead of 16-235 */
video_chroma_location_t chroma_location; /**< YCbCr chroma location */
video_multiview_mode_t multiview_mode; /** Multiview mode, 2D, 3D */
bool b_multiview_right_eye_first; /** Multiview left or right eye first*/
video_projection_mode_t projection_mode; /**< projection mode */
vlc_viewpoint_t pose;
struct {
/* similar to SMPTE ST 2086 mastering display color volume */
uint16_t primaries[3*2]; /* G,B,R / x,y */
uint16_t white_point[2]; /* x,y */
uint32_t max_luminance;
uint32_t min_luminance;
} mastering;
struct {
/* similar to CTA-861.3 content light level */
uint16_t MaxCLL; /* max content light level */
uint16_t MaxFALL; /* max frame average light level */
} lighting;
uint32_t i_cubemap_padding; /**< padding in pixels of the cube map faces */
};
/**
* Initialize a video_format_t structure with chroma 'i_chroma'
* \param p_src pointer to video_format_t structure
* \param i_chroma chroma value to use
*/
static inline void video_format_Init( video_format_t *p_src, vlc_fourcc_t i_chroma )
{
memset( p_src, 0, sizeof( video_format_t ) );
p_src->i_chroma = i_chroma;
vlc_viewpoint_init( &p_src->pose );
}
/**
* Copy video_format_t including the palette
* \param p_dst video_format_t to copy to
* \param p_src video_format_t to copy from
*/
static inline int video_format_Copy( video_format_t *p_dst, const video_format_t *p_src )
{
memcpy( p_dst, p_src, sizeof( *p_dst ) );
if( p_src->p_palette )
{
p_dst->p_palette = (video_palette_t *) malloc( sizeof( video_palette_t ) );
if( !p_dst->p_palette )
return VLC_ENOMEM;
memcpy( p_dst->p_palette, p_src->p_palette, sizeof( *p_dst->p_palette ) );
}
return VLC_SUCCESS;
}
static inline void video_format_AdjustColorSpace( video_format_t *p_fmt )
{
if ( p_fmt->primaries == COLOR_PRIMARIES_UNDEF )
{
if ( p_fmt->i_visible_height > 576 ) // HD
p_fmt->primaries = COLOR_PRIMARIES_BT709;
else if ( p_fmt->i_visible_height > 525 ) // PAL
p_fmt->primaries = COLOR_PRIMARIES_BT601_625;
else
p_fmt->primaries = COLOR_PRIMARIES_BT601_525;
}
if ( p_fmt->transfer == TRANSFER_FUNC_UNDEF )
{
if ( p_fmt->i_visible_height > 576 ) // HD
p_fmt->transfer = TRANSFER_FUNC_BT709;
else
p_fmt->transfer = TRANSFER_FUNC_SRGB;
}
if ( p_fmt->space == COLOR_SPACE_UNDEF )
{
if ( p_fmt->i_visible_height > 576 ) // HD
p_fmt->space = COLOR_SPACE_BT709;
else
p_fmt->space = COLOR_SPACE_BT601;
}
if ( p_fmt->color_range == COLOR_RANGE_UNDEF )
{
if ( vlc_fourcc_IsYUV(p_fmt->i_chroma) )
p_fmt->color_range = COLOR_RANGE_LIMITED;
else
p_fmt->color_range = COLOR_RANGE_FULL;
}
}
/**
* Cleanup and free palette of this video_format_t
* \param p_src video_format_t structure to clean
*/
static inline void video_format_Clean( video_format_t *p_src )
{
free( p_src->p_palette );
memset( p_src, 0, sizeof( video_format_t ) );
}
/**
* It will fill up a video_format_t using the given arguments.
* Note that the video_format_t must already be initialized.
*/
VLC_API void video_format_Setup( video_format_t *, vlc_fourcc_t i_chroma,
int i_width, int i_height, int i_visible_width, int i_visible_height,
int i_sar_num, int i_sar_den );
/**
* It will copy the crop properties from a video_format_t to another.
*/
VLC_API void video_format_CopyCrop( video_format_t *, const video_format_t * );
static inline void video_format_CopyCropAr(video_format_t *dst,
const video_format_t *src)
{
video_format_CopyCrop(dst, src);
dst->i_sar_num = src->i_sar_num;
dst->i_sar_den = src->i_sar_den;
}
/**
* It will compute the crop/ar properties when scaling.
*/
VLC_API void video_format_ScaleCropAr( video_format_t *, const video_format_t * );
/**
* This function "normalizes" the formats orientation, by switching the a/r according to the orientation,
* producing a format whose orientation is ORIENT_NORMAL. It makes a shallow copy (palette is not alloc'ed).
*/
VLC_API void video_format_ApplyRotation(video_format_t * /*restrict*/ out,
const video_format_t *in);
/**
* This function applies the transform operation to fmt.
*/
VLC_API void video_format_TransformBy(video_format_t *fmt, video_transform_t transform);
/**
* This function applies the transforms necessary to fmt so that the resulting fmt
* has the dst_orientation.
*/
VLC_API void video_format_TransformTo(video_format_t *fmt, video_orientation_t dst_orientation);
/**
* Returns the operation required to transform src into dst.
*/
VLC_API video_transform_t video_format_GetTransform(video_orientation_t src, video_orientation_t dst);
/**
* This function will check if the first video format is similar
* to the second one.
*/
VLC_API bool video_format_IsSimilar( const video_format_t *, const video_format_t * );
/**
* It prints details about the given video_format_t
*/
VLC_API void video_format_Print( vlc_object_t *, const char *, const video_format_t * );
static inline video_transform_t transform_Inverse( video_transform_t transform )
{
switch ( transform ) {
case TRANSFORM_R90:
return TRANSFORM_R270;
case TRANSFORM_R270:
return TRANSFORM_R90;
default:
return transform;
}
}
/**
* Dolby Vision metadata description
*/
enum vlc_dovi_reshape_method_t
{
VLC_DOVI_RESHAPE_POLYNOMIAL = 0,
VLC_DOVI_RESHAPE_MMR = 1,
};
enum vlc_dovi_nlq_method_t
{
VLC_DOVI_NLQ_NONE = -1,
VLC_DOVI_NLQ_LINEAR_DZ = 0,
};
#define VLC_ANCILLARY_ID_DOVI VLC_FOURCC('D','o','V','i')
typedef struct vlc_video_dovi_metadata_t
{
/* Common header fields */
uint8_t coef_log2_denom;
uint8_t bl_bit_depth;
uint8_t el_bit_depth;
enum vlc_dovi_nlq_method_t nlq_method_idc;
/* Colorspace metadata */
float nonlinear_offset[3];
float nonlinear_matrix[9];
float linear_matrix[9];
uint16_t source_min_pq; /* 12-bit PQ values */
uint16_t source_max_pq;
/**
* Do not reorder or modify the following structs, they are intentionally
* specified to be identical to AVDOVIReshapingCurve / AVDOVINLQParams.
*/
struct vlc_dovi_reshape_t {
uint8_t num_pivots;
uint16_t pivots[9];
enum vlc_dovi_reshape_method_t mapping_idc[8];
uint8_t poly_order[8];
int64_t poly_coef[8][3];
uint8_t mmr_order[8];
int64_t mmr_constant[8];
int64_t mmr_coef[8][3][7];
} curves[3];
struct vlc_dovi_nlq_t {
uint8_t offset_depth; /* bit depth of offset value */
uint16_t offset;
uint64_t hdr_in_max;
uint64_t dz_slope;
uint64_t dz_threshold;
} nlq[3];
} vlc_video_dovi_metadata_t;
/**
* Embedded ICC profiles
*/
#define VLC_ANCILLARY_ID_ICC VLC_FOURCC('i','C','C','P')
typedef struct vlc_icc_profile_t
{
size_t size;
uint8_t data[]; /* binary profile data, see ICC.1:2022 (or later) */
} vlc_icc_profile_t;
/**
* subtitles format description
*/
struct subs_format_t
{
/* the character encoding of the text of the subtitle.
* all gettext recognized shorts can be used */
char *psz_encoding;
int i_x_origin; /**< x coordinate of the subtitle. 0 = left */
int i_y_origin; /**< y coordinate of the subtitle. 0 = top */
struct
{
/* */
uint32_t palette[16+1]; /* CLUT Palette AYVU */
/* the width of the original movie the spu was extracted from */
int i_original_frame_width;
/* the height of the original movie the spu was extracted from */
int i_original_frame_height;
} spu;
struct
{
int i_id;
} dvb;
struct
{
uint8_t i_magazine; /* magazine value (3 bits), > 8 for any */
uint8_t i_page; /* BCD packet address value (4+4 bits) */
} teletext;
struct
{
uint8_t i_channel;
/* Reorder depth of transport video, -1 for no reordering */
int i_reorder_depth;
} cc;
};
#define SPU_PALETTE_DEFINED 0xbeefbeef
/**
* ES language definition
*/
typedef struct extra_languages_t
{
char *psz_language;
char *psz_description;
} extra_languages_t;
/** ES Categories */
enum es_format_category_e
{
UNKNOWN_ES = 0x00,
VIDEO_ES,
AUDIO_ES,
SPU_ES,
DATA_ES,
};
#define ES_CATEGORY_COUNT (DATA_ES + 1)
/**
* ES format definition
*/
#define ES_PRIORITY_NOT_SELECTABLE -2
#define ES_PRIORITY_NOT_DEFAULTABLE -1
#define ES_PRIORITY_SELECTABLE_MIN 0
#define ES_PRIORITY_MIN ES_PRIORITY_NOT_SELECTABLE
struct es_format_t
{
enum es_format_category_e i_cat; /**< ES category */
vlc_fourcc_t i_codec; /**< FOURCC value as used in vlc */
vlc_fourcc_t i_original_fourcc; /**< original FOURCC from the container */
int i_id; /**< es identifier, where means
-1: let the core mark the right id
>=0: valid id */
int i_group; /**< group identifier, where means:
-1 : standalone
>= 0 then a "group" (program) is created
for each value */
int i_priority; /**< priority, where means:
-2 : mean not selectable by the users
-1 : mean not selected by default even
when no other stream
>=0: priority */
char *psz_language; /**< human-readable language name */
char *psz_description; /**< human-readable description of language */
unsigned i_extra_languages; /**< length in bytes of extra language data pointer */
extra_languages_t *p_extra_languages; /**< extra language data needed by some decoders */
union {
struct {
audio_format_t audio; /**< description of audio format */
audio_replay_gain_t audio_replay_gain; /**< audio replay gain information */
};
video_format_t video; /**< description of video format */
subs_format_t subs; /**< description of subtitle format */
};
unsigned int i_bitrate; /**< bitrate of this ES */
int i_profile; /**< codec specific information (like real audio flavor, mpeg audio layer, h264 profile ...) */
int i_level; /**< codec specific information: indicates maximum restrictions on the stream (resolution, bitrate, codec features ...) */
bool b_packetized; /**< whether the data is packetized (ie. not truncated) */
int i_extra; /**< length in bytes of extra data pointer */
void *p_extra; /**< extra data needed by some decoders or muxers */
};
/**
* This function will fill all RGB shift from RGB masks.
*/
VLC_API void video_format_FixRgb( video_format_t * );
/**
* This function will initialize a es_format_t structure.
*/
VLC_API void es_format_Init( es_format_t *, int i_cat, vlc_fourcc_t i_codec );
/**
* This function will initialize a es_format_t structure from a video_format_t.
*/
VLC_API void es_format_InitFromVideo( es_format_t *, const video_format_t * );
/**
* This functions will copy a es_format_t.
*/
VLC_API int es_format_Copy( es_format_t *p_dst, const es_format_t *p_src );
/**
* This function will clean up a es_format_t and release all associated
* resources.
* You can call it multiple times on the same structure.
*/
VLC_API void es_format_Clean( es_format_t *fmt );
/**
* This function will check if the first ES format is similar
* to the second one.
*
* All descriptive fields are ignored.
*/
VLC_API bool es_format_IsSimilar( const es_format_t *, const es_format_t * );
/**
* Changes ES format to another category
* Format must have been properly initialized
*/
static inline void es_format_Change( es_format_t *fmt, int i_cat, vlc_fourcc_t i_codec )
{
es_format_Clean( fmt );
es_format_Init( fmt, i_cat, i_codec );
}
/**
* Increase the ES track id reference count.
*
* Any held ES tracks must be released with vlc_es_id_Release().
*
* @param es pointer to the ES id
* @return the same ES pointer, for convenience
*/
VLC_API vlc_es_id_t *
vlc_es_id_Hold(vlc_es_id_t *es);
/**
* Decrease the ES track id reference count.
*
* @param id pointer to the ES track id
*/
VLC_API void
vlc_es_id_Release(vlc_es_id_t *id);
/**
* Get the ES track input id
*
* @param id pointer to the ES track id
* @return the ES track input id (always valid)
*/
VLC_API int
vlc_es_id_GetInputId(vlc_es_id_t *id);
/**
* Return whether the ES track identifier is stable
*
* An string identifier is stable when it is certified to be the same across
* different playback instances for the same ES track.
*
* @param id pointer to the ES track id
* @return true if stable
*/
VLC_API bool
vlc_es_id_IsStrIdStable(vlc_es_id_t *id);
/**
* Get the unique string identifier
*
* This id could be used to identify a track across different playback
* instances. For example, it can be used to store a track selection
* preference in a database.
*
* @warning Check with vlc_es_id_IsStrIdStable() if the ES track is stable
* before saving it for a future usage.
*
* @param id pointer to the ES track id
* @return the ES track string identifier, can't be NULL, valid until id is
* released
*/
VLC_API const char *
vlc_es_id_GetStrId(vlc_es_id_t *id);
/**
* Get the ES category
*
* @param id pointer to the ES track id
* @return the es track category (always valid)
*/
VLC_API enum es_format_category_e
vlc_es_id_GetCat(vlc_es_id_t *id);
#endif
View Git Blame Copy Permalink