Threads.h revision 1f564acca544826daaf7dca44e39cec6016b82fd
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 const audio_attributes_t& attr, 710 uint32_t *sampleRate, 711 audio_format_t format, 712 audio_channel_mask_t channelMask, 713 size_t *pFrameCount, 714 size_t *pNotificationFrameCount, 715 uint32_t notificationsPerBuffer, 716 float speed, 717 const sp<IMemory>& sharedBuffer, 718 audio_session_t sessionId, 719 audio_output_flags_t *flags, 720 pid_t tid, 721 uid_t uid, 722 status_t *status /*non-NULL*/, 723 audio_port_handle_t portId); 724 725 AudioStreamOut* getOutput() const; 726 AudioStreamOut* clearOutput(); 727 virtual sp<StreamHalInterface> stream() const; 728 729 // a very large number of suspend() will eventually wraparound, but unlikely 730 void suspend() { (void) android_atomic_inc(&mSuspended); } 731 void restore() 732 { 733 // if restore() is done without suspend(), get back into 734 // range so that the next suspend() will operate correctly 735 if (android_atomic_dec(&mSuspended) <= 0) { 736 android_atomic_release_store(0, &mSuspended); 737 } 738 } 739 bool isSuspended() const 740 { return android_atomic_acquire_load(&mSuspended) > 0; } 741 742 virtual String8 getParameters(const String8& keys); 743 virtual void ioConfigChanged(audio_io_config_event event, pid_t pid = 0); 744 status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames); 745 // Consider also removing and passing an explicit mMainBuffer initialization 746 // parameter to AF::PlaybackThread::Track::Track(). 747 effect_buffer_t *sinkBuffer() const { 748 return reinterpret_cast<effect_buffer_t *>(mSinkBuffer); }; 749 750 virtual void detachAuxEffect_l(int effectId); 751 status_t attachAuxEffect(const sp<AudioFlinger::PlaybackThread::Track>& track, 752 int EffectId); 753 status_t attachAuxEffect_l(const sp<AudioFlinger::PlaybackThread::Track>& track, 754 int EffectId); 755 756 virtual status_t addEffectChain_l(const sp<EffectChain>& chain); 757 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain); 758 virtual uint32_t hasAudioSession_l(audio_session_t sessionId) const; 759 virtual uint32_t getStrategyForSession_l(audio_session_t sessionId); 760 761 762 virtual status_t setSyncEvent(const sp<SyncEvent>& event); 763 virtual bool isValidSyncEvent(const sp<SyncEvent>& event) const; 764 765 // called with AudioFlinger lock held 766 bool invalidateTracks_l(audio_stream_type_t streamType); 767 virtual void invalidateTracks(audio_stream_type_t streamType); 768 769 virtual size_t frameCount() const { return mNormalFrameCount; } 770 771 status_t getTimestamp_l(AudioTimestamp& timestamp); 772 773 void addPatchTrack(const sp<PatchTrack>& track); 774 void deletePatchTrack(const sp<PatchTrack>& track); 775 776 virtual void getAudioPortConfig(struct audio_port_config *config); 777 778 // Return the asynchronous signal wait time. 779 virtual int64_t computeWaitTimeNs_l() const { return INT64_MAX; } 780 781 virtual bool isOutput() const override { return true; } 782 783 // returns true if the track is allowed to be added to the thread. 784 virtual bool isTrackAllowed_l( 785 audio_channel_mask_t channelMask __unused, 786 audio_format_t format __unused, 787 audio_session_t sessionId __unused, 788 uid_t uid) const { 789 return trackCountForUid_l(uid) < PlaybackThread::kMaxTracksPerUid 790 && mTracks.size() < PlaybackThread::kMaxTracks; 791 } 792 793protected: 794 // updated by readOutputParameters_l() 795 size_t mNormalFrameCount; // normal mixer and effects 796 797 bool mThreadThrottle; // throttle the thread processing 798 uint32_t mThreadThrottleTimeMs; // throttle time for MIXER threads 799 uint32_t mThreadThrottleEndMs; // notify once per throttling 800 uint32_t mHalfBufferMs; // half the buffer size in milliseconds 801 802 void* mSinkBuffer; // frame size aligned sink buffer 803 804 // TODO: 805 // Rearrange the buffer info into a struct/class with 806 // clear, copy, construction, destruction methods. 807 // 808 // mSinkBuffer also has associated with it: 809 // 810 // mSinkBufferSize: Sink Buffer Size 811 // mFormat: Sink Buffer Format 812 813 // Mixer Buffer (mMixerBuffer*) 814 // 815 // In the case of floating point or multichannel data, which is not in the 816 // sink format, it is required to accumulate in a higher precision or greater channel count 817 // buffer before downmixing or data conversion to the sink buffer. 818 819 // Set to "true" to enable the Mixer Buffer otherwise mixer output goes to sink buffer. 820 bool mMixerBufferEnabled; 821 822 // Storage, 32 byte aligned (may make this alignment a requirement later). 823 // Due to constraints on mNormalFrameCount, the buffer size is a multiple of 16 frames. 824 void* mMixerBuffer; 825 826 // Size of mMixerBuffer in bytes: mNormalFrameCount * #channels * sampsize. 827 size_t mMixerBufferSize; 828 829 // The audio format of mMixerBuffer. Set to AUDIO_FORMAT_PCM_(FLOAT|16_BIT) only. 830 audio_format_t mMixerBufferFormat; 831 832 // An internal flag set to true by MixerThread::prepareTracks_l() 833 // when mMixerBuffer contains valid data after mixing. 834 bool mMixerBufferValid; 835 836 // Effects Buffer (mEffectsBuffer*) 837 // 838 // In the case of effects data, which is not in the sink format, 839 // it is required to accumulate in a different buffer before data conversion 840 // to the sink buffer. 841 842 // Set to "true" to enable the Effects Buffer otherwise effects output goes to sink buffer. 843 bool mEffectBufferEnabled; 844 845 // Storage, 32 byte aligned (may make this alignment a requirement later). 846 // Due to constraints on mNormalFrameCount, the buffer size is a multiple of 16 frames. 847 void* mEffectBuffer; 848 849 // Size of mEffectsBuffer in bytes: mNormalFrameCount * #channels * sampsize. 850 size_t mEffectBufferSize; 851 852 // The audio format of mEffectsBuffer. Set to AUDIO_FORMAT_PCM_16_BIT only. 853 audio_format_t mEffectBufferFormat; 854 855 // An internal flag set to true by MixerThread::prepareTracks_l() 856 // when mEffectsBuffer contains valid data after mixing. 857 // 858 // When this is set, all mixer data is routed into the effects buffer 859 // for any processing (including output processing). 860 bool mEffectBufferValid; 861 862 // suspend count, > 0 means suspended. While suspended, the thread continues to pull from 863 // tracks and mix, but doesn't write to HAL. A2DP and SCO HAL implementations can't handle 864 // concurrent use of both of them, so Audio Policy Service suspends one of the threads to 865 // workaround that restriction. 866 // 'volatile' means accessed via atomic operations and no lock. 867 volatile int32_t mSuspended; 868 869 int64_t mBytesWritten; 870 int64_t mFramesWritten; // not reset on standby 871 int64_t mSuspendedFrames; // not reset on standby 872private: 873 // mMasterMute is in both PlaybackThread and in AudioFlinger. When a 874 // PlaybackThread needs to find out if master-muted, it checks it's local 875 // copy rather than the one in AudioFlinger. This optimization saves a lock. 876 bool mMasterMute; 877 void setMasterMute_l(bool muted) { mMasterMute = muted; } 878protected: 879 ActiveTracks<Track> mActiveTracks; 880 881 // Time to sleep between cycles when: 882 virtual uint32_t activeSleepTimeUs() const; // mixer state MIXER_TRACKS_ENABLED 883 virtual uint32_t idleSleepTimeUs() const = 0; // mixer state MIXER_IDLE 884 virtual uint32_t suspendSleepTimeUs() const = 0; // audio policy manager suspended us 885 // No sleep when mixer state == MIXER_TRACKS_READY; relies on audio HAL stream->write() 886 // No sleep in standby mode; waits on a condition 887 888 // Code snippets that are temporarily lifted up out of threadLoop() until the merge 889 void checkSilentMode_l(); 890 891 // Non-trivial for DUPLICATING only 892 virtual void saveOutputTracks() { } 893 virtual void clearOutputTracks() { } 894 895 // Cache various calculated values, at threadLoop() entry and after a parameter change 896 virtual void cacheParameters_l(); 897 898 virtual uint32_t correctLatency_l(uint32_t latency) const; 899 900 virtual status_t createAudioPatch_l(const struct audio_patch *patch, 901 audio_patch_handle_t *handle); 902 virtual status_t releaseAudioPatch_l(const audio_patch_handle_t handle); 903 904 bool usesHwAvSync() const { return (mType == DIRECT) && (mOutput != NULL) 905 && mHwSupportsPause 906 && (mOutput->flags & AUDIO_OUTPUT_FLAG_HW_AV_SYNC); } 907 908 uint32_t trackCountForUid_l(uid_t uid) const; 909 910private: 911 912 friend class AudioFlinger; // for numerous 913 914 DISALLOW_COPY_AND_ASSIGN(PlaybackThread); 915 916 status_t addTrack_l(const sp<Track>& track); 917 bool destroyTrack_l(const sp<Track>& track); 918 void removeTrack_l(const sp<Track>& track); 919 920 void readOutputParameters_l(); 921 922 virtual void dumpInternals(int fd, const Vector<String16>& args); 923 void dumpTracks(int fd, const Vector<String16>& args); 924 925 // The Tracks class manages names for all tracks 926 // added and removed from the Thread. 927 template <typename T> 928 class Tracks { 929 public: 930 Tracks(bool saveDeletedTrackNames) : 931 mSaveDeletedTrackNames(saveDeletedTrackNames) { } 932 933 // SortedVector methods 934 ssize_t add(const sp<T> &track); 935 ssize_t remove(const sp<T> &track); 936 size_t size() const { 937 return mTracks.size(); 938 } 939 bool isEmpty() const { 940 return mTracks.isEmpty(); 941 } 942 ssize_t indexOf(const sp<T> &item) { 943 return mTracks.indexOf(item); 944 } 945 sp<T> operator[](size_t index) const { 946 return mTracks[index]; 947 } 948 typename SortedVector<sp<T>>::iterator begin() { 949 return mTracks.begin(); 950 } 951 typename SortedVector<sp<T>>::iterator end() { 952 return mTracks.end(); 953 } 954 955 size_t processDeletedTrackNames(std::function<void(int)> f) { 956 const size_t size = mDeletedTrackNames.size(); 957 if (size > 0) { 958 for (const int name : mDeletedTrackNames) { 959 f(name); 960 } 961 } 962 return size; 963 } 964 965 void clearDeletedTrackNames() { mDeletedTrackNames.clear(); } 966 967 private: 968 // Track names pending deletion for MIXER type threads 969 const bool mSaveDeletedTrackNames; // true to enable tracking 970 std::set<int> mDeletedTrackNames; 971 972 // Fast lookup of previously deleted track names for reuse. 973 // This is an arbitrary decision (actually any non-negative 974 // integer that isn't in mTracks[*]->names() could be used) - we attempt 975 // to use the smallest possible available name. 976 std::set<int> mUnusedTrackNames; 977 978 SortedVector<sp<T>> mTracks; // wrapped SortedVector. 979 }; 980 981 Tracks<Track> mTracks; 982 983 stream_type_t mStreamTypes[AUDIO_STREAM_CNT]; 984 AudioStreamOut *mOutput; 985 986 float mMasterVolume; 987 nsecs_t mLastWriteTime; 988 int mNumWrites; 989 int mNumDelayedWrites; 990 bool mInWrite; 991 992 // FIXME rename these former local variables of threadLoop to standard "m" names 993 nsecs_t mStandbyTimeNs; 994 size_t mSinkBufferSize; 995 996 // cached copies of activeSleepTimeUs() and idleSleepTimeUs() made by cacheParameters_l() 997 uint32_t mActiveSleepTimeUs; 998 uint32_t mIdleSleepTimeUs; 999 1000 uint32_t mSleepTimeUs; 1001 1002 // mixer status returned by prepareTracks_l() 1003 mixer_state mMixerStatus; // current cycle 1004 // previous cycle when in prepareTracks_l() 1005 mixer_state mMixerStatusIgnoringFastTracks; 1006 // FIXME or a separate ready state per track 1007 1008 // FIXME move these declarations into the specific sub-class that needs them 1009 // MIXER only 1010 uint32_t sleepTimeShift; 1011 1012 // same as AudioFlinger::mStandbyTimeInNsecs except for DIRECT which uses a shorter value 1013 nsecs_t mStandbyDelayNs; 1014 1015 // MIXER only 1016 nsecs_t maxPeriod; 1017 1018 // DUPLICATING only 1019 uint32_t writeFrames; 1020 1021 size_t mBytesRemaining; 1022 size_t mCurrentWriteLength; 1023 bool mUseAsyncWrite; 1024 // mWriteAckSequence contains current write sequence on bits 31-1. The write sequence is 1025 // incremented each time a write(), a flush() or a standby() occurs. 1026 // Bit 0 is set when a write blocks and indicates a callback is expected. 1027 // Bit 0 is reset by the async callback thread calling resetWriteBlocked(). Out of sequence 1028 // callbacks are ignored. 1029 uint32_t mWriteAckSequence; 1030 // mDrainSequence contains current drain sequence on bits 31-1. The drain sequence is 1031 // incremented each time a drain is requested or a flush() or standby() occurs. 1032 // Bit 0 is set when the drain() command is called at the HAL and indicates a callback is 1033 // expected. 1034 // Bit 0 is reset by the async callback thread calling resetDraining(). Out of sequence 1035 // callbacks are ignored. 1036 uint32_t mDrainSequence; 1037 sp<AsyncCallbackThread> mCallbackThread; 1038 1039private: 1040 // The HAL output sink is treated as non-blocking, but current implementation is blocking 1041 sp<NBAIO_Sink> mOutputSink; 1042 // If a fast mixer is present, the blocking pipe sink, otherwise clear 1043 sp<NBAIO_Sink> mPipeSink; 1044 // The current sink for the normal mixer to write it's (sub)mix, mOutputSink or mPipeSink 1045 sp<NBAIO_Sink> mNormalSink; 1046#ifdef TEE_SINK 1047 // For dumpsys 1048 sp<NBAIO_Sink> mTeeSink; 1049 sp<NBAIO_Source> mTeeSource; 1050#endif 1051 uint32_t mScreenState; // cached copy of gScreenState 1052 // TODO: add comment and adjust size as needed 1053 static const size_t kFastMixerLogSize = 8 * 1024; 1054 sp<NBLog::Writer> mFastMixerNBLogWriter; 1055 1056 1057public: 1058 virtual bool hasFastMixer() const = 0; 1059 virtual FastTrackUnderruns getFastTrackUnderruns(size_t fastIndex __unused) const 1060 { FastTrackUnderruns dummy; return dummy; } 1061 1062protected: 1063 // accessed by both binder threads and within threadLoop(), lock on mutex needed 1064 unsigned mFastTrackAvailMask; // bit i set if fast track [i] is available 1065 bool mHwSupportsPause; 1066 bool mHwPaused; 1067 bool mFlushPending; 1068 // volumes last sent to audio HAL with stream->setVolume() 1069 float mLeftVolFloat; 1070 float mRightVolFloat; 1071}; 1072 1073class MixerThread : public PlaybackThread { 1074public: 1075 MixerThread(const sp<AudioFlinger>& audioFlinger, 1076 AudioStreamOut* output, 1077 audio_io_handle_t id, 1078 audio_devices_t device, 1079 bool systemReady, 1080 type_t type = MIXER); 1081 virtual ~MixerThread(); 1082 1083 // Thread virtuals 1084 1085 virtual bool checkForNewParameter_l(const String8& keyValuePair, 1086 status_t& status); 1087 virtual void dumpInternals(int fd, const Vector<String16>& args); 1088 1089 virtual bool isTrackAllowed_l( 1090 audio_channel_mask_t channelMask, audio_format_t format, 1091 audio_session_t sessionId, uid_t uid) const override; 1092protected: 1093 virtual mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove); 1094 virtual uint32_t idleSleepTimeUs() const; 1095 virtual uint32_t suspendSleepTimeUs() const; 1096 virtual void cacheParameters_l(); 1097 1098 virtual void acquireWakeLock_l() { 1099 PlaybackThread::acquireWakeLock_l(); 1100 if (hasFastMixer()) { 1101 mFastMixer->setBoottimeOffset( 1102 mTimestamp.mTimebaseOffset[ExtendedTimestamp::TIMEBASE_BOOTTIME]); 1103 } 1104 } 1105 1106 // threadLoop snippets 1107 virtual ssize_t threadLoop_write(); 1108 virtual void threadLoop_standby(); 1109 virtual void threadLoop_mix(); 1110 virtual void threadLoop_sleepTime(); 1111 virtual void threadLoop_removeTracks(const Vector< sp<Track> >& tracksToRemove); 1112 virtual uint32_t correctLatency_l(uint32_t latency) const; 1113 1114 virtual status_t createAudioPatch_l(const struct audio_patch *patch, 1115 audio_patch_handle_t *handle); 1116 virtual status_t releaseAudioPatch_l(const audio_patch_handle_t handle); 1117 1118 AudioMixer* mAudioMixer; // normal mixer 1119private: 1120 // one-time initialization, no locks required 1121 sp<FastMixer> mFastMixer; // non-0 if there is also a fast mixer 1122 sp<AudioWatchdog> mAudioWatchdog; // non-0 if there is an audio watchdog thread 1123 1124 // contents are not guaranteed to be consistent, no locks required 1125 FastMixerDumpState mFastMixerDumpState; 1126#ifdef STATE_QUEUE_DUMP 1127 StateQueueObserverDump mStateQueueObserverDump; 1128 StateQueueMutatorDump mStateQueueMutatorDump; 1129#endif 1130 AudioWatchdogDump mAudioWatchdogDump; 1131 1132 // accessible only within the threadLoop(), no locks required 1133 // mFastMixer->sq() // for mutating and pushing state 1134 int32_t mFastMixerFutex; // for cold idle 1135 1136 std::atomic_bool mMasterMono; 1137public: 1138 virtual bool hasFastMixer() const { return mFastMixer != 0; } 1139 virtual FastTrackUnderruns getFastTrackUnderruns(size_t fastIndex) const { 1140 ALOG_ASSERT(fastIndex < FastMixerState::sMaxFastTracks); 1141 return mFastMixerDumpState.mTracks[fastIndex].mUnderruns; 1142 } 1143 1144protected: 1145 virtual void setMasterMono_l(bool mono) { 1146 mMasterMono.store(mono); 1147 if (mFastMixer != nullptr) { /* hasFastMixer() */ 1148 mFastMixer->setMasterMono(mMasterMono); 1149 } 1150 } 1151 // the FastMixer performs mono blend if it exists. 1152 // Blending with limiter is not idempotent, 1153 // and blending without limiter is idempotent but inefficient to do twice. 1154 virtual bool requireMonoBlend() { return mMasterMono.load() && !hasFastMixer(); } 1155}; 1156 1157class DirectOutputThread : public PlaybackThread { 1158public: 1159 1160 DirectOutputThread(const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, 1161 audio_io_handle_t id, audio_devices_t device, bool systemReady); 1162 virtual ~DirectOutputThread(); 1163 1164 // Thread virtuals 1165 1166 virtual bool checkForNewParameter_l(const String8& keyValuePair, 1167 status_t& status); 1168 virtual void flushHw_l(); 1169 1170protected: 1171 virtual uint32_t activeSleepTimeUs() const; 1172 virtual uint32_t idleSleepTimeUs() const; 1173 virtual uint32_t suspendSleepTimeUs() const; 1174 virtual void cacheParameters_l(); 1175 1176 // threadLoop snippets 1177 virtual mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove); 1178 virtual void threadLoop_mix(); 1179 virtual void threadLoop_sleepTime(); 1180 virtual void threadLoop_exit(); 1181 virtual bool shouldStandby_l(); 1182 1183 virtual void onAddNewTrack_l(); 1184 1185 bool mVolumeShaperActive; 1186 1187 DirectOutputThread(const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, 1188 audio_io_handle_t id, uint32_t device, ThreadBase::type_t type, 1189 bool systemReady); 1190 void processVolume_l(Track *track, bool lastTrack); 1191 1192 // prepareTracks_l() tells threadLoop_mix() the name of the single active track 1193 sp<Track> mActiveTrack; 1194 1195 wp<Track> mPreviousTrack; // used to detect track switch 1196 1197public: 1198 virtual bool hasFastMixer() const { return false; } 1199 1200 virtual int64_t computeWaitTimeNs_l() const override; 1201}; 1202 1203class OffloadThread : public DirectOutputThread { 1204public: 1205 1206 OffloadThread(const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, 1207 audio_io_handle_t id, uint32_t device, bool systemReady); 1208 virtual ~OffloadThread() {}; 1209 virtual void flushHw_l(); 1210 1211protected: 1212 // threadLoop snippets 1213 virtual mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove); 1214 virtual void threadLoop_exit(); 1215 1216 virtual bool waitingAsyncCallback(); 1217 virtual bool waitingAsyncCallback_l(); 1218 virtual void invalidateTracks(audio_stream_type_t streamType); 1219 1220 virtual bool keepWakeLock() const { return (mKeepWakeLock || (mDrainSequence & 1)); } 1221 1222private: 1223 size_t mPausedWriteLength; // length in bytes of write interrupted by pause 1224 size_t mPausedBytesRemaining; // bytes still waiting in mixbuffer after resume 1225 bool mKeepWakeLock; // keep wake lock while waiting for write callback 1226 uint64_t mOffloadUnderrunPosition; // Current frame position for offloaded playback 1227 // used and valid only during underrun. ~0 if 1228 // no underrun has occurred during playback and 1229 // is not reset on standby. 1230}; 1231 1232class AsyncCallbackThread : public Thread { 1233public: 1234 1235 explicit AsyncCallbackThread(const wp<PlaybackThread>& playbackThread); 1236 1237 virtual ~AsyncCallbackThread(); 1238 1239 // Thread virtuals 1240 virtual bool threadLoop(); 1241 1242 // RefBase 1243 virtual void onFirstRef(); 1244 1245 void exit(); 1246 void setWriteBlocked(uint32_t sequence); 1247 void resetWriteBlocked(); 1248 void setDraining(uint32_t sequence); 1249 void resetDraining(); 1250 void setAsyncError(); 1251 1252private: 1253 const wp<PlaybackThread> mPlaybackThread; 1254 // mWriteAckSequence corresponds to the last write sequence passed by the offload thread via 1255 // setWriteBlocked(). The sequence is shifted one bit to the left and the lsb is used 1256 // to indicate that the callback has been received via resetWriteBlocked() 1257 uint32_t mWriteAckSequence; 1258 // mDrainSequence corresponds to the last drain sequence passed by the offload thread via 1259 // setDraining(). The sequence is shifted one bit to the left and the lsb is used 1260 // to indicate that the callback has been received via resetDraining() 1261 uint32_t mDrainSequence; 1262 Condition mWaitWorkCV; 1263 Mutex mLock; 1264 bool mAsyncError; 1265}; 1266 1267class DuplicatingThread : public MixerThread { 1268public: 1269 DuplicatingThread(const sp<AudioFlinger>& audioFlinger, MixerThread* mainThread, 1270 audio_io_handle_t id, bool systemReady); 1271 virtual ~DuplicatingThread(); 1272 1273 // Thread virtuals 1274 virtual void dumpInternals(int fd, const Vector<String16>& args) override; 1275 1276 void addOutputTrack(MixerThread* thread); 1277 void removeOutputTrack(MixerThread* thread); 1278 uint32_t waitTimeMs() const { return mWaitTimeMs; } 1279protected: 1280 virtual uint32_t activeSleepTimeUs() const; 1281 1282private: 1283 bool outputsReady(const SortedVector< sp<OutputTrack> > &outputTracks); 1284protected: 1285 // threadLoop snippets 1286 virtual void threadLoop_mix(); 1287 virtual void threadLoop_sleepTime(); 1288 virtual ssize_t threadLoop_write(); 1289 virtual void threadLoop_standby(); 1290 virtual void cacheParameters_l(); 1291 1292private: 1293 // called from threadLoop, addOutputTrack, removeOutputTrack 1294 virtual void updateWaitTime_l(); 1295protected: 1296 virtual void saveOutputTracks(); 1297 virtual void clearOutputTracks(); 1298private: 1299 1300 uint32_t mWaitTimeMs; 1301 SortedVector < sp<OutputTrack> > outputTracks; 1302 SortedVector < sp<OutputTrack> > mOutputTracks; 1303public: 1304 virtual bool hasFastMixer() const { return false; } 1305}; 1306 1307// record thread 1308class RecordThread : public ThreadBase 1309{ 1310public: 1311 1312 class RecordTrack; 1313 1314 /* The ResamplerBufferProvider is used to retrieve recorded input data from the 1315 * RecordThread. It maintains local state on the relative position of the read 1316 * position of the RecordTrack compared with the RecordThread. 1317 */ 1318 class ResamplerBufferProvider : public AudioBufferProvider 1319 { 1320 public: 1321 explicit ResamplerBufferProvider(RecordTrack* recordTrack) : 1322 mRecordTrack(recordTrack), 1323 mRsmpInUnrel(0), mRsmpInFront(0) { } 1324 virtual ~ResamplerBufferProvider() { } 1325 1326 // called to set the ResamplerBufferProvider to head of the RecordThread data buffer, 1327 // skipping any previous data read from the hal. 1328 virtual void reset(); 1329 1330 /* Synchronizes RecordTrack position with the RecordThread. 1331 * Calculates available frames and handle overruns if the RecordThread 1332 * has advanced faster than the ResamplerBufferProvider has retrieved data. 1333 * TODO: why not do this for every getNextBuffer? 1334 * 1335 * Parameters 1336 * framesAvailable: pointer to optional output size_t to store record track 1337 * frames available. 1338 * hasOverrun: pointer to optional boolean, returns true if track has overrun. 1339 */ 1340 1341 virtual void sync(size_t *framesAvailable = NULL, bool *hasOverrun = NULL); 1342 1343 // AudioBufferProvider interface 1344 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer); 1345 virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer); 1346 private: 1347 RecordTrack * const mRecordTrack; 1348 size_t mRsmpInUnrel; // unreleased frames remaining from 1349 // most recent getNextBuffer 1350 // for debug only 1351 int32_t mRsmpInFront; // next available frame 1352 // rolling counter that is never cleared 1353 }; 1354 1355#include "RecordTracks.h" 1356 1357 RecordThread(const sp<AudioFlinger>& audioFlinger, 1358 AudioStreamIn *input, 1359 audio_io_handle_t id, 1360 audio_devices_t outDevice, 1361 audio_devices_t inDevice, 1362 bool systemReady 1363#ifdef TEE_SINK 1364 , const sp<NBAIO_Sink>& teeSink 1365#endif 1366 ); 1367 virtual ~RecordThread(); 1368 1369 // no addTrack_l ? 1370 void destroyTrack_l(const sp<RecordTrack>& track); 1371 void removeTrack_l(const sp<RecordTrack>& track); 1372 1373 void dumpInternals(int fd, const Vector<String16>& args); 1374 void dumpTracks(int fd, const Vector<String16>& args); 1375 1376 // Thread virtuals 1377 virtual bool threadLoop(); 1378 virtual void preExit(); 1379 1380 // RefBase 1381 virtual void onFirstRef(); 1382 1383 virtual status_t initCheck() const { return (mInput == NULL) ? NO_INIT : NO_ERROR; } 1384 1385 virtual sp<MemoryDealer> readOnlyHeap() const { return mReadOnlyHeap; } 1386 1387 virtual sp<IMemory> pipeMemory() const { return mPipeMemory; } 1388 1389 sp<AudioFlinger::RecordThread::RecordTrack> createRecordTrack_l( 1390 const sp<AudioFlinger::Client>& client, 1391 const audio_attributes_t& attr, 1392 uint32_t *pSampleRate, 1393 audio_format_t format, 1394 audio_channel_mask_t channelMask, 1395 size_t *pFrameCount, 1396 audio_session_t sessionId, 1397 size_t *pNotificationFrameCount, 1398 uid_t uid, 1399 audio_input_flags_t *flags, 1400 pid_t tid, 1401 status_t *status /*non-NULL*/, 1402 audio_port_handle_t portId); 1403 1404 status_t start(RecordTrack* recordTrack, 1405 AudioSystem::sync_event_t event, 1406 audio_session_t triggerSession); 1407 1408 // ask the thread to stop the specified track, and 1409 // return true if the caller should then do it's part of the stopping process 1410 bool stop(RecordTrack* recordTrack); 1411 1412 void dump(int fd, const Vector<String16>& args); 1413 AudioStreamIn* clearInput(); 1414 virtual sp<StreamHalInterface> stream() const; 1415 1416 1417 virtual bool checkForNewParameter_l(const String8& keyValuePair, 1418 status_t& status); 1419 virtual void cacheParameters_l() {} 1420 virtual String8 getParameters(const String8& keys); 1421 virtual void ioConfigChanged(audio_io_config_event event, pid_t pid = 0); 1422 virtual status_t createAudioPatch_l(const struct audio_patch *patch, 1423 audio_patch_handle_t *handle); 1424 virtual status_t releaseAudioPatch_l(const audio_patch_handle_t handle); 1425 1426 void addPatchRecord(const sp<PatchRecord>& record); 1427 void deletePatchRecord(const sp<PatchRecord>& record); 1428 1429 void readInputParameters_l(); 1430 virtual uint32_t getInputFramesLost(); 1431 1432 virtual status_t addEffectChain_l(const sp<EffectChain>& chain); 1433 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain); 1434 virtual uint32_t hasAudioSession_l(audio_session_t sessionId) const; 1435 1436 // Return the set of unique session IDs across all tracks. 1437 // The keys are the session IDs, and the associated values are meaningless. 1438 // FIXME replace by Set [and implement Bag/Multiset for other uses]. 1439 KeyedVector<audio_session_t, bool> sessionIds() const; 1440 1441 virtual status_t setSyncEvent(const sp<SyncEvent>& event); 1442 virtual bool isValidSyncEvent(const sp<SyncEvent>& event) const; 1443 1444 static void syncStartEventCallback(const wp<SyncEvent>& event); 1445 1446 virtual size_t frameCount() const { return mFrameCount; } 1447 bool hasFastCapture() const { return mFastCapture != 0; } 1448 virtual void getAudioPortConfig(struct audio_port_config *config); 1449 1450 virtual status_t checkEffectCompatibility_l(const effect_descriptor_t *desc, 1451 audio_session_t sessionId); 1452 1453 virtual void acquireWakeLock_l() { 1454 ThreadBase::acquireWakeLock_l(); 1455 mActiveTracks.updatePowerState(this, true /* force */); 1456 } 1457 virtual bool isOutput() const override { return false; } 1458 1459 void checkBtNrec(); 1460 1461 // Sets the UID records silence 1462 void setRecordSilenced(uid_t uid, bool silenced); 1463 1464 status_t getActiveMicrophones(std::vector<media::MicrophoneInfo>* activeMicrophones); 1465 1466private: 1467 // Enter standby if not already in standby, and set mStandby flag 1468 void standbyIfNotAlreadyInStandby(); 1469 1470 // Call the HAL standby method unconditionally, and don't change mStandby flag 1471 void inputStandBy(); 1472 1473 void checkBtNrec_l(); 1474 1475 AudioStreamIn *mInput; 1476 SortedVector < sp<RecordTrack> > mTracks; 1477 // mActiveTracks has dual roles: it indicates the current active track(s), and 1478 // is used together with mStartStopCond to indicate start()/stop() progress 1479 ActiveTracks<RecordTrack> mActiveTracks; 1480 1481 Condition mStartStopCond; 1482 1483 // resampler converts input at HAL Hz to output at AudioRecord client Hz 1484 void *mRsmpInBuffer; // size = mRsmpInFramesOA 1485 size_t mRsmpInFrames; // size of resampler input in frames 1486 size_t mRsmpInFramesP2;// size rounded up to a power-of-2 1487 size_t mRsmpInFramesOA;// mRsmpInFramesP2 + over-allocation 1488 1489 // rolling index that is never cleared 1490 int32_t mRsmpInRear; // last filled frame + 1 1491 1492 // For dumpsys 1493 const sp<NBAIO_Sink> mTeeSink; 1494 1495 const sp<MemoryDealer> mReadOnlyHeap; 1496 1497 // one-time initialization, no locks required 1498 sp<FastCapture> mFastCapture; // non-0 if there is also 1499 // a fast capture 1500 1501 // FIXME audio watchdog thread 1502 1503 // contents are not guaranteed to be consistent, no locks required 1504 FastCaptureDumpState mFastCaptureDumpState; 1505#ifdef STATE_QUEUE_DUMP 1506 // FIXME StateQueue observer and mutator dump fields 1507#endif 1508 // FIXME audio watchdog dump 1509 1510 // accessible only within the threadLoop(), no locks required 1511 // mFastCapture->sq() // for mutating and pushing state 1512 int32_t mFastCaptureFutex; // for cold idle 1513 1514 // The HAL input source is treated as non-blocking, 1515 // but current implementation is blocking 1516 sp<NBAIO_Source> mInputSource; 1517 // The source for the normal capture thread to read from: mInputSource or mPipeSource 1518 sp<NBAIO_Source> mNormalSource; 1519 // If a fast capture is present, the non-blocking pipe sink written to by fast capture, 1520 // otherwise clear 1521 sp<NBAIO_Sink> mPipeSink; 1522 // If a fast capture is present, the non-blocking pipe source read by normal thread, 1523 // otherwise clear 1524 sp<NBAIO_Source> mPipeSource; 1525 // Depth of pipe from fast capture to normal thread and fast clients, always power of 2 1526 size_t mPipeFramesP2; 1527 // If a fast capture is present, the Pipe as IMemory, otherwise clear 1528 sp<IMemory> mPipeMemory; 1529 1530 // TODO: add comment and adjust size as needed 1531 static const size_t kFastCaptureLogSize = 4 * 1024; 1532 sp<NBLog::Writer> mFastCaptureNBLogWriter; 1533 1534 bool mFastTrackAvail; // true if fast track available 1535 // common state to all record threads 1536 std::atomic_bool mBtNrecSuspended; 1537}; 1538 1539class MmapThread : public ThreadBase 1540{ 1541 public: 1542 1543#include "MmapTracks.h" 1544 1545 MmapThread(const sp<AudioFlinger>& audioFlinger, audio_io_handle_t id, 1546 AudioHwDevice *hwDev, sp<StreamHalInterface> stream, 1547 audio_devices_t outDevice, audio_devices_t inDevice, bool systemReady); 1548 virtual ~MmapThread(); 1549 1550 virtual void configure(const audio_attributes_t *attr, 1551 audio_stream_type_t streamType, 1552 audio_session_t sessionId, 1553 const sp<MmapStreamCallback>& callback, 1554 audio_port_handle_t deviceId, 1555 audio_port_handle_t portId); 1556 1557 void disconnect(); 1558 1559 // MmapStreamInterface 1560 status_t createMmapBuffer(int32_t minSizeFrames, 1561 struct audio_mmap_buffer_info *info); 1562 status_t getMmapPosition(struct audio_mmap_position *position); 1563 status_t start(const AudioClient& client, audio_port_handle_t *handle); 1564 status_t stop(audio_port_handle_t handle); 1565 status_t standby(); 1566 1567 // RefBase 1568 virtual void onFirstRef(); 1569 1570 // Thread virtuals 1571 virtual bool threadLoop(); 1572 1573 virtual void threadLoop_exit(); 1574 virtual void threadLoop_standby(); 1575 virtual bool shouldStandby_l() { return false; } 1576 1577 virtual status_t initCheck() const { return (mHalStream == 0) ? NO_INIT : NO_ERROR; } 1578 virtual size_t frameCount() const { return mFrameCount; } 1579 virtual bool checkForNewParameter_l(const String8& keyValuePair, 1580 status_t& status); 1581 virtual String8 getParameters(const String8& keys); 1582 virtual void ioConfigChanged(audio_io_config_event event, pid_t pid = 0); 1583 void readHalParameters_l(); 1584 virtual void cacheParameters_l() {} 1585 virtual status_t createAudioPatch_l(const struct audio_patch *patch, 1586 audio_patch_handle_t *handle); 1587 virtual status_t releaseAudioPatch_l(const audio_patch_handle_t handle); 1588 virtual void getAudioPortConfig(struct audio_port_config *config); 1589 1590 virtual sp<StreamHalInterface> stream() const { return mHalStream; } 1591 virtual status_t addEffectChain_l(const sp<EffectChain>& chain); 1592 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain); 1593 virtual status_t checkEffectCompatibility_l(const effect_descriptor_t *desc, 1594 audio_session_t sessionId); 1595 1596 virtual uint32_t hasAudioSession_l(audio_session_t sessionId) const; 1597 virtual status_t setSyncEvent(const sp<SyncEvent>& event); 1598 virtual bool isValidSyncEvent(const sp<SyncEvent>& event) const; 1599 1600 virtual void checkSilentMode_l() {} 1601 virtual void processVolume_l() {} 1602 void checkInvalidTracks_l(); 1603 1604 virtual audio_stream_type_t streamType() { return AUDIO_STREAM_DEFAULT; } 1605 1606 virtual void invalidateTracks(audio_stream_type_t streamType __unused) {} 1607 1608 void dump(int fd, const Vector<String16>& args); 1609 virtual void dumpInternals(int fd, const Vector<String16>& args); 1610 void dumpTracks(int fd, const Vector<String16>& args); 1611 1612 protected: 1613 1614 audio_attributes_t mAttr; 1615 audio_session_t mSessionId; 1616 audio_port_handle_t mDeviceId; 1617 audio_port_handle_t mPortId; 1618 1619 wp<MmapStreamCallback> mCallback; 1620 sp<StreamHalInterface> mHalStream; 1621 sp<DeviceHalInterface> mHalDevice; 1622 AudioHwDevice* const mAudioHwDev; 1623 ActiveTracks<MmapTrack> mActiveTracks; 1624}; 1625 1626class MmapPlaybackThread : public MmapThread, public VolumeInterface 1627{ 1628 1629public: 1630 MmapPlaybackThread(const sp<AudioFlinger>& audioFlinger, audio_io_handle_t id, 1631 AudioHwDevice *hwDev, AudioStreamOut *output, 1632 audio_devices_t outDevice, audio_devices_t inDevice, bool systemReady); 1633 virtual ~MmapPlaybackThread() {} 1634 1635 virtual void configure(const audio_attributes_t *attr, 1636 audio_stream_type_t streamType, 1637 audio_session_t sessionId, 1638 const sp<MmapStreamCallback>& callback, 1639 audio_port_handle_t deviceId, 1640 audio_port_handle_t portId); 1641 1642 AudioStreamOut* clearOutput(); 1643 1644 // VolumeInterface 1645 virtual void setMasterVolume(float value); 1646 virtual void setMasterMute(bool muted); 1647 virtual void setStreamVolume(audio_stream_type_t stream, float value); 1648 virtual void setStreamMute(audio_stream_type_t stream, bool muted); 1649 virtual float streamVolume(audio_stream_type_t stream) const; 1650 1651 void setMasterMute_l(bool muted) { mMasterMute = muted; } 1652 1653 virtual void invalidateTracks(audio_stream_type_t streamType); 1654 1655 virtual audio_stream_type_t streamType() { return mStreamType; } 1656 virtual void checkSilentMode_l(); 1657 virtual void processVolume_l(); 1658 1659 virtual void dumpInternals(int fd, const Vector<String16>& args); 1660 1661 virtual bool isOutput() const override { return true; } 1662 1663protected: 1664 1665 audio_stream_type_t mStreamType; 1666 float mMasterVolume; 1667 float mStreamVolume; 1668 bool mMasterMute; 1669 bool mStreamMute; 1670 float mHalVolFloat; 1671 int32_t mNoCallbackWarningCount; 1672 static constexpr int32_t kMaxNoCallbackWarnings = 5; 1673 AudioStreamOut* mOutput; 1674}; 1675 1676class MmapCaptureThread : public MmapThread 1677{ 1678 1679public: 1680 MmapCaptureThread(const sp<AudioFlinger>& audioFlinger, audio_io_handle_t id, 1681 AudioHwDevice *hwDev, AudioStreamIn *input, 1682 audio_devices_t outDevice, audio_devices_t inDevice, bool systemReady); 1683 virtual ~MmapCaptureThread() {} 1684 1685 AudioStreamIn* clearInput(); 1686 1687 virtual bool isOutput() const override { return false; } 1688 1689protected: 1690 1691 AudioStreamIn* mInput; 1692}; 1693