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