blob: d714ef4ab86356fdc285a700e1da1229f57f03d4 [file] [log] [blame]
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +00001/*
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
Shunkai Yao812d5b42022-11-16 18:08:50 +000019#include <algorithm>
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +000020#include <memory>
Shunkai Yao61f9dd22024-05-08 22:34:36 +000021#include <optional>
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +000022#include <string>
Shunkai Yao0a0c45e2023-02-13 17:41:11 +000023#include <type_traits>
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +000024#include <unordered_map>
Shunkai Yaof60fc372023-12-12 17:48:18 +000025#include <utility>
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +000026#include <vector>
27
Mikhail Naganov872d4a62023-03-09 18:19:01 -080028#include <Utils.h>
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +000029#include <aidl/android/hardware/audio/effect/IEffect.h>
30#include <aidl/android/hardware/audio/effect/IFactory.h>
31#include <aidl/android/media/audio/common/AudioChannelLayout.h>
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +000032#include <android/binder_auto_utils.h>
33#include <fmq/AidlMessageQueue.h>
Krzysztof KosiƄskia3a78a62023-03-04 00:58:52 +000034#include <gtest/gtest.h>
Shunkai Yao9e60e632023-06-23 04:34:50 +000035#include <system/audio_aidl_utils.h>
Shunkai Yao0a0c45e2023-02-13 17:41:11 +000036#include <system/audio_effects/aidl_effects_utils.h>
Shunkai Yaof8be1ac2023-03-06 18:41:27 +000037#include <system/audio_effects/effect_uuid.h>
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +000038
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +000039#include "EffectFactoryHelper.h"
40#include "TestUtils.h"
Sneha Patil93e4eb52024-02-13 14:09:48 +053041#include "pffft.hpp"
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +000042
43using namespace android;
44using aidl::android::hardware::audio::effect::CommandId;
45using aidl::android::hardware::audio::effect::Descriptor;
Shunkai Yao61f9dd22024-05-08 22:34:36 +000046using aidl::android::hardware::audio::effect::getEffectTypeUuidSpatializer;
47using aidl::android::hardware::audio::effect::getRange;
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +000048using aidl::android::hardware::audio::effect::IEffect;
Shunkai Yao61f9dd22024-05-08 22:34:36 +000049using aidl::android::hardware::audio::effect::isRangeValid;
50using aidl::android::hardware::audio::effect::kEffectTypeUuidSpatializer;
Shunkai Yaoef683a92024-04-18 04:38:17 +000051using aidl::android::hardware::audio::effect::kEventFlagDataMqNotEmpty;
Shunkai Yao65c7c702024-01-09 20:50:53 +000052using aidl::android::hardware::audio::effect::kEventFlagDataMqUpdate;
Shunkai Yao41888a22023-04-10 17:13:30 +000053using aidl::android::hardware::audio::effect::kEventFlagNotEmpty;
Shunkai Yaoef683a92024-04-18 04:38:17 +000054using aidl::android::hardware::audio::effect::kReopenSupportedVersion;
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +000055using aidl::android::hardware::audio::effect::Parameter;
Shunkai Yao0a0c45e2023-02-13 17:41:11 +000056using aidl::android::hardware::audio::effect::Range;
Shunkai Yao61f9dd22024-05-08 22:34:36 +000057using aidl::android::hardware::audio::effect::Spatializer;
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +000058using aidl::android::hardware::audio::effect::State;
59using aidl::android::hardware::common::fmq::SynchronizedReadWrite;
60using aidl::android::media::audio::common::AudioChannelLayout;
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +000061using aidl::android::media::audio::common::AudioFormatDescription;
62using aidl::android::media::audio::common::AudioFormatType;
63using aidl::android::media::audio::common::AudioUuid;
64using aidl::android::media::audio::common::PcmType;
Shunkai Yao9e60e632023-06-23 04:34:50 +000065using ::android::audio::utils::toString;
Shunkai Yao41888a22023-04-10 17:13:30 +000066using ::android::hardware::EventFlag;
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +000067
Shunkai Yao812d5b42022-11-16 18:08:50 +000068const AudioFormatDescription kDefaultFormatDescription = {
Shunkai Yao6afc8552022-10-26 22:47:20 +000069 .type = AudioFormatType::PCM, .pcm = PcmType::FLOAT_32_BIT, .encoding = ""};
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +000070
Shunkai Yao812d5b42022-11-16 18:08:50 +000071typedef ::android::AidlMessageQueue<IEffect::Status,
72 ::aidl::android::hardware::common::fmq::SynchronizedReadWrite>
73 StatusMQ;
74typedef ::android::AidlMessageQueue<float,
75 ::aidl::android::hardware::common::fmq::SynchronizedReadWrite>
76 DataMQ;
77
Shunkai Yao9e60e632023-06-23 04:34:50 +000078static inline std::string getPrefix(Descriptor& descriptor) {
Jaideep Sharmae4c7a962023-06-14 19:14:44 +053079 std::string prefix = "Implementor_" + descriptor.common.implementor + "_name_" +
Shunkai Yao9e60e632023-06-23 04:34:50 +000080 descriptor.common.name + "_UUID_" + toString(descriptor.common.id.uuid);
Sneha Patil94abce02024-04-03 12:15:03 +053081 std::replace_if(
82 prefix.begin(), prefix.end(), [](const char c) { return !std::isalnum(c); }, '_');
Jaideep Sharmae4c7a962023-06-14 19:14:44 +053083 return prefix;
84}
85
Aayush Sonibb001fb2024-09-11 13:51:14 +000086static constexpr float kMaxAudioSampleValue = 1;
Aayush Sonifbb5cd32024-11-21 10:51:46 +000087static constexpr int kNPointFFT = 16384;
Aayush Soni03460112024-11-04 07:14:44 +000088static constexpr int kSamplingFrequency = 44100;
Aayush Sonifbb5cd32024-11-21 10:51:46 +000089static constexpr int kDefaultChannelLayout = AudioChannelLayout::LAYOUT_STEREO;
Aayush Sonibb001fb2024-09-11 13:51:14 +000090
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +000091class EffectHelper {
92 public:
Shunkai Yao61f9dd22024-05-08 22:34:36 +000093 void create(std::shared_ptr<IFactory> factory, std::shared_ptr<IEffect>& effect,
94 Descriptor& desc, binder_status_t status = EX_NONE) {
Shunkai Yao812d5b42022-11-16 18:08:50 +000095 ASSERT_NE(factory, nullptr);
Shunkai Yaocb0fc412022-12-15 20:34:32 +000096 auto& id = desc.common.id;
97 ASSERT_STATUS(status, factory->createEffect(id.uuid, &effect));
Shunkai Yao812d5b42022-11-16 18:08:50 +000098 if (status == EX_NONE) {
Jaideep Sharmae4c7a962023-06-14 19:14:44 +053099 ASSERT_NE(effect, nullptr) << toString(id.uuid);
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000100 ASSERT_NO_FATAL_FAILURE(expectState(effect, State::INIT));
Shunkai Yao812d5b42022-11-16 18:08:50 +0000101 }
Shunkai Yao61f9dd22024-05-08 22:34:36 +0000102 mIsSpatializer = id.type == getEffectTypeUuidSpatializer();
103 mDescriptor = desc;
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +0000104 }
105
Shunkai Yaocb0fc412022-12-15 20:34:32 +0000106 static void destroyIgnoreRet(std::shared_ptr<IFactory> factory,
107 std::shared_ptr<IEffect> effect) {
108 if (factory && effect) {
109 factory->destroyEffect(effect);
110 }
111 }
112
Shunkai Yao812d5b42022-11-16 18:08:50 +0000113 static void destroy(std::shared_ptr<IFactory> factory, std::shared_ptr<IEffect> effect,
114 binder_status_t status = EX_NONE) {
115 ASSERT_NE(factory, nullptr);
116 ASSERT_NE(effect, nullptr);
Shunkai Yaocb0fc412022-12-15 20:34:32 +0000117 ASSERT_STATUS(status, factory->destroyEffect(effect));
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +0000118 }
119
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000120 void open(std::shared_ptr<IEffect> effect, const Parameter::Common& common,
121 const std::optional<Parameter::Specific>& specific, IEffect::OpenEffectReturn* ret,
122 binder_status_t status = EX_NONE) {
Shunkai Yao812d5b42022-11-16 18:08:50 +0000123 ASSERT_NE(effect, nullptr);
Shunkai Yaocb0fc412022-12-15 20:34:32 +0000124 ASSERT_STATUS(status, effect->open(common, specific, ret));
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000125 if (status != EX_NONE) {
126 return;
127 }
128
Shunkai Yao240c1d42024-11-24 18:40:58 +0000129 ASSERT_TRUE(expectState(effect, State::IDLE));
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000130 updateFrameSize(common);
Shunkai Yao812d5b42022-11-16 18:08:50 +0000131 }
132
Shunkai Yao61f9dd22024-05-08 22:34:36 +0000133 void open(std::shared_ptr<IEffect> effect, int session = 0, binder_status_t status = EX_NONE) {
Shunkai Yao812d5b42022-11-16 18:08:50 +0000134 ASSERT_NE(effect, nullptr);
Shunkai Yao61f9dd22024-05-08 22:34:36 +0000135 Parameter::Common common = createParamCommon(session);
Shunkai Yao812d5b42022-11-16 18:08:50 +0000136 IEffect::OpenEffectReturn ret;
Shunkai Yaocb0fc412022-12-15 20:34:32 +0000137 ASSERT_NO_FATAL_FAILURE(open(effect, common, std::nullopt /* specific */, &ret, status));
Shunkai Yao812d5b42022-11-16 18:08:50 +0000138 }
139
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000140 void reopen(std::shared_ptr<IEffect> effect, const Parameter::Common& common,
141 IEffect::OpenEffectReturn* ret, binder_status_t status = EX_NONE) {
142 ASSERT_NE(effect, nullptr);
143 ASSERT_STATUS(status, effect->reopen(ret));
144 if (status != EX_NONE) {
145 return;
146 }
147 updateFrameSize(common);
148 }
149
Shunkai Yaocb0fc412022-12-15 20:34:32 +0000150 static void closeIgnoreRet(std::shared_ptr<IEffect> effect) {
151 if (effect) {
152 effect->close();
153 }
154 }
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000155
Shunkai Yao812d5b42022-11-16 18:08:50 +0000156 static void close(std::shared_ptr<IEffect> effect, binder_status_t status = EX_NONE) {
157 if (effect) {
Shunkai Yaocb0fc412022-12-15 20:34:32 +0000158 ASSERT_STATUS(status, effect->close());
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000159 if (status == EX_NONE) {
Shunkai Yao240c1d42024-11-24 18:40:58 +0000160 ASSERT_TRUE(expectState(effect, State::INIT));
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000161 }
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +0000162 }
163 }
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000164
Shunkai Yao812d5b42022-11-16 18:08:50 +0000165 static void getDescriptor(std::shared_ptr<IEffect> effect, Descriptor& desc,
166 binder_status_t status = EX_NONE) {
167 ASSERT_NE(effect, nullptr);
Shunkai Yaocb0fc412022-12-15 20:34:32 +0000168 ASSERT_STATUS(status, effect->getDescriptor(&desc));
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +0000169 }
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000170
Shunkai Yao240c1d42024-11-24 18:40:58 +0000171 static bool expectState(std::shared_ptr<IEffect> effect, State expectState) {
172 if (effect == nullptr) return false;
173
174 if (State state; EX_NONE != effect->getState(&state).getStatus() || expectState != state) {
175 return false;
176 }
177
178 return true;
Shunkai Yaocb0fc412022-12-15 20:34:32 +0000179 }
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000180
Shunkai Yaocb0fc412022-12-15 20:34:32 +0000181 static void commandIgnoreRet(std::shared_ptr<IEffect> effect, CommandId command) {
182 if (effect) {
183 effect->command(command);
184 }
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +0000185 }
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000186
Shunkai Yao812d5b42022-11-16 18:08:50 +0000187 static void command(std::shared_ptr<IEffect> effect, CommandId command,
188 binder_status_t status = EX_NONE) {
189 ASSERT_NE(effect, nullptr);
Shunkai Yaocb0fc412022-12-15 20:34:32 +0000190 ASSERT_STATUS(status, effect->command(command));
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000191 if (status != EX_NONE) {
192 return;
193 }
194
195 switch (command) {
196 case CommandId::START:
Shunkai Yao240c1d42024-11-24 18:40:58 +0000197 ASSERT_TRUE(expectState(effect, State::PROCESSING));
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000198 break;
199 case CommandId::STOP:
Shunkai Yao240c1d42024-11-24 18:40:58 +0000200 ASSERT_TRUE(expectState(effect, State::IDLE) ||
201 expectState(effect, State::DRAINING));
202 break;
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000203 case CommandId::RESET:
Shunkai Yao240c1d42024-11-24 18:40:58 +0000204 ASSERT_TRUE(expectState(effect, State::IDLE));
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000205 break;
206 default:
207 return;
208 }
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +0000209 }
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000210
Shunkai Yao41888a22023-04-10 17:13:30 +0000211 static void writeToFmq(std::unique_ptr<StatusMQ>& statusMq, std::unique_ptr<DataMQ>& dataMq,
Shunkai Yaoef683a92024-04-18 04:38:17 +0000212 const std::vector<float>& buffer, int version) {
Shunkai Yao41888a22023-04-10 17:13:30 +0000213 const size_t available = dataMq->availableToWrite();
Shunkai Yaocb0fc412022-12-15 20:34:32 +0000214 ASSERT_NE(0Ul, available);
Shunkai Yao812d5b42022-11-16 18:08:50 +0000215 auto bufferFloats = buffer.size();
216 auto floatsToWrite = std::min(available, bufferFloats);
Shunkai Yao41888a22023-04-10 17:13:30 +0000217 ASSERT_TRUE(dataMq->write(buffer.data(), floatsToWrite));
218
219 EventFlag* efGroup;
220 ASSERT_EQ(::android::OK,
221 EventFlag::createEventFlag(statusMq->getEventFlagWord(), &efGroup));
222 ASSERT_NE(nullptr, efGroup);
Shunkai Yaoef683a92024-04-18 04:38:17 +0000223 efGroup->wake(version >= kReopenSupportedVersion ? kEventFlagDataMqNotEmpty
224 : kEventFlagNotEmpty);
Shunkai Yao41888a22023-04-10 17:13:30 +0000225 ASSERT_EQ(::android::OK, EventFlag::deleteEventFlag(&efGroup));
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +0000226 }
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000227
Shunkai Yao812d5b42022-11-16 18:08:50 +0000228 static void readFromFmq(std::unique_ptr<StatusMQ>& statusMq, size_t statusNum,
229 std::unique_ptr<DataMQ>& dataMq, size_t expectFloats,
Shunkai Yaob49631f2023-02-03 01:44:32 +0000230 std::vector<float>& buffer,
231 std::optional<int> expectStatus = STATUS_OK) {
232 if (0 == statusNum) {
233 ASSERT_EQ(0ul, statusMq->availableToRead());
234 return;
235 }
Shunkai Yao812d5b42022-11-16 18:08:50 +0000236 IEffect::Status status{};
Shunkai Yaocb0fc412022-12-15 20:34:32 +0000237 ASSERT_TRUE(statusMq->readBlocking(&status, statusNum));
Shunkai Yaob49631f2023-02-03 01:44:32 +0000238 if (expectStatus.has_value()) {
239 ASSERT_EQ(expectStatus.value(), status.status);
240 }
241
242 ASSERT_EQ(expectFloats, (unsigned)status.fmqProduced);
243 ASSERT_EQ(expectFloats, dataMq->availableToRead());
244 if (expectFloats != 0) {
245 ASSERT_TRUE(dataMq->read(buffer.data(), expectFloats));
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +0000246 }
247 }
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000248
Shunkai Yao65c7c702024-01-09 20:50:53 +0000249 static void expectDataMqUpdateEventFlag(std::unique_ptr<StatusMQ>& statusMq) {
250 EventFlag* efGroup;
251 ASSERT_EQ(::android::OK,
252 EventFlag::createEventFlag(statusMq->getEventFlagWord(), &efGroup));
253 ASSERT_NE(nullptr, efGroup);
254 uint32_t efState = 0;
255 EXPECT_EQ(::android::OK, efGroup->wait(kEventFlagDataMqUpdate, &efState, 1'000'000 /*1ms*/,
256 true /* retry */));
257 EXPECT_TRUE(efState & kEventFlagDataMqUpdate);
258 }
Shunkai Yao61f9dd22024-05-08 22:34:36 +0000259
Aayush Sonifbb5cd32024-11-21 10:51:46 +0000260 Parameter::Common createParamCommon(
261 int session = 0, int ioHandle = -1, int iSampleRate = 48000, int oSampleRate = 48000,
262 long iFrameCount = 0x100, long oFrameCount = 0x100,
263 AudioChannelLayout inputChannelLayout =
264 AudioChannelLayout::make<AudioChannelLayout::layoutMask>(kDefaultChannelLayout),
265 AudioChannelLayout outputChannelLayout =
266 AudioChannelLayout::make<AudioChannelLayout::layoutMask>(
267 kDefaultChannelLayout)) {
Shunkai Yao61f9dd22024-05-08 22:34:36 +0000268 // query supported input layout and use it as the default parameter in common
269 if (mIsSpatializer && isRangeValid<Range::spatializer>(Spatializer::supportedChannelLayout,
270 mDescriptor.capability)) {
271 const auto layoutRange = getRange<Range::spatializer, Range::SpatializerRange>(
272 mDescriptor.capability, Spatializer::supportedChannelLayout);
273 if (std::vector<AudioChannelLayout> layouts;
274 layoutRange &&
275 0 != (layouts = layoutRange->min.get<Spatializer::supportedChannelLayout>())
276 .size()) {
Aayush Sonifbb5cd32024-11-21 10:51:46 +0000277 inputChannelLayout = layouts[0];
Shunkai Yao61f9dd22024-05-08 22:34:36 +0000278 }
279 }
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000280
Shunkai Yao812d5b42022-11-16 18:08:50 +0000281 Parameter::Common common;
282 common.session = session;
283 common.ioHandle = ioHandle;
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +0000284
Shunkai Yao812d5b42022-11-16 18:08:50 +0000285 auto& input = common.input;
286 auto& output = common.output;
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +0000287 input.base.sampleRate = iSampleRate;
Shunkai Yao812d5b42022-11-16 18:08:50 +0000288 input.base.channelMask = inputChannelLayout;
289 input.base.format = kDefaultFormatDescription;
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +0000290 input.frameCount = iFrameCount;
291 output.base.sampleRate = oSampleRate;
Shunkai Yao812d5b42022-11-16 18:08:50 +0000292 output.base.channelMask = outputChannelLayout;
293 output.base.format = kDefaultFormatDescription;
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +0000294 output.frameCount = oFrameCount;
Shunkai Yao812d5b42022-11-16 18:08:50 +0000295 return common;
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +0000296 }
297
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +0000298 typedef ::android::AidlMessageQueue<
299 IEffect::Status, ::aidl::android::hardware::common::fmq::SynchronizedReadWrite>
300 StatusMQ;
301 typedef ::android::AidlMessageQueue<
Shunkai Yao6afc8552022-10-26 22:47:20 +0000302 float, ::aidl::android::hardware::common::fmq::SynchronizedReadWrite>
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +0000303 DataMQ;
304
305 class EffectParam {
306 public:
307 std::unique_ptr<StatusMQ> statusMQ;
308 std::unique_ptr<DataMQ> inputMQ;
309 std::unique_ptr<DataMQ> outputMQ;
310 };
Shunkai Yao0a0c45e2023-02-13 17:41:11 +0000311
312 template <typename T, Range::Tag tag>
313 static bool isParameterValid(const T& target, const Descriptor& desc) {
314 if (desc.capability.range.getTag() != tag) {
315 return true;
316 }
317 const auto& ranges = desc.capability.range.get<tag>();
318 return inRange(target, ranges);
319 }
320
321 /**
322 * Add to test value set: (min+max)/2, minimum/maximum numeric limits, and min-1/max+1 if
323 * result still in numeric limits after -1/+1.
324 * Only use this when the type of test value is basic type (std::is_arithmetic return true).
325 */
326 template <typename S, typename = std::enable_if_t<std::is_arithmetic_v<S>>>
327 static std::set<S> expandTestValueBasic(std::set<S>& s) {
Shunkai Yao0a0c45e2023-02-13 17:41:11 +0000328 const auto minLimit = std::numeric_limits<S>::min(),
329 maxLimit = std::numeric_limits<S>::max();
330 if (s.size()) {
Shraddha Basantwanib76f5ab2023-03-27 16:00:03 +0530331 const auto min = *s.begin(), max = *s.rbegin();
Shunkai Yao5ed80c52023-09-07 17:42:39 +0000332 s.insert((min & max) + ((min ^ max) >> 1));
333 if (min > minLimit + 1) {
Shunkai Yao0a0c45e2023-02-13 17:41:11 +0000334 s.insert(min - 1);
335 }
Shunkai Yao5ed80c52023-09-07 17:42:39 +0000336 if (max < maxLimit - 1) {
Shunkai Yao0a0c45e2023-02-13 17:41:11 +0000337 s.insert(max + 1);
338 }
339 }
340 s.insert(minLimit);
341 s.insert(maxLimit);
342 return s;
343 }
344
Shunkai Yaof60fc372023-12-12 17:48:18 +0000345 template <typename T, typename S, Range::Tag R, typename T::Tag tag>
Shunkai Yao0a0c45e2023-02-13 17:41:11 +0000346 static std::set<S> getTestValueSet(
Shunkai Yaof60fc372023-12-12 17:48:18 +0000347 std::vector<std::pair<std::shared_ptr<IFactory>, Descriptor>> descList) {
Shunkai Yao0a0c45e2023-02-13 17:41:11 +0000348 std::set<S> result;
Shunkai Yaof60fc372023-12-12 17:48:18 +0000349 for (const auto& [_, desc] : descList) {
Shunkai Yao0a0c45e2023-02-13 17:41:11 +0000350 if (desc.capability.range.getTag() == R) {
351 const auto& ranges = desc.capability.range.get<R>();
352 for (const auto& range : ranges) {
353 if (range.min.getTag() == tag) {
354 result.insert(range.min.template get<tag>());
355 }
356 if (range.max.getTag() == tag) {
357 result.insert(range.max.template get<tag>());
358 }
359 }
360 }
361 }
Shunkai Yaof60fc372023-12-12 17:48:18 +0000362 return result;
363 }
364
365 template <typename T, typename S, Range::Tag R, typename T::Tag tag, typename Functor>
366 static std::set<S> getTestValueSet(
367 std::vector<std::pair<std::shared_ptr<IFactory>, Descriptor>> descList,
368 Functor functor) {
369 auto result = getTestValueSet<T, S, R, tag>(descList);
Shunkai Yao0a0c45e2023-02-13 17:41:11 +0000370 return functor(result);
371 }
Sneha Patilf533b502023-10-25 12:39:55 +0530372
Shunkai Yao240c1d42024-11-24 18:40:58 +0000373 // keep writing data to the FMQ until effect transit from DRAINING to IDLE
374 static void waitForDrain(std::vector<float>& inputBuffer, std::vector<float>& outputBuffer,
375 const std::shared_ptr<IEffect>& effect,
376 std::unique_ptr<EffectHelper::StatusMQ>& statusMQ,
377 std::unique_ptr<EffectHelper::DataMQ>& inputMQ,
378 std::unique_ptr<EffectHelper::DataMQ>& outputMQ, int version) {
379 State state;
380 while (effect->getState(&state).getStatus() == EX_NONE && state == State::DRAINING) {
381 EXPECT_NO_FATAL_FAILURE(
382 EffectHelper::writeToFmq(statusMQ, inputMQ, inputBuffer, version));
383 EXPECT_NO_FATAL_FAILURE(EffectHelper::readFromFmq(
384 statusMQ, 1, outputMQ, outputBuffer.size(), outputBuffer, std::nullopt));
385 }
386 ASSERT_TRUE(State::IDLE == state);
387 EXPECT_NO_FATAL_FAILURE(EffectHelper::readFromFmq(statusMQ, 0, outputMQ, 0, outputBuffer));
388 return;
389 }
390
Sneha Patilf533b502023-10-25 12:39:55 +0530391 static void processAndWriteToOutput(std::vector<float>& inputBuffer,
392 std::vector<float>& outputBuffer,
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000393 const std::shared_ptr<IEffect>& effect,
394 IEffect::OpenEffectReturn* openEffectReturn,
Aayush Soni9eb548c2024-10-22 13:07:47 +0000395 int version = -1, int times = 1,
396 bool callStopReset = true) {
Sneha Patilf533b502023-10-25 12:39:55 +0530397 // Initialize AidlMessagequeues
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000398 auto statusMQ = std::make_unique<EffectHelper::StatusMQ>(openEffectReturn->statusMQ);
Sneha Patilf533b502023-10-25 12:39:55 +0530399 ASSERT_TRUE(statusMQ->isValid());
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000400 auto inputMQ = std::make_unique<EffectHelper::DataMQ>(openEffectReturn->inputDataMQ);
Sneha Patilf533b502023-10-25 12:39:55 +0530401 ASSERT_TRUE(inputMQ->isValid());
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000402 auto outputMQ = std::make_unique<EffectHelper::DataMQ>(openEffectReturn->outputDataMQ);
Sneha Patilf533b502023-10-25 12:39:55 +0530403 ASSERT_TRUE(outputMQ->isValid());
404
405 // Enabling the process
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000406 ASSERT_NO_FATAL_FAILURE(command(effect, CommandId::START));
Sneha Patilf533b502023-10-25 12:39:55 +0530407
408 // Write from buffer to message queues and calling process
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000409 if (version == -1) {
410 ASSERT_IS_OK(effect->getInterfaceVersion(&version));
411 }
Sneha Patilf533b502023-10-25 12:39:55 +0530412
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000413 for (int i = 0; i < times; i++) {
414 EXPECT_NO_FATAL_FAILURE(
415 EffectHelper::writeToFmq(statusMQ, inputMQ, inputBuffer, version));
416 // Read the updated message queues into buffer
417 EXPECT_NO_FATAL_FAILURE(EffectHelper::readFromFmq(statusMQ, 1, outputMQ,
418 outputBuffer.size(), outputBuffer));
419 }
420
Shraddha Basantwani0a981d32024-07-24 08:42:50 +0000421 // Disable the process
Aayush Soni9eb548c2024-10-22 13:07:47 +0000422 if (callStopReset) {
423 ASSERT_NO_FATAL_FAILURE(command(effect, CommandId::STOP));
Shunkai Yao240c1d42024-11-24 18:40:58 +0000424 EXPECT_NO_FATAL_FAILURE(waitForDrain(inputBuffer, outputBuffer, effect, statusMQ,
425 inputMQ, outputMQ, version));
Aayush Soni9eb548c2024-10-22 13:07:47 +0000426 }
Sneha Patilf533b502023-10-25 12:39:55 +0530427
Aayush Soni9eb548c2024-10-22 13:07:47 +0000428 if (callStopReset) {
429 ASSERT_NO_FATAL_FAILURE(command(effect, CommandId::RESET));
430 }
Sneha Patilf533b502023-10-25 12:39:55 +0530431 }
Sneha Patil93e4eb52024-02-13 14:09:48 +0530432
433 // Find FFT bin indices for testFrequencies and get bin center frequencies
434 void roundToFreqCenteredToFftBin(std::vector<int>& testFrequencies,
435 std::vector<int>& binOffsets, const float kBinWidth) {
436 for (size_t i = 0; i < testFrequencies.size(); i++) {
437 binOffsets[i] = std::round(testFrequencies[i] / kBinWidth);
438 testFrequencies[i] = std::round(binOffsets[i] * kBinWidth);
439 }
440 }
441
Aayush Sonibb001fb2024-09-11 13:51:14 +0000442 // Fill inputBuffer with random values between -maxAudioSampleValue to maxAudioSampleValue
443 void generateInputBuffer(std::vector<float>& inputBuffer, size_t startPosition, bool isStrip,
444 size_t channelCount,
445 float maxAudioSampleValue = kMaxAudioSampleValue) {
446 size_t increment = isStrip ? 1 /*Fill input at all the channels*/
447 : channelCount /*Fill input at only one channel*/;
448
449 for (size_t i = startPosition; i < inputBuffer.size(); i += increment) {
450 inputBuffer[i] =
451 ((static_cast<float>(std::rand()) / RAND_MAX) * 2 - 1) * maxAudioSampleValue;
452 }
453 }
454
Sneha Patiled98f7b2024-10-22 13:07:47 +0000455 // Generate multitone input between -amplitude to +amplitude using testFrequencies
456 // All test frequencies are considered having the same amplitude
Aayush Sonifbb5cd32024-11-21 10:51:46 +0000457 // The function supports only mono and stereo channel layout
Sneha Patiled98f7b2024-10-22 13:07:47 +0000458 void generateSineWave(const std::vector<int>& testFrequencies, std::vector<float>& input,
459 const float amplitude = 1.0,
Aayush Sonifbb5cd32024-11-21 10:51:46 +0000460 const int samplingFrequency = kSamplingFrequency,
461 int channelLayout = AudioChannelLayout::LAYOUT_STEREO) {
462 bool isStereo = (channelLayout == AudioChannelLayout::LAYOUT_STEREO);
463 if (isStereo) {
464 ASSERT_EQ(input.size() % 2, 0u)
465 << "In case of stereo input, the input size value must be even";
466 }
467 for (size_t i = 0; i < input.size(); i += (isStereo ? 2 : 1)) {
Sneha Patil93e4eb52024-02-13 14:09:48 +0530468 input[i] = 0;
469
470 for (size_t j = 0; j < testFrequencies.size(); j++) {
Aayush Sonifbb5cd32024-11-21 10:51:46 +0000471 input[i] += sin(2 * M_PI * testFrequencies[j] * (i / (isStereo ? 2 : 1)) /
472 samplingFrequency);
Sneha Patil93e4eb52024-02-13 14:09:48 +0530473 }
Sneha Patiled98f7b2024-10-22 13:07:47 +0000474 input[i] *= amplitude / testFrequencies.size();
Aayush Sonifbb5cd32024-11-21 10:51:46 +0000475
476 if (isStereo) {
477 input[i + 1] = input[i];
478 }
Sneha Patil93e4eb52024-02-13 14:09:48 +0530479 }
480 }
481
Sneha Patiled98f7b2024-10-22 13:07:47 +0000482 // Generate single tone input between -amplitude to +amplitude using testFrequency
Aayush Sonifbb5cd32024-11-21 10:51:46 +0000483 // The function supports only mono and stereo channel layout
Sneha Patiled98f7b2024-10-22 13:07:47 +0000484 void generateSineWave(const int testFrequency, std::vector<float>& input,
485 const float amplitude = 1.0,
Aayush Sonifbb5cd32024-11-21 10:51:46 +0000486 const int samplingFrequency = kSamplingFrequency,
487 int channelLayout = AudioChannelLayout::LAYOUT_STEREO) {
488 ASSERT_NO_FATAL_FAILURE(generateSineWave(std::vector<int>{testFrequency}, input, amplitude,
489 samplingFrequency, channelLayout));
490 }
491
492 // PFFFT only supports transforms for inputs of length N of the form N = (2^a)*(3^b)*(5^c) where
493 // a >= 5, b >=0, c >= 0.
494 constexpr bool isFftInputSizeValid(size_t n) {
495 if (n == 0 || n & 0b11111) {
496 return false;
497 }
498 for (const int factor : {2, 3, 5}) {
499 while (n % factor == 0) {
500 n /= factor;
501 }
502 }
503 return n == 1;
Sneha Patiled98f7b2024-10-22 13:07:47 +0000504 }
505
Sneha Patil93e4eb52024-02-13 14:09:48 +0530506 // Use FFT transform to convert the buffer to frequency domain
507 // Compute its magnitude at binOffsets
Aayush Sonifbb5cd32024-11-21 10:51:46 +0000508 void calculateMagnitudeMono(std::vector<float>& bufferMag, // Output parameter
509 const std::vector<float>& buffer, // Input parameter
510 const std::vector<int>& binOffsets, // Input parameter
511 const int nPointFFT = kNPointFFT) { // Input parameter
512 ASSERT_TRUE(isFftInputSizeValid(nPointFFT))
513 << "PFFFT only supports transforms for inputs of length N of the form N = (2 ^ a) "
514 "* (3 ^ b) * (5 ^ c) where a >= 5, b >= 0, c >= 0. ";
515 ASSERT_GE((int)buffer.size(), nPointFFT)
516 << "The input(buffer) size must be greater than or equal to nPointFFT";
517 bufferMag.resize(binOffsets.size());
Sneha Patil93e4eb52024-02-13 14:09:48 +0530518 std::vector<float> fftInput(nPointFFT);
519 PFFFT_Setup* inputHandle = pffft_new_setup(nPointFFT, PFFFT_REAL);
520 pffft_transform_ordered(inputHandle, buffer.data(), fftInput.data(), nullptr,
521 PFFFT_FORWARD);
522 pffft_destroy_setup(inputHandle);
Sneha Patil93e4eb52024-02-13 14:09:48 +0530523 for (size_t i = 0; i < binOffsets.size(); i++) {
524 size_t k = binOffsets[i];
525 bufferMag[i] = sqrt((fftInput[k * 2] * fftInput[k * 2]) +
526 (fftInput[k * 2 + 1] * fftInput[k * 2 + 1]));
527 }
Aayush Sonifbb5cd32024-11-21 10:51:46 +0000528 }
Sneha Patil93e4eb52024-02-13 14:09:48 +0530529
Aayush Sonifbb5cd32024-11-21 10:51:46 +0000530 // Use FFT transform to convert the buffer to frequency domain
531 // Compute its magnitude at binOffsets
532 void calculateMagnitudeStereo(
533 std::pair<std::vector<float>, std::vector<float>>& bufferMag, // Output parameter
534 const std::vector<float>& buffer, // Input parameter
535 const std::vector<int>& binOffsets, // Input parameter
536 const int nPointFFT = kNPointFFT) { // Input parameter
537 std::vector<float> leftChannelBuffer(buffer.size() / 2),
538 rightChannelBuffer(buffer.size() / 2);
539 for (size_t i = 0; i < buffer.size(); i += 2) {
540 leftChannelBuffer[i / 2] = buffer[i];
541 rightChannelBuffer[i / 2] = buffer[i + 1];
542 }
543 std::vector<float> leftMagnitude(binOffsets.size());
544 std::vector<float> rightMagnitude(binOffsets.size());
545
546 ASSERT_NO_FATAL_FAILURE(
547 calculateMagnitudeMono(leftMagnitude, leftChannelBuffer, binOffsets, nPointFFT));
548 ASSERT_NO_FATAL_FAILURE(
549 calculateMagnitudeMono(rightMagnitude, rightChannelBuffer, binOffsets, nPointFFT));
550
551 bufferMag = {leftMagnitude, rightMagnitude};
552 }
553
554 // Computes magnitude for mono and stereo inputs and verifies equal magnitude for left and right
555 // channel in case of stereo inputs
556 void calculateAndVerifyMagnitude(std::vector<float>& mag, // Output parameter
557 const int channelLayout, // Input parameter
558 const std::vector<float>& buffer, // Input parameter
559 const std::vector<int>& binOffsets, // Input parameter
560 const int nPointFFT = kNPointFFT) { // Input parameter
561 if (channelLayout == AudioChannelLayout::LAYOUT_STEREO) {
562 std::pair<std::vector<float>, std::vector<float>> magStereo;
563 ASSERT_NO_FATAL_FAILURE(
564 calculateMagnitudeStereo(magStereo, buffer, binOffsets, nPointFFT));
565 ASSERT_EQ(magStereo.first, magStereo.second);
566
567 mag = magStereo.first;
568 } else {
569 ASSERT_NO_FATAL_FAILURE(calculateMagnitudeMono(mag, buffer, binOffsets, nPointFFT));
570 }
Sneha Patil93e4eb52024-02-13 14:09:48 +0530571 }
Shunkai Yao61f9dd22024-05-08 22:34:36 +0000572
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000573 void updateFrameSize(const Parameter::Common& common) {
574 mInputFrameSize = ::aidl::android::hardware::audio::common::getFrameSizeInBytes(
575 common.input.base.format, common.input.base.channelMask);
576 mInputSamples = common.input.frameCount * mInputFrameSize / sizeof(float);
577 mOutputFrameSize = ::aidl::android::hardware::audio::common::getFrameSizeInBytes(
578 common.output.base.format, common.output.base.channelMask);
579 mOutputSamples = common.output.frameCount * mOutputFrameSize / sizeof(float);
580 }
581
Sneha Patil393369b2024-07-16 13:50:05 +0000582 void generateInput(std::vector<float>& input, float inputFrequency, float samplingFrequency,
583 size_t inputSize = 0) {
584 if (inputSize == 0 || inputSize > input.size()) {
585 inputSize = input.size();
586 }
587
588 for (size_t i = 0; i < inputSize; i++) {
589 input[i] = sin(2 * M_PI * inputFrequency * i / samplingFrequency);
590 }
591 }
592
Shunkai Yao61f9dd22024-05-08 22:34:36 +0000593 bool mIsSpatializer;
594 Descriptor mDescriptor;
Shunkai Yao28aff3d2024-06-15 03:16:06 +0000595 size_t mInputFrameSize, mOutputFrameSize;
596 size_t mInputSamples, mOutputSamples;
Shunkai Yaoa4ab38c2022-10-14 01:07:47 +0000597};