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