1 /*
2 * Copyright (C) 2022 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 #pragma once
18
19 #include <algorithm>
20 #include <array>
21 #include <initializer_list>
22 #include <regex>
23 #include <type_traits>
24
25 #include <aidl/android/media/audio/common/AudioChannelLayout.h>
26 #include <aidl/android/media/audio/common/AudioDeviceType.h>
27 #include <aidl/android/media/audio/common/AudioFormatDescription.h>
28 #include <aidl/android/media/audio/common/AudioInputFlags.h>
29 #include <aidl/android/media/audio/common/AudioIoFlags.h>
30 #include <aidl/android/media/audio/common/AudioMode.h>
31 #include <aidl/android/media/audio/common/AudioOutputFlags.h>
32 #include <aidl/android/media/audio/common/PcmType.h>
33 #include <android/binder_auto_utils.h>
34 #include <utils/FastStrcmp.h>
35
36 namespace ndk {
37
38 // This enables use of 'error/expected_utils' for ScopedAStatus.
39
errorIsOk(const ScopedAStatus & s)40 inline bool errorIsOk(const ScopedAStatus& s) {
41 return s.isOk();
42 }
43
errorToString(const ScopedAStatus & s)44 inline std::string errorToString(const ScopedAStatus& s) {
45 return s.getDescription();
46 }
47
48 } // namespace ndk
49
50 namespace aidl::android::hardware::audio::common {
51
52 // TODO: b/275135031 - move this string to AIDL interfaces.
53 static constexpr char kDumpFromAudioServerArgument[] = "dump_from_audioserver";
54
55 // Some values are reserved for use by the system code only.
56 // HALs must not accept or emit values outside from the provided list.
57 constexpr std::array<::aidl::android::media::audio::common::AudioMode, 5> kValidAudioModes = {
58 ::aidl::android::media::audio::common::AudioMode::NORMAL,
59 ::aidl::android::media::audio::common::AudioMode::RINGTONE,
60 ::aidl::android::media::audio::common::AudioMode::IN_CALL,
61 ::aidl::android::media::audio::common::AudioMode::IN_COMMUNICATION,
62 ::aidl::android::media::audio::common::AudioMode::CALL_SCREEN,
63 };
64
iequals(const std::string & str1,const std::string & str2)65 constexpr bool iequals(const std::string& str1, const std::string& str2) {
66 return str1.length() == str2.length() &&
67 !fasticmp<strncmp>(str1.c_str(), str2.c_str(), str1.length());
68 }
69
getPcmSampleSizeInBytes(::aidl::android::media::audio::common::PcmType pcm)70 constexpr size_t getPcmSampleSizeInBytes(::aidl::android::media::audio::common::PcmType pcm) {
71 using ::aidl::android::media::audio::common::PcmType;
72 switch (pcm) {
73 case PcmType::UINT_8_BIT:
74 return 1;
75 case PcmType::INT_16_BIT:
76 return 2;
77 case PcmType::INT_32_BIT:
78 return 4;
79 case PcmType::FIXED_Q_8_24:
80 return 4;
81 case PcmType::FLOAT_32_BIT:
82 return 4;
83 case PcmType::INT_24_BIT:
84 return 3;
85 }
86 return 0;
87 }
88
89 constexpr size_t getChannelCount(
90 const ::aidl::android::media::audio::common::AudioChannelLayout& layout,
91 int32_t mask = std::numeric_limits<int32_t>::max()) {
92 using Tag = ::aidl::android::media::audio::common::AudioChannelLayout::Tag;
93 switch (layout.getTag()) {
94 case Tag::none:
95 return 0;
96 case Tag::invalid:
97 return 0;
98 case Tag::indexMask:
99 return __builtin_popcount(layout.get<Tag::indexMask>() & mask);
100 case Tag::layoutMask:
101 return __builtin_popcount(layout.get<Tag::layoutMask>() & mask);
102 case Tag::voiceMask:
103 return __builtin_popcount(layout.get<Tag::voiceMask>() & mask);
104 }
105 return 0;
106 }
107
getFrameSizeInBytes(const::aidl::android::media::audio::common::AudioFormatDescription & format,const::aidl::android::media::audio::common::AudioChannelLayout & layout)108 constexpr size_t getFrameSizeInBytes(
109 const ::aidl::android::media::audio::common::AudioFormatDescription& format,
110 const ::aidl::android::media::audio::common::AudioChannelLayout& layout) {
111 if (format == ::aidl::android::media::audio::common::AudioFormatDescription{}) {
112 // Unspecified format.
113 return 0;
114 }
115 using ::aidl::android::media::audio::common::AudioFormatType;
116 if (format.type == AudioFormatType::PCM) {
117 return getPcmSampleSizeInBytes(format.pcm) * getChannelCount(layout);
118 } else if (format.type == AudioFormatType::NON_PCM) {
119 // For non-PCM formats always use the underlying PCM size. The default value for
120 // PCM is "UINT_8_BIT", thus non-encapsulated streams have the frame size of 1.
121 return getPcmSampleSizeInBytes(format.pcm);
122 }
123 // Something unexpected.
124 return 0;
125 }
126
isDefaultAudioFormat(const::aidl::android::media::audio::common::AudioFormatDescription & desc)127 constexpr bool isDefaultAudioFormat(
128 const ::aidl::android::media::audio::common::AudioFormatDescription& desc) {
129 return desc.type == ::aidl::android::media::audio::common::AudioFormatType::DEFAULT &&
130 desc.pcm == ::aidl::android::media::audio::common::PcmType::DEFAULT &&
131 desc.encoding.empty();
132 }
133
isTelephonyDeviceType(::aidl::android::media::audio::common::AudioDeviceType device)134 constexpr bool isTelephonyDeviceType(
135 ::aidl::android::media::audio::common::AudioDeviceType device) {
136 return device == ::aidl::android::media::audio::common::AudioDeviceType::IN_TELEPHONY_RX ||
137 device == ::aidl::android::media::audio::common::AudioDeviceType::OUT_TELEPHONY_TX;
138 }
139
isValidAudioMode(::aidl::android::media::audio::common::AudioMode mode)140 constexpr bool isValidAudioMode(::aidl::android::media::audio::common::AudioMode mode) {
141 return std::find(kValidAudioModes.begin(), kValidAudioModes.end(), mode) !=
142 kValidAudioModes.end();
143 }
144
maybeVendorExtension(const std::string & s)145 static inline bool maybeVendorExtension(const std::string& s) {
146 // Only checks whether the string starts with the "vendor prefix".
147 static const std::string vendorPrefix = "VX_";
148 return s.size() > vendorPrefix.size() && s.substr(0, vendorPrefix.size()) == vendorPrefix;
149 }
150
isVendorExtension(const std::string & s)151 static inline bool isVendorExtension(const std::string& s) {
152 // Must be the same as defined in {Playback|Record}TrackMetadata.aidl
153 static const std::regex vendorExtension("VX_[A-Z0-9]{3,}_[_A-Z0-9]+");
154 return std::regex_match(s.begin(), s.end(), vendorExtension);
155 }
156
157 // The helper functions defined below are only applicable to the case when an enum type
158 // specifies zero-based bit positions, not bit masks themselves. This is why instantiation
159 // is restricted to certain enum types.
160 template <typename E>
161 using is_bit_position_enum = std::integral_constant<
162 bool, std::is_same_v<E, ::aidl::android::media::audio::common::AudioInputFlags> ||
163 std::is_same_v<E, ::aidl::android::media::audio::common::AudioOutputFlags>>;
164
165 template <typename E, typename U = std::underlying_type_t<E>,
166 typename = std::enable_if_t<is_bit_position_enum<E>::value>>
makeBitPositionFlagMask(E flag)167 constexpr U makeBitPositionFlagMask(E flag) {
168 return 1 << static_cast<U>(flag);
169 }
170
171 template <typename E, typename U = std::underlying_type_t<E>,
172 typename = std::enable_if_t<is_bit_position_enum<E>::value>>
isBitPositionFlagSet(U mask,E flag)173 constexpr bool isBitPositionFlagSet(U mask, E flag) {
174 return (mask & makeBitPositionFlagMask(flag)) != 0;
175 }
176
177 template <typename E, typename U = std::underlying_type_t<E>,
178 typename = std::enable_if_t<is_bit_position_enum<E>::value>>
makeBitPositionFlagMask(std::initializer_list<E> flags)179 constexpr U makeBitPositionFlagMask(std::initializer_list<E> flags) {
180 U result = 0;
181 for (const auto flag : flags) {
182 result |= makeBitPositionFlagMask(flag);
183 }
184 return result;
185 }
186
187 template <typename E, typename U = std::underlying_type_t<E>,
188 typename = std::enable_if_t<is_bit_position_enum<E>::value>>
isAnyBitPositionFlagSet(U mask,std::initializer_list<E> flags)189 constexpr bool isAnyBitPositionFlagSet(U mask, std::initializer_list<E> flags) {
190 return (mask & makeBitPositionFlagMask<E>(flags)) != 0;
191 }
192
frameCountFromDurationUs(long durationUs,int32_t sampleRateHz)193 constexpr int32_t frameCountFromDurationUs(long durationUs, int32_t sampleRateHz) {
194 return (static_cast<long long>(durationUs) * sampleRateHz) / 1000000LL;
195 }
196
frameCountFromDurationMs(int32_t durationMs,int32_t sampleRateHz)197 constexpr int32_t frameCountFromDurationMs(int32_t durationMs, int32_t sampleRateHz) {
198 return frameCountFromDurationUs(durationMs * 1000, sampleRateHz);
199 }
200
hasMmapFlag(const::aidl::android::media::audio::common::AudioIoFlags & flags)201 constexpr bool hasMmapFlag(const ::aidl::android::media::audio::common::AudioIoFlags& flags) {
202 return (flags.getTag() == ::aidl::android::media::audio::common::AudioIoFlags::Tag::input &&
203 isBitPositionFlagSet(
204 flags.get<::aidl::android::media::audio::common::AudioIoFlags::Tag::input>(),
205 ::aidl::android::media::audio::common::AudioInputFlags::MMAP_NOIRQ)) ||
206 (flags.getTag() == ::aidl::android::media::audio::common::AudioIoFlags::Tag::output &&
207 isBitPositionFlagSet(
208 flags.get<::aidl::android::media::audio::common::AudioIoFlags::Tag::output>(),
209 ::aidl::android::media::audio::common::AudioOutputFlags::MMAP_NOIRQ));
210 }
211
212 } // namespace aidl::android::hardware::audio::common
213