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