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