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