Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit bd862b82 authored by Shunkai Yao's avatar Shunkai Yao
Browse files

Effect AIDL: Add AEC, AGC and NS AIDL and placeholder implmentation 

Bug: 238913361
Test: atest VtsHalAECTargetTest
Test: atest VtsHalAGCTargetTest
Test: atest VtsHalNSTargetTest

Change-Id: I13de3fb554a3161d993fbe69942019546c7a96a6
parent 0b58d826

audio/aidl/default/acousticEchoCanceler/AcousticEchoCancelerSw.cpp

0 → 100644
+194 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2022 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



#include <algorithm>

#include <cstddef>

#include <memory>

#define LOG_TAG "AHAL_AcousticEchoCancelerSw"

#include <Utils.h>

#include <unordered_set>



#include <android-base/logging.h>

#include <fmq/AidlMessageQueue.h>



#include "AcousticEchoCancelerSw.h"



using aidl::android::hardware::audio::effect::AcousticEchoCancelerSw;

using aidl::android::hardware::audio::effect::Descriptor;

using aidl::android::hardware::audio::effect::IEffect;

using aidl::android::hardware::audio::effect::kAcousticEchoCancelerSwImplUUID;

using aidl::android::media::audio::common::AudioUuid;



extern "C" binder_exception_t createEffect(const AudioUuid* in_impl_uuid,

                                           std::shared_ptr<IEffect>* instanceSpp) {

    if (!in_impl_uuid || *in_impl_uuid != kAcousticEchoCancelerSwImplUUID) {

        LOG(ERROR) << __func__ << "uuid not supported";

        return EX_ILLEGAL_ARGUMENT;

    }

    if (instanceSpp) {

        *instanceSpp = ndk::SharedRefBase::make<AcousticEchoCancelerSw>();

        LOG(DEBUG) << __func__ << " instance " << instanceSpp->get() << " created";

        return EX_NONE;

    } else {

        LOG(ERROR) << __func__ << " invalid input parameter!";

        return EX_ILLEGAL_ARGUMENT;

    }

}



extern "C" binder_exception_t queryEffect(const AudioUuid* in_impl_uuid, Descriptor* _aidl_return) {

    if (!in_impl_uuid || *in_impl_uuid != kAcousticEchoCancelerSwImplUUID) {

        LOG(ERROR) << __func__ << "uuid not supported";

        return EX_ILLEGAL_ARGUMENT;

    }

    *_aidl_return = AcousticEchoCancelerSw::kDescriptor;

    LOG(ERROR) << __func__ << "xxx " << _aidl_return->toString();

    return EX_NONE;

}



