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