AVIAMFParamDefinition Struct Reference

Parameters as defined in section 3.6.1 of IAMF. More...

#include <iamf.h>

Data Fields
const AVClass *	av_class
size_t	subblocks_offset
	Offset in bytes from the start of this struct, at which the subblocks array is located. More...
size_t	subblock_size
	Size in bytes of each element in the subblocks array. More...
unsigned int	nb_subblocks
	Number of subblocks in the array. More...
enum AVIAMFParamDefinitionType	type
	Parameters type. More...
unsigned int	parameter_id
	Identifier for the paremeter substream. More...
unsigned int	parameter_rate
	Sample rate for the paremeter substream. More...
unsigned int	duration
	The accumulated duration of all blocks in this parameter definition, in units of 1 / parameter_rate. More...
unsigned int	constant_subblock_duration
	The duration of every subblock in the case where all subblocks, with the optional exception of the last subblock, have equal durations. More...

Detailed Description

Parameters as defined in section 3.6.1 of IAMF.

The struct is allocated by av_iamf_param_definition_alloc() along with an array of subblocks, its type depending on the value of type. This array is placed subblocks_offset bytes after the start of this struct.

Note

This struct's size is not a part of the public ABI.

Definition at line 184 of file iamf.h.

Field Documentation

av_class

const AVClass* AVIAMFParamDefinition::av_class

Definition at line 185 of file iamf.h.

Referenced by av_iamf_param_definition_alloc().

subblocks_offset

size_t AVIAMFParamDefinition::subblocks_offset

Offset in bytes from the start of this struct, at which the subblocks array is located.

Definition at line 191 of file iamf.h.

Referenced by av_iamf_param_definition_alloc(), and av_iamf_param_definition_get_subblock().

subblock_size

size_t AVIAMFParamDefinition::subblock_size

Size in bytes of each element in the subblocks array.

Definition at line 195 of file iamf.h.

Referenced by av_iamf_param_definition_alloc(), and av_iamf_param_definition_get_subblock().

nb_subblocks

unsigned int AVIAMFParamDefinition::nb_subblocks

Number of subblocks in the array.

Definition at line 199 of file iamf.h.

Referenced by av_iamf_param_definition_alloc(), ff_iamf_add_audio_element(), of_map_group(), param_definition(), param_parse(), parameter_block_obu(), print_iamf_param_definition(), and write_parameter_block().

type

enum AVIAMFParamDefinitionType AVIAMFParamDefinition::type

Parameters type.

Determines the type of the subblock elements.

Definition at line 204 of file iamf.h.

Referenced by av_iamf_param_definition_alloc(), param_definition(), parameter_block_obu(), print_iamf_param_definition(), and write_parameter_block().

parameter_id

unsigned int AVIAMFParamDefinition::parameter_id

Identifier for the paremeter substream.

Definition at line 209 of file iamf.h.

Referenced by add_param_definition(), ff_iamf_add_audio_element(), ff_iamf_add_mix_presentation(), ff_iamf_get_param_definition(), iamf_write_audio_element(), iamf_write_mixing_presentation(), param_definition(), param_parse(), parameter_block_obu(), print_iamf_param_definition(), and write_parameter_block().

parameter_rate

unsigned int AVIAMFParamDefinition::parameter_rate

Sample rate for the paremeter substream.

It must not be 0.

Definition at line 213 of file iamf.h.

Referenced by add_param_definition(), param_definition(), param_parse(), parameter_block_obu(), and print_iamf_param_definition().

duration

unsigned int AVIAMFParamDefinition::duration

The accumulated duration of all blocks in this parameter definition, in units of 1 / parameter_rate.

May be 0, in which case all duration values should be specified in another parameter definition referencing the same parameter_id.

Definition at line 222 of file iamf.h.

Referenced by add_param_definition(), param_definition(), param_parse(), parameter_block_obu(), print_iamf_param_definition(), and write_parameter_block().

constant_subblock_duration

unsigned int AVIAMFParamDefinition::constant_subblock_duration

The duration of every subblock in the case where all subblocks, with the optional exception of the last subblock, have equal durations.

Must be 0 if subblocks have different durations.

Definition at line 229 of file iamf.h.

Referenced by add_param_definition(), param_definition(), param_parse(), parameter_block_obu(), print_iamf_param_definition(), and write_parameter_block().

---

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

• libavutil/iamf.h