IamfUtil

const val OUTPUT_LAYOUT_BINAURAL = 14: Int

Decoder rendered binaural audio.

const val OUTPUT_LAYOUT_IAMF_SOUND_SYSTEM_EXTENSION_0_1_0 = 12: Int

Mono.

const val OUTPUT_LAYOUT_IAMF_SOUND_SYSTEM_EXTENSION_2_3_0 = 11: Int

IAMF extension 3.1.2.

const val OUTPUT_LAYOUT_IAMF_SOUND_SYSTEM_EXTENSION_2_7_0 = 10: Int

IAMF extension 7.1.2.

const val OUTPUT_LAYOUT_IAMF_SOUND_SYSTEM_EXTENSION_6_9_0 = 13: Int

IAMF Extension 9.1.6.

const val OUTPUT_LAYOUT_ITU2051_SOUND_SYSTEM_A_0_2_0 = 0: Int

ITU-R B.S. 2051-3 sound system A (0+2+0), commonly known as stereo.

const val OUTPUT_LAYOUT_ITU2051_SOUND_SYSTEM_B_0_5_0 = 1: Int

ITU-R B.S. 2051-3 sound system B (0+5+0), commonly known as 5.1.

const val OUTPUT_LAYOUT_ITU2051_SOUND_SYSTEM_C_2_5_0 = 2: Int

ITU-R B.S. 2051-3 sound system C (2+5+0), commonly known as 5.1.2.

const val OUTPUT_LAYOUT_ITU2051_SOUND_SYSTEM_D_4_5_0 = 3: Int

ITU-R B.S. 2051-3 sound system D (4+5+0), commonly known as 5.1.4.

const val OUTPUT_LAYOUT_ITU2051_SOUND_SYSTEM_E_4_5_1 = 4: Int

ITU-R B.S. 2051-3 sound system E (4+5+1).

const val OUTPUT_LAYOUT_ITU2051_SOUND_SYSTEM_F_3_7_0 = 5: Int

ITU-R B.S. 2051-3 sound system F (3+7+0).

const val OUTPUT_LAYOUT_ITU2051_SOUND_SYSTEM_G_4_9_0 = 6: Int

ITU-R B.S. 2051-3 sound system G (4+9+0).

const val OUTPUT_LAYOUT_ITU2051_SOUND_SYSTEM_H_9_10_3 = 7: Int

ITU-R B.S. 2051-3 sound system H (9+10+3).

const val OUTPUT_LAYOUT_ITU2051_SOUND_SYSTEM_I_0_7_0 = 8: Int

ITU-R B.S. 2051-3 sound system I (0+7+0), commonly known as 7.1.

const val OUTPUT_LAYOUT_ITU2051_SOUND_SYSTEM_J_4_7_0 = 9: Int

ITU-R B.S. 2051-3 sound system J (4+7+0), commonly known as 7.1.4.

const val OUTPUT_LAYOUT_UNSET = -1: Int

Value to be used to not specify an output layout.

const val REQUESTED_MIX_PRESENTATION_ID_UNSET = -1: Long

Used to indicate no requested Mix Presentation ID when creating a decoder.

When this value is used, the decoder will select a Mix Presentation ID based on the default logic, including considering the requested OutputLayout, if provided.

java-static fun getChannelMaskForOutputLayout(@IamfUtil.OutputLayout outputLayout: Int): Int

Returns the Android channel mask that most closely matches the given IAMF output layout.

Some AudioFormat-defined channel masks do not exactly match IAMF/ITU spec. Where there are differences, this method returns the more exact IAMF version.

java-static fun getOutputChannelMaskForCurrentConfiguration(
    audioCapabilities: AudioCapabilities!
): Int

Returns an appropriate channel mask for the current AudioCapabilities.

This is used to set the channel count and channel mask when using the framework Codec2 software decoder, which takes a ChannelMask to indicate the output layout and does not currently support direct binaural output from the decoder.

@IamfUtil.OutputLayout
java-static fun getOutputLayoutForChannelMask(channelMask: Int): Int

Returns an IAMF output layout to try to match a given channel mask.

Where there are differences between the placement of speakers as defined by AudioFormat channel masks and channel masks matching the IAMF/ITU standard, we permissively match both.

@IamfUtil.OutputLayout
java-static fun getOutputLayoutForCurrentConfiguration(
    audioCapabilities: AudioCapabilities!,
    useIntegratedBinauralRenderer: Boolean
): Int

Returns an appropriate output layout for the current AudioCapabilities.

This is used to configure the IAMF extension decoder, which requires an OutputLayout to configure.