Threads.h revision e8a1ced4da17dc6c07803dc2af8060f62a8389c1
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 ThreadBase(const sp<AudioFlinger>& audioFlinger, audio_io_handle_t id, 36 audio_devices_t outDevice, audio_devices_t inDevice, type_t type); 37 virtual ~ThreadBase(); 38 39 virtual status_t readyToRun(); 40 41 void dumpBase(int fd, const Vector<String16>& args); 42 void dumpEffectChains(int fd, const Vector<String16>& args); 43 44 void clearPowerManager(); 45 46 // base for record and playback 47 enum { 48 CFG_EVENT_IO, 49 CFG_EVENT_PRIO, 50 CFG_EVENT_SET_PARAMETER, 51 }; 52 53 class ConfigEventData: public RefBase { 54 public: 55 virtual ~ConfigEventData() {} 56 57 virtual void dump(char *buffer, size_t size) = 0; 58 protected: 59 ConfigEventData() {} 60 }; 61 62 // Config event sequence by client if status needed (e.g binder thread calling setParameters()): 63 // 1. create SetParameterConfigEvent. This sets mWaitStatus in config event 64 // 2. Lock mLock 65 // 3. Call sendConfigEvent_l(): Append to mConfigEvents and mWaitWorkCV.signal 66 // 4. sendConfigEvent_l() reads status from event->mStatus; 67 // 5. sendConfigEvent_l() returns status 68 // 6. Unlock 69 // 70 // Parameter sequence by server: threadLoop calling processConfigEvents_l(): 71 // 1. Lock mLock 72 // 2. If there is an entry in mConfigEvents proceed ... 73 // 3. Read first entry in mConfigEvents 74 // 4. Remove first entry from mConfigEvents 75 // 5. Process 76 // 6. Set event->mStatus 77 // 7. event->mCond.signal 78 // 8. Unlock 79 80 class ConfigEvent: public RefBase { 81 public: 82 virtual ~ConfigEvent() {} 83 84 void dump(char *buffer, size_t size) { mData->dump(buffer, size); } 85 86 const int mType; // event type e.g. CFG_EVENT_IO 87 Mutex mLock; // mutex associated with mCond 88 Condition mCond; // condition for status return 89 status_t mStatus; // status communicated to sender 90 bool mWaitStatus; // true if sender is waiting for status 91 sp<ConfigEventData> mData; // event specific parameter data 92 93 protected: 94 ConfigEvent(int type) : mType(type), mStatus(NO_ERROR), mWaitStatus(false), mData(NULL) {} 95 }; 96 97 class IoConfigEventData : public ConfigEventData { 98 public: 99 IoConfigEventData(int event, int param) : 100 mEvent(event), mParam(param) {} 101 102 virtual void dump(char *buffer, size_t size) { 103 snprintf(buffer, size, "IO event: event %d, param %d\n", mEvent, mParam); 104 } 105 106 const int mEvent; 107 const int mParam; 108 }; 109 110 class IoConfigEvent : public ConfigEvent { 111 public: 112 IoConfigEvent(int event, int param) : 113 ConfigEvent(CFG_EVENT_IO) { 114 mData = new IoConfigEventData(event, param); 115 } 116 virtual ~IoConfigEvent() {} 117 }; 118 119 class PrioConfigEventData : public ConfigEventData { 120 public: 121 PrioConfigEventData(pid_t pid, pid_t tid, int32_t prio) : 122 mPid(pid), mTid(tid), mPrio(prio) {} 123 124 virtual void dump(char *buffer, size_t size) { 125 snprintf(buffer, size, "Prio event: pid %d, tid %d, prio %d\n", mPid, mTid, mPrio); 126 } 127 128 const pid_t mPid; 129 const pid_t mTid; 130 const int32_t mPrio; 131 }; 132 133 class PrioConfigEvent : public ConfigEvent { 134 public: 135 PrioConfigEvent(pid_t pid, pid_t tid, int32_t prio) : 136 ConfigEvent(CFG_EVENT_PRIO) { 137 mData = new PrioConfigEventData(pid, tid, prio); 138 } 139 virtual ~PrioConfigEvent() {} 140 }; 141 142 class SetParameterConfigEventData : public ConfigEventData { 143 public: 144 SetParameterConfigEventData(String8 keyValuePairs) : 145 mKeyValuePairs(keyValuePairs) {} 146 147 virtual void dump(char *buffer, size_t size) { 148 snprintf(buffer, size, "KeyValue: %s\n", mKeyValuePairs.string()); 149 } 150 151 const String8 mKeyValuePairs; 152 }; 153 154 class SetParameterConfigEvent : public ConfigEvent { 155 public: 156 SetParameterConfigEvent(String8 keyValuePairs) : 157 ConfigEvent(CFG_EVENT_SET_PARAMETER) { 158 mData = new SetParameterConfigEventData(keyValuePairs); 159 mWaitStatus = true; 160 } 161 virtual ~SetParameterConfigEvent() {} 162 }; 163 164 165 class PMDeathRecipient : public IBinder::DeathRecipient { 166 public: 167 PMDeathRecipient(const wp<ThreadBase>& thread) : mThread(thread) {} 168 virtual ~PMDeathRecipient() {} 169 170 // IBinder::DeathRecipient 171 virtual void binderDied(const wp<IBinder>& who); 172 173 private: 174 PMDeathRecipient(const PMDeathRecipient&); 175 PMDeathRecipient& operator = (const PMDeathRecipient&); 176 177 wp<ThreadBase> mThread; 178 }; 179 180 virtual status_t initCheck() const = 0; 181 182 // static externally-visible 183 type_t type() const { return mType; } 184 audio_io_handle_t id() const { return mId;} 185 186 // dynamic externally-visible 187 uint32_t sampleRate() const { return mSampleRate; } 188 uint32_t channelCount() const { return mChannelCount; } 189 audio_channel_mask_t channelMask() const { return mChannelMask; } 190 audio_format_t format() const { return mFormat; } 191 // Called by AudioFlinger::frameCount(audio_io_handle_t output) and effects, 192 // and returns the [normal mix] buffer's frame count. 193 virtual size_t frameCount() const = 0; 194 size_t frameSize() const { return mFrameSize; } 195 196 // Should be "virtual status_t requestExitAndWait()" and override same 197 // method in Thread, but Thread::requestExitAndWait() is not yet virtual. 198 void exit(); 199 virtual bool checkForNewParameter_l(const String8& keyValuePair, 200 status_t& status) = 0; 201 virtual status_t setParameters(const String8& keyValuePairs); 202 virtual String8 getParameters(const String8& keys) = 0; 203 virtual void audioConfigChanged(int event, int param = 0) = 0; 204 // sendConfigEvent_l() must be called with ThreadBase::mLock held 205 // Can temporarily release the lock if waiting for a reply from 206 // processConfigEvents_l(). 207 status_t sendConfigEvent_l(sp<ConfigEvent>& event); 208 void sendIoConfigEvent(int event, int param = 0); 209 void sendIoConfigEvent_l(int event, int param = 0); 210 void sendPrioConfigEvent_l(pid_t pid, pid_t tid, int32_t prio); 211 status_t sendSetParameterConfigEvent_l(const String8& keyValuePair); 212 void processConfigEvents_l(); 213 virtual void cacheParameters_l() = 0; 214 215 // see note at declaration of mStandby, mOutDevice and mInDevice 216 bool standby() const { return mStandby; } 217 audio_devices_t outDevice() const { return mOutDevice; } 218 audio_devices_t inDevice() const { return mInDevice; } 219 220 virtual audio_stream_t* stream() const = 0; 221 222 sp<EffectHandle> createEffect_l( 223 const sp<AudioFlinger::Client>& client, 224 const sp<IEffectClient>& effectClient, 225 int32_t priority, 226 int sessionId, 227 effect_descriptor_t *desc, 228 int *enabled, 229 status_t *status /*non-NULL*/); 230 void disconnectEffect(const sp< EffectModule>& effect, 231 EffectHandle *handle, 232 bool unpinIfLast); 233 234 // return values for hasAudioSession (bit field) 235 enum effect_state { 236 EFFECT_SESSION = 0x1, // the audio session corresponds to at least one 237 // effect 238 TRACK_SESSION = 0x2 // the audio session corresponds to at least one 239 // track 240 }; 241 242 // get effect chain corresponding to session Id. 243 sp<EffectChain> getEffectChain(int sessionId); 244 // same as getEffectChain() but must be called with ThreadBase mutex locked 245 sp<EffectChain> getEffectChain_l(int sessionId) const; 246 // add an effect chain to the chain list (mEffectChains) 247 virtual status_t addEffectChain_l(const sp<EffectChain>& chain) = 0; 248 // remove an effect chain from the chain list (mEffectChains) 249 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain) = 0; 250 // lock all effect chains Mutexes. Must be called before releasing the 251 // ThreadBase mutex before processing the mixer and effects. This guarantees the 252 // integrity of the chains during the process. 253 // Also sets the parameter 'effectChains' to current value of mEffectChains. 254 void lockEffectChains_l(Vector< sp<EffectChain> >& effectChains); 255 // unlock effect chains after process 256 void unlockEffectChains(const Vector< sp<EffectChain> >& effectChains); 257 // get a copy of mEffectChains vector 258 Vector< sp<EffectChain> > getEffectChains_l() const { return mEffectChains; }; 259 // set audio mode to all effect chains 260 void setMode(audio_mode_t mode); 261 // get effect module with corresponding ID on specified audio session 262 sp<AudioFlinger::EffectModule> getEffect(int sessionId, int effectId); 263 sp<AudioFlinger::EffectModule> getEffect_l(int sessionId, int effectId); 264 // add and effect module. Also creates the effect chain is none exists for 265 // the effects audio session 266 status_t addEffect_l(const sp< EffectModule>& effect); 267 // remove and effect module. Also removes the effect chain is this was the last 268 // effect 269 void removeEffect_l(const sp< EffectModule>& effect); 270 // detach all tracks connected to an auxiliary effect 271 virtual void detachAuxEffect_l(int effectId __unused) {} 272 // returns either EFFECT_SESSION if effects on this audio session exist in one 273 // chain, or TRACK_SESSION if tracks on this audio session exist, or both 274 virtual uint32_t hasAudioSession(int sessionId) const = 0; 275 // the value returned by default implementation is not important as the 276 // strategy is only meaningful for PlaybackThread which implements this method 277 virtual uint32_t getStrategyForSession_l(int sessionId __unused) { return 0; } 278 279 // suspend or restore effect according to the type of effect passed. a NULL 280 // type pointer means suspend all effects in the session 281 void setEffectSuspended(const effect_uuid_t *type, 282 bool suspend, 283 int sessionId = AUDIO_SESSION_OUTPUT_MIX); 284 // check if some effects must be suspended/restored when an effect is enabled 285 // or disabled 286 void checkSuspendOnEffectEnabled(const sp<EffectModule>& effect, 287 bool enabled, 288 int sessionId = AUDIO_SESSION_OUTPUT_MIX); 289 void checkSuspendOnEffectEnabled_l(const sp<EffectModule>& effect, 290 bool enabled, 291 int sessionId = AUDIO_SESSION_OUTPUT_MIX); 292 293 virtual status_t setSyncEvent(const sp<SyncEvent>& event) = 0; 294 virtual bool isValidSyncEvent(const sp<SyncEvent>& event) const = 0; 295 296 // Return a reference to a per-thread heap which can be used to allocate IMemory 297 // objects that will be read-only to client processes, read/write to mediaserver, 298 // and shared by all client processes of the thread. 299 // The heap is per-thread rather than common across all threads, because 300 // clients can't be trusted not to modify the offset of the IMemory they receive. 301 // If a thread does not have such a heap, this method returns 0. 302 virtual sp<MemoryDealer> readOnlyHeap() const { return 0; } 303 304 mutable Mutex mLock; 305 306protected: 307 308 // entry describing an effect being suspended in mSuspendedSessions keyed vector 309 class SuspendedSessionDesc : public RefBase { 310 public: 311 SuspendedSessionDesc() : mRefCount(0) {} 312 313 int mRefCount; // number of active suspend requests 314 effect_uuid_t mType; // effect type UUID 315 }; 316 317 void acquireWakeLock(int uid = -1); 318 void acquireWakeLock_l(int uid = -1); 319 void releaseWakeLock(); 320 void releaseWakeLock_l(); 321 void updateWakeLockUids(const SortedVector<int> &uids); 322 void updateWakeLockUids_l(const SortedVector<int> &uids); 323 void getPowerManager_l(); 324 void setEffectSuspended_l(const effect_uuid_t *type, 325 bool suspend, 326 int sessionId); 327 // updated mSuspendedSessions when an effect suspended or restored 328 void updateSuspendedSessions_l(const effect_uuid_t *type, 329 bool suspend, 330 int sessionId); 331 // check if some effects must be suspended when an effect chain is added 332 void checkSuspendOnAddEffectChain_l(const sp<EffectChain>& chain); 333 334 String16 getWakeLockTag(); 335 336 virtual void preExit() { } 337 338 friend class AudioFlinger; // for mEffectChains 339 340 const type_t mType; 341 342 // Used by parameters, config events, addTrack_l, exit 343 Condition mWaitWorkCV; 344 345 const sp<AudioFlinger> mAudioFlinger; 346 347 // updated by PlaybackThread::readOutputParameters_l() or 348 // RecordThread::readInputParameters_l() 349 uint32_t mSampleRate; 350 size_t mFrameCount; // output HAL, direct output, record 351 audio_channel_mask_t mChannelMask; 352 uint32_t mChannelCount; 353 size_t mFrameSize; 354 audio_format_t mFormat; 355 size_t mBufferSize; // HAL buffer size for read() or write() 356 357 Vector< sp<ConfigEvent> > mConfigEvents; 358 359 // These fields are written and read by thread itself without lock or barrier, 360 // and read by other threads without lock or barrier via standby(), outDevice() 361 // and inDevice(). 362 // Because of the absence of a lock or barrier, any other thread that reads 363 // these fields must use the information in isolation, or be prepared to deal 364 // with possibility that it might be inconsistent with other information. 365 bool mStandby; // Whether thread is currently in standby. 366 audio_devices_t mOutDevice; // output device 367 audio_devices_t mInDevice; // input device 368 audio_source_t mAudioSource; // (see audio.h, audio_source_t) 369 370 const audio_io_handle_t mId; 371 Vector< sp<EffectChain> > mEffectChains; 372 373 static const int kNameLength = 16; // prctl(PR_SET_NAME) limit 374 char mName[kNameLength]; 375 sp<IPowerManager> mPowerManager; 376 sp<IBinder> mWakeLockToken; 377 const sp<PMDeathRecipient> mDeathRecipient; 378 // list of suspended effects per session and per type. The first vector is 379 // keyed by session ID, the second by type UUID timeLow field 380 KeyedVector< int, KeyedVector< int, sp<SuspendedSessionDesc> > > 381 mSuspendedSessions; 382 static const size_t kLogSize = 4 * 1024; 383 sp<NBLog::Writer> mNBLogWriter; 384}; 385 386// --- PlaybackThread --- 387class PlaybackThread : public ThreadBase { 388public: 389 390#include "PlaybackTracks.h" 391 392 enum mixer_state { 393 MIXER_IDLE, // no active tracks 394 MIXER_TRACKS_ENABLED, // at least one active track, but no track has any data ready 395 MIXER_TRACKS_READY, // at least one active track, and at least one track has data 396 MIXER_DRAIN_TRACK, // drain currently playing track 397 MIXER_DRAIN_ALL, // fully drain the hardware 398 // standby mode does not have an enum value 399 // suspend by audio policy manager is orthogonal to mixer state 400 }; 401 402 // retry count before removing active track in case of underrun on offloaded thread: 403 // we need to make sure that AudioTrack client has enough time to send large buffers 404//FIXME may be more appropriate if expressed in time units. Need to revise how underrun is handled 405 // for offloaded tracks 406 static const int8_t kMaxTrackRetriesOffload = 20; 407 408 PlaybackThread(const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, 409 audio_io_handle_t id, audio_devices_t device, type_t type); 410 virtual ~PlaybackThread(); 411 412 void dump(int fd, const Vector<String16>& args); 413 414 // Thread virtuals 415 virtual bool threadLoop(); 416 417 // RefBase 418 virtual void onFirstRef(); 419 420protected: 421 // Code snippets that were lifted up out of threadLoop() 422 virtual void threadLoop_mix() = 0; 423 virtual void threadLoop_sleepTime() = 0; 424 virtual ssize_t threadLoop_write(); 425 virtual void threadLoop_drain(); 426 virtual void threadLoop_standby(); 427 virtual void threadLoop_exit(); 428 virtual void threadLoop_removeTracks(const Vector< sp<Track> >& tracksToRemove); 429 430 // prepareTracks_l reads and writes mActiveTracks, and returns 431 // the pending set of tracks to remove via Vector 'tracksToRemove'. The caller 432 // is responsible for clearing or destroying this Vector later on, when it 433 // is safe to do so. That will drop the final ref count and destroy the tracks. 434 virtual mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove) = 0; 435 void removeTracks_l(const Vector< sp<Track> >& tracksToRemove); 436 437 void writeCallback(); 438 void resetWriteBlocked(uint32_t sequence); 439 void drainCallback(); 440 void resetDraining(uint32_t sequence); 441 442 static int asyncCallback(stream_callback_event_t event, void *param, void *cookie); 443 444 virtual bool waitingAsyncCallback(); 445 virtual bool waitingAsyncCallback_l(); 446 virtual bool shouldStandby_l(); 447 virtual void onAddNewTrack_l(); 448 449 // ThreadBase virtuals 450 virtual void preExit(); 451 452public: 453 454 virtual status_t initCheck() const { return (mOutput == NULL) ? NO_INIT : NO_ERROR; } 455 456 // return estimated latency in milliseconds, as reported by HAL 457 uint32_t latency() const; 458 // same, but lock must already be held 459 uint32_t latency_l() const; 460 461 void setMasterVolume(float value); 462 void setMasterMute(bool muted); 463 464 void setStreamVolume(audio_stream_type_t stream, float value); 465 void setStreamMute(audio_stream_type_t stream, bool muted); 466 467 float streamVolume(audio_stream_type_t stream) const; 468 469 sp<Track> createTrack_l( 470 const sp<AudioFlinger::Client>& client, 471 audio_stream_type_t streamType, 472 uint32_t sampleRate, 473 audio_format_t format, 474 audio_channel_mask_t channelMask, 475 size_t *pFrameCount, 476 const sp<IMemory>& sharedBuffer, 477 int sessionId, 478 IAudioFlinger::track_flags_t *flags, 479 pid_t tid, 480 int uid, 481 status_t *status /*non-NULL*/); 482 483 AudioStreamOut* getOutput() const; 484 AudioStreamOut* clearOutput(); 485 virtual audio_stream_t* stream() const; 486 487 // a very large number of suspend() will eventually wraparound, but unlikely 488 void suspend() { (void) android_atomic_inc(&mSuspended); } 489 void restore() 490 { 491 // if restore() is done without suspend(), get back into 492 // range so that the next suspend() will operate correctly 493 if (android_atomic_dec(&mSuspended) <= 0) { 494 android_atomic_release_store(0, &mSuspended); 495 } 496 } 497 bool isSuspended() const 498 { return android_atomic_acquire_load(&mSuspended) > 0; } 499 500 virtual String8 getParameters(const String8& keys); 501 virtual void audioConfigChanged(int event, int param = 0); 502 status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames); 503 // FIXME rename mixBuffer() to sinkBuffer() and remove int16_t* dependency. 504 // Consider also removing and passing an explicit mMainBuffer initialization 505 // parameter to AF::PlaybackThread::Track::Track(). 506 int16_t *mixBuffer() const { 507 return reinterpret_cast<int16_t *>(mSinkBuffer); }; 508 509 virtual void detachAuxEffect_l(int effectId); 510 status_t attachAuxEffect(const sp<AudioFlinger::PlaybackThread::Track> track, 511 int EffectId); 512 status_t attachAuxEffect_l(const sp<AudioFlinger::PlaybackThread::Track> track, 513 int EffectId); 514 515 virtual status_t addEffectChain_l(const sp<EffectChain>& chain); 516 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain); 517 virtual uint32_t hasAudioSession(int sessionId) const; 518 virtual uint32_t getStrategyForSession_l(int sessionId); 519 520 521 virtual status_t setSyncEvent(const sp<SyncEvent>& event); 522 virtual bool isValidSyncEvent(const sp<SyncEvent>& event) const; 523 524 // called with AudioFlinger lock held 525 void invalidateTracks(audio_stream_type_t streamType); 526 527 virtual size_t frameCount() const { return mNormalFrameCount; } 528 529 // Return's the HAL's frame count i.e. fast mixer buffer size. 530 size_t frameCountHAL() const { return mFrameCount; } 531 532 status_t getTimestamp_l(AudioTimestamp& timestamp); 533 534protected: 535 // updated by readOutputParameters_l() 536 size_t mNormalFrameCount; // normal mixer and effects 537 538 void* mSinkBuffer; // frame size aligned sink buffer 539 540 // TODO: 541 // Rearrange the buffer info into a struct/class with 542 // clear, copy, construction, destruction methods. 543 // 544 // mSinkBuffer also has associated with it: 545 // 546 // mSinkBufferSize: Sink Buffer Size 547 // mFormat: Sink Buffer Format 548 549 // Mixer Buffer (mMixerBuffer*) 550 // 551 // In the case of floating point or multichannel data, which is not in the 552 // sink format, it is required to accumulate in a higher precision or greater channel count 553 // buffer before downmixing or data conversion to the sink buffer. 554 555 // Set to "true" to enable the Mixer Buffer otherwise mixer output goes to sink buffer. 556 bool mMixerBufferEnabled; 557 558 // Storage, 32 byte aligned (may make this alignment a requirement later). 559 // Due to constraints on mNormalFrameCount, the buffer size is a multiple of 16 frames. 560 void* mMixerBuffer; 561 562 // Size of mMixerBuffer in bytes: mNormalFrameCount * #channels * sampsize. 563 size_t mMixerBufferSize; 564 565 // The audio format of mMixerBuffer. Set to AUDIO_FORMAT_PCM_(FLOAT|16_BIT) only. 566 audio_format_t mMixerBufferFormat; 567 568 // An internal flag set to true by MixerThread::prepareTracks_l() 569 // when mMixerBuffer contains valid data after mixing. 570 bool mMixerBufferValid; 571 572 // Effects Buffer (mEffectsBuffer*) 573 // 574 // In the case of effects data, which is not in the sink format, 575 // it is required to accumulate in a different buffer before data conversion 576 // to the sink buffer. 577 578 // Set to "true" to enable the Effects Buffer otherwise effects output goes to sink buffer. 579 bool mEffectBufferEnabled; 580 581 // Storage, 32 byte aligned (may make this alignment a requirement later). 582 // Due to constraints on mNormalFrameCount, the buffer size is a multiple of 16 frames. 583 void* mEffectBuffer; 584 585 // Size of mEffectsBuffer in bytes: mNormalFrameCount * #channels * sampsize. 586 size_t mEffectBufferSize; 587 588 // The audio format of mEffectsBuffer. Set to AUDIO_FORMAT_PCM_16_BIT only. 589 audio_format_t mEffectBufferFormat; 590 591 // An internal flag set to true by MixerThread::prepareTracks_l() 592 // when mEffectsBuffer contains valid data after mixing. 593 // 594 // When this is set, all mixer data is routed into the effects buffer 595 // for any processing (including output processing). 596 bool mEffectBufferValid; 597 598 // suspend count, > 0 means suspended. While suspended, the thread continues to pull from 599 // tracks and mix, but doesn't write to HAL. A2DP and SCO HAL implementations can't handle 600 // concurrent use of both of them, so Audio Policy Service suspends one of the threads to 601 // workaround that restriction. 602 // 'volatile' means accessed via atomic operations and no lock. 603 volatile int32_t mSuspended; 604 605 // FIXME overflows every 6+ hours at 44.1 kHz stereo 16-bit samples 606 // mFramesWritten would be better, or 64-bit even better 607 size_t mBytesWritten; 608private: 609 // mMasterMute is in both PlaybackThread and in AudioFlinger. When a 610 // PlaybackThread needs to find out if master-muted, it checks it's local 611 // copy rather than the one in AudioFlinger. This optimization saves a lock. 612 bool mMasterMute; 613 void setMasterMute_l(bool muted) { mMasterMute = muted; } 614protected: 615 SortedVector< wp<Track> > mActiveTracks; // FIXME check if this could be sp<> 616 SortedVector<int> mWakeLockUids; 617 int mActiveTracksGeneration; 618 wp<Track> mLatestActiveTrack; // latest track added to mActiveTracks 619 620 // Allocate a track name for a given channel mask. 621 // Returns name >= 0 if successful, -1 on failure. 622 virtual int getTrackName_l(audio_channel_mask_t channelMask, 623 audio_format_t format, int sessionId) = 0; 624 virtual void deleteTrackName_l(int name) = 0; 625 626 // Time to sleep between cycles when: 627 virtual uint32_t activeSleepTimeUs() const; // mixer state MIXER_TRACKS_ENABLED 628 virtual uint32_t idleSleepTimeUs() const = 0; // mixer state MIXER_IDLE 629 virtual uint32_t suspendSleepTimeUs() const = 0; // audio policy manager suspended us 630 // No sleep when mixer state == MIXER_TRACKS_READY; relies on audio HAL stream->write() 631 // No sleep in standby mode; waits on a condition 632 633 // Code snippets that are temporarily lifted up out of threadLoop() until the merge 634 void checkSilentMode_l(); 635 636 // Non-trivial for DUPLICATING only 637 virtual void saveOutputTracks() { } 638 virtual void clearOutputTracks() { } 639 640 // Cache various calculated values, at threadLoop() entry and after a parameter change 641 virtual void cacheParameters_l(); 642 643 virtual uint32_t correctLatency_l(uint32_t latency) const; 644 645private: 646 647 friend class AudioFlinger; // for numerous 648 649 PlaybackThread& operator = (const PlaybackThread&); 650 651 status_t addTrack_l(const sp<Track>& track); 652 bool destroyTrack_l(const sp<Track>& track); 653 void removeTrack_l(const sp<Track>& track); 654 void broadcast_l(); 655 656 void readOutputParameters_l(); 657 658 virtual void dumpInternals(int fd, const Vector<String16>& args); 659 void dumpTracks(int fd, const Vector<String16>& args); 660 661 SortedVector< sp<Track> > mTracks; 662 // mStreamTypes[] uses 1 additional stream type internally for the OutputTrack used by 663 // DuplicatingThread 664 stream_type_t mStreamTypes[AUDIO_STREAM_CNT + 1]; 665 AudioStreamOut *mOutput; 666 667 float mMasterVolume; 668 nsecs_t mLastWriteTime; 669 int mNumWrites; 670 int mNumDelayedWrites; 671 bool mInWrite; 672 673 // FIXME rename these former local variables of threadLoop to standard "m" names 674 nsecs_t standbyTime; 675 size_t mSinkBufferSize; 676 677 // cached copies of activeSleepTimeUs() and idleSleepTimeUs() made by cacheParameters_l() 678 uint32_t activeSleepTime; 679 uint32_t idleSleepTime; 680 681 uint32_t sleepTime; 682 683 // mixer status returned by prepareTracks_l() 684 mixer_state mMixerStatus; // current cycle 685 // previous cycle when in prepareTracks_l() 686 mixer_state mMixerStatusIgnoringFastTracks; 687 // FIXME or a separate ready state per track 688 689 // FIXME move these declarations into the specific sub-class that needs them 690 // MIXER only 691 uint32_t sleepTimeShift; 692 693 // same as AudioFlinger::mStandbyTimeInNsecs except for DIRECT which uses a shorter value 694 nsecs_t standbyDelay; 695 696 // MIXER only 697 nsecs_t maxPeriod; 698 699 // DUPLICATING only 700 uint32_t writeFrames; 701 702 size_t mBytesRemaining; 703 size_t mCurrentWriteLength; 704 bool mUseAsyncWrite; 705 // mWriteAckSequence contains current write sequence on bits 31-1. The write sequence is 706 // incremented each time a write(), a flush() or a standby() occurs. 707 // Bit 0 is set when a write blocks and indicates a callback is expected. 708 // Bit 0 is reset by the async callback thread calling resetWriteBlocked(). Out of sequence 709 // callbacks are ignored. 710 uint32_t mWriteAckSequence; 711 // mDrainSequence contains current drain sequence on bits 31-1. The drain sequence is 712 // incremented each time a drain is requested or a flush() or standby() occurs. 713 // Bit 0 is set when the drain() command is called at the HAL and indicates a callback is 714 // expected. 715 // Bit 0 is reset by the async callback thread calling resetDraining(). Out of sequence 716 // callbacks are ignored. 717 uint32_t mDrainSequence; 718 // A condition that must be evaluated by prepareTrack_l() has changed and we must not wait 719 // for async write callback in the thread loop before evaluating it 720 bool mSignalPending; 721 sp<AsyncCallbackThread> mCallbackThread; 722 723private: 724 // The HAL output sink is treated as non-blocking, but current implementation is blocking 725 sp<NBAIO_Sink> mOutputSink; 726 // If a fast mixer is present, the blocking pipe sink, otherwise clear 727 sp<NBAIO_Sink> mPipeSink; 728 // The current sink for the normal mixer to write it's (sub)mix, mOutputSink or mPipeSink 729 sp<NBAIO_Sink> mNormalSink; 730#ifdef TEE_SINK 731 // For dumpsys 732 sp<NBAIO_Sink> mTeeSink; 733 sp<NBAIO_Source> mTeeSource; 734#endif 735 uint32_t mScreenState; // cached copy of gScreenState 736 static const size_t kFastMixerLogSize = 4 * 1024; 737 sp<NBLog::Writer> mFastMixerNBLogWriter; 738public: 739 virtual bool hasFastMixer() const = 0; 740 virtual FastTrackUnderruns getFastTrackUnderruns(size_t fastIndex __unused) const 741 { FastTrackUnderruns dummy; return dummy; } 742 743protected: 744 // accessed by both binder threads and within threadLoop(), lock on mutex needed 745 unsigned mFastTrackAvailMask; // bit i set if fast track [i] is available 746 747private: 748 // timestamp latch: 749 // D input is written by threadLoop_write while mutex is unlocked, and read while locked 750 // Q output is written while locked, and read while locked 751 struct { 752 AudioTimestamp mTimestamp; 753 uint32_t mUnpresentedFrames; 754 } mLatchD, mLatchQ; 755 bool mLatchDValid; // true means mLatchD is valid, and clock it into latch at next opportunity 756 bool mLatchQValid; // true means mLatchQ is valid 757}; 758 759class MixerThread : public PlaybackThread { 760public: 761 MixerThread(const sp<AudioFlinger>& audioFlinger, 762 AudioStreamOut* output, 763 audio_io_handle_t id, 764 audio_devices_t device, 765 type_t type = MIXER); 766 virtual ~MixerThread(); 767 768 // Thread virtuals 769 770 virtual bool checkForNewParameter_l(const String8& keyValuePair, 771 status_t& status); 772 virtual void dumpInternals(int fd, const Vector<String16>& args); 773 774protected: 775 virtual mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove); 776 virtual int getTrackName_l(audio_channel_mask_t channelMask, 777 audio_format_t format, int sessionId); 778 virtual void deleteTrackName_l(int name); 779 virtual uint32_t idleSleepTimeUs() const; 780 virtual uint32_t suspendSleepTimeUs() const; 781 virtual void cacheParameters_l(); 782 783 // threadLoop snippets 784 virtual ssize_t threadLoop_write(); 785 virtual void threadLoop_standby(); 786 virtual void threadLoop_mix(); 787 virtual void threadLoop_sleepTime(); 788 virtual void threadLoop_removeTracks(const Vector< sp<Track> >& tracksToRemove); 789 virtual uint32_t correctLatency_l(uint32_t latency) const; 790 791 AudioMixer* mAudioMixer; // normal mixer 792private: 793 // one-time initialization, no locks required 794 FastMixer* mFastMixer; // non-NULL if there is also a fast mixer 795 sp<AudioWatchdog> mAudioWatchdog; // non-0 if there is an audio watchdog thread 796 797 // contents are not guaranteed to be consistent, no locks required 798 FastMixerDumpState mFastMixerDumpState; 799#ifdef STATE_QUEUE_DUMP 800 StateQueueObserverDump mStateQueueObserverDump; 801 StateQueueMutatorDump mStateQueueMutatorDump; 802#endif 803 AudioWatchdogDump mAudioWatchdogDump; 804 805 // accessible only within the threadLoop(), no locks required 806 // mFastMixer->sq() // for mutating and pushing state 807 int32_t mFastMixerFutex; // for cold idle 808 809public: 810 virtual bool hasFastMixer() const { return mFastMixer != NULL; } 811 virtual FastTrackUnderruns getFastTrackUnderruns(size_t fastIndex) const { 812 ALOG_ASSERT(fastIndex < FastMixerState::kMaxFastTracks); 813 return mFastMixerDumpState.mTracks[fastIndex].mUnderruns; 814 } 815}; 816 817class DirectOutputThread : public PlaybackThread { 818public: 819 820 DirectOutputThread(const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, 821 audio_io_handle_t id, audio_devices_t device); 822 virtual ~DirectOutputThread(); 823 824 // Thread virtuals 825 826 virtual bool checkForNewParameter_l(const String8& keyValuePair, 827 status_t& status); 828 829protected: 830 virtual int getTrackName_l(audio_channel_mask_t channelMask, 831 audio_format_t format, int sessionId); 832 virtual void deleteTrackName_l(int name); 833 virtual uint32_t activeSleepTimeUs() const; 834 virtual uint32_t idleSleepTimeUs() const; 835 virtual uint32_t suspendSleepTimeUs() const; 836 virtual void cacheParameters_l(); 837 838 // threadLoop snippets 839 virtual mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove); 840 virtual void threadLoop_mix(); 841 virtual void threadLoop_sleepTime(); 842 843 // volumes last sent to audio HAL with stream->set_volume() 844 float mLeftVolFloat; 845 float mRightVolFloat; 846 847 DirectOutputThread(const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, 848 audio_io_handle_t id, uint32_t device, ThreadBase::type_t type); 849 void processVolume_l(Track *track, bool lastTrack); 850 851 // prepareTracks_l() tells threadLoop_mix() the name of the single active track 852 sp<Track> mActiveTrack; 853public: 854 virtual bool hasFastMixer() const { return false; } 855}; 856 857class OffloadThread : public DirectOutputThread { 858public: 859 860 OffloadThread(const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output, 861 audio_io_handle_t id, uint32_t device); 862 virtual ~OffloadThread() {}; 863 864protected: 865 // threadLoop snippets 866 virtual mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove); 867 virtual void threadLoop_exit(); 868 869 virtual bool waitingAsyncCallback(); 870 virtual bool waitingAsyncCallback_l(); 871 virtual bool shouldStandby_l(); 872 virtual void onAddNewTrack_l(); 873 874private: 875 void flushHw_l(); 876 877private: 878 bool mHwPaused; 879 bool mFlushPending; 880 size_t mPausedWriteLength; // length in bytes of write interrupted by pause 881 size_t mPausedBytesRemaining; // bytes still waiting in mixbuffer after resume 882 wp<Track> mPreviousTrack; // used to detect track switch 883}; 884 885class AsyncCallbackThread : public Thread { 886public: 887 888 AsyncCallbackThread(const wp<PlaybackThread>& playbackThread); 889 890 virtual ~AsyncCallbackThread(); 891 892 // Thread virtuals 893 virtual bool threadLoop(); 894 895 // RefBase 896 virtual void onFirstRef(); 897 898 void exit(); 899 void setWriteBlocked(uint32_t sequence); 900 void resetWriteBlocked(); 901 void setDraining(uint32_t sequence); 902 void resetDraining(); 903 904private: 905 const wp<PlaybackThread> mPlaybackThread; 906 // mWriteAckSequence corresponds to the last write sequence passed by the offload thread via 907 // setWriteBlocked(). The sequence is shifted one bit to the left and the lsb is used 908 // to indicate that the callback has been received via resetWriteBlocked() 909 uint32_t mWriteAckSequence; 910 // mDrainSequence corresponds to the last drain sequence passed by the offload thread via 911 // setDraining(). The sequence is shifted one bit to the left and the lsb is used 912 // to indicate that the callback has been received via resetDraining() 913 uint32_t mDrainSequence; 914 Condition mWaitWorkCV; 915 Mutex mLock; 916}; 917 918class DuplicatingThread : public MixerThread { 919public: 920 DuplicatingThread(const sp<AudioFlinger>& audioFlinger, MixerThread* mainThread, 921 audio_io_handle_t id); 922 virtual ~DuplicatingThread(); 923 924 // Thread virtuals 925 void addOutputTrack(MixerThread* thread); 926 void removeOutputTrack(MixerThread* thread); 927 uint32_t waitTimeMs() const { return mWaitTimeMs; } 928protected: 929 virtual uint32_t activeSleepTimeUs() const; 930 931private: 932 bool outputsReady(const SortedVector< sp<OutputTrack> > &outputTracks); 933protected: 934 // threadLoop snippets 935 virtual void threadLoop_mix(); 936 virtual void threadLoop_sleepTime(); 937 virtual ssize_t threadLoop_write(); 938 virtual void threadLoop_standby(); 939 virtual void cacheParameters_l(); 940 941private: 942 // called from threadLoop, addOutputTrack, removeOutputTrack 943 virtual void updateWaitTime_l(); 944protected: 945 virtual void saveOutputTracks(); 946 virtual void clearOutputTracks(); 947private: 948 949 uint32_t mWaitTimeMs; 950 SortedVector < sp<OutputTrack> > outputTracks; 951 SortedVector < sp<OutputTrack> > mOutputTracks; 952public: 953 virtual bool hasFastMixer() const { return false; } 954}; 955 956 957// record thread 958class RecordThread : public ThreadBase 959{ 960public: 961 962 class RecordTrack; 963 class ResamplerBufferProvider : public AudioBufferProvider 964 // derives from AudioBufferProvider interface for use by resampler 965 { 966 public: 967 ResamplerBufferProvider(RecordTrack* recordTrack) : mRecordTrack(recordTrack) { } 968 virtual ~ResamplerBufferProvider() { } 969 // AudioBufferProvider interface 970 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer, int64_t pts); 971 virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer); 972 private: 973 RecordTrack * const mRecordTrack; 974 }; 975 976#include "RecordTracks.h" 977 978 RecordThread(const sp<AudioFlinger>& audioFlinger, 979 AudioStreamIn *input, 980 audio_io_handle_t id, 981 audio_devices_t outDevice, 982 audio_devices_t inDevice 983#ifdef TEE_SINK 984 , const sp<NBAIO_Sink>& teeSink 985#endif 986 ); 987 virtual ~RecordThread(); 988 989 // no addTrack_l ? 990 void destroyTrack_l(const sp<RecordTrack>& track); 991 void removeTrack_l(const sp<RecordTrack>& track); 992 993 void dumpInternals(int fd, const Vector<String16>& args); 994 void dumpTracks(int fd, const Vector<String16>& args); 995 996 // Thread virtuals 997 virtual bool threadLoop(); 998 999 // RefBase 1000 virtual void onFirstRef(); 1001 1002 virtual status_t initCheck() const { return (mInput == NULL) ? NO_INIT : NO_ERROR; } 1003 1004 virtual sp<MemoryDealer> readOnlyHeap() const { return mReadOnlyHeap; } 1005 1006 sp<AudioFlinger::RecordThread::RecordTrack> createRecordTrack_l( 1007 const sp<AudioFlinger::Client>& client, 1008 uint32_t sampleRate, 1009 audio_format_t format, 1010 audio_channel_mask_t channelMask, 1011 size_t *pFrameCount, 1012 int sessionId, 1013 int uid, 1014 IAudioFlinger::track_flags_t *flags, 1015 pid_t tid, 1016 status_t *status /*non-NULL*/); 1017 1018 status_t start(RecordTrack* recordTrack, 1019 AudioSystem::sync_event_t event, 1020 int triggerSession); 1021 1022 // ask the thread to stop the specified track, and 1023 // return true if the caller should then do it's part of the stopping process 1024 bool stop(RecordTrack* recordTrack); 1025 1026 void dump(int fd, const Vector<String16>& args); 1027 AudioStreamIn* clearInput(); 1028 virtual audio_stream_t* stream() const; 1029 1030 1031 virtual bool checkForNewParameter_l(const String8& keyValuePair, 1032 status_t& status); 1033 virtual void cacheParameters_l() {} 1034 virtual String8 getParameters(const String8& keys); 1035 virtual void audioConfigChanged(int event, int param = 0); 1036 void readInputParameters_l(); 1037 virtual uint32_t getInputFramesLost(); 1038 1039 virtual status_t addEffectChain_l(const sp<EffectChain>& chain); 1040 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain); 1041 virtual uint32_t hasAudioSession(int sessionId) const; 1042 1043 // Return the set of unique session IDs across all tracks. 1044 // The keys are the session IDs, and the associated values are meaningless. 1045 // FIXME replace by Set [and implement Bag/Multiset for other uses]. 1046 KeyedVector<int, bool> sessionIds() const; 1047 1048 virtual status_t setSyncEvent(const sp<SyncEvent>& event); 1049 virtual bool isValidSyncEvent(const sp<SyncEvent>& event) const; 1050 1051 static void syncStartEventCallback(const wp<SyncEvent>& event); 1052 1053 virtual size_t frameCount() const { return mFrameCount; } 1054 bool hasFastCapture() const { return false; } 1055 1056private: 1057 // Enter standby if not already in standby, and set mStandby flag 1058 void standbyIfNotAlreadyInStandby(); 1059 1060 // Call the HAL standby method unconditionally, and don't change mStandby flag 1061 void inputStandBy(); 1062 1063 AudioStreamIn *mInput; 1064 SortedVector < sp<RecordTrack> > mTracks; 1065 // mActiveTracks has dual roles: it indicates the current active track(s), and 1066 // is used together with mStartStopCond to indicate start()/stop() progress 1067 SortedVector< sp<RecordTrack> > mActiveTracks; 1068 // generation counter for mActiveTracks 1069 int mActiveTracksGen; 1070 Condition mStartStopCond; 1071 1072 // resampler converts input at HAL Hz to output at AudioRecord client Hz 1073 int16_t *mRsmpInBuffer; // see new[] for details on the size 1074 size_t mRsmpInFrames; // size of resampler input in frames 1075 size_t mRsmpInFramesP2;// size rounded up to a power-of-2 1076 1077 // rolling index that is never cleared 1078 int32_t mRsmpInRear; // last filled frame + 1 1079 1080 // For dumpsys 1081 const sp<NBAIO_Sink> mTeeSink; 1082 1083 const sp<MemoryDealer> mReadOnlyHeap; 1084}; 1085