Threads.h revision e2a9c29f35e0c09782558542fc4cf9823779590e
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 // TODO: rename mixBuffer() to sinkBuffer() or try to remove external use. 454 int16_t *mixBuffer() const { return mSinkBuffer; }; 455 456 virtual void detachAuxEffect_l(int effectId); 457 status_t attachAuxEffect(const sp<AudioFlinger::PlaybackThread::Track> track, 458 int EffectId); 459 status_t attachAuxEffect_l(const sp<AudioFlinger::PlaybackThread::Track> track, 460 int EffectId); 461 462 virtual status_t addEffectChain_l(const sp<EffectChain>& chain); 463 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain); 464 virtual uint32_t hasAudioSession(int sessionId) const; 465 virtual uint32_t getStrategyForSession_l(int sessionId); 466 467 468 virtual status_t setSyncEvent(const sp<SyncEvent>& event); 469 virtual bool isValidSyncEvent(const sp<SyncEvent>& event) const; 470 471 // called with AudioFlinger lock held 472 void invalidateTracks(audio_stream_type_t streamType); 473 474 virtual size_t frameCount() const { return mNormalFrameCount; } 475 476 // Return's the HAL's frame count i.e. fast mixer buffer size. 477 size_t frameCountHAL() const { return mFrameCount; } 478 479 status_t getTimestamp_l(AudioTimestamp& timestamp); 480 481protected: 482 // updated by readOutputParameters_l() 483 size_t mNormalFrameCount; // normal mixer and effects 484 485 int16_t* mSinkBuffer; // frame size aligned sink buffer 486 487 // TODO: 488 // Rearrange the buffer info into a struct/class with 489 // clear, copy, construction, destruction methods. 490 // 491 // mSinkBuffer also has associated with it: 492 // 493 // mSinkBufferSize: Sink Buffer Size 494 // mFormat: Sink Buffer Format 495 496 // Mixer Buffer (mMixerBuffer*) 497 // 498 // In the case of floating point or multichannel data, which is not in the 499 // sink format, it is required to accumulate in a higher precision or greater channel count 500 // buffer before downmixing or data conversion to the sink buffer. 501 502 // Set to "true" to enable the Mixer Buffer otherwise mixer output goes to sink buffer. 503 bool mMixerBufferEnabled; 504 505 // Storage, 32 byte aligned (may make this alignment a requirement later). 506 // Due to constraints on mNormalFrameCount, the buffer size is a multiple of 16 frames. 507 void* mMixerBuffer; 508 509 // Size of mMixerBuffer in bytes: mNormalFrameCount * #channels * sampsize. 510 size_t mMixerBufferSize; 511 512 // The audio format of mMixerBuffer. Set to AUDIO_FORMAT_PCM_(FLOAT|16_BIT) only. 513 audio_format_t mMixerBufferFormat; 514 515 // An internal flag set to true by MixerThread::prepareTracks_l() 516 // when mMixerBuffer contains valid data after mixing. 517 bool mMixerBufferValid; 518 519 // Effects Buffer (mEffectsBuffer*) 520 // 521 // In the case of effects data, which is not in the sink format, 522 // it is required to accumulate in a different buffer before data conversion 523 // to the sink buffer. 524 525 // Set to "true" to enable the Effects Buffer otherwise effects output goes to sink buffer. 526 bool mEffectBufferEnabled; 527 528 // Storage, 32 byte aligned (may make this alignment a requirement later). 529 // Due to constraints on mNormalFrameCount, the buffer size is a multiple of 16 frames. 530 void* mEffectBuffer; 531 532 // Size of mEffectsBuffer in bytes: mNormalFrameCount * #channels * sampsize. 533 size_t mEffectBufferSize; 534 535 // The audio format of mEffectsBuffer. Set to AUDIO_FORMAT_PCM_16_BIT only. 536 audio_format_t mEffectBufferFormat; 537 538 // An internal flag set to true by MixerThread::prepareTracks_l() 539 // when mEffectsBuffer contains valid data after mixing. 540 // 541 // When this is set, all mixer data is routed into the effects buffer 542 // for any processing (including output processing). 543 bool mEffectBufferValid; 544 545 // suspend count, > 0 means suspended. While suspended, the thread continues to pull from 546 // tracks and mix, but doesn't write to HAL. A2DP and SCO HAL implementations can't handle 547 // concurrent use of both of them, so Audio Policy Service suspends one of the threads to 548 // workaround that restriction. 549 // 'volatile' means accessed via atomic operations and no lock. 550 volatile int32_t mSuspended; 551 552 // FIXME overflows every 6+ hours at 44.1 kHz stereo 16-bit samples 553 // mFramesWritten would be better, or 64-bit even better 554 size_t mBytesWritten; 555private: 556 // mMasterMute is in both PlaybackThread and in AudioFlinger. When a 557 // PlaybackThread needs to find out if master-muted, it checks it's local 558 // copy rather than the one in AudioFlinger. This optimization saves a lock. 559 bool mMasterMute; 560 void setMasterMute_l(bool muted) { mMasterMute = muted; } 561protected: 562 SortedVector< wp<Track> > mActiveTracks; // FIXME check if this could be sp<> 563 SortedVector<int> mWakeLockUids; 564 int mActiveTracksGeneration; 565 wp<Track> mLatestActiveTrack; // latest track added to mActiveTracks 566 567 // Allocate a track name for a given channel mask. 568 // Returns name >= 0 if successful, -1 on failure. 569 virtual int getTrackName_l(audio_channel_mask_t channelMask, int sessionId) = 0; 570 virtual void deleteTrackName_l(int name) = 0; 571 572 // Time to sleep between cycles when: 573 virtual uint32_t activeSleepTimeUs() const; // mixer state MIXER_TRACKS_ENABLED 574 virtual uint32_t idleSleepTimeUs() const = 0; // mixer state MIXER_IDLE 575 virtual uint32_t suspendSleepTimeUs() const = 0; // audio policy manager suspended us 576 // No sleep when mixer state == MIXER_TRACKS_READY; relies on audio HAL stream->write() 577 // No sleep in standby mode; waits on a condition 578 579 // Code snippets that are temporarily lifted up out of threadLoop() until the merge 580 void checkSilentMode_l(); 581 582 // Non-trivial for DUPLICATING only 583 virtual void saveOutputTracks() { } 584 virtual void clearOutputTracks() { } 585 586 // Cache various calculated values, at threadLoop() entry and after a parameter change 587 virtual void cacheParameters_l(); 588 589 virtual uint32_t correctLatency_l(uint32_t latency) const; 590 591private: 592 593 friend class AudioFlinger; // for numerous 594 595 PlaybackThread(const Client&); 596 PlaybackThread& operator = (const PlaybackThread&); 597 598 status_t addTrack_l(const sp<Track>& track); 599 bool destroyTrack_l(const sp<Track>& track); 600 void removeTrack_l(const sp<Track>& track); 601 void broadcast_l(); 602 603 void readOutputParameters_l(); 604 605 virtual void dumpInternals(int fd, const Vector<String16>& args); 606 void dumpTracks(int fd, const Vector<String16>& args); 607 608 SortedVector< sp<Track> > mTracks; 609 // mStreamTypes[] uses 1 additional stream type internally for the OutputTrack used by 610 // DuplicatingThread 611 stream_type_t mStreamTypes[AUDIO_STREAM_CNT + 1]; 612 AudioStreamOut *mOutput; 613 614 float mMasterVolume; 615 nsecs_t mLastWriteTime; 616 int mNumWrites; 617 int mNumDelayedWrites; 618 bool mInWrite; 619 620 // FIXME rename these former local variables of threadLoop to standard "m" names 621 nsecs_t standbyTime; 622 size_t mSinkBufferSize; 623 624 // cached copies of activeSleepTimeUs() and idleSleepTimeUs() made by cacheParameters_l() 625 uint32_t activeSleepTime; 626 uint32_t idleSleepTime; 627 628 uint32_t sleepTime; 629 630 // mixer status returned by prepareTracks_l() 631 mixer_state mMixerStatus; // current cycle 632 // previous cycle when in prepareTracks_l() 633 mixer_state mMixerStatusIgnoringFastTracks; 634 // FIXME or a separate ready state per track 635 636 // FIXME move these declarations into the specific sub-class that needs them 637 // MIXER only 638 uint32_t sleepTimeShift; 639 640 // same as AudioFlinger::mStandbyTimeInNsecs except for DIRECT which uses a shorter value 641 nsecs_t standbyDelay; 642 643 // MIXER only 644 nsecs_t maxPeriod; 645 646 // DUPLICATING only 647 uint32_t writeFrames; 648 649 size_t mBytesRemaining; 650 size_t mCurrentWriteLength; 651 bool mUseAsyncWrite; 652 // mWriteAckSequence contains current write sequence on bits 31-1. The write sequence is 653 // incremented each time a write(), a flush() or a standby() occurs. 654 // Bit 0 is set when a write blocks and indicates a callback is expected. 655 // Bit 0 is reset by the async callback thread calling resetWriteBlocked(). Out of sequence 656 // callbacks are ignored. 657 uint32_t mWriteAckSequence; 658 // mDrainSequence contains current drain sequence on bits 31-1. The drain sequence is 659 // incremented each time a drain is requested or a flush() or standby() occurs. 660 // Bit 0 is set when the drain() command is called at the HAL and indicates a callback is 661 // expected. 662 // Bit 0 is reset by the async callback thread calling resetDraining(). Out of sequence 663 // callbacks are ignored. 664 uint32_t mDrainSequence; 665 // A condition that must be evaluated by prepareTrack_l() has changed and we must not wait 666 // for async write callback in the thread loop before evaluating it 667 bool mSignalPending; 668 sp<AsyncCallbackThread> mCallbackThread; 669 670private: 671 // The HAL output sink is treated as non-blocking, but current implementation is blocking 672 sp<NBAIO_Sink> mOutputSink; 673 // If a fast mixer is present, the blocking pipe sink, otherwise clear 674 sp<NBAIO_Sink> mPipeSink; 675 // The current sink for the normal mixer to write it's (sub)mix, mOutputSink or mPipeSink 676 sp<NBAIO_Sink> mNormalSink; 677#ifdef TEE_SINK 678 // For dumpsys 679 sp<NBAIO_Sink> mTeeSink; 680 sp<NBAIO_Source> mTeeSource; 681#endif 682 uint32_t mScreenState; // cached copy of gScreenState 683 static const size_t kFastMixerLogSize = 4 * 1024; 684 sp<NBLog::Writer> mFastMixerNBLogWriter; 685public: 686 virtual bool hasFastMixer() const = 0; 687 virtual FastTrackUnderruns getFastTrackUnderruns(size_t fastIndex __unused) const 688 { FastTrackUnderruns dummy; return dummy; } 689 690protected: 691 // accessed by both binder threads and within threadLoop(), lock on mutex needed 692 unsigned mFastTrackAvailMask; // bit i set if fast track [i] is available 693 694private: 695 // timestamp latch: 696 // D input is written by threadLoop_write while mutex is unlocked, and read while locked 697 // Q output is written while locked, and read while locked 698 struct { 699 AudioTimestamp mTimestamp; 700 uint32_t mUnpresentedFrames; 701 } mLatchD, mLatchQ; 702 bool mLatchDValid; // true means mLatchD is valid, and clock it into latch at next opportunity 703 bool mLatchQValid; // true means mLatchQ is valid 704}; 705 706class MixerThread : public PlaybackThread { 707public: 708 MixerThread(const sp<AudioFlinger>& audioFlinger, 709 AudioStreamOut* output, 710 audio_io_handle_t id, 711 audio_devices_t device, 712 type_t type = MIXER); 713 virtual ~MixerThread(); 714 715 // Thread virtuals 716 717 virtual bool checkForNewParameters_l(); 718 virtual void dumpInternals(int fd, const Vector<String16>& args); 719 720protected: 721 virtual mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove); 722 virtual int getTrackName_l(audio_channel_mask_t channelMask, int sessionId); 723 virtual void deleteTrackName_l(int name); 724 virtual uint32_t idleSleepTimeUs() const; 725 virtual uint32_t suspendSleepTimeUs() const; 726 virtual void cacheParameters_l(); 727 728 // threadLoop snippets 729 virtual ssize_t threadLoop_write(); 730 virtual void threadLoop_standby(); 731 virtual void threadLoop_mix(); 732 virtual void threadLoop_sleepTime(); 733 virtual void threadLoop_removeTracks(const Vector< sp<Track> >& tracksToRemove); 734 virtual uint32_t correctLatency_l(uint32_t latency) const; 735 736 AudioMixer* mAudioMixer; // normal mixer 737private: 738 // one-time initialization, no locks required 739 FastMixer* mFastMixer; // non-NULL if there is also a fast mixer 740 sp<AudioWatchdog> mAudioWatchdog; // non-0 if there is an audio watchdog thread 741 742 // contents are not guaranteed to be consistent, no locks required 743 FastMixerDumpState mFastMixerDumpState; 744#ifdef STATE_QUEUE_DUMP 745 StateQueueObserverDump mStateQueueObserverDump; 746 StateQueueMutatorDump mStateQueueMutatorDump; 747#endif 748 AudioWatchdogDump mAudioWatchdogDump; 749 750 // accessible only within the threadLoop(), no locks required 751 // mFastMixer->sq() // for mutating and pushing state 752 int32_t mFastMixerFutex; // for cold idle 753 754public: 755 virtual bool hasFastMixer() const { return mFastMixer != NULL; } 756 virtual FastTrackUnderruns getFastTrackUnderruns(size_t fastIndex) const { 757 ALOG_ASSERT(fastIndex < FastMixerState::kMaxFastTracks); 758 return mFastMixerDumpState.mTracks[fastIndex].mUnderruns; 759 } 760}; 761 762class DirectOutputThread : public PlaybackThread { 763public: 764 765 DirectOutputThread(const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, 766 audio_io_handle_t id, audio_devices_t device); 767 virtual ~DirectOutputThread(); 768 769 // Thread virtuals 770 771 virtual bool checkForNewParameters_l(); 772 773protected: 774 virtual int getTrackName_l(audio_channel_mask_t channelMask, int sessionId); 775 virtual void deleteTrackName_l(int name); 776 virtual uint32_t activeSleepTimeUs() const; 777 virtual uint32_t idleSleepTimeUs() const; 778 virtual uint32_t suspendSleepTimeUs() const; 779 virtual void cacheParameters_l(); 780 781 // threadLoop snippets 782 virtual mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove); 783 virtual void threadLoop_mix(); 784 virtual void threadLoop_sleepTime(); 785 786 // volumes last sent to audio HAL with stream->set_volume() 787 float mLeftVolFloat; 788 float mRightVolFloat; 789 790 DirectOutputThread(const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, 791 audio_io_handle_t id, uint32_t device, ThreadBase::type_t type); 792 void processVolume_l(Track *track, bool lastTrack); 793 794 // prepareTracks_l() tells threadLoop_mix() the name of the single active track 795 sp<Track> mActiveTrack; 796public: 797 virtual bool hasFastMixer() const { return false; } 798}; 799 800class OffloadThread : public DirectOutputThread { 801public: 802 803 OffloadThread(const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, 804 audio_io_handle_t id, uint32_t device); 805 virtual ~OffloadThread() {}; 806 807protected: 808 // threadLoop snippets 809 virtual mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove); 810 virtual void threadLoop_exit(); 811 812 virtual bool waitingAsyncCallback(); 813 virtual bool waitingAsyncCallback_l(); 814 virtual bool shouldStandby_l(); 815 virtual void onAddNewTrack_l(); 816 817private: 818 void flushHw_l(); 819 820private: 821 bool mHwPaused; 822 bool mFlushPending; 823 size_t mPausedWriteLength; // length in bytes of write interrupted by pause 824 size_t mPausedBytesRemaining; // bytes still waiting in mixbuffer after resume 825 wp<Track> mPreviousTrack; // used to detect track switch 826}; 827 828class AsyncCallbackThread : public Thread { 829public: 830 831 AsyncCallbackThread(const wp<PlaybackThread>& playbackThread); 832 833 virtual ~AsyncCallbackThread(); 834 835 // Thread virtuals 836 virtual bool threadLoop(); 837 838 // RefBase 839 virtual void onFirstRef(); 840 841 void exit(); 842 void setWriteBlocked(uint32_t sequence); 843 void resetWriteBlocked(); 844 void setDraining(uint32_t sequence); 845 void resetDraining(); 846 847private: 848 const wp<PlaybackThread> mPlaybackThread; 849 // mWriteAckSequence corresponds to the last write sequence passed by the offload thread via 850 // setWriteBlocked(). The sequence is shifted one bit to the left and the lsb is used 851 // to indicate that the callback has been received via resetWriteBlocked() 852 uint32_t mWriteAckSequence; 853 // mDrainSequence corresponds to the last drain sequence passed by the offload thread via 854 // setDraining(). The sequence is shifted one bit to the left and the lsb is used 855 // to indicate that the callback has been received via resetDraining() 856 uint32_t mDrainSequence; 857 Condition mWaitWorkCV; 858 Mutex mLock; 859}; 860 861class DuplicatingThread : public MixerThread { 862public: 863 DuplicatingThread(const sp<AudioFlinger>& audioFlinger, MixerThread* mainThread, 864 audio_io_handle_t id); 865 virtual ~DuplicatingThread(); 866 867 // Thread virtuals 868 void addOutputTrack(MixerThread* thread); 869 void removeOutputTrack(MixerThread* thread); 870 uint32_t waitTimeMs() const { return mWaitTimeMs; } 871protected: 872 virtual uint32_t activeSleepTimeUs() const; 873 874private: 875 bool outputsReady(const SortedVector< sp<OutputTrack> > &outputTracks); 876protected: 877 // threadLoop snippets 878 virtual void threadLoop_mix(); 879 virtual void threadLoop_sleepTime(); 880 virtual ssize_t threadLoop_write(); 881 virtual void threadLoop_standby(); 882 virtual void cacheParameters_l(); 883 884private: 885 // called from threadLoop, addOutputTrack, removeOutputTrack 886 virtual void updateWaitTime_l(); 887protected: 888 virtual void saveOutputTracks(); 889 virtual void clearOutputTracks(); 890private: 891 892 uint32_t mWaitTimeMs; 893 SortedVector < sp<OutputTrack> > outputTracks; 894 SortedVector < sp<OutputTrack> > mOutputTracks; 895public: 896 virtual bool hasFastMixer() const { return false; } 897}; 898 899 900// record thread 901class RecordThread : public ThreadBase 902{ 903public: 904 905 class RecordTrack; 906 class ResamplerBufferProvider : public AudioBufferProvider 907 // derives from AudioBufferProvider interface for use by resampler 908 { 909 public: 910 ResamplerBufferProvider(RecordTrack* recordTrack) : mRecordTrack(recordTrack) { } 911 virtual ~ResamplerBufferProvider() { } 912 // AudioBufferProvider interface 913 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer, int64_t pts); 914 virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer); 915 private: 916 RecordTrack * const mRecordTrack; 917 }; 918 919#include "RecordTracks.h" 920 921 RecordThread(const sp<AudioFlinger>& audioFlinger, 922 AudioStreamIn *input, 923 audio_io_handle_t id, 924 audio_devices_t outDevice, 925 audio_devices_t inDevice 926#ifdef TEE_SINK 927 , const sp<NBAIO_Sink>& teeSink 928#endif 929 ); 930 virtual ~RecordThread(); 931 932 // no addTrack_l ? 933 void destroyTrack_l(const sp<RecordTrack>& track); 934 void removeTrack_l(const sp<RecordTrack>& track); 935 936 void dumpInternals(int fd, const Vector<String16>& args); 937 void dumpTracks(int fd, const Vector<String16>& args); 938 939 // Thread virtuals 940 virtual bool threadLoop(); 941 942 // RefBase 943 virtual void onFirstRef(); 944 945 virtual status_t initCheck() const { return (mInput == NULL) ? NO_INIT : NO_ERROR; } 946 947 sp<AudioFlinger::RecordThread::RecordTrack> createRecordTrack_l( 948 const sp<AudioFlinger::Client>& client, 949 uint32_t sampleRate, 950 audio_format_t format, 951 audio_channel_mask_t channelMask, 952 size_t *pFrameCount, 953 int sessionId, 954 int uid, 955 IAudioFlinger::track_flags_t *flags, 956 pid_t tid, 957 status_t *status /*non-NULL*/); 958 959 status_t start(RecordTrack* recordTrack, 960 AudioSystem::sync_event_t event, 961 int triggerSession); 962 963 // ask the thread to stop the specified track, and 964 // return true if the caller should then do it's part of the stopping process 965 bool stop(RecordTrack* recordTrack); 966 967 void dump(int fd, const Vector<String16>& args); 968 AudioStreamIn* clearInput(); 969 virtual audio_stream_t* stream() const; 970 971 972 virtual bool checkForNewParameters_l(); 973 virtual String8 getParameters(const String8& keys); 974 virtual void audioConfigChanged_l(int event, int param = 0); 975 void readInputParameters_l(); 976 virtual uint32_t getInputFramesLost(); 977 978 virtual status_t addEffectChain_l(const sp<EffectChain>& chain); 979 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain); 980 virtual uint32_t hasAudioSession(int sessionId) const; 981 982 // Return the set of unique session IDs across all tracks. 983 // The keys are the session IDs, and the associated values are meaningless. 984 // FIXME replace by Set [and implement Bag/Multiset for other uses]. 985 KeyedVector<int, bool> sessionIds() const; 986 987 virtual status_t setSyncEvent(const sp<SyncEvent>& event); 988 virtual bool isValidSyncEvent(const sp<SyncEvent>& event) const; 989 990 static void syncStartEventCallback(const wp<SyncEvent>& event); 991 992 virtual size_t frameCount() const { return mFrameCount; } 993 bool hasFastRecorder() const { return false; } 994 995private: 996 // Enter standby if not already in standby, and set mStandby flag 997 void standbyIfNotAlreadyInStandby(); 998 999 // Call the HAL standby method unconditionally, and don't change mStandby flag 1000 void inputStandBy(); 1001 1002 AudioStreamIn *mInput; 1003 SortedVector < sp<RecordTrack> > mTracks; 1004 // mActiveTracks has dual roles: it indicates the current active track(s), and 1005 // is used together with mStartStopCond to indicate start()/stop() progress 1006 SortedVector< sp<RecordTrack> > mActiveTracks; 1007 // generation counter for mActiveTracks 1008 int mActiveTracksGen; 1009 Condition mStartStopCond; 1010 1011 // resampler converts input at HAL Hz to output at AudioRecord client Hz 1012 int16_t *mRsmpInBuffer; // see new[] for details on the size 1013 size_t mRsmpInFrames; // size of resampler input in frames 1014 size_t mRsmpInFramesP2;// size rounded up to a power-of-2 1015 1016 // rolling index that is never cleared 1017 int32_t mRsmpInRear; // last filled frame + 1 1018 1019 // For dumpsys 1020 const sp<NBAIO_Sink> mTeeSink; 1021}; 1022