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

#include <iamf.h>

Data Fields
const AVClass *	av_class

unsigned int	audio_element_id
	The id of the Audio Element this submix element references. More...

AVIAMFParamDefinition *	element_mix_config
	Information required required for applying any processing to the referenced and rendered Audio Element before being summed with other processed Audio Elements. More...

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

enum AVIAMFHeadphonesMode	headphones_rendering_mode
	A value that indicates whether the referenced channel-based Audio Element shall be rendered to stereo loudspeakers or spatialized with a binaural renderer when played back on headphones. More...

AVDictionary *	annotations
	A dictionary of strings describing the submix in different languages. More...

Detailed Description

Submix element as defined in section 3.7 of IAMF.

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

Definition at line 437 of file iamf.h.

Field Documentation

◆ av_class

const AVClass* AVIAMFSubmixElement::av_class

Definition at line 438 of file iamf.h.

◆ audio_element_id

unsigned int AVIAMFSubmixElement::audio_element_id

The id of the Audio Element this submix element references.

Definition at line 443 of file iamf.h.

Referenced by dump_stream_group(), iamf_read_header(), iamf_write_mixing_presentation(), mix_presentation_obu(), of_map_group(), of_parse_iamf_submixes(), and print_iamf_submix_params().

◆ element_mix_config

AVIAMFParamDefinition* AVIAMFSubmixElement::element_mix_config

Information required required for applying any processing to the referenced and rendered Audio Element before being summed with other processed Audio Elements.

The type must be AV_IAMF_PARAMETER_DEFINITION_MIX_GAIN.

Definition at line 452 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_element_child_next().

◆ default_mix_gain

AVRational AVIAMFSubmixElement::default_mix_gain

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

Definition at line 460 of file iamf.h.

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

◆ headphones_rendering_mode

enum AVIAMFHeadphonesMode AVIAMFSubmixElement::headphones_rendering_mode

A value that indicates whether the referenced channel-based Audio Element shall be rendered to stereo loudspeakers or spatialized with a binaural renderer when played back on headphones.

If the Audio Element is not of type AV_IAMF_AUDIO_ELEMENT_TYPE_CHANNEL, then this field is undefined.

Definition at line 469 of file iamf.h.

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

◆ annotations

AVDictionary* AVIAMFSubmixElement::annotations

A dictionary of strings describing the submix in different languages.

Must have the same amount of entries as the mix's annotations, stored in the same order, and with the same key strings.

key is a string conforming to BCP-47 that specifies the language for the string stored in value.

Definition at line 481 of file iamf.h.

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

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

libavutil/iamf.h

Data Fields