Threads.h revision 56ecf3e3ce36d111a17d67485047836660128629
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 MMAP // control thread for MMAP stream 34 // If you add any values here, also update ThreadBase::threadTypeToString() 35 }; 36 37 static const char *threadTypeToString(type_t type); 38 39 ThreadBase(const sp<AudioFlinger>& audioFlinger, audio_io_handle_t id, 40 audio_devices_t outDevice, audio_devices_t inDevice, type_t type, 41 bool systemReady); 42 virtual ~ThreadBase(); 43 44 virtual status_t readyToRun(); 45 46 void dumpBase(int fd, const Vector<String16>& args); 47 void dumpEffectChains(int fd, const Vector<String16>& args); 48 49 void clearPowerManager(); 50 51 // base for record and playback 52 enum { 53 CFG_EVENT_IO, 54 CFG_EVENT_PRIO, 55 CFG_EVENT_SET_PARAMETER, 56 CFG_EVENT_CREATE_AUDIO_PATCH, 57 CFG_EVENT_RELEASE_AUDIO_PATCH, 58 }; 59 60 class ConfigEventData: public RefBase { 61 public: 62 virtual ~ConfigEventData() {} 63 64 virtual void dump(char *buffer, size_t size) = 0; 65 protected: 66 ConfigEventData() {} 67 }; 68 69 // Config event sequence by client if status needed (e.g binder thread calling setParameters()): 70 // 1. create SetParameterConfigEvent. This sets mWaitStatus in config event 71 // 2. Lock mLock 72 // 3. Call sendConfigEvent_l(): Append to mConfigEvents and mWaitWorkCV.signal 73 // 4. sendConfigEvent_l() reads status from event->mStatus; 74 // 5. sendConfigEvent_l() returns status 75 // 6. Unlock 76 // 77 // Parameter sequence by server: threadLoop calling processConfigEvents_l(): 78 // 1. Lock mLock 79 // 2. If there is an entry in mConfigEvents proceed ... 80 // 3. Read first entry in mConfigEvents 81 // 4. Remove first entry from mConfigEvents 82 // 5. Process 83 // 6. Set event->mStatus 84 // 7. event->mCond.signal 85 // 8. Unlock 86 87 class ConfigEvent: public RefBase { 88 public: 89 virtual ~ConfigEvent() {} 90 91 void dump(char *buffer, size_t size) { mData->dump(buffer, size); } 92 93 const int mType; // event type e.g. CFG_EVENT_IO 94 Mutex mLock; // mutex associated with mCond 95 Condition mCond; // condition for status return 96 status_t mStatus; // status communicated to sender 97 bool mWaitStatus; // true if sender is waiting for status 98 bool mRequiresSystemReady; // true if must wait for system ready to enter event queue 99 sp<ConfigEventData> mData; // event specific parameter data 100 101 protected: 102 explicit ConfigEvent(int type, bool requiresSystemReady = false) : 103 mType(type), mStatus(NO_ERROR), mWaitStatus(false), 104 mRequiresSystemReady(requiresSystemReady), mData(NULL) {} 105 }; 106 107 class IoConfigEventData : public ConfigEventData { 108 public: 109 IoConfigEventData(audio_io_config_event event, pid_t pid) : 110 mEvent(event), mPid(pid) {} 111 112 virtual void dump(char *buffer, size_t size) { 113 snprintf(buffer, size, "IO event: event %d\n", mEvent); 114 } 115 116 const audio_io_config_event mEvent; 117 const pid_t mPid; 118 }; 119 120 class IoConfigEvent : public ConfigEvent { 121 public: 122 IoConfigEvent(audio_io_config_event event, pid_t pid) : 123 ConfigEvent(CFG_EVENT_IO) { 124 mData = new IoConfigEventData(event, pid); 125 } 126 virtual ~IoConfigEvent() {} 127 }; 128 129 class PrioConfigEventData : public ConfigEventData { 130 public: 131 PrioConfigEventData(pid_t pid, pid_t tid, int32_t prio, bool forApp) : 132 mPid(pid), mTid(tid), mPrio(prio), mForApp(forApp) {} 133 134 virtual void dump(char *buffer, size_t size) { 135 snprintf(buffer, size, "Prio event: pid %d, tid %d, prio %d, for app? %d\n", 136 mPid, mTid, mPrio, mForApp); 137 } 138 139 const pid_t mPid; 140 const pid_t mTid; 141 const int32_t mPrio; 142 const bool mForApp; 143 }; 144 145 class PrioConfigEvent : public ConfigEvent { 146 public: 147 PrioConfigEvent(pid_t pid, pid_t tid, int32_t prio, bool forApp) : 148 ConfigEvent(CFG_EVENT_PRIO, true) { 149 mData = new PrioConfigEventData(pid, tid, prio, forApp); 150 } 151 virtual ~PrioConfigEvent() {} 152 }; 153 154 class SetParameterConfigEventData : public ConfigEventData { 155 public: 156 explicit SetParameterConfigEventData(String8 keyValuePairs) : 157 mKeyValuePairs(keyValuePairs) {} 158 159 virtual void dump(char *buffer, size_t size) { 160 snprintf(buffer, size, "KeyValue: %s\n", mKeyValuePairs.string()); 161 } 162 163 const String8 mKeyValuePairs; 164 }; 165 166 class SetParameterConfigEvent : public ConfigEvent { 167 public: 168 explicit SetParameterConfigEvent(String8 keyValuePairs) : 169 ConfigEvent(CFG_EVENT_SET_PARAMETER) { 170 mData = new SetParameterConfigEventData(keyValuePairs); 171 mWaitStatus = true; 172 } 173 virtual ~SetParameterConfigEvent() {} 174 }; 175 176 class CreateAudioPatchConfigEventData : public ConfigEventData { 177 public: 178 CreateAudioPatchConfigEventData(const struct audio_patch patch, 179 audio_patch_handle_t handle) : 180 mPatch(patch), mHandle(handle) {} 181 182 virtual void dump(char *buffer, size_t size) { 183 snprintf(buffer, size, "Patch handle: %u\n", mHandle); 184 } 185 186 const struct audio_patch mPatch; 187 audio_patch_handle_t mHandle; 188 }; 189 190 class CreateAudioPatchConfigEvent : public ConfigEvent { 191 public: 192 CreateAudioPatchConfigEvent(const struct audio_patch patch, 193 audio_patch_handle_t handle) : 194 ConfigEvent(CFG_EVENT_CREATE_AUDIO_PATCH) { 195 mData = new CreateAudioPatchConfigEventData(patch, handle); 196 mWaitStatus = true; 197 } 198 virtual ~CreateAudioPatchConfigEvent() {} 199 }; 200 201 class ReleaseAudioPatchConfigEventData : public ConfigEventData { 202 public: 203 explicit ReleaseAudioPatchConfigEventData(const audio_patch_handle_t handle) : 204 mHandle(handle) {} 205 206 virtual void dump(char *buffer, size_t size) { 207 snprintf(buffer, size, "Patch handle: %u\n", mHandle); 208 } 209 210 audio_patch_handle_t mHandle; 211 }; 212 213 class ReleaseAudioPatchConfigEvent : public ConfigEvent { 214 public: 215 explicit ReleaseAudioPatchConfigEvent(const audio_patch_handle_t handle) : 216 ConfigEvent(CFG_EVENT_RELEASE_AUDIO_PATCH) { 217 mData = new ReleaseAudioPatchConfigEventData(handle); 218 mWaitStatus = true; 219 } 220 virtual ~ReleaseAudioPatchConfigEvent() {} 221 }; 222 223 class PMDeathRecipient : public IBinder::DeathRecipient { 224 public: 225 explicit PMDeathRecipient(const wp<ThreadBase>& thread) : mThread(thread) {} 226 virtual ~PMDeathRecipient() {} 227 228 // IBinder::DeathRecipient 229 virtual void binderDied(const wp<IBinder>& who); 230 231 private: 232 DISALLOW_COPY_AND_ASSIGN(PMDeathRecipient); 233 234 wp<ThreadBase> mThread; 235 }; 236 237 virtual status_t initCheck() const = 0; 238 239 // static externally-visible 240 type_t type() const { return mType; } 241 bool isDuplicating() const { return (mType == DUPLICATING); } 242 243 audio_io_handle_t id() const { return mId;} 244 245 // dynamic externally-visible 246 uint32_t sampleRate() const { return mSampleRate; } 247 audio_channel_mask_t channelMask() const { return mChannelMask; } 248 audio_format_t format() const { return mHALFormat; } 249 uint32_t channelCount() const { return mChannelCount; } 250 // Called by AudioFlinger::frameCount(audio_io_handle_t output) and effects, 251 // and returns the [normal mix] buffer's frame count. 252 virtual size_t frameCount() const = 0; 253 254 // Return's the HAL's frame count i.e. fast mixer buffer size. 255 size_t frameCountHAL() const { return mFrameCount; } 256 257 size_t frameSize() const { return mFrameSize; } 258 259 // Should be "virtual status_t requestExitAndWait()" and override same 260 // method in Thread, but Thread::requestExitAndWait() is not yet virtual. 261 void exit(); 262 virtual bool checkForNewParameter_l(const String8& keyValuePair, 263 status_t& status) = 0; 264 virtual status_t setParameters(const String8& keyValuePairs); 265 virtual String8 getParameters(const String8& keys) = 0; 266 virtual void ioConfigChanged(audio_io_config_event event, pid_t pid = 0) = 0; 267 // sendConfigEvent_l() must be called with ThreadBase::mLock held 268 // Can temporarily release the lock if waiting for a reply from 269 // processConfigEvents_l(). 270 status_t sendConfigEvent_l(sp<ConfigEvent>& event); 271 void sendIoConfigEvent(audio_io_config_event event, pid_t pid = 0); 272 void sendIoConfigEvent_l(audio_io_config_event event, pid_t pid = 0); 273 void sendPrioConfigEvent(pid_t pid, pid_t tid, int32_t prio, bool forApp); 274 void sendPrioConfigEvent_l(pid_t pid, pid_t tid, int32_t prio, bool forApp); 275 status_t sendSetParameterConfigEvent_l(const String8& keyValuePair); 276 status_t sendCreateAudioPatchConfigEvent(const struct audio_patch *patch, 277 audio_patch_handle_t *handle); 278 status_t sendReleaseAudioPatchConfigEvent(audio_patch_handle_t handle); 279 void processConfigEvents_l(); 280 virtual void cacheParameters_l() = 0; 281 virtual status_t createAudioPatch_l(const struct audio_patch *patch, 282 audio_patch_handle_t *handle) = 0; 283 virtual status_t releaseAudioPatch_l(const audio_patch_handle_t handle) = 0; 284 virtual void getAudioPortConfig(struct audio_port_config *config) = 0; 285 286 287 // see note at declaration of mStandby, mOutDevice and mInDevice 288 bool standby() const { return mStandby; } 289 audio_devices_t outDevice() const { return mOutDevice; } 290 audio_devices_t inDevice() const { return mInDevice; } 291 audio_devices_t getDevice() const { return isOutput() ? mOutDevice : mInDevice; } 292 293 virtual bool isOutput() const = 0; 294 295 virtual sp<StreamHalInterface> stream() const = 0; 296 297 sp<EffectHandle> createEffect_l( 298 const sp<AudioFlinger::Client>& client, 299 const sp<IEffectClient>& effectClient, 300 int32_t priority, 301 audio_session_t sessionId, 302 effect_descriptor_t *desc, 303 int *enabled, 304 status_t *status /*non-NULL*/, 305 bool pinned); 306 307 // return values for hasAudioSession (bit field) 308 enum effect_state { 309 EFFECT_SESSION = 0x1, // the audio session corresponds to at least one 310 // effect 311 TRACK_SESSION = 0x2, // the audio session corresponds to at least one 312 // track 313 FAST_SESSION = 0x4 // the audio session corresponds to at least one 314 // fast track 315 }; 316 317 // get effect chain corresponding to session Id. 318 sp<EffectChain> getEffectChain(audio_session_t sessionId); 319 // same as getEffectChain() but must be called with ThreadBase mutex locked 320 sp<EffectChain> getEffectChain_l(audio_session_t sessionId) const; 321 // add an effect chain to the chain list (mEffectChains) 322 virtual status_t addEffectChain_l(const sp<EffectChain>& chain) = 0; 323 // remove an effect chain from the chain list (mEffectChains) 324 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain) = 0; 325 // lock all effect chains Mutexes. Must be called before releasing the 326 // ThreadBase mutex before processing the mixer and effects. This guarantees the 327 // integrity of the chains during the process. 328 // Also sets the parameter 'effectChains' to current value of mEffectChains. 329 void lockEffectChains_l(Vector< sp<EffectChain> >& effectChains); 330 // unlock effect chains after process 331 void unlockEffectChains(const Vector< sp<EffectChain> >& effectChains); 332 // get a copy of mEffectChains vector 333 Vector< sp<EffectChain> > getEffectChains_l() const { return mEffectChains; }; 334 // set audio mode to all effect chains 335 void setMode(audio_mode_t mode); 336 // get effect module with corresponding ID on specified audio session 337 sp<AudioFlinger::EffectModule> getEffect(audio_session_t sessionId, int effectId); 338 sp<AudioFlinger::EffectModule> getEffect_l(audio_session_t sessionId, int effectId); 339 // add and effect module. Also creates the effect chain is none exists for 340 // the effects audio session 341 status_t addEffect_l(const sp< EffectModule>& effect); 342 // remove and effect module. Also removes the effect chain is this was the last 343 // effect 344 void removeEffect_l(const sp< EffectModule>& effect, bool release = false); 345 // disconnect an effect handle from module and destroy module if last handle 346 void disconnectEffectHandle(EffectHandle *handle, bool unpinIfLast); 347 // detach all tracks connected to an auxiliary effect 348 virtual void detachAuxEffect_l(int effectId __unused) {} 349 // returns a combination of: 350 // - EFFECT_SESSION if effects on this audio session exist in one chain 351 // - TRACK_SESSION if tracks on this audio session exist 352 // - FAST_SESSION if fast tracks on this audio session exist 353 virtual uint32_t hasAudioSession_l(audio_session_t sessionId) const = 0; 354 uint32_t hasAudioSession(audio_session_t sessionId) const { 355 Mutex::Autolock _l(mLock); 356 return hasAudioSession_l(sessionId); 357 } 358 359 // the value returned by default implementation is not important as the 360 // strategy is only meaningful for PlaybackThread which implements this method 361 virtual uint32_t getStrategyForSession_l(audio_session_t sessionId __unused) 362 { return 0; } 363 364 // check if some effects must be suspended/restored when an effect is enabled 365 // or disabled 366 void checkSuspendOnEffectEnabled(const sp<EffectModule>& effect, 367 bool enabled, 368 audio_session_t sessionId = 369 AUDIO_SESSION_OUTPUT_MIX); 370 void checkSuspendOnEffectEnabled_l(const sp<EffectModule>& effect, 371 bool enabled, 372 audio_session_t sessionId = 373 AUDIO_SESSION_OUTPUT_MIX); 374 375 virtual status_t setSyncEvent(const sp<SyncEvent>& event) = 0; 376 virtual bool isValidSyncEvent(const sp<SyncEvent>& event) const = 0; 377 378 // Return a reference to a per-thread heap which can be used to allocate IMemory 379 // objects that will be read-only to client processes, read/write to mediaserver, 380 // and shared by all client processes of the thread. 381 // The heap is per-thread rather than common across all threads, because 382 // clients can't be trusted not to modify the offset of the IMemory they receive. 383 // If a thread does not have such a heap, this method returns 0. 384 virtual sp<MemoryDealer> readOnlyHeap() const { return 0; } 385 386 virtual sp<IMemory> pipeMemory() const { return 0; } 387 388 void systemReady(); 389 390 // checkEffectCompatibility_l() must be called with ThreadBase::mLock held 391 virtual status_t checkEffectCompatibility_l(const effect_descriptor_t *desc, 392 audio_session_t sessionId) = 0; 393 394 void broadcast_l(); 395 396 mutable Mutex mLock; 397 398protected: 399 400 // entry describing an effect being suspended in mSuspendedSessions keyed vector 401 class SuspendedSessionDesc : public RefBase { 402 public: 403 SuspendedSessionDesc() : mRefCount(0) {} 404 405 int mRefCount; // number of active suspend requests 406 effect_uuid_t mType; // effect type UUID 407 }; 408 409 void acquireWakeLock(); 410 virtual void acquireWakeLock_l(); 411 void releaseWakeLock(); 412 void releaseWakeLock_l(); 413 void updateWakeLockUids_l(const SortedVector<uid_t> &uids); 414 void getPowerManager_l(); 415 // suspend or restore effects of the specified type (or all if type is NULL) 416 // on a given session. The number of suspend requests is counted and restore 417 // occurs when all suspend requests are cancelled. 418 void setEffectSuspended_l(const effect_uuid_t *type, 419 bool suspend, 420 audio_session_t sessionId); 421 // updated mSuspendedSessions when an effect is suspended or restored 422 void updateSuspendedSessions_l(const effect_uuid_t *type, 423 bool suspend, 424 audio_session_t sessionId); 425 // check if some effects must be suspended when an effect chain is added 426 void checkSuspendOnAddEffectChain_l(const sp<EffectChain>& chain); 427 428 String16 getWakeLockTag(); 429 430 virtual void preExit() { } 431 virtual void setMasterMono_l(bool mono __unused) { } 432 virtual bool requireMonoBlend() { return false; } 433 434 friend class AudioFlinger; // for mEffectChains 435 436 const type_t mType; 437 438 // Used by parameters, config events, addTrack_l, exit 439 Condition mWaitWorkCV; 440 441 const sp<AudioFlinger> mAudioFlinger; 442 443 // updated by PlaybackThread::readOutputParameters_l() or 444 // RecordThread::readInputParameters_l() 445 uint32_t mSampleRate; 446 size_t mFrameCount; // output HAL, direct output, record 447 audio_channel_mask_t mChannelMask; 448 uint32_t mChannelCount; 449 size_t mFrameSize; 450 // not HAL frame size, this is for output sink (to pipe to fast mixer) 451 audio_format_t mFormat; // Source format for Recording and 452 // Sink format for Playback. 453 // Sink format may be different than 454 // HAL format if Fastmixer is used. 455 audio_format_t mHALFormat; 456 size_t mBufferSize; // HAL buffer size for read() or write() 457 458 Vector< sp<ConfigEvent> > mConfigEvents; 459 Vector< sp<ConfigEvent> > mPendingConfigEvents; // events awaiting system ready 460 461 // These fields are written and read by thread itself without lock or barrier, 462 // and read by other threads without lock or barrier via standby(), outDevice() 463 // and inDevice(). 464 // Because of the absence of a lock or barrier, any other thread that reads 465 // these fields must use the information in isolation, or be prepared to deal 466 // with possibility that it might be inconsistent with other information. 467 bool mStandby; // Whether thread is currently in standby. 468 audio_devices_t mOutDevice; // output device 469 audio_devices_t mInDevice; // input device 470 audio_devices_t mPrevOutDevice; // previous output device 471 audio_devices_t mPrevInDevice; // previous input device 472 struct audio_patch mPatch; 473 audio_source_t mAudioSource; 474 475 const audio_io_handle_t mId; 476 Vector< sp<EffectChain> > mEffectChains; 477 478 static const int kThreadNameLength = 16; // prctl(PR_SET_NAME) limit 479 char mThreadName[kThreadNameLength]; // guaranteed NUL-terminated 480 sp<IPowerManager> mPowerManager; 481 sp<IBinder> mWakeLockToken; 482 const sp<PMDeathRecipient> mDeathRecipient; 483 // list of suspended effects per session and per type. The first (outer) vector is 484 // keyed by session ID, the second (inner) by type UUID timeLow field 485 // Updated by updateSuspendedSessions_l() only. 486 KeyedVector< audio_session_t, KeyedVector< int, sp<SuspendedSessionDesc> > > 487 mSuspendedSessions; 488 // TODO: add comment and adjust size as needed 489 static const size_t kLogSize = 4 * 1024; 490 sp<NBLog::Writer> mNBLogWriter; 491 bool mSystemReady; 492 ExtendedTimestamp mTimestamp; 493 // A condition that must be evaluated by the thread loop has changed and 494 // we must not wait for async write callback in the thread loop before evaluating it 495 bool mSignalPending; 496 497 // ActiveTracks is a sorted vector of track type T representing the 498 // active tracks of threadLoop() to be considered by the locked prepare portion. 499 // ActiveTracks should be accessed with the ThreadBase lock held. 500 // 501 // During processing and I/O, the threadLoop does not hold the lock; 502 // hence it does not directly use ActiveTracks. Care should be taken 503 // to hold local strong references or defer removal of tracks 504 // if the threadLoop may still be accessing those tracks due to mix, etc. 505 // 506 // This class updates power information appropriately. 507 // 508 509 template <typename T> 510 class ActiveTracks { 511 public: 512 explicit ActiveTracks(SimpleLog *localLog = nullptr) 513 : mActiveTracksGeneration(0) 514 , mLastActiveTracksGeneration(0) 515 , mLocalLog(localLog) 516 { } 517 518 ~ActiveTracks() { 519 ALOGW_IF(!mActiveTracks.isEmpty(), 520 "ActiveTracks should be empty in destructor"); 521 } 522 // returns the last track added (even though it may have been 523 // subsequently removed from ActiveTracks). 524 // 525 // Used for DirectOutputThread to ensure a flush is called when transitioning 526 // to a new track (even though it may be on the same session). 527 // Used for OffloadThread to ensure that volume and mixer state is 528 // taken from the latest track added. 529 // 530 // The latest track is saved with a weak pointer to prevent keeping an 531 // otherwise useless track alive. Thus the function will return nullptr 532 // if the latest track has subsequently been removed and destroyed. 533 sp<T> getLatest() { 534 return mLatestActiveTrack.promote(); 535 } 536 537 // SortedVector methods 538 ssize_t add(const sp<T> &track); 539 ssize_t remove(const sp<T> &track); 540 size_t size() const { 541 return mActiveTracks.size(); 542 } 543 ssize_t indexOf(const sp<T>& item) { 544 return mActiveTracks.indexOf(item); 545 } 546 sp<T> operator[](size_t index) const { 547 return mActiveTracks[index]; 548 } 549 typename SortedVector<sp<T>>::iterator begin() { 550 return mActiveTracks.begin(); 551 } 552 typename SortedVector<sp<T>>::iterator end() { 553 return mActiveTracks.end(); 554 } 555 556 // Due to Binder recursion optimization, clear() and updatePowerState() 557 // cannot be called from a Binder thread because they may call back into 558 // the original calling process (system server) for BatteryNotifier 559 // (which requires a Java environment that may not be present). 560 // Hence, call clear() and updatePowerState() only from the 561 // ThreadBase thread. 562 void clear(); 563 // periodically called in the threadLoop() to update power state uids. 564 void updatePowerState(sp<ThreadBase> thread, bool force = false); 565 566 private: 567 void logTrack(const char *funcName, const sp<T> &track) const; 568 569 SortedVector<uid_t> getWakeLockUids() { 570 SortedVector<uid_t> wakeLockUids; 571 for (const sp<T> &track : mActiveTracks) { 572 wakeLockUids.add(track->uid()); 573 } 574 return wakeLockUids; // moved by underlying SharedBuffer 575 } 576 577 std::map<uid_t, std::pair<ssize_t /* previous */, ssize_t /* current */>> 578 mBatteryCounter; 579 SortedVector<sp<T>> mActiveTracks; 580 int mActiveTracksGeneration; 581 int mLastActiveTracksGeneration; 582 wp<T> mLatestActiveTrack; // latest track added to ActiveTracks 583 SimpleLog * const mLocalLog; 584 }; 585 586 SimpleLog mLocalLog; 587}; 588 589class VolumeInterface { 590 public: 591 592 virtual ~VolumeInterface() {} 593 594 virtual void setMasterVolume(float value) = 0; 595 virtual void setMasterMute(bool muted) = 0; 596 virtual void setStreamVolume(audio_stream_type_t stream, float value) = 0; 597 virtual void setStreamMute(audio_stream_type_t stream, bool muted) = 0; 598 virtual float streamVolume(audio_stream_type_t stream) const = 0; 599 600}; 601 602// --- PlaybackThread --- 603class PlaybackThread : public ThreadBase, public StreamOutHalInterfaceCallback, 604 public VolumeInterface { 605public: 606 607#include "PlaybackTracks.h" 608 609 enum mixer_state { 610 MIXER_IDLE, // no active tracks 611 MIXER_TRACKS_ENABLED, // at least one active track, but no track has any data ready 612 MIXER_TRACKS_READY, // at least one active track, and at least one track has data 613 MIXER_DRAIN_TRACK, // drain currently playing track 614 MIXER_DRAIN_ALL, // fully drain the hardware 615 // standby mode does not have an enum value 616 // suspend by audio policy manager is orthogonal to mixer state 617 }; 618 619 // retry count before removing active track in case of underrun on offloaded thread: 620 // we need to make sure that AudioTrack client has enough time to send large buffers 621 //FIXME may be more appropriate if expressed in time units. Need to revise how underrun is 622 // handled for offloaded tracks 623 static const int8_t kMaxTrackRetriesOffload = 20; 624 static const int8_t kMaxTrackStartupRetriesOffload = 100; 625 static const int8_t kMaxTrackStopRetriesOffload = 2; 626 static constexpr uint32_t kMaxTracksPerUid = 40; 627 static constexpr size_t kMaxTracks = 256; 628 629 // Maximum delay (in nanoseconds) for upcoming buffers in suspend mode, otherwise 630 // if delay is greater, the estimated time for timeLoopNextNs is reset. 631 // This allows for catch-up to be done for small delays, while resetting the estimate 632 // for initial conditions or large delays. 633 static const nsecs_t kMaxNextBufferDelayNs = 100000000; 634 635 PlaybackThread(const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, 636 audio_io_handle_t id, audio_devices_t device, type_t type, bool systemReady); 637 virtual ~PlaybackThread(); 638 639 void dump(int fd, const Vector<String16>& args); 640 641 // Thread virtuals 642 virtual bool threadLoop(); 643 644 // RefBase 645 virtual void onFirstRef(); 646 647 virtual status_t checkEffectCompatibility_l(const effect_descriptor_t *desc, 648 audio_session_t sessionId); 649 650protected: 651 // Code snippets that were lifted up out of threadLoop() 652 virtual void threadLoop_mix() = 0; 653 virtual void threadLoop_sleepTime() = 0; 654 virtual ssize_t threadLoop_write(); 655 virtual void threadLoop_drain(); 656 virtual void threadLoop_standby(); 657 virtual void threadLoop_exit(); 658 virtual void threadLoop_removeTracks(const Vector< sp<Track> >& tracksToRemove); 659 660 // prepareTracks_l reads and writes mActiveTracks, and returns 661 // the pending set of tracks to remove via Vector 'tracksToRemove'. The caller 662 // is responsible for clearing or destroying this Vector later on, when it 663 // is safe to do so. That will drop the final ref count and destroy the tracks. 664 virtual mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove) = 0; 665 void removeTracks_l(const Vector< sp<Track> >& tracksToRemove); 666 667 // StreamOutHalInterfaceCallback implementation 668 virtual void onWriteReady(); 669 virtual void onDrainReady(); 670 virtual void onError(); 671 672 void resetWriteBlocked(uint32_t sequence); 673 void resetDraining(uint32_t sequence); 674 675 virtual bool waitingAsyncCallback(); 676 virtual bool waitingAsyncCallback_l(); 677 virtual bool shouldStandby_l(); 678 virtual void onAddNewTrack_l(); 679 void onAsyncError(); // error reported by AsyncCallbackThread 680 681 // ThreadBase virtuals 682 virtual void preExit(); 683 684 virtual bool keepWakeLock() const { return true; } 685 virtual void acquireWakeLock_l() { 686 ThreadBase::acquireWakeLock_l(); 687 mActiveTracks.updatePowerState(this, true /* force */); 688 } 689 690public: 691 692 virtual status_t initCheck() const { return (mOutput == NULL) ? NO_INIT : NO_ERROR; } 693 694 // return estimated latency in milliseconds, as reported by HAL 695 uint32_t latency() const; 696 // same, but lock must already be held 697 uint32_t latency_l() const; 698 699 // VolumeInterface 700 virtual void setMasterVolume(float value); 701 virtual void setMasterMute(bool muted); 702 virtual void setStreamVolume(audio_stream_type_t stream, float value); 703 virtual void setStreamMute(audio_stream_type_t stream, bool muted); 704 virtual float streamVolume(audio_stream_type_t stream) const; 705 706 sp<Track> createTrack_l( 707 const sp<AudioFlinger::Client>& client, 708 audio_stream_type_t streamType, 709 uint32_t *sampleRate, 710 audio_format_t format, 711 audio_channel_mask_t channelMask, 712 size_t *pFrameCount, 713 size_t *pNotificationFrameCount, 714 uint32_t notificationsPerBuffer, 715 float speed, 716 const sp<IMemory>& sharedBuffer, 717 audio_session_t sessionId, 718 audio_output_flags_t *flags, 719 pid_t tid, 720 uid_t uid, 721 status_t *status /*non-NULL*/, 722 audio_port_handle_t portId); 723 724 AudioStreamOut* getOutput() const; 725 AudioStreamOut* clearOutput(); 726 virtual sp<StreamHalInterface> stream() const; 727 728 // a very large number of suspend() will eventually wraparound, but unlikely 729 void suspend() { (void) android_atomic_inc(&mSuspended); } 730 void restore() 731 { 732 // if restore() is done without suspend(), get back into 733 // range so that the next suspend() will operate correctly 734 if (android_atomic_dec(&mSuspended) <= 0) { 735 android_atomic_release_store(0, &mSuspended); 736 } 737 } 738 bool isSuspended() const 739 { return android_atomic_acquire_load(&mSuspended) > 0; } 740 741 virtual String8 getParameters(const String8& keys); 742 virtual void ioConfigChanged(audio_io_config_event event, pid_t pid = 0); 743 status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames); 744 // Consider also removing and passing an explicit mMainBuffer initialization 745 // parameter to AF::PlaybackThread::Track::Track(). 746 effect_buffer_t *sinkBuffer() const { 747 return reinterpret_cast<effect_buffer_t *>(mSinkBuffer); }; 748 749 virtual void detachAuxEffect_l(int effectId); 750 status_t attachAuxEffect(const sp<AudioFlinger::PlaybackThread::Track>& track, 751 int EffectId); 752 status_t attachAuxEffect_l(const sp<AudioFlinger::PlaybackThread::Track>& track, 753 int EffectId); 754 755 virtual status_t addEffectChain_l(const sp<EffectChain>& chain); 756 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain); 757 virtual uint32_t hasAudioSession_l(audio_session_t sessionId) const; 758 virtual uint32_t getStrategyForSession_l(audio_session_t sessionId); 759 760 761 virtual status_t setSyncEvent(const sp<SyncEvent>& event); 762 virtual bool isValidSyncEvent(const sp<SyncEvent>& event) const; 763 764 // called with AudioFlinger lock held 765 bool invalidateTracks_l(audio_stream_type_t streamType); 766 virtual void invalidateTracks(audio_stream_type_t streamType); 767 768 virtual size_t frameCount() const { return mNormalFrameCount; } 769 770 status_t getTimestamp_l(AudioTimestamp& timestamp); 771 772 void addPatchTrack(const sp<PatchTrack>& track); 773 void deletePatchTrack(const sp<PatchTrack>& track); 774 775 virtual void getAudioPortConfig(struct audio_port_config *config); 776 777 // Return the asynchronous signal wait time. 778 virtual int64_t computeWaitTimeNs_l() const { return INT64_MAX; } 779 780 virtual bool isOutput() const override { return true; } 781 782 // returns true if the track is allowed to be added to the thread. 783 virtual bool isTrackAllowed_l( 784 audio_channel_mask_t channelMask __unused, 785 audio_format_t format __unused, 786 audio_session_t sessionId __unused, 787 uid_t uid) const { 788 return trackCountForUid_l(uid) < PlaybackThread::kMaxTracksPerUid 789 && mTracks.size() < PlaybackThread::kMaxTracks; 790 } 791 792protected: 793 // updated by readOutputParameters_l() 794 size_t mNormalFrameCount; // normal mixer and effects 795 796 bool mThreadThrottle; // throttle the thread processing 797 uint32_t mThreadThrottleTimeMs; // throttle time for MIXER threads 798 uint32_t mThreadThrottleEndMs; // notify once per throttling 799 uint32_t mHalfBufferMs; // half the buffer size in milliseconds 800 801 void* mSinkBuffer; // frame size aligned sink buffer 802 803 // TODO: 804 // Rearrange the buffer info into a struct/class with 805 // clear, copy, construction, destruction methods. 806 // 807 // mSinkBuffer also has associated with it: 808 // 809 // mSinkBufferSize: Sink Buffer Size 810 // mFormat: Sink Buffer Format 811 812 // Mixer Buffer (mMixerBuffer*) 813 // 814 // In the case of floating point or multichannel data, which is not in the 815 // sink format, it is required to accumulate in a higher precision or greater channel count 816 // buffer before downmixing or data conversion to the sink buffer. 817 818 // Set to "true" to enable the Mixer Buffer otherwise mixer output goes to sink buffer. 819 bool mMixerBufferEnabled; 820 821 // Storage, 32 byte aligned (may make this alignment a requirement later). 822 // Due to constraints on mNormalFrameCount, the buffer size is a multiple of 16 frames. 823 void* mMixerBuffer; 824 825 // Size of mMixerBuffer in bytes: mNormalFrameCount * #channels * sampsize. 826 size_t mMixerBufferSize; 827 828 // The audio format of mMixerBuffer. Set to AUDIO_FORMAT_PCM_(FLOAT|16_BIT) only. 829 audio_format_t mMixerBufferFormat; 830 831 // An internal flag set to true by MixerThread::prepareTracks_l() 832 // when mMixerBuffer contains valid data after mixing. 833 bool mMixerBufferValid; 834 835 // Effects Buffer (mEffectsBuffer*) 836 // 837 // In the case of effects data, which is not in the sink format, 838 // it is required to accumulate in a different buffer before data conversion 839 // to the sink buffer. 840 841 // Set to "true" to enable the Effects Buffer otherwise effects output goes to sink buffer. 842 bool mEffectBufferEnabled; 843 844 // Storage, 32 byte aligned (may make this alignment a requirement later). 845 // Due to constraints on mNormalFrameCount, the buffer size is a multiple of 16 frames. 846 void* mEffectBuffer; 847 848 // Size of mEffectsBuffer in bytes: mNormalFrameCount * #channels * sampsize. 849 size_t mEffectBufferSize; 850 851 // The audio format of mEffectsBuffer. Set to AUDIO_FORMAT_PCM_16_BIT only. 852 audio_format_t mEffectBufferFormat; 853 854 // An internal flag set to true by MixerThread::prepareTracks_l() 855 // when mEffectsBuffer contains valid data after mixing. 856 // 857 // When this is set, all mixer data is routed into the effects buffer 858 // for any processing (including output processing). 859 bool mEffectBufferValid; 860 861 // suspend count, > 0 means suspended. While suspended, the thread continues to pull from 862 // tracks and mix, but doesn't write to HAL. A2DP and SCO HAL implementations can't handle 863 // concurrent use of both of them, so Audio Policy Service suspends one of the threads to 864 // workaround that restriction. 865 // 'volatile' means accessed via atomic operations and no lock. 866 volatile int32_t mSuspended; 867 868 int64_t mBytesWritten; 869 int64_t mFramesWritten; // not reset on standby 870 int64_t mSuspendedFrames; // not reset on standby 871private: 872 // mMasterMute is in both PlaybackThread and in AudioFlinger. When a 873 // PlaybackThread needs to find out if master-muted, it checks it's local 874 // copy rather than the one in AudioFlinger. This optimization saves a lock. 875 bool mMasterMute; 876 void setMasterMute_l(bool muted) { mMasterMute = muted; } 877protected: 878 ActiveTracks<Track> mActiveTracks; 879 880 // Time to sleep between cycles when: 881 virtual uint32_t activeSleepTimeUs() const; // mixer state MIXER_TRACKS_ENABLED 882 virtual uint32_t idleSleepTimeUs() const = 0; // mixer state MIXER_IDLE 883 virtual uint32_t suspendSleepTimeUs() const = 0; // audio policy manager suspended us 884 // No sleep when mixer state == MIXER_TRACKS_READY; relies on audio HAL stream->write() 885 // No sleep in standby mode; waits on a condition 886 887 // Code snippets that are temporarily lifted up out of threadLoop() until the merge 888 void checkSilentMode_l(); 889 890 // Non-trivial for DUPLICATING only 891 virtual void saveOutputTracks() { } 892 virtual void clearOutputTracks() { } 893 894 // Cache various calculated values, at threadLoop() entry and after a parameter change 895 virtual void cacheParameters_l(); 896 897 virtual uint32_t correctLatency_l(uint32_t latency) const; 898 899 virtual status_t createAudioPatch_l(const struct audio_patch *patch, 900 audio_patch_handle_t *handle); 901 virtual status_t releaseAudioPatch_l(const audio_patch_handle_t handle); 902 903 bool usesHwAvSync() const { return (mType == DIRECT) && (mOutput != NULL) 904 && mHwSupportsPause 905 && (mOutput->flags & AUDIO_OUTPUT_FLAG_HW_AV_SYNC); } 906 907 uint32_t trackCountForUid_l(uid_t uid) const; 908 909private: 910 911 friend class AudioFlinger; // for numerous 912 913 DISALLOW_COPY_AND_ASSIGN(PlaybackThread); 914 915 status_t addTrack_l(const sp<Track>& track); 916 bool destroyTrack_l(const sp<Track>& track); 917 void removeTrack_l(const sp<Track>& track); 918 919 void readOutputParameters_l(); 920 921 virtual void dumpInternals(int fd, const Vector<String16>& args); 922 void dumpTracks(int fd, const Vector<String16>& args); 923 924 // The Tracks class manages names for all tracks 925 // added and removed from the Thread. 926 template <typename T> 927 class Tracks { 928 public: 929 Tracks(bool saveDeletedTrackNames) : 930 mSaveDeletedTrackNames(saveDeletedTrackNames) { } 931 932 // SortedVector methods 933 ssize_t add(const sp<T> &track); 934 ssize_t remove(const sp<T> &track); 935 size_t size() const { 936 return mTracks.size(); 937 } 938 bool isEmpty() const { 939 return mTracks.isEmpty(); 940 } 941 ssize_t indexOf(const sp<T> &item) { 942 return mTracks.indexOf(item); 943 } 944 sp<T> operator[](size_t index) const { 945 return mTracks[index]; 946 } 947 typename SortedVector<sp<T>>::iterator begin() { 948 return mTracks.begin(); 949 } 950 typename SortedVector<sp<T>>::iterator end() { 951 return mTracks.end(); 952 } 953 954 size_t processDeletedTrackNames(std::function<void(int)> f) { 955 const size_t size = mDeletedTrackNames.size(); 956 if (size > 0) { 957 for (const int name : mDeletedTrackNames) { 958 f(name); 959 } 960 } 961 return size; 962 } 963 964 void clearDeletedTrackNames() { mDeletedTrackNames.clear(); } 965 966 private: 967 // Track names pending deletion for MIXER type threads 968 const bool mSaveDeletedTrackNames; // true to enable tracking 969 std::set<int> mDeletedTrackNames; 970 971 // Fast lookup of previously deleted track names for reuse. 972 // This is an arbitrary decision (actually any non-negative 973 // integer that isn't in mTracks[*]->names() could be used) - we attempt 974 // to use the smallest possible available name. 975 std::set<int> mUnusedTrackNames; 976 977 SortedVector<sp<T>> mTracks; // wrapped SortedVector. 978 }; 979 980 Tracks<Track> mTracks; 981 982 stream_type_t mStreamTypes[AUDIO_STREAM_CNT]; 983 AudioStreamOut *mOutput; 984 985 float mMasterVolume; 986 nsecs_t mLastWriteTime; 987 int mNumWrites; 988 int mNumDelayedWrites; 989 bool mInWrite; 990 991 // FIXME rename these former local variables of threadLoop to standard "m" names 992 nsecs_t mStandbyTimeNs; 993 size_t mSinkBufferSize; 994 995 // cached copies of activeSleepTimeUs() and idleSleepTimeUs() made by cacheParameters_l() 996 uint32_t mActiveSleepTimeUs; 997 uint32_t mIdleSleepTimeUs; 998 999 uint32_t mSleepTimeUs; 1000 1001 // mixer status returned by prepareTracks_l() 1002 mixer_state mMixerStatus; // current cycle 1003 // previous cycle when in prepareTracks_l() 1004 mixer_state mMixerStatusIgnoringFastTracks; 1005 // FIXME or a separate ready state per track 1006 1007 // FIXME move these declarations into the specific sub-class that needs them 1008 // MIXER only 1009 uint32_t sleepTimeShift; 1010 1011 // same as AudioFlinger::mStandbyTimeInNsecs except for DIRECT which uses a shorter value 1012 nsecs_t mStandbyDelayNs; 1013 1014 // MIXER only 1015 nsecs_t maxPeriod; 1016 1017 // DUPLICATING only 1018 uint32_t writeFrames; 1019 1020 size_t mBytesRemaining; 1021 size_t mCurrentWriteLength; 1022 bool mUseAsyncWrite; 1023 // mWriteAckSequence contains current write sequence on bits 31-1. The write sequence is 1024 // incremented each time a write(), a flush() or a standby() occurs. 1025 // Bit 0 is set when a write blocks and indicates a callback is expected. 1026 // Bit 0 is reset by the async callback thread calling resetWriteBlocked(). Out of sequence 1027 // callbacks are ignored. 1028 uint32_t mWriteAckSequence; 1029 // mDrainSequence contains current drain sequence on bits 31-1. The drain sequence is 1030 // incremented each time a drain is requested or a flush() or standby() occurs. 1031 // Bit 0 is set when the drain() command is called at the HAL and indicates a callback is 1032 // expected. 1033 // Bit 0 is reset by the async callback thread calling resetDraining(). Out of sequence 1034 // callbacks are ignored. 1035 uint32_t mDrainSequence; 1036 sp<AsyncCallbackThread> mCallbackThread; 1037 1038private: 1039 // The HAL output sink is treated as non-blocking, but current implementation is blocking 1040 sp<NBAIO_Sink> mOutputSink; 1041 // If a fast mixer is present, the blocking pipe sink, otherwise clear 1042 sp<NBAIO_Sink> mPipeSink; 1043 // The current sink for the normal mixer to write it's (sub)mix, mOutputSink or mPipeSink 1044 sp<NBAIO_Sink> mNormalSink; 1045#ifdef TEE_SINK 1046 // For dumpsys 1047 sp<NBAIO_Sink> mTeeSink; 1048 sp<NBAIO_Source> mTeeSource; 1049#endif 1050 uint32_t mScreenState; // cached copy of gScreenState 1051 // TODO: add comment and adjust size as needed 1052 static const size_t kFastMixerLogSize = 8 * 1024; 1053 sp<NBLog::Writer> mFastMixerNBLogWriter; 1054 1055 1056public: 1057 virtual bool hasFastMixer() const = 0; 1058 virtual FastTrackUnderruns getFastTrackUnderruns(size_t fastIndex __unused) const 1059 { FastTrackUnderruns dummy; return dummy; } 1060 1061protected: 1062 // accessed by both binder threads and within threadLoop(), lock on mutex needed 1063 unsigned mFastTrackAvailMask; // bit i set if fast track [i] is available 1064 bool mHwSupportsPause; 1065 bool mHwPaused; 1066 bool mFlushPending; 1067 // volumes last sent to audio HAL with stream->setVolume() 1068 float mLeftVolFloat; 1069 float mRightVolFloat; 1070}; 1071 1072class MixerThread : public PlaybackThread { 1073public: 1074 MixerThread(const sp<AudioFlinger>& audioFlinger, 1075 AudioStreamOut* output, 1076 audio_io_handle_t id, 1077 audio_devices_t device, 1078 bool systemReady, 1079 type_t type = MIXER); 1080 virtual ~MixerThread(); 1081 1082 // Thread virtuals 1083 1084 virtual bool checkForNewParameter_l(const String8& keyValuePair, 1085 status_t& status); 1086 virtual void dumpInternals(int fd, const Vector<String16>& args); 1087 1088 virtual bool isTrackAllowed_l( 1089 audio_channel_mask_t channelMask, audio_format_t format, 1090 audio_session_t sessionId, uid_t uid) const override; 1091protected: 1092 virtual mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove); 1093 virtual uint32_t idleSleepTimeUs() const; 1094 virtual uint32_t suspendSleepTimeUs() const; 1095 virtual void cacheParameters_l(); 1096 1097 virtual void acquireWakeLock_l() { 1098 PlaybackThread::acquireWakeLock_l(); 1099 if (hasFastMixer()) { 1100 mFastMixer->setBoottimeOffset( 1101 mTimestamp.mTimebaseOffset[ExtendedTimestamp::TIMEBASE_BOOTTIME]); 1102 } 1103 } 1104 1105 // threadLoop snippets 1106 virtual ssize_t threadLoop_write(); 1107 virtual void threadLoop_standby(); 1108 virtual void threadLoop_mix(); 1109 virtual void threadLoop_sleepTime(); 1110 virtual void threadLoop_removeTracks(const Vector< sp<Track> >& tracksToRemove); 1111 virtual uint32_t correctLatency_l(uint32_t latency) const; 1112 1113 virtual status_t createAudioPatch_l(const struct audio_patch *patch, 1114 audio_patch_handle_t *handle); 1115 virtual status_t releaseAudioPatch_l(const audio_patch_handle_t handle); 1116 1117 AudioMixer* mAudioMixer; // normal mixer 1118private: 1119 // one-time initialization, no locks required 1120 sp<FastMixer> mFastMixer; // non-0 if there is also a fast mixer 1121 sp<AudioWatchdog> mAudioWatchdog; // non-0 if there is an audio watchdog thread 1122 1123 // contents are not guaranteed to be consistent, no locks required 1124 FastMixerDumpState mFastMixerDumpState; 1125#ifdef STATE_QUEUE_DUMP 1126 StateQueueObserverDump mStateQueueObserverDump; 1127 StateQueueMutatorDump mStateQueueMutatorDump; 1128#endif 1129 AudioWatchdogDump mAudioWatchdogDump; 1130 1131 // accessible only within the threadLoop(), no locks required 1132 // mFastMixer->sq() // for mutating and pushing state 1133 int32_t mFastMixerFutex; // for cold idle 1134 1135 std::atomic_bool mMasterMono; 1136public: 1137 virtual bool hasFastMixer() const { return mFastMixer != 0; } 1138 virtual FastTrackUnderruns getFastTrackUnderruns(size_t fastIndex) const { 1139 ALOG_ASSERT(fastIndex < FastMixerState::sMaxFastTracks); 1140 return mFastMixerDumpState.mTracks[fastIndex].mUnderruns; 1141 } 1142 1143protected: 1144 virtual void setMasterMono_l(bool mono) { 1145 mMasterMono.store(mono); 1146 if (mFastMixer != nullptr) { /* hasFastMixer() */ 1147 mFastMixer->setMasterMono(mMasterMono); 1148 } 1149 } 1150 // the FastMixer performs mono blend if it exists. 1151 // Blending with limiter is not idempotent, 1152 // and blending without limiter is idempotent but inefficient to do twice. 1153 virtual bool requireMonoBlend() { return mMasterMono.load() && !hasFastMixer(); } 1154}; 1155 1156class DirectOutputThread : public PlaybackThread { 1157public: 1158 1159 DirectOutputThread(const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, 1160 audio_io_handle_t id, audio_devices_t device, bool systemReady); 1161 virtual ~DirectOutputThread(); 1162 1163 // Thread virtuals 1164 1165 virtual bool checkForNewParameter_l(const String8& keyValuePair, 1166 status_t& status); 1167 virtual void flushHw_l(); 1168 1169protected: 1170 virtual uint32_t activeSleepTimeUs() const; 1171 virtual uint32_t idleSleepTimeUs() const; 1172 virtual uint32_t suspendSleepTimeUs() const; 1173 virtual void cacheParameters_l(); 1174 1175 // threadLoop snippets 1176 virtual mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove); 1177 virtual void threadLoop_mix(); 1178 virtual void threadLoop_sleepTime(); 1179 virtual void threadLoop_exit(); 1180 virtual bool shouldStandby_l(); 1181 1182 virtual void onAddNewTrack_l(); 1183 1184 bool mVolumeShaperActive; 1185 1186 DirectOutputThread(const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, 1187 audio_io_handle_t id, uint32_t device, ThreadBase::type_t type, 1188 bool systemReady); 1189 void processVolume_l(Track *track, bool lastTrack); 1190 1191 // prepareTracks_l() tells threadLoop_mix() the name of the single active track 1192 sp<Track> mActiveTrack; 1193 1194 wp<Track> mPreviousTrack; // used to detect track switch 1195 1196public: 1197 virtual bool hasFastMixer() const { return false; } 1198 1199 virtual int64_t computeWaitTimeNs_l() const override; 1200}; 1201 1202class OffloadThread : public DirectOutputThread { 1203public: 1204 1205 OffloadThread(const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, 1206 audio_io_handle_t id, uint32_t device, bool systemReady); 1207 virtual ~OffloadThread() {}; 1208 virtual void flushHw_l(); 1209 1210protected: 1211 // threadLoop snippets 1212 virtual mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove); 1213 virtual void threadLoop_exit(); 1214 1215 virtual bool waitingAsyncCallback(); 1216 virtual bool waitingAsyncCallback_l(); 1217 virtual void invalidateTracks(audio_stream_type_t streamType); 1218 1219 virtual bool keepWakeLock() const { return (mKeepWakeLock || (mDrainSequence & 1)); } 1220 1221private: 1222 size_t mPausedWriteLength; // length in bytes of write interrupted by pause 1223 size_t mPausedBytesRemaining; // bytes still waiting in mixbuffer after resume 1224 bool mKeepWakeLock; // keep wake lock while waiting for write callback 1225 uint64_t mOffloadUnderrunPosition; // Current frame position for offloaded playback 1226 // used and valid only during underrun. ~0 if 1227 // no underrun has occurred during playback and 1228 // is not reset on standby. 1229}; 1230 1231class AsyncCallbackThread : public Thread { 1232public: 1233 1234 explicit AsyncCallbackThread(const wp<PlaybackThread>& playbackThread); 1235 1236 virtual ~AsyncCallbackThread(); 1237 1238 // Thread virtuals 1239 virtual bool threadLoop(); 1240 1241 // RefBase 1242 virtual void onFirstRef(); 1243 1244 void exit(); 1245 void setWriteBlocked(uint32_t sequence); 1246 void resetWriteBlocked(); 1247 void setDraining(uint32_t sequence); 1248 void resetDraining(); 1249 void setAsyncError(); 1250 1251private: 1252 const wp<PlaybackThread> mPlaybackThread; 1253 // mWriteAckSequence corresponds to the last write sequence passed by the offload thread via 1254 // setWriteBlocked(). The sequence is shifted one bit to the left and the lsb is used 1255 // to indicate that the callback has been received via resetWriteBlocked() 1256 uint32_t mWriteAckSequence; 1257 // mDrainSequence corresponds to the last drain sequence passed by the offload thread via 1258 // setDraining(). The sequence is shifted one bit to the left and the lsb is used 1259 // to indicate that the callback has been received via resetDraining() 1260 uint32_t mDrainSequence; 1261 Condition mWaitWorkCV; 1262 Mutex mLock; 1263 bool mAsyncError; 1264}; 1265 1266class DuplicatingThread : public MixerThread { 1267public: 1268 DuplicatingThread(const sp<AudioFlinger>& audioFlinger, MixerThread* mainThread, 1269 audio_io_handle_t id, bool systemReady); 1270 virtual ~DuplicatingThread(); 1271 1272 // Thread virtuals 1273 virtual void dumpInternals(int fd, const Vector<String16>& args) override; 1274 1275 void addOutputTrack(MixerThread* thread); 1276 void removeOutputTrack(MixerThread* thread); 1277 uint32_t waitTimeMs() const { return mWaitTimeMs; } 1278protected: 1279 virtual uint32_t activeSleepTimeUs() const; 1280 1281private: 1282 bool outputsReady(const SortedVector< sp<OutputTrack> > &outputTracks); 1283protected: 1284 // threadLoop snippets 1285 virtual void threadLoop_mix(); 1286 virtual void threadLoop_sleepTime(); 1287 virtual ssize_t threadLoop_write(); 1288 virtual void threadLoop_standby(); 1289 virtual void cacheParameters_l(); 1290 1291private: 1292 // called from threadLoop, addOutputTrack, removeOutputTrack 1293 virtual void updateWaitTime_l(); 1294protected: 1295 virtual void saveOutputTracks(); 1296 virtual void clearOutputTracks(); 1297private: 1298 1299 uint32_t mWaitTimeMs; 1300 SortedVector < sp<OutputTrack> > outputTracks; 1301 SortedVector < sp<OutputTrack> > mOutputTracks; 1302public: 1303 virtual bool hasFastMixer() const { return false; } 1304}; 1305 1306// record thread 1307class RecordThread : public ThreadBase 1308{ 1309public: 1310 1311 class RecordTrack; 1312 1313 /* The ResamplerBufferProvider is used to retrieve recorded input data from the 1314 * RecordThread. It maintains local state on the relative position of the read 1315 * position of the RecordTrack compared with the RecordThread. 1316 */ 1317 class ResamplerBufferProvider : public AudioBufferProvider 1318 { 1319 public: 1320 explicit ResamplerBufferProvider(RecordTrack* recordTrack) : 1321 mRecordTrack(recordTrack), 1322 mRsmpInUnrel(0), mRsmpInFront(0) { } 1323 virtual ~ResamplerBufferProvider() { } 1324 1325 // called to set the ResamplerBufferProvider to head of the RecordThread data buffer, 1326 // skipping any previous data read from the hal. 1327 virtual void reset(); 1328 1329 /* Synchronizes RecordTrack position with the RecordThread. 1330 * Calculates available frames and handle overruns if the RecordThread 1331 * has advanced faster than the ResamplerBufferProvider has retrieved data. 1332 * TODO: why not do this for every getNextBuffer? 1333 * 1334 * Parameters 1335 * framesAvailable: pointer to optional output size_t to store record track 1336 * frames available. 1337 * hasOverrun: pointer to optional boolean, returns true if track has overrun. 1338 */ 1339 1340 virtual void sync(size_t *framesAvailable = NULL, bool *hasOverrun = NULL); 1341 1342 // AudioBufferProvider interface 1343 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer); 1344 virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer); 1345 private: 1346 RecordTrack * const mRecordTrack; 1347 size_t mRsmpInUnrel; // unreleased frames remaining from 1348 // most recent getNextBuffer 1349 // for debug only 1350 int32_t mRsmpInFront; // next available frame 1351 // rolling counter that is never cleared 1352 }; 1353 1354#include "RecordTracks.h" 1355 1356 RecordThread(const sp<AudioFlinger>& audioFlinger, 1357 AudioStreamIn *input, 1358 audio_io_handle_t id, 1359 audio_devices_t outDevice, 1360 audio_devices_t inDevice, 1361 bool systemReady 1362#ifdef TEE_SINK 1363 , const sp<NBAIO_Sink>& teeSink 1364#endif 1365 ); 1366 virtual ~RecordThread(); 1367 1368 // no addTrack_l ? 1369 void destroyTrack_l(const sp<RecordTrack>& track); 1370 void removeTrack_l(const sp<RecordTrack>& track); 1371 1372 void dumpInternals(int fd, const Vector<String16>& args); 1373 void dumpTracks(int fd, const Vector<String16>& args); 1374 1375 // Thread virtuals 1376 virtual bool threadLoop(); 1377 virtual void preExit(); 1378 1379 // RefBase 1380 virtual void onFirstRef(); 1381 1382 virtual status_t initCheck() const { return (mInput == NULL) ? NO_INIT : NO_ERROR; } 1383 1384 virtual sp<MemoryDealer> readOnlyHeap() const { return mReadOnlyHeap; } 1385 1386 virtual sp<IMemory> pipeMemory() const { return mPipeMemory; } 1387 1388 sp<AudioFlinger::RecordThread::RecordTrack> createRecordTrack_l( 1389 const sp<AudioFlinger::Client>& client, 1390 uint32_t *pSampleRate, 1391 audio_format_t format, 1392 audio_channel_mask_t channelMask, 1393 size_t *pFrameCount, 1394 audio_session_t sessionId, 1395 size_t *pNotificationFrameCount, 1396 uid_t uid, 1397 audio_input_flags_t *flags, 1398 pid_t tid, 1399 status_t *status /*non-NULL*/, 1400 audio_port_handle_t portId); 1401 1402 status_t start(RecordTrack* recordTrack, 1403 AudioSystem::sync_event_t event, 1404 audio_session_t triggerSession); 1405 1406 // ask the thread to stop the specified track, and 1407 // return true if the caller should then do it's part of the stopping process 1408 bool stop(RecordTrack* recordTrack); 1409 1410 void dump(int fd, const Vector<String16>& args); 1411 AudioStreamIn* clearInput(); 1412 virtual sp<StreamHalInterface> stream() const; 1413 1414 1415 virtual bool checkForNewParameter_l(const String8& keyValuePair, 1416 status_t& status); 1417 virtual void cacheParameters_l() {} 1418 virtual String8 getParameters(const String8& keys); 1419 virtual void ioConfigChanged(audio_io_config_event event, pid_t pid = 0); 1420 virtual status_t createAudioPatch_l(const struct audio_patch *patch, 1421 audio_patch_handle_t *handle); 1422 virtual status_t releaseAudioPatch_l(const audio_patch_handle_t handle); 1423 1424 void addPatchRecord(const sp<PatchRecord>& record); 1425 void deletePatchRecord(const sp<PatchRecord>& record); 1426 1427 void readInputParameters_l(); 1428 virtual uint32_t getInputFramesLost(); 1429 1430 virtual status_t addEffectChain_l(const sp<EffectChain>& chain); 1431 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain); 1432 virtual uint32_t hasAudioSession_l(audio_session_t sessionId) const; 1433 1434 // Return the set of unique session IDs across all tracks. 1435 // The keys are the session IDs, and the associated values are meaningless. 1436 // FIXME replace by Set [and implement Bag/Multiset for other uses]. 1437 KeyedVector<audio_session_t, bool> sessionIds() const; 1438 1439 virtual status_t setSyncEvent(const sp<SyncEvent>& event); 1440 virtual bool isValidSyncEvent(const sp<SyncEvent>& event) const; 1441 1442 static void syncStartEventCallback(const wp<SyncEvent>& event); 1443 1444 virtual size_t frameCount() const { return mFrameCount; } 1445 bool hasFastCapture() const { return mFastCapture != 0; } 1446 virtual void getAudioPortConfig(struct audio_port_config *config); 1447 1448 virtual status_t checkEffectCompatibility_l(const effect_descriptor_t *desc, 1449 audio_session_t sessionId); 1450 1451 virtual void acquireWakeLock_l() { 1452 ThreadBase::acquireWakeLock_l(); 1453 mActiveTracks.updatePowerState(this, true /* force */); 1454 } 1455 virtual bool isOutput() const override { return false; } 1456 1457 void checkBtNrec(); 1458 1459 // Sets the UID records silence 1460 void setRecordSilenced(uid_t uid, bool silenced); 1461 1462 status_t getActiveMicrophones(std::vector<media::MicrophoneInfo>* activeMicrophones); 1463 1464private: 1465 // Enter standby if not already in standby, and set mStandby flag 1466 void standbyIfNotAlreadyInStandby(); 1467 1468 // Call the HAL standby method unconditionally, and don't change mStandby flag 1469 void inputStandBy(); 1470 1471 void checkBtNrec_l(); 1472 1473 AudioStreamIn *mInput; 1474 SortedVector < sp<RecordTrack> > mTracks; 1475 // mActiveTracks has dual roles: it indicates the current active track(s), and 1476 // is used together with mStartStopCond to indicate start()/stop() progress 1477 ActiveTracks<RecordTrack> mActiveTracks; 1478 1479 Condition mStartStopCond; 1480 1481 // resampler converts input at HAL Hz to output at AudioRecord client Hz 1482 void *mRsmpInBuffer; // size = mRsmpInFramesOA 1483 size_t mRsmpInFrames; // size of resampler input in frames 1484 size_t mRsmpInFramesP2;// size rounded up to a power-of-2 1485 size_t mRsmpInFramesOA;// mRsmpInFramesP2 + over-allocation 1486 1487 // rolling index that is never cleared 1488 int32_t mRsmpInRear; // last filled frame + 1 1489 1490 // For dumpsys 1491 const sp<NBAIO_Sink> mTeeSink; 1492 1493 const sp<MemoryDealer> mReadOnlyHeap; 1494 1495 // one-time initialization, no locks required 1496 sp<FastCapture> mFastCapture; // non-0 if there is also 1497 // a fast capture 1498 1499 // FIXME audio watchdog thread 1500 1501 // contents are not guaranteed to be consistent, no locks required 1502 FastCaptureDumpState mFastCaptureDumpState; 1503#ifdef STATE_QUEUE_DUMP 1504 // FIXME StateQueue observer and mutator dump fields 1505#endif 1506 // FIXME audio watchdog dump 1507 1508 // accessible only within the threadLoop(), no locks required 1509 // mFastCapture->sq() // for mutating and pushing state 1510 int32_t mFastCaptureFutex; // for cold idle 1511 1512 // The HAL input source is treated as non-blocking, 1513 // but current implementation is blocking 1514 sp<NBAIO_Source> mInputSource; 1515 // The source for the normal capture thread to read from: mInputSource or mPipeSource 1516 sp<NBAIO_Source> mNormalSource; 1517 // If a fast capture is present, the non-blocking pipe sink written to by fast capture, 1518 // otherwise clear 1519 sp<NBAIO_Sink> mPipeSink; 1520 // If a fast capture is present, the non-blocking pipe source read by normal thread, 1521 // otherwise clear 1522 sp<NBAIO_Source> mPipeSource; 1523 // Depth of pipe from fast capture to normal thread and fast clients, always power of 2 1524 size_t mPipeFramesP2; 1525 // If a fast capture is present, the Pipe as IMemory, otherwise clear 1526 sp<IMemory> mPipeMemory; 1527 1528 // TODO: add comment and adjust size as needed 1529 static const size_t kFastCaptureLogSize = 4 * 1024; 1530 sp<NBLog::Writer> mFastCaptureNBLogWriter; 1531 1532 bool mFastTrackAvail; // true if fast track available 1533 // common state to all record threads 1534 std::atomic_bool mBtNrecSuspended; 1535}; 1536 1537class MmapThread : public ThreadBase 1538{ 1539 public: 1540 1541#include "MmapTracks.h" 1542 1543 MmapThread(const sp<AudioFlinger>& audioFlinger, audio_io_handle_t id, 1544 AudioHwDevice *hwDev, sp<StreamHalInterface> stream, 1545 audio_devices_t outDevice, audio_devices_t inDevice, bool systemReady); 1546 virtual ~MmapThread(); 1547 1548 virtual void configure(const audio_attributes_t *attr, 1549 audio_stream_type_t streamType, 1550 audio_session_t sessionId, 1551 const sp<MmapStreamCallback>& callback, 1552 audio_port_handle_t deviceId, 1553 audio_port_handle_t portId); 1554 1555 void disconnect(); 1556 1557 // MmapStreamInterface 1558 status_t createMmapBuffer(int32_t minSizeFrames, 1559 struct audio_mmap_buffer_info *info); 1560 status_t getMmapPosition(struct audio_mmap_position *position); 1561 status_t start(const AudioClient& client, audio_port_handle_t *handle); 1562 status_t stop(audio_port_handle_t handle); 1563 status_t standby(); 1564 1565 // RefBase 1566 virtual void onFirstRef(); 1567 1568 // Thread virtuals 1569 virtual bool threadLoop(); 1570 1571 virtual void threadLoop_exit(); 1572 virtual void threadLoop_standby(); 1573 virtual bool shouldStandby_l() { return false; } 1574 1575 virtual status_t initCheck() const { return (mHalStream == 0) ? NO_INIT : NO_ERROR; } 1576 virtual size_t frameCount() const { return mFrameCount; } 1577 virtual bool checkForNewParameter_l(const String8& keyValuePair, 1578 status_t& status); 1579 virtual String8 getParameters(const String8& keys); 1580 virtual void ioConfigChanged(audio_io_config_event event, pid_t pid = 0); 1581 void readHalParameters_l(); 1582 virtual void cacheParameters_l() {} 1583 virtual status_t createAudioPatch_l(const struct audio_patch *patch, 1584 audio_patch_handle_t *handle); 1585 virtual status_t releaseAudioPatch_l(const audio_patch_handle_t handle); 1586 virtual void getAudioPortConfig(struct audio_port_config *config); 1587 1588 virtual sp<StreamHalInterface> stream() const { return mHalStream; } 1589 virtual status_t addEffectChain_l(const sp<EffectChain>& chain); 1590 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain); 1591 virtual status_t checkEffectCompatibility_l(const effect_descriptor_t *desc, 1592 audio_session_t sessionId); 1593 1594 virtual uint32_t hasAudioSession_l(audio_session_t sessionId) const; 1595 virtual status_t setSyncEvent(const sp<SyncEvent>& event); 1596 virtual bool isValidSyncEvent(const sp<SyncEvent>& event) const; 1597 1598 virtual void checkSilentMode_l() {} 1599 virtual void processVolume_l() {} 1600 void checkInvalidTracks_l(); 1601 1602 virtual audio_stream_type_t streamType() { return AUDIO_STREAM_DEFAULT; } 1603 1604 virtual void invalidateTracks(audio_stream_type_t streamType __unused) {} 1605 1606 void dump(int fd, const Vector<String16>& args); 1607 virtual void dumpInternals(int fd, const Vector<String16>& args); 1608 void dumpTracks(int fd, const Vector<String16>& args); 1609 1610 protected: 1611 1612 audio_attributes_t mAttr; 1613 audio_session_t mSessionId; 1614 audio_port_handle_t mDeviceId; 1615 audio_port_handle_t mPortId; 1616 1617 wp<MmapStreamCallback> mCallback; 1618 sp<StreamHalInterface> mHalStream; 1619 sp<DeviceHalInterface> mHalDevice; 1620 AudioHwDevice* const mAudioHwDev; 1621 ActiveTracks<MmapTrack> mActiveTracks; 1622}; 1623 1624class MmapPlaybackThread : public MmapThread, public VolumeInterface 1625{ 1626 1627public: 1628 MmapPlaybackThread(const sp<AudioFlinger>& audioFlinger, audio_io_handle_t id, 1629 AudioHwDevice *hwDev, AudioStreamOut *output, 1630 audio_devices_t outDevice, audio_devices_t inDevice, bool systemReady); 1631 virtual ~MmapPlaybackThread() {} 1632 1633 virtual void configure(const audio_attributes_t *attr, 1634 audio_stream_type_t streamType, 1635 audio_session_t sessionId, 1636 const sp<MmapStreamCallback>& callback, 1637 audio_port_handle_t deviceId, 1638 audio_port_handle_t portId); 1639 1640 AudioStreamOut* clearOutput(); 1641 1642 // VolumeInterface 1643 virtual void setMasterVolume(float value); 1644 virtual void setMasterMute(bool muted); 1645 virtual void setStreamVolume(audio_stream_type_t stream, float value); 1646 virtual void setStreamMute(audio_stream_type_t stream, bool muted); 1647 virtual float streamVolume(audio_stream_type_t stream) const; 1648 1649 void setMasterMute_l(bool muted) { mMasterMute = muted; } 1650 1651 virtual void invalidateTracks(audio_stream_type_t streamType); 1652 1653 virtual audio_stream_type_t streamType() { return mStreamType; } 1654 virtual void checkSilentMode_l(); 1655 virtual void processVolume_l(); 1656 1657 virtual void dumpInternals(int fd, const Vector<String16>& args); 1658 1659 virtual bool isOutput() const override { return true; } 1660 1661protected: 1662 1663 audio_stream_type_t mStreamType; 1664 float mMasterVolume; 1665 float mStreamVolume; 1666 bool mMasterMute; 1667 bool mStreamMute; 1668 float mHalVolFloat; 1669 int32_t mNoCallbackWarningCount; 1670 static constexpr int32_t kMaxNoCallbackWarnings = 5; 1671 AudioStreamOut* mOutput; 1672}; 1673 1674class MmapCaptureThread : public MmapThread 1675{ 1676 1677public: 1678 MmapCaptureThread(const sp<AudioFlinger>& audioFlinger, audio_io_handle_t id, 1679 AudioHwDevice *hwDev, AudioStreamIn *input, 1680 audio_devices_t outDevice, audio_devices_t inDevice, bool systemReady); 1681 virtual ~MmapCaptureThread() {} 1682 1683 AudioStreamIn* clearInput(); 1684 1685 virtual bool isOutput() const override { return false; } 1686 1687protected: 1688 1689 AudioStreamIn* mInput; 1690}; 1691