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