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