Ancillary that can be attached to any vlc_frame_t or picture_t. More...

Collaboration diagram for Ancillary:

Files
file	vlc_ancillary.h
	Ancillary definition and functions.

Data Structures
struct	vlc_video_dovi_metadata_t

struct	vlc_video_hdr_dynamic_metadata_t

struct	vlc_icc_profile_t

struct	vlc_vpx_alpha_t

Macros
#define	VLC_ANCILLARY_ID(a, b, c, d) VLC_FOURCC(a,b,c,d)

#define	VLC_ANCILLARY_ID_DOVI VLC_FOURCC('D','o','V','i')

#define	VLC_ANCILLARY_ID_HDR10PLUS VLC_FOURCC('H','D','R','+')
	HDR10+ Dynamic metadata (based on ATSC A/341 Amendment 2094-40)

#define	VLC_ANCILLARY_ID_ICC VLC_FOURCC('i','C','C','P')
	Embedded ICC profiles.

#define	VLC_ANCILLARY_ID_VPX_ALPHA VLC_FOURCC('v','p','x','A')
	VPx alpha data.

Typedefs
typedef uint32_t	vlc_ancillary_id
	ID of an ancillary.

typedef void(*	vlc_ancillary_free_cb) (void *data)
	Callback to free an ancillary data.

typedef struct vlc_video_dovi_metadata_t	vlc_video_dovi_metadata_t

typedef struct vlc_video_hdr_dynamic_metadata_t	vlc_video_hdr_dynamic_metadata_t

typedef struct vlc_icc_profile_t	vlc_icc_profile_t

typedef struct vlc_vpx_alpha_t	vlc_vpx_alpha_t

Enumerations
enum	vlc_dovi_reshape_method_t { VLC_DOVI_RESHAPE_POLYNOMIAL = 0 , VLC_DOVI_RESHAPE_MMR = 1 }
	Dolby Vision metadata description. More...

enum	vlc_dovi_nlq_method_t { VLC_DOVI_NLQ_NONE = -1 , VLC_DOVI_NLQ_LINEAR_DZ = 0 }

Functions
struct vlc_ancillary *	vlc_ancillary_CreateWithFreeCb (void *data, vlc_ancillary_id id, vlc_ancillary_free_cb free_cb)
	Create an ancillary.

static struct vlc_ancillary *	vlc_ancillary_Create (void *data, vlc_ancillary_id id)
	Helper to create an ancillary holding an allocated data.

void	vlc_ancillary_Release (struct vlc_ancillary *ancillary)
	Release an ancillary.

struct vlc_ancillary *	vlc_ancillary_Hold (struct vlc_ancillary *ancillary)
	Hold an ancillary.

void *	vlc_ancillary_GetData (const struct vlc_ancillary *ancillary)

Detailed Description

Ancillary that can be attached to any vlc_frame_t or picture_t.

Ancillaries can be created from:

packetized demuxer modules,
packetizer modules,
decoder modules.

Warning: Ancillaries should not be attached from a non packetized demuxer module since the attachment to the vlc_frame will be lost by the packetizer module that will be automatically inserted.

Ancillaries are automatically forwarded from a vlc_frame_t to an other vlc_frame_t and from a picture_t to an other picture_t. This allow to keep ancillaries untouched when audio filters or video filters are used (these filters don't have to know about the ancillary).

Ancillary readers can be either:

A decoder module,
An audio output,
A video output,
A video or audio filter.

Macro Definition Documentation

◆ VLC_ANCILLARY_ID

#define VLC_ANCILLARY_ID	(	a,
		b,
		c,
		d
	)	VLC_FOURCC(a,b,c,d)

◆ VLC_ANCILLARY_ID_DOVI

#define VLC_ANCILLARY_ID_DOVI VLC_FOURCC('D','o','V','i')

◆ VLC_ANCILLARY_ID_HDR10PLUS

#define VLC_ANCILLARY_ID_HDR10PLUS VLC_FOURCC('H','D','R','+')

HDR10+ Dynamic metadata (based on ATSC A/341 Amendment 2094-40)

This is similar to SMPTE ST2094-40:2016, but omits the mastering display and target display actual peak luminance LUTs, the rectangular boundaries and ellipse coefficients, and support for multiple processing windows, as these are intentionally left unused in this version of the specification.