FFmpeg 9.1
Loading...
Searching...
No Matches
gain_map.h File Reference
#include <stddef.h>
#include "rational.h"
#include "frame.h"

Go to the source code of this file.

Data Structures

struct  AVGainMapParams
 Parameters describing how to combine a gain map rendition with its base rendition to recover the alternate rendition, as defined by ISO 21496-1:2025 "Digital photography - Gain map metadata for image conversion". More...
struct  AVGainMapParams::AVGainMapChannel

Macros

#define AV_ISO21496_VERSION   0
#define AV_ISO21496_IDENTIFIER   "urn:iso:std:iso:ts:21496:-1"
#define AV_GAIN_MAP_MAX_PAYLOAD_SIZE   141 /* = 5 + 2*8 + 3*5*8 */

Functions

int av_gain_map_params_from_iso21496 (AVGainMapParams *p, const uint8_t *data, size_t size)
 Parse the payload of an ISO 21496-1 gain map metadata blob.
int av_gain_map_params_to_iso21496 (const AVGainMapParams *p, uint8_t *buf)
 Serialize an AVGainMapParams as an ISO 21496-1 gain map metadata blob.
int av_gain_map_params_validate (const AVGainMapParams *p)
 Returns >= 0 if the given AVGainMapParams struct contains valid data; or a negative AVERROR otherwise.
int av_gain_map_channels_identical (const AVGainMapParams *p)
 Returns 1 if all channels of the gain map have identical parameters, 0 otherwise.
AVGainMapParams * av_gain_map_params_alloc (size_t *size)
 Allocate an AVGainMapParams structure and initialize it to default values.
AVGainMapParams * av_gain_map_params_create_side_data (AVFrameSideData ***sd, int *nb_sd)
 Allocate and add an AVGainMapParams structure to an existing AVFrameSideData array as AV_FRAME_DATA_GAIN_MAP_PARAMS side data.

Macro Definition Documentation

◆ AV_ISO21496_VERSION

#define AV_ISO21496_VERSION   0

Definition at line 27 of file gain_map.h.

◆ AV_ISO21496_IDENTIFIER

#define AV_ISO21496_IDENTIFIER   "urn:iso:std:iso:ts:21496:-1"

Definition at line 28 of file gain_map.h.

◆ AV_GAIN_MAP_MAX_PAYLOAD_SIZE

#define AV_GAIN_MAP_MAX_PAYLOAD_SIZE   141 /* = 5 + 2*8 + 3*5*8 */

Definition at line 98 of file gain_map.h.

Function Documentation

◆ av_gain_map_params_from_iso21496()

int av_gain_map_params_from_iso21496 ( AVGainMapParams * p,
const uint8_t * data,
size_t size )

Parse the payload of an ISO 21496-1 gain map metadata blob.

Parameters
pstruct to fill; overwritten on success, untouched on failure
datapayload, excluding container-specific identifiers
sizesize of data in bytes
Returns
>= 0 on success, or a negative AVERROR on failure

◆ av_gain_map_params_to_iso21496()

int av_gain_map_params_to_iso21496 ( const AVGainMapParams * p,
uint8_t * buf )

Serialize an AVGainMapParams as an ISO 21496-1 gain map metadata blob.

The output starts at the minimum_version field; the caller should prepend whatever identifier its container requires.

Parameters
pparameters to serialize
bufByte buffer to fill with the serialized data. Must contain at least AV_GAIN_MAP_MAX_PAYLOAD_SIZE bytes.
Returns
Number of bytes written on success, or a negative AVERROR on failure
Note
Always succeeds if av_gain_map_params_validate() returns >= 0.

◆ av_gain_map_params_validate()

int av_gain_map_params_validate ( const AVGainMapParams * p)

Returns >= 0 if the given AVGainMapParams struct contains valid data; or a negative AVERROR otherwise.

◆ av_gain_map_channels_identical()

int av_gain_map_channels_identical ( const AVGainMapParams * p)

Returns 1 if all channels of the gain map have identical parameters, 0 otherwise.

◆ av_gain_map_params_alloc()

AVGainMapParams * av_gain_map_params_alloc ( size_t * size)

Allocate an AVGainMapParams structure and initialize it to default values.

The resulting pointer must be freed using av_free().

Parameters
sizeif non-NULL, set to sizeof(AVGainMapParams)
Returns
the newly allocated struct, or NULL on failure

◆ av_gain_map_params_create_side_data()

AVGainMapParams * av_gain_map_params_create_side_data ( AVFrameSideData *** sd,
int * nb_sd )

Allocate and add an AVGainMapParams structure to an existing AVFrameSideData array as AV_FRAME_DATA_GAIN_MAP_PARAMS side data.

Returns
the newly allocated struct, or NULL on failure