namespace aidl::android::hardware::audio::effect {



const std::string AcousticEchoCancelerSw::kEffectName = "AcousticEchoCancelerSw";

const AcousticEchoCanceler::Capability AcousticEchoCancelerSw::kCapability = {

        .maxEchoDelayUs = 500, .supportMobileMode = false};

const Descriptor AcousticEchoCancelerSw::kDescriptor = {

        .common = {.id = {.type = kAcousticEchoCancelerTypeUUID,

                          .uuid = kAcousticEchoCancelerSwImplUUID,

                          .proxy = std::nullopt},

                   .flags = {.type = Flags::Type::INSERT,

                             .insert = Flags::Insert::FIRST,

                             .volume = Flags::Volume::CTRL},

                   .name = AcousticEchoCancelerSw::kEffectName,

                   .implementor = "The Android Open Source Project"},

        .capability = Capability::make<Capability::acousticEchoCanceler>(

                AcousticEchoCancelerSw::kCapability)};



ndk::ScopedAStatus AcousticEchoCancelerSw::getDescriptor(Descriptor* _aidl_return) {

    LOG(DEBUG) << __func__ << kDescriptor.toString();

    *_aidl_return = kDescriptor;

    return ndk::ScopedAStatus::ok();

}



ndk::ScopedAStatus AcousticEchoCancelerSw::setParameterSpecific(

        const Parameter::Specific& specific) {

    RETURN_IF(Parameter::Specific::acousticEchoCanceler != specific.getTag(), EX_ILLEGAL_ARGUMENT,

              "EffectNotSupported");

    RETURN_IF(!mContext, EX_NULL_POINTER, "nullContext");



    auto& param = specific.get<Parameter::Specific::acousticEchoCanceler>();

    auto tag = param.getTag();



    switch (tag) {

        case AcousticEchoCanceler::echoDelayUs: {

            RETURN_IF(mContext->setEchoDelay(param.get<AcousticEchoCanceler::echoDelayUs>()) !=

                              RetCode::SUCCESS,

                      EX_ILLEGAL_ARGUMENT, "echoDelayNotSupported");

            return ndk::ScopedAStatus::ok();

        }

        case AcousticEchoCanceler::mobileMode: {

            RETURN_IF(true == param.get<AcousticEchoCanceler::mobileMode>(), EX_ILLEGAL_ARGUMENT,

                      "SettingmobileModeSupported");

            return ndk::ScopedAStatus::ok();

        }

        default: {

            LOG(ERROR) << __func__ << " unsupported tag: " << toString(tag);

            return ndk::ScopedAStatus::fromExceptionCodeWithMessage(

                    EX_ILLEGAL_ARGUMENT, "AcousticEchoCancelerTagNotSupported");

        }

    }

}



ndk::ScopedAStatus AcousticEchoCancelerSw::getParameterSpecific(const Parameter::Id& id,

                                                                Parameter::Specific* specific) {

    auto tag = id.getTag();

    RETURN_IF(Parameter::Id::acousticEchoCancelerTag != tag, EX_ILLEGAL_ARGUMENT, "wrongIdTag");

    auto specificId = id.get<Parameter::Id::acousticEchoCancelerTag>();

    auto specificIdTag = specificId.getTag();

    switch (specificIdTag) {

        case AcousticEchoCanceler::Id::commonTag:

            return getParameterAcousticEchoCanceler(

                    specificId.get<AcousticEchoCanceler::Id::commonTag>(), specific);

        default:

            LOG(ERROR) << __func__ << " unsupported tag: " << toString(tag);

            return ndk::ScopedAStatus::fromExceptionCodeWithMessage(

                    EX_ILLEGAL_ARGUMENT, "AcousticEchoCancelerTagNotSupported");

    }

}



ndk::ScopedAStatus AcousticEchoCancelerSw::getParameterAcousticEchoCanceler(

        const AcousticEchoCanceler::Tag& tag, Parameter::Specific* specific) {

    RETURN_IF(!mContext, EX_NULL_POINTER, "nullContext");

    AcousticEchoCanceler param;

    switch (tag) {

        case AcousticEchoCanceler::echoDelayUs: {

            param.set<AcousticEchoCanceler::echoDelayUs>(mContext->getEchoDelay());

            break;

        }

        case AcousticEchoCanceler::mobileMode: {

            param.set<AcousticEchoCanceler::mobileMode>(false);

            break;

        }

        default: {

            LOG(ERROR) << __func__ << " unsupported tag: " << toString(tag);

            return ndk::ScopedAStatus::fromExceptionCodeWithMessage(

                    EX_ILLEGAL_ARGUMENT, "AcousticEchoCancelerTagNotSupported");

        }

    }



    specific->set<Parameter::Specific::acousticEchoCanceler>(param);

    return ndk::ScopedAStatus::ok();

}



std::shared_ptr<EffectContext> AcousticEchoCancelerSw::createContext(

        const Parameter::Common& common) {

    if (mContext) {

        LOG(DEBUG) << __func__ << " context already exist";

    } else {

        mContext = std::make_shared<AcousticEchoCancelerSwContext>(1 /* statusFmqDepth */, common);

    }

    return mContext;

}



std::shared_ptr<EffectContext> AcousticEchoCancelerSw::getContext() {

    return mContext;

}



RetCode AcousticEchoCancelerSw::releaseContext() {

    if (mContext) {

        mContext.reset();

    }

    return RetCode::SUCCESS;

}



// Processing method running in EffectWorker thread.

IEffect::Status AcousticEchoCancelerSw::effectProcessImpl(float* in, float* out, int samples) {

    // TODO: get data buffer and process.

    LOG(DEBUG) << __func__ << " in " << in << " out " << out << " samples " << samples;

    for (int i = 0; i < samples; i++) {

        *out++ = *in++;

    }

    return {STATUS_OK, samples, samples};

}



RetCode AcousticEchoCancelerSwContext::setEchoDelay(int echoDelayUs) {

    if (echoDelayUs < 0 || echoDelayUs > AcousticEchoCancelerSw::kCapability.maxEchoDelayUs) {

        LOG(DEBUG) << __func__ << " illegal delay " << echoDelayUs;

        return RetCode::ERROR_ILLEGAL_PARAMETER;

    }

    mEchoDelayUs = echoDelayUs;

    return RetCode::SUCCESS;

}



}  // namespace aidl::android::hardware::audio::effect

