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