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