1 /*
2  * Copyright (C) 2016 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 #ifndef ANDROID_HARDWARE_EFFECT_HAL_HIDL_H
18 #define ANDROID_HARDWARE_EFFECT_HAL_HIDL_H
19 
20 #include PATH(android/hardware/audio/effect/FILE_VERSION/IEffect.h)
21 #include <media/audiohal/EffectHalInterface.h>
22 #include <fmq/EventFlag.h>
23 #include <fmq/MessageQueue.h>
24 #include <system/audio_effect.h>
25 
26 using ::android::hardware::EventFlag;
27 using ::android::hardware::MessageQueue;
28 
29 namespace android {
30 namespace effect {
31 namespace CPP_VERSION {
32 
33 using namespace ::android::hardware::audio::effect::CPP_VERSION;
34 
35 class EffectHalHidl : public EffectHalInterface
36 {
37   public:
38     // Set the input buffer.
39     virtual status_t setInBuffer(const sp<EffectBufferHalInterface>& buffer);
40 
41     // Set the output buffer.
42     virtual status_t setOutBuffer(const sp<EffectBufferHalInterface>& buffer);
43 
44     // Effect process function.
45     virtual status_t process();
46 
47     // Process reverse stream function. This function is used to pass
48     // a reference stream to the effect engine.
49     virtual status_t processReverse();
50 
51     // Send a command and receive a response to/from effect engine.
52     virtual status_t command(uint32_t cmdCode, uint32_t cmdSize, void *pCmdData,
53             uint32_t *replySize, void *pReplyData);
54 
55     // Returns the effect descriptor.
56     virtual status_t getDescriptor(effect_descriptor_t *pDescriptor);
57 
58     // Free resources on the remote side.
59     virtual status_t close();
60 
61     // Whether it's a local implementation.
isLocal()62     virtual bool isLocal() const { return false; }
63 
64     virtual status_t dump(int fd);
65 
effectId()66     uint64_t effectId() const { return mEffectId; }
67 
68   private:
69     friend class EffectsFactoryHalHidl;
70     typedef MessageQueue<Result, hardware::kSynchronizedReadWrite> StatusMQ;
71 
72     sp<IEffect> mEffect;
73     const uint64_t mEffectId;
74     sp<EffectBufferHalInterface> mInBuffer;
75     sp<EffectBufferHalInterface> mOutBuffer;
76     bool mBuffersChanged;
77     std::unique_ptr<StatusMQ> mStatusMQ;
78     EventFlag* mEfGroup;
79     bool mIsInput = false;
80 
81     static status_t analyzeResult(const Result& result);
82 
83     // Can not be constructed directly by clients.
84     EffectHalHidl(const sp<IEffect>& effect, uint64_t effectId);
85 
86     // The destructor automatically releases the effect.
87     virtual ~EffectHalHidl();
88 
89     status_t getConfigImpl(uint32_t cmdCode, uint32_t *replySize, void *pReplyData);
90     status_t prepareForProcessing();
91     bool needToResetBuffers();
92     status_t processImpl(uint32_t mqFlag);
93     status_t setConfigImpl(
94             uint32_t cmdCode, uint32_t cmdSize, void *pCmdData,
95             uint32_t *replySize, void *pReplyData);
96     status_t setProcessBuffers();
97 };
98 
99 } // namespace CPP_VERSION
100 } // namespace effect
101 } // namespace android
102 
103 #endif // ANDROID_HARDWARE_EFFECT_HAL_HIDL_H
104