HapticGeneratorTest: Add Tests for all HapticGenerator effect parameters
Add validation for multiple scales, scaleFactor, and adaptiveScaleFactors
Add AIDL version check for new parameters
Remove single scale param test as it's being validated in data test
Compare the energies for different values of the parameters
Flag: TEST_ONLY
Bug: 337294664
Bug: 305866207
Test: atest VtsHalHapticGeneratorTargetTest
Test: Haptic generator test APP on Pixel 9
Change-Id: Id95dc5513b00d671cb7fd8581ce8bc22b939cc81
diff --git a/audio/aidl/vts/Android.bp b/audio/aidl/vts/Android.bp
index cbd42c0..85d400e 100644
--- a/audio/aidl/vts/Android.bp
+++ b/audio/aidl/vts/Android.bp
@@ -136,6 +136,9 @@
name: "VtsHalHapticGeneratorTargetTest",
defaults: ["VtsHalAudioEffectTargetTestDefaults"],
srcs: ["VtsHalHapticGeneratorTargetTest.cpp"],
+ shared_libs: [
+ "libaudioutils",
+ ],
}
cc_test {
diff --git a/audio/aidl/vts/EffectHelper.h b/audio/aidl/vts/EffectHelper.h
index 0fa170f..93589e2 100644
--- a/audio/aidl/vts/EffectHelper.h
+++ b/audio/aidl/vts/EffectHelper.h
@@ -454,6 +454,17 @@
mOutputSamples = common.output.frameCount * mOutputFrameSize / sizeof(float);
}
+ void generateInput(std::vector<float>& input, float inputFrequency, float samplingFrequency,
+ size_t inputSize = 0) {
+ if (inputSize == 0 || inputSize > input.size()) {
+ inputSize = input.size();
+ }
+
+ for (size_t i = 0; i < inputSize; i++) {
+ input[i] = sin(2 * M_PI * inputFrequency * i / samplingFrequency);
+ }
+ }
+
bool mIsSpatializer;
Descriptor mDescriptor;
size_t mInputFrameSize, mOutputFrameSize;
diff --git a/audio/aidl/vts/VtsHalHapticGeneratorTargetTest.cpp b/audio/aidl/vts/VtsHalHapticGeneratorTargetTest.cpp
index 154a5af..2802bf9 100644
--- a/audio/aidl/vts/VtsHalHapticGeneratorTargetTest.cpp
+++ b/audio/aidl/vts/VtsHalHapticGeneratorTargetTest.cpp
@@ -21,11 +21,13 @@
#define LOG_TAG "VtsHalHapticGeneratorTargetTest"
#include <android-base/logging.h>
#include <android/binder_enums.h>
+#include <audio_utils/power.h>
#include "EffectHelper.h"
using namespace android;
+using aidl::android::hardware::audio::common::getChannelCount;
using aidl::android::hardware::audio::effect::Descriptor;
using aidl::android::hardware::audio::effect::getEffectTypeUuidHapticGenerator;
using aidl::android::hardware::audio::effect::HapticGenerator;
@@ -34,41 +36,15 @@
using aidl::android::hardware::audio::effect::Parameter;
using android::hardware::audio::common::testing::detail::TestExecutionTracer;
-/**
- * Here we focus on specific parameter checking, general IEffect interfaces testing performed in
- * VtsAudioEffectTargetTest.
- */
-enum ParamName {
- PARAM_INSTANCE_NAME,
- PARAM_HAPTIC_SCALE_ID,
- PARAM_HAPTIC_SCALE_VIBRATOR_SCALE,
- PARAM_HAPTIC_SCALE_SCALE_FACTOR,
- PARAM_HAPTIC_SCALE_ADAPTIVE_SCALE_FACTOR,
- PARAM_VIBRATION_INFORMATION_RESONANT_FREQUENCY,
- PARAM_VIBRATION_INFORMATION_Q_FACTOR,
- PARAM_VIBRATION_INFORMATION_MAX_AMPLITUDE,
-};
-using HapticGeneratorParamTestParam =
- std::tuple<std::pair<std::shared_ptr<IFactory>, Descriptor>, int,
- HapticGenerator::VibratorScale, float, float, float, float, float>;
-
-/*
- * Testing parameter range, assuming the parameter supported by effect is in this range.
- * Parameter should be within the valid range defined in the documentation,
- * for any supported value test expects EX_NONE from IEffect.setParameter(),
- * otherwise expect EX_ILLEGAL_ARGUMENT.
- */
-
-// TODO : Update the test values once range/capability is updated by implementation
const int MIN_ID = std::numeric_limits<int>::min();
const int MAX_ID = std::numeric_limits<int>::max();
const float MIN_FLOAT = std::numeric_limits<float>::min();
const float MAX_FLOAT = std::numeric_limits<float>::max();
-const std::vector<int> kHapticScaleIdValues = {MIN_ID, 0, MAX_ID};
-const std::vector<HapticGenerator::VibratorScale> kVibratorScaleValues = {
+std::vector<HapticGenerator::VibratorScale> kScaleValues = {
ndk::enum_range<HapticGenerator::VibratorScale>().begin(),
ndk::enum_range<HapticGenerator::VibratorScale>().end()};
+
const std::vector<float> kScaleFactorValues = {HapticGenerator::HapticScale::UNDEFINED_SCALE_FACTOR,
0.0f, 0.5f, 1.0f, MAX_FLOAT};
const std::vector<float> kAdaptiveScaleFactorValues = {
@@ -80,396 +56,392 @@
constexpr int HAPTIC_SCALE_FACTORS_EFFECT_MIN_VERSION = 3;
-class HapticGeneratorParamTest : public ::testing::TestWithParam<HapticGeneratorParamTestParam>,
- public EffectHelper {
+static const std::vector<int32_t> kHapticOutputLayouts = {
+ AudioChannelLayout::LAYOUT_MONO_HAPTIC_A, AudioChannelLayout::LAYOUT_MONO_HAPTIC_AB,
+ AudioChannelLayout::LAYOUT_STEREO_HAPTIC_A, AudioChannelLayout::LAYOUT_STEREO_HAPTIC_AB};
+
+class HapticGeneratorHelper : public EffectHelper {
public:
- HapticGeneratorParamTest()
- : mParamHapticScaleId(std::get<PARAM_HAPTIC_SCALE_ID>(GetParam())),
- mParamVibratorScale(std::get<PARAM_HAPTIC_SCALE_VIBRATOR_SCALE>(GetParam())),
- mParamScaleFactor(std::get<PARAM_HAPTIC_SCALE_SCALE_FACTOR>(GetParam())),
- mParamAdaptiveScaleFactor(std::get<PARAM_HAPTIC_SCALE_ADAPTIVE_SCALE_FACTOR>(GetParam())),
- mParamResonantFrequency(
- std::get<PARAM_VIBRATION_INFORMATION_RESONANT_FREQUENCY>(GetParam())),
- mParamQFactor(std::get<PARAM_VIBRATION_INFORMATION_Q_FACTOR>(GetParam())),
- mParamMaxAmplitude(std::get<PARAM_VIBRATION_INFORMATION_MAX_AMPLITUDE>(GetParam())) {
- std::tie(mFactory, mDescriptor) = std::get<PARAM_INSTANCE_NAME>(GetParam());
- }
- void SetUp() override {
+ void SetUpHapticGenerator(int32_t chMask = AudioChannelLayout::CHANNEL_HAPTIC_A) {
ASSERT_NE(nullptr, mFactory);
ASSERT_NO_FATAL_FAILURE(create(mFactory, mEffect, mDescriptor));
EXPECT_STATUS(EX_NONE, mEffect->getInterfaceVersion(&mEffectInterfaceVersion));
+ AudioChannelLayout layout =
+ AudioChannelLayout::make<AudioChannelLayout::layoutMask>(chMask);
+
Parameter::Common common = createParamCommon(
- 0 /* session */, 1 /* ioHandle */, 44100 /* iSampleRate */, 44100 /* oSampleRate */,
- kInputFrameCount /* iFrameCount */, kOutputFrameCount /* oFrameCount */);
- IEffect::OpenEffectReturn ret;
+ 0 /* session */, 1 /* ioHandle */, kSamplingFrequency /* iSampleRate */,
+ kSamplingFrequency /* oSampleRate */, kFrameCount /* iFrameCount */,
+ kFrameCount /* oFrameCount */, layout, layout);
ASSERT_NO_FATAL_FAILURE(open(mEffect, common, std::nullopt, &ret, EX_NONE));
ASSERT_NE(nullptr, mEffect);
}
- void TearDown() override {
+ void TearDownHapticGenerator() {
ASSERT_NO_FATAL_FAILURE(close(mEffect));
ASSERT_NO_FATAL_FAILURE(destroy(mFactory, mEffect));
+ ret = IEffect::OpenEffectReturn{};
}
- static const long kInputFrameCount = 0x100, kOutputFrameCount = 0x100;
- std::shared_ptr<IFactory> mFactory;
- std::shared_ptr<IEffect> mEffect;
- Descriptor mDescriptor;
- int mEffectInterfaceVersion;
- int mParamHapticScaleId = 0;
- HapticGenerator::VibratorScale mParamVibratorScale = HapticGenerator::VibratorScale::MUTE;
- float mParamScaleFactor = HapticGenerator::HapticScale::UNDEFINED_SCALE_FACTOR;
- float mParamAdaptiveScaleFactor = HapticGenerator::HapticScale::UNDEFINED_SCALE_FACTOR;
- float mParamResonantFrequency = 0;
- float mParamQFactor = 0;
- float mParamMaxAmplitude = 0;
+ Parameter createScaleParam(const std::vector<HapticGenerator::HapticScale>& hapticScales) {
+ return Parameter::make<Parameter::specific>(
+ Parameter::Specific::make<Parameter::Specific::hapticGenerator>(
+ HapticGenerator::make<HapticGenerator::hapticScales>(hapticScales)));
+ }
- void SetAndGetHapticGeneratorParameters() {
- for (auto& it : mTags) {
- auto& tag = std::get<ParamTestEnum::PARAM_TEST_TAG>(it);
- auto& setHg = std::get<ParamTestEnum::PARAM_TEST_TARGET>(it);
+ Parameter createVibratorParam(HapticGenerator::VibratorInformation vibrationInfo) {
+ return Parameter::make<Parameter::specific>(
+ Parameter::Specific::make<Parameter::Specific::hapticGenerator>(
+ HapticGenerator::make<HapticGenerator::vibratorInfo>(vibrationInfo)));
+ }
- // set parameter
- Parameter expectParam;
- Parameter::Specific specific;
- specific.set<Parameter::Specific::hapticGenerator>(setHg);
- expectParam.set<Parameter::specific>(specific);
- EXPECT_STATUS(EX_NONE, mEffect->setParameter(expectParam)) << expectParam.toString();
-
+ void setAndVerifyParameter(Parameter hapticParameter, HapticGenerator::Tag tag,
+ binder_exception_t expected = EX_NONE) {
+ EXPECT_STATUS(expected, mEffect->setParameter(hapticParameter))
+ << hapticParameter.toString();
+ if (expected == EX_NONE) {
// get parameter
Parameter getParam;
- Parameter::Id id;
- HapticGenerator::Id hgId;
- hgId.set<HapticGenerator::Id::commonTag>(tag);
- id.set<Parameter::Id::hapticGeneratorTag>(hgId);
- EXPECT_STATUS(EX_NONE, mEffect->getParameter(id, &getParam));
- EXPECT_EQ(expectParam, getParam) << expectParam.toString() << "\n"
- << getParam.toString();
+ auto second = Parameter::Id::make<Parameter::Id::hapticGeneratorTag>(
+ HapticGenerator::Id::make<HapticGenerator::Id::commonTag>(
+ HapticGenerator::Tag(tag)));
+ // If the set is successful, get param should match
+ EXPECT_STATUS(expected, mEffect->getParameter(second, &getParam));
+ EXPECT_EQ(hapticParameter, getParam) << "\nexpectedParam:" << hapticParameter.toString()
+ << "\ngetParam:" << getParam.toString();
}
}
- void addHapticScaleParam(int id, HapticGenerator::VibratorScale scale, float scaleFactor,
- float adaptiveScaleFactor) {
- HapticGenerator setHg;
- std::vector<HapticGenerator::HapticScale> hapticScales;
- if (mEffectInterfaceVersion >= HAPTIC_SCALE_FACTORS_EFFECT_MIN_VERSION) {
- hapticScales = {{.id = id,
- .scale = scale,
- .scaleFactor = scaleFactor,
- .adaptiveScaleFactor = adaptiveScaleFactor}};
- } else {
- hapticScales = {{.id = id, .scale = scale}};
- }
- setHg.set<HapticGenerator::hapticScales>(hapticScales);
- mTags.push_back({HapticGenerator::hapticScales, setHg});
+ HapticGenerator::VibratorInformation createVibratorInfo(float resonantFrequency, float qFactor,
+ float amplitude) {
+ return HapticGenerator::VibratorInformation(resonantFrequency, qFactor, amplitude);
}
- void addVibratorInformationParam(float resonantFrequencyHz, float qFactor, float maxAmplitude) {
- HapticGenerator hg;
- HapticGenerator::VibratorInformation vibrationInfo = {
- .resonantFrequencyHz = resonantFrequencyHz,
- .qFactor = qFactor,
- .maxAmplitude = maxAmplitude};
- hg.set<HapticGenerator::vibratorInfo>(vibrationInfo);
- mTags.push_back({HapticGenerator::vibratorInfo, hg});
- }
-
- private:
- enum ParamTestEnum { PARAM_TEST_TAG, PARAM_TEST_TARGET };
- std::vector<std::tuple<HapticGenerator::Tag, HapticGenerator>> mTags;
-
- void CleanUp() { mTags.clear(); }
-};
-
-TEST_P(HapticGeneratorParamTest, SetAndGetHapticScale) {
- EXPECT_NO_FATAL_FAILURE(addHapticScaleParam(mParamHapticScaleId, mParamVibratorScale,
- mParamScaleFactor, mParamAdaptiveScaleFactor));
- SetAndGetHapticGeneratorParameters();
-}
-
-TEST_P(HapticGeneratorParamTest, SetAndGetMultipleHapticScales) {
- EXPECT_NO_FATAL_FAILURE(addHapticScaleParam(mParamHapticScaleId, mParamVibratorScale,
- mParamScaleFactor, mParamAdaptiveScaleFactor));
- EXPECT_NO_FATAL_FAILURE(addHapticScaleParam(mParamHapticScaleId, mParamVibratorScale,
- mParamScaleFactor, mParamAdaptiveScaleFactor));
- SetAndGetHapticGeneratorParameters();
-}
-
-TEST_P(HapticGeneratorParamTest, SetAndGetVibratorInformation) {
- EXPECT_NO_FATAL_FAILURE(addVibratorInformationParam(mParamResonantFrequency, mParamQFactor,
- mParamMaxAmplitude));
- SetAndGetHapticGeneratorParameters();
-}
-
-INSTANTIATE_TEST_SUITE_P(
- HapticGeneratorValidTest, HapticGeneratorParamTest,
- ::testing::Combine(testing::ValuesIn(EffectFactoryHelper::getAllEffectDescriptors(
- IFactory::descriptor, getEffectTypeUuidHapticGenerator())),
- testing::ValuesIn(kHapticScaleIdValues),
- testing::ValuesIn(kVibratorScaleValues),
- testing::ValuesIn(kScaleFactorValues),
- testing::ValuesIn(kAdaptiveScaleFactorValues),
- testing::ValuesIn(kResonantFrequencyValues),
- testing::ValuesIn(kQFactorValues), testing::ValuesIn(kMaxAmplitude)),
- [](const testing::TestParamInfo<HapticGeneratorParamTest::ParamType>& info) {
- auto descriptor = std::get<PARAM_INSTANCE_NAME>(info.param).second;
- std::string hapticScaleID = std::to_string(std::get<PARAM_HAPTIC_SCALE_ID>(info.param));
- std::string hapticScaleVibScale = std::to_string(
- static_cast<int>(std::get<PARAM_HAPTIC_SCALE_VIBRATOR_SCALE>(info.param)));
- std::string hapticScaleFactor =
- std::to_string(std::get<PARAM_HAPTIC_SCALE_SCALE_FACTOR>(info.param));
- std::string hapticAdaptiveScaleFactor =
- std::to_string(std::get<PARAM_HAPTIC_SCALE_ADAPTIVE_SCALE_FACTOR>(info.param));
- std::string resonantFrequency = std::to_string(
- std::get<PARAM_VIBRATION_INFORMATION_RESONANT_FREQUENCY>(info.param));
- std::string qFactor =
- std::to_string(std::get<PARAM_VIBRATION_INFORMATION_Q_FACTOR>(info.param));
- std::string maxAmplitude =
- std::to_string(std::get<PARAM_VIBRATION_INFORMATION_MAX_AMPLITUDE>(info.param));
- std::string name = getPrefix(descriptor) + "_hapticScaleId" + hapticScaleID +
- "_hapticScaleVibScale" + hapticScaleVibScale + "_hapticScaleFactor" +
- hapticScaleFactor + "_hapticAdaptiveScaleFactor" +
- hapticAdaptiveScaleFactor + "_resonantFrequency" +
- resonantFrequency + "_qFactor" + qFactor + "_maxAmplitude" +
- maxAmplitude;
- std::replace_if(
- name.begin(), name.end(), [](const char c) { return !std::isalnum(c); }, '_');
- return name;
- });
-
-INSTANTIATE_TEST_SUITE_P(
- HapticGeneratorInvalidTest, HapticGeneratorParamTest,
- ::testing::Combine(testing::ValuesIn(EffectFactoryHelper::getAllEffectDescriptors(
- IFactory::descriptor, getEffectTypeUuidHapticGenerator())),
- testing::Values(MIN_ID),
- testing::Values(HapticGenerator::VibratorScale::NONE),
- testing::Values(HapticGenerator::HapticScale::UNDEFINED_SCALE_FACTOR),
- testing::Values(HapticGenerator::HapticScale::UNDEFINED_SCALE_FACTOR),
- testing::Values(MIN_FLOAT), testing::Values(MIN_FLOAT),
- testing::Values(MIN_FLOAT)),
- [](const testing::TestParamInfo<HapticGeneratorParamTest::ParamType>& info) {
- auto descriptor = std::get<PARAM_INSTANCE_NAME>(info.param).second;
- std::string hapticScaleID = std::to_string(std::get<PARAM_HAPTIC_SCALE_ID>(info.param));
- std::string hapticScaleVibScale = std::to_string(
- static_cast<int>(std::get<PARAM_HAPTIC_SCALE_VIBRATOR_SCALE>(info.param)));
- std::string hapticScaleFactor =
- std::to_string(std::get<PARAM_HAPTIC_SCALE_SCALE_FACTOR>(info.param));
- std::string hapticAdaptiveScaleFactor =
- std::to_string(std::get<PARAM_HAPTIC_SCALE_ADAPTIVE_SCALE_FACTOR>(info.param));
- std::string resonantFrequency = std::to_string(
- std::get<PARAM_VIBRATION_INFORMATION_RESONANT_FREQUENCY>(info.param));
- std::string qFactor =
- std::to_string(std::get<PARAM_VIBRATION_INFORMATION_Q_FACTOR>(info.param));
- std::string maxAmplitude =
- std::to_string(std::get<PARAM_VIBRATION_INFORMATION_MAX_AMPLITUDE>(info.param));
- std::string name = "Implementor_" + descriptor.common.implementor + "_name_" +
- descriptor.common.name + "_UUID_" +
- toString(descriptor.common.id.uuid) + "_hapticScaleId" +
- hapticScaleID + "_hapticScaleVibScale" + hapticScaleVibScale +
- "_hapticScaleFactor" + hapticScaleFactor +
- "_hapticAdaptiveScaleFactor" + hapticAdaptiveScaleFactor +
- "_resonantFrequency" + resonantFrequency + "_qFactor" + qFactor +
- "_maxAmplitude" + maxAmplitude;
- std::replace_if(
- name.begin(), name.end(), [](const char c) { return !std::isalnum(c); }, '_');
- return name;
- });
-GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST(HapticGeneratorParamTest);
-
-// Test HapticScale[] hapticScales parameter
-using HapticGeneratorScalesTestParam = std::tuple<std::pair<std::shared_ptr<IFactory>, Descriptor>>;
-class HapticGeneratorScalesTest : public ::testing::TestWithParam<HapticGeneratorScalesTestParam>,
- public EffectHelper {
- public:
- HapticGeneratorScalesTest() {
- std::tie(mFactory, mDescriptor) = std::get<PARAM_INSTANCE_NAME>(GetParam());
- }
-
- void SetUp() override {
- ASSERT_NE(nullptr, mFactory);
- ASSERT_NO_FATAL_FAILURE(create(mFactory, mEffect, mDescriptor));
-
- Parameter::Common common = createParamCommon(
- 0 /* session */, 1 /* ioHandle */, 44100 /* iSampleRate */, 44100 /* oSampleRate */,
- kInputFrameCount /* iFrameCount */, kOutputFrameCount /* oFrameCount */);
- IEffect::OpenEffectReturn ret;
- ASSERT_NO_FATAL_FAILURE(open(mEffect, common, std::nullopt, &ret, EX_NONE));
- ASSERT_NE(nullptr, mEffect);
- }
-
- void TearDown() override {
- ASSERT_NO_FATAL_FAILURE(close(mEffect));
- ASSERT_NO_FATAL_FAILURE(destroy(mFactory, mEffect));
- CleanUp();
- }
-
- static const long kInputFrameCount = 0x100, kOutputFrameCount = 0x100;
+ static const long kFrameCount = 10000;
+ static constexpr int kSamplingFrequency = 44100;
+ static constexpr int kDefaultScaleID = 0;
+ static constexpr float kDefaultMaxAmp = 1;
+ static constexpr float kDefaultResonantFrequency = 150;
+ static constexpr float kDefaultQfactor = 8;
+ static constexpr HapticGenerator::VibratorScale kDefaultScale =
+ HapticGenerator::VibratorScale::NONE;
std::shared_ptr<IFactory> mFactory;
std::shared_ptr<IEffect> mEffect;
- Descriptor mDescriptor;
-
- void addHapticScaleParam(std::vector<HapticGenerator::HapticScale> scales) {
- mHapticScales.push_back(HapticGenerator::make<HapticGenerator::hapticScales>(scales));
- for (const auto& scale : scales) {
- expectMap.insert_or_assign(scale.id, scale.scale);
- }
- }
-
- void SetHapticScaleParameters() {
- // std::unordered_set<HapticGenerator::HapticScale> target;
- for (auto& it : mHapticScales) {
- Parameter::Specific specific =
- Parameter::Specific::make<Parameter::Specific::hapticGenerator>(it);
- Parameter param = Parameter::make<Parameter::specific>(specific);
- EXPECT_STATUS(EX_NONE, mEffect->setParameter(param)) << param.toString();
- }
- }
-
- void checkHapticScaleParameter() {
- // get parameter
- Parameter targetParam;
- HapticGenerator::Id hgId = HapticGenerator::Id::make<HapticGenerator::Id::commonTag>(
- HapticGenerator::hapticScales);
- Parameter::Id id = Parameter::Id::make<Parameter::Id::hapticGeneratorTag>(hgId);
- EXPECT_STATUS(EX_NONE, mEffect->getParameter(id, &targetParam));
- ASSERT_EQ(Parameter::specific, targetParam.getTag());
- Parameter::Specific specific = targetParam.get<Parameter::specific>();
- ASSERT_EQ(Parameter::Specific::hapticGenerator, specific.getTag());
- HapticGenerator hg = specific.get<Parameter::Specific::hapticGenerator>();
- ASSERT_EQ(HapticGenerator::hapticScales, hg.getTag());
- std::vector<HapticGenerator::HapticScale> scales = hg.get<HapticGenerator::hapticScales>();
- ASSERT_EQ(scales.size(), expectMap.size());
- for (const auto& scale : scales) {
- auto itor = expectMap.find(scale.id);
- ASSERT_NE(expectMap.end(), itor);
- ASSERT_EQ(scale.scale, itor->second);
- expectMap.erase(scale.id);
- }
- ASSERT_EQ(0ul, expectMap.size());
- }
-
- const static HapticGenerator::HapticScale kHapticScaleWithMinId;
- const static HapticGenerator::HapticScale kHapticScaleWithMinIdNew;
- const static HapticGenerator::HapticScale kHapticScale;
- const static HapticGenerator::HapticScale kHapticScaleNew;
- const static HapticGenerator::HapticScale kHapticScaleWithMaxId;
- const static HapticGenerator::HapticScale kHapticScaleWithMaxIdNew;
-
- std::vector<HapticGenerator> mHapticScales;
-
- void CleanUp() {
- mHapticScales.clear();
- expectMap.clear();
- }
-
- private:
- std::map<int /* trackID */, HapticGenerator::VibratorScale> expectMap;
+ IEffect::OpenEffectReturn ret;
+ Parameter mHapticSpecificParameter;
+ Parameter::Id mHapticIdParameter;
+ int mEffectInterfaceVersion;
};
-const HapticGenerator::HapticScale HapticGeneratorScalesTest::kHapticScaleWithMinId = {
- .id = MIN_ID, .scale = HapticGenerator::VibratorScale::MUTE};
-const HapticGenerator::HapticScale HapticGeneratorScalesTest::kHapticScaleWithMinIdNew = {
- .id = MIN_ID, .scale = HapticGenerator::VibratorScale::VERY_LOW};
-const HapticGenerator::HapticScale HapticGeneratorScalesTest::kHapticScale = {
- .id = 1, .scale = HapticGenerator::VibratorScale::LOW};
-const HapticGenerator::HapticScale HapticGeneratorScalesTest::kHapticScaleNew = {
- .id = 1, .scale = HapticGenerator::VibratorScale::NONE};
-const HapticGenerator::HapticScale HapticGeneratorScalesTest::kHapticScaleWithMaxId = {
- .id = MAX_ID, .scale = HapticGenerator::VibratorScale::VERY_HIGH};
-const HapticGenerator::HapticScale HapticGeneratorScalesTest::kHapticScaleWithMaxIdNew = {
- .id = MAX_ID, .scale = HapticGenerator::VibratorScale::MUTE};
+/**
+ *Tests do the following:
+ * -Testing parameter range supported by the effect.
+ * -For any supported value test expects EX_NONE from IEffect.setParameter(),
+ * otherwise expect EX_ILLEGAL_ARGUMENT.
+ * -Validating the effect by comparing the output energies of the supported parameters.
+ **/
-TEST_P(HapticGeneratorScalesTest, SetAndUpdateOne) {
- EXPECT_NO_FATAL_FAILURE(addHapticScaleParam({kHapticScale}));
- EXPECT_NO_FATAL_FAILURE(SetHapticScaleParameters());
- EXPECT_NO_FATAL_FAILURE(addHapticScaleParam({kHapticScaleNew}));
- EXPECT_NO_FATAL_FAILURE(SetHapticScaleParameters());
+using EffectInstance = std::pair<std::shared_ptr<IFactory>, Descriptor>;
- EXPECT_NO_FATAL_FAILURE(addHapticScaleParam({kHapticScaleWithMinId}));
- EXPECT_NO_FATAL_FAILURE(SetHapticScaleParameters());
- EXPECT_NO_FATAL_FAILURE(addHapticScaleParam({kHapticScaleWithMinIdNew}));
- EXPECT_NO_FATAL_FAILURE(SetHapticScaleParameters());
+class HapticGeneratorScaleParamTest : public ::testing::TestWithParam<EffectInstance>,
+ public HapticGeneratorHelper {
+ public:
+ HapticGeneratorScaleParamTest() { std::tie(mFactory, mDescriptor) = GetParam(); }
+ void SetUp() override { ASSERT_NO_FATAL_FAILURE(SetUpHapticGenerator()); }
+ void TearDown() override { ASSERT_NO_FATAL_FAILURE(TearDownHapticGenerator()); }
+};
- EXPECT_NO_FATAL_FAILURE(addHapticScaleParam({kHapticScaleWithMaxId}));
- EXPECT_NO_FATAL_FAILURE(SetHapticScaleParameters());
- EXPECT_NO_FATAL_FAILURE(addHapticScaleParam({kHapticScaleWithMaxIdNew}));
- EXPECT_NO_FATAL_FAILURE(SetHapticScaleParameters());
-
- EXPECT_NO_FATAL_FAILURE(checkHapticScaleParameter());
+TEST_P(HapticGeneratorScaleParamTest, SetAndGetScales) {
+ std::vector<HapticGenerator::HapticScale> hapticScales;
+ for (int i = 0; i < static_cast<int>(kScaleValues.size()); i++) {
+ hapticScales.push_back({.id = i, .scale = kScaleValues[i]});
+ }
+ ASSERT_NO_FATAL_FAILURE(
+ setAndVerifyParameter(createScaleParam(hapticScales), HapticGenerator::hapticScales));
}
-TEST_P(HapticGeneratorScalesTest, SetAndUpdateVector) {
- EXPECT_NO_FATAL_FAILURE(
- addHapticScaleParam({kHapticScale, kHapticScaleWithMaxId, kHapticScaleWithMinId}));
- EXPECT_NO_FATAL_FAILURE(SetHapticScaleParameters());
- EXPECT_NO_FATAL_FAILURE(addHapticScaleParam(
- {kHapticScaleNew, kHapticScaleWithMaxIdNew, kHapticScaleWithMinIdNew}));
- EXPECT_NO_FATAL_FAILURE(SetHapticScaleParameters());
+TEST_P(HapticGeneratorScaleParamTest, SetAndGetScaleFactors) {
+ if (mEffectInterfaceVersion < HAPTIC_SCALE_FACTORS_EFFECT_MIN_VERSION) {
+ GTEST_SKIP() << "Skipping HapticGenerator ScaleFactors test for effect version "
+ << std::to_string(mEffectInterfaceVersion);
+ }
- EXPECT_NO_FATAL_FAILURE(checkHapticScaleParameter());
+ std::vector<HapticGenerator::HapticScale> hapticScales;
+ for (int i = 0; i < static_cast<int>(kScaleFactorValues.size()); i++) {
+ hapticScales.push_back(
+ {.id = i, .scale = kScaleValues[0], .scaleFactor = kScaleFactorValues[i]});
+ }
+ ASSERT_NO_FATAL_FAILURE(
+ setAndVerifyParameter(createScaleParam(hapticScales), HapticGenerator::hapticScales));
}
-TEST_P(HapticGeneratorScalesTest, SetAndUpdateMultipleVector) {
- EXPECT_NO_FATAL_FAILURE(
- addHapticScaleParam({kHapticScale, kHapticScaleWithMaxId, kHapticScaleWithMinId}));
- EXPECT_NO_FATAL_FAILURE(SetHapticScaleParameters());
- EXPECT_NO_FATAL_FAILURE(addHapticScaleParam(
- {kHapticScaleNew, kHapticScaleWithMaxIdNew, kHapticScaleWithMinIdNew}));
- EXPECT_NO_FATAL_FAILURE(SetHapticScaleParameters());
- EXPECT_NO_FATAL_FAILURE(
- addHapticScaleParam({kHapticScale, kHapticScaleWithMaxId, kHapticScaleWithMinId}));
- EXPECT_NO_FATAL_FAILURE(SetHapticScaleParameters());
+TEST_P(HapticGeneratorScaleParamTest, SetAndGetAdaptiveScaleFactors) {
+ if (mEffectInterfaceVersion < HAPTIC_SCALE_FACTORS_EFFECT_MIN_VERSION) {
+ GTEST_SKIP() << "Skipping HapticGenerator AdaptiveScaleFactors test for effect version "
+ << std::to_string(mEffectInterfaceVersion);
+ }
- EXPECT_NO_FATAL_FAILURE(checkHapticScaleParameter());
-}
-
-TEST_P(HapticGeneratorScalesTest, SetOneAndAddMoreVector) {
- EXPECT_NO_FATAL_FAILURE(addHapticScaleParam({kHapticScale}));
- EXPECT_NO_FATAL_FAILURE(SetHapticScaleParameters());
- EXPECT_NO_FATAL_FAILURE(addHapticScaleParam({kHapticScaleWithMaxId, kHapticScaleWithMinId}));
- EXPECT_NO_FATAL_FAILURE(SetHapticScaleParameters());
-
- EXPECT_NO_FATAL_FAILURE(checkHapticScaleParameter());
-}
-
-TEST_P(HapticGeneratorScalesTest, SetMultipleAndAddOneVector) {
- EXPECT_NO_FATAL_FAILURE(addHapticScaleParam({kHapticScaleWithMaxId, kHapticScaleWithMinId}));
- EXPECT_NO_FATAL_FAILURE(SetHapticScaleParameters());
- EXPECT_NO_FATAL_FAILURE(addHapticScaleParam({kHapticScale}));
- EXPECT_NO_FATAL_FAILURE(SetHapticScaleParameters());
-
- EXPECT_NO_FATAL_FAILURE(checkHapticScaleParameter());
-}
-
-TEST_P(HapticGeneratorScalesTest, SetMultipleVectorRepeat) {
- EXPECT_NO_FATAL_FAILURE(
- addHapticScaleParam({kHapticScaleWithMaxId, kHapticScale, kHapticScaleWithMinId}));
- EXPECT_NO_FATAL_FAILURE(SetHapticScaleParameters());
- EXPECT_NO_FATAL_FAILURE(
- addHapticScaleParam({kHapticScaleWithMaxId, kHapticScale, kHapticScaleWithMinId}));
- EXPECT_NO_FATAL_FAILURE(SetHapticScaleParameters());
- EXPECT_NO_FATAL_FAILURE(
- addHapticScaleParam({kHapticScaleWithMaxId, kHapticScale, kHapticScaleWithMinId}));
- EXPECT_NO_FATAL_FAILURE(SetHapticScaleParameters());
-
- EXPECT_NO_FATAL_FAILURE(checkHapticScaleParameter());
+ std::vector<HapticGenerator::HapticScale> hapticScales;
+ for (int i = 0; i < static_cast<int>(kAdaptiveScaleFactorValues.size()); i++) {
+ hapticScales.push_back({.id = i,
+ .scale = kScaleValues[0],
+ .scaleFactor = kScaleFactorValues[3],
+ .adaptiveScaleFactor = kAdaptiveScaleFactorValues[i]});
+ }
+ ASSERT_NO_FATAL_FAILURE(
+ setAndVerifyParameter(createScaleParam(hapticScales), HapticGenerator::hapticScales));
}
INSTANTIATE_TEST_SUITE_P(
- HapticGeneratorScalesTest, HapticGeneratorScalesTest,
+ HapticGeneratorValidTest, HapticGeneratorScaleParamTest,
+ testing::ValuesIn(EffectFactoryHelper::getAllEffectDescriptors(
+ IFactory::descriptor, getEffectTypeUuidHapticGenerator())),
+ [](const testing::TestParamInfo<HapticGeneratorScaleParamTest::ParamType>& info) {
+ auto descriptor = info.param;
+ return getPrefix(descriptor.second);
+ });
+
+GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST(HapticGeneratorScaleParamTest);
+
+enum VibratorParamName {
+ VIBRATOR_PARAM_INSTANCE,
+ VIBRATOR_PARAM_RESONANT_FREQUENCY,
+ VIBRATOR_PARAM_Q_FACTOR,
+ VIBRATOR_PARAM_MAX_AMPLITUDE,
+};
+
+using HapticGeneratorVibratorInfoTestParam = std::tuple<EffectInstance, float, float, float>;
+
+class HapticGeneratorVibratorInfoParamTest
+ : public ::testing::TestWithParam<HapticGeneratorVibratorInfoTestParam>,
+ public HapticGeneratorHelper {
+ public:
+ HapticGeneratorVibratorInfoParamTest()
+ : mParamResonantFrequency(std::get<VIBRATOR_PARAM_RESONANT_FREQUENCY>(GetParam())),
+ mParamQFactor(std::get<VIBRATOR_PARAM_Q_FACTOR>(GetParam())),
+ mParamMaxAmplitude(std::get<VIBRATOR_PARAM_MAX_AMPLITUDE>(GetParam())) {
+ std::tie(mFactory, mDescriptor) = std::get<VIBRATOR_PARAM_INSTANCE>(GetParam());
+ }
+ void SetUp() override { ASSERT_NO_FATAL_FAILURE(SetUpHapticGenerator()); }
+ void TearDown() override { ASSERT_NO_FATAL_FAILURE(TearDownHapticGenerator()); }
+
+ float mParamResonantFrequency = kDefaultResonantFrequency;
+ float mParamQFactor = kDefaultQfactor;
+ float mParamMaxAmplitude = kDefaultMaxAmp;
+};
+
+TEST_P(HapticGeneratorVibratorInfoParamTest, SetAndGetVibratorInformation) {
+ auto vibratorInfo =
+ createVibratorInfo(mParamResonantFrequency, mParamQFactor, mParamMaxAmplitude);
+ if (isParameterValid<HapticGenerator, Range::hapticGenerator>(vibratorInfo, mDescriptor)) {
+ ASSERT_NO_FATAL_FAILURE(setAndVerifyParameter(createVibratorParam(vibratorInfo),
+ HapticGenerator::vibratorInfo));
+ } else {
+ ASSERT_NO_FATAL_FAILURE(setAndVerifyParameter(createVibratorParam(vibratorInfo),
+ HapticGenerator::vibratorInfo,
+ EX_ILLEGAL_ARGUMENT));
+ }
+}
+GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST(HapticGeneratorVibratorInfoParamTest);
+
+INSTANTIATE_TEST_SUITE_P(
+ HapticGeneratorValidTest, HapticGeneratorVibratorInfoParamTest,
::testing::Combine(testing::ValuesIn(EffectFactoryHelper::getAllEffectDescriptors(
- IFactory::descriptor, getEffectTypeUuidHapticGenerator()))),
- [](const testing::TestParamInfo<HapticGeneratorScalesTest::ParamType>& info) {
- auto descriptor = std::get<PARAM_INSTANCE_NAME>(info.param).second;
- std::string name = "Implementor_" + descriptor.common.implementor + "_name_" +
- descriptor.common.name + "_UUID_" +
- toString(descriptor.common.id.uuid);
+ IFactory::descriptor, getEffectTypeUuidHapticGenerator())),
+ testing::ValuesIn(kResonantFrequencyValues),
+ testing::ValuesIn(kQFactorValues), testing::ValuesIn(kMaxAmplitude)),
+ [](const testing::TestParamInfo<HapticGeneratorVibratorInfoParamTest::ParamType>& info) {
+ auto descriptor = std::get<VIBRATOR_PARAM_INSTANCE>(info.param).second;
+ std::string resonantFrequency =
+ std::to_string(std::get<VIBRATOR_PARAM_RESONANT_FREQUENCY>(info.param));
+ std::string qFactor = std::to_string(std::get<VIBRATOR_PARAM_Q_FACTOR>(info.param));
+ std::string maxAmplitude =
+ std::to_string(std::get<VIBRATOR_PARAM_MAX_AMPLITUDE>(info.param));
+ std::string name = getPrefix(descriptor) + "_resonantFrequency" + resonantFrequency +
+ "_qFactor" + qFactor + "_maxAmplitude" + maxAmplitude;
std::replace_if(
name.begin(), name.end(), [](const char c) { return !std::isalnum(c); }, '_');
return name;
});
-GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST(HapticGeneratorScalesTest);
+
+/**
+ * The data tests do the following
+ * -Generate test input.
+ * -Check if the parameters are supported. Skip the unsupported parameter values.
+ * -Validate increase in haptic output energy energy.
+ **/
+
+enum DataTestParam { EFFECT_INSTANCE, LAYOUT };
+using HapticGeneratorDataTestParam = std::tuple<EffectInstance, int32_t>;
+
+class HapticGeneratorDataTest : public ::testing::TestWithParam<HapticGeneratorDataTestParam>,
+ public HapticGeneratorHelper {
+ public:
+ HapticGeneratorDataTest() : mChMask(std::get<LAYOUT>(GetParam())) {
+ std::tie(mFactory, mDescriptor) = std::get<EFFECT_INSTANCE>(GetParam());
+ mAudioChannelCount =
+ getChannelCount(AudioChannelLayout::make<AudioChannelLayout::layoutMask>(mChMask),
+ ~AudioChannelLayout::LAYOUT_HAPTIC_AB);
+ mHapticChannelCount =
+ getChannelCount(AudioChannelLayout::make<AudioChannelLayout::layoutMask>(mChMask),
+ AudioChannelLayout::LAYOUT_HAPTIC_AB);
+
+ mAudioSamples = kFrameCount * mAudioChannelCount;
+ mHapticSamples = kFrameCount * mHapticChannelCount;
+ mInput.resize(mHapticSamples + mAudioSamples, 0);
+ mOutput.resize(mHapticSamples + mAudioSamples, 0);
+ }
+
+ void SetUp() override { ASSERT_NO_FATAL_FAILURE(SetUpHapticGenerator(mChMask)); }
+ void TearDown() override { ASSERT_NO_FATAL_FAILURE(TearDownHapticGenerator()); }
+
+ void generateSinePeriod() {
+ size_t cycleSize = kSamplingFrequency / kInputFrequency;
+ size_t startSize = 0;
+ while (startSize < mAudioSamples) {
+ for (size_t i = 0; i < cycleSize; i++) {
+ mInput[i + startSize] = sin(2 * M_PI * kInputFrequency * i / kSamplingFrequency);
+ }
+ startSize += mAudioSamples / 4;
+ }
+ }
+
+ void setBaseVibratorParam() {
+ auto vibratorInfo =
+ createVibratorInfo(kDefaultResonantFrequency, kDefaultQfactor, kDefaultMaxAmp);
+ if (isParameterValid<HapticGenerator, Range::hapticGenerator>(vibratorInfo, mDescriptor)) {
+ ASSERT_NO_FATAL_FAILURE(setAndVerifyParameter(createVibratorParam(vibratorInfo),
+ HapticGenerator::vibratorInfo));
+ } else {
+ GTEST_SKIP() << "Invalid base vibrator values, skipping the test\n";
+ }
+ }
+
+ void setBaseScaleParam() {
+ ASSERT_NO_FATAL_FAILURE(setAndVerifyParameter(
+ createScaleParam({HapticGenerator::HapticScale(kDefaultScaleID, kDefaultScale)}),
+ HapticGenerator::hapticScales));
+ }
+
+ void validateIncreasingEnergy(HapticGenerator::Tag tag) {
+ float baseEnergy = -1;
+ for (auto param : mHapticParam) {
+ ASSERT_NO_FATAL_FAILURE(setAndVerifyParameter(param, tag));
+ SCOPED_TRACE("Param: " + param.toString());
+ ASSERT_NO_FATAL_FAILURE(processAndWriteToOutput(mInput, mOutput, mEffect, &ret));
+ float hapticOutputEnergy = audio_utils_compute_energy_mono(
+ mOutput.data() + mAudioSamples, AUDIO_FORMAT_PCM_FLOAT, mHapticSamples);
+ EXPECT_GT(hapticOutputEnergy, baseEnergy);
+ baseEnergy = hapticOutputEnergy;
+ }
+ }
+
+ float findAbsMax(auto begin, auto end) {
+ return *std::max_element(begin, end,
+ [](float a, float b) { return std::abs(a) < std::abs(b); });
+ }
+
+ void findMaxAmplitude() {
+ for (float amp = 0.1; amp <= 1; amp += 0.1) {
+ auto vibratorInfo = createVibratorInfo(kDefaultResonantFrequency, kDefaultQfactor, amp);
+ if (!isParameterValid<HapticGenerator, Range::hapticGenerator>(vibratorInfo,
+ mDescriptor)) {
+ continue;
+ }
+ ASSERT_NO_FATAL_FAILURE(setAndVerifyParameter(createVibratorParam(vibratorInfo),
+ HapticGenerator::vibratorInfo));
+ ASSERT_NO_FATAL_FAILURE(processAndWriteToOutput(mInput, mOutput, mEffect, &ret));
+ float outAmplitude = findAbsMax(mOutput.begin() + mAudioSamples, mOutput.end());
+ if (outAmplitude > mMaxAmplitude) {
+ mMaxAmplitude = outAmplitude;
+ } else {
+ break;
+ }
+ }
+ }
+
+ const int kInputFrequency = 1000;
+ float mMaxAmplitude = 0;
+ size_t mHapticSamples;
+ int32_t mChMask;
+ int32_t mAudioChannelCount;
+ int32_t mHapticChannelCount;
+ size_t mAudioSamples;
+ float mBaseHapticOutputEnergy;
+ std::vector<Parameter> mHapticParam;
+ // both input and output buffer includes audio and haptic samples
+ std::vector<float> mInput;
+ std::vector<float> mOutput;
+};
+
+TEST_P(HapticGeneratorDataTest, IncreasingVibratorScaleTest) {
+ generateInput(mInput, kInputFrequency, kSamplingFrequency, mAudioSamples);
+ ASSERT_NO_FATAL_FAILURE(setBaseVibratorParam());
+ for (HapticGenerator::VibratorScale scale : kScaleValues) {
+ mHapticParam.push_back(
+ createScaleParam({HapticGenerator::HapticScale(kDefaultScaleID, scale)}));
+ }
+ ASSERT_NO_FATAL_FAILURE(validateIncreasingEnergy(HapticGenerator::hapticScales));
+}
+
+TEST_P(HapticGeneratorDataTest, IncreasingMaxAmplitudeTest) {
+ generateInput(mInput, kInputFrequency, kSamplingFrequency, mAudioSamples);
+ ASSERT_NO_FATAL_FAILURE(setBaseScaleParam());
+ findMaxAmplitude();
+ std::vector<float> increasingAmplitudeValues = {0.25f * mMaxAmplitude, 0.5f * mMaxAmplitude,
+ 0.75f * mMaxAmplitude, mMaxAmplitude};
+ for (float amplitude : increasingAmplitudeValues) {
+ auto vibratorInfo =
+ createVibratorInfo(kDefaultResonantFrequency, kDefaultQfactor, amplitude);
+ if (!isParameterValid<HapticGenerator, Range::hapticGenerator>(vibratorInfo, mDescriptor)) {
+ continue;
+ }
+ mHapticParam.push_back(createVibratorParam(vibratorInfo));
+ }
+ ASSERT_NO_FATAL_FAILURE(validateIncreasingEnergy(HapticGenerator::vibratorInfo));
+}
+
+TEST_P(HapticGeneratorDataTest, DescreasingResonantFrequencyTest) {
+ std::vector<float> descreasingResonantFrequency = {800, 600, 400, 200};
+ generateInput(mInput, kInputFrequency, kSamplingFrequency, mAudioSamples);
+ ASSERT_NO_FATAL_FAILURE(setBaseScaleParam());
+ for (float resonantFrequency : descreasingResonantFrequency) {
+ auto vibratorInfo = createVibratorInfo(resonantFrequency, kDefaultQfactor, kDefaultMaxAmp);
+ if (!isParameterValid<HapticGenerator, Range::hapticGenerator>(vibratorInfo, mDescriptor)) {
+ continue;
+ }
+ mHapticParam.push_back(createVibratorParam(vibratorInfo));
+ }
+ ASSERT_NO_FATAL_FAILURE(validateIncreasingEnergy(HapticGenerator::vibratorInfo));
+}
+
+TEST_P(HapticGeneratorDataTest, IncreasingQfactorTest) {
+ std::vector<float> increasingQfactor = {16, 24, 32, 40};
+ generateSinePeriod();
+ ASSERT_NO_FATAL_FAILURE(setBaseScaleParam());
+ for (float qFactor : increasingQfactor) {
+ auto vibratorInfo = createVibratorInfo(kDefaultResonantFrequency, qFactor, kDefaultMaxAmp);
+ if (!isParameterValid<HapticGenerator, Range::hapticGenerator>(vibratorInfo, mDescriptor)) {
+ continue;
+ }
+ mHapticParam.push_back(createVibratorParam(vibratorInfo));
+ }
+ ASSERT_NO_FATAL_FAILURE(validateIncreasingEnergy(HapticGenerator::vibratorInfo));
+}
+
+INSTANTIATE_TEST_SUITE_P(
+ DataTest, HapticGeneratorDataTest,
+ ::testing::Combine(testing::ValuesIn(EffectFactoryHelper::getAllEffectDescriptors(
+ IFactory::descriptor, getEffectTypeUuidHapticGenerator())),
+ testing::ValuesIn(kHapticOutputLayouts)),
+ [](const testing::TestParamInfo<HapticGeneratorDataTest::ParamType>& info) {
+ auto descriptor = std::get<EFFECT_INSTANCE>(info.param).second;
+ std::string layout = "0x" + std::format("{:x}", std::get<LAYOUT>(info.param));
+ std::string name = getPrefix(descriptor) + "_layout_" + layout;
+ return name;
+ });
+GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST(HapticGeneratorDataTest);
int main(int argc, char** argv) {
::testing::InitGoogleTest(&argc, argv);