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