AudioFlinger.h revision 6637baae4244aec731c4014da72418d330636ae1
1/* //device/include/server/AudioFlinger/AudioFlinger.h 2** 3** Copyright 2007, 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 ANDROID_AUDIO_FLINGER_H 19#define ANDROID_AUDIO_FLINGER_H 20 21#include <stdint.h> 22#include <sys/types.h> 23#include <limits.h> 24 25#include <media/IAudioFlinger.h> 26#include <media/IAudioFlingerClient.h> 27#include <media/IAudioTrack.h> 28#include <media/IAudioRecord.h> 29#include <media/AudioSystem.h> 30 31#include <utils/Atomic.h> 32#include <utils/Errors.h> 33#include <utils/threads.h> 34#include <utils/SortedVector.h> 35#include <utils/TypeHelpers.h> 36#include <utils/Vector.h> 37 38#include <binder/BinderService.h> 39#include <binder/MemoryDealer.h> 40 41#include <system/audio.h> 42#include <hardware/audio.h> 43 44#include "AudioBufferProvider.h" 45 46#include <powermanager/IPowerManager.h> 47 48namespace android { 49 50class audio_track_cblk_t; 51class effect_param_cblk_t; 52class AudioMixer; 53class AudioBuffer; 54class AudioResampler; 55 56// ---------------------------------------------------------------------------- 57 58static const nsecs_t kStandbyTimeInNsecs = seconds(3); 59 60class AudioFlinger : 61 public BinderService<AudioFlinger>, 62 public BnAudioFlinger 63{ 64 friend class BinderService<AudioFlinger>; 65public: 66 static const char* getServiceName() { return "media.audio_flinger"; } 67 68 virtual status_t dump(int fd, const Vector<String16>& args); 69 70 // IAudioFlinger interface 71 virtual sp<IAudioTrack> createTrack( 72 pid_t pid, 73 audio_stream_type_t streamType, 74 uint32_t sampleRate, 75 audio_format_t format, 76 uint32_t channelMask, 77 int frameCount, 78 uint32_t flags, 79 const sp<IMemory>& sharedBuffer, 80 audio_io_handle_t output, 81 int *sessionId, 82 status_t *status); 83 84 virtual uint32_t sampleRate(audio_io_handle_t output) const; 85 virtual int channelCount(audio_io_handle_t output) const; 86 virtual audio_format_t format(audio_io_handle_t output) const; 87 virtual size_t frameCount(audio_io_handle_t output) const; 88 virtual uint32_t latency(audio_io_handle_t output) const; 89 90 virtual status_t setMasterVolume(float value); 91 virtual status_t setMasterMute(bool muted); 92 93 virtual float masterVolume() const; 94 virtual bool masterMute() const; 95 96 virtual status_t setStreamVolume(audio_stream_type_t stream, float value, 97 audio_io_handle_t output); 98 virtual status_t setStreamMute(audio_stream_type_t stream, bool muted); 99 100 virtual float streamVolume(audio_stream_type_t stream, 101 audio_io_handle_t output) const; 102 virtual bool streamMute(audio_stream_type_t stream) const; 103 104 virtual status_t setMode(audio_mode_t mode); 105 106 virtual status_t setMicMute(bool state); 107 virtual bool getMicMute() const; 108 109 virtual status_t setParameters(audio_io_handle_t ioHandle, const String8& keyValuePairs); 110 virtual String8 getParameters(audio_io_handle_t ioHandle, const String8& keys) const; 111 112 virtual void registerClient(const sp<IAudioFlingerClient>& client); 113 114 virtual size_t getInputBufferSize(uint32_t sampleRate, audio_format_t format, int channelCount) const; 115 virtual unsigned int getInputFramesLost(audio_io_handle_t ioHandle) const; 116 117 virtual audio_io_handle_t openOutput(uint32_t *pDevices, 118 uint32_t *pSamplingRate, 119 audio_format_t *pFormat, 120 uint32_t *pChannels, 121 uint32_t *pLatencyMs, 122 uint32_t flags); 123 124 virtual audio_io_handle_t openDuplicateOutput(audio_io_handle_t output1, 125 audio_io_handle_t output2); 126 127 virtual status_t closeOutput(audio_io_handle_t output); 128 129 virtual status_t suspendOutput(audio_io_handle_t output); 130 131 virtual status_t restoreOutput(audio_io_handle_t output); 132 133 virtual audio_io_handle_t openInput(uint32_t *pDevices, 134 uint32_t *pSamplingRate, 135 audio_format_t *pFormat, 136 uint32_t *pChannels, 137 audio_in_acoustics_t acoustics); 138 139 virtual status_t closeInput(audio_io_handle_t input); 140 141 virtual status_t setStreamOutput(audio_stream_type_t stream, audio_io_handle_t output); 142 143 virtual status_t setVoiceVolume(float volume); 144 145 virtual status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames, 146 audio_io_handle_t output) const; 147 148 virtual int newAudioSessionId(); 149 150 virtual void acquireAudioSessionId(int audioSession); 151 152 virtual void releaseAudioSessionId(int audioSession); 153 154 virtual status_t queryNumberEffects(uint32_t *numEffects) const; 155 156 virtual status_t queryEffect(uint32_t index, effect_descriptor_t *descriptor) const; 157 158 virtual status_t getEffectDescriptor(const effect_uuid_t *pUuid, 159 effect_descriptor_t *descriptor) const; 160 161 virtual sp<IEffect> createEffect(pid_t pid, 162 effect_descriptor_t *pDesc, 163 const sp<IEffectClient>& effectClient, 164 int32_t priority, 165 audio_io_handle_t io, 166 int sessionId, 167 status_t *status, 168 int *id, 169 int *enabled); 170 171 virtual status_t moveEffects(int sessionId, audio_io_handle_t srcOutput, 172 audio_io_handle_t dstOutput); 173 174 enum hardware_call_state { 175 AUDIO_HW_IDLE = 0, 176 AUDIO_HW_INIT, 177 AUDIO_HW_OUTPUT_OPEN, 178 AUDIO_HW_OUTPUT_CLOSE, 179 AUDIO_HW_INPUT_OPEN, 180 AUDIO_HW_INPUT_CLOSE, 181 AUDIO_HW_STANDBY, 182 AUDIO_HW_SET_MASTER_VOLUME, 183 AUDIO_HW_GET_ROUTING, 184 AUDIO_HW_SET_ROUTING, 185 AUDIO_HW_GET_MODE, 186 AUDIO_HW_SET_MODE, 187 AUDIO_HW_GET_MIC_MUTE, 188 AUDIO_HW_SET_MIC_MUTE, 189 AUDIO_SET_VOICE_VOLUME, 190 AUDIO_SET_PARAMETER, 191 }; 192 193 // record interface 194 virtual sp<IAudioRecord> openRecord( 195 pid_t pid, 196 audio_io_handle_t input, 197 uint32_t sampleRate, 198 audio_format_t format, 199 uint32_t channelMask, 200 int frameCount, 201 uint32_t flags, 202 int *sessionId, 203 status_t *status); 204 205 virtual status_t onTransact( 206 uint32_t code, 207 const Parcel& data, 208 Parcel* reply, 209 uint32_t flags); 210 211 audio_mode_t getMode() const { return mMode; } 212 213 bool btNrecIsOff() const { return mBtNrecIsOff; } 214 215private: 216 217 AudioFlinger(); 218 virtual ~AudioFlinger(); 219 220 status_t initCheck() const; 221 virtual void onFirstRef(); 222 audio_hw_device_t* findSuitableHwDev_l(uint32_t devices); 223 void purgeStaleEffects_l(); 224 225 // Internal dump utilites. 226 status_t dumpPermissionDenial(int fd, const Vector<String16>& args); 227 status_t dumpClients(int fd, const Vector<String16>& args); 228 status_t dumpInternals(int fd, const Vector<String16>& args); 229 230 // --- Client --- 231 class Client : public RefBase { 232 public: 233 Client(const sp<AudioFlinger>& audioFlinger, pid_t pid); 234 virtual ~Client(); 235 sp<MemoryDealer> heap() const; 236 pid_t pid() const { return mPid; } 237 sp<AudioFlinger> audioFlinger() const { return mAudioFlinger; } 238 239 private: 240 Client(const Client&); 241 Client& operator = (const Client&); 242 const sp<AudioFlinger> mAudioFlinger; 243 const sp<MemoryDealer> mMemoryDealer; 244 const pid_t mPid; 245 }; 246 247 // --- Notification Client --- 248 class NotificationClient : public IBinder::DeathRecipient { 249 public: 250 NotificationClient(const sp<AudioFlinger>& audioFlinger, 251 const sp<IAudioFlingerClient>& client, 252 pid_t pid); 253 virtual ~NotificationClient(); 254 255 sp<IAudioFlingerClient> audioFlingerClient() const { return mAudioFlingerClient; } 256 257 // IBinder::DeathRecipient 258 virtual void binderDied(const wp<IBinder>& who); 259 260 private: 261 NotificationClient(const NotificationClient&); 262 NotificationClient& operator = (const NotificationClient&); 263 264 const sp<AudioFlinger> mAudioFlinger; 265 const pid_t mPid; 266 const sp<IAudioFlingerClient> mAudioFlingerClient; 267 }; 268 269 class TrackHandle; 270 class RecordHandle; 271 class RecordThread; 272 class PlaybackThread; 273 class MixerThread; 274 class DirectOutputThread; 275 class DuplicatingThread; 276 class Track; 277 class RecordTrack; 278 class EffectModule; 279 class EffectHandle; 280 class EffectChain; 281 struct AudioStreamOut; 282 struct AudioStreamIn; 283 284 class ThreadBase : public Thread { 285 public: 286 287 enum type_t { 288 MIXER, // Thread class is MixerThread 289 DIRECT, // Thread class is DirectOutputThread 290 DUPLICATING, // Thread class is DuplicatingThread 291 RECORD // Thread class is RecordThread 292 }; 293 294 ThreadBase (const sp<AudioFlinger>& audioFlinger, audio_io_handle_t id, uint32_t device, type_t type); 295 virtual ~ThreadBase(); 296 297 status_t dumpBase(int fd, const Vector<String16>& args); 298 status_t dumpEffectChains(int fd, const Vector<String16>& args); 299 300 void clearPowerManager(); 301 302 // base for record and playback 303 class TrackBase : public AudioBufferProvider, public RefBase { 304 305 public: 306 enum track_state { 307 IDLE, 308 TERMINATED, 309 STOPPED, 310 RESUMING, 311 ACTIVE, 312 PAUSING, 313 PAUSED 314 }; 315 316 enum track_flags { 317 STEPSERVER_FAILED = 0x01, // StepServer could not acquire cblk->lock mutex 318 SYSTEM_FLAGS_MASK = 0x0000ffffUL, 319 // The upper 16 bits are used for track-specific flags. 320 }; 321 322 TrackBase(const wp<ThreadBase>& thread, 323 const sp<Client>& client, 324 uint32_t sampleRate, 325 audio_format_t format, 326 uint32_t channelMask, 327 int frameCount, 328 uint32_t flags, 329 const sp<IMemory>& sharedBuffer, 330 int sessionId); 331 virtual ~TrackBase(); 332 333 virtual status_t start() = 0; 334 virtual void stop() = 0; 335 sp<IMemory> getCblk() const { return mCblkMemory; } 336 audio_track_cblk_t* cblk() const { return mCblk; } 337 int sessionId() const { return mSessionId; } 338 339 protected: 340 friend class ThreadBase; 341 friend class RecordHandle; 342 friend class PlaybackThread; 343 friend class RecordThread; 344 friend class MixerThread; 345 friend class DirectOutputThread; 346 347 TrackBase(const TrackBase&); 348 TrackBase& operator = (const TrackBase&); 349 350 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer) = 0; 351 virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer); 352 353 audio_format_t format() const { 354 return mFormat; 355 } 356 357 int channelCount() const { return mChannelCount; } 358 359 uint32_t channelMask() const { return mChannelMask; } 360 361 int sampleRate() const; // FIXME inline after cblk sr moved 362 363 void* getBuffer(uint32_t offset, uint32_t frames) const; 364 365 bool isStopped() const { 366 return mState == STOPPED; 367 } 368 369 bool isTerminated() const { 370 return mState == TERMINATED; 371 } 372 373 bool step(); 374 void reset(); 375 376 const wp<ThreadBase> mThread; 377 /*const*/ sp<Client> mClient; // see explanation at ~TrackBase() why not const 378 sp<IMemory> mCblkMemory; 379 audio_track_cblk_t* mCblk; 380 void* mBuffer; 381 void* mBufferEnd; 382 uint32_t mFrameCount; 383 // we don't really need a lock for these 384 track_state mState; 385 const audio_format_t mFormat; 386 uint32_t mFlags; 387 const int mSessionId; 388 uint8_t mChannelCount; 389 uint32_t mChannelMask; 390 }; 391 392 class ConfigEvent { 393 public: 394 ConfigEvent() : mEvent(0), mParam(0) {} 395 396 int mEvent; 397 int mParam; 398 }; 399 400 class PMDeathRecipient : public IBinder::DeathRecipient { 401 public: 402 PMDeathRecipient(const wp<ThreadBase>& thread) : mThread(thread) {} 403 virtual ~PMDeathRecipient() {} 404 405 // IBinder::DeathRecipient 406 virtual void binderDied(const wp<IBinder>& who); 407 408 private: 409 PMDeathRecipient(const PMDeathRecipient&); 410 PMDeathRecipient& operator = (const PMDeathRecipient&); 411 412 wp<ThreadBase> mThread; 413 }; 414 415 virtual status_t initCheck() const = 0; 416 type_t type() const { return mType; } 417 uint32_t sampleRate() const { return mSampleRate; } 418 int channelCount() const { return mChannelCount; } 419 audio_format_t format() const { return mFormat; } 420 size_t frameCount() const { return mFrameCount; } 421 void wakeUp() { mWaitWorkCV.broadcast(); } 422 void exit(); 423 virtual bool checkForNewParameters_l() = 0; 424 virtual status_t setParameters(const String8& keyValuePairs); 425 virtual String8 getParameters(const String8& keys) = 0; 426 virtual void audioConfigChanged_l(int event, int param = 0) = 0; 427 void sendConfigEvent(int event, int param = 0); 428 void sendConfigEvent_l(int event, int param = 0); 429 void processConfigEvents(); 430 audio_io_handle_t id() const { return mId;} 431 bool standby() { return mStandby; } 432 uint32_t device() { return mDevice; } 433 virtual audio_stream_t* stream() = 0; 434 435 sp<EffectHandle> createEffect_l( 436 const sp<AudioFlinger::Client>& client, 437 const sp<IEffectClient>& effectClient, 438 int32_t priority, 439 int sessionId, 440 effect_descriptor_t *desc, 441 int *enabled, 442 status_t *status); 443 void disconnectEffect(const sp< EffectModule>& effect, 444 const wp<EffectHandle>& handle, 445 bool unpiniflast); 446 447 // return values for hasAudioSession (bit field) 448 enum effect_state { 449 EFFECT_SESSION = 0x1, // the audio session corresponds to at least one 450 // effect 451 TRACK_SESSION = 0x2 // the audio session corresponds to at least one 452 // track 453 }; 454 455 // get effect chain corresponding to session Id. 456 sp<EffectChain> getEffectChain(int sessionId); 457 // same as getEffectChain() but must be called with ThreadBase mutex locked 458 sp<EffectChain> getEffectChain_l(int sessionId); 459 // add an effect chain to the chain list (mEffectChains) 460 virtual status_t addEffectChain_l(const sp<EffectChain>& chain) = 0; 461 // remove an effect chain from the chain list (mEffectChains) 462 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain) = 0; 463 // lock mall effect chains Mutexes. Must be called before releasing the 464 // ThreadBase mutex before processing the mixer and effects. This guarantees the 465 // integrity of the chains during the process. 466 void lockEffectChains_l(Vector<sp <EffectChain> >& effectChains); 467 // unlock effect chains after process 468 void unlockEffectChains(Vector<sp <EffectChain> >& effectChains); 469 // set audio mode to all effect chains 470 void setMode(audio_mode_t mode); 471 // get effect module with corresponding ID on specified audio session 472 sp<AudioFlinger::EffectModule> getEffect_l(int sessionId, int effectId); 473 // add and effect module. Also creates the effect chain is none exists for 474 // the effects audio session 475 status_t addEffect_l(const sp< EffectModule>& effect); 476 // remove and effect module. Also removes the effect chain is this was the last 477 // effect 478 void removeEffect_l(const sp< EffectModule>& effect); 479 // detach all tracks connected to an auxiliary effect 480 virtual void detachAuxEffect_l(int effectId) {} 481 // returns either EFFECT_SESSION if effects on this audio session exist in one 482 // chain, or TRACK_SESSION if tracks on this audio session exist, or both 483 virtual uint32_t hasAudioSession(int sessionId) = 0; 484 // the value returned by default implementation is not important as the 485 // strategy is only meaningful for PlaybackThread which implements this method 486 virtual uint32_t getStrategyForSession_l(int sessionId) { return 0; } 487 488 // suspend or restore effect according to the type of effect passed. a NULL 489 // type pointer means suspend all effects in the session 490 void setEffectSuspended(const effect_uuid_t *type, 491 bool suspend, 492 int sessionId = AUDIO_SESSION_OUTPUT_MIX); 493 // check if some effects must be suspended/restored when an effect is enabled 494 // or disabled 495 void checkSuspendOnEffectEnabled(const sp<EffectModule>& effect, 496 bool enabled, 497 int sessionId = AUDIO_SESSION_OUTPUT_MIX); 498 void checkSuspendOnEffectEnabled_l(const sp<EffectModule>& effect, 499 bool enabled, 500 int sessionId = AUDIO_SESSION_OUTPUT_MIX); 501 mutable Mutex mLock; 502 503 protected: 504 505 // entry describing an effect being suspended in mSuspendedSessions keyed vector 506 class SuspendedSessionDesc : public RefBase { 507 public: 508 SuspendedSessionDesc() : mRefCount(0) {} 509 510 int mRefCount; // number of active suspend requests 511 effect_uuid_t mType; // effect type UUID 512 }; 513 514 void acquireWakeLock(); 515 void acquireWakeLock_l(); 516 void releaseWakeLock(); 517 void releaseWakeLock_l(); 518 void setEffectSuspended_l(const effect_uuid_t *type, 519 bool suspend, 520 int sessionId = AUDIO_SESSION_OUTPUT_MIX); 521 // updated mSuspendedSessions when an effect suspended or restored 522 void updateSuspendedSessions_l(const effect_uuid_t *type, 523 bool suspend, 524 int sessionId); 525 // check if some effects must be suspended when an effect chain is added 526 void checkSuspendOnAddEffectChain_l(const sp<EffectChain>& chain); 527 528 friend class AudioFlinger; 529 friend class Track; 530 friend class TrackBase; 531 friend class PlaybackThread; 532 friend class MixerThread; 533 friend class DirectOutputThread; 534 friend class DuplicatingThread; 535 friend class RecordThread; 536 friend class RecordTrack; 537 538 const type_t mType; 539 Condition mWaitWorkCV; 540 const sp<AudioFlinger> mAudioFlinger; 541 uint32_t mSampleRate; 542 size_t mFrameCount; 543 uint32_t mChannelMask; 544 uint16_t mChannelCount; 545 size_t mFrameSize; 546 audio_format_t mFormat; 547 Condition mParamCond; 548 Vector<String8> mNewParameters; 549 status_t mParamStatus; 550 Vector<ConfigEvent> mConfigEvents; 551 bool mStandby; 552 const audio_io_handle_t mId; 553 bool mExiting; 554 Vector< sp<EffectChain> > mEffectChains; 555 uint32_t mDevice; // output device for PlaybackThread 556 // input + output devices for RecordThread 557 static const int kNameLength = 32; 558 char mName[kNameLength]; 559 sp<IPowerManager> mPowerManager; 560 sp<IBinder> mWakeLockToken; 561 const sp<PMDeathRecipient> mDeathRecipient; 562 // list of suspended effects per session and per type. The first vector is 563 // keyed by session ID, the second by type UUID timeLow field 564 KeyedVector< int, KeyedVector< int, sp<SuspendedSessionDesc> > > mSuspendedSessions; 565 }; 566 567 // --- PlaybackThread --- 568 class PlaybackThread : public ThreadBase { 569 public: 570 571 enum mixer_state { 572 MIXER_IDLE, 573 MIXER_TRACKS_ENABLED, 574 MIXER_TRACKS_READY 575 }; 576 577 // playback track 578 class Track : public TrackBase { 579 public: 580 Track( const wp<ThreadBase>& thread, 581 const sp<Client>& client, 582 audio_stream_type_t streamType, 583 uint32_t sampleRate, 584 audio_format_t format, 585 uint32_t channelMask, 586 int frameCount, 587 const sp<IMemory>& sharedBuffer, 588 int sessionId); 589 virtual ~Track(); 590 591 void dump(char* buffer, size_t size); 592 virtual status_t start(); 593 virtual void stop(); 594 void pause(); 595 596 void flush(); 597 void destroy(); 598 void mute(bool); 599 int name() const { 600 return mName; 601 } 602 603 audio_stream_type_t type() const { 604 return mStreamType; 605 } 606 status_t attachAuxEffect(int EffectId); 607 void setAuxBuffer(int EffectId, int32_t *buffer); 608 int32_t *auxBuffer() const { return mAuxBuffer; } 609 void setMainBuffer(int16_t *buffer) { mMainBuffer = buffer; } 610 int16_t *mainBuffer() const { return mMainBuffer; } 611 int auxEffectId() const { return mAuxEffectId; } 612 613 614 protected: 615 friend class ThreadBase; 616 friend class TrackHandle; 617 friend class PlaybackThread; 618 friend class MixerThread; 619 friend class DirectOutputThread; 620 621 Track(const Track&); 622 Track& operator = (const Track&); 623 624 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer); 625 bool isMuted() const { return mMute; } 626 bool isPausing() const { 627 return mState == PAUSING; 628 } 629 bool isPaused() const { 630 return mState == PAUSED; 631 } 632 bool isReady() const; 633 void setPaused() { mState = PAUSED; } 634 void reset(); 635 636 bool isOutputTrack() const { 637 return (mStreamType == AUDIO_STREAM_CNT); 638 } 639 640 // we don't really need a lock for these 641 volatile bool mMute; 642 // FILLED state is used for suppressing volume ramp at begin of playing 643 enum {FS_FILLING, FS_FILLED, FS_ACTIVE}; 644 mutable uint8_t mFillingUpStatus; 645 int8_t mRetryCount; 646 sp<IMemory> mSharedBuffer; 647 bool mResetDone; 648 audio_stream_type_t mStreamType; 649 int mName; 650 int16_t *mMainBuffer; 651 int32_t *mAuxBuffer; 652 int mAuxEffectId; 653 bool mHasVolumeController; 654 }; // end of Track 655 656 657 // playback track 658 class OutputTrack : public Track { 659 public: 660 661 class Buffer: public AudioBufferProvider::Buffer { 662 public: 663 int16_t *mBuffer; 664 }; 665 666 OutputTrack( const wp<ThreadBase>& thread, 667 DuplicatingThread *sourceThread, 668 uint32_t sampleRate, 669 audio_format_t format, 670 uint32_t channelMask, 671 int frameCount); 672 virtual ~OutputTrack(); 673 674 virtual status_t start(); 675 virtual void stop(); 676 bool write(int16_t* data, uint32_t frames); 677 bool bufferQueueEmpty() const { return (mBufferQueue.size() == 0) ? true : false; } 678 bool isActive() const { return mActive; } 679 const wp<ThreadBase>& thread() const { return mThread; } 680 681 private: 682 683 enum { 684 NO_MORE_BUFFERS = 0x80000001, // same in AudioTrack.h, ok to be different value 685 }; 686 687 status_t obtainBuffer(AudioBufferProvider::Buffer* buffer, uint32_t waitTimeMs); 688 void clearBufferQueue(); 689 690 // Maximum number of pending buffers allocated by OutputTrack::write() 691 static const uint8_t kMaxOverFlowBuffers = 10; 692 693 Vector < Buffer* > mBufferQueue; 694 AudioBufferProvider::Buffer mOutBuffer; 695 bool mActive; 696 DuplicatingThread* const mSourceThread; // for waitTimeMs() in write() 697 }; // end of OutputTrack 698 699 PlaybackThread (const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, 700 audio_io_handle_t id, uint32_t device, type_t type); 701 virtual ~PlaybackThread(); 702 703 virtual status_t dump(int fd, const Vector<String16>& args); 704 705 // Thread virtuals 706 virtual status_t readyToRun(); 707 virtual void onFirstRef(); 708 709 virtual status_t initCheck() const { return (mOutput == NULL) ? NO_INIT : NO_ERROR; } 710 711 virtual uint32_t latency() const; 712 713 void setMasterVolume(float value); 714 void setMasterMute(bool muted); 715 716 void setStreamVolume(audio_stream_type_t stream, float value); 717 void setStreamMute(audio_stream_type_t stream, bool muted); 718 719 float streamVolume(audio_stream_type_t stream) const; 720 721 sp<Track> createTrack_l( 722 const sp<AudioFlinger::Client>& client, 723 audio_stream_type_t streamType, 724 uint32_t sampleRate, 725 audio_format_t format, 726 uint32_t channelMask, 727 int frameCount, 728 const sp<IMemory>& sharedBuffer, 729 int sessionId, 730 status_t *status); 731 732 AudioStreamOut* getOutput() const; 733 AudioStreamOut* clearOutput(); 734 virtual audio_stream_t* stream(); 735 736 void suspend() { mSuspended++; } 737 void restore() { if (mSuspended) mSuspended--; } 738 bool isSuspended() const { return (mSuspended != 0); } 739 virtual String8 getParameters(const String8& keys); 740 virtual void audioConfigChanged_l(int event, int param = 0); 741 virtual status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames); 742 int16_t *mixBuffer() const { return mMixBuffer; }; 743 744 virtual void detachAuxEffect_l(int effectId); 745 status_t attachAuxEffect(const sp<AudioFlinger::PlaybackThread::Track> track, 746 int EffectId); 747 status_t attachAuxEffect_l(const sp<AudioFlinger::PlaybackThread::Track> track, 748 int EffectId); 749 750 virtual status_t addEffectChain_l(const sp<EffectChain>& chain); 751 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain); 752 virtual uint32_t hasAudioSession(int sessionId); 753 virtual uint32_t getStrategyForSession_l(int sessionId); 754 755 void setStreamValid(audio_stream_type_t streamType, bool valid); 756 757 struct stream_type_t { 758 stream_type_t() 759 : volume(1.0f), 760 mute(false), 761 valid(true) 762 { 763 } 764 float volume; 765 bool mute; 766 bool valid; 767 }; 768 769 protected: 770 int16_t* mMixBuffer; 771 int mSuspended; 772 int mBytesWritten; 773 private: 774 bool mMasterMute; 775 void setMasterMute_l(bool muted) { mMasterMute = muted; } 776 protected: 777 SortedVector< wp<Track> > mActiveTracks; 778 779 virtual int getTrackName_l() = 0; 780 virtual void deleteTrackName_l(int name) = 0; 781 virtual uint32_t activeSleepTimeUs(); 782 virtual uint32_t idleSleepTimeUs() = 0; 783 virtual uint32_t suspendSleepTimeUs() = 0; 784 785 private: 786 787 friend class AudioFlinger; 788 friend class OutputTrack; 789 friend class Track; 790 friend class TrackBase; 791 friend class MixerThread; 792 friend class DirectOutputThread; 793 friend class DuplicatingThread; 794 795 PlaybackThread(const Client&); 796 PlaybackThread& operator = (const PlaybackThread&); 797 798 status_t addTrack_l(const sp<Track>& track); 799 void destroyTrack_l(const sp<Track>& track); 800 void removeTrack_l(const sp<Track>& track); 801 802 void readOutputParameters(); 803 804 virtual status_t dumpInternals(int fd, const Vector<String16>& args); 805 status_t dumpTracks(int fd, const Vector<String16>& args); 806 807 SortedVector< sp<Track> > mTracks; 808 // mStreamTypes[] uses 1 additional stream type internally for the OutputTrack used by DuplicatingThread 809 stream_type_t mStreamTypes[AUDIO_STREAM_CNT + 1]; 810 AudioStreamOut *mOutput; 811 float mMasterVolume; 812 nsecs_t mLastWriteTime; 813 int mNumWrites; 814 int mNumDelayedWrites; 815 bool mInWrite; 816 }; 817 818 class MixerThread : public PlaybackThread { 819 public: 820 MixerThread (const sp<AudioFlinger>& audioFlinger, 821 AudioStreamOut* output, 822 audio_io_handle_t id, 823 uint32_t device, 824 type_t type = MIXER); 825 virtual ~MixerThread(); 826 827 // Thread virtuals 828 virtual bool threadLoop(); 829 830 void invalidateTracks(audio_stream_type_t streamType); 831 virtual bool checkForNewParameters_l(); 832 virtual status_t dumpInternals(int fd, const Vector<String16>& args); 833 834 protected: 835 mixer_state prepareTracks_l(const SortedVector< wp<Track> >& activeTracks, 836 Vector< sp<Track> > *tracksToRemove); 837 virtual int getTrackName_l(); 838 virtual void deleteTrackName_l(int name); 839 virtual uint32_t idleSleepTimeUs(); 840 virtual uint32_t suspendSleepTimeUs(); 841 842 AudioMixer* mAudioMixer; 843 mixer_state mPrevMixerStatus; // previous status returned by prepareTracks_l() 844 }; 845 846 class DirectOutputThread : public PlaybackThread { 847 public: 848 849 DirectOutputThread (const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, 850 audio_io_handle_t id, uint32_t device); 851 virtual ~DirectOutputThread(); 852 853 // Thread virtuals 854 virtual bool threadLoop(); 855 856 virtual bool checkForNewParameters_l(); 857 858 protected: 859 virtual int getTrackName_l(); 860 virtual void deleteTrackName_l(int name); 861 virtual uint32_t activeSleepTimeUs(); 862 virtual uint32_t idleSleepTimeUs(); 863 virtual uint32_t suspendSleepTimeUs(); 864 865 private: 866 void applyVolume(uint16_t leftVol, uint16_t rightVol, bool ramp); 867 868 float mLeftVolFloat; 869 float mRightVolFloat; 870 uint16_t mLeftVolShort; 871 uint16_t mRightVolShort; 872 }; 873 874 class DuplicatingThread : public MixerThread { 875 public: 876 DuplicatingThread (const sp<AudioFlinger>& audioFlinger, MixerThread* mainThread, 877 audio_io_handle_t id); 878 virtual ~DuplicatingThread(); 879 880 // Thread virtuals 881 virtual bool threadLoop(); 882 void addOutputTrack(MixerThread* thread); 883 void removeOutputTrack(MixerThread* thread); 884 uint32_t waitTimeMs() { return mWaitTimeMs; } 885 protected: 886 virtual uint32_t activeSleepTimeUs(); 887 888 private: 889 bool outputsReady(SortedVector< sp<OutputTrack> > &outputTracks); 890 void updateWaitTime(); 891 892 SortedVector < sp<OutputTrack> > mOutputTracks; 893 uint32_t mWaitTimeMs; 894 }; 895 896 PlaybackThread *checkPlaybackThread_l(audio_io_handle_t output) const; 897 MixerThread *checkMixerThread_l(audio_io_handle_t output) const; 898 RecordThread *checkRecordThread_l(audio_io_handle_t input) const; 899 // no range check, AudioFlinger::mLock held 900 bool streamMute_l(audio_stream_type_t stream) const 901 { return mStreamTypes[stream].mute; } 902 // no range check, doesn't check per-thread stream volume, AudioFlinger::mLock held 903 float streamVolume_l(audio_stream_type_t stream) const 904 { return mStreamTypes[stream].volume; } 905 void audioConfigChanged_l(int event, audio_io_handle_t ioHandle, void *param2); 906 907 // allocate an audio_io_handle_t, session ID, or effect ID 908 uint32_t nextUniqueId(); 909 910 status_t moveEffectChain_l(int sessionId, 911 AudioFlinger::PlaybackThread *srcThread, 912 AudioFlinger::PlaybackThread *dstThread, 913 bool reRegister); 914 PlaybackThread *primaryPlaybackThread_l(); 915 uint32_t primaryOutputDevice_l(); 916 917 friend class AudioBuffer; 918 919 class TrackHandle : public android::BnAudioTrack { 920 public: 921 TrackHandle(const sp<PlaybackThread::Track>& track); 922 virtual ~TrackHandle(); 923 virtual sp<IMemory> getCblk() const; 924 virtual status_t start(); 925 virtual void stop(); 926 virtual void flush(); 927 virtual void mute(bool); 928 virtual void pause(); 929 virtual status_t attachAuxEffect(int effectId); 930 virtual status_t onTransact( 931 uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags); 932 private: 933 const sp<PlaybackThread::Track> mTrack; 934 }; 935 936 friend class Client; 937 friend class PlaybackThread::Track; 938 939 940 void removeClient_l(pid_t pid); 941 void removeNotificationClient(pid_t pid); 942 943 944 // record thread 945 class RecordThread : public ThreadBase, public AudioBufferProvider 946 { 947 public: 948 949 // record track 950 class RecordTrack : public TrackBase { 951 public: 952 RecordTrack(const wp<ThreadBase>& thread, 953 const sp<Client>& client, 954 uint32_t sampleRate, 955 audio_format_t format, 956 uint32_t channelMask, 957 int frameCount, 958 uint32_t flags, 959 int sessionId); 960 virtual ~RecordTrack(); 961 962 virtual status_t start(); 963 virtual void stop(); 964 965 bool overflow() { bool tmp = mOverflow; mOverflow = false; return tmp; } 966 bool setOverflow() { bool tmp = mOverflow; mOverflow = true; return tmp; } 967 968 void dump(char* buffer, size_t size); 969 970 private: 971 friend class AudioFlinger; 972 friend class RecordThread; 973 974 RecordTrack(const RecordTrack&); 975 RecordTrack& operator = (const RecordTrack&); 976 977 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer); 978 979 bool mOverflow; 980 }; 981 982 983 RecordThread(const sp<AudioFlinger>& audioFlinger, 984 AudioStreamIn *input, 985 uint32_t sampleRate, 986 uint32_t channels, 987 audio_io_handle_t id, 988 uint32_t device); 989 virtual ~RecordThread(); 990 991 virtual bool threadLoop(); 992 virtual status_t readyToRun(); 993 virtual void onFirstRef(); 994 995 virtual status_t initCheck() const { return (mInput == NULL) ? NO_INIT : NO_ERROR; } 996 sp<AudioFlinger::RecordThread::RecordTrack> createRecordTrack_l( 997 const sp<AudioFlinger::Client>& client, 998 uint32_t sampleRate, 999 audio_format_t format, 1000 int channelMask, 1001 int frameCount, 1002 uint32_t flags, 1003 int sessionId, 1004 status_t *status); 1005 1006 status_t start(RecordTrack* recordTrack); 1007 void stop(RecordTrack* recordTrack); 1008 status_t dump(int fd, const Vector<String16>& args); 1009 AudioStreamIn* getInput() const; 1010 AudioStreamIn* clearInput(); 1011 virtual audio_stream_t* stream(); 1012 1013 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer); 1014 virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer); 1015 virtual bool checkForNewParameters_l(); 1016 virtual String8 getParameters(const String8& keys); 1017 virtual void audioConfigChanged_l(int event, int param = 0); 1018 void readInputParameters(); 1019 virtual unsigned int getInputFramesLost(); 1020 1021 virtual status_t addEffectChain_l(const sp<EffectChain>& chain); 1022 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain); 1023 virtual uint32_t hasAudioSession(int sessionId); 1024 RecordTrack* track(); 1025 1026 private: 1027 RecordThread(); 1028 AudioStreamIn *mInput; 1029 RecordTrack* mTrack; 1030 sp<RecordTrack> mActiveTrack; 1031 Condition mStartStopCond; 1032 AudioResampler *mResampler; 1033 int32_t *mRsmpOutBuffer; 1034 int16_t *mRsmpInBuffer; 1035 size_t mRsmpInIndex; 1036 size_t mInputBytes; 1037 const int mReqChannelCount; 1038 const uint32_t mReqSampleRate; 1039 ssize_t mBytesRead; 1040 }; 1041 1042 class RecordHandle : public android::BnAudioRecord { 1043 public: 1044 RecordHandle(const sp<RecordThread::RecordTrack>& recordTrack); 1045 virtual ~RecordHandle(); 1046 virtual sp<IMemory> getCblk() const; 1047 virtual status_t start(); 1048 virtual void stop(); 1049 virtual status_t onTransact( 1050 uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags); 1051 private: 1052 const sp<RecordThread::RecordTrack> mRecordTrack; 1053 }; 1054 1055 //--- Audio Effect Management 1056 1057 // EffectModule and EffectChain classes both have their own mutex to protect 1058 // state changes or resource modifications. Always respect the following order 1059 // if multiple mutexes must be acquired to avoid cross deadlock: 1060 // AudioFlinger -> ThreadBase -> EffectChain -> EffectModule 1061 1062 // The EffectModule class is a wrapper object controlling the effect engine implementation 1063 // in the effect library. It prevents concurrent calls to process() and command() functions 1064 // from different client threads. It keeps a list of EffectHandle objects corresponding 1065 // to all client applications using this effect and notifies applications of effect state, 1066 // control or parameter changes. It manages the activation state machine to send appropriate 1067 // reset, enable, disable commands to effect engine and provide volume 1068 // ramping when effects are activated/deactivated. 1069 // When controlling an auxiliary effect, the EffectModule also provides an input buffer used by 1070 // the attached track(s) to accumulate their auxiliary channel. 1071 class EffectModule: public RefBase { 1072 public: 1073 EffectModule(const wp<ThreadBase>& wThread, 1074 const wp<AudioFlinger::EffectChain>& chain, 1075 effect_descriptor_t *desc, 1076 int id, 1077 int sessionId); 1078 virtual ~EffectModule(); 1079 1080 enum effect_state { 1081 IDLE, 1082 RESTART, 1083 STARTING, 1084 ACTIVE, 1085 STOPPING, 1086 STOPPED, 1087 DESTROYED 1088 }; 1089 1090 int id() const { return mId; } 1091 void process(); 1092 void updateState(); 1093 status_t command(uint32_t cmdCode, 1094 uint32_t cmdSize, 1095 void *pCmdData, 1096 uint32_t *replySize, 1097 void *pReplyData); 1098 1099 void reset_l(); 1100 status_t configure(); 1101 status_t init(); 1102 effect_state state() const { 1103 return mState; 1104 } 1105 uint32_t status() { 1106 return mStatus; 1107 } 1108 int sessionId() const { 1109 return mSessionId; 1110 } 1111 status_t setEnabled(bool enabled); 1112 bool isEnabled() const; 1113 bool isProcessEnabled() const; 1114 1115 void setInBuffer(int16_t *buffer) { mConfig.inputCfg.buffer.s16 = buffer; } 1116 int16_t *inBuffer() { return mConfig.inputCfg.buffer.s16; } 1117 void setOutBuffer(int16_t *buffer) { mConfig.outputCfg.buffer.s16 = buffer; } 1118 int16_t *outBuffer() { return mConfig.outputCfg.buffer.s16; } 1119 void setChain(const wp<EffectChain>& chain) { mChain = chain; } 1120 void setThread(const wp<ThreadBase>& thread) { mThread = thread; } 1121 const wp<ThreadBase>& thread() { return mThread; } 1122 1123 status_t addHandle(const sp<EffectHandle>& handle); 1124 void disconnect(const wp<EffectHandle>& handle, bool unpiniflast); 1125 size_t removeHandle (const wp<EffectHandle>& handle); 1126 1127 effect_descriptor_t& desc() { return mDescriptor; } 1128 wp<EffectChain>& chain() { return mChain; } 1129 1130 status_t setDevice(uint32_t device); 1131 status_t setVolume(uint32_t *left, uint32_t *right, bool controller); 1132 status_t setMode(audio_mode_t mode); 1133 status_t start(); 1134 status_t stop(); 1135 void setSuspended(bool suspended); 1136 bool suspended() const; 1137 1138 sp<EffectHandle> controlHandle(); 1139 1140 bool isPinned() const { return mPinned; } 1141 void unPin() { mPinned = false; } 1142 1143 status_t dump(int fd, const Vector<String16>& args); 1144 1145 protected: 1146 friend class EffectHandle; 1147 friend class AudioFlinger; 1148 bool mPinned; 1149 1150 // Maximum time allocated to effect engines to complete the turn off sequence 1151 static const uint32_t MAX_DISABLE_TIME_MS = 10000; 1152 1153 EffectModule(const EffectModule&); 1154 EffectModule& operator = (const EffectModule&); 1155 1156 status_t start_l(); 1157 status_t stop_l(); 1158 1159mutable Mutex mLock; // mutex for process, commands and handles list protection 1160 wp<ThreadBase> mThread; // parent thread 1161 wp<EffectChain> mChain; // parent effect chain 1162 int mId; // this instance unique ID 1163 int mSessionId; // audio session ID 1164 effect_descriptor_t mDescriptor;// effect descriptor received from effect engine 1165 effect_config_t mConfig; // input and output audio configuration 1166 effect_handle_t mEffectInterface; // Effect module C API 1167 status_t mStatus; // initialization status 1168 effect_state mState; // current activation state 1169 Vector< wp<EffectHandle> > mHandles; // list of client handles 1170 uint32_t mMaxDisableWaitCnt; // maximum grace period before forcing an effect off after 1171 // sending disable command. 1172 uint32_t mDisableWaitCnt; // current process() calls count during disable period. 1173 bool mSuspended; // effect is suspended: temporarily disabled by framework 1174 }; 1175 1176 // The EffectHandle class implements the IEffect interface. It provides resources 1177 // to receive parameter updates, keeps track of effect control 1178 // ownership and state and has a pointer to the EffectModule object it is controlling. 1179 // There is one EffectHandle object for each application controlling (or using) 1180 // an effect module. 1181 // The EffectHandle is obtained by calling AudioFlinger::createEffect(). 1182 class EffectHandle: public android::BnEffect { 1183 public: 1184 1185 EffectHandle(const sp<EffectModule>& effect, 1186 const sp<AudioFlinger::Client>& client, 1187 const sp<IEffectClient>& effectClient, 1188 int32_t priority); 1189 virtual ~EffectHandle(); 1190 1191 // IEffect 1192 virtual status_t enable(); 1193 virtual status_t disable(); 1194 virtual status_t command(uint32_t cmdCode, 1195 uint32_t cmdSize, 1196 void *pCmdData, 1197 uint32_t *replySize, 1198 void *pReplyData); 1199 virtual void disconnect(); 1200 virtual void disconnect(bool unpiniflast); 1201 virtual sp<IMemory> getCblk() const { return mCblkMemory; } 1202 virtual status_t onTransact(uint32_t code, const Parcel& data, 1203 Parcel* reply, uint32_t flags); 1204 1205 1206 // Give or take control of effect module 1207 // - hasControl: true if control is given, false if removed 1208 // - signal: true client app should be signaled of change, false otherwise 1209 // - enabled: state of the effect when control is passed 1210 void setControl(bool hasControl, bool signal, bool enabled); 1211 void commandExecuted(uint32_t cmdCode, 1212 uint32_t cmdSize, 1213 void *pCmdData, 1214 uint32_t replySize, 1215 void *pReplyData); 1216 void setEnabled(bool enabled); 1217 bool enabled() const { return mEnabled; } 1218 1219 // Getters 1220 int id() const { return mEffect->id(); } 1221 int priority() const { return mPriority; } 1222 bool hasControl() const { return mHasControl; } 1223 sp<EffectModule> effect() const { return mEffect; } 1224 1225 void dump(char* buffer, size_t size); 1226 1227 protected: 1228 friend class AudioFlinger; 1229 friend class EffectModule; 1230 EffectHandle(const EffectHandle&); 1231 EffectHandle& operator =(const EffectHandle&); 1232 1233 sp<EffectModule> mEffect; // pointer to controlled EffectModule 1234 sp<IEffectClient> mEffectClient; // callback interface for client notifications 1235 /*const*/ sp<Client> mClient; // client for shared memory allocation, see disconnect() 1236 sp<IMemory> mCblkMemory; // shared memory for control block 1237 effect_param_cblk_t* mCblk; // control block for deferred parameter setting via shared memory 1238 uint8_t* mBuffer; // pointer to parameter area in shared memory 1239 int mPriority; // client application priority to control the effect 1240 bool mHasControl; // true if this handle is controlling the effect 1241 bool mEnabled; // cached enable state: needed when the effect is 1242 // restored after being suspended 1243 }; 1244 1245 // the EffectChain class represents a group of effects associated to one audio session. 1246 // There can be any number of EffectChain objects per output mixer thread (PlaybackThread). 1247 // The EffecChain with session ID 0 contains global effects applied to the output mix. 1248 // Effects in this chain can be insert or auxiliary. Effects in other chains (attached to tracks) 1249 // are insert only. The EffectChain maintains an ordered list of effect module, the order corresponding 1250 // in the effect process order. When attached to a track (session ID != 0), it also provide it's own 1251 // input buffer used by the track as accumulation buffer. 1252 class EffectChain: public RefBase { 1253 public: 1254 EffectChain(const wp<ThreadBase>& wThread, int sessionId); 1255 virtual ~EffectChain(); 1256 1257 // special key used for an entry in mSuspendedEffects keyed vector 1258 // corresponding to a suspend all request. 1259 static const int kKeyForSuspendAll = 0; 1260 1261 // minimum duration during which we force calling effect process when last track on 1262 // a session is stopped or removed to allow effect tail to be rendered 1263 static const int kProcessTailDurationMs = 1000; 1264 1265 void process_l(); 1266 1267 void lock() { 1268 mLock.lock(); 1269 } 1270 void unlock() { 1271 mLock.unlock(); 1272 } 1273 1274 status_t addEffect_l(const sp<EffectModule>& handle); 1275 size_t removeEffect_l(const sp<EffectModule>& handle); 1276 1277 int sessionId() const { return mSessionId; } 1278 void setSessionId(int sessionId) { mSessionId = sessionId; } 1279 1280 sp<EffectModule> getEffectFromDesc_l(effect_descriptor_t *descriptor); 1281 sp<EffectModule> getEffectFromId_l(int id); 1282 sp<EffectModule> getEffectFromType_l(const effect_uuid_t *type); 1283 bool setVolume_l(uint32_t *left, uint32_t *right); 1284 void setDevice_l(uint32_t device); 1285 void setMode_l(audio_mode_t mode); 1286 1287 void setInBuffer(int16_t *buffer, bool ownsBuffer = false) { 1288 mInBuffer = buffer; 1289 mOwnInBuffer = ownsBuffer; 1290 } 1291 int16_t *inBuffer() const { 1292 return mInBuffer; 1293 } 1294 void setOutBuffer(int16_t *buffer) { 1295 mOutBuffer = buffer; 1296 } 1297 int16_t *outBuffer() const { 1298 return mOutBuffer; 1299 } 1300 1301 void incTrackCnt() { android_atomic_inc(&mTrackCnt); } 1302 void decTrackCnt() { android_atomic_dec(&mTrackCnt); } 1303 int32_t trackCnt() const { return mTrackCnt;} 1304 1305 void incActiveTrackCnt() { android_atomic_inc(&mActiveTrackCnt); 1306 mTailBufferCount = mMaxTailBuffers; } 1307 void decActiveTrackCnt() { android_atomic_dec(&mActiveTrackCnt); } 1308 int32_t activeTrackCnt() const { return mActiveTrackCnt;} 1309 1310 uint32_t strategy() const { return mStrategy; } 1311 void setStrategy(uint32_t strategy) 1312 { mStrategy = strategy; } 1313 1314 // suspend effect of the given type 1315 void setEffectSuspended_l(const effect_uuid_t *type, 1316 bool suspend); 1317 // suspend all eligible effects 1318 void setEffectSuspendedAll_l(bool suspend); 1319 // check if effects should be suspend or restored when a given effect is enable or disabled 1320 void checkSuspendOnEffectEnabled(const sp<EffectModule>& effect, 1321 bool enabled); 1322 1323 status_t dump(int fd, const Vector<String16>& args); 1324 1325 protected: 1326 friend class AudioFlinger; 1327 EffectChain(const EffectChain&); 1328 EffectChain& operator =(const EffectChain&); 1329 1330 class SuspendedEffectDesc : public RefBase { 1331 public: 1332 SuspendedEffectDesc() : mRefCount(0) {} 1333 1334 int mRefCount; 1335 effect_uuid_t mType; 1336 wp<EffectModule> mEffect; 1337 }; 1338 1339 // get a list of effect modules to suspend when an effect of the type 1340 // passed is enabled. 1341 void getSuspendEligibleEffects(Vector< sp<EffectModule> > &effects); 1342 1343 // get an effect module if it is currently enable 1344 sp<EffectModule> getEffectIfEnabled(const effect_uuid_t *type); 1345 // true if the effect whose descriptor is passed can be suspended 1346 // OEMs can modify the rules implemented in this method to exclude specific effect 1347 // types or implementations from the suspend/restore mechanism. 1348 bool isEffectEligibleForSuspend(const effect_descriptor_t& desc); 1349 1350 wp<ThreadBase> mThread; // parent mixer thread 1351 Mutex mLock; // mutex protecting effect list 1352 Vector<sp<EffectModule> > mEffects; // list of effect modules 1353 int mSessionId; // audio session ID 1354 int16_t *mInBuffer; // chain input buffer 1355 int16_t *mOutBuffer; // chain output buffer 1356 volatile int32_t mActiveTrackCnt; // number of active tracks connected 1357 volatile int32_t mTrackCnt; // number of tracks connected 1358 int32_t mTailBufferCount; // current effect tail buffer count 1359 int32_t mMaxTailBuffers; // maximum effect tail buffers 1360 bool mOwnInBuffer; // true if the chain owns its input buffer 1361 int mVolumeCtrlIdx; // index of insert effect having control over volume 1362 uint32_t mLeftVolume; // previous volume on left channel 1363 uint32_t mRightVolume; // previous volume on right channel 1364 uint32_t mNewLeftVolume; // new volume on left channel 1365 uint32_t mNewRightVolume; // new volume on right channel 1366 uint32_t mStrategy; // strategy for this effect chain 1367 // mSuspendedEffects lists all effect currently suspended in the chain 1368 // use effect type UUID timelow field as key. There is no real risk of identical 1369 // timeLow fields among effect type UUIDs. 1370 KeyedVector< int, sp<SuspendedEffectDesc> > mSuspendedEffects; 1371 }; 1372 1373 // AudioStreamOut and AudioStreamIn are immutable, so their fields are const. 1374 // For emphasis, we could also make all pointers to them be "const *", 1375 // but that would clutter the code unnecessarily. 1376 1377 struct AudioStreamOut { 1378 audio_hw_device_t* const hwDev; 1379 audio_stream_out_t* const stream; 1380 1381 AudioStreamOut(audio_hw_device_t *dev, audio_stream_out_t *out) : 1382 hwDev(dev), stream(out) {} 1383 }; 1384 1385 struct AudioStreamIn { 1386 audio_hw_device_t* const hwDev; 1387 audio_stream_in_t* const stream; 1388 1389 AudioStreamIn(audio_hw_device_t *dev, audio_stream_in_t *in) : 1390 hwDev(dev), stream(in) {} 1391 }; 1392 1393 struct AudioSessionRef { 1394 // FIXME rename parameter names when fields get "m" prefix 1395 AudioSessionRef(int sessionid_, pid_t pid_) : 1396 sessionid(sessionid_), pid(pid_), cnt(1) {} 1397 const int sessionid; 1398 const pid_t pid; 1399 int cnt; 1400 }; 1401 1402 friend class RecordThread; 1403 friend class PlaybackThread; 1404 1405 mutable Mutex mLock; 1406 1407 DefaultKeyedVector< pid_t, wp<Client> > mClients; // see ~Client() 1408 1409 mutable Mutex mHardwareLock; 1410 audio_hw_device_t* mPrimaryHardwareDev; 1411 Vector<audio_hw_device_t*> mAudioHwDevs; 1412 mutable hardware_call_state mHardwareStatus; // for dump only 1413 1414 1415 DefaultKeyedVector< audio_io_handle_t, sp<PlaybackThread> > mPlaybackThreads; 1416 PlaybackThread::stream_type_t mStreamTypes[AUDIO_STREAM_CNT]; 1417 1418 // both are protected by mLock 1419 float mMasterVolume; 1420 bool mMasterMute; 1421 1422 DefaultKeyedVector< audio_io_handle_t, sp<RecordThread> > mRecordThreads; 1423 1424 DefaultKeyedVector< pid_t, sp<NotificationClient> > mNotificationClients; 1425 volatile int32_t mNextUniqueId; 1426 audio_mode_t mMode; 1427 bool mBtNrecIsOff; 1428 1429 Vector<AudioSessionRef*> mAudioSessionRefs; 1430 1431 float masterVolume_l() const { return mMasterVolume; } 1432 bool masterMute_l() const { return mMasterMute; } 1433 1434private: 1435 sp<Client> registerPid_l(pid_t pid); // always returns non-0 1436 1437}; 1438 1439 1440// ---------------------------------------------------------------------------- 1441 1442}; // namespace android 1443 1444#endif // ANDROID_AUDIO_FLINGER_H 1445