AudioFlinger.h revision e8286332f3817a8b7cc4cfd8f6450a3913533660
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() const { return mStandby; } 427 uint32_t device() const { 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 all 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 // Also sets the parameter 'effectChains' to current value of mEffectChains. 462 void lockEffectChains_l(Vector<sp <EffectChain> >& effectChains); 463 // unlock effect chains after process 464 void unlockEffectChains(const 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 = 16; // prctl(PR_SET_NAME) limit 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, // no active tracks 580 MIXER_TRACKS_ENABLED, // at least one active track, but no track has any data ready 581 MIXER_TRACKS_READY // at least one active track, and at least one track has data 582 // standby mode does not have an enum value 583 // suspend by audio policy manager is orthogonal to mixer state 584 }; 585 586 // playback track 587 class Track : public TrackBase { 588 public: 589 Track( PlaybackThread *thread, 590 const sp<Client>& client, 591 audio_stream_type_t streamType, 592 uint32_t sampleRate, 593 audio_format_t format, 594 uint32_t channelMask, 595 int frameCount, 596 const sp<IMemory>& sharedBuffer, 597 int sessionId); 598 virtual ~Track(); 599 600 void dump(char* buffer, size_t size); 601 virtual status_t start(pid_t tid); 602 virtual void stop(); 603 void pause(); 604 605 void flush(); 606 void destroy(); 607 void mute(bool); 608 int name() const { 609 return mName; 610 } 611 612 audio_stream_type_t streamType() const { 613 return mStreamType; 614 } 615 status_t attachAuxEffect(int EffectId); 616 void setAuxBuffer(int EffectId, int32_t *buffer); 617 int32_t *auxBuffer() const { return mAuxBuffer; } 618 void setMainBuffer(int16_t *buffer) { mMainBuffer = buffer; } 619 int16_t *mainBuffer() const { return mMainBuffer; } 620 int auxEffectId() const { return mAuxEffectId; } 621 622 protected: 623 friend class ThreadBase; 624 friend class TrackHandle; 625 friend class PlaybackThread; 626 friend class MixerThread; 627 friend class DirectOutputThread; 628 629 Track(const Track&); 630 Track& operator = (const Track&); 631 632 // AudioBufferProvider interface 633 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer, int64_t pts = kInvalidPTS); 634 // releaseBuffer() not overridden 635 636 virtual uint32_t framesReady() const; 637 638 bool isMuted() const { return mMute; } 639 bool isPausing() const { 640 return mState == PAUSING; 641 } 642 bool isPaused() const { 643 return mState == PAUSED; 644 } 645 bool isReady() const; 646 void setPaused() { mState = PAUSED; } 647 void reset(); 648 649 bool isOutputTrack() const { 650 return (mStreamType == AUDIO_STREAM_CNT); 651 } 652 653 virtual bool isTimedTrack() const { return false; } 654 655 // we don't really need a lock for these 656 volatile bool mMute; 657 // FILLED state is used for suppressing volume ramp at begin of playing 658 enum {FS_FILLING, FS_FILLED, FS_ACTIVE}; 659 mutable uint8_t mFillingUpStatus; 660 int8_t mRetryCount; 661 sp<IMemory> mSharedBuffer; 662 bool mResetDone; 663 audio_stream_type_t mStreamType; 664 int mName; 665 int16_t *mMainBuffer; 666 int32_t *mAuxBuffer; 667 int mAuxEffectId; 668 bool mHasVolumeController; 669 }; // end of Track 670 671 class TimedTrack : public Track { 672 public: 673 static sp<TimedTrack> create(PlaybackThread *thread, 674 const sp<Client>& client, 675 audio_stream_type_t streamType, 676 uint32_t sampleRate, 677 audio_format_t format, 678 uint32_t channelMask, 679 int frameCount, 680 const sp<IMemory>& sharedBuffer, 681 int sessionId); 682 ~TimedTrack(); 683 684 class TimedBuffer { 685 public: 686 TimedBuffer(); 687 TimedBuffer(const sp<IMemory>& buffer, int64_t pts); 688 const sp<IMemory>& buffer() const { return mBuffer; } 689 int64_t pts() const { return mPTS; } 690 int position() const { return mPosition; } 691 void setPosition(int pos) { mPosition = pos; } 692 private: 693 sp<IMemory> mBuffer; 694 int64_t mPTS; 695 int mPosition; 696 }; 697 698 virtual bool isTimedTrack() const { return true; } 699 700 virtual uint32_t framesReady() const; 701 702 // AudioBufferProvider interface 703 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer, int64_t pts); 704 virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer); 705 706 void timedYieldSamples(AudioBufferProvider::Buffer* buffer); 707 void timedYieldSilence(uint32_t numFrames, 708 AudioBufferProvider::Buffer* buffer); 709 710 status_t allocateTimedBuffer(size_t size, 711 sp<IMemory>* buffer); 712 status_t queueTimedBuffer(const sp<IMemory>& buffer, 713 int64_t pts); 714 status_t setMediaTimeTransform(const LinearTransform& xform, 715 TimedAudioTrack::TargetTimeline target); 716 void trimTimedBufferQueue_l(); 717 718 private: 719 TimedTrack(PlaybackThread *thread, 720 const sp<Client>& client, 721 audio_stream_type_t streamType, 722 uint32_t sampleRate, 723 audio_format_t format, 724 uint32_t channelMask, 725 int frameCount, 726 const sp<IMemory>& sharedBuffer, 727 int sessionId); 728 729 uint64_t mLocalTimeFreq; 730 LinearTransform mLocalTimeToSampleTransform; 731 sp<MemoryDealer> mTimedMemoryDealer; 732 Vector<TimedBuffer> mTimedBufferQueue; 733 uint8_t* mTimedSilenceBuffer; 734 uint32_t mTimedSilenceBufferSize; 735 mutable Mutex mTimedBufferQueueLock; 736 bool mTimedAudioOutputOnTime; 737 CCHelper mCCHelper; 738 739 Mutex mMediaTimeTransformLock; 740 LinearTransform mMediaTimeTransform; 741 bool mMediaTimeTransformValid; 742 TimedAudioTrack::TargetTimeline mMediaTimeTransformTarget; 743 }; 744 745 746 // playback track 747 class OutputTrack : public Track { 748 public: 749 750 class Buffer: public AudioBufferProvider::Buffer { 751 public: 752 int16_t *mBuffer; 753 }; 754 755 OutputTrack(PlaybackThread *thread, 756 DuplicatingThread *sourceThread, 757 uint32_t sampleRate, 758 audio_format_t format, 759 uint32_t channelMask, 760 int frameCount); 761 virtual ~OutputTrack(); 762 763 virtual status_t start(pid_t tid); 764 virtual void stop(); 765 bool write(int16_t* data, uint32_t frames); 766 bool bufferQueueEmpty() const { return mBufferQueue.size() == 0; } 767 bool isActive() const { return mActive; } 768 const wp<ThreadBase>& thread() const { return mThread; } 769 770 private: 771 772 enum { 773 NO_MORE_BUFFERS = 0x80000001, // same in AudioTrack.h, ok to be different value 774 }; 775 776 status_t obtainBuffer(AudioBufferProvider::Buffer* buffer, uint32_t waitTimeMs); 777 void clearBufferQueue(); 778 779 // Maximum number of pending buffers allocated by OutputTrack::write() 780 static const uint8_t kMaxOverFlowBuffers = 10; 781 782 Vector < Buffer* > mBufferQueue; 783 AudioBufferProvider::Buffer mOutBuffer; 784 bool mActive; 785 DuplicatingThread* const mSourceThread; // for waitTimeMs() in write() 786 }; // end of OutputTrack 787 788 PlaybackThread (const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, 789 audio_io_handle_t id, uint32_t device, type_t type); 790 virtual ~PlaybackThread(); 791 792 virtual status_t dump(int fd, const Vector<String16>& args); 793 794 // Thread virtuals 795 virtual status_t readyToRun(); 796 virtual void onFirstRef(); 797 798 virtual status_t initCheck() const { return (mOutput == NULL) ? NO_INIT : NO_ERROR; } 799 800 virtual uint32_t latency() const; 801 802 void setMasterVolume(float value); 803 void setMasterMute(bool muted); 804 805 void setStreamVolume(audio_stream_type_t stream, float value); 806 void setStreamMute(audio_stream_type_t stream, bool muted); 807 808 float streamVolume(audio_stream_type_t stream) const; 809 810 sp<Track> createTrack_l( 811 const sp<AudioFlinger::Client>& client, 812 audio_stream_type_t streamType, 813 uint32_t sampleRate, 814 audio_format_t format, 815 uint32_t channelMask, 816 int frameCount, 817 const sp<IMemory>& sharedBuffer, 818 int sessionId, 819 bool isTimed, 820 status_t *status); 821 822 AudioStreamOut* getOutput() const; 823 AudioStreamOut* clearOutput(); 824 virtual audio_stream_t* stream(); 825 826 void suspend() { mSuspended++; } 827 void restore() { if (mSuspended > 0) mSuspended--; } 828 bool isSuspended() const { return (mSuspended > 0); } 829 virtual String8 getParameters(const String8& keys); 830 virtual void audioConfigChanged_l(int event, int param = 0); 831 virtual status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames); 832 int16_t *mixBuffer() const { return mMixBuffer; }; 833 834 virtual void detachAuxEffect_l(int effectId); 835 status_t attachAuxEffect(const sp<AudioFlinger::PlaybackThread::Track> track, 836 int EffectId); 837 status_t attachAuxEffect_l(const sp<AudioFlinger::PlaybackThread::Track> track, 838 int EffectId); 839 840 virtual status_t addEffectChain_l(const sp<EffectChain>& chain); 841 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain); 842 virtual uint32_t hasAudioSession(int sessionId); 843 virtual uint32_t getStrategyForSession_l(int sessionId); 844 845 void setStreamValid(audio_stream_type_t streamType, bool valid); 846 847 protected: 848 int16_t* mMixBuffer; 849 uint32_t mSuspended; // suspend count, > 0 means suspended 850 int mBytesWritten; 851 private: 852 // mMasterMute is in both PlaybackThread and in AudioFlinger. When a 853 // PlaybackThread needs to find out if master-muted, it checks it's local 854 // copy rather than the one in AudioFlinger. This optimization saves a lock. 855 bool mMasterMute; 856 void setMasterMute_l(bool muted) { mMasterMute = muted; } 857 protected: 858 SortedVector< wp<Track> > mActiveTracks; 859 860 virtual int getTrackName_l() = 0; 861 virtual void deleteTrackName_l(int name) = 0; 862 virtual uint32_t activeSleepTimeUs(); 863 virtual uint32_t idleSleepTimeUs() = 0; 864 virtual uint32_t suspendSleepTimeUs() = 0; 865 866 // Code snippets that are temporarily lifted up out of threadLoop() until the merge 867 void checkSilentMode_l(); 868 869 private: 870 871 friend class AudioFlinger; 872 friend class OutputTrack; 873 friend class Track; 874 friend class TrackBase; 875 friend class MixerThread; 876 friend class DirectOutputThread; 877 friend class DuplicatingThread; 878 879 PlaybackThread(const Client&); 880 PlaybackThread& operator = (const PlaybackThread&); 881 882 status_t addTrack_l(const sp<Track>& track); 883 void destroyTrack_l(const sp<Track>& track); 884 void removeTrack_l(const sp<Track>& track); 885 886 void readOutputParameters(); 887 888 virtual status_t dumpInternals(int fd, const Vector<String16>& args); 889 status_t dumpTracks(int fd, const Vector<String16>& args); 890 891 SortedVector< sp<Track> > mTracks; 892 // mStreamTypes[] uses 1 additional stream type internally for the OutputTrack used by DuplicatingThread 893 stream_type_t mStreamTypes[AUDIO_STREAM_CNT + 1]; 894 AudioStreamOut *mOutput; 895 float mMasterVolume; 896 nsecs_t mLastWriteTime; 897 int mNumWrites; 898 int mNumDelayedWrites; 899 bool mInWrite; 900 }; 901 902 class MixerThread : public PlaybackThread { 903 public: 904 MixerThread (const sp<AudioFlinger>& audioFlinger, 905 AudioStreamOut* output, 906 audio_io_handle_t id, 907 uint32_t device, 908 type_t type = MIXER); 909 virtual ~MixerThread(); 910 911 // Thread virtuals 912 virtual bool threadLoop(); 913 914 void invalidateTracks(audio_stream_type_t streamType); 915 virtual bool checkForNewParameters_l(); 916 virtual status_t dumpInternals(int fd, const Vector<String16>& args); 917 918 protected: 919 // prepareTracks_l reads and writes mActiveTracks, and also returns the 920 // pending set of tracks to remove via Vector 'tracksToRemove'. The caller is 921 // responsible for clearing or destroying this Vector later on, when it 922 // is safe to do so. That will drop the final ref count and destroy the tracks. 923 mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove); 924 virtual int getTrackName_l(); 925 virtual void deleteTrackName_l(int name); 926 virtual uint32_t idleSleepTimeUs(); 927 virtual uint32_t suspendSleepTimeUs(); 928 929 AudioMixer* mAudioMixer; 930 mixer_state mPrevMixerStatus; // previous status returned by prepareTracks_l() 931 }; 932 933 class DirectOutputThread : public PlaybackThread { 934 public: 935 936 DirectOutputThread (const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, 937 audio_io_handle_t id, uint32_t device); 938 virtual ~DirectOutputThread(); 939 940 // Thread virtuals 941 virtual bool threadLoop(); 942 943 virtual bool checkForNewParameters_l(); 944 945 protected: 946 virtual int getTrackName_l(); 947 virtual void deleteTrackName_l(int name); 948 virtual uint32_t activeSleepTimeUs(); 949 virtual uint32_t idleSleepTimeUs(); 950 virtual uint32_t suspendSleepTimeUs(); 951 952 private: 953 void applyVolume(uint16_t leftVol, uint16_t rightVol, bool ramp); 954 955 // volumes last sent to audio HAL with stream->set_volume() 956 // FIXME use standard representation and names 957 float mLeftVolFloat; 958 float mRightVolFloat; 959 uint16_t mLeftVolShort; 960 uint16_t mRightVolShort; 961 }; 962 963 class DuplicatingThread : public MixerThread { 964 public: 965 DuplicatingThread (const sp<AudioFlinger>& audioFlinger, MixerThread* mainThread, 966 audio_io_handle_t id); 967 virtual ~DuplicatingThread(); 968 969 // Thread virtuals 970 virtual bool threadLoop(); 971 void addOutputTrack(MixerThread* thread); 972 void removeOutputTrack(MixerThread* thread); 973 uint32_t waitTimeMs() { return mWaitTimeMs; } 974 protected: 975 virtual uint32_t activeSleepTimeUs(); 976 977 private: 978 bool outputsReady(const SortedVector<sp<OutputTrack> > &outputTracks); 979 void updateWaitTime(); 980 981 SortedVector < sp<OutputTrack> > mOutputTracks; 982 uint32_t mWaitTimeMs; 983 }; 984 985 PlaybackThread *checkPlaybackThread_l(audio_io_handle_t output) const; 986 MixerThread *checkMixerThread_l(audio_io_handle_t output) const; 987 RecordThread *checkRecordThread_l(audio_io_handle_t input) const; 988 // no range check, AudioFlinger::mLock held 989 bool streamMute_l(audio_stream_type_t stream) const 990 { return mStreamTypes[stream].mute; } 991 // no range check, doesn't check per-thread stream volume, AudioFlinger::mLock held 992 float streamVolume_l(audio_stream_type_t stream) const 993 { return mStreamTypes[stream].volume; } 994 void audioConfigChanged_l(int event, audio_io_handle_t ioHandle, void *param2); 995 996 // allocate an audio_io_handle_t, session ID, or effect ID 997 uint32_t nextUniqueId(); 998 999 status_t moveEffectChain_l(int sessionId, 1000 PlaybackThread *srcThread, 1001 PlaybackThread *dstThread, 1002 bool reRegister); 1003 // return thread associated with primary hardware device, or NULL 1004 PlaybackThread *primaryPlaybackThread_l() const; 1005 uint32_t primaryOutputDevice_l() const; 1006 1007 friend class AudioBuffer; 1008 1009 // server side of the client's IAudioTrack 1010 class TrackHandle : public android::BnAudioTrack { 1011 public: 1012 TrackHandle(const sp<PlaybackThread::Track>& track); 1013 virtual ~TrackHandle(); 1014 virtual sp<IMemory> getCblk() const; 1015 virtual status_t start(pid_t tid); 1016 virtual void stop(); 1017 virtual void flush(); 1018 virtual void mute(bool); 1019 virtual void pause(); 1020 virtual status_t attachAuxEffect(int effectId); 1021 virtual status_t allocateTimedBuffer(size_t size, 1022 sp<IMemory>* buffer); 1023 virtual status_t queueTimedBuffer(const sp<IMemory>& buffer, 1024 int64_t pts); 1025 virtual status_t setMediaTimeTransform(const LinearTransform& xform, 1026 int target); 1027 virtual status_t onTransact( 1028 uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags); 1029 private: 1030 const sp<PlaybackThread::Track> mTrack; 1031 }; 1032 1033 friend class Client; 1034 friend class PlaybackThread::Track; 1035 1036 1037 void removeClient_l(pid_t pid); 1038 void removeNotificationClient(pid_t pid); 1039 1040 1041 // record thread 1042 class RecordThread : public ThreadBase, public AudioBufferProvider 1043 { 1044 public: 1045 1046 // record track 1047 class RecordTrack : public TrackBase { 1048 public: 1049 RecordTrack(RecordThread *thread, 1050 const sp<Client>& client, 1051 uint32_t sampleRate, 1052 audio_format_t format, 1053 uint32_t channelMask, 1054 int frameCount, 1055 int sessionId); 1056 virtual ~RecordTrack(); 1057 1058 virtual status_t start(pid_t tid); 1059 virtual void stop(); 1060 1061 bool overflow() { bool tmp = mOverflow; mOverflow = false; return tmp; } 1062 bool setOverflow() { bool tmp = mOverflow; mOverflow = true; return tmp; } 1063 1064 void dump(char* buffer, size_t size); 1065 1066 private: 1067 friend class AudioFlinger; 1068 friend class RecordThread; 1069 1070 RecordTrack(const RecordTrack&); 1071 RecordTrack& operator = (const RecordTrack&); 1072 1073 // AudioBufferProvider interface 1074 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer, int64_t pts = kInvalidPTS); 1075 // releaseBuffer() not overridden 1076 1077 bool mOverflow; 1078 }; 1079 1080 1081 RecordThread(const sp<AudioFlinger>& audioFlinger, 1082 AudioStreamIn *input, 1083 uint32_t sampleRate, 1084 uint32_t channels, 1085 audio_io_handle_t id, 1086 uint32_t device); 1087 virtual ~RecordThread(); 1088 1089 virtual bool threadLoop(); 1090 virtual status_t readyToRun(); 1091 virtual void onFirstRef(); 1092 1093 virtual status_t initCheck() const { return (mInput == NULL) ? NO_INIT : NO_ERROR; } 1094 sp<AudioFlinger::RecordThread::RecordTrack> createRecordTrack_l( 1095 const sp<AudioFlinger::Client>& client, 1096 uint32_t sampleRate, 1097 audio_format_t format, 1098 int channelMask, 1099 int frameCount, 1100 int sessionId, 1101 status_t *status); 1102 1103 status_t start(RecordTrack* recordTrack); 1104 status_t start(RecordTrack* recordTrack, pid_t tid); 1105 void stop(RecordTrack* recordTrack); 1106 status_t dump(int fd, const Vector<String16>& args); 1107 AudioStreamIn* getInput() const; 1108 AudioStreamIn* clearInput(); 1109 virtual audio_stream_t* stream(); 1110 1111 // AudioBufferProvider interface 1112 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer, int64_t pts); 1113 virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer); 1114 1115 virtual bool checkForNewParameters_l(); 1116 virtual String8 getParameters(const String8& keys); 1117 virtual void audioConfigChanged_l(int event, int param = 0); 1118 void readInputParameters(); 1119 virtual unsigned int getInputFramesLost(); 1120 1121 virtual status_t addEffectChain_l(const sp<EffectChain>& chain); 1122 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain); 1123 virtual uint32_t hasAudioSession(int sessionId); 1124 RecordTrack* track(); 1125 1126 private: 1127 RecordThread(); 1128 AudioStreamIn *mInput; 1129 RecordTrack* mTrack; 1130 sp<RecordTrack> mActiveTrack; 1131 Condition mStartStopCond; 1132 AudioResampler *mResampler; 1133 int32_t *mRsmpOutBuffer; 1134 int16_t *mRsmpInBuffer; 1135 size_t mRsmpInIndex; 1136 size_t mInputBytes; 1137 const int mReqChannelCount; 1138 const uint32_t mReqSampleRate; 1139 ssize_t mBytesRead; 1140 }; 1141 1142 // server side of the client's IAudioRecord 1143 class RecordHandle : public android::BnAudioRecord { 1144 public: 1145 RecordHandle(const sp<RecordThread::RecordTrack>& recordTrack); 1146 virtual ~RecordHandle(); 1147 virtual sp<IMemory> getCblk() const; 1148 virtual status_t start(pid_t tid); 1149 virtual void stop(); 1150 virtual status_t onTransact( 1151 uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags); 1152 private: 1153 const sp<RecordThread::RecordTrack> mRecordTrack; 1154 }; 1155 1156 //--- Audio Effect Management 1157 1158 // EffectModule and EffectChain classes both have their own mutex to protect 1159 // state changes or resource modifications. Always respect the following order 1160 // if multiple mutexes must be acquired to avoid cross deadlock: 1161 // AudioFlinger -> ThreadBase -> EffectChain -> EffectModule 1162 1163 // The EffectModule class is a wrapper object controlling the effect engine implementation 1164 // in the effect library. It prevents concurrent calls to process() and command() functions 1165 // from different client threads. It keeps a list of EffectHandle objects corresponding 1166 // to all client applications using this effect and notifies applications of effect state, 1167 // control or parameter changes. It manages the activation state machine to send appropriate 1168 // reset, enable, disable commands to effect engine and provide volume 1169 // ramping when effects are activated/deactivated. 1170 // When controlling an auxiliary effect, the EffectModule also provides an input buffer used by 1171 // the attached track(s) to accumulate their auxiliary channel. 1172 class EffectModule: public RefBase { 1173 public: 1174 EffectModule(ThreadBase *thread, 1175 const wp<AudioFlinger::EffectChain>& chain, 1176 effect_descriptor_t *desc, 1177 int id, 1178 int sessionId); 1179 virtual ~EffectModule(); 1180 1181 enum effect_state { 1182 IDLE, 1183 RESTART, 1184 STARTING, 1185 ACTIVE, 1186 STOPPING, 1187 STOPPED, 1188 DESTROYED 1189 }; 1190 1191 int id() const { return mId; } 1192 void process(); 1193 void updateState(); 1194 status_t command(uint32_t cmdCode, 1195 uint32_t cmdSize, 1196 void *pCmdData, 1197 uint32_t *replySize, 1198 void *pReplyData); 1199 1200 void reset_l(); 1201 status_t configure(); 1202 status_t init(); 1203 effect_state state() const { 1204 return mState; 1205 } 1206 uint32_t status() { 1207 return mStatus; 1208 } 1209 int sessionId() const { 1210 return mSessionId; 1211 } 1212 status_t setEnabled(bool enabled); 1213 bool isEnabled() const; 1214 bool isProcessEnabled() const; 1215 1216 void setInBuffer(int16_t *buffer) { mConfig.inputCfg.buffer.s16 = buffer; } 1217 int16_t *inBuffer() { return mConfig.inputCfg.buffer.s16; } 1218 void setOutBuffer(int16_t *buffer) { mConfig.outputCfg.buffer.s16 = buffer; } 1219 int16_t *outBuffer() { return mConfig.outputCfg.buffer.s16; } 1220 void setChain(const wp<EffectChain>& chain) { mChain = chain; } 1221 void setThread(const wp<ThreadBase>& thread) { mThread = thread; } 1222 const wp<ThreadBase>& thread() { return mThread; } 1223 1224 status_t addHandle(const sp<EffectHandle>& handle); 1225 void disconnect(const wp<EffectHandle>& handle, bool unpinIfLast); 1226 size_t removeHandle (const wp<EffectHandle>& handle); 1227 1228 effect_descriptor_t& desc() { return mDescriptor; } 1229 wp<EffectChain>& chain() { return mChain; } 1230 1231 status_t setDevice(uint32_t device); 1232 status_t setVolume(uint32_t *left, uint32_t *right, bool controller); 1233 status_t setMode(audio_mode_t mode); 1234 status_t start(); 1235 status_t stop(); 1236 void setSuspended(bool suspended); 1237 bool suspended() const; 1238 1239 sp<EffectHandle> controlHandle(); 1240 1241 bool isPinned() const { return mPinned; } 1242 void unPin() { mPinned = false; } 1243 1244 status_t dump(int fd, const Vector<String16>& args); 1245 1246 protected: 1247 friend class EffectHandle; 1248 friend class AudioFlinger; 1249 bool mPinned; 1250 1251 // Maximum time allocated to effect engines to complete the turn off sequence 1252 static const uint32_t MAX_DISABLE_TIME_MS = 10000; 1253 1254 EffectModule(const EffectModule&); 1255 EffectModule& operator = (const EffectModule&); 1256 1257 status_t start_l(); 1258 status_t stop_l(); 1259 1260mutable Mutex mLock; // mutex for process, commands and handles list protection 1261 wp<ThreadBase> mThread; // parent thread 1262 wp<EffectChain> mChain; // parent effect chain 1263 int mId; // this instance unique ID 1264 int mSessionId; // audio session ID 1265 effect_descriptor_t mDescriptor;// effect descriptor received from effect engine 1266 effect_config_t mConfig; // input and output audio configuration 1267 effect_handle_t mEffectInterface; // Effect module C API 1268 status_t mStatus; // initialization status 1269 effect_state mState; // current activation state 1270 Vector< wp<EffectHandle> > mHandles; // list of client handles 1271 // First handle in mHandles has highest priority and controls the effect module 1272 uint32_t mMaxDisableWaitCnt; // maximum grace period before forcing an effect off after 1273 // sending disable command. 1274 uint32_t mDisableWaitCnt; // current process() calls count during disable period. 1275 bool mSuspended; // effect is suspended: temporarily disabled by framework 1276 }; 1277 1278 // The EffectHandle class implements the IEffect interface. It provides resources 1279 // to receive parameter updates, keeps track of effect control 1280 // ownership and state and has a pointer to the EffectModule object it is controlling. 1281 // There is one EffectHandle object for each application controlling (or using) 1282 // an effect module. 1283 // The EffectHandle is obtained by calling AudioFlinger::createEffect(). 1284 class EffectHandle: public android::BnEffect { 1285 public: 1286 1287 EffectHandle(const sp<EffectModule>& effect, 1288 const sp<AudioFlinger::Client>& client, 1289 const sp<IEffectClient>& effectClient, 1290 int32_t priority); 1291 virtual ~EffectHandle(); 1292 1293 // IEffect 1294 virtual status_t enable(); 1295 virtual status_t disable(); 1296 virtual status_t command(uint32_t cmdCode, 1297 uint32_t cmdSize, 1298 void *pCmdData, 1299 uint32_t *replySize, 1300 void *pReplyData); 1301 virtual void disconnect(); 1302 private: 1303 void disconnect(bool unpinIfLast); 1304 public: 1305 virtual sp<IMemory> getCblk() const { return mCblkMemory; } 1306 virtual status_t onTransact(uint32_t code, const Parcel& data, 1307 Parcel* reply, uint32_t flags); 1308 1309 1310 // Give or take control of effect module 1311 // - hasControl: true if control is given, false if removed 1312 // - signal: true client app should be signaled of change, false otherwise 1313 // - enabled: state of the effect when control is passed 1314 void setControl(bool hasControl, bool signal, bool enabled); 1315 void commandExecuted(uint32_t cmdCode, 1316 uint32_t cmdSize, 1317 void *pCmdData, 1318 uint32_t replySize, 1319 void *pReplyData); 1320 void setEnabled(bool enabled); 1321 bool enabled() const { return mEnabled; } 1322 1323 // Getters 1324 int id() const { return mEffect->id(); } 1325 int priority() const { return mPriority; } 1326 bool hasControl() const { return mHasControl; } 1327 sp<EffectModule> effect() const { return mEffect; } 1328 1329 void dump(char* buffer, size_t size); 1330 1331 protected: 1332 friend class AudioFlinger; 1333 friend class EffectModule; 1334 EffectHandle(const EffectHandle&); 1335 EffectHandle& operator =(const EffectHandle&); 1336 1337 sp<EffectModule> mEffect; // pointer to controlled EffectModule 1338 sp<IEffectClient> mEffectClient; // callback interface for client notifications 1339 /*const*/ sp<Client> mClient; // client for shared memory allocation, see disconnect() 1340 sp<IMemory> mCblkMemory; // shared memory for control block 1341 effect_param_cblk_t* mCblk; // control block for deferred parameter setting via shared memory 1342 uint8_t* mBuffer; // pointer to parameter area in shared memory 1343 int mPriority; // client application priority to control the effect 1344 bool mHasControl; // true if this handle is controlling the effect 1345 bool mEnabled; // cached enable state: needed when the effect is 1346 // restored after being suspended 1347 }; 1348 1349 // the EffectChain class represents a group of effects associated to one audio session. 1350 // There can be any number of EffectChain objects per output mixer thread (PlaybackThread). 1351 // The EffecChain with session ID 0 contains global effects applied to the output mix. 1352 // Effects in this chain can be insert or auxiliary. Effects in other chains (attached to tracks) 1353 // are insert only. The EffectChain maintains an ordered list of effect module, the order corresponding 1354 // in the effect process order. When attached to a track (session ID != 0), it also provide it's own 1355 // input buffer used by the track as accumulation buffer. 1356 class EffectChain: public RefBase { 1357 public: 1358 EffectChain(const wp<ThreadBase>& wThread, int sessionId); 1359 EffectChain(ThreadBase *thread, int sessionId); 1360 virtual ~EffectChain(); 1361 1362 // special key used for an entry in mSuspendedEffects keyed vector 1363 // corresponding to a suspend all request. 1364 static const int kKeyForSuspendAll = 0; 1365 1366 // minimum duration during which we force calling effect process when last track on 1367 // a session is stopped or removed to allow effect tail to be rendered 1368 static const int kProcessTailDurationMs = 1000; 1369 1370 void process_l(); 1371 1372 void lock() { 1373 mLock.lock(); 1374 } 1375 void unlock() { 1376 mLock.unlock(); 1377 } 1378 1379 status_t addEffect_l(const sp<EffectModule>& handle); 1380 size_t removeEffect_l(const sp<EffectModule>& handle); 1381 1382 int sessionId() const { return mSessionId; } 1383 void setSessionId(int sessionId) { mSessionId = sessionId; } 1384 1385 sp<EffectModule> getEffectFromDesc_l(effect_descriptor_t *descriptor); 1386 sp<EffectModule> getEffectFromId_l(int id); 1387 sp<EffectModule> getEffectFromType_l(const effect_uuid_t *type); 1388 bool setVolume_l(uint32_t *left, uint32_t *right); 1389 void setDevice_l(uint32_t device); 1390 void setMode_l(audio_mode_t mode); 1391 1392 void setInBuffer(int16_t *buffer, bool ownsBuffer = false) { 1393 mInBuffer = buffer; 1394 mOwnInBuffer = ownsBuffer; 1395 } 1396 int16_t *inBuffer() const { 1397 return mInBuffer; 1398 } 1399 void setOutBuffer(int16_t *buffer) { 1400 mOutBuffer = buffer; 1401 } 1402 int16_t *outBuffer() const { 1403 return mOutBuffer; 1404 } 1405 1406 void incTrackCnt() { android_atomic_inc(&mTrackCnt); } 1407 void decTrackCnt() { android_atomic_dec(&mTrackCnt); } 1408 int32_t trackCnt() const { return mTrackCnt;} 1409 1410 void incActiveTrackCnt() { android_atomic_inc(&mActiveTrackCnt); 1411 mTailBufferCount = mMaxTailBuffers; } 1412 void decActiveTrackCnt() { android_atomic_dec(&mActiveTrackCnt); } 1413 int32_t activeTrackCnt() const { return mActiveTrackCnt;} 1414 1415 uint32_t strategy() const { return mStrategy; } 1416 void setStrategy(uint32_t strategy) 1417 { mStrategy = strategy; } 1418 1419 // suspend effect of the given type 1420 void setEffectSuspended_l(const effect_uuid_t *type, 1421 bool suspend); 1422 // suspend all eligible effects 1423 void setEffectSuspendedAll_l(bool suspend); 1424 // check if effects should be suspend or restored when a given effect is enable or disabled 1425 void checkSuspendOnEffectEnabled(const sp<EffectModule>& effect, 1426 bool enabled); 1427 1428 status_t dump(int fd, const Vector<String16>& args); 1429 1430 protected: 1431 friend class AudioFlinger; 1432 EffectChain(const EffectChain&); 1433 EffectChain& operator =(const EffectChain&); 1434 1435 class SuspendedEffectDesc : public RefBase { 1436 public: 1437 SuspendedEffectDesc() : mRefCount(0) {} 1438 1439 int mRefCount; 1440 effect_uuid_t mType; 1441 wp<EffectModule> mEffect; 1442 }; 1443 1444 // get a list of effect modules to suspend when an effect of the type 1445 // passed is enabled. 1446 void getSuspendEligibleEffects(Vector< sp<EffectModule> > &effects); 1447 1448 // get an effect module if it is currently enable 1449 sp<EffectModule> getEffectIfEnabled(const effect_uuid_t *type); 1450 // true if the effect whose descriptor is passed can be suspended 1451 // OEMs can modify the rules implemented in this method to exclude specific effect 1452 // types or implementations from the suspend/restore mechanism. 1453 bool isEffectEligibleForSuspend(const effect_descriptor_t& desc); 1454 1455 wp<ThreadBase> mThread; // parent mixer thread 1456 Mutex mLock; // mutex protecting effect list 1457 Vector<sp<EffectModule> > mEffects; // list of effect modules 1458 int mSessionId; // audio session ID 1459 int16_t *mInBuffer; // chain input buffer 1460 int16_t *mOutBuffer; // chain output buffer 1461 volatile int32_t mActiveTrackCnt; // number of active tracks connected 1462 volatile int32_t mTrackCnt; // number of tracks connected 1463 int32_t mTailBufferCount; // current effect tail buffer count 1464 int32_t mMaxTailBuffers; // maximum effect tail buffers 1465 bool mOwnInBuffer; // true if the chain owns its input buffer 1466 int mVolumeCtrlIdx; // index of insert effect having control over volume 1467 uint32_t mLeftVolume; // previous volume on left channel 1468 uint32_t mRightVolume; // previous volume on right channel 1469 uint32_t mNewLeftVolume; // new volume on left channel 1470 uint32_t mNewRightVolume; // new volume on right channel 1471 uint32_t mStrategy; // strategy for this effect chain 1472 // mSuspendedEffects lists all effect currently suspended in the chain 1473 // use effect type UUID timelow field as key. There is no real risk of identical 1474 // timeLow fields among effect type UUIDs. 1475 KeyedVector< int, sp<SuspendedEffectDesc> > mSuspendedEffects; 1476 }; 1477 1478 // AudioStreamOut and AudioStreamIn are immutable, so their fields are const. 1479 // For emphasis, we could also make all pointers to them be "const *", 1480 // but that would clutter the code unnecessarily. 1481 1482 struct AudioStreamOut { 1483 audio_hw_device_t* const hwDev; 1484 audio_stream_out_t* const stream; 1485 1486 AudioStreamOut(audio_hw_device_t *dev, audio_stream_out_t *out) : 1487 hwDev(dev), stream(out) {} 1488 }; 1489 1490 struct AudioStreamIn { 1491 audio_hw_device_t* const hwDev; 1492 audio_stream_in_t* const stream; 1493 1494 AudioStreamIn(audio_hw_device_t *dev, audio_stream_in_t *in) : 1495 hwDev(dev), stream(in) {} 1496 }; 1497 1498 // for mAudioSessionRefs only 1499 struct AudioSessionRef { 1500 // FIXME rename parameter names when fields get "m" prefix 1501 AudioSessionRef(int sessionid_, pid_t pid_) : 1502 sessionid(sessionid_), pid(pid_), cnt(1) {} 1503 const int sessionid; 1504 const pid_t pid; 1505 int cnt; 1506 }; 1507 1508 friend class RecordThread; 1509 friend class PlaybackThread; 1510 1511 enum master_volume_support { 1512 // MVS_NONE: 1513 // Audio HAL has no support for master volume, either setting or 1514 // getting. All master volume control must be implemented in SW by the 1515 // AudioFlinger mixing core. 1516 MVS_NONE, 1517 1518 // MVS_SETONLY: 1519 // Audio HAL has support for setting master volume, but not for getting 1520 // master volume (original HAL design did not include a getter). 1521 // AudioFlinger needs to keep track of the last set master volume in 1522 // addition to needing to set an initial, default, master volume at HAL 1523 // load time. 1524 MVS_SETONLY, 1525 1526 // MVS_FULL: 1527 // Audio HAL has support both for setting and getting master volume. 1528 // AudioFlinger should send all set and get master volume requests 1529 // directly to the HAL. 1530 MVS_FULL, 1531 }; 1532 1533 mutable Mutex mLock; 1534 1535 DefaultKeyedVector< pid_t, wp<Client> > mClients; // see ~Client() 1536 1537 mutable Mutex mHardwareLock; 1538 1539 // These two fields are immutable after onFirstRef(), so no lock needed to access 1540 audio_hw_device_t* mPrimaryHardwareDev; // mAudioHwDevs[0] or NULL 1541 Vector<audio_hw_device_t*> mAudioHwDevs; 1542 1543 // for dump, indicates which hardware operation is currently in progress (but not stream ops) 1544 enum hardware_call_state { 1545 AUDIO_HW_IDLE = 0, // no operation in progress 1546 AUDIO_HW_INIT, // init_check 1547 AUDIO_HW_OUTPUT_OPEN, // open_output_stream 1548 AUDIO_HW_OUTPUT_CLOSE, // unused 1549 AUDIO_HW_INPUT_OPEN, // unused 1550 AUDIO_HW_INPUT_CLOSE, // unused 1551 AUDIO_HW_STANDBY, // unused 1552 AUDIO_HW_SET_MASTER_VOLUME, // set_master_volume 1553 AUDIO_HW_GET_ROUTING, // unused 1554 AUDIO_HW_SET_ROUTING, // unused 1555 AUDIO_HW_GET_MODE, // unused 1556 AUDIO_HW_SET_MODE, // set_mode 1557 AUDIO_HW_GET_MIC_MUTE, // get_mic_mute 1558 AUDIO_HW_SET_MIC_MUTE, // set_mic_mute 1559 AUDIO_HW_SET_VOICE_VOLUME, // set_voice_volume 1560 AUDIO_HW_SET_PARAMETER, // set_parameters 1561 AUDIO_HW_GET_INPUT_BUFFER_SIZE, // get_input_buffer_size 1562 AUDIO_HW_GET_MASTER_VOLUME, // get_master_volume 1563 AUDIO_HW_GET_PARAMETER, // get_parameters 1564 }; 1565 1566 mutable hardware_call_state mHardwareStatus; // for dump only 1567 1568 1569 DefaultKeyedVector< audio_io_handle_t, sp<PlaybackThread> > mPlaybackThreads; 1570 stream_type_t mStreamTypes[AUDIO_STREAM_CNT]; 1571 1572 // both are protected by mLock 1573 float mMasterVolume; 1574 float mMasterVolumeSW; 1575 master_volume_support mMasterVolumeSupportLvl; 1576 bool mMasterMute; 1577 1578 DefaultKeyedVector< audio_io_handle_t, sp<RecordThread> > mRecordThreads; 1579 1580 DefaultKeyedVector< pid_t, sp<NotificationClient> > mNotificationClients; 1581 volatile int32_t mNextUniqueId; // updated by android_atomic_inc 1582 audio_mode_t mMode; 1583 bool mBtNrecIsOff; 1584 1585 // protected by mLock 1586 Vector<AudioSessionRef*> mAudioSessionRefs; 1587 1588 float masterVolume_l() const; 1589 float masterVolumeSW_l() const { return mMasterVolumeSW; } 1590 bool masterMute_l() const { return mMasterMute; } 1591 1592private: 1593 sp<Client> registerPid_l(pid_t pid); // always returns non-0 1594 1595}; 1596 1597 1598// ---------------------------------------------------------------------------- 1599 1600}; // namespace android 1601 1602#endif // ANDROID_AUDIO_FLINGER_H 1603