1 /* 2 ** 3 ** Copyright 2012, 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 INCLUDING_FROM_AUDIOFLINGER_H 19 #error This header file should only be included from AudioFlinger.h 20 #endif 21 22 class ThreadBase : public Thread { 23 public: 24 25 #include "TrackBase.h" 26 27 enum type_t { 28 MIXER, // Thread class is MixerThread 29 DIRECT, // Thread class is DirectOutputThread 30 DUPLICATING, // Thread class is DuplicatingThread 31 RECORD, // Thread class is RecordThread 32 OFFLOAD // Thread class is OffloadThread 33 }; 34 35 ThreadBase(const sp<AudioFlinger>& audioFlinger, audio_io_handle_t id, 36 audio_devices_t outDevice, audio_devices_t inDevice, type_t type); 37 virtual ~ThreadBase(); 38 39 void dumpBase(int fd, const Vector<String16>& args); 40 void dumpEffectChains(int fd, const Vector<String16>& args); 41 42 void clearPowerManager(); 43 44 // base for record and playback 45 enum { 46 CFG_EVENT_IO, 47 CFG_EVENT_PRIO 48 }; 49 50 class ConfigEvent { 51 public: 52 ConfigEvent(int type) : mType(type) {} 53 virtual ~ConfigEvent() {} 54 55 int type() const { return mType; } 56 57 virtual void dump(char *buffer, size_t size) = 0; 58 59 private: 60 const int mType; 61 }; 62 63 class IoConfigEvent : public ConfigEvent { 64 public: 65 IoConfigEvent(int event, int param) : 66 ConfigEvent(CFG_EVENT_IO), mEvent(event), mParam(event) {} 67 virtual ~IoConfigEvent() {} 68 69 int event() const { return mEvent; } 70 int param() const { return mParam; } 71 72 virtual void dump(char *buffer, size_t size) { 73 snprintf(buffer, size, "IO event: event %d, param %d\n", mEvent, mParam); 74 } 75 76 private: 77 const int mEvent; 78 const int mParam; 79 }; 80 81 class PrioConfigEvent : public ConfigEvent { 82 public: 83 PrioConfigEvent(pid_t pid, pid_t tid, int32_t prio) : 84 ConfigEvent(CFG_EVENT_PRIO), mPid(pid), mTid(tid), mPrio(prio) {} 85 virtual ~PrioConfigEvent() {} 86 87 pid_t pid() const { return mPid; } 88 pid_t tid() const { return mTid; } 89 int32_t prio() const { return mPrio; } 90 91 virtual void dump(char *buffer, size_t size) { 92 snprintf(buffer, size, "Prio event: pid %d, tid %d, prio %d\n", mPid, mTid, mPrio); 93 } 94 95 private: 96 const pid_t mPid; 97 const pid_t mTid; 98 const int32_t mPrio; 99 }; 100 101 102 class PMDeathRecipient : public IBinder::DeathRecipient { 103 public: 104 PMDeathRecipient(const wp<ThreadBase>& thread) : mThread(thread) {} 105 virtual ~PMDeathRecipient() {} 106 107 // IBinder::DeathRecipient 108 virtual void binderDied(const wp<IBinder>& who); 109 110 private: 111 PMDeathRecipient(const PMDeathRecipient&); 112 PMDeathRecipient& operator = (const PMDeathRecipient&); 113 114 wp<ThreadBase> mThread; 115 }; 116 117 virtual status_t initCheck() const = 0; 118 119 // static externally-visible 120 type_t type() const { return mType; } 121 audio_io_handle_t id() const { return mId;} 122 123 // dynamic externally-visible 124 uint32_t sampleRate() const { return mSampleRate; } 125 uint32_t channelCount() const { return mChannelCount; } 126 audio_channel_mask_t channelMask() const { return mChannelMask; } 127 audio_format_t format() const { return mFormat; } 128 // Called by AudioFlinger::frameCount(audio_io_handle_t output) and effects, 129 // and returns the [normal mix] buffer's frame count. 130 virtual size_t frameCount() const = 0; 131 size_t frameSize() const { return mFrameSize; } 132 133 // Should be "virtual status_t requestExitAndWait()" and override same 134 // method in Thread, but Thread::requestExitAndWait() is not yet virtual. 135 void exit(); 136 virtual bool checkForNewParameters_l() = 0; 137 virtual status_t setParameters(const String8& keyValuePairs); 138 virtual String8 getParameters(const String8& keys) = 0; 139 virtual void audioConfigChanged_l(int event, int param = 0) = 0; 140 void sendIoConfigEvent(int event, int param = 0); 141 void sendIoConfigEvent_l(int event, int param = 0); 142 void sendPrioConfigEvent_l(pid_t pid, pid_t tid, int32_t prio); 143 void processConfigEvents(); 144 145 // see note at declaration of mStandby, mOutDevice and mInDevice 146 bool standby() const { return mStandby; } 147 audio_devices_t outDevice() const { return mOutDevice; } 148 audio_devices_t inDevice() const { return mInDevice; } 149 150 virtual audio_stream_t* stream() const = 0; 151 152 sp<EffectHandle> createEffect_l( 153 const sp<AudioFlinger::Client>& client, 154 const sp<IEffectClient>& effectClient, 155 int32_t priority, 156 int sessionId, 157 effect_descriptor_t *desc, 158 int *enabled, 159 status_t *status); 160 void disconnectEffect(const sp< EffectModule>& effect, 161 EffectHandle *handle, 162 bool unpinIfLast); 163 164 // return values for hasAudioSession (bit field) 165 enum effect_state { 166 EFFECT_SESSION = 0x1, // the audio session corresponds to at least one 167 // effect 168 TRACK_SESSION = 0x2 // the audio session corresponds to at least one 169 // track 170 }; 171 172 // get effect chain corresponding to session Id. 173 sp<EffectChain> getEffectChain(int sessionId); 174 // same as getEffectChain() but must be called with ThreadBase mutex locked 175 sp<EffectChain> getEffectChain_l(int sessionId) const; 176 // add an effect chain to the chain list (mEffectChains) 177 virtual status_t addEffectChain_l(const sp<EffectChain>& chain) = 0; 178 // remove an effect chain from the chain list (mEffectChains) 179 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain) = 0; 180 // lock all effect chains Mutexes. Must be called before releasing the 181 // ThreadBase mutex before processing the mixer and effects. This guarantees the 182 // integrity of the chains during the process. 183 // Also sets the parameter 'effectChains' to current value of mEffectChains. 184 void lockEffectChains_l(Vector< sp<EffectChain> >& effectChains); 185 // unlock effect chains after process 186 void unlockEffectChains(const Vector< sp<EffectChain> >& effectChains); 187 // get a copy of mEffectChains vector 188 Vector< sp<EffectChain> > getEffectChains_l() const { return mEffectChains; }; 189 // set audio mode to all effect chains 190 void setMode(audio_mode_t mode); 191 // get effect module with corresponding ID on specified audio session 192 sp<AudioFlinger::EffectModule> getEffect(int sessionId, int effectId); 193 sp<AudioFlinger::EffectModule> getEffect_l(int sessionId, int effectId); 194 // add and effect module. Also creates the effect chain is none exists for 195 // the effects audio session 196 status_t addEffect_l(const sp< EffectModule>& effect); 197 // remove and effect module. Also removes the effect chain is this was the last 198 // effect 199 void removeEffect_l(const sp< EffectModule>& effect); 200 // detach all tracks connected to an auxiliary effect 201 virtual void detachAuxEffect_l(int effectId) {} 202 // returns either EFFECT_SESSION if effects on this audio session exist in one 203 // chain, or TRACK_SESSION if tracks on this audio session exist, or both 204 virtual uint32_t hasAudioSession(int sessionId) const = 0; 205 // the value returned by default implementation is not important as the 206 // strategy is only meaningful for PlaybackThread which implements this method 207 virtual uint32_t getStrategyForSession_l(int sessionId) { return 0; } 208 209 // suspend or restore effect according to the type of effect passed. a NULL 210 // type pointer means suspend all effects in the session 211 void setEffectSuspended(const effect_uuid_t *type, 212 bool suspend, 213 int sessionId = AUDIO_SESSION_OUTPUT_MIX); 214 // check if some effects must be suspended/restored when an effect is enabled 215 // or disabled 216 void checkSuspendOnEffectEnabled(const sp<EffectModule>& effect, 217 bool enabled, 218 int sessionId = AUDIO_SESSION_OUTPUT_MIX); 219 void checkSuspendOnEffectEnabled_l(const sp<EffectModule>& effect, 220 bool enabled, 221 int sessionId = AUDIO_SESSION_OUTPUT_MIX); 222 223 virtual status_t setSyncEvent(const sp<SyncEvent>& event) = 0; 224 virtual bool isValidSyncEvent(const sp<SyncEvent>& event) const = 0; 225 226 227 mutable Mutex mLock; 228 229 protected: 230 231 // entry describing an effect being suspended in mSuspendedSessions keyed vector 232 class SuspendedSessionDesc : public RefBase { 233 public: 234 SuspendedSessionDesc() : mRefCount(0) {} 235 236 int mRefCount; // number of active suspend requests 237 effect_uuid_t mType; // effect type UUID 238 }; 239 240 void acquireWakeLock(int uid = -1); 241 void acquireWakeLock_l(int uid = -1); 242 void releaseWakeLock(); 243 void releaseWakeLock_l(); 244 void setEffectSuspended_l(const effect_uuid_t *type, 245 bool suspend, 246 int sessionId); 247 // updated mSuspendedSessions when an effect suspended or restored 248 void updateSuspendedSessions_l(const effect_uuid_t *type, 249 bool suspend, 250 int sessionId); 251 // check if some effects must be suspended when an effect chain is added 252 void checkSuspendOnAddEffectChain_l(const sp<EffectChain>& chain); 253 254 String16 getWakeLockTag(); 255 256 virtual void preExit() { } 257 258 friend class AudioFlinger; // for mEffectChains 259 260 const type_t mType; 261 262 // Used by parameters, config events, addTrack_l, exit 263 Condition mWaitWorkCV; 264 265 const sp<AudioFlinger> mAudioFlinger; 266 267 // updated by PlaybackThread::readOutputParameters() or 268 // RecordThread::readInputParameters() 269 uint32_t mSampleRate; 270 size_t mFrameCount; // output HAL, direct output, record 271 audio_channel_mask_t mChannelMask; 272 uint32_t mChannelCount; 273 size_t mFrameSize; 274 audio_format_t mFormat; 275 276 // Parameter sequence by client: binder thread calling setParameters(): 277 // 1. Lock mLock 278 // 2. Append to mNewParameters 279 // 3. mWaitWorkCV.signal 280 // 4. mParamCond.waitRelative with timeout 281 // 5. read mParamStatus 282 // 6. mWaitWorkCV.signal 283 // 7. Unlock 284 // 285 // Parameter sequence by server: threadLoop calling checkForNewParameters_l(): 286 // 1. Lock mLock 287 // 2. If there is an entry in mNewParameters proceed ... 288 // 2. Read first entry in mNewParameters 289 // 3. Process 290 // 4. Remove first entry from mNewParameters 291 // 5. Set mParamStatus 292 // 6. mParamCond.signal 293 // 7. mWaitWorkCV.wait with timeout (this is to avoid overwriting mParamStatus) 294 // 8. Unlock 295 Condition mParamCond; 296 Vector<String8> mNewParameters; 297 status_t mParamStatus; 298 299 // vector owns each ConfigEvent *, so must delete after removing 300 Vector<ConfigEvent *> mConfigEvents; 301 302 // These fields are written and read by thread itself without lock or barrier, 303 // and read by other threads without lock or barrier via standby() , outDevice() 304 // and inDevice(). 305 // Because of the absence of a lock or barrier, any other thread that reads 306 // these fields must use the information in isolation, or be prepared to deal 307 // with possibility that it might be inconsistent with other information. 308 bool mStandby; // Whether thread is currently in standby. 309 audio_devices_t mOutDevice; // output device 310 audio_devices_t mInDevice; // input device 311 audio_source_t mAudioSource; // (see audio.h, audio_source_t) 312 313 const audio_io_handle_t mId; 314 Vector< sp<EffectChain> > mEffectChains; 315 316 static const int kNameLength = 16; // prctl(PR_SET_NAME) limit 317 char mName[kNameLength]; 318 sp<IPowerManager> mPowerManager; 319 sp<IBinder> mWakeLockToken; 320 const sp<PMDeathRecipient> mDeathRecipient; 321 // list of suspended effects per session and per type. The first vector is 322 // keyed by session ID, the second by type UUID timeLow field 323 KeyedVector< int, KeyedVector< int, sp<SuspendedSessionDesc> > > 324 mSuspendedSessions; 325 static const size_t kLogSize = 4 * 1024; 326 sp<NBLog::Writer> mNBLogWriter; 327 }; 328 329 // --- PlaybackThread --- 330 class PlaybackThread : public ThreadBase { 331 public: 332 333 #include "PlaybackTracks.h" 334 335 enum mixer_state { 336 MIXER_IDLE, // no active tracks 337 MIXER_TRACKS_ENABLED, // at least one active track, but no track has any data ready 338 MIXER_TRACKS_READY, // at least one active track, and at least one track has data 339 MIXER_DRAIN_TRACK, // drain currently playing track 340 MIXER_DRAIN_ALL, // fully drain the hardware 341 // standby mode does not have an enum value 342 // suspend by audio policy manager is orthogonal to mixer state 343 }; 344 345 // retry count before removing active track in case of underrun on offloaded thread: 346 // we need to make sure that AudioTrack client has enough time to send large buffers 347 //FIXME may be more appropriate if expressed in time units. Need to revise how underrun is handled 348 // for offloaded tracks 349 static const int8_t kMaxTrackRetriesOffload = 20; 350 351 PlaybackThread(const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, 352 audio_io_handle_t id, audio_devices_t device, type_t type); 353 virtual ~PlaybackThread(); 354 355 void dump(int fd, const Vector<String16>& args); 356 357 // Thread virtuals 358 virtual status_t readyToRun(); 359 virtual bool threadLoop(); 360 361 // RefBase 362 virtual void onFirstRef(); 363 364 protected: 365 // Code snippets that were lifted up out of threadLoop() 366 virtual void threadLoop_mix() = 0; 367 virtual void threadLoop_sleepTime() = 0; 368 virtual ssize_t threadLoop_write(); 369 virtual void threadLoop_drain(); 370 virtual void threadLoop_standby(); 371 virtual void threadLoop_exit(); 372 virtual void threadLoop_removeTracks(const Vector< sp<Track> >& tracksToRemove); 373 374 // prepareTracks_l reads and writes mActiveTracks, and returns 375 // the pending set of tracks to remove via Vector 'tracksToRemove'. The caller 376 // is responsible for clearing or destroying this Vector later on, when it 377 // is safe to do so. That will drop the final ref count and destroy the tracks. 378 virtual mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove) = 0; 379 void removeTracks_l(const Vector< sp<Track> >& tracksToRemove); 380 381 void writeCallback(); 382 void resetWriteBlocked(uint32_t sequence); 383 void drainCallback(); 384 void resetDraining(uint32_t sequence); 385 386 static int asyncCallback(stream_callback_event_t event, void *param, void *cookie); 387 388 virtual bool waitingAsyncCallback(); 389 virtual bool waitingAsyncCallback_l(); 390 virtual bool shouldStandby_l(); 391 392 393 // ThreadBase virtuals 394 virtual void preExit(); 395 396 public: 397 398 virtual status_t initCheck() const { return (mOutput == NULL) ? NO_INIT : NO_ERROR; } 399 400 // return estimated latency in milliseconds, as reported by HAL 401 uint32_t latency() const; 402 // same, but lock must already be held 403 uint32_t latency_l() const; 404 405 void setMasterVolume(float value); 406 void setMasterMute(bool muted); 407 408 void setStreamVolume(audio_stream_type_t stream, float value); 409 void setStreamMute(audio_stream_type_t stream, bool muted); 410 411 float streamVolume(audio_stream_type_t stream) const; 412 413 sp<Track> createTrack_l( 414 const sp<AudioFlinger::Client>& client, 415 audio_stream_type_t streamType, 416 uint32_t sampleRate, 417 audio_format_t format, 418 audio_channel_mask_t channelMask, 419 size_t frameCount, 420 const sp<IMemory>& sharedBuffer, 421 int sessionId, 422 IAudioFlinger::track_flags_t *flags, 423 pid_t tid, 424 status_t *status); 425 426 AudioStreamOut* getOutput() const; 427 AudioStreamOut* clearOutput(); 428 virtual audio_stream_t* stream() const; 429 430 // a very large number of suspend() will eventually wraparound, but unlikely 431 void suspend() { (void) android_atomic_inc(&mSuspended); } 432 void restore() 433 { 434 // if restore() is done without suspend(), get back into 435 // range so that the next suspend() will operate correctly 436 if (android_atomic_dec(&mSuspended) <= 0) { 437 android_atomic_release_store(0, &mSuspended); 438 } 439 } 440 bool isSuspended() const 441 { return android_atomic_acquire_load(&mSuspended) > 0; } 442 443 virtual String8 getParameters(const String8& keys); 444 virtual void audioConfigChanged_l(int event, int param = 0); 445 status_t getRenderPosition(size_t *halFrames, size_t *dspFrames); 446 int16_t *mixBuffer() const { return mMixBuffer; }; 447 448 virtual void detachAuxEffect_l(int effectId); 449 status_t attachAuxEffect(const sp<AudioFlinger::PlaybackThread::Track> track, 450 int EffectId); 451 status_t attachAuxEffect_l(const sp<AudioFlinger::PlaybackThread::Track> track, 452 int EffectId); 453 454 virtual status_t addEffectChain_l(const sp<EffectChain>& chain); 455 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain); 456 virtual uint32_t hasAudioSession(int sessionId) const; 457 virtual uint32_t getStrategyForSession_l(int sessionId); 458 459 460 virtual status_t setSyncEvent(const sp<SyncEvent>& event); 461 virtual bool isValidSyncEvent(const sp<SyncEvent>& event) const; 462 463 // called with AudioFlinger lock held 464 void invalidateTracks(audio_stream_type_t streamType); 465 466 virtual size_t frameCount() const { return mNormalFrameCount; } 467 468 // Return's the HAL's frame count i.e. fast mixer buffer size. 469 size_t frameCountHAL() const { return mFrameCount; } 470 471 status_t getTimestamp_l(AudioTimestamp& timestamp); 472 473 protected: 474 // updated by readOutputParameters() 475 size_t mNormalFrameCount; // normal mixer and effects 476 477 int16_t* mMixBuffer; // frame size aligned mix buffer 478 int8_t* mAllocMixBuffer; // mixer buffer allocation address 479 480 // suspend count, > 0 means suspended. While suspended, the thread continues to pull from 481 // tracks and mix, but doesn't write to HAL. A2DP and SCO HAL implementations can't handle 482 // concurrent use of both of them, so Audio Policy Service suspends one of the threads to 483 // workaround that restriction. 484 // 'volatile' means accessed via atomic operations and no lock. 485 volatile int32_t mSuspended; 486 487 // FIXME overflows every 6+ hours at 44.1 kHz stereo 16-bit samples 488 // mFramesWritten would be better, or 64-bit even better 489 size_t mBytesWritten; 490 private: 491 // mMasterMute is in both PlaybackThread and in AudioFlinger. When a 492 // PlaybackThread needs to find out if master-muted, it checks it's local 493 // copy rather than the one in AudioFlinger. This optimization saves a lock. 494 bool mMasterMute; 495 void setMasterMute_l(bool muted) { mMasterMute = muted; } 496 protected: 497 SortedVector< wp<Track> > mActiveTracks; // FIXME check if this could be sp<> 498 499 // Allocate a track name for a given channel mask. 500 // Returns name >= 0 if successful, -1 on failure. 501 virtual int getTrackName_l(audio_channel_mask_t channelMask, int sessionId) = 0; 502 virtual void deleteTrackName_l(int name) = 0; 503 504 // Time to sleep between cycles when: 505 virtual uint32_t activeSleepTimeUs() const; // mixer state MIXER_TRACKS_ENABLED 506 virtual uint32_t idleSleepTimeUs() const = 0; // mixer state MIXER_IDLE 507 virtual uint32_t suspendSleepTimeUs() const = 0; // audio policy manager suspended us 508 // No sleep when mixer state == MIXER_TRACKS_READY; relies on audio HAL stream->write() 509 // No sleep in standby mode; waits on a condition 510 511 // Code snippets that are temporarily lifted up out of threadLoop() until the merge 512 void checkSilentMode_l(); 513 514 // Non-trivial for DUPLICATING only 515 virtual void saveOutputTracks() { } 516 virtual void clearOutputTracks() { } 517 518 // Cache various calculated values, at threadLoop() entry and after a parameter change 519 virtual void cacheParameters_l(); 520 521 virtual uint32_t correctLatency_l(uint32_t latency) const; 522 523 private: 524 525 friend class AudioFlinger; // for numerous 526 527 PlaybackThread(const Client&); 528 PlaybackThread& operator = (const PlaybackThread&); 529 530 status_t addTrack_l(const sp<Track>& track); 531 bool destroyTrack_l(const sp<Track>& track); 532 void removeTrack_l(const sp<Track>& track); 533 void broadcast_l(); 534 535 void readOutputParameters(); 536 537 virtual void dumpInternals(int fd, const Vector<String16>& args); 538 void dumpTracks(int fd, const Vector<String16>& args); 539 540 SortedVector< sp<Track> > mTracks; 541 // mStreamTypes[] uses 1 additional stream type internally for the OutputTrack used by 542 // DuplicatingThread 543 stream_type_t mStreamTypes[AUDIO_STREAM_CNT + 1]; 544 AudioStreamOut *mOutput; 545 546 float mMasterVolume; 547 nsecs_t mLastWriteTime; 548 int mNumWrites; 549 int mNumDelayedWrites; 550 bool mInWrite; 551 552 // FIXME rename these former local variables of threadLoop to standard "m" names 553 nsecs_t standbyTime; 554 size_t mixBufferSize; 555 556 // cached copies of activeSleepTimeUs() and idleSleepTimeUs() made by cacheParameters_l() 557 uint32_t activeSleepTime; 558 uint32_t idleSleepTime; 559 560 uint32_t sleepTime; 561 562 // mixer status returned by prepareTracks_l() 563 mixer_state mMixerStatus; // current cycle 564 // previous cycle when in prepareTracks_l() 565 mixer_state mMixerStatusIgnoringFastTracks; 566 // FIXME or a separate ready state per track 567 568 // FIXME move these declarations into the specific sub-class that needs them 569 // MIXER only 570 uint32_t sleepTimeShift; 571 572 // same as AudioFlinger::mStandbyTimeInNsecs except for DIRECT which uses a shorter value 573 nsecs_t standbyDelay; 574 575 // MIXER only 576 nsecs_t maxPeriod; 577 578 // DUPLICATING only 579 uint32_t writeFrames; 580 581 size_t mBytesRemaining; 582 size_t mCurrentWriteLength; 583 bool mUseAsyncWrite; 584 // mWriteAckSequence contains current write sequence on bits 31-1. The write sequence is 585 // incremented each time a write(), a flush() or a standby() occurs. 586 // Bit 0 is set when a write blocks and indicates a callback is expected. 587 // Bit 0 is reset by the async callback thread calling resetWriteBlocked(). Out of sequence 588 // callbacks are ignored. 589 uint32_t mWriteAckSequence; 590 // mDrainSequence contains current drain sequence on bits 31-1. The drain sequence is 591 // incremented each time a drain is requested or a flush() or standby() occurs. 592 // Bit 0 is set when the drain() command is called at the HAL and indicates a callback is 593 // expected. 594 // Bit 0 is reset by the async callback thread calling resetDraining(). Out of sequence 595 // callbacks are ignored. 596 uint32_t mDrainSequence; 597 // A condition that must be evaluated by prepareTrack_l() has changed and we must not wait 598 // for async write callback in the thread loop before evaluating it 599 bool mSignalPending; 600 sp<AsyncCallbackThread> mCallbackThread; 601 602 private: 603 // The HAL output sink is treated as non-blocking, but current implementation is blocking 604 sp<NBAIO_Sink> mOutputSink; 605 // If a fast mixer is present, the blocking pipe sink, otherwise clear 606 sp<NBAIO_Sink> mPipeSink; 607 // The current sink for the normal mixer to write it's (sub)mix, mOutputSink or mPipeSink 608 sp<NBAIO_Sink> mNormalSink; 609 #ifdef TEE_SINK 610 // For dumpsys 611 sp<NBAIO_Sink> mTeeSink; 612 sp<NBAIO_Source> mTeeSource; 613 #endif 614 uint32_t mScreenState; // cached copy of gScreenState 615 static const size_t kFastMixerLogSize = 4 * 1024; 616 sp<NBLog::Writer> mFastMixerNBLogWriter; 617 public: 618 virtual bool hasFastMixer() const = 0; 619 virtual FastTrackUnderruns getFastTrackUnderruns(size_t fastIndex) const 620 { FastTrackUnderruns dummy; return dummy; } 621 622 protected: 623 // accessed by both binder threads and within threadLoop(), lock on mutex needed 624 unsigned mFastTrackAvailMask; // bit i set if fast track [i] is available 625 virtual void flushOutput_l(); 626 627 private: 628 // timestamp latch: 629 // D input is written by threadLoop_write while mutex is unlocked, and read while locked 630 // Q output is written while locked, and read while locked 631 struct { 632 AudioTimestamp mTimestamp; 633 uint32_t mUnpresentedFrames; 634 } mLatchD, mLatchQ; 635 bool mLatchDValid; // true means mLatchD is valid, and clock it into latch at next opportunity 636 bool mLatchQValid; // true means mLatchQ is valid 637 }; 638 639 class MixerThread : public PlaybackThread { 640 public: 641 MixerThread(const sp<AudioFlinger>& audioFlinger, 642 AudioStreamOut* output, 643 audio_io_handle_t id, 644 audio_devices_t device, 645 type_t type = MIXER); 646 virtual ~MixerThread(); 647 648 // Thread virtuals 649 650 virtual bool checkForNewParameters_l(); 651 virtual void dumpInternals(int fd, const Vector<String16>& args); 652 653 protected: 654 virtual mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove); 655 virtual int getTrackName_l(audio_channel_mask_t channelMask, int sessionId); 656 virtual void deleteTrackName_l(int name); 657 virtual uint32_t idleSleepTimeUs() const; 658 virtual uint32_t suspendSleepTimeUs() const; 659 virtual void cacheParameters_l(); 660 661 // threadLoop snippets 662 virtual ssize_t threadLoop_write(); 663 virtual void threadLoop_standby(); 664 virtual void threadLoop_mix(); 665 virtual void threadLoop_sleepTime(); 666 virtual void threadLoop_removeTracks(const Vector< sp<Track> >& tracksToRemove); 667 virtual uint32_t correctLatency_l(uint32_t latency) const; 668 669 AudioMixer* mAudioMixer; // normal mixer 670 private: 671 // one-time initialization, no locks required 672 FastMixer* mFastMixer; // non-NULL if there is also a fast mixer 673 sp<AudioWatchdog> mAudioWatchdog; // non-0 if there is an audio watchdog thread 674 675 // contents are not guaranteed to be consistent, no locks required 676 FastMixerDumpState mFastMixerDumpState; 677 #ifdef STATE_QUEUE_DUMP 678 StateQueueObserverDump mStateQueueObserverDump; 679 StateQueueMutatorDump mStateQueueMutatorDump; 680 #endif 681 AudioWatchdogDump mAudioWatchdogDump; 682 683 // accessible only within the threadLoop(), no locks required 684 // mFastMixer->sq() // for mutating and pushing state 685 int32_t mFastMixerFutex; // for cold idle 686 687 public: 688 virtual bool hasFastMixer() const { return mFastMixer != NULL; } 689 virtual FastTrackUnderruns getFastTrackUnderruns(size_t fastIndex) const { 690 ALOG_ASSERT(fastIndex < FastMixerState::kMaxFastTracks); 691 return mFastMixerDumpState.mTracks[fastIndex].mUnderruns; 692 } 693 }; 694 695 class DirectOutputThread : public PlaybackThread { 696 public: 697 698 DirectOutputThread(const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, 699 audio_io_handle_t id, audio_devices_t device); 700 virtual ~DirectOutputThread(); 701 702 // Thread virtuals 703 704 virtual bool checkForNewParameters_l(); 705 706 protected: 707 virtual int getTrackName_l(audio_channel_mask_t channelMask, int sessionId); 708 virtual void deleteTrackName_l(int name); 709 virtual uint32_t activeSleepTimeUs() const; 710 virtual uint32_t idleSleepTimeUs() const; 711 virtual uint32_t suspendSleepTimeUs() const; 712 virtual void cacheParameters_l(); 713 714 // threadLoop snippets 715 virtual mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove); 716 virtual void threadLoop_mix(); 717 virtual void threadLoop_sleepTime(); 718 719 // volumes last sent to audio HAL with stream->set_volume() 720 float mLeftVolFloat; 721 float mRightVolFloat; 722 723 DirectOutputThread(const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, 724 audio_io_handle_t id, uint32_t device, ThreadBase::type_t type); 725 void processVolume_l(Track *track, bool lastTrack); 726 727 // prepareTracks_l() tells threadLoop_mix() the name of the single active track 728 sp<Track> mActiveTrack; 729 public: 730 virtual bool hasFastMixer() const { return false; } 731 }; 732 733 class OffloadThread : public DirectOutputThread { 734 public: 735 736 OffloadThread(const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, 737 audio_io_handle_t id, uint32_t device); 738 virtual ~OffloadThread() {}; 739 740 protected: 741 // threadLoop snippets 742 virtual mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove); 743 virtual void threadLoop_exit(); 744 virtual void flushOutput_l(); 745 746 virtual bool waitingAsyncCallback(); 747 virtual bool waitingAsyncCallback_l(); 748 virtual bool shouldStandby_l(); 749 750 private: 751 void flushHw_l(); 752 753 private: 754 bool mHwPaused; 755 bool mFlushPending; 756 size_t mPausedWriteLength; // length in bytes of write interrupted by pause 757 size_t mPausedBytesRemaining; // bytes still waiting in mixbuffer after resume 758 Track *mPreviousTrack; // used to detect track switch 759 }; 760 761 class AsyncCallbackThread : public Thread { 762 public: 763 764 AsyncCallbackThread(const wp<PlaybackThread>& playbackThread); 765 766 virtual ~AsyncCallbackThread(); 767 768 // Thread virtuals 769 virtual bool threadLoop(); 770 771 // RefBase 772 virtual void onFirstRef(); 773 774 void exit(); 775 void setWriteBlocked(uint32_t sequence); 776 void resetWriteBlocked(); 777 void setDraining(uint32_t sequence); 778 void resetDraining(); 779 780 private: 781 const wp<PlaybackThread> mPlaybackThread; 782 // mWriteAckSequence corresponds to the last write sequence passed by the offload thread via 783 // setWriteBlocked(). The sequence is shifted one bit to the left and the lsb is used 784 // to indicate that the callback has been received via resetWriteBlocked() 785 uint32_t mWriteAckSequence; 786 // mDrainSequence corresponds to the last drain sequence passed by the offload thread via 787 // setDraining(). The sequence is shifted one bit to the left and the lsb is used 788 // to indicate that the callback has been received via resetDraining() 789 uint32_t mDrainSequence; 790 Condition mWaitWorkCV; 791 Mutex mLock; 792 }; 793 794 class DuplicatingThread : public MixerThread { 795 public: 796 DuplicatingThread(const sp<AudioFlinger>& audioFlinger, MixerThread* mainThread, 797 audio_io_handle_t id); 798 virtual ~DuplicatingThread(); 799 800 // Thread virtuals 801 void addOutputTrack(MixerThread* thread); 802 void removeOutputTrack(MixerThread* thread); 803 uint32_t waitTimeMs() const { return mWaitTimeMs; } 804 protected: 805 virtual uint32_t activeSleepTimeUs() const; 806 807 private: 808 bool outputsReady(const SortedVector< sp<OutputTrack> > &outputTracks); 809 protected: 810 // threadLoop snippets 811 virtual void threadLoop_mix(); 812 virtual void threadLoop_sleepTime(); 813 virtual ssize_t threadLoop_write(); 814 virtual void threadLoop_standby(); 815 virtual void cacheParameters_l(); 816 817 private: 818 // called from threadLoop, addOutputTrack, removeOutputTrack 819 virtual void updateWaitTime_l(); 820 protected: 821 virtual void saveOutputTracks(); 822 virtual void clearOutputTracks(); 823 private: 824 825 uint32_t mWaitTimeMs; 826 SortedVector < sp<OutputTrack> > outputTracks; 827 SortedVector < sp<OutputTrack> > mOutputTracks; 828 public: 829 virtual bool hasFastMixer() const { return false; } 830 }; 831 832 833 // record thread 834 class RecordThread : public ThreadBase, public AudioBufferProvider 835 // derives from AudioBufferProvider interface for use by resampler 836 { 837 public: 838 839 #include "RecordTracks.h" 840 841 RecordThread(const sp<AudioFlinger>& audioFlinger, 842 AudioStreamIn *input, 843 uint32_t sampleRate, 844 audio_channel_mask_t channelMask, 845 audio_io_handle_t id, 846 audio_devices_t outDevice, 847 audio_devices_t inDevice 848 #ifdef TEE_SINK 849 , const sp<NBAIO_Sink>& teeSink 850 #endif 851 ); 852 virtual ~RecordThread(); 853 854 // no addTrack_l ? 855 void destroyTrack_l(const sp<RecordTrack>& track); 856 void removeTrack_l(const sp<RecordTrack>& track); 857 858 void dumpInternals(int fd, const Vector<String16>& args); 859 void dumpTracks(int fd, const Vector<String16>& args); 860 861 // Thread virtuals 862 virtual bool threadLoop(); 863 virtual status_t readyToRun(); 864 865 // RefBase 866 virtual void onFirstRef(); 867 868 virtual status_t initCheck() const { return (mInput == NULL) ? NO_INIT : NO_ERROR; } 869 sp<AudioFlinger::RecordThread::RecordTrack> createRecordTrack_l( 870 const sp<AudioFlinger::Client>& client, 871 uint32_t sampleRate, 872 audio_format_t format, 873 audio_channel_mask_t channelMask, 874 size_t frameCount, 875 int sessionId, 876 IAudioFlinger::track_flags_t *flags, 877 pid_t tid, 878 status_t *status); 879 880 status_t start(RecordTrack* recordTrack, 881 AudioSystem::sync_event_t event, 882 int triggerSession); 883 884 // ask the thread to stop the specified track, and 885 // return true if the caller should then do it's part of the stopping process 886 bool stop(RecordTrack* recordTrack); 887 888 void dump(int fd, const Vector<String16>& args); 889 AudioStreamIn* clearInput(); 890 virtual audio_stream_t* stream() const; 891 892 // AudioBufferProvider interface 893 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer, int64_t pts); 894 virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer); 895 896 virtual bool checkForNewParameters_l(); 897 virtual String8 getParameters(const String8& keys); 898 virtual void audioConfigChanged_l(int event, int param = 0); 899 void readInputParameters(); 900 virtual unsigned int getInputFramesLost(); 901 902 virtual status_t addEffectChain_l(const sp<EffectChain>& chain); 903 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain); 904 virtual uint32_t hasAudioSession(int sessionId) const; 905 906 // Return the set of unique session IDs across all tracks. 907 // The keys are the session IDs, and the associated values are meaningless. 908 // FIXME replace by Set [and implement Bag/Multiset for other uses]. 909 KeyedVector<int, bool> sessionIds() const; 910 911 virtual status_t setSyncEvent(const sp<SyncEvent>& event); 912 virtual bool isValidSyncEvent(const sp<SyncEvent>& event) const; 913 914 static void syncStartEventCallback(const wp<SyncEvent>& event); 915 void handleSyncStartEvent(const sp<SyncEvent>& event); 916 917 virtual size_t frameCount() const { return mFrameCount; } 918 bool hasFastRecorder() const { return false; } 919 920 private: 921 void clearSyncStartEvent(); 922 923 // Enter standby if not already in standby, and set mStandby flag 924 void standby(); 925 926 // Call the HAL standby method unconditionally, and don't change mStandby flag 927 void inputStandBy(); 928 929 AudioStreamIn *mInput; 930 SortedVector < sp<RecordTrack> > mTracks; 931 // mActiveTrack has dual roles: it indicates the current active track, and 932 // is used together with mStartStopCond to indicate start()/stop() progress 933 sp<RecordTrack> mActiveTrack; 934 Condition mStartStopCond; 935 936 // updated by RecordThread::readInputParameters() 937 AudioResampler *mResampler; 938 // interleaved stereo pairs of fixed-point signed Q19.12 939 int32_t *mRsmpOutBuffer; 940 int16_t *mRsmpInBuffer; // [mFrameCount * mChannelCount] 941 size_t mRsmpInIndex; 942 size_t mBufferSize; // stream buffer size for read() 943 const uint32_t mReqChannelCount; 944 const uint32_t mReqSampleRate; 945 ssize_t mBytesRead; 946 // sync event triggering actual audio capture. Frames read before this event will 947 // be dropped and therefore not read by the application. 948 sp<SyncEvent> mSyncStartEvent; 949 // number of captured frames to drop after the start sync event has been received. 950 // when < 0, maximum frames to drop before starting capture even if sync event is 951 // not received 952 ssize_t mFramestoDrop; 953 954 // For dumpsys 955 const sp<NBAIO_Sink> mTeeSink; 956 int mClientUid; 957 }; 958
