1 /*
2  * Copyright (C) 2023 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef AVCODEC_AUDIO_CHANNEL_LAYOUT_H
17 #define AVCODEC_AUDIO_CHANNEL_LAYOUT_H
18 #include <cstdint>
19 #ifdef __cplusplus
20 extern "C" {
21 #endif
22 
23 /**
24  * @brief Audio Channel Set
25  * A 64-bit integer with bits set for each channel.
26  * @syscap SystemCapability.Multimedia.Media.CodecBase
27  * @deprecated since 11
28  * @useinstead OH_AudioChannelSet
29  * @since 10
30  */
31 enum AudioChannelSet : uint64_t {
32     FRONT_LEFT = 1ULL << 0U,
33     FRONT_RIGHT = 1ULL << 1U,
34     FRONT_CENTER = 1ULL << 2U,
35     LOW_FREQUENCY = 1ULL << 3U,
36     BACK_LEFT = 1ULL << 4U,
37     BACK_RIGHT = 1ULL << 5U,
38     FRONT_LEFT_OF_CENTER = 1ULL << 6U,
39     FRONT_RIGHT_OF_CENTER = 1ULL << 7U,
40     BACK_CENTER = 1ULL << 8U,
41     SIDE_LEFT = 1ULL << 9U,
42     SIDE_RIGHT = 1ULL << 10U,
43     TOP_CENTER = 1ULL << 11U,
44     TOP_FRONT_LEFT = 1ULL << 12U,
45     TOP_FRONT_CENTER = 1ULL << 13U,
46     TOP_FRONT_RIGHT = 1ULL << 14U,
47     TOP_BACK_LEFT = 1ULL << 15U,
48     TOP_BACK_CENTER = 1ULL << 16U,
49     TOP_BACK_RIGHT = 1ULL << 17U,
50     STEREO_LEFT = 1ULL << 29U,
51     STEREO_RIGHT = 1ULL << 30U,
52     WIDE_LEFT = 1ULL << 31U,
53     WIDE_RIGHT = 1ULL << 32U,
54     SURROUND_DIRECT_LEFT = 1ULL << 33U,
55     SURROUND_DIRECT_RIGHT = 1ULL << 34U,
56     LOW_FREQUENCY_2 = 1ULL << 35U,
57     TOP_SIDE_LEFT = 1ULL << 36U,
58     TOP_SIDE_RIGHT = 1ULL << 37U,
59     BOTTOM_FRONT_CENTER = 1ULL << 38U,
60     BOTTOM_FRONT_LEFT = 1ULL << 39U,
61     BOTTOM_FRONT_RIGHT = 1ULL << 40U,
62 
63     // Ambisonics ACN formats
64     // 0th and first order ambisonics ACN
65     AMBISONICS_ACN0 = 1ULL << 41U,  /** 0th ambisonics channel number 0. */
66     AMBISONICS_ACN1 = 1ULL << 42U,  /** first-order ambisonics channel number 1. */
67     AMBISONICS_ACN2 = 1ULL << 43U,  /** first-order ambisonics channel number 2. */
68     AMBISONICS_ACN3 = 1ULL << 44U,  /** first-order ambisonics channel number 3. */
69     AMBISONICS_W = AMBISONICS_ACN0, /** same as 0th ambisonics channel number 0. */
70     AMBISONICS_Y = AMBISONICS_ACN1, /** same as first-order ambisonics channel number 1. */
71     AMBISONICS_Z = AMBISONICS_ACN2, /** same as first-order ambisonics channel number 2. */
72     AMBISONICS_X = AMBISONICS_ACN3, /** same as first-order ambisonics channel number 3. */
73 
74     // second order ambisonics ACN
75     AMBISONICS_ACN4 = 1ULL << 45U, /** second-order ambisonics channel number 4. */
76     AMBISONICS_ACN5 = 1ULL << 46U, /** second-order ambisonics channel number 5. */
77     AMBISONICS_ACN6 = 1ULL << 47U, /** second-order ambisonics channel number 6. */
78     AMBISONICS_ACN7 = 1ULL << 48U, /** second-order ambisonics channel number 7. */
79     AMBISONICS_ACN8 = 1ULL << 49U, /** second-order ambisonics channel number 8. */
80 
81     // third order ambisonics ACN
82     AMBISONICS_ACN9 = 1ULL << 50U,  /** third-order ambisonics channel number 9. */
83     AMBISONICS_ACN10 = 1ULL << 51U, /** third-order ambisonics channel number 10. */
84     AMBISONICS_ACN11 = 1ULL << 52U, /** third-order ambisonics channel number 11. */
85     AMBISONICS_ACN12 = 1ULL << 53U, /** third-order ambisonics channel number 12. */
86     AMBISONICS_ACN13 = 1ULL << 54U, /** third-order ambisonics channel number 13. */
87     AMBISONICS_ACN14 = 1ULL << 55U, /** third-order ambisonics channel number 14. */
88     AMBISONICS_ACN15 = 1ULL << 56U, /** third-order ambisonics channel number 15. */
89 };
90 
91 /**
92  * @brief Audio AudioChannel Layout
93  * Indicates that the channel order in which the user requests decoder output
94  * is the native codec channel order.
95  * @syscap SystemCapability.Multimedia.Media.CodecBase
96  * @deprecated since 11
97  * @useinstead OH_AudioChannelLayout
98  * @since 10
99  */
100 enum AudioChannelLayout : uint64_t {
101     UNKNOWN_CHANNEL_LAYOUT = 0,
102     MONO = (AudioChannelSet::FRONT_CENTER),
103     STEREO = (AudioChannelSet::FRONT_LEFT | AudioChannelSet::FRONT_RIGHT),
104     CH_2POINT1 = (STEREO | AudioChannelSet::LOW_FREQUENCY),
105     CH_2_1 = (STEREO | AudioChannelSet::BACK_CENTER),
106     SURROUND = (STEREO | AudioChannelSet::FRONT_CENTER),
107     CH_3POINT1 = (SURROUND | AudioChannelSet::LOW_FREQUENCY),
108     CH_4POINT0 = (SURROUND | AudioChannelSet::BACK_CENTER),
109     CH_4POINT1 = (CH_4POINT0 | AudioChannelSet::LOW_FREQUENCY),
110     CH_2_2 = (STEREO | AudioChannelSet::SIDE_LEFT | AudioChannelSet::SIDE_RIGHT),
111     QUAD = (STEREO | AudioChannelSet::BACK_LEFT | AudioChannelSet::BACK_RIGHT),
112     CH_5POINT0 = (SURROUND | AudioChannelSet::SIDE_LEFT | AudioChannelSet::SIDE_RIGHT),
113     CH_5POINT1 = (CH_5POINT0 | AudioChannelSet::LOW_FREQUENCY),
114     CH_5POINT0_BACK = (SURROUND | AudioChannelSet::BACK_LEFT | AudioChannelSet::BACK_RIGHT),
115     CH_5POINT1_BACK = (CH_5POINT0_BACK | AudioChannelSet::LOW_FREQUENCY),
116     CH_6POINT0 = (CH_5POINT0 | AudioChannelSet::BACK_CENTER),
117     CH_6POINT0_FRONT = (CH_2_2 | AudioChannelSet::FRONT_LEFT_OF_CENTER | AudioChannelSet::FRONT_RIGHT_OF_CENTER),
118     HEXAGONAL = (CH_5POINT0_BACK | AudioChannelSet::BACK_CENTER),
119     CH_6POINT1 = (CH_5POINT1 | AudioChannelSet::BACK_CENTER),
120     CH_6POINT1_BACK = (CH_5POINT1_BACK | AudioChannelSet::BACK_CENTER),
121     CH_6POINT1_FRONT = (CH_6POINT0_FRONT | AudioChannelSet::LOW_FREQUENCY),
122     CH_7POINT0 = (CH_5POINT0 | AudioChannelSet::BACK_LEFT | AudioChannelSet::BACK_RIGHT),
123     CH_7POINT0_FRONT = (CH_5POINT0 | AudioChannelSet::FRONT_LEFT_OF_CENTER | AudioChannelSet::FRONT_RIGHT_OF_CENTER),
124     CH_7POINT1 = (CH_5POINT1 | AudioChannelSet::BACK_LEFT | AudioChannelSet::BACK_RIGHT),
125     CH_7POINT1_WIDE = (CH_5POINT1 | AudioChannelSet::FRONT_LEFT_OF_CENTER | AudioChannelSet::FRONT_RIGHT_OF_CENTER),
126     CH_7POINT1_WIDE_BACK =
127         (CH_5POINT1_BACK | AudioChannelSet::FRONT_LEFT_OF_CENTER | AudioChannelSet::FRONT_RIGHT_OF_CENTER),
128     CH_3POINT1POINT2 = (CH_3POINT1 | AudioChannelSet::TOP_FRONT_LEFT | AudioChannelSet::TOP_FRONT_RIGHT),
129     CH_5POINT1POINT2 = (CH_5POINT1 | AudioChannelSet::TOP_SIDE_LEFT | AudioChannelSet::TOP_SIDE_RIGHT),
130     CH_5POINT1POINT4 = (CH_5POINT1 | AudioChannelSet::TOP_FRONT_LEFT | AudioChannelSet::TOP_FRONT_RIGHT |
131                         AudioChannelSet::TOP_BACK_LEFT | AudioChannelSet::TOP_BACK_RIGHT),
132     CH_7POINT1POINT2 = (CH_7POINT1 | AudioChannelSet::TOP_SIDE_LEFT | AudioChannelSet::TOP_SIDE_RIGHT),
133     CH_7POINT1POINT4 = (CH_7POINT1 | AudioChannelSet::TOP_FRONT_LEFT | AudioChannelSet::TOP_FRONT_RIGHT |
134                         AudioChannelSet::TOP_BACK_LEFT | AudioChannelSet::TOP_BACK_RIGHT),
135     CH_9POINT1POINT4 = (CH_7POINT1POINT4 | AudioChannelSet::WIDE_LEFT | AudioChannelSet::WIDE_RIGHT),
136     CH_9POINT1POINT6 = (CH_9POINT1POINT4 | AudioChannelSet::TOP_SIDE_LEFT | AudioChannelSet::TOP_SIDE_RIGHT),
137     CH_10POINT2 = (AudioChannelSet::FRONT_LEFT | AudioChannelSet::FRONT_RIGHT | AudioChannelSet::FRONT_CENTER |
138                    AudioChannelSet::TOP_FRONT_LEFT | AudioChannelSet::TOP_FRONT_RIGHT | AudioChannelSet::BACK_LEFT |
139                    AudioChannelSet::BACK_RIGHT | AudioChannelSet::BACK_CENTER | AudioChannelSet::SIDE_LEFT |
140                    AudioChannelSet::SIDE_RIGHT | AudioChannelSet::WIDE_LEFT | AudioChannelSet::WIDE_RIGHT),
141     CH_22POINT2 = (CH_7POINT1POINT4 | AudioChannelSet::FRONT_LEFT_OF_CENTER | AudioChannelSet::FRONT_RIGHT_OF_CENTER |
142                    AudioChannelSet::BACK_CENTER | AudioChannelSet::TOP_CENTER | AudioChannelSet::TOP_FRONT_CENTER |
143                    AudioChannelSet::TOP_BACK_CENTER | AudioChannelSet::TOP_SIDE_LEFT | AudioChannelSet::TOP_SIDE_RIGHT |
144                    AudioChannelSet::BOTTOM_FRONT_LEFT | AudioChannelSet::BOTTOM_FRONT_RIGHT |
145                    AudioChannelSet::BOTTOM_FRONT_CENTER | AudioChannelSet::LOW_FREQUENCY_2),
146     OCTAGONAL = (CH_5POINT0 | AudioChannelSet::BACK_LEFT | AudioChannelSet::BACK_CENTER | AudioChannelSet::BACK_RIGHT),
147     HEXADECAGONAL =
148         (OCTAGONAL | AudioChannelSet::WIDE_LEFT | AudioChannelSet::WIDE_RIGHT | AudioChannelSet::TOP_BACK_LEFT |
149          AudioChannelSet::TOP_BACK_RIGHT | AudioChannelSet::TOP_BACK_CENTER | AudioChannelSet::TOP_FRONT_CENTER |
150          AudioChannelSet::TOP_FRONT_LEFT | AudioChannelSet::TOP_FRONT_RIGHT),
151     STEREO_DOWNMIX = (AudioChannelSet::STEREO_LEFT | AudioChannelSet::STEREO_RIGHT),
152 
153     HOA_FIRST = AudioChannelSet::AMBISONICS_ACN0 | AudioChannelSet::AMBISONICS_ACN1 | AudioChannelSet::AMBISONICS_ACN2 |
154                 AudioChannelSet::AMBISONICS_ACN3,
155     HOA_SECOND = HOA_FIRST | AudioChannelSet::AMBISONICS_ACN4 | AudioChannelSet::AMBISONICS_ACN5 |
156                  AudioChannelSet::AMBISONICS_ACN6 | AudioChannelSet::AMBISONICS_ACN7 | AudioChannelSet::AMBISONICS_ACN8,
157     HOA_THIRD = HOA_SECOND | AudioChannelSet::AMBISONICS_ACN9 | AudioChannelSet::AMBISONICS_ACN10 |
158                 AudioChannelSet::AMBISONICS_ACN11 | AudioChannelSet::AMBISONICS_ACN12 |
159                 AudioChannelSet::AMBISONICS_ACN13 | AudioChannelSet::AMBISONICS_ACN14 |
160                 AudioChannelSet::AMBISONICS_ACN15,
161 };
162 #ifdef __cplusplus
163 }
164 #endif
165 #endif