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