Home | History | Annotate | Download | only in libaudiohal
      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_LOCAL_H
     18 #define ANDROID_HARDWARE_EFFECT_HAL_LOCAL_H
     19 
     20 #include <hardware/audio_effect.h>
     21 #include <media/audiohal/EffectHalInterface.h>
     22 
     23 namespace android {
     24 
     25 class EffectHalLocal : public EffectHalInterface
     26 {
     27   public:
     28     // Set the input buffer.
     29     virtual status_t setInBuffer(const sp<EffectBufferHalInterface>& buffer);
     30 
     31     // Set the output buffer.
     32     virtual status_t setOutBuffer(const sp<EffectBufferHalInterface>& buffer);
     33 
     34     // Effect process function.
     35     virtual status_t process();
     36 
     37     // Process reverse stream function. This function is used to pass
     38     // a reference stream to the effect engine.
     39     virtual status_t processReverse();
     40 
     41     // Send a command and receive a response to/from effect engine.
     42     virtual status_t command(uint32_t cmdCode, uint32_t cmdSize, void *pCmdData,
     43             uint32_t *replySize, void *pReplyData);
     44 
     45     // Returns the effect descriptor.
     46     virtual status_t getDescriptor(effect_descriptor_t *pDescriptor);
     47 
     48     // Free resources on the remote side.
     49     virtual status_t close();
     50 
     51     // Whether it's a local implementation.
     52     virtual bool isLocal() const { return true; }
     53 
     54     effect_handle_t handle() const { return mHandle; }
     55 
     56   private:
     57     effect_handle_t mHandle;
     58     sp<EffectBufferHalInterface> mInBuffer;
     59     sp<EffectBufferHalInterface> mOutBuffer;
     60 
     61     friend class EffectsFactoryHalLocal;
     62 
     63     // Can not be constructed directly by clients.
     64     explicit EffectHalLocal(effect_handle_t handle);
     65 
     66     // The destructor automatically releases the effect.
     67     virtual ~EffectHalLocal();
     68 };
     69 
     70 } // namespace android
     71 
     72 #endif // ANDROID_HARDWARE_EFFECT_HAL_LOCAL_H
     73