audio/aidl/default/acousticEchoCanceler/AcousticEchoCancelerSw.h

0 → 100644
+72 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2022 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



#pragma once



#include <aidl/android/hardware/audio/effect/BnEffect.h>

#include <fmq/AidlMessageQueue.h>

#include <cstdlib>

#include <memory>



#include "effect-impl/EffectImpl.h"

#include "effect-impl/EffectUUID.h"



namespace aidl::android::hardware::audio::effect {



class AcousticEchoCancelerSwContext final : public EffectContext {

  public:

    AcousticEchoCancelerSwContext(int statusDepth, const Parameter::Common& common)

        : EffectContext(statusDepth, common) {

        LOG(DEBUG) << __func__;

    }



    RetCode setEchoDelay(int echoDelayUs);

    int getEchoDelay() const { return mEchoDelayUs; }



  private:

    int mEchoDelayUs;

};



class AcousticEchoCancelerSw final : public EffectImpl {

  public:

    static const std::string kEffectName;

    static const bool kStrengthSupported;

    static const AcousticEchoCanceler::Capability kCapability;

    static const Descriptor kDescriptor;

    AcousticEchoCancelerSw() { LOG(DEBUG) << __func__; }

    ~AcousticEchoCancelerSw() {

        cleanUp();

        LOG(DEBUG) << __func__;

    }



    ndk::ScopedAStatus getDescriptor(Descriptor* _aidl_return) override;

    ndk::ScopedAStatus setParameterSpecific(const Parameter::Specific& specific) override;

    ndk::ScopedAStatus getParameterSpecific(const Parameter::Id& id,

                                            Parameter::Specific* specific) override;



    std::shared_ptr<EffectContext> createContext(const Parameter::Common& common) override;

    std::shared_ptr<EffectContext> getContext() override;

    RetCode releaseContext() override;



    std::string getEffectName() override { return kEffectName; };

    IEffect::Status effectProcessImpl(float* in, float* out, int samples) override;



  private:

    std::shared_ptr<AcousticEchoCancelerSwContext> mContext;

    ndk::ScopedAStatus getParameterAcousticEchoCanceler(const AcousticEchoCanceler::Tag& tag,

                                                        Parameter::Specific* specific);

};

}  // namespace aidl::android::hardware::audio::effect

audio/aidl/default/acousticEchoCanceler/Android.bp

0 → 100644
+40 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2022 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package {

    // See: http://go/android-license-faq

    // A large-scale-change added 'default_applicable_licenses' to import

    // all of the 'license_kinds' from "hardware_interfaces_license"

    // to get the below license kinds:

    //   SPDX-license-identifier-Apache-2.0

    default_applicable_licenses: ["hardware_interfaces_license"],

}



