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