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