1# avcodec_audio_channel_layout.h 2 3## Overview 4 5The file declares the enums used for audio encoding and decoding. 6 7**File to include**: <multimedia/player_framework/avcodec_audio_channel_layout.h> 8 9**Library**: libnative_media_codecbase.so 10 11**System capability**: SystemCapability.Multimedia.Media.CodecBase 12 13**Since**: 9 14 15**Deprecated from**: 11 16 17**Related module**: [CodecBase](capi-codecbase.md) 18 19## Summary 20 21### Enums 22 23| Name| Description| 24| -- | -- | 25| [AudioChannelSet](#audiochannelset) | Enumerates the audio channels. Each channel is mapped to a variable of int64.| 26| [AudioChannelLayout](#audiochannellayout) | Enumerates the layouts of audio channels. The output format of the decoder is described using the channel layout of the codec.| 27 28## Enum Description 29 30### AudioChannelSet 31 32``` 33enum AudioChannelSet : uint64_t 34``` 35 36**Description** 37 38Enumerates the audio channels. Each channel is mapped to a variable of int64. 39 40**System capability**: SystemCapability.Multimedia.Media.CodecBase 41 42**Since**: 10 43 44**Deprecated from**: 11 45 46**Substitute**: [OH_AudioChannelSet](_core.md#oh_audiochannelset-1) 47 48| Value| Description| 49| -- | -- | 50| FRONT_LEFT = 1ULL << 0U | Front left channel.| 51| FRONT_RIGHT = 1ULL << 1U | Front right channel.| 52| FRONT_CENTER = 1ULL << 2U | Front center channel.| 53| LOW_FREQUENCY = 1ULL << 3U | Low-frequency channel.| 54| BACK_LEFT = 1ULL << 4U | Rear left channel.| 55| BACK_RIGHT = 1ULL << 5U | Rear right channel.| 56| FRONT_LEFT_OF_CENTER = 1ULL << 6U | Front left center channel.| 57| FRONT_RIGHT_OF_CENTER = 1ULL << 7U | Front right center channel.| 58| BACK_CENTER = 1ULL << 8U | Rear center channel.| 59| SIDE_LEFT = 1ULL << 9U | Left channel.| 60| SIDE_RIGHT = 1ULL << 10U | Right channel.| 61| TOP_CENTER = 1ULL << 11U | Top center channel.| 62| TOP_FRONT_LEFT = 1ULL << 12U | Top left front channel.| 63| TOP_FRONT_CENTER = 1ULL << 13U | Top center front channel.| 64| TOP_FRONT_RIGHT = 1ULL << 14U | Top right front channel.| 65| TOP_BACK_LEFT = 1ULL << 15U | Top left rear channel.| 66| TOP_BACK_CENTER = 1ULL << 16U | Top center rear channel.| 67| TOP_BACK_RIGHT = 1ULL << 17U | Top right rear channel.| 68| STEREO_LEFT = 1ULL << 29U | Stereo left channel.| 69| STEREO_RIGHT = 1ULL << 30U | Stereo right channel.| 70| WIDE_LEFT = 1ULL << 31U | Wide left channel.| 71| WIDE_RIGHT = 1ULL << 32U | Wide right channel.| 72| SURROUND_DIRECT_LEFT = 1ULL << 33U | Left surround channel.| 73| SURROUND_DIRECT_RIGHT = 1ULL << 34U | Right surround channel.| 74| LOW_FREQUENCY_2 = 1ULL << 35U | Low-frequency channel 2.| 75| TOP_SIDE_LEFT = 1ULL << 36U | Top left channel.| 76| TOP_SIDE_RIGHT = 1ULL << 37U | Top right channel.| 77| BOTTOM_FRONT_CENTER = 1ULL << 38U | Bottom center front channel.| 78| BOTTOM_FRONT_LEFT = 1ULL << 39U | Bottom left front channel.| 79| BOTTOM_FRONT_RIGHT = 1ULL << 40U | Bottom right front channel.| 80| AMBISONICS_ACN0 = 1ULL << 41U | Channel 0 for the zero-order stereo.| 81| AMBISONICS_ACN1 = 1ULL << 42U | Channel 1 for the first-order stereo.| 82| AMBISONICS_ACN2 = 1ULL << 43U | Channel 2 for the first-order stereo.| 83| AMBISONICS_ACN3 = 1ULL << 44U | Channel 3 for the first-order stereo.| 84| AMBISONICS_W = AMBISONICS_ACN0 | Equivalent to channel 0 for the zero-order stereo.| 85| AMBISONICS_Y = AMBISONICS_ACN1 | Equivalent to channel 1 for the first-order stereo.| 86| AMBISONICS_Z = AMBISONICS_ACN2 | Equivalent to channel 2 for the first-order stereo.| 87| AMBISONICS_X = AMBISONICS_ACN3 | Equivalent to channel 3 for the first-order stereo.| 88| AMBISONICS_ACN4 = 1ULL << 45U | Channel 4 for the second-order stereo.| 89| AMBISONICS_ACN5 = 1ULL << 46U | Channel 5 for the second-order stereo.| 90| AMBISONICS_ACN6 = 1ULL << 47U | Channel 6 for the second-order stereo.| 91| AMBISONICS_ACN7 = 1ULL << 48U | Channel 7 for the second-order stereo.| 92| AMBISONICS_ACN8 = 1ULL << 49U | Channel 8 for the second-order stereo.| 93| AMBISONICS_ACN9 = 1ULL << 50U | Channel 9 for the third-order stereo.| 94| AMBISONICS_ACN10 = 1ULL << 51U | Channel 10 for the third-order stereo.| 95| AMBISONICS_ACN11 = 1ULL << 52U | Channel 11 for the third-order stereo.| 96| AMBISONICS_ACN12 = 1ULL << 53U | Channel 12 for the third-order stereo.| 97| AMBISONICS_ACN13 = 1ULL << 54U | Channel 13 for the third-order stereo.| 98| AMBISONICS_ACN14 = 1ULL << 55U | Channel 14 for the third-order stereo.| 99| AMBISONICS_ACN15 = 1ULL << 56U | Channel 15 for the third-order stereo.| 100 101### AudioChannelLayout 102 103``` 104enum AudioChannelLayout : uint64_t 105``` 106 107**Description** 108 109Enumerates the layouts of audio channels. The output format of the decoder is described using the channel layout of the codec. 110 111**System capability**: SystemCapability.Multimedia.Media.CodecBase 112 113**Since**: 10 114 115**Deprecated from**: 11 116 117**Substitute**: [OH_AudioChannelLayout](_core.md#oh_audiochannellayout-1) 118 119| Value| Description| 120| -- | -- | 121| UNKNOWN_CHANNEL_LAYOUT = 0 | Unknown.| 122| MONO = (AudioChannelSet::FRONT_CENTER) | Mono layout.| 123| STEREO = (AudioChannelSet::FRONT_LEFT \| AudioChannelSet::FRONT_RIGHT) | Stereo layout.| 124| CH_2POINT1 = (STEREO \| AudioChannelSet::LOW_FREQUENCY) | 2.1 layout.| 125| CH_2_1 = (STEREO \| AudioChannelSet::BACK_CENTER) | 2_1 layout.| 126| SURROUND = (STEREO \| AudioChannelSet::FRONT_CENTER) | Surround layout.| 127| CH_3POINT1 = (SURROUND \| AudioChannelSet::LOW_FREQUENCY) | 3.1 layout.| 128| CH_4POINT0 = (SURROUND \| AudioChannelSet::BACK_CENTER) | 4.0 layout.| 129| CH_4POINT1 = (CH_4POINT0 \| AudioChannelSet::LOW_FREQUENCY) | 4.1 layout.| 130| CH_2_2 = (STEREO \| AudioChannelSet::SIDE_LEFT \| AudioChannelSet::SIDE_RIGHT) | 2_2 layout.| 131| QUAD = (STEREO \| AudioChannelSet::BACK_LEFT \| AudioChannelSet::BACK_RIGHT) | Quad layout.| 132| CH_5POINT0 = (SURROUND \| AudioChannelSet::SIDE_LEFT \| AudioChannelSet::SIDE_RIGHT) | 5.0 layout.| 133| CH_5POINT1 = (CH_5POINT0 \| AudioChannelSet::LOW_FREQUENCY) | 5.1 layout.| 134| CH_5POINT0_BACK = (SURROUND \| AudioChannelSet::BACK_LEFT \| AudioChannelSet::BACK_RIGHT) | 5.0 rear layout.| 135| CH_5POINT1_BACK = (CH_5POINT0_BACK \| AudioChannelSet::LOW_FREQUENCY) | 5.1 rear layout.| 136| CH_6POINT0 = (CH_5POINT0 \| AudioChannelSet::BACK_CENTER) | 6.0 layout.| 137| CH_6POINT0_FRONT = (CH_2_2 \| AudioChannelSet::FRONT_LEFT_OF_CENTER \| AudioChannelSet::FRONT_RIGHT_OF_CENTER) | 6.0 front layout.| 138| HEXAGONAL = (CH_5POINT0_BACK \| AudioChannelSet::BACK_CENTER) | Hexagonal layout.| 139| CH_6POINT1 = (CH_5POINT1 \| AudioChannelSet::BACK_CENTER) | 6.1 layout.| 140| CH_6POINT1_BACK = (CH_5POINT1_BACK \| AudioChannelSet::BACK_CENTER) | 6.1 rear layout.| 141| CH_6POINT1_FRONT = (CH_6POINT0_FRONT \| AudioChannelSet::LOW_FREQUENCY) | 6.1 front layout.| 142| CH_7POINT0 = (CH_5POINT0 \| AudioChannelSet::BACK_LEFT \| AudioChannelSet::BACK_RIGHT) | 7.0 layout.| 143| CH_7POINT0_FRONT = (CH_5POINT0 \| AudioChannelSet::FRONT_LEFT_OF_CENTER \| AudioChannelSet::FRONT_RIGHT_OF_CENTER) | 7.0 front layout.| 144| CH_7POINT1 = (CH_5POINT1 \| AudioChannelSet::BACK_LEFT \| AudioChannelSet::BACK_RIGHT) | 7.1 layout.| 145| CH_7POINT1_WIDE = (CH_5POINT1 \| AudioChannelSet::FRONT_LEFT_OF_CENTER \| AudioChannelSet::FRONT_RIGHT_OF_CENTER) | 7.1 wide layout.| 146| CH_7POINT1_WIDE_BACK = | 7.1 rear wide layout.| 147| CH_3POINT1POINT2 = (CH_3POINT1 \| AudioChannelSet::TOP_FRONT_LEFT \| AudioChannelSet::TOP_FRONT_RIGHT) | 3.1.2 layout.| 148| CH_5POINT1POINT2 = (CH_5POINT1 \| AudioChannelSet::TOP_SIDE_LEFT \| AudioChannelSet::TOP_SIDE_RIGHT) | 5.1.2 layout.| 149| (CH_5POINT1 \| AudioChannelSet::TOP_FRONT_LEFT \| AudioChannelSet::TOP_FRONT_RIGHT \|AudioChannelSet::TOP_BACK_LEFT \| AudioChannelSet::TOP_BACK_RIGHT) | 5.1.4 layout.| 150| CH_7POINT1POINT2 = (CH_7POINT1 \| AudioChannelSet::TOP_SIDE_LEFT \| AudioChannelSet::TOP_SIDE_RIGHT) | 7.1.2 layout.| 151| CH_7POINT1POINT4 = (CH_7POINT1 \| AudioChannelSet::TOP_FRONT_LEFT \| AudioChannelSet::TOP_FRONT_RIGHT \| AudioChannelSet::TOP_BACK_LEFT \| AudioChannelSet::TOP_BACK_RIGHT) | 7.1.4 layout.| 152| CH_9POINT1POINT4 = (CH_7POINT1POINT4 \| AudioChannelSet::WIDE_LEFT \| AudioChannelSet::WIDE_RIGHT) | 9.1.4 layout.| 153| CH_9POINT1POINT6 = (CH_9POINT1POINT4 \| AudioChannelSet::TOP_SIDE_LEFT \| AudioChannelSet::TOP_SIDE_RIGHT) | 9.1.6 layout.| 154| CH_10POINT2 = (AudioChannelSet::FRONT_LEFT \| AudioChannelSet::FRONT_RIGHT \| AudioChannelSet::FRONT_CENTER \| AudioChannelSet::TOP_FRONT_LEFT \| AudioChannelSet::TOP_FRONT_RIGHT \| AudioChannelSet::BACK_LEFT \| AudioChannelSet::BACK_RIGHT \| AudioChannelSet::BACK_CENTER \| AudioChannelSet::SIDE_LEFT \| AudioChannelSet::SIDE_RIGHT \| AudioChannelSet::WIDE_LEFT \| AudioChannelSet::WIDE_RIGHT) | 10.2 layout.| 155| CH_22POINT2 = (CH_7POINT1POINT4 \| AudioChannelSet::FRONT_LEFT_OF_CENTER \| AudioChannelSet::FRONT_RIGHT_OF_CENTER \| AudioChannelSet::BACK_CENTER \| AudioChannelSet::TOP_CENTER \| AudioChannelSet::TOP_FRONT_CENTER \| AudioChannelSet::TOP_BACK_CENTER \| AudioChannelSet::TOP_SIDE_LEFT \| AudioChannelSet::TOP_SIDE_RIGHT \| AudioChannelSet::BOTTOM_FRONT_LEFT \| AudioChannelSet::BOTTOM_FRONT_RIGHT \| AudioChannelSet::BOTTOM_FRONT_CENTER \| AudioChannelSet::LOW_FREQUENCY_2) | 22.2 layout.| 156| OCTAGONAL = (CH_5POINT0 \| AudioChannelSet::BACK_LEFT \| AudioChannelSet::BACK_CENTER \| AudioChannelSet::BACK_RIGHT) | Octagonal layout.| 157| HEXADECAGONAL = (OCTAGONAL \| AudioChannelSet::WIDE_LEFT \| AudioChannelSet::WIDE_RIGHT \| AudioChannelSet::TOP_BACK_LEFT \| AudioChannelSet::TOP_BACK_RIGHT \| AudioChannelSet::TOP_BACK_CENTER \| AudioChannelSet::TOP_FRONT_CENTER \| AudioChannelSet::TOP_FRONT_LEFT \| AudioChannelSet::TOP_FRONT_RIGHT)| Hexadecagonal layout.| 158| STEREO_DOWNMIX = (AudioChannelSet::STEREO_LEFT \| AudioChannelSet::STEREO_RIGHT) | Stereo downmix layout.| 159| HOA_FIRST = AudioChannelSet::AMBISONICS_ACN0 \| AudioChannelSet::AMBISONICS_ACN1 \| AudioChannelSet::AMBISONICS_ACN2 \| AudioChannelSet::AMBISONICS_ACN3 | High-Order Ambisonics (HOA) first-order layout.| 160| HOA_SECOND = HOA_FIRST \| AudioChannelSet::AMBISONICS_ACN4 \| AudioChannelSet::AMBISONICS_ACN5 \| AudioChannelSet::AMBISONICS_ACN6 \| AudioChannelSet::AMBISONICS_ACN7 \| AudioChannelSet::AMBISONICS_ACN8 | HOA second-order layout.| 161| HOA_THIRD = HOA_SECOND \| AudioChannelSet::AMBISONICS_ACN9 \| AudioChannelSet::AMBISONICS_ACN10 \| AudioChannelSet::AMBISONICS_ACN11 \| AudioChannelSet::AMBISONICS_ACN12 \| AudioChannelSet::AMBISONICS_ACN13 \| AudioChannelSet::AMBISONICS_ACN14 \| AudioChannelSet::AMBISONICS_ACN15 | HOA third-order layout.| 162