FFmpeg
Data Fields
AVIAMFSubmix Struct Reference

Submix layout as defined in section 3.7 of IAMF. More...

#include <iamf.h>

Data Fields

const AVClassav_class
 
AVIAMFSubmixElement ** elements
 Array of submix elements. More...
 
unsigned int nb_elements
 Number of elements in the submix. More...
 
AVIAMFSubmixLayout ** layouts
 Array of submix layouts. More...
 
unsigned int nb_layouts
 Number of layouts in the submix. More...
 
AVIAMFParamDefinitionoutput_mix_config
 Information required for post-processing the mixed audio signal to generate the audio signal for playback. More...
 
AVRational default_mix_gain
 Default mix gain value to apply when there are no AVIAMFParamDefinition with output_mix_config's parameter_id available for a given audio frame. More...
 

Detailed Description

Submix layout as defined in section 3.7 of IAMF.

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

Definition at line 543 of file iamf.h.

Field Documentation

◆ av_class

const AVClass* AVIAMFSubmix::av_class

Definition at line 544 of file iamf.h.

◆ elements

AVIAMFSubmixElement** AVIAMFSubmix::elements

Array of submix elements.

Set by av_iamf_submix_add_element(), must not be modified by any other code.

Definition at line 552 of file iamf.h.

Referenced by av_iamf_mix_presentation_free(), dump_stream_group(), ff_iamf_add_mix_presentation(), iamf_read_header(), iamf_write_mixing_presentation(), of_map_group(), and print_iamf_submix_params().

◆ nb_elements

unsigned int AVIAMFSubmix::nb_elements

◆ layouts

AVIAMFSubmixLayout** AVIAMFSubmix::layouts

Array of submix layouts.

Set by av_iamf_submix_add_layout(), must not be modified by any other code.

Definition at line 567 of file iamf.h.

Referenced by av_iamf_mix_presentation_free(), dump_stream_group(), iamf_write_mixing_presentation(), and print_iamf_submix_params().

◆ nb_layouts

unsigned int AVIAMFSubmix::nb_layouts

Number of layouts in the submix.

Set by av_iamf_submix_add_layout(), must not be modified by any other code.

Definition at line 574 of file iamf.h.

Referenced by av_iamf_mix_presentation_free(), dump_stream_group(), iamf_write_mixing_presentation(), and print_iamf_submix_params().

◆ output_mix_config

AVIAMFParamDefinition* AVIAMFSubmix::output_mix_config

Information required for post-processing the mixed audio signal to generate the audio signal for playback.

The type must be AV_IAMF_PARAMETER_DEFINITION_MIX_GAIN.

Definition at line 582 of file iamf.h.

Referenced by av_iamf_mix_presentation_free(), ff_iamf_add_mix_presentation(), iamf_write_mixing_presentation(), mix_presentation_obu(), of_map_group(), of_parse_iamf_submixes(), print_iamf_submix_params(), and submix_presentation_child_next().

◆ default_mix_gain

AVRational AVIAMFSubmix::default_mix_gain

Default mix gain value to apply when there are no AVIAMFParamDefinition with output_mix_config's parameter_id available for a given audio frame.

Definition at line 590 of file iamf.h.

Referenced by iamf_write_mixing_presentation(), mix_presentation_obu(), and print_iamf_submix_params().


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