FFmpeg
Data Fields
AVFilmGrainH274Params Struct Reference

This structure describes how to handle film grain synthesis for codecs using the ITU-T H.274 Versatile suplemental enhancement information message. More...

#include <film_grain_params.h>

Data Fields

int model_id
 Specifies the film grain simulation mode. More...
 
attribute_deprecated int bit_depth_luma
 TODO: On this ABI bump, please also re-order the fields in AVFilmGrainParams (see below) More...
 
attribute_deprecated int bit_depth_chroma
 Specifies the bit depth used for the chroma components. More...
 
attribute_deprecated enum AVColorRange color_range
 Specifies the video signal characteristics. More...
 
attribute_deprecated enum AVColorPrimaries color_primaries
 
attribute_deprecated enum AVColorTransferCharacteristic color_trc
 
attribute_deprecated enum AVColorSpace color_space
 
int blending_mode_id
 Specifies the blending mode used to blend the simulated film grain with the decoded images. More...
 
int log2_scale_factor
 Specifies a scale factor used in the film grain characterization equations. More...
 
int component_model_present [3]
 Indicates if the modelling of film grain for a given component is present. More...
 
uint16_t num_intensity_intervals [3]
 Specifies the number of intensity intervals for which a specific set of model values has been estimated, with a range of [1, 256]. More...
 
uint8_t num_model_values [3]
 Specifies the number of model values present for each intensity interval in which the film grain has been modelled, with a range of [1, 6]. More...
 
uint8_t intensity_interval_lower_bound [3][256]
 Specifies the lower ounds of each intensity interval for whichthe set of model values applies for the component. More...
 
uint8_t intensity_interval_upper_bound [3][256]
 Specifies the upper bound of each intensity interval for which the set of model values applies for the component. More...
 
int16_t comp_model_value [3][256][6]
 Specifies the model values for the component for each intensity interval. More...
 

Detailed Description

This structure describes how to handle film grain synthesis for codecs using the ITU-T H.274 Versatile suplemental enhancement information message.

Note
The struct must be allocated as part of AVFilmGrainParams using av_film_grain_params_alloc(). Its size is not a part of the public ABI.

Definition at line 132 of file film_grain_params.h.

Field Documentation

◆ model_id

int AVFilmGrainH274Params::model_id

Specifies the film grain simulation mode.

0 = Frequency filtering, 1 = Auto-regression

Definition at line 137 of file film_grain_params.h.

Referenced by ff_h2645_sei_to_frame(), ff_h274_apply_film_grain(), and print_film_grain_params().

◆ bit_depth_luma

attribute_deprecated int AVFilmGrainH274Params::bit_depth_luma

TODO: On this ABI bump, please also re-order the fields in AVFilmGrainParams (see below)

Specifies the bit depth used for the luma component.

Deprecated:
use AVFilmGrainParams.bit_depth_luma.

Definition at line 151 of file film_grain_params.h.

Referenced by ff_h2645_sei_to_frame().

◆ bit_depth_chroma

attribute_deprecated int AVFilmGrainH274Params::bit_depth_chroma

Specifies the bit depth used for the chroma components.

Deprecated:
use AVFilmGrainParams.bit_depth_chroma.

Definition at line 159 of file film_grain_params.h.

Referenced by ff_h2645_sei_to_frame().

◆ color_range

attribute_deprecated enum AVColorRange AVFilmGrainH274Params::color_range

Specifies the video signal characteristics.

Deprecated:
use AVFilmGrainParams.color_{range,primaries,trc,space}.

Definition at line 167 of file film_grain_params.h.

Referenced by ff_h2645_sei_to_frame().

◆ color_primaries

attribute_deprecated enum AVColorPrimaries AVFilmGrainH274Params::color_primaries

Definition at line 169 of file film_grain_params.h.

Referenced by ff_h2645_sei_to_frame().

◆ color_trc

attribute_deprecated enum AVColorTransferCharacteristic AVFilmGrainH274Params::color_trc

Definition at line 171 of file film_grain_params.h.

Referenced by ff_h2645_sei_to_frame().

◆ color_space

attribute_deprecated enum AVColorSpace AVFilmGrainH274Params::color_space

Definition at line 173 of file film_grain_params.h.

Referenced by ff_h2645_sei_to_frame().

◆ blending_mode_id

int AVFilmGrainH274Params::blending_mode_id

Specifies the blending mode used to blend the simulated film grain with the decoded images.

0 = Additive, 1 = Multiplicative

Definition at line 182 of file film_grain_params.h.

Referenced by ff_h2645_sei_to_frame(), and print_film_grain_params().

◆ log2_scale_factor

int AVFilmGrainH274Params::log2_scale_factor

Specifies a scale factor used in the film grain characterization equations.

Definition at line 187 of file film_grain_params.h.

Referenced by ff_h2645_sei_to_frame(), generate(), and print_film_grain_params().

◆ component_model_present

int AVFilmGrainH274Params::component_model_present[3]

Indicates if the modelling of film grain for a given component is present.

Definition at line 192 of file film_grain_params.h.

Referenced by ff_h2645_sei_to_frame(), ff_h274_apply_film_grain(), and print_film_grain_params().

◆ num_intensity_intervals

uint16_t AVFilmGrainH274Params::num_intensity_intervals[3]

Specifies the number of intensity intervals for which a specific set of model values has been estimated, with a range of [1, 256].

Definition at line 198 of file film_grain_params.h.

Referenced by ff_h2645_sei_to_frame(), ff_h274_apply_film_grain(), generate(), and print_film_grain_params().

◆ num_model_values

uint8_t AVFilmGrainH274Params::num_model_values[3]

Specifies the number of model values present for each intensity interval in which the film grain has been modelled, with a range of [1, 6].

Definition at line 204 of file film_grain_params.h.

Referenced by ff_h2645_sei_to_frame(), and print_film_grain_params().

◆ intensity_interval_lower_bound

uint8_t AVFilmGrainH274Params::intensity_interval_lower_bound[3][256]

Specifies the lower ounds of each intensity interval for whichthe set of model values applies for the component.

Definition at line 210 of file film_grain_params.h.

Referenced by ff_h2645_sei_to_frame(), generate(), and print_film_grain_params().

◆ intensity_interval_upper_bound

uint8_t AVFilmGrainH274Params::intensity_interval_upper_bound[3][256]

Specifies the upper bound of each intensity interval for which the set of model values applies for the component.

Definition at line 216 of file film_grain_params.h.

Referenced by ff_h2645_sei_to_frame(), and print_film_grain_params().

◆ comp_model_value

int16_t AVFilmGrainH274Params::comp_model_value[3][256][6]

Specifies the model values for the component for each intensity interval.

  • When model_id == 0, the following applies: For comp_model_value[y], the range of values is [0, 2^bit_depth_luma - 1] For comp_model_value[cb..cr], the range of values is [0, 2^bit_depth_chroma - 1]
  • Otherwise, the following applies: For comp_model_value[y], the range of values is [-2^(bit_depth_luma - 1), 2^(bit_depth_luma - 1) - 1] For comp_model_value[cb..cr], the range of values is [-2^(bit_depth_chroma - 1), 2^(bit_depth_chroma - 1) - 1]

Definition at line 227 of file film_grain_params.h.

Referenced by ff_h2645_sei_to_frame(), ff_h274_apply_film_grain(), generate(), and print_film_grain_params().


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