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