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