FFmpeg
Loading...
Searching...
No Matches
AVGainMapParams Struct Reference

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...

#include <gain_map.h>

Data Structures

struct  AVGainMapChannel
 

Data Fields

int version
 The version of this gain map struct.
 
int use_base_color_space
 If non-zero, the gain map is applied in the colour space of the base rendition; otherwise in that of the alternate rendition.
 
AVRational base_hdr_headroom
 log2 of the display headroom at which the base rendition is shown unmodified, and at which the map is applied in full.
 
AVRational alternate_hdr_headroom
 
struct AVGainMapParams::AVGainMapChannel channels [3]
 
int nb_channels
 Must be 1 or 3.
 

Detailed Description

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".

Note: sizeof(AVGainMapParams) is not part of the ABI. New fields may be added at the end of the struct.

Definition at line 39 of file gain_map.h.

Field Documentation

◆ version

int AVGainMapParams::version

The version of this gain map struct.

Reserved to allow future extensions of the struct. Must be <= AV_ISO21496_VERSION.

Definition at line 44 of file gain_map.h.

◆ use_base_color_space

int AVGainMapParams::use_base_color_space

If non-zero, the gain map is applied in the colour space of the base rendition; otherwise in that of the alternate rendition.

Definition at line 50 of file gain_map.h.

◆ base_hdr_headroom

AVRational AVGainMapParams::base_hdr_headroom

log2 of the display headroom at which the base rendition is shown unmodified, and at which the map is applied in full.

Definition at line 56 of file gain_map.h.

◆ alternate_hdr_headroom

AVRational AVGainMapParams::alternate_hdr_headroom

Definition at line 57 of file gain_map.h.

◆ channels

struct AVGainMapParams::AVGainMapChannel AVGainMapParams::channels[3]

◆ nb_channels

int AVGainMapParams::nb_channels

Must be 1 or 3.

If 1, all channels share the same set of parameters.

Definition at line 83 of file gain_map.h.


The documentation for this struct was generated from the following file: