Effects.h revision 01d3acba9de861cb2b718338e787cff3566fc5ec
1/* 2** 3** Copyright 2012, The Android Open Source Project 4** 5** Licensed under the Apache License, Version 2.0 (the "License"); 6** you may not use this file except in compliance with the License. 7** You may obtain a copy of the License at 8** 9** http://www.apache.org/licenses/LICENSE-2.0 10** 11** Unless required by applicable law or agreed to in writing, software 12** distributed under the License is distributed on an "AS IS" BASIS, 13** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14** See the License for the specific language governing permissions and 15** limitations under the License. 16*/ 17 18#ifndef INCLUDING_FROM_AUDIOFLINGER_H 19 #error This header file should only be included from AudioFlinger.h 20#endif 21 22//--- Audio Effect Management 23 24// EffectModule and EffectChain classes both have their own mutex to protect 25// state changes or resource modifications. Always respect the following order 26// if multiple mutexes must be acquired to avoid cross deadlock: 27// AudioFlinger -> ThreadBase -> EffectChain -> EffectModule 28// In addition, methods that lock the AudioPolicyService mutex (getOutputForEffect(), 29// startOutput()...) should never be called with AudioFlinger or Threadbase mutex locked 30// to avoid cross deadlock with other clients calling AudioPolicyService methods that in turn 31// call AudioFlinger thus locking the same mutexes in the reverse order. 32 33// The EffectModule class is a wrapper object controlling the effect engine implementation 34// in the effect library. It prevents concurrent calls to process() and command() functions 35// from different client threads. It keeps a list of EffectHandle objects corresponding 36// to all client applications using this effect and notifies applications of effect state, 37// control or parameter changes. It manages the activation state machine to send appropriate 38// reset, enable, disable commands to effect engine and provide volume 39// ramping when effects are activated/deactivated. 40// When controlling an auxiliary effect, the EffectModule also provides an input buffer used by 41// the attached track(s) to accumulate their auxiliary channel. 42class EffectModule : public RefBase { 43public: 44 EffectModule(ThreadBase *thread, 45 const wp<AudioFlinger::EffectChain>& chain, 46 effect_descriptor_t *desc, 47 int id, 48 int sessionId); 49 virtual ~EffectModule(); 50 51 enum effect_state { 52 IDLE, 53 RESTART, 54 STARTING, 55 ACTIVE, 56 STOPPING, 57 STOPPED, 58 DESTROYED 59 }; 60 61 int id() const { return mId; } 62 void process(); 63 void updateState(); 64 status_t command(uint32_t cmdCode, 65 uint32_t cmdSize, 66 void *pCmdData, 67 uint32_t *replySize, 68 void *pReplyData); 69 70 void reset_l(); 71 status_t configure(); 72 status_t init(); 73 effect_state state() const { 74 return mState; 75 } 76 uint32_t status() { 77 return mStatus; 78 } 79 int sessionId() const { 80 return mSessionId; 81 } 82 status_t setEnabled(bool enabled); 83 status_t setEnabled_l(bool enabled); 84 bool isEnabled() const; 85 bool isProcessEnabled() const; 86 87 void setInBuffer(int16_t *buffer) { mConfig.inputCfg.buffer.s16 = buffer; } 88 int16_t *inBuffer() { return mConfig.inputCfg.buffer.s16; } 89 void setOutBuffer(int16_t *buffer) { mConfig.outputCfg.buffer.s16 = buffer; } 90 int16_t *outBuffer() { return mConfig.outputCfg.buffer.s16; } 91 void setChain(const wp<EffectChain>& chain) { mChain = chain; } 92 void setThread(const wp<ThreadBase>& thread) { mThread = thread; } 93 const wp<ThreadBase>& thread() { return mThread; } 94 95 status_t addHandle(EffectHandle *handle); 96 size_t disconnect(EffectHandle *handle, bool unpinIfLast); 97 size_t removeHandle(EffectHandle *handle); 98 99 const effect_descriptor_t& desc() const { return mDescriptor; } 100 wp<EffectChain>& chain() { return mChain; } 101 102 status_t setDevice(audio_devices_t device); 103 status_t setVolume(uint32_t *left, uint32_t *right, bool controller); 104 status_t setMode(audio_mode_t mode); 105 status_t setAudioSource(audio_source_t source); 106 status_t start(); 107 status_t stop(); 108 void setSuspended(bool suspended); 109 bool suspended() const; 110 111 EffectHandle* controlHandle_l(); 112 113 bool isPinned() const { return mPinned; } 114 void unPin() { mPinned = false; } 115 bool purgeHandles(); 116 void lock() { mLock.lock(); } 117 void unlock() { mLock.unlock(); } 118 bool isOffloadable() const 119 { return (mDescriptor.flags & EFFECT_FLAG_OFFLOAD_SUPPORTED) != 0; } 120 status_t setOffloaded(bool offloaded, audio_io_handle_t io); 121 bool isOffloaded() const; 122 123 void dump(int fd, const Vector<String16>& args); 124 125protected: 126 friend class AudioFlinger; // for mHandles 127 bool mPinned; 128 129 // Maximum time allocated to effect engines to complete the turn off sequence 130 static const uint32_t MAX_DISABLE_TIME_MS = 10000; 131 132 EffectModule(const EffectModule&); 133 EffectModule& operator = (const EffectModule&); 134 135 status_t start_l(); 136 status_t stop_l(); 137 status_t remove_effect_from_hal_l(); 138 139mutable Mutex mLock; // mutex for process, commands and handles list protection 140 wp<ThreadBase> mThread; // parent thread 141 wp<EffectChain> mChain; // parent effect chain 142 const int mId; // this instance unique ID 143 const int mSessionId; // audio session ID 144 const effect_descriptor_t mDescriptor;// effect descriptor received from effect engine 145 effect_config_t mConfig; // input and output audio configuration 146 effect_handle_t mEffectInterface; // Effect module C API 147 status_t mStatus; // initialization status 148 effect_state mState; // current activation state 149 Vector<EffectHandle *> mHandles; // list of client handles 150 // First handle in mHandles has highest priority and controls the effect module 151 uint32_t mMaxDisableWaitCnt; // maximum grace period before forcing an effect off after 152 // sending disable command. 153 uint32_t mDisableWaitCnt; // current process() calls count during disable period. 154 bool mSuspended; // effect is suspended: temporarily disabled by framework 155 bool mOffloaded; // effect is currently offloaded to the audio DSP 156}; 157 158// The EffectHandle class implements the IEffect interface. It provides resources 159// to receive parameter updates, keeps track of effect control 160// ownership and state and has a pointer to the EffectModule object it is controlling. 161// There is one EffectHandle object for each application controlling (or using) 162// an effect module. 163// The EffectHandle is obtained by calling AudioFlinger::createEffect(). 164class EffectHandle: public android::BnEffect { 165public: 166 167 EffectHandle(const sp<EffectModule>& effect, 168 const sp<AudioFlinger::Client>& client, 169 const sp<IEffectClient>& effectClient, 170 int32_t priority); 171 virtual ~EffectHandle(); 172 virtual status_t initCheck(); 173 174 // IEffect 175 virtual status_t enable(); 176 virtual status_t disable(); 177 virtual status_t command(uint32_t cmdCode, 178 uint32_t cmdSize, 179 void *pCmdData, 180 uint32_t *replySize, 181 void *pReplyData); 182 virtual void disconnect(); 183private: 184 void disconnect(bool unpinIfLast); 185public: 186 virtual sp<IMemory> getCblk() const { return mCblkMemory; } 187 virtual status_t onTransact(uint32_t code, const Parcel& data, 188 Parcel* reply, uint32_t flags); 189 190 191 // Give or take control of effect module 192 // - hasControl: true if control is given, false if removed 193 // - signal: true client app should be signaled of change, false otherwise 194 // - enabled: state of the effect when control is passed 195 void setControl(bool hasControl, bool signal, bool enabled); 196 void commandExecuted(uint32_t cmdCode, 197 uint32_t cmdSize, 198 void *pCmdData, 199 uint32_t replySize, 200 void *pReplyData); 201 void setEnabled(bool enabled); 202 bool enabled() const { return mEnabled; } 203 204 // Getters 205 int id() const { return mEffect->id(); } 206 int priority() const { return mPriority; } 207 bool hasControl() const { return mHasControl; } 208 sp<EffectModule> effect() const { return mEffect; } 209 // destroyed_l() must be called with the associated EffectModule mLock held 210 bool destroyed_l() const { return mDestroyed; } 211 212 void dumpToBuffer(char* buffer, size_t size); 213 214protected: 215 friend class AudioFlinger; // for mEffect, mHasControl, mEnabled 216 EffectHandle(const EffectHandle&); 217 EffectHandle& operator =(const EffectHandle&); 218 219 sp<EffectModule> mEffect; // pointer to controlled EffectModule 220 sp<IEffectClient> mEffectClient; // callback interface for client notifications 221 /*const*/ sp<Client> mClient; // client for shared memory allocation, see disconnect() 222 sp<IMemory> mCblkMemory; // shared memory for control block 223 effect_param_cblk_t* mCblk; // control block for deferred parameter setting via 224 // shared memory 225 uint8_t* mBuffer; // pointer to parameter area in shared memory 226 int mPriority; // client application priority to control the effect 227 bool mHasControl; // true if this handle is controlling the effect 228 bool mEnabled; // cached enable state: needed when the effect is 229 // restored after being suspended 230 bool mDestroyed; // Set to true by destructor. Access with EffectModule 231 // mLock held 232}; 233 234// the EffectChain class represents a group of effects associated to one audio session. 235// There can be any number of EffectChain objects per output mixer thread (PlaybackThread). 236// The EffecChain with session ID 0 contains global effects applied to the output mix. 237// Effects in this chain can be insert or auxiliary. Effects in other chains (attached to 238// tracks) are insert only. The EffectChain maintains an ordered list of effect module, the 239// order corresponding in the effect process order. When attached to a track (session ID != 0), 240// it also provide it's own input buffer used by the track as accumulation buffer. 241class EffectChain : public RefBase { 242public: 243 EffectChain(const wp<ThreadBase>& wThread, int sessionId); 244 EffectChain(ThreadBase *thread, int sessionId); 245 virtual ~EffectChain(); 246 247 // special key used for an entry in mSuspendedEffects keyed vector 248 // corresponding to a suspend all request. 249 static const int kKeyForSuspendAll = 0; 250 251 // minimum duration during which we force calling effect process when last track on 252 // a session is stopped or removed to allow effect tail to be rendered 253 static const int kProcessTailDurationMs = 1000; 254 255 void process_l(); 256 257 void lock() { 258 mLock.lock(); 259 } 260 void unlock() { 261 mLock.unlock(); 262 } 263 264 status_t addEffect_l(const sp<EffectModule>& handle); 265 size_t removeEffect_l(const sp<EffectModule>& handle); 266 267 int sessionId() const { return mSessionId; } 268 void setSessionId(int sessionId) { mSessionId = sessionId; } 269 270 sp<EffectModule> getEffectFromDesc_l(effect_descriptor_t *descriptor); 271 sp<EffectModule> getEffectFromId_l(int id); 272 sp<EffectModule> getEffectFromType_l(const effect_uuid_t *type); 273 bool setVolume_l(uint32_t *left, uint32_t *right); 274 void setDevice_l(audio_devices_t device); 275 void setMode_l(audio_mode_t mode); 276 void setAudioSource_l(audio_source_t source); 277 278 void setInBuffer(int16_t *buffer, bool ownsBuffer = false) { 279 mInBuffer = buffer; 280 mOwnInBuffer = ownsBuffer; 281 } 282 int16_t *inBuffer() const { 283 return mInBuffer; 284 } 285 void setOutBuffer(int16_t *buffer) { 286 mOutBuffer = buffer; 287 } 288 int16_t *outBuffer() const { 289 return mOutBuffer; 290 } 291 292 void incTrackCnt() { android_atomic_inc(&mTrackCnt); } 293 void decTrackCnt() { android_atomic_dec(&mTrackCnt); } 294 int32_t trackCnt() const { return android_atomic_acquire_load(&mTrackCnt); } 295 296 void incActiveTrackCnt() { android_atomic_inc(&mActiveTrackCnt); 297 mTailBufferCount = mMaxTailBuffers; } 298 void decActiveTrackCnt() { android_atomic_dec(&mActiveTrackCnt); } 299 int32_t activeTrackCnt() const { return android_atomic_acquire_load(&mActiveTrackCnt); } 300 301 uint32_t strategy() const { return mStrategy; } 302 void setStrategy(uint32_t strategy) 303 { mStrategy = strategy; } 304 305 // suspend effect of the given type 306 void setEffectSuspended_l(const effect_uuid_t *type, 307 bool suspend); 308 // suspend all eligible effects 309 void setEffectSuspendedAll_l(bool suspend); 310 // check if effects should be suspend or restored when a given effect is enable or disabled 311 void checkSuspendOnEffectEnabled(const sp<EffectModule>& effect, 312 bool enabled); 313 314 void clearInputBuffer(); 315 316 // At least one non offloadable effect in the chain is enabled 317 bool isNonOffloadableEnabled(); 318 319 320 void dump(int fd, const Vector<String16>& args); 321 322protected: 323 friend class AudioFlinger; // for mThread, mEffects 324 EffectChain(const EffectChain&); 325 EffectChain& operator =(const EffectChain&); 326 327 class SuspendedEffectDesc : public RefBase { 328 public: 329 SuspendedEffectDesc() : mRefCount(0) {} 330 331 int mRefCount; 332 effect_uuid_t mType; 333 wp<EffectModule> mEffect; 334 }; 335 336 // get a list of effect modules to suspend when an effect of the type 337 // passed is enabled. 338 void getSuspendEligibleEffects(Vector< sp<EffectModule> > &effects); 339 340 // get an effect module if it is currently enable 341 sp<EffectModule> getEffectIfEnabled(const effect_uuid_t *type); 342 // true if the effect whose descriptor is passed can be suspended 343 // OEMs can modify the rules implemented in this method to exclude specific effect 344 // types or implementations from the suspend/restore mechanism. 345 bool isEffectEligibleForSuspend(const effect_descriptor_t& desc); 346 347 void clearInputBuffer_l(sp<ThreadBase> thread); 348 349 wp<ThreadBase> mThread; // parent mixer thread 350 Mutex mLock; // mutex protecting effect list 351 Vector< sp<EffectModule> > mEffects; // list of effect modules 352 int mSessionId; // audio session ID 353 int16_t *mInBuffer; // chain input buffer 354 int16_t *mOutBuffer; // chain output buffer 355 356 // 'volatile' here means these are accessed with atomic operations instead of mutex 357 volatile int32_t mActiveTrackCnt; // number of active tracks connected 358 volatile int32_t mTrackCnt; // number of tracks connected 359 360 int32_t mTailBufferCount; // current effect tail buffer count 361 int32_t mMaxTailBuffers; // maximum effect tail buffers 362 bool mOwnInBuffer; // true if the chain owns its input buffer 363 int mVolumeCtrlIdx; // index of insert effect having control over volume 364 uint32_t mLeftVolume; // previous volume on left channel 365 uint32_t mRightVolume; // previous volume on right channel 366 uint32_t mNewLeftVolume; // new volume on left channel 367 uint32_t mNewRightVolume; // new volume on right channel 368 uint32_t mStrategy; // strategy for this effect chain 369 // mSuspendedEffects lists all effects currently suspended in the chain. 370 // Use effect type UUID timelow field as key. There is no real risk of identical 371 // timeLow fields among effect type UUIDs. 372 // Updated by updateSuspendedSessions_l() only. 373 KeyedVector< int, sp<SuspendedEffectDesc> > mSuspendedEffects; 374}; 375