FFmpeg
Data Fields
AVIAMFAudioElement Struct Reference

Information on how to combine one or more audio streams, as defined in section 3.6 of IAMF. More...

#include <iamf.h>

Data Fields

const AVClassav_class
 
AVIAMFLayer ** layers
 
unsigned int nb_layers
 Number of layers, or channel groups, in the Audio Element. More...
 
AVIAMFParamDefinitiondemixing_info
 Demixing information used to reconstruct a scalable channel audio representation. More...
 
AVIAMFParamDefinitionrecon_gain_info
 Recon gain information used to reconstruct a scalable channel audio representation. More...
 
enum AVIAMFAudioElementType audio_element_type
 Audio element type as defined in section 3.6 of IAMF. More...
 
unsigned int default_w
 Default weight value as defined in section 3.6 of IAMF. More...
 

Detailed Description

Information on how to combine one or more audio streams, as defined in section 3.6 of IAMF.

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

Definition at line 347 of file iamf.h.

Field Documentation

◆ av_class

const AVClass* AVIAMFAudioElement::av_class

Definition at line 348 of file iamf.h.

Referenced by av_iamf_audio_element_alloc().

◆ layers

AVIAMFLayer** AVIAMFAudioElement::layers

◆ nb_layers

unsigned int AVIAMFAudioElement::nb_layers

Number of layers, or channel groups, in the Audio Element.

There may be 6 layers at most, and for audio_element_type AV_IAMF_AUDIO_ELEMENT_TYPE_SCENE, there may be exactly 1.

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

Definition at line 359 of file iamf.h.

Referenced by av_iamf_audio_element_free(), dump_stream_group(), ff_iamf_add_audio_element(), iamf_write_audio_element(), of_parse_iamf_audio_element_layers(), parameter_block_obu(), print_iamf_audio_element_params(), scalable_channel_layout_config(), and write_parameter_block().

◆ demixing_info

AVIAMFParamDefinition* AVIAMFAudioElement::demixing_info

Demixing information used to reconstruct a scalable channel audio representation.

The type must be AV_IAMF_PARAMETER_DEFINITION_DEMIXING.

Definition at line 367 of file iamf.h.

Referenced by audio_element_obu(), av_iamf_audio_element_free(), ff_iamf_add_audio_element(), iamf_write_audio_element(), of_map_group(), of_parse_iamf_audio_element_layers(), and print_iamf_audio_element_params().

◆ recon_gain_info

AVIAMFParamDefinition* AVIAMFAudioElement::recon_gain_info

Recon gain information used to reconstruct a scalable channel audio representation.

The type must be AV_IAMF_PARAMETER_DEFINITION_RECON_GAIN.

Definition at line 374 of file iamf.h.

Referenced by audio_element_obu(), av_iamf_audio_element_free(), ff_iamf_add_audio_element(), iamf_write_audio_element(), of_map_group(), of_parse_iamf_audio_element_layers(), and print_iamf_audio_element_params().

◆ audio_element_type

enum AVIAMFAudioElementType AVIAMFAudioElement::audio_element_type

Audio element type as defined in section 3.6 of IAMF.

Definition at line 379 of file iamf.h.

Referenced by audio_element_obu(), ff_iamf_add_audio_element(), iamf_write_audio_element(), and print_iamf_audio_element_params().

◆ default_w

unsigned int AVIAMFAudioElement::default_w

Default weight value as defined in section 3.6 of IAMF.

Definition at line 384 of file iamf.h.

Referenced by iamf_write_audio_element(), param_parse(), and print_iamf_audio_element_params().


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