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