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