EffectHalInterface.h revision 00260b5e6996b0a4b12f71c5b84e44adea040534
14a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov/* 24a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov * Copyright (C) 2016 The Android Open Source Project 34a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov * 44a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov * Licensed under the Apache License, Version 2.0 (the "License"); 54a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov * you may not use this file except in compliance with the License. 64a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov * You may obtain a copy of the License at 74a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov * 84a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov * http://www.apache.org/licenses/LICENSE-2.0 94a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov * 104a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov * Unless required by applicable law or agreed to in writing, software 114a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov * distributed under the License is distributed on an "AS IS" BASIS, 124a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 134a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov * See the License for the specific language governing permissions and 144a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov * limitations under the License. 154a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov */ 164a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov 174a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov#ifndef ANDROID_HARDWARE_EFFECT_HAL_INTERFACE_H 184a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov#define ANDROID_HARDWARE_EFFECT_HAL_INTERFACE_H 194a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov 2000260b5e6996b0a4b12f71c5b84e44adea040534Mikhail Naganov#include <system/audio_effect.h> 214a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov#include <utils/Errors.h> 224a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov#include <utils/RefBase.h> 234a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov 244a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganovnamespace android { 254a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov 26e4f1f63a2c54ee8687ad8cca18df0f6639ad7c81Mikhail Naganovclass EffectHalInterface : public RefBase 274a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov{ 284a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov public: 294a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov // Effect process function. Takes input samples as specified 304a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov // in input buffer descriptor and output processed samples as specified 314a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov // in output buffer descriptor. 324a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov virtual status_t process(audio_buffer_t *inBuffer, audio_buffer_t *outBuffer) = 0; 334a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov 344a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov // Process reverse stream function. This function is used to pass 354a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov // a reference stream to the effect engine. 364a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov virtual status_t processReverse(audio_buffer_t *inBuffer, audio_buffer_t *outBuffer) = 0; 374a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov 384a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov // Send a command and receive a response to/from effect engine. 394a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov virtual status_t command(uint32_t cmdCode, uint32_t cmdSize, void *pCmdData, 404a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov uint32_t *replySize, void *pReplyData) = 0; 414a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov 424a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov // Returns the effect descriptor. 434a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov virtual status_t getDescriptor(effect_descriptor_t *pDescriptor) = 0; 444a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov 454a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov protected: 464a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov // Subclasses can not be constructed directly by clients. 474a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov EffectHalInterface() {} 481dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 491dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // The destructor automatically releases the effect. 501dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual ~EffectHalInterface() {} 514a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov}; 524a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov 534a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov} // namespace android 544a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov 554a3d5c23f79189eb7ab9f31c440c7da5b15947a2Mikhail Naganov#endif // ANDROID_HARDWARE_EFFECT_HAL_INTERFACE_H 56