media/libaudiohal/impl/EffectHalAidl.h

/*
 * Copyright (C) 2023 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 <memory>

#include <aidl/android/hardware/audio/effect/IEffect.h>
#include <aidl/android/hardware/audio/effect/IFactory.h>
#include <fmq/AidlMessageQueue.h>
#include <media/audiohal/EffectHalInterface.h>
#include <system/audio_effect.h>
#include <system/audio_effects/aidl_effects_utils.h>

#include "EffectConversionHelperAidl.h"

namespace android {
namespace effect {

class EffectHalAidl : public EffectHalInterface {
  public:

    // Set the input buffer.
    status_t setInBuffer(const sp<EffectBufferHalInterface>& buffer) override;

    // Set the output buffer.
    status_t setOutBuffer(const sp<EffectBufferHalInterface>& buffer) override;

    // Effect process function.
    status_t process() override;

    // Process reverse stream function. This function is used to pass
    // a reference stream to the effect engine.
    status_t processReverse() override;

    // Send a command and receive a response to/from effect engine.
    status_t command(uint32_t cmdCode, uint32_t cmdSize, void* pCmdData, uint32_t* replySize,
                     void* pReplyData) override;

    // Returns the effect descriptor.
    status_t getDescriptor(effect_descriptor_t *pDescriptor) override;

    // Free resources on the remote side.
    status_t close() override;

    status_t dump(int fd) override;

    const std::shared_ptr<::aidl::android::hardware::audio::effect::IEffect> getIEffect() const {
        return mEffect;
    }

    // for TIME_CHECK
    const std::string getClassName() const { return "EffectHalAidl"; }

  private:
    friend class sp<EffectHalAidl>;

    const std::shared_ptr<::aidl::android::hardware::audio::effect::IFactory> mFactory;
    const std::shared_ptr<::aidl::android::hardware::audio::effect::IEffect> mEffect;
    const int32_t mSessionId;
    const int32_t mIoId;
    const bool mIsProxyEffect;
    const int32_t mHalVersion;
    // Audio effect HAL v2+ changes flag to kEventFlagDataMqNotEmpty to avoid conflict from using
    // kEventFlagNotEmpty
    const uint32_t mEventFlagDataMqNotEmpty;
    bool mIsHapticGenerator = false;
    std::string mEffectName;

    std::unique_ptr<EffectConversionHelperAidl> mConversion;

    sp<EffectBufferHalInterface> mInBuffer, mOutBuffer;

    status_t createAidlConversion(
            std::shared_ptr<::aidl::android::hardware::audio::effect::IEffect> effect,
            int32_t sessionId, int32_t ioId,
            const ::aidl::android::hardware::audio::effect::Descriptor& desc);
    // Can not be constructed directly by clients.
    EffectHalAidl(
            const std::shared_ptr<::aidl::android::hardware::audio::effect::IFactory>& factory,
            const std::shared_ptr<::aidl::android::hardware::audio::effect::IEffect>& effect,
            int32_t sessionId, int32_t ioId,
            const ::aidl::android::hardware::audio::effect::Descriptor& desc,
            bool isProxyEffect);
    bool setEffectReverse(bool reverse);
    bool needUpdateReturnParam(uint32_t cmdCode);

    status_t maybeReopen(const std::shared_ptr<android::hardware::EventFlag>& efGroup) const;
    void writeHapticGeneratorData(size_t totalSamples, float* const outputRawBuffer,
                                  float* const fmqOutputBuffer) const;
    size_t writeToHalInputFmqAndSignal(
            const std::shared_ptr<android::hardware::EventFlag>& efGroup) const;
    status_t waitHalStatusFmq(size_t samplesWritten) const;
    status_t readFromHalOutputFmq(size_t samplesWritten) const;

    // The destructor automatically releases the effect.
    virtual ~EffectHalAidl();
};

} // namespace effect
} // namespace android