blob: 21df163c5c277be8ed027531aa9fa060fbb6624c [file] [log] [blame]
Shunkai Yaoea24c1a2022-09-28 17:39:23 +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#include <memory>
Shunkai Yao812d5b42022-11-16 18:08:50 +000018#include <set>
Shunkai Yaoea24c1a2022-09-28 17:39:23 +000019#include <string>
20#include <vector>
21
22#define LOG_TAG "VtsHalAudioEffectFactory"
23
24#include <aidl/Gtest.h>
25#include <aidl/Vintf.h>
26#include <android-base/logging.h>
27#include <android-base/properties.h>
28#include <android/binder_interface_utils.h>
29#include <android/binder_manager.h>
30#include <android/binder_process.h>
Shunkai Yaof8be1ac2023-03-06 18:41:27 +000031#include <system/audio_effects/effect_uuid.h>
Shunkai Yaoea24c1a2022-09-28 17:39:23 +000032
33#include <aidl/android/hardware/audio/effect/IFactory.h>
34
Shunkai Yaoea24c1a2022-09-28 17:39:23 +000035#include "EffectFactoryHelper.h"
36#include "TestUtils.h"
37
Jaideep Sharmae4c7a962023-06-14 19:14:44 +053038#include <system/audio_aidl_utils.h>
39
40using namespace android;
41using ::android::audio::utils::toString;
42
Shunkai Yaoea24c1a2022-09-28 17:39:23 +000043using namespace android;
44
45using aidl::android::hardware::audio::effect::Descriptor;
Shunkai Yaof8be1ac2023-03-06 18:41:27 +000046using aidl::android::hardware::audio::effect::getEffectUuidNull;
47using aidl::android::hardware::audio::effect::getEffectUuidZero;
Shunkai Yao812d5b42022-11-16 18:08:50 +000048using aidl::android::hardware::audio::effect::IEffect;
Shunkai Yaoea24c1a2022-09-28 17:39:23 +000049using aidl::android::hardware::audio::effect::IFactory;
Shunkai Yao08b687d2022-10-13 21:11:11 +000050using aidl::android::hardware::audio::effect::Processing;
Shunkai Yao812d5b42022-11-16 18:08:50 +000051using aidl::android::media::audio::common::AudioSource;
52using aidl::android::media::audio::common::AudioStreamType;
Shunkai Yaoea24c1a2022-09-28 17:39:23 +000053using aidl::android::media::audio::common::AudioUuid;
Jaideep Sharma74498412023-09-13 15:25:25 +053054using android::hardware::audio::common::testing::detail::TestExecutionTracer;
Shunkai Yaoea24c1a2022-09-28 17:39:23 +000055
56/// Effect factory testing.
57class EffectFactoryTest : public testing::TestWithParam<std::string> {
58 public:
Shunkai Yao8a4e9b72024-03-04 23:25:36 +000059 void SetUp() override { connectAndGetFactory(); }
Shunkai Yaoea24c1a2022-09-28 17:39:23 +000060
Shunkai Yao812d5b42022-11-16 18:08:50 +000061 void TearDown() override {
62 for (auto& effect : mEffects) {
63 const auto status = mEffectFactory->destroyEffect(effect);
64 EXPECT_STATUS(EX_NONE, status);
65 }
66 }
Shunkai Yaoea24c1a2022-09-28 17:39:23 +000067
Shunkai Yao8a4e9b72024-03-04 23:25:36 +000068 std::string kServiceName = GetParam();
Shunkai Yao812d5b42022-11-16 18:08:50 +000069 std::shared_ptr<IFactory> mEffectFactory;
70 std::vector<std::shared_ptr<IEffect>> mEffects;
Shunkai Yaof8be1ac2023-03-06 18:41:27 +000071 const Descriptor::Identity kNullId = {.uuid = getEffectUuidNull()};
72 const Descriptor::Identity kZeroId = {.uuid = getEffectUuidZero()};
Shunkai Yaoc12e0822022-12-12 07:13:58 +000073 const Descriptor kNullDesc = {.common.id = kNullId};
74 const Descriptor kZeroDesc = {.common.id = kZeroId};
Shunkai Yao8a4e9b72024-03-04 23:25:36 +000075 AudioHalBinderServiceUtil mBinderUtil;
Shunkai Yaoea24c1a2022-09-28 17:39:23 +000076
Shunkai Yao812d5b42022-11-16 18:08:50 +000077 template <typename Functor>
78 void ForEachId(const std::vector<Descriptor::Identity> ids, Functor functor) {
79 for (const auto& id : ids) {
80 SCOPED_TRACE(id.toString());
81 functor(id);
82 }
83 }
84 template <typename Functor>
85 void ForEachEffect(std::vector<std::shared_ptr<IEffect>> effects, Functor functor) {
86 for (auto& effect : effects) {
87 functor(effect);
88 }
89 }
90
Shunkai Yaoc12e0822022-12-12 07:13:58 +000091 std::vector<std::shared_ptr<IEffect>> createWithDescs(
92 const std::vector<Descriptor> descs, const binder_status_t expectStatus = EX_NONE) {
Shunkai Yao812d5b42022-11-16 18:08:50 +000093 std::vector<std::shared_ptr<IEffect>> effects;
Shunkai Yaoc12e0822022-12-12 07:13:58 +000094 for (const auto& desc : descs) {
95 const auto& uuid = desc.common.id.uuid;
Shunkai Yao812d5b42022-11-16 18:08:50 +000096 std::shared_ptr<IEffect> effect;
Shunkai Yaoc12e0822022-12-12 07:13:58 +000097 EXPECT_STATUS(expectStatus, mEffectFactory->createEffect(uuid, &effect));
Shunkai Yao812d5b42022-11-16 18:08:50 +000098 if (expectStatus == EX_NONE) {
Jaideep Sharmae4c7a962023-06-14 19:14:44 +053099 EXPECT_NE(effect, nullptr) << " null effect with uuid: " << toString(uuid);
Shunkai Yao812d5b42022-11-16 18:08:50 +0000100 effects.push_back(std::move(effect));
101 }
102 }
103 return effects;
104 }
105 void destroyEffects(std::vector<std::shared_ptr<IEffect>> effects,
106 const binder_status_t expectStatus = EX_NONE) {
107 for (const auto& effect : effects) {
108 EXPECT_STATUS(expectStatus, mEffectFactory->destroyEffect(effect));
109 }
110 }
Shunkai Yaoc12e0822022-12-12 07:13:58 +0000111 void creatAndDestroyDescs(const std::vector<Descriptor> descs) {
112 for (const auto& desc : descs) {
113 auto effects = createWithDescs({desc});
Shunkai Yao812d5b42022-11-16 18:08:50 +0000114 ASSERT_NO_FATAL_FAILURE(destroyEffects(effects));
115 }
116 }
117 void connectAndGetFactory() {
Shunkai Yao8a4e9b72024-03-04 23:25:36 +0000118 mEffectFactory = IFactory::fromBinder(mBinderUtil.connectToService(kServiceName));
Shunkai Yao812d5b42022-11-16 18:08:50 +0000119 ASSERT_NE(mEffectFactory, nullptr);
120 }
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000121};
122
123TEST_P(EffectFactoryTest, SetupAndTearDown) {
124 // Intentionally empty test body.
125}
126
127TEST_P(EffectFactoryTest, CanBeRestarted) {
Shunkai Yao8a4e9b72024-03-04 23:25:36 +0000128 ASSERT_NE(mEffectFactory, nullptr);
129 mEffectFactory = IFactory::fromBinder(mBinderUtil.restartService());
130 ASSERT_NE(mEffectFactory, nullptr);
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000131}
132
Shunkai Yao812d5b42022-11-16 18:08:50 +0000133/**
134 * @brief Check at least support list of effect must be supported by aosp:
135 * https://developer.android.com/reference/android/media/audiofx/AudioEffect
Shunkai Yao96967412023-08-21 18:55:24 +0000136 *
137 * For Android 13, they are: Equalizer, LoudnessEnhancer, Visualizer, and DynamicsProcessing.
138 * https://source.android.com/docs/compatibility/13/android-13-cdd#552_audio_effects
Shunkai Yao812d5b42022-11-16 18:08:50 +0000139 */
Shunkai Yao96967412023-08-21 18:55:24 +0000140TEST_P(EffectFactoryTest, SupportMandatoryEffectTypes) {
Shunkai Yaoc12e0822022-12-12 07:13:58 +0000141 std::vector<Descriptor> descs;
Shunkai Yao96967412023-08-21 18:55:24 +0000142 std::set<AudioUuid> typeUuidSet({
143 aidl::android::hardware::audio::effect::getEffectTypeUuidEqualizer(),
144 aidl::android::hardware::audio::effect::getEffectTypeUuidDynamicsProcessing(),
145 aidl::android::hardware::audio::effect::getEffectTypeUuidLoudnessEnhancer(),
146 aidl::android::hardware::audio::effect::getEffectTypeUuidVisualizer(),
147 });
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000148
Shunkai Yaoc12e0822022-12-12 07:13:58 +0000149 EXPECT_IS_OK(mEffectFactory->queryEffects(std::nullopt, std::nullopt, std::nullopt, &descs));
150 EXPECT_TRUE(descs.size() >= typeUuidSet.size());
151 for (const auto& desc : descs) {
152 typeUuidSet.erase(desc.common.id.type);
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000153 }
Shunkai Yao812d5b42022-11-16 18:08:50 +0000154 std::string msg = " missing type UUID:\n";
155 for (const auto& uuid : typeUuidSet) {
Jaideep Sharmae4c7a962023-06-14 19:14:44 +0530156 msg += (toString(uuid) + "\n");
Shunkai Yao812d5b42022-11-16 18:08:50 +0000157 }
158 SCOPED_TRACE(msg);
159 EXPECT_EQ(0UL, typeUuidSet.size());
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000160}
161
Shunkai Yao812d5b42022-11-16 18:08:50 +0000162TEST_P(EffectFactoryTest, QueryNullTypeUuid) {
Shunkai Yaoc12e0822022-12-12 07:13:58 +0000163 std::vector<Descriptor> descs;
Shunkai Yaof8be1ac2023-03-06 18:41:27 +0000164 EXPECT_IS_OK(
165 mEffectFactory->queryEffects(getEffectUuidNull(), std::nullopt, std::nullopt, &descs));
Shunkai Yaoc12e0822022-12-12 07:13:58 +0000166 EXPECT_EQ(descs.size(), 0UL);
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000167}
168
Shunkai Yao812d5b42022-11-16 18:08:50 +0000169TEST_P(EffectFactoryTest, QueriedNullImplUuid) {
Shunkai Yaoc12e0822022-12-12 07:13:58 +0000170 std::vector<Descriptor> descs;
Shunkai Yaof8be1ac2023-03-06 18:41:27 +0000171 EXPECT_IS_OK(
172 mEffectFactory->queryEffects(std::nullopt, getEffectUuidNull(), std::nullopt, &descs));
Shunkai Yaoc12e0822022-12-12 07:13:58 +0000173 EXPECT_EQ(descs.size(), 0UL);
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000174}
175
Shunkai Yao812d5b42022-11-16 18:08:50 +0000176TEST_P(EffectFactoryTest, QueriedNullProxyUuid) {
Shunkai Yaoc12e0822022-12-12 07:13:58 +0000177 std::vector<Descriptor> descs;
Shunkai Yaof8be1ac2023-03-06 18:41:27 +0000178 EXPECT_IS_OK(
179 mEffectFactory->queryEffects(std::nullopt, std::nullopt, getEffectUuidNull(), &descs));
Shunkai Yaoc12e0822022-12-12 07:13:58 +0000180 EXPECT_EQ(descs.size(), 0UL);
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000181}
182
Shunkai Yao812d5b42022-11-16 18:08:50 +0000183// create all effects, and then destroy them all together
184TEST_P(EffectFactoryTest, CreateAndDestroyEffects) {
Shunkai Yaoc12e0822022-12-12 07:13:58 +0000185 std::vector<Descriptor> descs;
186 EXPECT_IS_OK(mEffectFactory->queryEffects(std::nullopt, std::nullopt, std::nullopt, &descs));
187 EXPECT_NE(descs.size(), 0UL);
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000188
Shunkai Yao812d5b42022-11-16 18:08:50 +0000189 std::vector<std::shared_ptr<IEffect>> effects;
Shunkai Yaoc12e0822022-12-12 07:13:58 +0000190 effects = createWithDescs(descs);
191 EXPECT_EQ(descs.size(), effects.size());
Shunkai Yao812d5b42022-11-16 18:08:50 +0000192 destroyEffects(effects);
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000193}
194
195TEST_P(EffectFactoryTest, CreateMultipleInstanceOfSameEffect) {
Shunkai Yaoc12e0822022-12-12 07:13:58 +0000196 std::vector<Descriptor> descs;
197 EXPECT_IS_OK(mEffectFactory->queryEffects(std::nullopt, std::nullopt, std::nullopt, &descs));
198 EXPECT_NE(descs.size(), 0UL);
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000199
Shunkai Yaoc12e0822022-12-12 07:13:58 +0000200 std::vector<std::shared_ptr<IEffect>> effects = createWithDescs(descs);
201 EXPECT_EQ(descs.size(), effects.size());
202 std::vector<std::shared_ptr<IEffect>> effects2 = createWithDescs(descs);
203 EXPECT_EQ(descs.size(), effects2.size());
204 std::vector<std::shared_ptr<IEffect>> effects3 = createWithDescs(descs);
205 EXPECT_EQ(descs.size(), effects3.size());
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000206
Shunkai Yao812d5b42022-11-16 18:08:50 +0000207 destroyEffects(effects);
208 destroyEffects(effects2);
209 destroyEffects(effects3);
210}
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000211
Shunkai Yao812d5b42022-11-16 18:08:50 +0000212// create and destroy each effect one by one
213TEST_P(EffectFactoryTest, CreateAndDestroyEffectsOneByOne) {
Shunkai Yaoc12e0822022-12-12 07:13:58 +0000214 std::vector<Descriptor> descs;
215 EXPECT_IS_OK(mEffectFactory->queryEffects(std::nullopt, std::nullopt, std::nullopt, &descs));
216 EXPECT_NE(descs.size(), 0UL);
Shunkai Yao812d5b42022-11-16 18:08:50 +0000217
Shunkai Yaoc12e0822022-12-12 07:13:58 +0000218 creatAndDestroyDescs(descs);
Shunkai Yao812d5b42022-11-16 18:08:50 +0000219}
220
221// for each effect: repeat 3 times create and destroy
222TEST_P(EffectFactoryTest, CreateAndDestroyRepeat) {
Shunkai Yaoc12e0822022-12-12 07:13:58 +0000223 std::vector<Descriptor> descs;
224 EXPECT_IS_OK(mEffectFactory->queryEffects(std::nullopt, std::nullopt, std::nullopt, &descs));
225 EXPECT_NE(descs.size(), 0UL);
Shunkai Yao812d5b42022-11-16 18:08:50 +0000226
Shunkai Yaoc12e0822022-12-12 07:13:58 +0000227 creatAndDestroyDescs(descs);
228 creatAndDestroyDescs(descs);
229 creatAndDestroyDescs(descs);
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000230}
231
232// Expect EX_ILLEGAL_ARGUMENT when create with invalid UUID.
233TEST_P(EffectFactoryTest, CreateWithInvalidUuid) {
Shunkai Yaoc12e0822022-12-12 07:13:58 +0000234 std::vector<Descriptor> descs = {kNullDesc, kZeroDesc};
235 auto effects = createWithDescs(descs, EX_ILLEGAL_ARGUMENT);
Shunkai Yao812d5b42022-11-16 18:08:50 +0000236 EXPECT_EQ(effects.size(), 0UL);
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000237}
238
239// Expect EX_ILLEGAL_ARGUMENT when destroy null interface.
240TEST_P(EffectFactoryTest, DestroyWithInvalidInterface) {
241 std::shared_ptr<IEffect> spDummyEffect(nullptr);
Shunkai Yao812d5b42022-11-16 18:08:50 +0000242 destroyEffects({spDummyEffect}, EX_ILLEGAL_ARGUMENT);
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000243}
244
Shunkai Yao812d5b42022-11-16 18:08:50 +0000245// Same descriptor ID should work after service restart.
246TEST_P(EffectFactoryTest, CreateDestroyWithRestart) {
Shunkai Yaoc12e0822022-12-12 07:13:58 +0000247 std::vector<Descriptor> descs;
248 EXPECT_IS_OK(mEffectFactory->queryEffects(std::nullopt, std::nullopt, std::nullopt, &descs));
249 EXPECT_NE(descs.size(), 0UL);
250 creatAndDestroyDescs(descs);
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000251
Shunkai Yao8a4e9b72024-03-04 23:25:36 +0000252 mEffectFactory = IFactory::fromBinder(mBinderUtil.restartService());
253 ASSERT_NE(mEffectFactory, nullptr);
Shunkai Yao812d5b42022-11-16 18:08:50 +0000254
255 connectAndGetFactory();
Shunkai Yaoc12e0822022-12-12 07:13:58 +0000256 creatAndDestroyDescs(descs);
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000257}
258
Shunkai Yao812d5b42022-11-16 18:08:50 +0000259// Effect handle invalid after restart.
260TEST_P(EffectFactoryTest, EffectInvalidAfterRestart) {
Shunkai Yaoc12e0822022-12-12 07:13:58 +0000261 std::vector<Descriptor> descs;
262 EXPECT_IS_OK(mEffectFactory->queryEffects(std::nullopt, std::nullopt, std::nullopt, &descs));
263 EXPECT_NE(descs.size(), 0UL);
264 std::vector<std::shared_ptr<IEffect>> effects = createWithDescs(descs);
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000265
Shunkai Yao8a4e9b72024-03-04 23:25:36 +0000266 mEffectFactory = IFactory::fromBinder(mBinderUtil.restartService());
267 ASSERT_NE(mEffectFactory, nullptr);
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000268
Shunkai Yao812d5b42022-11-16 18:08:50 +0000269 connectAndGetFactory();
270 destroyEffects(effects, EX_ILLEGAL_ARGUMENT);
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000271}
272
Shunkai Yao812d5b42022-11-16 18:08:50 +0000273// expect no error with the queryProcessing interface, but don't check number of processing
Shunkai Yao08b687d2022-10-13 21:11:11 +0000274TEST_P(EffectFactoryTest, QueryProcess) {
275 std::vector<Processing> processing;
Shunkai Yao812d5b42022-11-16 18:08:50 +0000276 EXPECT_IS_OK(mEffectFactory->queryProcessing(std::nullopt, &processing));
Shunkai Yao5824efb2023-05-08 21:16:13 +0000277 std::set<Processing> processingSet(processing.begin(), processing.end());
Shunkai Yao812d5b42022-11-16 18:08:50 +0000278
279 Processing::Type streamType =
280 Processing::Type::make<Processing::Type::streamType>(AudioStreamType::SYSTEM);
281 std::vector<Processing> processingFilteredByStream;
282 EXPECT_IS_OK(mEffectFactory->queryProcessing(streamType, &processingFilteredByStream));
283
284 Processing::Type source =
285 Processing::Type::make<Processing::Type::source>(AudioSource::DEFAULT);
286 std::vector<Processing> processingFilteredBySource;
287 EXPECT_IS_OK(mEffectFactory->queryProcessing(source, &processingFilteredBySource));
288
289 EXPECT_TRUE(processing.size() >= processingFilteredByStream.size());
Shunkai Yao5824efb2023-05-08 21:16:13 +0000290 EXPECT_TRUE(std::all_of(
291 processingFilteredByStream.begin(), processingFilteredByStream.end(),
292 [&](const auto& proc) { return processingSet.find(proc) != processingSet.end(); }));
293
Shunkai Yao812d5b42022-11-16 18:08:50 +0000294 EXPECT_TRUE(processing.size() >= processingFilteredBySource.size());
Shunkai Yao5824efb2023-05-08 21:16:13 +0000295 EXPECT_TRUE(std::all_of(
296 processingFilteredBySource.begin(), processingFilteredBySource.end(),
297 [&](const auto& proc) { return processingSet.find(proc) != processingSet.end(); }));
Shunkai Yao08b687d2022-10-13 21:11:11 +0000298}
299
Shunkai Yao910a8152024-02-01 23:11:28 +0000300// Make sure all effect instances have same HAL version number as IFactory.
301TEST_P(EffectFactoryTest, VersionNumberForAllEffectsEqualsToIFactory) {
302 std::vector<Descriptor> descs;
303 EXPECT_IS_OK(mEffectFactory->queryEffects(std::nullopt, std::nullopt, std::nullopt, &descs));
304 EXPECT_NE(descs.size(), 0UL);
305
306 std::vector<std::shared_ptr<IEffect>> effects = createWithDescs(descs);
307 int factoryVersion = 0;
308 EXPECT_IS_OK(mEffectFactory->getInterfaceVersion(&factoryVersion));
309
310 for (const auto& effect : effects) {
311 int effectVersion = 0;
312 EXPECT_NE(nullptr, effect);
313 EXPECT_IS_OK(effect->getInterfaceVersion(&effectVersion));
314 EXPECT_EQ(factoryVersion, effectVersion);
315 }
316 ASSERT_NO_FATAL_FAILURE(destroyEffects(effects));
317}
318
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000319INSTANTIATE_TEST_SUITE_P(EffectFactoryTest, EffectFactoryTest,
320 testing::ValuesIn(android::getAidlHalInstanceNames(IFactory::descriptor)),
321 android::PrintInstanceNameToString);
322GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST(EffectFactoryTest);
323
324int main(int argc, char** argv) {
325 ::testing::InitGoogleTest(&argc, argv);
Jaideep Sharma74498412023-09-13 15:25:25 +0530326 ::testing::UnitTest::GetInstance()->listeners().Append(new TestExecutionTracer());
Shunkai Yaoea24c1a2022-09-28 17:39:23 +0000327 ABinderProcess_setThreadPoolMaxThreadCount(1);
328 ABinderProcess_startThreadPool();
329 return RUN_ALL_TESTS();
Shunkai Yao96967412023-08-21 18:55:24 +0000330}