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