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