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