mirror of https://code.videolan.org/videolan/vlc
234 lines
6.8 KiB
C
234 lines
6.8 KiB
C
/*****************************************************************************
|
|
* vlc_ancillary.h: ancillary management functions
|
|
*****************************************************************************
|
|
* Copyright (C) 2021 VLC authors and VideoLAN
|
|
*
|
|
* 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_ANCILLARY_H
|
|
#define VLC_ANCILLARY_H 1
|
|
|
|
#include <stdint.h>
|
|
|
|
/**
|
|
* \defgroup ancillary Ancillary
|
|
* \ingroup input
|
|
*
|
|
* 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.
|
|
*
|
|
* @{
|
|
* \file
|
|
* Ancillary definition and functions
|
|
*/
|
|
|
|
/**
|
|
* Ancillary opaque struct, refcounted struct that hold user data with a free
|
|
* callback.
|
|
*/
|
|
struct vlc_ancillary;
|
|
|
|
/**
|
|
* ID of an ancillary. Each ancillary user can create its own unique ID via
|
|
* VLC_ANCILLARY_ID.
|
|
*/
|
|
typedef uint32_t vlc_ancillary_id;
|
|
#define VLC_ANCILLARY_ID(a,b,c,d) VLC_FOURCC(a,b,c,d)
|
|
|
|
/**
|
|
* Callback to free an ancillary data
|
|
*/
|
|
typedef void (*vlc_ancillary_free_cb)(void *data);
|
|
|
|
/**
|
|
* Create an ancillary
|
|
*
|
|
* @param data an opaque ancillary, can't be NULL
|
|
* @param id id of ancillary
|
|
* @param free_cb callback to release the data, can be NULL
|
|
* @return a valid vlc_ancillary pointer or NULL in case of allocation error
|
|
*/
|
|
VLC_API struct vlc_ancillary *
|
|
vlc_ancillary_CreateWithFreeCb(void *data, vlc_ancillary_id id,
|
|
vlc_ancillary_free_cb free_cb);
|
|
|
|
/**
|
|
* Helper to create an ancillary holding an allocated data
|
|
*/
|
|
static inline struct vlc_ancillary *
|
|
vlc_ancillary_Create(void *data, vlc_ancillary_id id)
|
|
{
|
|
return vlc_ancillary_CreateWithFreeCb(data, id, free);
|
|
}
|
|
|
|
/**
|
|
* Release an ancillary
|
|
*
|
|
* If the refcount reaches 0, the free_cb provided by
|
|
* vlc_ancillary_CreateWithFreeCb() is called.
|
|
*
|
|
* @param ancillary ancillary to release
|
|
*/
|
|
VLC_API void
|
|
vlc_ancillary_Release(struct vlc_ancillary *ancillary);
|
|
|
|
/**
|
|
* Hold an ancillary
|
|
*
|
|
* @param ancillary ancillary to hold
|
|
* @return the same ancillary
|
|
*/
|
|
VLC_API struct vlc_ancillary *
|
|
vlc_ancillary_Hold(struct vlc_ancillary *ancillary);
|
|
|
|
VLC_API void *
|
|
vlc_ancillary_GetData(const struct vlc_ancillary *ancillary);
|
|
|
|
/**
|
|
* 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;
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
|
|
#define VLC_ANCILLARY_ID_HDR10PLUS VLC_FOURCC('H','D','R','+')
|
|
|
|
typedef struct vlc_video_hdr_dynamic_metadata_t
|
|
{
|
|
uint8_t country_code; /* ITU-T T.35 Annex A */
|
|
uint8_t application_version;
|
|
float targeted_luminance; /* in cd/m² */
|
|
|
|
/* parameters for the first processing window (encompassing the frame) */
|
|
float maxscl[3]; /* in linearized range [0,1] */
|
|
float average_maxrgb; /* in linearized range [0,1] */
|
|
uint8_t num_histogram; /* in range [0,15] */
|
|
struct {
|
|
uint8_t percentage; /* in range [1,100] */
|
|
float percentile; /* in linearized range [0,1] */
|
|
} histogram[15];
|
|
float fraction_bright_pixels;/* in range [0,1] */
|
|
uint8_t tone_mapping_flag;
|
|
float knee_point_x; /* in ootf range [0,1] */
|
|
float knee_point_y; /* in ootf range [0,1] */
|
|
uint8_t num_bezier_anchors; /* in range [1,15] */
|
|
float bezier_curve_anchors[15]; /* in range [0,1] */
|
|
} vlc_video_hdr_dynamic_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;
|
|
|
|
/**
|
|
* VPx alpha data
|
|
*/
|
|
|
|
#define VLC_ANCILLARY_ID_VPX_ALPHA VLC_FOURCC('v','p','x','A')
|
|
|
|
typedef struct vlc_vpx_alpha_t
|
|
{
|
|
size_t size;
|
|
uint8_t *data;
|
|
} vlc_vpx_alpha_t;
|
|
|
|
/** @} */
|
|
#endif /* VLC_ANCILLARY_H */
|