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