AudioFlinger.h revision b8ba0a979067a4efb0b3819bf17770793e41c15e
1/* //device/include/server/AudioFlinger/AudioFlinger.h 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 <media/IAudioFlinger.h> 26#include <media/IAudioFlingerClient.h> 27#include <media/IAudioTrack.h> 28#include <media/IAudioRecord.h> 29#include <media/AudioTrack.h> 30 31#include <utils/Atomic.h> 32#include <utils/Errors.h> 33#include <utils/threads.h> 34#include <utils/SortedVector.h> 35#include <utils/TypeHelpers.h> 36#include <utils/Vector.h> 37 38#include <binder/BinderService.h> 39#include <binder/MemoryDealer.h> 40 41#include <system/audio.h> 42#include <hardware/audio.h> 43 44#include "AudioBufferProvider.h" 45 46#include <powermanager/IPowerManager.h> 47 48namespace android { 49 50class audio_track_cblk_t; 51class effect_param_cblk_t; 52class AudioMixer; 53class AudioBuffer; 54class AudioResampler; 55 56// ---------------------------------------------------------------------------- 57 58#define LIKELY( exp ) (__builtin_expect( (exp) != 0, true )) 59#define UNLIKELY( exp ) (__builtin_expect( (exp) != 0, false )) 60 61 62// ---------------------------------------------------------------------------- 63 64static const nsecs_t kStandbyTimeInNsecs = seconds(3); 65 66class AudioFlinger : 67 public BinderService<AudioFlinger>, 68 public BnAudioFlinger 69{ 70 friend class BinderService<AudioFlinger>; 71public: 72 static char const* getServiceName() { return "media.audio_flinger"; } 73 74 virtual status_t dump(int fd, const Vector<String16>& args); 75 76 // IAudioFlinger interface 77 virtual sp<IAudioTrack> createTrack( 78 pid_t pid, 79 int streamType, 80 uint32_t sampleRate, 81 uint32_t format, 82 uint32_t channelMask, 83 int frameCount, 84 uint32_t flags, 85 const sp<IMemory>& sharedBuffer, 86 int output, 87 int *sessionId, 88 status_t *status); 89 90 virtual uint32_t sampleRate(int output) const; 91 virtual int channelCount(int output) const; 92 virtual uint32_t format(int output) const; 93 virtual size_t frameCount(int output) const; 94 virtual uint32_t latency(int output) const; 95 96 virtual status_t setMasterVolume(float value); 97 virtual status_t setMasterMute(bool muted); 98 99 virtual float masterVolume() const; 100 virtual bool masterMute() const; 101 102 virtual status_t setStreamVolume(int stream, float value, int output); 103 virtual status_t setStreamMute(int stream, bool muted); 104 105 virtual float streamVolume(int stream, int output) const; 106 virtual bool streamMute(int stream) const; 107 108 virtual status_t setMode(int mode); 109 110 virtual status_t setMicMute(bool state); 111 virtual bool getMicMute() const; 112 113 virtual status_t setParameters(int ioHandle, const String8& keyValuePairs); 114 virtual String8 getParameters(int ioHandle, const String8& keys); 115 116 virtual void registerClient(const sp<IAudioFlingerClient>& client); 117 118 virtual size_t getInputBufferSize(uint32_t sampleRate, int format, int channelCount); 119 virtual unsigned int getInputFramesLost(int ioHandle); 120 121 virtual int openOutput(uint32_t *pDevices, 122 uint32_t *pSamplingRate, 123 uint32_t *pFormat, 124 uint32_t *pChannels, 125 uint32_t *pLatencyMs, 126 uint32_t flags); 127 128 virtual int openDuplicateOutput(int output1, int output2); 129 130 virtual status_t closeOutput(int output); 131 132 virtual status_t suspendOutput(int output); 133 134 virtual status_t restoreOutput(int output); 135 136 virtual int openInput(uint32_t *pDevices, 137 uint32_t *pSamplingRate, 138 uint32_t *pFormat, 139 uint32_t *pChannels, 140 uint32_t acoustics); 141 142 virtual status_t closeInput(int input); 143 144 virtual status_t setStreamOutput(uint32_t stream, int output); 145 146 virtual status_t setVoiceVolume(float volume); 147 148 virtual status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames, int output); 149 150 virtual int newAudioSessionId(); 151 152 virtual status_t queryNumberEffects(uint32_t *numEffects); 153 154 virtual status_t queryEffect(uint32_t index, effect_descriptor_t *descriptor); 155 156 virtual status_t getEffectDescriptor(effect_uuid_t *pUuid, effect_descriptor_t *descriptor); 157 158 virtual sp<IEffect> createEffect(pid_t pid, 159 effect_descriptor_t *pDesc, 160 const sp<IEffectClient>& effectClient, 161 int32_t priority, 162 int io, 163 int sessionId, 164 status_t *status, 165 int *id, 166 int *enabled); 167 168 virtual status_t moveEffects(int session, int srcOutput, int dstOutput); 169 170 enum hardware_call_state { 171 AUDIO_HW_IDLE = 0, 172 AUDIO_HW_INIT, 173 AUDIO_HW_OUTPUT_OPEN, 174 AUDIO_HW_OUTPUT_CLOSE, 175 AUDIO_HW_INPUT_OPEN, 176 AUDIO_HW_INPUT_CLOSE, 177 AUDIO_HW_STANDBY, 178 AUDIO_HW_SET_MASTER_VOLUME, 179 AUDIO_HW_GET_ROUTING, 180 AUDIO_HW_SET_ROUTING, 181 AUDIO_HW_GET_MODE, 182 AUDIO_HW_SET_MODE, 183 AUDIO_HW_GET_MIC_MUTE, 184 AUDIO_HW_SET_MIC_MUTE, 185 AUDIO_SET_VOICE_VOLUME, 186 AUDIO_SET_PARAMETER, 187 }; 188 189 // record interface 190 virtual sp<IAudioRecord> openRecord( 191 pid_t pid, 192 int input, 193 uint32_t sampleRate, 194 uint32_t format, 195 uint32_t channelMask, 196 int frameCount, 197 uint32_t flags, 198 int *sessionId, 199 status_t *status); 200 201 virtual status_t onTransact( 202 uint32_t code, 203 const Parcel& data, 204 Parcel* reply, 205 uint32_t flags); 206 207 uint32_t getMode() { return mMode; } 208 209private: 210 AudioFlinger(); 211 virtual ~AudioFlinger(); 212 213 status_t initCheck() const; 214 virtual void onFirstRef(); 215 audio_hw_device_t* findSuitableHwDev_l(uint32_t devices); 216 217 // Internal dump utilites. 218 status_t dumpPermissionDenial(int fd, const Vector<String16>& args); 219 status_t dumpClients(int fd, const Vector<String16>& args); 220 status_t dumpInternals(int fd, const Vector<String16>& args); 221 222 // --- Client --- 223 class Client : public RefBase { 224 public: 225 Client(const sp<AudioFlinger>& audioFlinger, pid_t pid); 226 virtual ~Client(); 227 const sp<MemoryDealer>& heap() const; 228 pid_t pid() const { return mPid; } 229 sp<AudioFlinger> audioFlinger() { return mAudioFlinger; } 230 231 private: 232 Client(const Client&); 233 Client& operator = (const Client&); 234 sp<AudioFlinger> mAudioFlinger; 235 sp<MemoryDealer> mMemoryDealer; 236 pid_t mPid; 237 }; 238 239 // --- Notification Client --- 240 class NotificationClient : public IBinder::DeathRecipient { 241 public: 242 NotificationClient(const sp<AudioFlinger>& audioFlinger, 243 const sp<IAudioFlingerClient>& client, 244 pid_t pid); 245 virtual ~NotificationClient(); 246 247 sp<IAudioFlingerClient> client() { return mClient; } 248 249 // IBinder::DeathRecipient 250 virtual void binderDied(const wp<IBinder>& who); 251 252 private: 253 NotificationClient(const NotificationClient&); 254 NotificationClient& operator = (const NotificationClient&); 255 256 sp<AudioFlinger> mAudioFlinger; 257 pid_t mPid; 258 sp<IAudioFlingerClient> mClient; 259 }; 260 261 class TrackHandle; 262 class RecordHandle; 263 class RecordThread; 264 class PlaybackThread; 265 class MixerThread; 266 class DirectOutputThread; 267 class DuplicatingThread; 268 class Track; 269 class RecordTrack; 270 class EffectModule; 271 class EffectHandle; 272 class EffectChain; 273 struct AudioStreamOut; 274 struct AudioStreamIn; 275 276 class ThreadBase : public Thread { 277 public: 278 ThreadBase (const sp<AudioFlinger>& audioFlinger, int id, uint32_t device); 279 virtual ~ThreadBase(); 280 281 282 enum type { 283 MIXER, // Thread class is MixerThread 284 DIRECT, // Thread class is DirectOutputThread 285 DUPLICATING, // Thread class is DuplicatingThread 286 RECORD // Thread class is RecordThread 287 }; 288 289 status_t dumpBase(int fd, const Vector<String16>& args); 290 status_t dumpEffectChains(int fd, const Vector<String16>& args); 291 292 void clearPowerManager(); 293 294 // base for record and playback 295 class TrackBase : public AudioBufferProvider, public RefBase { 296 297 public: 298 enum track_state { 299 IDLE, 300 TERMINATED, 301 STOPPED, 302 RESUMING, 303 ACTIVE, 304 PAUSING, 305 PAUSED 306 }; 307 308 enum track_flags { 309 STEPSERVER_FAILED = 0x01, // StepServer could not acquire cblk->lock mutex 310 SYSTEM_FLAGS_MASK = 0x0000ffffUL, 311 // The upper 16 bits are used for track-specific flags. 312 }; 313 314 TrackBase(const wp<ThreadBase>& thread, 315 const sp<Client>& client, 316 uint32_t sampleRate, 317 uint32_t format, 318 uint32_t channelMask, 319 int frameCount, 320 uint32_t flags, 321 const sp<IMemory>& sharedBuffer, 322 int sessionId); 323 ~TrackBase(); 324 325 virtual status_t start() = 0; 326 virtual void stop() = 0; 327 sp<IMemory> getCblk() const; 328 audio_track_cblk_t* cblk() const { return mCblk; } 329 int sessionId() { return mSessionId; } 330 331 protected: 332 friend class ThreadBase; 333 friend class RecordHandle; 334 friend class PlaybackThread; 335 friend class RecordThread; 336 friend class MixerThread; 337 friend class DirectOutputThread; 338 339 TrackBase(const TrackBase&); 340 TrackBase& operator = (const TrackBase&); 341 342 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer) = 0; 343 virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer); 344 345 uint32_t format() const { 346 return mFormat; 347 } 348 349 int channelCount() const ; 350 351 uint32_t channelMask() const; 352 353 int sampleRate() const; 354 355 void* getBuffer(uint32_t offset, uint32_t frames) const; 356 357 bool isStopped() const { 358 return mState == STOPPED; 359 } 360 361 bool isTerminated() const { 362 return mState == TERMINATED; 363 } 364 365 bool step(); 366 void reset(); 367 368 wp<ThreadBase> mThread; 369 sp<Client> mClient; 370 sp<IMemory> mCblkMemory; 371 audio_track_cblk_t* mCblk; 372 void* mBuffer; 373 void* mBufferEnd; 374 uint32_t mFrameCount; 375 // we don't really need a lock for these 376 int mState; 377 int mClientTid; 378 uint32_t mFormat; 379 uint32_t mFlags; 380 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 int type() const { return mType; } 410 uint32_t sampleRate() const; 411 int channelCount() const; 412 uint32_t format() const; 413 size_t frameCount() const; 414 void wakeUp() { mWaitWorkCV.broadcast(); } 415 void exit(); 416 virtual bool checkForNewParameters_l() = 0; 417 virtual status_t setParameters(const String8& keyValuePairs); 418 virtual String8 getParameters(const String8& keys) = 0; 419 virtual void audioConfigChanged_l(int event, int param = 0) = 0; 420 void sendConfigEvent(int event, int param = 0); 421 void sendConfigEvent_l(int event, int param = 0); 422 void processConfigEvents(); 423 int id() const { return mId;} 424 bool standby() { return mStandby; } 425 uint32_t device() { return mDevice; } 426 virtual audio_stream_t* stream() = 0; 427 428 sp<EffectHandle> createEffect_l( 429 const sp<AudioFlinger::Client>& client, 430 const sp<IEffectClient>& effectClient, 431 int32_t priority, 432 int sessionId, 433 effect_descriptor_t *desc, 434 int *enabled, 435 status_t *status); 436 void disconnectEffect(const sp< EffectModule>& effect, 437 const wp<EffectHandle>& handle); 438 439 // return values for hasAudioSession (bit field) 440 enum effect_state { 441 EFFECT_SESSION = 0x1, // the audio session corresponds to at least one 442 // effect 443 TRACK_SESSION = 0x2 // the audio session corresponds to at least one 444 // track 445 }; 446 447 // get effect chain corresponding to session Id. 448 sp<EffectChain> getEffectChain(int sessionId); 449 // same as getEffectChain() but must be called with ThreadBase mutex locked 450 sp<EffectChain> getEffectChain_l(int sessionId); 451 // add an effect chain to the chain list (mEffectChains) 452 virtual status_t addEffectChain_l(const sp<EffectChain>& chain) = 0; 453 // remove an effect chain from the chain list (mEffectChains) 454 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain) = 0; 455 // lock mall effect chains Mutexes. Must be called before releasing the 456 // ThreadBase mutex before processing the mixer and effects. This guarantees the 457 // integrity of the chains during the process. 458 void lockEffectChains_l(Vector<sp <EffectChain> >& effectChains); 459 // unlock effect chains after process 460 void unlockEffectChains(Vector<sp <EffectChain> >& effectChains); 461 // set audio mode to all effect chains 462 void setMode(uint32_t mode); 463 // get effect module with corresponding ID on specified audio session 464 sp<AudioFlinger::EffectModule> getEffect_l(int sessionId, int effectId); 465 // add and effect module. Also creates the effect chain is none exists for 466 // the effects audio session 467 status_t addEffect_l(const sp< EffectModule>& effect); 468 // remove and effect module. Also removes the effect chain is this was the last 469 // effect 470 void removeEffect_l(const sp< EffectModule>& effect); 471 // detach all tracks connected to an auxiliary effect 472 virtual void detachAuxEffect_l(int effectId) {} 473 // returns either EFFECT_SESSION if effects on this audio session exist in one 474 // chain, or TRACK_SESSION if tracks on this audio session exist, or both 475 virtual uint32_t hasAudioSession(int sessionId) = 0; 476 // the value returned by default implementation is not important as the 477 // strategy is only meaningful for PlaybackThread which implements this method 478 virtual uint32_t getStrategyForSession_l(int sessionId) { return 0; } 479 480 mutable Mutex mLock; 481 482 protected: 483 484 void acquireWakeLock(); 485 void acquireWakeLock_l(); 486 void releaseWakeLock(); 487 void releaseWakeLock_l(); 488 489 friend class Track; 490 friend class TrackBase; 491 friend class PlaybackThread; 492 friend class MixerThread; 493 friend class DirectOutputThread; 494 friend class DuplicatingThread; 495 friend class RecordThread; 496 friend class RecordTrack; 497 498 int mType; 499 Condition mWaitWorkCV; 500 sp<AudioFlinger> mAudioFlinger; 501 uint32_t mSampleRate; 502 size_t mFrameCount; 503 uint32_t mChannelMask; 504 uint16_t mChannelCount; 505 uint16_t mFrameSize; 506 uint32_t mFormat; 507 Condition mParamCond; 508 Vector<String8> mNewParameters; 509 status_t mParamStatus; 510 Vector<ConfigEvent *> mConfigEvents; 511 bool mStandby; 512 int mId; 513 bool mExiting; 514 Vector< sp<EffectChain> > mEffectChains; 515 uint32_t mDevice; // output device for PlaybackThread 516 // input + output devices for RecordThread 517 static const int kNameLength = 32; 518 char mName[kNameLength]; 519 sp<IPowerManager> mPowerManager; 520 sp<IBinder> mWakeLockToken; 521 sp<PMDeathRecipient> mDeathRecipient; 522 }; 523 524 // --- PlaybackThread --- 525 class PlaybackThread : public ThreadBase { 526 public: 527 528 enum mixer_state { 529 MIXER_IDLE, 530 MIXER_TRACKS_ENABLED, 531 MIXER_TRACKS_READY 532 }; 533 534 // playback track 535 class Track : public TrackBase { 536 public: 537 Track( const wp<ThreadBase>& thread, 538 const sp<Client>& client, 539 int streamType, 540 uint32_t sampleRate, 541 uint32_t format, 542 uint32_t channelMask, 543 int frameCount, 544 const sp<IMemory>& sharedBuffer, 545 int sessionId); 546 ~Track(); 547 548 void dump(char* buffer, size_t size); 549 virtual status_t start(); 550 virtual void stop(); 551 void pause(); 552 553 void flush(); 554 void destroy(); 555 void mute(bool); 556 void setVolume(float left, float right); 557 int name() const { 558 return mName; 559 } 560 561 int type() const { 562 return mStreamType; 563 } 564 status_t attachAuxEffect(int EffectId); 565 void setAuxBuffer(int EffectId, int32_t *buffer); 566 int32_t *auxBuffer() { return mAuxBuffer; } 567 void setMainBuffer(int16_t *buffer) { mMainBuffer = buffer; } 568 int16_t *mainBuffer() { return mMainBuffer; } 569 int auxEffectId() { return mAuxEffectId; } 570 571 572 protected: 573 friend class ThreadBase; 574 friend class AudioFlinger; 575 friend class TrackHandle; 576 friend class PlaybackThread; 577 friend class MixerThread; 578 friend class DirectOutputThread; 579 580 Track(const Track&); 581 Track& operator = (const Track&); 582 583 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer); 584 bool isMuted() { return mMute; } 585 bool isPausing() const { 586 return mState == PAUSING; 587 } 588 bool isPaused() const { 589 return mState == PAUSED; 590 } 591 bool isReady() const; 592 void setPaused() { mState = PAUSED; } 593 void reset(); 594 595 bool isOutputTrack() const { 596 return (mStreamType == AUDIO_STREAM_CNT); 597 } 598 599 // we don't really need a lock for these 600 float mVolume[2]; 601 volatile bool mMute; 602 // FILLED state is used for suppressing volume ramp at begin of playing 603 enum {FS_FILLING, FS_FILLED, FS_ACTIVE}; 604 mutable uint8_t mFillingUpStatus; 605 int8_t mRetryCount; 606 sp<IMemory> mSharedBuffer; 607 bool mResetDone; 608 int mStreamType; 609 int mName; 610 int16_t *mMainBuffer; 611 int32_t *mAuxBuffer; 612 int mAuxEffectId; 613 bool mHasVolumeController; 614 }; // end of Track 615 616 617 // playback track 618 class OutputTrack : public Track { 619 public: 620 621 class Buffer: public AudioBufferProvider::Buffer { 622 public: 623 int16_t *mBuffer; 624 }; 625 626 OutputTrack( const wp<ThreadBase>& thread, 627 DuplicatingThread *sourceThread, 628 uint32_t sampleRate, 629 uint32_t format, 630 uint32_t channelMask, 631 int frameCount); 632 ~OutputTrack(); 633 634 virtual status_t start(); 635 virtual void stop(); 636 bool write(int16_t* data, uint32_t frames); 637 bool bufferQueueEmpty() { return (mBufferQueue.size() == 0) ? true : false; } 638 bool isActive() { return mActive; } 639 wp<ThreadBase>& thread() { return mThread; } 640 641 private: 642 643 status_t obtainBuffer(AudioBufferProvider::Buffer* buffer, uint32_t waitTimeMs); 644 void clearBufferQueue(); 645 646 // Maximum number of pending buffers allocated by OutputTrack::write() 647 static const uint8_t kMaxOverFlowBuffers = 10; 648 649 Vector < Buffer* > mBufferQueue; 650 AudioBufferProvider::Buffer mOutBuffer; 651 bool mActive; 652 DuplicatingThread* mSourceThread; 653 }; // end of OutputTrack 654 655 PlaybackThread (const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, int id, uint32_t device); 656 virtual ~PlaybackThread(); 657 658 virtual status_t dump(int fd, const Vector<String16>& args); 659 660 // Thread virtuals 661 virtual status_t readyToRun(); 662 virtual void onFirstRef(); 663 664 virtual status_t initCheck() const { return (mOutput == 0) ? NO_INIT : NO_ERROR; } 665 666 virtual uint32_t latency() const; 667 668 virtual status_t setMasterVolume(float value); 669 virtual status_t setMasterMute(bool muted); 670 671 virtual float masterVolume() const; 672 virtual bool masterMute() const; 673 674 virtual status_t setStreamVolume(int stream, float value); 675 virtual status_t setStreamMute(int stream, bool muted); 676 677 virtual float streamVolume(int stream) const; 678 virtual bool streamMute(int stream) const; 679 680 sp<Track> createTrack_l( 681 const sp<AudioFlinger::Client>& client, 682 int streamType, 683 uint32_t sampleRate, 684 uint32_t format, 685 uint32_t channelMask, 686 int frameCount, 687 const sp<IMemory>& sharedBuffer, 688 int sessionId, 689 status_t *status); 690 691 AudioStreamOut* getOutput(); 692 AudioStreamOut* clearOutput(); 693 virtual audio_stream_t* stream(); 694 695 void suspend() { mSuspended++; } 696 void restore() { if (mSuspended) mSuspended--; } 697 bool isSuspended() { return (mSuspended != 0); } 698 virtual String8 getParameters(const String8& keys); 699 virtual void audioConfigChanged_l(int event, int param = 0); 700 virtual status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames); 701 int16_t *mixBuffer() { return mMixBuffer; }; 702 703 virtual void detachAuxEffect_l(int effectId); 704 status_t attachAuxEffect(const sp<AudioFlinger::PlaybackThread::Track> track, 705 int EffectId); 706 status_t attachAuxEffect_l(const sp<AudioFlinger::PlaybackThread::Track> track, 707 int EffectId); 708 709 virtual status_t addEffectChain_l(const sp<EffectChain>& chain); 710 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain); 711 virtual uint32_t hasAudioSession(int sessionId); 712 virtual uint32_t getStrategyForSession_l(int sessionId); 713 714 struct stream_type_t { 715 stream_type_t() 716 : volume(1.0f), 717 mute(false) 718 { 719 } 720 float volume; 721 bool mute; 722 }; 723 724 protected: 725 int16_t* mMixBuffer; 726 int mSuspended; 727 int mBytesWritten; 728 bool mMasterMute; 729 SortedVector< wp<Track> > mActiveTracks; 730 731 virtual int getTrackName_l() = 0; 732 virtual void deleteTrackName_l(int name) = 0; 733 virtual uint32_t activeSleepTimeUs() = 0; 734 virtual uint32_t idleSleepTimeUs() = 0; 735 virtual uint32_t suspendSleepTimeUs() = 0; 736 737 private: 738 739 friend class AudioFlinger; 740 friend class OutputTrack; 741 friend class Track; 742 friend class TrackBase; 743 friend class MixerThread; 744 friend class DirectOutputThread; 745 friend class DuplicatingThread; 746 747 PlaybackThread(const Client&); 748 PlaybackThread& operator = (const PlaybackThread&); 749 750 status_t addTrack_l(const sp<Track>& track); 751 void destroyTrack_l(const sp<Track>& track); 752 void removeTrack_l(const sp<Track>& track); 753 754 void readOutputParameters(); 755 756 virtual status_t dumpInternals(int fd, const Vector<String16>& args); 757 status_t dumpTracks(int fd, const Vector<String16>& args); 758 759 SortedVector< sp<Track> > mTracks; 760 // mStreamTypes[] uses 1 additionnal stream type internally for the OutputTrack used by DuplicatingThread 761 stream_type_t mStreamTypes[AUDIO_STREAM_CNT + 1]; 762 AudioStreamOut* mOutput; 763 float mMasterVolume; 764 nsecs_t mLastWriteTime; 765 int mNumWrites; 766 int mNumDelayedWrites; 767 bool mInWrite; 768 }; 769 770 class MixerThread : public PlaybackThread { 771 public: 772 MixerThread (const sp<AudioFlinger>& audioFlinger, 773 AudioStreamOut* output, 774 int id, 775 uint32_t device); 776 virtual ~MixerThread(); 777 778 // Thread virtuals 779 virtual bool threadLoop(); 780 781 void invalidateTracks(int streamType); 782 virtual bool checkForNewParameters_l(); 783 virtual status_t dumpInternals(int fd, const Vector<String16>& args); 784 785 protected: 786 uint32_t prepareTracks_l(const SortedVector< wp<Track> >& activeTracks, 787 Vector< sp<Track> > *tracksToRemove); 788 virtual int getTrackName_l(); 789 virtual void deleteTrackName_l(int name); 790 virtual uint32_t activeSleepTimeUs(); 791 virtual uint32_t idleSleepTimeUs(); 792 virtual uint32_t suspendSleepTimeUs(); 793 794 AudioMixer* mAudioMixer; 795 }; 796 797 class DirectOutputThread : public PlaybackThread { 798 public: 799 800 DirectOutputThread (const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, int id, uint32_t device); 801 ~DirectOutputThread(); 802 803 // Thread virtuals 804 virtual bool threadLoop(); 805 806 virtual bool checkForNewParameters_l(); 807 808 protected: 809 virtual int getTrackName_l(); 810 virtual void deleteTrackName_l(int name); 811 virtual uint32_t activeSleepTimeUs(); 812 virtual uint32_t idleSleepTimeUs(); 813 virtual uint32_t suspendSleepTimeUs(); 814 815 private: 816 void applyVolume(uint16_t leftVol, uint16_t rightVol, bool ramp); 817 818 float mLeftVolFloat; 819 float mRightVolFloat; 820 uint16_t mLeftVolShort; 821 uint16_t mRightVolShort; 822 }; 823 824 class DuplicatingThread : public MixerThread { 825 public: 826 DuplicatingThread (const sp<AudioFlinger>& audioFlinger, MixerThread* mainThread, int id); 827 ~DuplicatingThread(); 828 829 // Thread virtuals 830 virtual bool threadLoop(); 831 void addOutputTrack(MixerThread* thread); 832 void removeOutputTrack(MixerThread* thread); 833 uint32_t waitTimeMs() { return mWaitTimeMs; } 834 protected: 835 virtual uint32_t activeSleepTimeUs(); 836 837 private: 838 bool outputsReady(SortedVector< sp<OutputTrack> > &outputTracks); 839 void updateWaitTime(); 840 841 SortedVector < sp<OutputTrack> > mOutputTracks; 842 uint32_t mWaitTimeMs; 843 }; 844 845 PlaybackThread *checkPlaybackThread_l(int output) const; 846 MixerThread *checkMixerThread_l(int output) const; 847 RecordThread *checkRecordThread_l(int input) const; 848 float streamVolumeInternal(int stream) const { return mStreamTypes[stream].volume; } 849 void audioConfigChanged_l(int event, int ioHandle, void *param2); 850 851 uint32_t nextUniqueId(); 852 status_t moveEffectChain_l(int session, 853 AudioFlinger::PlaybackThread *srcThread, 854 AudioFlinger::PlaybackThread *dstThread, 855 bool reRegister); 856 PlaybackThread *primaryPlaybackThread_l(); 857 uint32_t primaryOutputDevice_l(); 858 859 friend class AudioBuffer; 860 861 class TrackHandle : public android::BnAudioTrack { 862 public: 863 TrackHandle(const sp<PlaybackThread::Track>& track); 864 virtual ~TrackHandle(); 865 virtual status_t start(); 866 virtual void stop(); 867 virtual void flush(); 868 virtual void mute(bool); 869 virtual void pause(); 870 virtual void setVolume(float left, float right); 871 virtual sp<IMemory> getCblk() const; 872 virtual status_t attachAuxEffect(int effectId); 873 virtual status_t onTransact( 874 uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags); 875 private: 876 sp<PlaybackThread::Track> mTrack; 877 }; 878 879 friend class Client; 880 friend class PlaybackThread::Track; 881 882 883 void removeClient_l(pid_t pid); 884 void removeNotificationClient(pid_t pid); 885 886 887 // record thread 888 class RecordThread : public ThreadBase, public AudioBufferProvider 889 { 890 public: 891 892 // record track 893 class RecordTrack : public TrackBase { 894 public: 895 RecordTrack(const wp<ThreadBase>& thread, 896 const sp<Client>& client, 897 uint32_t sampleRate, 898 uint32_t format, 899 uint32_t channelMask, 900 int frameCount, 901 uint32_t flags, 902 int sessionId); 903 ~RecordTrack(); 904 905 virtual status_t start(); 906 virtual void stop(); 907 908 bool overflow() { bool tmp = mOverflow; mOverflow = false; return tmp; } 909 bool setOverflow() { bool tmp = mOverflow; mOverflow = true; return tmp; } 910 911 void dump(char* buffer, size_t size); 912 private: 913 friend class AudioFlinger; 914 friend class RecordThread; 915 916 RecordTrack(const RecordTrack&); 917 RecordTrack& operator = (const RecordTrack&); 918 919 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer); 920 921 bool mOverflow; 922 }; 923 924 925 RecordThread(const sp<AudioFlinger>& audioFlinger, 926 AudioStreamIn *input, 927 uint32_t sampleRate, 928 uint32_t channels, 929 int id, 930 uint32_t device); 931 ~RecordThread(); 932 933 virtual bool threadLoop(); 934 virtual status_t readyToRun(); 935 virtual void onFirstRef(); 936 937 virtual status_t initCheck() const { return (mInput == 0) ? NO_INIT : NO_ERROR; } 938 sp<AudioFlinger::RecordThread::RecordTrack> createRecordTrack_l( 939 const sp<AudioFlinger::Client>& client, 940 uint32_t sampleRate, 941 int format, 942 int channelMask, 943 int frameCount, 944 uint32_t flags, 945 int sessionId, 946 status_t *status); 947 948 status_t start(RecordTrack* recordTrack); 949 void stop(RecordTrack* recordTrack); 950 status_t dump(int fd, const Vector<String16>& args); 951 AudioStreamIn* getInput(); 952 AudioStreamIn* clearInput(); 953 virtual audio_stream_t* stream(); 954 955 956 void setTrack(RecordTrack *recordTrack) { mTrack = recordTrack; } 957 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer); 958 virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer); 959 virtual bool checkForNewParameters_l(); 960 virtual String8 getParameters(const String8& keys); 961 virtual void audioConfigChanged_l(int event, int param = 0); 962 void readInputParameters(); 963 virtual unsigned int getInputFramesLost(); 964 965 virtual status_t addEffectChain_l(const sp<EffectChain>& chain); 966 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain); 967 virtual uint32_t hasAudioSession(int sessionId); 968 969 private: 970 RecordThread(); 971 AudioStreamIn *mInput; 972 RecordTrack* mTrack; 973 sp<RecordTrack> mActiveTrack; 974 Condition mStartStopCond; 975 AudioResampler *mResampler; 976 int32_t *mRsmpOutBuffer; 977 int16_t *mRsmpInBuffer; 978 size_t mRsmpInIndex; 979 size_t mInputBytes; 980 int mReqChannelCount; 981 uint32_t mReqSampleRate; 982 ssize_t mBytesRead; 983 }; 984 985 class RecordHandle : public android::BnAudioRecord { 986 public: 987 RecordHandle(const sp<RecordThread::RecordTrack>& recordTrack); 988 virtual ~RecordHandle(); 989 virtual status_t start(); 990 virtual void stop(); 991 virtual sp<IMemory> getCblk() const; 992 virtual status_t onTransact( 993 uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags); 994 private: 995 sp<RecordThread::RecordTrack> mRecordTrack; 996 }; 997 998 //--- Audio Effect Management 999 1000 // EffectModule and EffectChain classes both have their own mutex to protect 1001 // state changes or resource modifications. Always respect the following order 1002 // if multiple mutexes must be acquired to avoid cross deadlock: 1003 // AudioFlinger -> ThreadBase -> EffectChain -> EffectModule 1004 1005 // The EffectModule class is a wrapper object controlling the effect engine implementation 1006 // in the effect library. It prevents concurrent calls to process() and command() functions 1007 // from different client threads. It keeps a list of EffectHandle objects corresponding 1008 // to all client applications using this effect and notifies applications of effect state, 1009 // control or parameter changes. It manages the activation state machine to send appropriate 1010 // reset, enable, disable commands to effect engine and provide volume 1011 // ramping when effects are activated/deactivated. 1012 // When controlling an auxiliary effect, the EffectModule also provides an input buffer used by 1013 // the attached track(s) to accumulate their auxiliary channel. 1014 class EffectModule: public RefBase { 1015 public: 1016 EffectModule(const wp<ThreadBase>& wThread, 1017 const wp<AudioFlinger::EffectChain>& chain, 1018 effect_descriptor_t *desc, 1019 int id, 1020 int sessionId); 1021 ~EffectModule(); 1022 1023 enum effect_state { 1024 IDLE, 1025 RESTART, 1026 STARTING, 1027 ACTIVE, 1028 STOPPING, 1029 STOPPED, 1030 DESTROYED 1031 }; 1032 1033 int id() { return mId; } 1034 void process(); 1035 void updateState(); 1036 status_t command(uint32_t cmdCode, 1037 uint32_t cmdSize, 1038 void *pCmdData, 1039 uint32_t *replySize, 1040 void *pReplyData); 1041 1042 void reset_l(); 1043 status_t configure(); 1044 status_t init(); 1045 uint32_t state() { 1046 return mState; 1047 } 1048 uint32_t status() { 1049 return mStatus; 1050 } 1051 int sessionId() { 1052 return mSessionId; 1053 } 1054 status_t setEnabled(bool enabled); 1055 bool isEnabled(); 1056 bool isProcessEnabled(); 1057 1058 void setInBuffer(int16_t *buffer) { mConfig.inputCfg.buffer.s16 = buffer; } 1059 int16_t *inBuffer() { return mConfig.inputCfg.buffer.s16; } 1060 void setOutBuffer(int16_t *buffer) { mConfig.outputCfg.buffer.s16 = buffer; } 1061 int16_t *outBuffer() { return mConfig.outputCfg.buffer.s16; } 1062 void setChain(const wp<EffectChain>& chain) { mChain = chain; } 1063 void setThread(const wp<ThreadBase>& thread) { mThread = thread; } 1064 1065 status_t addHandle(sp<EffectHandle>& handle); 1066 void disconnect(const wp<EffectHandle>& handle); 1067 size_t removeHandle (const wp<EffectHandle>& handle); 1068 1069 effect_descriptor_t& desc() { return mDescriptor; } 1070 wp<EffectChain>& chain() { return mChain; } 1071 1072 status_t setDevice(uint32_t device); 1073 status_t setVolume(uint32_t *left, uint32_t *right, bool controller); 1074 status_t setMode(uint32_t mode); 1075 status_t stop(); 1076 1077 status_t dump(int fd, const Vector<String16>& args); 1078 1079 protected: 1080 1081 // Maximum time allocated to effect engines to complete the turn off sequence 1082 static const uint32_t MAX_DISABLE_TIME_MS = 10000; 1083 1084 EffectModule(const EffectModule&); 1085 EffectModule& operator = (const EffectModule&); 1086 1087 status_t start_l(); 1088 status_t stop_l(); 1089 1090 Mutex mLock; // mutex for process, commands and handles list protection 1091 wp<ThreadBase> mThread; // parent thread 1092 wp<EffectChain> mChain; // parent effect chain 1093 int mId; // this instance unique ID 1094 int mSessionId; // audio session ID 1095 effect_descriptor_t mDescriptor;// effect descriptor received from effect engine 1096 effect_config_t mConfig; // input and output audio configuration 1097 effect_handle_t mEffectInterface; // Effect module C API 1098 status_t mStatus; // initialization status 1099 uint32_t mState; // current activation state (effect_state) 1100 Vector< wp<EffectHandle> > mHandles; // list of client handles 1101 uint32_t mMaxDisableWaitCnt; // maximum grace period before forcing an effect off after 1102 // sending disable command. 1103 uint32_t mDisableWaitCnt; // current process() calls count during disable period. 1104 }; 1105 1106 // The EffectHandle class implements the IEffect interface. It provides resources 1107 // to receive parameter updates, keeps track of effect control 1108 // ownership and state and has a pointer to the EffectModule object it is controlling. 1109 // There is one EffectHandle object for each application controlling (or using) 1110 // an effect module. 1111 // The EffectHandle is obtained by calling AudioFlinger::createEffect(). 1112 class EffectHandle: public android::BnEffect { 1113 public: 1114 1115 EffectHandle(const sp<EffectModule>& effect, 1116 const sp<AudioFlinger::Client>& client, 1117 const sp<IEffectClient>& effectClient, 1118 int32_t priority); 1119 virtual ~EffectHandle(); 1120 1121 // IEffect 1122 virtual status_t enable(); 1123 virtual status_t disable(); 1124 virtual status_t command(uint32_t cmdCode, 1125 uint32_t cmdSize, 1126 void *pCmdData, 1127 uint32_t *replySize, 1128 void *pReplyData); 1129 virtual void disconnect(); 1130 virtual sp<IMemory> getCblk() const; 1131 virtual status_t onTransact(uint32_t code, const Parcel& data, 1132 Parcel* reply, uint32_t flags); 1133 1134 1135 // Give or take control of effect module 1136 void setControl(bool hasControl, bool signal); 1137 void commandExecuted(uint32_t cmdCode, 1138 uint32_t cmdSize, 1139 void *pCmdData, 1140 uint32_t replySize, 1141 void *pReplyData); 1142 void setEnabled(bool enabled); 1143 1144 // Getters 1145 int id() { return mEffect->id(); } 1146 int priority() { return mPriority; } 1147 bool hasControl() { return mHasControl; } 1148 sp<EffectModule> effect() { return mEffect; } 1149 1150 void dump(char* buffer, size_t size); 1151 1152 protected: 1153 1154 EffectHandle(const EffectHandle&); 1155 EffectHandle& operator =(const EffectHandle&); 1156 1157 sp<EffectModule> mEffect; // pointer to controlled EffectModule 1158 sp<IEffectClient> mEffectClient; // callback interface for client notifications 1159 sp<Client> mClient; // client for shared memory allocation 1160 sp<IMemory> mCblkMemory; // shared memory for control block 1161 effect_param_cblk_t* mCblk; // control block for deferred parameter setting via shared memory 1162 uint8_t* mBuffer; // pointer to parameter area in shared memory 1163 int mPriority; // client application priority to control the effect 1164 bool mHasControl; // true if this handle is controlling the effect 1165 }; 1166 1167 // the EffectChain class represents a group of effects associated to one audio session. 1168 // There can be any number of EffectChain objects per output mixer thread (PlaybackThread). 1169 // The EffecChain with session ID 0 contains global effects applied to the output mix. 1170 // Effects in this chain can be insert or auxiliary. Effects in other chains (attached to tracks) 1171 // are insert only. The EffectChain maintains an ordered list of effect module, the order corresponding 1172 // in the effect process order. When attached to a track (session ID != 0), it also provide it's own 1173 // input buffer used by the track as accumulation buffer. 1174 class EffectChain: public RefBase { 1175 public: 1176 EffectChain(const wp<ThreadBase>& wThread, int sessionId); 1177 ~EffectChain(); 1178 1179 void process_l(); 1180 1181 void lock() { 1182 mLock.lock(); 1183 } 1184 void unlock() { 1185 mLock.unlock(); 1186 } 1187 1188 status_t addEffect_l(const sp<EffectModule>& handle); 1189 size_t removeEffect_l(const sp<EffectModule>& handle); 1190 1191 int sessionId() { return mSessionId; } 1192 void setSessionId(int sessionId) { mSessionId = sessionId; } 1193 1194 sp<EffectModule> getEffectFromDesc_l(effect_descriptor_t *descriptor); 1195 sp<EffectModule> getEffectFromId_l(int id); 1196 bool setVolume_l(uint32_t *left, uint32_t *right); 1197 void setDevice_l(uint32_t device); 1198 void setMode_l(uint32_t mode); 1199 1200 void setInBuffer(int16_t *buffer, bool ownsBuffer = false) { 1201 mInBuffer = buffer; 1202 mOwnInBuffer = ownsBuffer; 1203 } 1204 int16_t *inBuffer() { 1205 return mInBuffer; 1206 } 1207 void setOutBuffer(int16_t *buffer) { 1208 mOutBuffer = buffer; 1209 } 1210 int16_t *outBuffer() { 1211 return mOutBuffer; 1212 } 1213 1214 void incTrackCnt() { android_atomic_inc(&mTrackCnt); } 1215 void decTrackCnt() { android_atomic_dec(&mTrackCnt); } 1216 int32_t trackCnt() { return mTrackCnt;} 1217 1218 void incActiveTrackCnt() { android_atomic_inc(&mActiveTrackCnt); } 1219 void decActiveTrackCnt() { android_atomic_dec(&mActiveTrackCnt); } 1220 int32_t activeTrackCnt() { return mActiveTrackCnt;} 1221 1222 uint32_t strategy() { return mStrategy; } 1223 void setStrategy(uint32_t strategy) 1224 { mStrategy = strategy; } 1225 1226 status_t dump(int fd, const Vector<String16>& args); 1227 1228 protected: 1229 1230 EffectChain(const EffectChain&); 1231 EffectChain& operator =(const EffectChain&); 1232 1233 wp<ThreadBase> mThread; // parent mixer thread 1234 Mutex mLock; // mutex protecting effect list 1235 Vector<sp<EffectModule> > mEffects; // list of effect modules 1236 int mSessionId; // audio session ID 1237 int16_t *mInBuffer; // chain input buffer 1238 int16_t *mOutBuffer; // chain output buffer 1239 volatile int32_t mActiveTrackCnt; // number of active tracks connected 1240 volatile int32_t mTrackCnt; // number of tracks connected 1241 bool mOwnInBuffer; // true if the chain owns its input buffer 1242 int mVolumeCtrlIdx; // index of insert effect having control over volume 1243 uint32_t mLeftVolume; // previous volume on left channel 1244 uint32_t mRightVolume; // previous volume on right channel 1245 uint32_t mNewLeftVolume; // new volume on left channel 1246 uint32_t mNewRightVolume; // new volume on right channel 1247 uint32_t mStrategy; // strategy for this effect chain 1248 }; 1249 1250 struct AudioStreamOut { 1251 audio_hw_device_t *hwDev; 1252 audio_stream_out_t *stream; 1253 1254 AudioStreamOut(audio_hw_device_t *dev, audio_stream_out_t *out) : 1255 hwDev(dev), stream(out) {} 1256 }; 1257 1258 struct AudioStreamIn { 1259 audio_hw_device_t *hwDev; 1260 audio_stream_in_t *stream; 1261 1262 AudioStreamIn(audio_hw_device_t *dev, audio_stream_in_t *in) : 1263 hwDev(dev), stream(in) {} 1264 }; 1265 1266 friend class RecordThread; 1267 friend class PlaybackThread; 1268 1269 mutable Mutex mLock; 1270 1271 DefaultKeyedVector< pid_t, wp<Client> > mClients; 1272 1273 mutable Mutex mHardwareLock; 1274 audio_hw_device_t* mPrimaryHardwareDev; 1275 Vector<audio_hw_device_t*> mAudioHwDevs; 1276 mutable int mHardwareStatus; 1277 1278 1279 DefaultKeyedVector< int, sp<PlaybackThread> > mPlaybackThreads; 1280 PlaybackThread::stream_type_t mStreamTypes[AUDIO_STREAM_CNT]; 1281 float mMasterVolume; 1282 bool mMasterMute; 1283 1284 DefaultKeyedVector< int, sp<RecordThread> > mRecordThreads; 1285 1286 DefaultKeyedVector< pid_t, sp<NotificationClient> > mNotificationClients; 1287 volatile int32_t mNextUniqueId; 1288 uint32_t mMode; 1289 1290}; 1291 1292 1293// ---------------------------------------------------------------------------- 1294 1295}; // namespace android 1296 1297#endif // ANDROID_AUDIO_FLINGER_H 1298