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