cc_library_shared {

    name: "libaecsw",

    defaults: [

        "aidlaudioeffectservice_defaults",

        "latest_android_media_audio_common_types_ndk_shared",

        "latest_android_hardware_audio_effect_ndk_shared",

    ],

    srcs: [

        "AcousticEchoCancelerSw.cpp",

        ":effectCommonFile",

    ],

    visibility: [

        "//hardware/interfaces/audio/aidl/default",

    ],

}

audio/aidl/default/audio_effects_config.xml

+6 −0
Original line number Diff line number Diff line
@@ -28,6 +28,8 @@ 
         name of a library .so file on the target device.

    -->

    <libraries>

        <library name="aecsw" path="libaecsw.so"/>

        <library name="agcsw" path="libagcsw.so"/>

        <library name="bassboostsw" path="libbassboostsw.so"/>

        <library name="bundle" path="libbundleaidl.so"/>

        <library name="downmix" path="libdownmixaidl.so"/>
@@ -35,6 +37,7 @@ 
        <library name="equalizersw" path="libequalizersw.so"/>

        <library name="haptic_generatorsw" path="libhapticgeneratorsw.so"/>

        <library name="loudness_enhancer" path="libloudnessenhanceraidl.so"/>

        <library name="nssw" path="libnssw.so"/>

        <library name="env_reverbsw" path="libenvreverbsw.so"/>

        <library name="preset_reverbsw" path="libpresetreverbsw.so"/>

        <library name="virtualizersw" path="libvirtualizersw.so"/>
@@ -62,6 +65,8 @@ 
    -->



    <effects>

        <effect name="acoustic_echo_canceler" library="aecsw" uuid="bb392ec0-8d4d-11e0-a896-0002a5d5c51b"/>

        <effect name="automatic_gain_control" library="agcsw" uuid="89f38e65-d4d2-4d64-ad0e-2b3e799ea886"/>

        <effectProxy name="bassboost" uuid="14804144-a5ee-4d24-aa88-0002a5d5c51b">

            <libsw library="bassboostsw" uuid="fa8181f2-588b-11ed-9b6a-0242ac120002"/>

            <libsw library="bundle" uuid="8631f300-72e2-11df-b57e-0002a5d5c51b"/>
@@ -71,6 +76,7 @@ 
        <effect name="haptic_generator" library="haptic_generatorsw" uuid="fa819110-588b-11ed-9b6a-0242ac120002"/>

        <effect name="loudness_enhancer" library="loudness_enhancer" uuid="fa415329-2034-4bea-b5dc-5b381c8d1e2c"/>

        <effect name="env_reverb" library="env_reverbsw" uuid="fa819886-588b-11ed-9b6a-0242ac120002"/>

        <effect name="noise_suppression" library="nssw" uuid="c06c8400-8e06-11e0-9cb6-0002a5d5c51b"/>

        <effect name="preset_reverb" library="preset_reverbsw" uuid="fa8199c6-588b-11ed-9b6a-0242ac120002"/>

        <effect name="virtualizer" library="virtualizersw" uuid="fa819d86-588b-11ed-9b6a-0242ac120002"/>

        <effect name="visualizer" library="visualizersw" uuid="fa81a0f6-588b-11ed-9b6a-0242ac120002"/>

audio/aidl/default/automaticGainControl/Android.bp

0 → 100644
+40 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2022 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package {

    // See: http://go/android-license-faq

    // A large-scale-change added 'default_applicable_licenses' to import

    // all of the 'license_kinds' from "hardware_interfaces_license"

    // to get the below license kinds:

    //   SPDX-license-identifier-Apache-2.0

    default_applicable_licenses: ["hardware_interfaces_license"],

}



cc_library_shared {

    name: "libagcsw",

    defaults: [

        "aidlaudioeffectservice_defaults",

        "latest_android_media_audio_common_types_ndk_shared",

        "latest_android_hardware_audio_effect_ndk_shared",

    ],

    srcs: [

        "AutomaticGainControlSw.cpp",

        ":effectCommonFile",

    ],

    visibility: [

        "//hardware/interfaces/audio/aidl/default",

    ],

}