FFmpeg
Data Fields
AVFilmGrainParams Struct Reference

This structure describes how to handle film grain synthesis in video for specific codecs. More...

#include <film_grain_params.h>

Data Fields

enum AVFilmGrainParamsType type
 Specifies the codec for which this structure is valid. More...
 
uint64_t seed
 Seed to use for the synthesis process, if the codec allows for it. More...
 
union {
   AVFilmGrainAOMParams   aom
 
   AVFilmGrainH274Params   h274
 
codec
 Additional fields may be added both here and in any structure included. More...
 

Detailed Description

This structure describes how to handle film grain synthesis in video for specific codecs.

Must be present on every frame where film grain is meant to be synthesised for correct presentation.

Note
The struct must be allocated with av_film_grain_params_alloc() and its size is not a part of the public ABI.

Definition at line 216 of file film_grain_params.h.

Field Documentation

◆ type

enum AVFilmGrainParamsType AVFilmGrainParams::type

Specifies the codec for which this structure is valid.

Definition at line 220 of file film_grain_params.h.

Referenced by export_film_grain(), ff_h274_apply_film_grain(), h264_export_frame_props(), libdav1d_receive_frame(), and set_side_data().

◆ seed

uint64_t AVFilmGrainParams::seed

Seed to use for the synthesis process, if the codec allows for it.

Note
For H.264, this refers to pic_offset as defined in SMPTE RDD 5-2006.

Definition at line 228 of file film_grain_params.h.

Referenced by export_film_grain(), ff_h274_apply_film_grain(), h264_export_frame_props(), libdav1d_receive_frame(), and set_side_data().

◆ aom

AVFilmGrainAOMParams AVFilmGrainParams::aom

Definition at line 236 of file film_grain_params.h.

Referenced by export_film_grain(), and libdav1d_receive_frame().

◆ h274

AVFilmGrainH274Params AVFilmGrainParams::h274

◆ codec

union { ... } AVFilmGrainParams::codec

Additional fields may be added both here and in any structure included.

If a codec's film grain structure differs slightly over another codec's, fields within may change meaning depending on the type.

Referenced by export_film_grain(), ff_h274_apply_film_grain(), h264_export_frame_props(), libdav1d_receive_frame(), and set_side_data().


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