blob: 43d1055b047cd72180154ad5cef4bd6697c86346 [file] [log] [blame]
Eric Laurent81784c32012-11-19 14:55:58 -08001/*
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
Eric Laurentbfb1b832013-01-07 09:53:42 -080031 RECORD, // Thread class is RecordThread
Eric Laurent6acd1d42017-01-04 14:23:29 -080032 OFFLOAD, // Thread class is OffloadThread
Andy Hungea840382020-05-05 21:50:17 -070033 MMAP_PLAYBACK, // Thread class for MMAP playback stream
34 MMAP_CAPTURE, // Thread class for MMAP capture stream
Eric Laurent1c5e2e32021-08-18 18:50:28 +020035 SPATIALIZER, //
Glenn Kasten1bfe09a2017-02-21 13:05:56 -080036 // If you add any values here, also update ThreadBase::threadTypeToString()
Eric Laurent81784c32012-11-19 14:55:58 -080037 };
38
Glenn Kasten97b7b752014-09-28 13:04:24 -070039 static const char *threadTypeToString(type_t type);
40
Eric Laurent81784c32012-11-19 14:55:58 -080041 ThreadBase(const sp<AudioFlinger>& audioFlinger, audio_io_handle_t id,
Andy Hungcf10d742020-04-28 15:38:24 -070042 type_t type, bool systemReady, bool isOut);
Eric Laurent81784c32012-11-19 14:55:58 -080043 virtual ~ThreadBase();
44
Glenn Kastencf04c2c2013-08-06 07:41:16 -070045 virtual status_t readyToRun();
46
Eric Laurent81784c32012-11-19 14:55:58 -080047 void clearPowerManager();
48
49 // base for record and playback
50 enum {
51 CFG_EVENT_IO,
Eric Laurent10351942014-05-08 18:49:52 -070052 CFG_EVENT_PRIO,
53 CFG_EVENT_SET_PARAMETER,
Eric Laurent1c333e22014-05-20 10:48:17 -070054 CFG_EVENT_CREATE_AUDIO_PATCH,
55 CFG_EVENT_RELEASE_AUDIO_PATCH,
jiabinc52b1ff2019-10-31 17:20:42 -070056 CFG_EVENT_UPDATE_OUT_DEVICE,
Eric Laurentb3f315a2021-07-13 15:09:05 +020057 CFG_EVENT_RESIZE_BUFFER,
58 CFG_EVENT_CHECK_OUTPUT_STAGE_EFFECTS
Eric Laurent81784c32012-11-19 14:55:58 -080059 };
60
Eric Laurent10351942014-05-08 18:49:52 -070061 class ConfigEventData: public RefBase {
Eric Laurent81784c32012-11-19 14:55:58 -080062 public:
Eric Laurent10351942014-05-08 18:49:52 -070063 virtual ~ConfigEventData() {}
Eric Laurent81784c32012-11-19 14:55:58 -080064
65 virtual void dump(char *buffer, size_t size) = 0;
Eric Laurent10351942014-05-08 18:49:52 -070066 protected:
67 ConfigEventData() {}
Eric Laurent81784c32012-11-19 14:55:58 -080068 };
69
Eric Laurent10351942014-05-08 18:49:52 -070070 // Config event sequence by client if status needed (e.g binder thread calling setParameters()):
71 // 1. create SetParameterConfigEvent. This sets mWaitStatus in config event
72 // 2. Lock mLock
73 // 3. Call sendConfigEvent_l(): Append to mConfigEvents and mWaitWorkCV.signal
74 // 4. sendConfigEvent_l() reads status from event->mStatus;
75 // 5. sendConfigEvent_l() returns status
76 // 6. Unlock
77 //
78 // Parameter sequence by server: threadLoop calling processConfigEvents_l():
79 // 1. Lock mLock
80 // 2. If there is an entry in mConfigEvents proceed ...
81 // 3. Read first entry in mConfigEvents
82 // 4. Remove first entry from mConfigEvents
83 // 5. Process
84 // 6. Set event->mStatus
85 // 7. event->mCond.signal
86 // 8. Unlock
Eric Laurent81784c32012-11-19 14:55:58 -080087
Eric Laurent10351942014-05-08 18:49:52 -070088 class ConfigEvent: public RefBase {
89 public:
90 virtual ~ConfigEvent() {}
91
Eric Laurentb3f315a2021-07-13 15:09:05 +020092 void dump(char *buffer, size_t size) {
93 snprintf(buffer, size, "Event type: %d\n", mType);
94 if (mData != nullptr) {
95 snprintf(buffer, size, "Data:\n");
96 mData->dump(buffer, size);
97 }
98 }
Eric Laurent10351942014-05-08 18:49:52 -070099
100 const int mType; // event type e.g. CFG_EVENT_IO
101 Mutex mLock; // mutex associated with mCond
102 Condition mCond; // condition for status return
103 status_t mStatus; // status communicated to sender
104 bool mWaitStatus; // true if sender is waiting for status
Eric Laurent72e3f392015-05-20 14:43:50 -0700105 bool mRequiresSystemReady; // true if must wait for system ready to enter event queue
Eric Laurent10351942014-05-08 18:49:52 -0700106 sp<ConfigEventData> mData; // event specific parameter data
107
108 protected:
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -0700109 explicit ConfigEvent(int type, bool requiresSystemReady = false) :
Eric Laurent72e3f392015-05-20 14:43:50 -0700110 mType(type), mStatus(NO_ERROR), mWaitStatus(false),
111 mRequiresSystemReady(requiresSystemReady), mData(NULL) {}
Eric Laurent10351942014-05-08 18:49:52 -0700112 };
113
114 class IoConfigEventData : public ConfigEventData {
115 public:
Mikhail Naganov88536df2021-07-26 17:30:29 -0700116 IoConfigEventData(audio_io_config_event_t event, pid_t pid,
Eric Laurent09f1ed22019-04-24 17:45:17 -0700117 audio_port_handle_t portId) :
118 mEvent(event), mPid(pid), mPortId(portId) {}
Eric Laurent81784c32012-11-19 14:55:58 -0800119
120 virtual void dump(char *buffer, size_t size) {
Eric Laurentb3f315a2021-07-13 15:09:05 +0200121 snprintf(buffer, size, "- IO event: event %d\n", mEvent);
Eric Laurent81784c32012-11-19 14:55:58 -0800122 }
123
Mikhail Naganov88536df2021-07-26 17:30:29 -0700124 const audio_io_config_event_t mEvent;
Eric Laurent7c1ec5f2015-07-09 14:52:47 -0700125 const pid_t mPid;
Eric Laurent09f1ed22019-04-24 17:45:17 -0700126 const audio_port_handle_t mPortId;
Eric Laurent81784c32012-11-19 14:55:58 -0800127 };
128
Eric Laurent10351942014-05-08 18:49:52 -0700129 class IoConfigEvent : public ConfigEvent {
Eric Laurent81784c32012-11-19 14:55:58 -0800130 public:
Mikhail Naganov88536df2021-07-26 17:30:29 -0700131 IoConfigEvent(audio_io_config_event_t event, pid_t pid, audio_port_handle_t portId) :
Eric Laurent10351942014-05-08 18:49:52 -0700132 ConfigEvent(CFG_EVENT_IO) {
Eric Laurent09f1ed22019-04-24 17:45:17 -0700133 mData = new IoConfigEventData(event, pid, portId);
Eric Laurent10351942014-05-08 18:49:52 -0700134 }
135 virtual ~IoConfigEvent() {}
136 };
Eric Laurent81784c32012-11-19 14:55:58 -0800137
Eric Laurent10351942014-05-08 18:49:52 -0700138 class PrioConfigEventData : public ConfigEventData {
139 public:
Mikhail Naganov83f04272017-02-07 10:45:09 -0800140 PrioConfigEventData(pid_t pid, pid_t tid, int32_t prio, bool forApp) :
141 mPid(pid), mTid(tid), mPrio(prio), mForApp(forApp) {}
Eric Laurent81784c32012-11-19 14:55:58 -0800142
143 virtual void dump(char *buffer, size_t size) {
Eric Laurentb3f315a2021-07-13 15:09:05 +0200144 snprintf(buffer, size, "- Prio event: pid %d, tid %d, prio %d, for app? %d\n",
Mikhail Naganov83f04272017-02-07 10:45:09 -0800145 mPid, mTid, mPrio, mForApp);
Eric Laurent81784c32012-11-19 14:55:58 -0800146 }
147
Eric Laurent81784c32012-11-19 14:55:58 -0800148 const pid_t mPid;
149 const pid_t mTid;
150 const int32_t mPrio;
Mikhail Naganov83f04272017-02-07 10:45:09 -0800151 const bool mForApp;
Eric Laurent81784c32012-11-19 14:55:58 -0800152 };
153
Eric Laurent10351942014-05-08 18:49:52 -0700154 class PrioConfigEvent : public ConfigEvent {
155 public:
Mikhail Naganov83f04272017-02-07 10:45:09 -0800156 PrioConfigEvent(pid_t pid, pid_t tid, int32_t prio, bool forApp) :
Eric Laurent72e3f392015-05-20 14:43:50 -0700157 ConfigEvent(CFG_EVENT_PRIO, true) {
Mikhail Naganov83f04272017-02-07 10:45:09 -0800158 mData = new PrioConfigEventData(pid, tid, prio, forApp);
Eric Laurent10351942014-05-08 18:49:52 -0700159 }
160 virtual ~PrioConfigEvent() {}
161 };
162
163 class SetParameterConfigEventData : public ConfigEventData {
164 public:
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -0700165 explicit SetParameterConfigEventData(String8 keyValuePairs) :
Eric Laurent10351942014-05-08 18:49:52 -0700166 mKeyValuePairs(keyValuePairs) {}
167
168 virtual void dump(char *buffer, size_t size) {
Eric Laurentb3f315a2021-07-13 15:09:05 +0200169 snprintf(buffer, size, "- KeyValue: %s\n", mKeyValuePairs.string());
Eric Laurent10351942014-05-08 18:49:52 -0700170 }
171
172 const String8 mKeyValuePairs;
173 };
174
175 class SetParameterConfigEvent : public ConfigEvent {
176 public:
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -0700177 explicit SetParameterConfigEvent(String8 keyValuePairs) :
Eric Laurent10351942014-05-08 18:49:52 -0700178 ConfigEvent(CFG_EVENT_SET_PARAMETER) {
179 mData = new SetParameterConfigEventData(keyValuePairs);
180 mWaitStatus = true;
181 }
182 virtual ~SetParameterConfigEvent() {}
183 };
184
Eric Laurent1c333e22014-05-20 10:48:17 -0700185 class CreateAudioPatchConfigEventData : public ConfigEventData {
186 public:
187 CreateAudioPatchConfigEventData(const struct audio_patch patch,
188 audio_patch_handle_t handle) :
189 mPatch(patch), mHandle(handle) {}
190
191 virtual void dump(char *buffer, size_t size) {
Eric Laurentb3f315a2021-07-13 15:09:05 +0200192 snprintf(buffer, size, "- Patch handle: %u\n", mHandle);
Eric Laurent1c333e22014-05-20 10:48:17 -0700193 }
194
195 const struct audio_patch mPatch;
196 audio_patch_handle_t mHandle;
197 };
198
199 class CreateAudioPatchConfigEvent : public ConfigEvent {
200 public:
201 CreateAudioPatchConfigEvent(const struct audio_patch patch,
202 audio_patch_handle_t handle) :
203 ConfigEvent(CFG_EVENT_CREATE_AUDIO_PATCH) {
204 mData = new CreateAudioPatchConfigEventData(patch, handle);
205 mWaitStatus = true;
206 }
207 virtual ~CreateAudioPatchConfigEvent() {}
208 };
209
210 class ReleaseAudioPatchConfigEventData : public ConfigEventData {
211 public:
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -0700212 explicit ReleaseAudioPatchConfigEventData(const audio_patch_handle_t handle) :
Eric Laurent1c333e22014-05-20 10:48:17 -0700213 mHandle(handle) {}
214
215 virtual void dump(char *buffer, size_t size) {
Eric Laurentb3f315a2021-07-13 15:09:05 +0200216 snprintf(buffer, size, "- Patch handle: %u\n", mHandle);
Eric Laurent1c333e22014-05-20 10:48:17 -0700217 }
218
219 audio_patch_handle_t mHandle;
220 };
221
222 class ReleaseAudioPatchConfigEvent : public ConfigEvent {
223 public:
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -0700224 explicit ReleaseAudioPatchConfigEvent(const audio_patch_handle_t handle) :
Eric Laurent1c333e22014-05-20 10:48:17 -0700225 ConfigEvent(CFG_EVENT_RELEASE_AUDIO_PATCH) {
226 mData = new ReleaseAudioPatchConfigEventData(handle);
227 mWaitStatus = true;
228 }
229 virtual ~ReleaseAudioPatchConfigEvent() {}
230 };
Eric Laurent81784c32012-11-19 14:55:58 -0800231
jiabinc52b1ff2019-10-31 17:20:42 -0700232 class UpdateOutDevicesConfigEventData : public ConfigEventData {
233 public:
234 explicit UpdateOutDevicesConfigEventData(const DeviceDescriptorBaseVector& outDevices) :
235 mOutDevices(outDevices) {}
236
237 virtual void dump(char *buffer, size_t size) {
Eric Laurentb3f315a2021-07-13 15:09:05 +0200238 snprintf(buffer, size, "- Devices: %s", android::toString(mOutDevices).c_str());
jiabinc52b1ff2019-10-31 17:20:42 -0700239 }
240
241 DeviceDescriptorBaseVector mOutDevices;
242 };
243
244 class UpdateOutDevicesConfigEvent : public ConfigEvent {
245 public:
246 explicit UpdateOutDevicesConfigEvent(const DeviceDescriptorBaseVector& outDevices) :
247 ConfigEvent(CFG_EVENT_UPDATE_OUT_DEVICE) {
248 mData = new UpdateOutDevicesConfigEventData(outDevices);
249 }
250
251 virtual ~UpdateOutDevicesConfigEvent();
252 };
253
Eric Laurentec376dc2021-04-08 20:41:22 +0200254 class ResizeBufferConfigEventData : public ConfigEventData {
255 public:
256 explicit ResizeBufferConfigEventData(int32_t maxSharedAudioHistoryMs) :
257 mMaxSharedAudioHistoryMs(maxSharedAudioHistoryMs) {}
258
259 virtual void dump(char *buffer, size_t size) {
Eric Laurentb3f315a2021-07-13 15:09:05 +0200260 snprintf(buffer, size, "- mMaxSharedAudioHistoryMs: %d", mMaxSharedAudioHistoryMs);
Eric Laurentec376dc2021-04-08 20:41:22 +0200261 }
262
263 int32_t mMaxSharedAudioHistoryMs;
264 };
265
266 class ResizeBufferConfigEvent : public ConfigEvent {
267 public:
268 explicit ResizeBufferConfigEvent(int32_t maxSharedAudioHistoryMs) :
269 ConfigEvent(CFG_EVENT_RESIZE_BUFFER) {
270 mData = new ResizeBufferConfigEventData(maxSharedAudioHistoryMs);
271 }
272
273 virtual ~ResizeBufferConfigEvent() {}
274 };
275
Eric Laurentb3f315a2021-07-13 15:09:05 +0200276 class CheckOutputStageEffectsEvent : public ConfigEvent {
277 public:
278 CheckOutputStageEffectsEvent() :
279 ConfigEvent(CFG_EVENT_CHECK_OUTPUT_STAGE_EFFECTS) {
280 }
281
282 virtual ~CheckOutputStageEffectsEvent() {}
283 };
284
285
Eric Laurent81784c32012-11-19 14:55:58 -0800286 class PMDeathRecipient : public IBinder::DeathRecipient {
287 public:
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -0700288 explicit PMDeathRecipient(const wp<ThreadBase>& thread) : mThread(thread) {}
Eric Laurent81784c32012-11-19 14:55:58 -0800289 virtual ~PMDeathRecipient() {}
290
291 // IBinder::DeathRecipient
292 virtual void binderDied(const wp<IBinder>& who);
293
294 private:
Mikhail Naganovbf493082017-04-17 17:37:12 -0700295 DISALLOW_COPY_AND_ASSIGN(PMDeathRecipient);
Eric Laurent81784c32012-11-19 14:55:58 -0800296
297 wp<ThreadBase> mThread;
298 };
299
300 virtual status_t initCheck() const = 0;
301
302 // static externally-visible
303 type_t type() const { return mType; }
Eric Laurentf6870ae2015-05-08 10:50:03 -0700304 bool isDuplicating() const { return (mType == DUPLICATING); }
305
Eric Laurent81784c32012-11-19 14:55:58 -0800306 audio_io_handle_t id() const { return mId;}
307
308 // dynamic externally-visible
309 uint32_t sampleRate() const { return mSampleRate; }
Eric Laurent81784c32012-11-19 14:55:58 -0800310 audio_channel_mask_t channelMask() const { return mChannelMask; }
Eric Laurentf1f22e72021-07-13 14:04:14 +0200311 virtual audio_channel_mask_t mixerChannelMask() const { return mChannelMask; }
312
Andy Hung463be252014-07-10 16:56:07 -0700313 audio_format_t format() const { return mHALFormat; }
Eric Laurent83b88082014-06-20 18:31:16 -0700314 uint32_t channelCount() const { return mChannelCount; }
Eric Laurentf1f22e72021-07-13 14:04:14 +0200315
Eric Laurent81784c32012-11-19 14:55:58 -0800316 // Called by AudioFlinger::frameCount(audio_io_handle_t output) and effects,
Glenn Kasten9b58f632013-07-16 11:37:48 -0700317 // and returns the [normal mix] buffer's frame count.
318 virtual size_t frameCount() const = 0;
jiabineb3bda02020-06-30 14:07:03 -0700319 virtual audio_channel_mask_t hapticChannelMask() const { return AUDIO_CHANNEL_NONE; }
Eric Laurent6b446ce2019-12-13 10:56:31 -0800320 virtual uint32_t latency_l() const { return 0; }
321 virtual void setVolumeForOutput_l(float left __unused, float right __unused) const {}
Glenn Kasten4a8308b2016-04-18 14:10:01 -0700322
323 // Return's the HAL's frame count i.e. fast mixer buffer size.
324 size_t frameCountHAL() const { return mFrameCount; }
325
Eric Laurentbfb1b832013-01-07 09:53:42 -0800326 size_t frameSize() const { return mFrameSize; }
Eric Laurent81784c32012-11-19 14:55:58 -0800327
328 // Should be "virtual status_t requestExitAndWait()" and override same
329 // method in Thread, but Thread::requestExitAndWait() is not yet virtual.
330 void exit();
Eric Laurent10351942014-05-08 18:49:52 -0700331 virtual bool checkForNewParameter_l(const String8& keyValuePair,
332 status_t& status) = 0;
Eric Laurent81784c32012-11-19 14:55:58 -0800333 virtual status_t setParameters(const String8& keyValuePairs);
334 virtual String8 getParameters(const String8& keys) = 0;
Mikhail Naganov88536df2021-07-26 17:30:29 -0700335 virtual void ioConfigChanged(audio_io_config_event_t event, pid_t pid = 0,
Eric Laurent09f1ed22019-04-24 17:45:17 -0700336 audio_port_handle_t portId = AUDIO_PORT_HANDLE_NONE) = 0;
Eric Laurent10351942014-05-08 18:49:52 -0700337 // sendConfigEvent_l() must be called with ThreadBase::mLock held
338 // Can temporarily release the lock if waiting for a reply from
339 // processConfigEvents_l().
340 status_t sendConfigEvent_l(sp<ConfigEvent>& event);
Mikhail Naganov88536df2021-07-26 17:30:29 -0700341 void sendIoConfigEvent(audio_io_config_event_t event, pid_t pid = 0,
Eric Laurent09f1ed22019-04-24 17:45:17 -0700342 audio_port_handle_t portId = AUDIO_PORT_HANDLE_NONE);
Mikhail Naganov88536df2021-07-26 17:30:29 -0700343 void sendIoConfigEvent_l(audio_io_config_event_t event, pid_t pid = 0,
Eric Laurent09f1ed22019-04-24 17:45:17 -0700344 audio_port_handle_t portId = AUDIO_PORT_HANDLE_NONE);
Mikhail Naganov83f04272017-02-07 10:45:09 -0800345 void sendPrioConfigEvent(pid_t pid, pid_t tid, int32_t prio, bool forApp);
346 void sendPrioConfigEvent_l(pid_t pid, pid_t tid, int32_t prio, bool forApp);
Eric Laurent10351942014-05-08 18:49:52 -0700347 status_t sendSetParameterConfigEvent_l(const String8& keyValuePair);
Eric Laurent1c333e22014-05-20 10:48:17 -0700348 status_t sendCreateAudioPatchConfigEvent(const struct audio_patch *patch,
349 audio_patch_handle_t *handle);
350 status_t sendReleaseAudioPatchConfigEvent(audio_patch_handle_t handle);
jiabinc52b1ff2019-10-31 17:20:42 -0700351 status_t sendUpdateOutDeviceConfigEvent(
352 const DeviceDescriptorBaseVector& outDevices);
Eric Laurentec376dc2021-04-08 20:41:22 +0200353 void sendResizeBufferConfigEvent_l(int32_t maxSharedAudioHistoryMs);
Eric Laurentb3f315a2021-07-13 15:09:05 +0200354 void sendCheckOutputStageEffectsEvent();
355 void sendCheckOutputStageEffectsEvent_l();
356
Eric Laurent021cf962014-05-13 10:18:14 -0700357 void processConfigEvents_l();
Eric Laurentb3f315a2021-07-13 15:09:05 +0200358 virtual void setCheckOutputStageEffects() {}
Eric Laurent10351942014-05-08 18:49:52 -0700359 virtual void cacheParameters_l() = 0;
Eric Laurent1c333e22014-05-20 10:48:17 -0700360 virtual status_t createAudioPatch_l(const struct audio_patch *patch,
361 audio_patch_handle_t *handle) = 0;
362 virtual status_t releaseAudioPatch_l(const audio_patch_handle_t handle) = 0;
jiabinc52b1ff2019-10-31 17:20:42 -0700363 virtual void updateOutDevices(const DeviceDescriptorBaseVector& outDevices);
Mikhail Naganovdc769682018-05-04 15:34:08 -0700364 virtual void toAudioPortConfig(struct audio_port_config *config) = 0;
Eric Laurent1c333e22014-05-20 10:48:17 -0700365
Eric Laurent5f0fd7b2021-05-07 16:33:26 +0200366 virtual void resizeInputBuffer_l(int32_t maxSharedAudioHistoryMs);
Eric Laurentec376dc2021-04-08 20:41:22 +0200367
368
Eric Laurent81784c32012-11-19 14:55:58 -0800369
370 // see note at declaration of mStandby, mOutDevice and mInDevice
371 bool standby() const { return mStandby; }
jiabinc52b1ff2019-10-31 17:20:42 -0700372 const DeviceTypeSet outDeviceTypes() const {
373 return getAudioDeviceTypes(mOutDeviceTypeAddrs);
374 }
375 audio_devices_t inDeviceType() const { return mInDeviceTypeAddr.mType; }
376 DeviceTypeSet getDeviceTypes() const {
377 return isOutput() ? outDeviceTypes() : DeviceTypeSet({inDeviceType()});
378 }
Andy Hung293558a2017-03-21 12:19:20 -0700379
jiabin8f278ee2019-11-11 12:16:27 -0800380 const AudioDeviceTypeAddrVector& outDeviceTypeAddrs() const {
381 return mOutDeviceTypeAddrs;
382 }
383 const AudioDeviceTypeAddr& inDeviceTypeAddr() const {
384 return mInDeviceTypeAddr;
385 }
386
Andy Hungcf10d742020-04-28 15:38:24 -0700387 bool isOutput() const { return mIsOut; }
Eric Laurent81784c32012-11-19 14:55:58 -0800388
Andy Hungea840382020-05-05 21:50:17 -0700389 bool isOffloadOrMmap() const {
390 switch (mType) {
391 case OFFLOAD:
392 case MMAP_PLAYBACK:
393 case MMAP_CAPTURE:
394 return true;
395 default:
396 return false;
397 }
398 }
399
Mikhail Naganov1dc98672016-08-18 17:50:29 -0700400 virtual sp<StreamHalInterface> stream() const = 0;
Eric Laurent81784c32012-11-19 14:55:58 -0800401
402 sp<EffectHandle> createEffect_l(
403 const sp<AudioFlinger::Client>& client,
Ytai Ben-Tsvi9cd89812020-07-01 17:12:06 -0700404 const sp<media::IEffectClient>& effectClient,
Eric Laurent81784c32012-11-19 14:55:58 -0800405 int32_t priority,
Glenn Kastend848eb42016-03-08 13:42:11 -0800406 audio_session_t sessionId,
Eric Laurent81784c32012-11-19 14:55:58 -0800407 effect_descriptor_t *desc,
408 int *enabled,
Eric Laurent0d5a2ed2016-12-01 15:28:29 -0800409 status_t *status /*non-NULL*/,
Eric Laurent2fe0acd2020-03-13 14:30:46 -0700410 bool pinned,
Eric Laurentde8caf42021-08-11 17:19:25 +0200411 bool probe,
412 bool notifyFramesProcessed);
Eric Laurent81784c32012-11-19 14:55:58 -0800413
414 // return values for hasAudioSession (bit field)
415 enum effect_state {
416 EFFECT_SESSION = 0x1, // the audio session corresponds to at least one
417 // effect
Eric Laurent4c415062016-06-17 16:14:16 -0700418 TRACK_SESSION = 0x2, // the audio session corresponds to at least one
Eric Laurent81784c32012-11-19 14:55:58 -0800419 // track
Eric Laurentb62d0362021-10-26 17:40:18 +0200420 FAST_SESSION = 0x4, // the audio session corresponds to at least one
Eric Laurent4c415062016-06-17 16:14:16 -0700421 // fast track
Eric Laurentb62d0362021-10-26 17:40:18 +0200422 SPATIALIZED_SESSION = 0x8 // the audio session corresponds to at least one
423 // spatialized track
Eric Laurent81784c32012-11-19 14:55:58 -0800424 };
425
426 // get effect chain corresponding to session Id.
Glenn Kastend848eb42016-03-08 13:42:11 -0800427 sp<EffectChain> getEffectChain(audio_session_t sessionId);
Eric Laurent81784c32012-11-19 14:55:58 -0800428 // same as getEffectChain() but must be called with ThreadBase mutex locked
Glenn Kastend848eb42016-03-08 13:42:11 -0800429 sp<EffectChain> getEffectChain_l(audio_session_t sessionId) const;
Eric Laurent6c796322019-04-09 14:13:17 -0700430 std::vector<int> getEffectIds_l(audio_session_t sessionId);
Eric Laurent81784c32012-11-19 14:55:58 -0800431 // add an effect chain to the chain list (mEffectChains)
432 virtual status_t addEffectChain_l(const sp<EffectChain>& chain) = 0;
433 // remove an effect chain from the chain list (mEffectChains)
434 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain) = 0;
435 // lock all effect chains Mutexes. Must be called before releasing the
436 // ThreadBase mutex before processing the mixer and effects. This guarantees the
437 // integrity of the chains during the process.
438 // Also sets the parameter 'effectChains' to current value of mEffectChains.
439 void lockEffectChains_l(Vector< sp<EffectChain> >& effectChains);
440 // unlock effect chains after process
441 void unlockEffectChains(const Vector< sp<EffectChain> >& effectChains);
Eric Laurentbfb1b832013-01-07 09:53:42 -0800442 // get a copy of mEffectChains vector
443 Vector< sp<EffectChain> > getEffectChains_l() const { return mEffectChains; };
Eric Laurent81784c32012-11-19 14:55:58 -0800444 // set audio mode to all effect chains
445 void setMode(audio_mode_t mode);
446 // get effect module with corresponding ID on specified audio session
Glenn Kastend848eb42016-03-08 13:42:11 -0800447 sp<AudioFlinger::EffectModule> getEffect(audio_session_t sessionId, int effectId);
448 sp<AudioFlinger::EffectModule> getEffect_l(audio_session_t sessionId, int effectId);
Eric Laurent81784c32012-11-19 14:55:58 -0800449 // add and effect module. Also creates the effect chain is none exists for
Eric Laurent6c796322019-04-09 14:13:17 -0700450 // the effects audio session. Only called in a context of moving an effect
451 // from one thread to another
Eric Laurent81784c32012-11-19 14:55:58 -0800452 status_t addEffect_l(const sp< EffectModule>& effect);
453 // remove and effect module. Also removes the effect chain is this was the last
454 // effect
Eric Laurent0d5a2ed2016-12-01 15:28:29 -0800455 void removeEffect_l(const sp< EffectModule>& effect, bool release = false);
456 // disconnect an effect handle from module and destroy module if last handle
457 void disconnectEffectHandle(EffectHandle *handle, bool unpinIfLast);
Eric Laurent81784c32012-11-19 14:55:58 -0800458 // detach all tracks connected to an auxiliary effect
Glenn Kasten0f11b512014-01-31 16:18:54 -0800459 virtual void detachAuxEffect_l(int effectId __unused) {}
Eric Laurent4c415062016-06-17 16:14:16 -0700460 // returns a combination of:
461 // - EFFECT_SESSION if effects on this audio session exist in one chain
462 // - TRACK_SESSION if tracks on this audio session exist
463 // - FAST_SESSION if fast tracks on this audio session exist
Eric Laurentb62d0362021-10-26 17:40:18 +0200464 // - SPATIALIZED_SESSION if spatialized tracks on this audio session exist
Eric Laurent4c415062016-06-17 16:14:16 -0700465 virtual uint32_t hasAudioSession_l(audio_session_t sessionId) const = 0;
466 uint32_t hasAudioSession(audio_session_t sessionId) const {
467 Mutex::Autolock _l(mLock);
468 return hasAudioSession_l(sessionId);
469 }
470
Andy Hungc3d62f92019-03-14 13:38:51 -0700471 template <typename T>
472 uint32_t hasAudioSession_l(audio_session_t sessionId, const T& tracks) const {
473 uint32_t result = 0;
474 if (getEffectChain_l(sessionId) != 0) {
475 result = EFFECT_SESSION;
476 }
477 for (size_t i = 0; i < tracks.size(); ++i) {
478 const sp<TrackBase>& track = tracks[i];
479 if (sessionId == track->sessionId()
480 && !track->isInvalid() // not yet removed from tracks.
481 && !track->isTerminated()) {
482 result |= TRACK_SESSION;
483 if (track->isFastTrack()) {
484 result |= FAST_SESSION; // caution, only represents first track.
485 }
Eric Laurentb62d0362021-10-26 17:40:18 +0200486 if (track->canBeSpatialized()) {
487 result |= SPATIALIZED_SESSION; // caution, only first track.
488 }
Andy Hungc3d62f92019-03-14 13:38:51 -0700489 break;
490 }
491 }
492 return result;
493 }
494
Eric Laurent81784c32012-11-19 14:55:58 -0800495 // the value returned by default implementation is not important as the
496 // strategy is only meaningful for PlaybackThread which implements this method
Ytai Ben-Tsvi0a4904a2021-01-06 12:57:05 -0800497 virtual product_strategy_t getStrategyForSession_l(
498 audio_session_t sessionId __unused) {
499 return static_cast<product_strategy_t>(0);
500 }
Eric Laurent81784c32012-11-19 14:55:58 -0800501
Eric Laurent81784c32012-11-19 14:55:58 -0800502 // check if some effects must be suspended/restored when an effect is enabled
503 // or disabled
Eric Laurent6b446ce2019-12-13 10:56:31 -0800504 void checkSuspendOnEffectEnabled(bool enabled,
505 audio_session_t sessionId,
506 bool threadLocked);
Eric Laurent81784c32012-11-19 14:55:58 -0800507
508 virtual status_t setSyncEvent(const sp<SyncEvent>& event) = 0;
509 virtual bool isValidSyncEvent(const sp<SyncEvent>& event) const = 0;
510
Glenn Kastenb880f5e2014-05-07 08:43:45 -0700511 // Return a reference to a per-thread heap which can be used to allocate IMemory
512 // objects that will be read-only to client processes, read/write to mediaserver,
513 // and shared by all client processes of the thread.
514 // The heap is per-thread rather than common across all threads, because
515 // clients can't be trusted not to modify the offset of the IMemory they receive.
516 // If a thread does not have such a heap, this method returns 0.
517 virtual sp<MemoryDealer> readOnlyHeap() const { return 0; }
Eric Laurent81784c32012-11-19 14:55:58 -0800518
Glenn Kasten6181ffd2014-05-13 10:41:52 -0700519 virtual sp<IMemory> pipeMemory() const { return 0; }
520
Eric Laurent72e3f392015-05-20 14:43:50 -0700521 void systemReady();
522
Eric Laurent4c415062016-06-17 16:14:16 -0700523 // checkEffectCompatibility_l() must be called with ThreadBase::mLock held
524 virtual status_t checkEffectCompatibility_l(const effect_descriptor_t *desc,
525 audio_session_t sessionId) = 0;
526
Eric Laurent6acd1d42017-01-04 14:23:29 -0800527 void broadcast_l();
528
Andy Hungc8fddf32018-08-08 18:32:37 -0700529 virtual bool isTimestampCorrectionEnabled() const { return false; }
530
531 bool isMsdDevice() const { return mIsMsdDevice; }
532
Mikhail Naganov01dc5ca2019-03-29 10:12:12 -0700533 void dump(int fd, const Vector<String16>& args);
Andy Hungdc099c22018-09-18 13:46:39 -0700534
Andy Hungd0979812019-02-21 15:51:44 -0800535 // deliver stats to mediametrics.
536 void sendStatistics(bool force);
537
Eric Laurent81784c32012-11-19 14:55:58 -0800538 mutable Mutex mLock;
539
Eric Laurent6b446ce2019-12-13 10:56:31 -0800540 void onEffectEnable(const sp<EffectModule>& effect);
541 void onEffectDisable();
542
jiabineb3bda02020-06-30 14:07:03 -0700543 // invalidateTracksForAudioSession_l must be called with holding mLock.
544 virtual void invalidateTracksForAudioSession_l(audio_session_t sessionId __unused) const { }
545 // Invalidate all the tracks with the given audio session.
546 void invalidateTracksForAudioSession(audio_session_t sessionId) const {
547 Mutex::Autolock _l(mLock);
548 invalidateTracksForAudioSession_l(sessionId);
549 }
550
551 template <typename T>
552 void invalidateTracksForAudioSession_l(audio_session_t sessionId,
553 const T& tracks) const {
554 for (size_t i = 0; i < tracks.size(); ++i) {
555 const sp<TrackBase>& track = tracks[i];
556 if (sessionId == track->sessionId()) {
557 track->invalidate();
558 }
559 }
560 }
561
Jasmine Chaeaa10e42021-05-11 10:11:14 +0800562 virtual bool isStreamInitialized() = 0;
563
Eric Laurent81784c32012-11-19 14:55:58 -0800564protected:
565
566 // entry describing an effect being suspended in mSuspendedSessions keyed vector
567 class SuspendedSessionDesc : public RefBase {
568 public:
569 SuspendedSessionDesc() : mRefCount(0) {}
570
571 int mRefCount; // number of active suspend requests
572 effect_uuid_t mType; // effect type UUID
573 };
574
Andy Hungdae27702016-10-31 14:01:16 -0700575 void acquireWakeLock();
576 virtual void acquireWakeLock_l();
Eric Laurent81784c32012-11-19 14:55:58 -0800577 void releaseWakeLock();
578 void releaseWakeLock_l();
Andy Hungd01b0f12016-11-07 16:10:30 -0800579 void updateWakeLockUids_l(const SortedVector<uid_t> &uids);
Marco Nelissen462fd2f2013-01-14 14:12:05 -0800580 void getPowerManager_l();
Eric Laurentd8365c52017-07-16 15:27:05 -0700581 // suspend or restore effects of the specified type (or all if type is NULL)
582 // on a given session. The number of suspend requests is counted and restore
583 // occurs when all suspend requests are cancelled.
Eric Laurent81784c32012-11-19 14:55:58 -0800584 void setEffectSuspended_l(const effect_uuid_t *type,
585 bool suspend,
Glenn Kastend848eb42016-03-08 13:42:11 -0800586 audio_session_t sessionId);
Eric Laurentd8365c52017-07-16 15:27:05 -0700587 // updated mSuspendedSessions when an effect is suspended or restored
Eric Laurent81784c32012-11-19 14:55:58 -0800588 void updateSuspendedSessions_l(const effect_uuid_t *type,
589 bool suspend,
Glenn Kastend848eb42016-03-08 13:42:11 -0800590 audio_session_t sessionId);
Eric Laurent81784c32012-11-19 14:55:58 -0800591 // check if some effects must be suspended when an effect chain is added
592 void checkSuspendOnAddEffectChain_l(const sp<EffectChain>& chain);
593
Kevin Rocard069c2712018-03-29 19:09:14 -0700594 // sends the metadata of the active tracks to the HAL
595 virtual void updateMetadata_l() = 0;
596
Narayan Kamath014e7fa2013-10-14 15:03:38 +0100597 String16 getWakeLockTag();
598
Eric Laurent81784c32012-11-19 14:55:58 -0800599 virtual void preExit() { }
Andy Hung2ddee192015-12-18 17:34:44 -0800600 virtual void setMasterMono_l(bool mono __unused) { }
601 virtual bool requireMonoBlend() { return false; }
Eric Laurent81784c32012-11-19 14:55:58 -0800602
Andy Hung1c86ebe2018-05-29 20:29:08 -0700603 // called within the threadLoop to obtain timestamp from the HAL.
604 virtual status_t threadloop_getHalTimestamp_l(
605 ExtendedTimestamp *timestamp __unused) const {
606 return INVALID_OPERATION;
607 }
608
Eric Laurentd66d7a12021-07-13 13:35:32 +0200609 product_strategy_t getStrategyForStream(audio_stream_type_t stream) const;
610
Mikhail Naganov01dc5ca2019-03-29 10:12:12 -0700611 virtual void dumpInternals_l(int fd __unused, const Vector<String16>& args __unused)
612 { }
613 virtual void dumpTracks_l(int fd __unused, const Vector<String16>& args __unused) { }
614
615
Eric Laurent81784c32012-11-19 14:55:58 -0800616 friend class AudioFlinger; // for mEffectChains
617
618 const type_t mType;
619
620 // Used by parameters, config events, addTrack_l, exit
621 Condition mWaitWorkCV;
622
623 const sp<AudioFlinger> mAudioFlinger;
Andy Hungcf10d742020-04-28 15:38:24 -0700624 ThreadMetrics mThreadMetrics;
625 const bool mIsOut;
Glenn Kasten9b58f632013-07-16 11:37:48 -0700626
Glenn Kastendeca2ae2014-02-07 10:25:56 -0800627 // updated by PlaybackThread::readOutputParameters_l() or
628 // RecordThread::readInputParameters_l()
Eric Laurent81784c32012-11-19 14:55:58 -0800629 uint32_t mSampleRate;
630 size_t mFrameCount; // output HAL, direct output, record
Eric Laurent81784c32012-11-19 14:55:58 -0800631 audio_channel_mask_t mChannelMask;
Glenn Kastenf6ed4232013-07-16 11:16:27 -0700632 uint32_t mChannelCount;
Eric Laurent81784c32012-11-19 14:55:58 -0800633 size_t mFrameSize;
Glenn Kasten97b7b752014-09-28 13:04:24 -0700634 // not HAL frame size, this is for output sink (to pipe to fast mixer)
Andy Hung463be252014-07-10 16:56:07 -0700635 audio_format_t mFormat; // Source format for Recording and
636 // Sink format for Playback.
637 // Sink format may be different than
638 // HAL format if Fastmixer is used.
639 audio_format_t mHALFormat;
Glenn Kasten70949c42013-08-06 07:40:12 -0700640 size_t mBufferSize; // HAL buffer size for read() or write()
jiabinc52b1ff2019-10-31 17:20:42 -0700641 AudioDeviceTypeAddrVector mOutDeviceTypeAddrs; // output device types and addresses
642 AudioDeviceTypeAddr mInDeviceTypeAddr; // input device type and address
Eric Laurent10351942014-05-08 18:49:52 -0700643 Vector< sp<ConfigEvent> > mConfigEvents;
Eric Laurent72e3f392015-05-20 14:43:50 -0700644 Vector< sp<ConfigEvent> > mPendingConfigEvents; // events awaiting system ready
Eric Laurent81784c32012-11-19 14:55:58 -0800645
646 // These fields are written and read by thread itself without lock or barrier,
jiabinc52b1ff2019-10-31 17:20:42 -0700647 // and read by other threads without lock or barrier via standby(), outDeviceTypes()
648 // and inDeviceType().
Eric Laurent81784c32012-11-19 14:55:58 -0800649 // Because of the absence of a lock or barrier, any other thread that reads
650 // these fields must use the information in isolation, or be prepared to deal
651 // with possibility that it might be inconsistent with other information.
Glenn Kasten4944acb2013-08-19 08:39:20 -0700652 bool mStandby; // Whether thread is currently in standby.
jiabinc52b1ff2019-10-31 17:20:42 -0700653
Eric Laurent296fb132015-05-01 11:38:42 -0700654 struct audio_patch mPatch;
jiabinc52b1ff2019-10-31 17:20:42 -0700655
Glenn Kastenf59497b2015-01-26 16:35:47 -0800656 audio_source_t mAudioSource;
Eric Laurent81784c32012-11-19 14:55:58 -0800657
658 const audio_io_handle_t mId;
659 Vector< sp<EffectChain> > mEffectChains;
660
Glenn Kastend7dca052015-03-05 16:05:54 -0800661 static const int kThreadNameLength = 16; // prctl(PR_SET_NAME) limit
662 char mThreadName[kThreadNameLength]; // guaranteed NUL-terminated
Chris Ye6597d732020-02-28 22:38:25 -0800663 sp<os::IPowerManager> mPowerManager;
Eric Laurent81784c32012-11-19 14:55:58 -0800664 sp<IBinder> mWakeLockToken;
665 const sp<PMDeathRecipient> mDeathRecipient;
Glenn Kastend848eb42016-03-08 13:42:11 -0800666 // list of suspended effects per session and per type. The first (outer) vector is
667 // keyed by session ID, the second (inner) by type UUID timeLow field
Eric Laurentd8365c52017-07-16 15:27:05 -0700668 // Updated by updateSuspendedSessions_l() only.
Glenn Kastend848eb42016-03-08 13:42:11 -0800669 KeyedVector< audio_session_t, KeyedVector< int, sp<SuspendedSessionDesc> > >
Eric Laurent81784c32012-11-19 14:55:58 -0800670 mSuspendedSessions;
Sanna Catherine de Treville Wager2a6a9452017-07-28 11:02:01 -0700671 // TODO: add comment and adjust size as needed
Glenn Kastenab7d72f2013-02-27 09:05:28 -0800672 static const size_t kLogSize = 4 * 1024;
Glenn Kasten9e58b552013-01-18 15:09:48 -0800673 sp<NBLog::Writer> mNBLogWriter;
Eric Laurent72e3f392015-05-20 14:43:50 -0700674 bool mSystemReady;
Andy Hung818e7a32016-02-16 18:08:07 -0800675 ExtendedTimestamp mTimestamp;
Andy Hung2e2c0bb2018-06-11 19:13:11 -0700676 TimestampVerifier< // For timestamp statistics.
677 int64_t /* frame count */, int64_t /* time ns */> mTimestampVerifier;
Dean Wheatley12473e92021-03-18 23:00:55 +1100678 // DIRECT and OFFLOAD threads should reset frame count to zero on stop/flush
679 // TODO: add confirmation checks:
680 // 1) DIRECT threads and linear PCM format really resets to 0?
681 // 2) Is frame count really valid if not linear pcm?
682 // 3) Are all 64 bits of position returned, not just lowest 32 bits?
jiabinc52b1ff2019-10-31 17:20:42 -0700683 // Timestamp corrected device should be a single device.
684 audio_devices_t mTimestampCorrectedDevice = AUDIO_DEVICE_NONE;
Andy Hung446f4df2019-02-21 12:26:41 -0800685
686 // ThreadLoop statistics per iteration.
687 int64_t mLastIoBeginNs = -1;
688 int64_t mLastIoEndNs = -1;
689
690 // This should be read under ThreadBase lock (if not on the threadLoop thread).
691 audio_utils::Statistics<double> mIoJitterMs{0.995 /* alpha */};
692 audio_utils::Statistics<double> mProcessTimeMs{0.995 /* alpha */};
Andy Hunge6c37112019-02-26 17:38:10 -0800693 audio_utils::Statistics<double> mLatencyMs{0.995 /* alpha */};
Robert Wu06db0a32021-08-10 19:05:34 +0000694 audio_utils::Statistics<double> mMonopipePipeDepthStats{0.999 /* alpha */};
Andy Hung446f4df2019-02-21 12:26:41 -0800695
Andy Hungd0979812019-02-21 15:51:44 -0800696 // Save the last count when we delivered statistics to mediametrics.
697 int64_t mLastRecordedTimestampVerifierN = 0;
698 int64_t mLastRecordedTimeNs = 0; // BOOTTIME to include suspend.
699
Andy Hungc8fddf32018-08-08 18:32:37 -0700700 bool mIsMsdDevice = false;
Eric Laurent6acd1d42017-01-04 14:23:29 -0800701 // A condition that must be evaluated by the thread loop has changed and
702 // we must not wait for async write callback in the thread loop before evaluating it
703 bool mSignalPending;
Andy Hungdae27702016-10-31 14:01:16 -0700704
Andy Hung8946a282018-04-19 20:04:56 -0700705#ifdef TEE_SINK
706 NBAIO_Tee mTee;
707#endif
Andy Hungdae27702016-10-31 14:01:16 -0700708 // ActiveTracks is a sorted vector of track type T representing the
709 // active tracks of threadLoop() to be considered by the locked prepare portion.
710 // ActiveTracks should be accessed with the ThreadBase lock held.
711 //
712 // During processing and I/O, the threadLoop does not hold the lock;
713 // hence it does not directly use ActiveTracks. Care should be taken
714 // to hold local strong references or defer removal of tracks
715 // if the threadLoop may still be accessing those tracks due to mix, etc.
716 //
717 // This class updates power information appropriately.
718 //
719
720 template <typename T>
721 class ActiveTracks {
722 public:
Andy Hung2c6c3bb2017-06-16 14:01:45 -0700723 explicit ActiveTracks(SimpleLog *localLog = nullptr)
Andy Hungdae27702016-10-31 14:01:16 -0700724 : mActiveTracksGeneration(0)
725 , mLastActiveTracksGeneration(0)
Andy Hung2c6c3bb2017-06-16 14:01:45 -0700726 , mLocalLog(localLog)
Andy Hungdae27702016-10-31 14:01:16 -0700727 { }
728
729 ~ActiveTracks() {
730 ALOGW_IF(!mActiveTracks.isEmpty(),
731 "ActiveTracks should be empty in destructor");
732 }
733 // returns the last track added (even though it may have been
734 // subsequently removed from ActiveTracks).
735 //
736 // Used for DirectOutputThread to ensure a flush is called when transitioning
737 // to a new track (even though it may be on the same session).
738 // Used for OffloadThread to ensure that volume and mixer state is
739 // taken from the latest track added.
740 //
741 // The latest track is saved with a weak pointer to prevent keeping an
742 // otherwise useless track alive. Thus the function will return nullptr
743 // if the latest track has subsequently been removed and destroyed.
744 sp<T> getLatest() {
745 return mLatestActiveTrack.promote();
746 }
747
748 // SortedVector methods
749 ssize_t add(const sp<T> &track);
750 ssize_t remove(const sp<T> &track);
751 size_t size() const {
752 return mActiveTracks.size();
753 }
Eric Tan39ec8d62018-07-24 09:49:29 -0700754 bool isEmpty() const {
755 return mActiveTracks.isEmpty();
756 }
Andy Hungdae27702016-10-31 14:01:16 -0700757 ssize_t indexOf(const sp<T>& item) {
758 return mActiveTracks.indexOf(item);
759 }
760 sp<T> operator[](size_t index) const {
761 return mActiveTracks[index];
762 }
763 typename SortedVector<sp<T>>::iterator begin() {
764 return mActiveTracks.begin();
765 }
766 typename SortedVector<sp<T>>::iterator end() {
767 return mActiveTracks.end();
768 }
769
770 // Due to Binder recursion optimization, clear() and updatePowerState()
771 // cannot be called from a Binder thread because they may call back into
772 // the original calling process (system server) for BatteryNotifier
773 // (which requires a Java environment that may not be present).
774 // Hence, call clear() and updatePowerState() only from the
775 // ThreadBase thread.
776 void clear();
777 // periodically called in the threadLoop() to update power state uids.
778 void updatePowerState(sp<ThreadBase> thread, bool force = false);
779
Kevin Rocardc86a7f72018-04-03 09:00:09 -0700780 /** @return true if one or move active tracks was added or removed since the
Jasmine Chaeaa10e42021-05-11 10:11:14 +0800781 * last time this function was called or the vector was created.
782 * true if volume of one of active tracks was changed.
783 */
Kevin Rocard069c2712018-03-29 19:09:14 -0700784 bool readAndClearHasChanged();
785
Andy Hungdae27702016-10-31 14:01:16 -0700786 private:
Andy Hung2c6c3bb2017-06-16 14:01:45 -0700787 void logTrack(const char *funcName, const sp<T> &track) const;
788
Andy Hungd01b0f12016-11-07 16:10:30 -0800789 SortedVector<uid_t> getWakeLockUids() {
790 SortedVector<uid_t> wakeLockUids;
Andy Hungdae27702016-10-31 14:01:16 -0700791 for (const sp<T> &track : mActiveTracks) {
792 wakeLockUids.add(track->uid());
793 }
794 return wakeLockUids; // moved by underlying SharedBuffer
795 }
796
797 std::map<uid_t, std::pair<ssize_t /* previous */, ssize_t /* current */>>
798 mBatteryCounter;
799 SortedVector<sp<T>> mActiveTracks;
800 int mActiveTracksGeneration;
801 int mLastActiveTracksGeneration;
802 wp<T> mLatestActiveTrack; // latest track added to ActiveTracks
Andy Hung2c6c3bb2017-06-16 14:01:45 -0700803 SimpleLog * const mLocalLog;
Kevin Rocardc86a7f72018-04-03 09:00:09 -0700804 // If the vector has changed since last call to readAndClearHasChanged
Kevin Rocard069c2712018-03-29 19:09:14 -0700805 bool mHasChanged = false;
Andy Hungdae27702016-10-31 14:01:16 -0700806 };
Andy Hung293558a2017-03-21 12:19:20 -0700807
808 SimpleLog mLocalLog;
Mikhail Naganov01dc5ca2019-03-29 10:12:12 -0700809
810private:
811 void dumpBase_l(int fd, const Vector<String16>& args);
812 void dumpEffectChains_l(int fd, const Vector<String16>& args);
Eric Laurent81784c32012-11-19 14:55:58 -0800813};
814
Eric Laurent6acd1d42017-01-04 14:23:29 -0800815class VolumeInterface {
816 public:
817
818 virtual ~VolumeInterface() {}
819
820 virtual void setMasterVolume(float value) = 0;
821 virtual void setMasterMute(bool muted) = 0;
822 virtual void setStreamVolume(audio_stream_type_t stream, float value) = 0;
823 virtual void setStreamMute(audio_stream_type_t stream, bool muted) = 0;
824 virtual float streamVolume(audio_stream_type_t stream) const = 0;
825
826};
827
Eric Laurent81784c32012-11-19 14:55:58 -0800828// --- PlaybackThread ---
Eric Laurent6acd1d42017-01-04 14:23:29 -0800829class PlaybackThread : public ThreadBase, public StreamOutHalInterfaceCallback,
jiabinf6eb4c32020-02-25 14:06:25 -0800830 public VolumeInterface, public StreamOutHalInterfaceEventCallback {
Eric Laurent81784c32012-11-19 14:55:58 -0800831public:
832
833#include "PlaybackTracks.h"
834
835 enum mixer_state {
836 MIXER_IDLE, // no active tracks
837 MIXER_TRACKS_ENABLED, // at least one active track, but no track has any data ready
Eric Laurentbfb1b832013-01-07 09:53:42 -0800838 MIXER_TRACKS_READY, // at least one active track, and at least one track has data
839 MIXER_DRAIN_TRACK, // drain currently playing track
840 MIXER_DRAIN_ALL, // fully drain the hardware
Eric Laurent81784c32012-11-19 14:55:58 -0800841 // standby mode does not have an enum value
842 // suspend by audio policy manager is orthogonal to mixer state
843 };
844
Eric Laurente93cc032016-05-05 10:15:10 -0700845 // retry count before removing active track in case of underrun on offloaded thread:
846 // we need to make sure that AudioTrack client has enough time to send large buffers
847 //FIXME may be more appropriate if expressed in time units. Need to revise how underrun is
848 // handled for offloaded tracks
849 static const int8_t kMaxTrackRetriesOffload = 20;
850 static const int8_t kMaxTrackStartupRetriesOffload = 100;
851 static const int8_t kMaxTrackStopRetriesOffload = 2;
Andy Hung8ed196a2018-01-05 13:21:11 -0800852 static constexpr uint32_t kMaxTracksPerUid = 40;
Andy Hung1bc088a2018-02-09 15:57:31 -0800853 static constexpr size_t kMaxTracks = 256;
Eric Laurente93cc032016-05-05 10:15:10 -0700854
rago1bb90822017-05-02 18:31:48 -0700855 // Maximum delay (in nanoseconds) for upcoming buffers in suspend mode, otherwise
856 // if delay is greater, the estimated time for timeLoopNextNs is reset.
857 // This allows for catch-up to be done for small delays, while resetting the estimate
858 // for initial conditions or large delays.
859 static const nsecs_t kMaxNextBufferDelayNs = 100000000;
860
Eric Laurent81784c32012-11-19 14:55:58 -0800861 PlaybackThread(const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output,
Eric Laurentf1f22e72021-07-13 14:04:14 +0200862 audio_io_handle_t id, type_t type, bool systemReady,
863 audio_config_base_t *mixerConfig = nullptr);
Eric Laurent81784c32012-11-19 14:55:58 -0800864 virtual ~PlaybackThread();
865
Eric Laurent81784c32012-11-19 14:55:58 -0800866 // Thread virtuals
Eric Laurent81784c32012-11-19 14:55:58 -0800867 virtual bool threadLoop();
868
869 // RefBase
870 virtual void onFirstRef();
871
Eric Laurent4c415062016-06-17 16:14:16 -0700872 virtual status_t checkEffectCompatibility_l(const effect_descriptor_t *desc,
873 audio_session_t sessionId);
874
Eric Laurent81784c32012-11-19 14:55:58 -0800875protected:
876 // Code snippets that were lifted up out of threadLoop()
877 virtual void threadLoop_mix() = 0;
878 virtual void threadLoop_sleepTime() = 0;
Eric Laurentbfb1b832013-01-07 09:53:42 -0800879 virtual ssize_t threadLoop_write();
880 virtual void threadLoop_drain();
Eric Laurent81784c32012-11-19 14:55:58 -0800881 virtual void threadLoop_standby();
Eric Laurentbfb1b832013-01-07 09:53:42 -0800882 virtual void threadLoop_exit();
Eric Laurent81784c32012-11-19 14:55:58 -0800883 virtual void threadLoop_removeTracks(const Vector< sp<Track> >& tracksToRemove);
884
885 // prepareTracks_l reads and writes mActiveTracks, and returns
886 // the pending set of tracks to remove via Vector 'tracksToRemove'. The caller
887 // is responsible for clearing or destroying this Vector later on, when it
888 // is safe to do so. That will drop the final ref count and destroy the tracks.
889 virtual mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove) = 0;
Eric Laurentbfb1b832013-01-07 09:53:42 -0800890 void removeTracks_l(const Vector< sp<Track> >& tracksToRemove);
Eric Laurenteab90452019-06-24 15:17:46 -0700891 status_t handleVoipVolume_l(float *volume);
Eric Laurentbfb1b832013-01-07 09:53:42 -0800892
Mikhail Naganov1dc98672016-08-18 17:50:29 -0700893 // StreamOutHalInterfaceCallback implementation
894 virtual void onWriteReady();
895 virtual void onDrainReady();
896 virtual void onError();
Eric Laurentbfb1b832013-01-07 09:53:42 -0800897
Mikhail Naganov1dc98672016-08-18 17:50:29 -0700898 void resetWriteBlocked(uint32_t sequence);
899 void resetDraining(uint32_t sequence);
Eric Laurentbfb1b832013-01-07 09:53:42 -0800900
901 virtual bool waitingAsyncCallback();
902 virtual bool waitingAsyncCallback_l();
903 virtual bool shouldStandby_l();
Haynes Mathew George4c6a4332014-01-15 12:31:39 -0800904 virtual void onAddNewTrack_l();
Haynes Mathew George4527b9e2016-07-07 19:54:17 -0700905 void onAsyncError(); // error reported by AsyncCallbackThread
Eric Laurent81784c32012-11-19 14:55:58 -0800906
jiabinf6eb4c32020-02-25 14:06:25 -0800907 // StreamHalInterfaceCodecFormatCallback implementation
908 void onCodecFormatChanged(
909 const std::basic_string<uint8_t>& metadataBs) override;
910
Eric Laurent81784c32012-11-19 14:55:58 -0800911 // ThreadBase virtuals
912 virtual void preExit();
913
Eric Laurent64667972016-03-30 18:19:46 -0700914 virtual bool keepWakeLock() const { return true; }
Andy Hungdae27702016-10-31 14:01:16 -0700915 virtual void acquireWakeLock_l() {
916 ThreadBase::acquireWakeLock_l();
917 mActiveTracks.updatePowerState(this, true /* force */);
918 }
Eric Laurent64667972016-03-30 18:19:46 -0700919
Eric Laurentb3f315a2021-07-13 15:09:05 +0200920 virtual void checkOutputStageEffects() {}
921
Mikhail Naganov01dc5ca2019-03-29 10:12:12 -0700922 void dumpInternals_l(int fd, const Vector<String16>& args) override;
923 void dumpTracks_l(int fd, const Vector<String16>& args) override;
924
Eric Laurent81784c32012-11-19 14:55:58 -0800925public:
926
927 virtual status_t initCheck() const { return (mOutput == NULL) ? NO_INIT : NO_ERROR; }
928
929 // return estimated latency in milliseconds, as reported by HAL
930 uint32_t latency() const;
931 // same, but lock must already be held
Eric Laurent6b446ce2019-12-13 10:56:31 -0800932 uint32_t latency_l() const override;
Eric Laurent81784c32012-11-19 14:55:58 -0800933
Eric Laurent6acd1d42017-01-04 14:23:29 -0800934 // VolumeInterface
935 virtual void setMasterVolume(float value);
Richard Folke Tullberg3fae0372017-01-13 09:04:25 +0100936 virtual void setMasterBalance(float balance);
Eric Laurent6acd1d42017-01-04 14:23:29 -0800937 virtual void setMasterMute(bool muted);
938 virtual void setStreamVolume(audio_stream_type_t stream, float value);
939 virtual void setStreamMute(audio_stream_type_t stream, bool muted);
940 virtual float streamVolume(audio_stream_type_t stream) const;
Eric Laurent81784c32012-11-19 14:55:58 -0800941
Eric Laurent6b446ce2019-12-13 10:56:31 -0800942 void setVolumeForOutput_l(float left, float right) const override;
Tomoharu Kasahara1990bd42014-12-12 14:04:11 +0900943
Eric Laurent81784c32012-11-19 14:55:58 -0800944 sp<Track> createTrack_l(
945 const sp<AudioFlinger::Client>& client,
946 audio_stream_type_t streamType,
Kevin Rocard1f564ac2018-03-29 13:53:10 -0700947 const audio_attributes_t& attr,
Eric Laurent21da6472017-11-09 16:29:26 -0800948 uint32_t *sampleRate,
Eric Laurent81784c32012-11-19 14:55:58 -0800949 audio_format_t format,
950 audio_channel_mask_t channelMask,
Glenn Kasten74935e42013-12-19 08:56:45 -0800951 size_t *pFrameCount,
Eric Laurent21da6472017-11-09 16:29:26 -0800952 size_t *pNotificationFrameCount,
953 uint32_t notificationsPerBuffer,
954 float speed,
Eric Laurent81784c32012-11-19 14:55:58 -0800955 const sp<IMemory>& sharedBuffer,
Glenn Kastend848eb42016-03-08 13:42:11 -0800956 audio_session_t sessionId,
Eric Laurent05067782016-06-01 18:27:28 -0700957 audio_output_flags_t *flags,
Eric Laurent09f1ed22019-04-24 17:45:17 -0700958 pid_t creatorPid,
Svet Ganov33761132021-05-13 22:51:08 +0000959 const AttributionSourceState& attributionSource,
Eric Laurent81784c32012-11-19 14:55:58 -0800960 pid_t tid,
Eric Laurent20b9ef02016-12-05 11:03:16 -0800961 status_t *status /*non-NULL*/,
jiabinf6eb4c32020-02-25 14:06:25 -0800962 audio_port_handle_t portId,
Philip P. Moltmannbda45752020-07-17 16:41:18 -0700963 const sp<media::IAudioTrackCallback>& callback);
Eric Laurent81784c32012-11-19 14:55:58 -0800964
965 AudioStreamOut* getOutput() const;
966 AudioStreamOut* clearOutput();
Mikhail Naganov1dc98672016-08-18 17:50:29 -0700967 virtual sp<StreamHalInterface> stream() const;
Eric Laurent81784c32012-11-19 14:55:58 -0800968
969 // a very large number of suspend() will eventually wraparound, but unlikely
970 void suspend() { (void) android_atomic_inc(&mSuspended); }
971 void restore()
972 {
973 // if restore() is done without suspend(), get back into
974 // range so that the next suspend() will operate correctly
975 if (android_atomic_dec(&mSuspended) <= 0) {
976 android_atomic_release_store(0, &mSuspended);
977 }
978 }
979 bool isSuspended() const
980 { return android_atomic_acquire_load(&mSuspended) > 0; }
981
982 virtual String8 getParameters(const String8& keys);
Mikhail Naganov88536df2021-07-26 17:30:29 -0700983 virtual void ioConfigChanged(audio_io_config_event_t event, pid_t pid = 0,
Eric Laurent09f1ed22019-04-24 17:45:17 -0700984 audio_port_handle_t portId = AUDIO_PORT_HANDLE_NONE);
Kévin PETIT377b2ec2014-02-03 12:35:36 +0000985 status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames);
Andy Hung010a1a12014-03-13 13:57:33 -0700986 // Consider also removing and passing an explicit mMainBuffer initialization
987 // parameter to AF::PlaybackThread::Track::Track().
rago94a1ee82017-07-21 15:11:02 -0700988 effect_buffer_t *sinkBuffer() const {
989 return reinterpret_cast<effect_buffer_t *>(mSinkBuffer); };
Eric Laurent81784c32012-11-19 14:55:58 -0800990
991 virtual void detachAuxEffect_l(int effectId);
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -0700992 status_t attachAuxEffect(const sp<AudioFlinger::PlaybackThread::Track>& track,
Eric Laurent81784c32012-11-19 14:55:58 -0800993 int EffectId);
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -0700994 status_t attachAuxEffect_l(const sp<AudioFlinger::PlaybackThread::Track>& track,
Eric Laurent81784c32012-11-19 14:55:58 -0800995 int EffectId);
996
997 virtual status_t addEffectChain_l(const sp<EffectChain>& chain);
998 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain);
Andy Hungc3d62f92019-03-14 13:38:51 -0700999 uint32_t hasAudioSession_l(audio_session_t sessionId) const override {
1000 return ThreadBase::hasAudioSession_l(sessionId, mTracks);
1001 }
Ytai Ben-Tsvi0a4904a2021-01-06 12:57:05 -08001002 virtual product_strategy_t getStrategyForSession_l(audio_session_t sessionId);
Eric Laurent81784c32012-11-19 14:55:58 -08001003
1004
1005 virtual status_t setSyncEvent(const sp<SyncEvent>& event);
1006 virtual bool isValidSyncEvent(const sp<SyncEvent>& event) const;
Glenn Kastenfb1fdc92013-07-10 17:03:19 -07001007
1008 // called with AudioFlinger lock held
Eric Laurent13084622016-05-17 10:51:49 -07001009 bool invalidateTracks_l(audio_stream_type_t streamType);
Haynes Mathew George05317d22016-05-03 16:34:26 -07001010 virtual void invalidateTracks(audio_stream_type_t streamType);
Eric Laurent81784c32012-11-19 14:55:58 -08001011
Glenn Kasten9b58f632013-07-16 11:37:48 -07001012 virtual size_t frameCount() const { return mNormalFrameCount; }
1013
Eric Laurentf1f22e72021-07-13 14:04:14 +02001014 audio_channel_mask_t mixerChannelMask() const override {
1015 return mMixerChannelMask;
1016 }
1017
Eric Laurent83b88082014-06-20 18:31:16 -07001018 status_t getTimestamp_l(AudioTimestamp& timestamp);
1019
1020 void addPatchTrack(const sp<PatchTrack>& track);
1021 void deletePatchTrack(const sp<PatchTrack>& track);
1022
Mikhail Naganovdc769682018-05-04 15:34:08 -07001023 virtual void toAudioPortConfig(struct audio_port_config *config);
Eric Laurentaccc1472013-09-20 09:36:34 -07001024
Andy Hung10cbff12017-02-21 17:30:14 -08001025 // Return the asynchronous signal wait time.
1026 virtual int64_t computeWaitTimeNs_l() const { return INT64_MAX; }
Andy Hung1bc088a2018-02-09 15:57:31 -08001027 // returns true if the track is allowed to be added to the thread.
1028 virtual bool isTrackAllowed_l(
1029 audio_channel_mask_t channelMask __unused,
1030 audio_format_t format __unused,
1031 audio_session_t sessionId __unused,
1032 uid_t uid) const {
1033 return trackCountForUid_l(uid) < PlaybackThread::kMaxTracksPerUid
1034 && mTracks.size() < PlaybackThread::kMaxTracks;
1035 }
1036
Andy Hungc8fddf32018-08-08 18:32:37 -07001037 bool isTimestampCorrectionEnabled() const override {
jiabinc52b1ff2019-10-31 17:20:42 -07001038 return audio_is_output_devices(mTimestampCorrectedDevice)
1039 && outDeviceTypes().count(mTimestampCorrectedDevice) != 0;
Andy Hungc8fddf32018-08-08 18:32:37 -07001040 }
jiabinc52b1ff2019-10-31 17:20:42 -07001041
Jasmine Chaeaa10e42021-05-11 10:11:14 +08001042 virtual bool isStreamInitialized() {
1043 return !(mOutput == nullptr || mOutput->stream == nullptr);
1044 }
1045
jiabineb3bda02020-06-30 14:07:03 -07001046 audio_channel_mask_t hapticChannelMask() const override {
1047 return mHapticChannelMask;
1048 }
1049 bool supportsHapticPlayback() const {
1050 return (mHapticChannelMask & AUDIO_CHANNEL_HAPTIC_ALL) != AUDIO_CHANNEL_NONE;
1051 }
1052
Eric Laurent74c38dc2020-12-23 18:19:44 +01001053 void setDownStreamPatch(const struct audio_patch *patch) {
1054 Mutex::Autolock _l(mLock);
1055 mDownStreamPatch = *patch;
1056 }
1057
jiabinf042b9b2021-05-07 23:46:28 +00001058 PlaybackThread::Track* getTrackById_l(audio_port_handle_t trackId);
1059
Eric Laurentb3f315a2021-07-13 15:09:05 +02001060 bool hasMixer() const {
Eric Laurent1c5e2e32021-08-18 18:50:28 +02001061 return mType == MIXER || mType == DUPLICATING || mType == SPATIALIZER;
Eric Laurentb3f315a2021-07-13 15:09:05 +02001062 }
Eric Laurent81784c32012-11-19 14:55:58 -08001063protected:
Glenn Kastendeca2ae2014-02-07 10:25:56 -08001064 // updated by readOutputParameters_l()
Glenn Kasten9b58f632013-07-16 11:37:48 -07001065 size_t mNormalFrameCount; // normal mixer and effects
1066
Andy Hung08fb1742015-05-31 23:22:10 -07001067 bool mThreadThrottle; // throttle the thread processing
Andy Hung40eb1a12015-06-18 13:42:02 -07001068 uint32_t mThreadThrottleTimeMs; // throttle time for MIXER threads
1069 uint32_t mThreadThrottleEndMs; // notify once per throttling
Andy Hung08fb1742015-05-31 23:22:10 -07001070 uint32_t mHalfBufferMs; // half the buffer size in milliseconds
1071
Andy Hung010a1a12014-03-13 13:57:33 -07001072 void* mSinkBuffer; // frame size aligned sink buffer
Eric Laurent81784c32012-11-19 14:55:58 -08001073
Andy Hung98ef9782014-03-04 14:46:50 -08001074 // TODO:
1075 // Rearrange the buffer info into a struct/class with
1076 // clear, copy, construction, destruction methods.
1077 //
1078 // mSinkBuffer also has associated with it:
1079 //
1080 // mSinkBufferSize: Sink Buffer Size
1081 // mFormat: Sink Buffer Format
1082
Andy Hung69aed5f2014-02-25 17:24:40 -08001083 // Mixer Buffer (mMixerBuffer*)
1084 //
1085 // In the case of floating point or multichannel data, which is not in the
1086 // sink format, it is required to accumulate in a higher precision or greater channel count
1087 // buffer before downmixing or data conversion to the sink buffer.
1088
1089 // Set to "true" to enable the Mixer Buffer otherwise mixer output goes to sink buffer.
1090 bool mMixerBufferEnabled;
1091
1092 // Storage, 32 byte aligned (may make this alignment a requirement later).
1093 // Due to constraints on mNormalFrameCount, the buffer size is a multiple of 16 frames.
1094 void* mMixerBuffer;
1095
1096 // Size of mMixerBuffer in bytes: mNormalFrameCount * #channels * sampsize.
1097 size_t mMixerBufferSize;
1098
1099 // The audio format of mMixerBuffer. Set to AUDIO_FORMAT_PCM_(FLOAT|16_BIT) only.
1100 audio_format_t mMixerBufferFormat;
1101
1102 // An internal flag set to true by MixerThread::prepareTracks_l()
1103 // when mMixerBuffer contains valid data after mixing.
1104 bool mMixerBufferValid;
1105
Andy Hung98ef9782014-03-04 14:46:50 -08001106 // Effects Buffer (mEffectsBuffer*)
1107 //
1108 // In the case of effects data, which is not in the sink format,
1109 // it is required to accumulate in a different buffer before data conversion
1110 // to the sink buffer.
1111
1112 // Set to "true" to enable the Effects Buffer otherwise effects output goes to sink buffer.
1113 bool mEffectBufferEnabled;
1114
1115 // Storage, 32 byte aligned (may make this alignment a requirement later).
1116 // Due to constraints on mNormalFrameCount, the buffer size is a multiple of 16 frames.
1117 void* mEffectBuffer;
1118
1119 // Size of mEffectsBuffer in bytes: mNormalFrameCount * #channels * sampsize.
1120 size_t mEffectBufferSize;
1121
1122 // The audio format of mEffectsBuffer. Set to AUDIO_FORMAT_PCM_16_BIT only.
1123 audio_format_t mEffectBufferFormat;
1124
1125 // An internal flag set to true by MixerThread::prepareTracks_l()
1126 // when mEffectsBuffer contains valid data after mixing.
1127 //
1128 // When this is set, all mixer data is routed into the effects buffer
1129 // for any processing (including output processing).
1130 bool mEffectBufferValid;
1131
Eric Laurentb62d0362021-10-26 17:40:18 +02001132 // Frame size aligned buffer used as input and output to all post processing effects
1133 // except the Spatializer in a SPATIALIZER thread. Non spatialized tracks are mixed into
1134 // this buffer so that post processing effects can be applied.
1135 void* mPostSpatializerBuffer = nullptr;
1136
1137 // Size of mPostSpatializerBuffer in bytes
1138 size_t mPostSpatializerBufferSize;
Eric Laurent39095982021-08-24 18:29:27 +02001139
1140
Eric Laurent81784c32012-11-19 14:55:58 -08001141 // suspend count, > 0 means suspended. While suspended, the thread continues to pull from
1142 // tracks and mix, but doesn't write to HAL. A2DP and SCO HAL implementations can't handle
1143 // concurrent use of both of them, so Audio Policy Service suspends one of the threads to
1144 // workaround that restriction.
1145 // 'volatile' means accessed via atomic operations and no lock.
1146 volatile int32_t mSuspended;
1147
Andy Hung818e7a32016-02-16 18:08:07 -08001148 int64_t mBytesWritten;
Andy Hungc54b1ff2016-02-23 14:07:07 -08001149 int64_t mFramesWritten; // not reset on standby
Dean Wheatley12473e92021-03-18 23:00:55 +11001150 int64_t mLastFramesWritten = -1; // track changes in timestamp
1151 // server frames written.
Andy Hung238fa3d2016-07-28 10:53:22 -07001152 int64_t mSuspendedFrames; // not reset on standby
jiabin245cdd92018-12-07 17:55:15 -08001153
1154 // mHapticChannelMask and mHapticChannelCount will only be valid when the thread support
1155 // haptic playback.
1156 audio_channel_mask_t mHapticChannelMask = AUDIO_CHANNEL_NONE;
1157 uint32_t mHapticChannelCount = 0;
Eric Laurentf1f22e72021-07-13 14:04:14 +02001158
1159 audio_channel_mask_t mMixerChannelMask = AUDIO_CHANNEL_NONE;
1160
Eric Laurent81784c32012-11-19 14:55:58 -08001161private:
1162 // mMasterMute is in both PlaybackThread and in AudioFlinger. When a
1163 // PlaybackThread needs to find out if master-muted, it checks it's local
1164 // copy rather than the one in AudioFlinger. This optimization saves a lock.
1165 bool mMasterMute;
1166 void setMasterMute_l(bool muted) { mMasterMute = muted; }
Dean Wheatley12473e92021-03-18 23:00:55 +11001167
1168 auto discontinuityForStandbyOrFlush() const { // call on threadLoop or with lock.
1169 return ((mType == DIRECT && !audio_is_linear_pcm(mFormat))
1170 || mType == OFFLOAD)
1171 ? mTimestampVerifier.DISCONTINUITY_MODE_ZERO
1172 : mTimestampVerifier.DISCONTINUITY_MODE_CONTINUOUS;
1173 }
1174
Eric Laurent81784c32012-11-19 14:55:58 -08001175protected:
Andy Hungdae27702016-10-31 14:01:16 -07001176 ActiveTracks<Track> mActiveTracks;
Eric Laurent81784c32012-11-19 14:55:58 -08001177
Eric Laurent81784c32012-11-19 14:55:58 -08001178 // Time to sleep between cycles when:
1179 virtual uint32_t activeSleepTimeUs() const; // mixer state MIXER_TRACKS_ENABLED
1180 virtual uint32_t idleSleepTimeUs() const = 0; // mixer state MIXER_IDLE
1181 virtual uint32_t suspendSleepTimeUs() const = 0; // audio policy manager suspended us
1182 // No sleep when mixer state == MIXER_TRACKS_READY; relies on audio HAL stream->write()
1183 // No sleep in standby mode; waits on a condition
1184
1185 // Code snippets that are temporarily lifted up out of threadLoop() until the merge
1186 void checkSilentMode_l();
1187
1188 // Non-trivial for DUPLICATING only
1189 virtual void saveOutputTracks() { }
1190 virtual void clearOutputTracks() { }
1191
1192 // Cache various calculated values, at threadLoop() entry and after a parameter change
1193 virtual void cacheParameters_l();
Eric Laurentb3f315a2021-07-13 15:09:05 +02001194 void setCheckOutputStageEffects() override {
1195 mCheckOutputStageEffects.store(true);
1196 }
Eric Laurent81784c32012-11-19 14:55:58 -08001197
1198 virtual uint32_t correctLatency_l(uint32_t latency) const;
1199
Eric Laurent1c333e22014-05-20 10:48:17 -07001200 virtual status_t createAudioPatch_l(const struct audio_patch *patch,
1201 audio_patch_handle_t *handle);
1202 virtual status_t releaseAudioPatch_l(const audio_patch_handle_t handle);
1203
Phil Burk6fc2a7c2015-04-30 16:08:10 -07001204 bool usesHwAvSync() const { return (mType == DIRECT) && (mOutput != NULL)
1205 && mHwSupportsPause
1206 && (mOutput->flags & AUDIO_OUTPUT_FLAG_HW_AV_SYNC); }
Eric Laurent0f7b5f22014-12-19 10:43:21 -08001207
Andy Hung1bc088a2018-02-09 15:57:31 -08001208 uint32_t trackCountForUid_l(uid_t uid) const;
Eric Laurentad7dd962016-09-22 12:38:37 -07001209
jiabineb3bda02020-06-30 14:07:03 -07001210 void invalidateTracksForAudioSession_l(
1211 audio_session_t sessionId) const override {
1212 ThreadBase::invalidateTracksForAudioSession_l(sessionId, mTracks);
1213 }
1214
Eric Laurent81784c32012-11-19 14:55:58 -08001215private:
1216
1217 friend class AudioFlinger; // for numerous
1218
Mikhail Naganovbf493082017-04-17 17:37:12 -07001219 DISALLOW_COPY_AND_ASSIGN(PlaybackThread);
Eric Laurent81784c32012-11-19 14:55:58 -08001220
1221 status_t addTrack_l(const sp<Track>& track);
Eric Laurentbfb1b832013-01-07 09:53:42 -08001222 bool destroyTrack_l(const sp<Track>& track);
Eric Laurent81784c32012-11-19 14:55:58 -08001223 void removeTrack_l(const sp<Track>& track);
1224
Glenn Kastendeca2ae2014-02-07 10:25:56 -08001225 void readOutputParameters_l();
Kevin Rocardc86a7f72018-04-03 09:00:09 -07001226 void updateMetadata_l() final;
1227 virtual void sendMetadataToBackend_l(const StreamOutHalInterface::SourceMetadata& metadata);
Eric Laurent81784c32012-11-19 14:55:58 -08001228
Dean Wheatley12473e92021-03-18 23:00:55 +11001229 void collectTimestamps_l();
1230
Andy Hungc0691382018-09-12 18:01:57 -07001231 // The Tracks class manages tracks added and removed from the Thread.
Andy Hung1bc088a2018-02-09 15:57:31 -08001232 template <typename T>
1233 class Tracks {
1234 public:
Andy Hungc0691382018-09-12 18:01:57 -07001235 Tracks(bool saveDeletedTrackIds) :
1236 mSaveDeletedTrackIds(saveDeletedTrackIds) { }
Andy Hung1bc088a2018-02-09 15:57:31 -08001237
1238 // SortedVector methods
Andy Hungc0691382018-09-12 18:01:57 -07001239 ssize_t add(const sp<T> &track) {
1240 const ssize_t index = mTracks.add(track);
1241 LOG_ALWAYS_FATAL_IF(index < 0, "cannot add track");
1242 return index;
1243 }
Andy Hung1bc088a2018-02-09 15:57:31 -08001244 ssize_t remove(const sp<T> &track);
1245 size_t size() const {
1246 return mTracks.size();
1247 }
1248 bool isEmpty() const {
1249 return mTracks.isEmpty();
1250 }
1251 ssize_t indexOf(const sp<T> &item) {
1252 return mTracks.indexOf(item);
1253 }
1254 sp<T> operator[](size_t index) const {
1255 return mTracks[index];
1256 }
1257 typename SortedVector<sp<T>>::iterator begin() {
1258 return mTracks.begin();
1259 }
1260 typename SortedVector<sp<T>>::iterator end() {
1261 return mTracks.end();
1262 }
1263
Andy Hungc0691382018-09-12 18:01:57 -07001264 size_t processDeletedTrackIds(std::function<void(int)> f) {
1265 for (const int trackId : mDeletedTrackIds) {
1266 f(trackId);
Andy Hung1bc088a2018-02-09 15:57:31 -08001267 }
Andy Hungc0691382018-09-12 18:01:57 -07001268 return mDeletedTrackIds.size();
Andy Hung1bc088a2018-02-09 15:57:31 -08001269 }
1270
Andy Hungc0691382018-09-12 18:01:57 -07001271 void clearDeletedTrackIds() { mDeletedTrackIds.clear(); }
Andy Hung1bc088a2018-02-09 15:57:31 -08001272
1273 private:
Andy Hungc0691382018-09-12 18:01:57 -07001274 // Tracks pending deletion for MIXER type threads
1275 const bool mSaveDeletedTrackIds; // true to enable tracking
1276 std::set<int> mDeletedTrackIds;
Andy Hung1bc088a2018-02-09 15:57:31 -08001277
1278 SortedVector<sp<T>> mTracks; // wrapped SortedVector.
1279 };
1280
1281 Tracks<Track> mTracks;
1282
Eric Laurent223fd5c2014-11-11 13:43:36 -08001283 stream_type_t mStreamTypes[AUDIO_STREAM_CNT];
Eric Laurent81784c32012-11-19 14:55:58 -08001284 AudioStreamOut *mOutput;
1285
1286 float mMasterVolume;
Richard Folke Tullberg3fae0372017-01-13 09:04:25 +01001287 std::atomic<float> mMasterBalance{};
1288 audio_utils::Balance mBalance;
Eric Laurent81784c32012-11-19 14:55:58 -08001289 int mNumWrites;
1290 int mNumDelayedWrites;
1291 bool mInWrite;
1292
1293 // FIXME rename these former local variables of threadLoop to standard "m" names
Eric Laurentad9cb8b2015-05-26 16:38:19 -07001294 nsecs_t mStandbyTimeNs;
Andy Hung25c2dac2014-02-27 14:56:00 -08001295 size_t mSinkBufferSize;
Eric Laurent81784c32012-11-19 14:55:58 -08001296
1297 // cached copies of activeSleepTimeUs() and idleSleepTimeUs() made by cacheParameters_l()
Eric Laurentad9cb8b2015-05-26 16:38:19 -07001298 uint32_t mActiveSleepTimeUs;
1299 uint32_t mIdleSleepTimeUs;
Eric Laurent81784c32012-11-19 14:55:58 -08001300
Eric Laurentad9cb8b2015-05-26 16:38:19 -07001301 uint32_t mSleepTimeUs;
Eric Laurent81784c32012-11-19 14:55:58 -08001302
1303 // mixer status returned by prepareTracks_l()
1304 mixer_state mMixerStatus; // current cycle
1305 // previous cycle when in prepareTracks_l()
1306 mixer_state mMixerStatusIgnoringFastTracks;
1307 // FIXME or a separate ready state per track
1308
1309 // FIXME move these declarations into the specific sub-class that needs them
1310 // MIXER only
1311 uint32_t sleepTimeShift;
1312
1313 // same as AudioFlinger::mStandbyTimeInNsecs except for DIRECT which uses a shorter value
Eric Laurentad9cb8b2015-05-26 16:38:19 -07001314 nsecs_t mStandbyDelayNs;
Eric Laurent81784c32012-11-19 14:55:58 -08001315
1316 // MIXER only
1317 nsecs_t maxPeriod;
1318
1319 // DUPLICATING only
1320 uint32_t writeFrames;
1321
Eric Laurentbfb1b832013-01-07 09:53:42 -08001322 size_t mBytesRemaining;
1323 size_t mCurrentWriteLength;
1324 bool mUseAsyncWrite;
Eric Laurent3b4529e2013-09-05 18:09:19 -07001325 // mWriteAckSequence contains current write sequence on bits 31-1. The write sequence is
1326 // incremented each time a write(), a flush() or a standby() occurs.
1327 // Bit 0 is set when a write blocks and indicates a callback is expected.
1328 // Bit 0 is reset by the async callback thread calling resetWriteBlocked(). Out of sequence
1329 // callbacks are ignored.
1330 uint32_t mWriteAckSequence;
1331 // mDrainSequence contains current drain sequence on bits 31-1. The drain sequence is
1332 // incremented each time a drain is requested or a flush() or standby() occurs.
1333 // Bit 0 is set when the drain() command is called at the HAL and indicates a callback is
1334 // expected.
1335 // Bit 0 is reset by the async callback thread calling resetDraining(). Out of sequence
1336 // callbacks are ignored.
1337 uint32_t mDrainSequence;
Eric Laurentbfb1b832013-01-07 09:53:42 -08001338 sp<AsyncCallbackThread> mCallbackThread;
1339
jiabinf6eb4c32020-02-25 14:06:25 -08001340 Mutex mAudioTrackCbLock;
1341 // Record of IAudioTrackCallback
jiabin18a4b1c2020-09-17 11:40:42 -07001342 std::map<sp<Track>, sp<media::IAudioTrackCallback>> mAudioTrackCallbacks;
jiabinf6eb4c32020-02-25 14:06:25 -08001343
Eric Laurent81784c32012-11-19 14:55:58 -08001344private:
1345 // The HAL output sink is treated as non-blocking, but current implementation is blocking
1346 sp<NBAIO_Sink> mOutputSink;
1347 // If a fast mixer is present, the blocking pipe sink, otherwise clear
1348 sp<NBAIO_Sink> mPipeSink;
1349 // The current sink for the normal mixer to write it's (sub)mix, mOutputSink or mPipeSink
1350 sp<NBAIO_Sink> mNormalSink;
Eric Laurent81784c32012-11-19 14:55:58 -08001351 uint32_t mScreenState; // cached copy of gScreenState
Sanna Catherine de Treville Wager2a6a9452017-07-28 11:02:01 -07001352 // TODO: add comment and adjust size as needed
Glenn Kasteneef598c2017-04-03 14:41:13 -07001353 static const size_t kFastMixerLogSize = 8 * 1024;
Glenn Kasten9e58b552013-01-18 15:09:48 -08001354 sp<NBLog::Writer> mFastMixerNBLogWriter;
Andy Hung2148bf02016-11-28 19:01:02 -08001355
Dean Wheatley30d28422018-11-06 10:27:40 +11001356 // Downstream patch latency, available if mDownstreamLatencyStatMs.getN() > 0.
1357 audio_utils::Statistics<double> mDownstreamLatencyStatMs{0.999};
Andy Hung2148bf02016-11-28 19:01:02 -08001358
Eric Laurent81784c32012-11-19 14:55:58 -08001359public:
1360 virtual bool hasFastMixer() const = 0;
Glenn Kasten0f11b512014-01-31 16:18:54 -08001361 virtual FastTrackUnderruns getFastTrackUnderruns(size_t fastIndex __unused) const
Eric Laurent81784c32012-11-19 14:55:58 -08001362 { FastTrackUnderruns dummy; return dummy; }
1363
1364protected:
1365 // accessed by both binder threads and within threadLoop(), lock on mutex needed
1366 unsigned mFastTrackAvailMask; // bit i set if fast track [i] is available
Eric Laurentd1f69b02014-12-15 14:33:13 -08001367 bool mHwSupportsPause;
1368 bool mHwPaused;
1369 bool mFlushPending;
Eric Laurent7c29ec92017-09-20 17:54:22 -07001370 // volumes last sent to audio HAL with stream->setVolume()
1371 float mLeftVolFloat;
1372 float mRightVolFloat;
Eric Laurent74c38dc2020-12-23 18:19:44 +01001373
1374 // audio patch used by the downstream software patch.
1375 // Only used if ThreadBase::mIsMsdDevice is true.
1376 struct audio_patch mDownStreamPatch;
Eric Laurentb3f315a2021-07-13 15:09:05 +02001377
1378 std::atomic_bool mCheckOutputStageEffects{};
Eric Laurent81784c32012-11-19 14:55:58 -08001379};
1380
1381class MixerThread : public PlaybackThread {
1382public:
1383 MixerThread(const sp<AudioFlinger>& audioFlinger,
1384 AudioStreamOut* output,
1385 audio_io_handle_t id,
Eric Laurent72e3f392015-05-20 14:43:50 -07001386 bool systemReady,
Eric Laurentf1f22e72021-07-13 14:04:14 +02001387 type_t type = MIXER,
1388 audio_config_base_t *mixerConfig = nullptr);
Eric Laurent81784c32012-11-19 14:55:58 -08001389 virtual ~MixerThread();
1390
1391 // Thread virtuals
1392
Eric Laurent10351942014-05-08 18:49:52 -07001393 virtual bool checkForNewParameter_l(const String8& keyValuePair,
1394 status_t& status);
Eric Laurent81784c32012-11-19 14:55:58 -08001395
Andy Hung1bc088a2018-02-09 15:57:31 -08001396 virtual bool isTrackAllowed_l(
1397 audio_channel_mask_t channelMask, audio_format_t format,
1398 audio_session_t sessionId, uid_t uid) const override;
Eric Laurent81784c32012-11-19 14:55:58 -08001399protected:
1400 virtual mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove);
Eric Laurent81784c32012-11-19 14:55:58 -08001401 virtual uint32_t idleSleepTimeUs() const;
1402 virtual uint32_t suspendSleepTimeUs() const;
1403 virtual void cacheParameters_l();
1404
Andy Hungdae27702016-10-31 14:01:16 -07001405 virtual void acquireWakeLock_l() {
1406 PlaybackThread::acquireWakeLock_l();
Andy Hung818e7a32016-02-16 18:08:07 -08001407 if (hasFastMixer()) {
1408 mFastMixer->setBoottimeOffset(
1409 mTimestamp.mTimebaseOffset[ExtendedTimestamp::TIMEBASE_BOOTTIME]);
1410 }
1411 }
1412
Mikhail Naganov01dc5ca2019-03-29 10:12:12 -07001413 void dumpInternals_l(int fd, const Vector<String16>& args) override;
1414
Eric Laurent81784c32012-11-19 14:55:58 -08001415 // threadLoop snippets
Eric Laurentbfb1b832013-01-07 09:53:42 -08001416 virtual ssize_t threadLoop_write();
Eric Laurent81784c32012-11-19 14:55:58 -08001417 virtual void threadLoop_standby();
1418 virtual void threadLoop_mix();
1419 virtual void threadLoop_sleepTime();
Eric Laurent81784c32012-11-19 14:55:58 -08001420 virtual uint32_t correctLatency_l(uint32_t latency) const;
1421
Eric Laurent054d9d32015-04-24 08:48:48 -07001422 virtual status_t createAudioPatch_l(const struct audio_patch *patch,
1423 audio_patch_handle_t *handle);
1424 virtual status_t releaseAudioPatch_l(const audio_patch_handle_t handle);
1425
Eric Laurent81784c32012-11-19 14:55:58 -08001426 AudioMixer* mAudioMixer; // normal mixer
1427private:
1428 // one-time initialization, no locks required
Glenn Kasten4d23ca32014-05-13 10:39:51 -07001429 sp<FastMixer> mFastMixer; // non-0 if there is also a fast mixer
Eric Laurent81784c32012-11-19 14:55:58 -08001430 sp<AudioWatchdog> mAudioWatchdog; // non-0 if there is an audio watchdog thread
1431
1432 // contents are not guaranteed to be consistent, no locks required
1433 FastMixerDumpState mFastMixerDumpState;
1434#ifdef STATE_QUEUE_DUMP
1435 StateQueueObserverDump mStateQueueObserverDump;
1436 StateQueueMutatorDump mStateQueueMutatorDump;
1437#endif
1438 AudioWatchdogDump mAudioWatchdogDump;
1439
1440 // accessible only within the threadLoop(), no locks required
1441 // mFastMixer->sq() // for mutating and pushing state
1442 int32_t mFastMixerFutex; // for cold idle
1443
Andy Hung2ddee192015-12-18 17:34:44 -08001444 std::atomic_bool mMasterMono;
Eric Laurent81784c32012-11-19 14:55:58 -08001445public:
Glenn Kasten4d23ca32014-05-13 10:39:51 -07001446 virtual bool hasFastMixer() const { return mFastMixer != 0; }
Eric Laurent81784c32012-11-19 14:55:58 -08001447 virtual FastTrackUnderruns getFastTrackUnderruns(size_t fastIndex) const {
Glenn Kastendc2c50b2016-04-21 08:13:14 -07001448 ALOG_ASSERT(fastIndex < FastMixerState::sMaxFastTracks);
Eric Laurent81784c32012-11-19 14:55:58 -08001449 return mFastMixerDumpState.mTracks[fastIndex].mUnderruns;
1450 }
Eric Laurent83b88082014-06-20 18:31:16 -07001451
Andy Hung1c86ebe2018-05-29 20:29:08 -07001452 status_t threadloop_getHalTimestamp_l(
1453 ExtendedTimestamp *timestamp) const override {
1454 if (mNormalSink.get() != nullptr) {
1455 return mNormalSink->getTimestamp(*timestamp);
1456 }
1457 return INVALID_OPERATION;
1458 }
1459
Andy Hung2ddee192015-12-18 17:34:44 -08001460protected:
1461 virtual void setMasterMono_l(bool mono) {
1462 mMasterMono.store(mono);
1463 if (mFastMixer != nullptr) { /* hasFastMixer() */
1464 mFastMixer->setMasterMono(mMasterMono);
1465 }
1466 }
1467 // the FastMixer performs mono blend if it exists.
Glenn Kasten03c48d52016-01-27 17:25:17 -08001468 // Blending with limiter is not idempotent,
1469 // and blending without limiter is idempotent but inefficient to do twice.
Andy Hung2ddee192015-12-18 17:34:44 -08001470 virtual bool requireMonoBlend() { return mMasterMono.load() && !hasFastMixer(); }
Richard Folke Tullberg3fae0372017-01-13 09:04:25 +01001471
1472 void setMasterBalance(float balance) override {
1473 mMasterBalance.store(balance);
1474 if (hasFastMixer()) {
1475 mFastMixer->setMasterBalance(balance);
1476 }
1477 }
Eric Laurent81784c32012-11-19 14:55:58 -08001478};
1479
1480class DirectOutputThread : public PlaybackThread {
1481public:
1482
1483 DirectOutputThread(const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output,
jiabinc52b1ff2019-10-31 17:20:42 -07001484 audio_io_handle_t id, bool systemReady)
1485 : DirectOutputThread(audioFlinger, output, id, DIRECT, systemReady) { }
Andy Hung48f59ed2019-01-28 15:06:59 -08001486
Eric Laurent81784c32012-11-19 14:55:58 -08001487 virtual ~DirectOutputThread();
1488
Mikhail Naganovac917ac2018-11-28 14:03:52 -08001489 status_t selectPresentation(int presentationId, int programId);
1490
Eric Laurent81784c32012-11-19 14:55:58 -08001491 // Thread virtuals
1492
Eric Laurent10351942014-05-08 18:49:52 -07001493 virtual bool checkForNewParameter_l(const String8& keyValuePair,
1494 status_t& status);
Richard Folke Tullberg3fae0372017-01-13 09:04:25 +01001495
Eric Laurente659ef42014-09-29 13:06:46 -07001496 virtual void flushHw_l();
Eric Laurent81784c32012-11-19 14:55:58 -08001497
Richard Folke Tullberg3fae0372017-01-13 09:04:25 +01001498 void setMasterBalance(float balance) override;
1499
Eric Laurent81784c32012-11-19 14:55:58 -08001500protected:
Eric Laurent81784c32012-11-19 14:55:58 -08001501 virtual uint32_t activeSleepTimeUs() const;
1502 virtual uint32_t idleSleepTimeUs() const;
1503 virtual uint32_t suspendSleepTimeUs() const;
1504 virtual void cacheParameters_l();
1505
Mikhail Naganov01dc5ca2019-03-29 10:12:12 -07001506 void dumpInternals_l(int fd, const Vector<String16>& args) override;
1507
Eric Laurent81784c32012-11-19 14:55:58 -08001508 // threadLoop snippets
1509 virtual mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove);
1510 virtual void threadLoop_mix();
1511 virtual void threadLoop_sleepTime();
Eric Laurentd1f69b02014-12-15 14:33:13 -08001512 virtual void threadLoop_exit();
1513 virtual bool shouldStandby_l();
Eric Laurent81784c32012-11-19 14:55:58 -08001514
Phil Burk43b4dcc2015-06-09 16:53:44 -07001515 virtual void onAddNewTrack_l();
1516
Andy Hung48f59ed2019-01-28 15:06:59 -08001517 bool mVolumeShaperActive = false;
Eric Laurent81784c32012-11-19 14:55:58 -08001518
Eric Laurentbfb1b832013-01-07 09:53:42 -08001519 DirectOutputThread(const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output,
jiabinc52b1ff2019-10-31 17:20:42 -07001520 audio_io_handle_t id, ThreadBase::type_t type, bool systemReady);
Eric Laurent5850c4c2016-11-10 13:04:31 -08001521 void processVolume_l(Track *track, bool lastTrack);
Eric Laurentbfb1b832013-01-07 09:53:42 -08001522
Eric Laurent81784c32012-11-19 14:55:58 -08001523 // prepareTracks_l() tells threadLoop_mix() the name of the single active track
1524 sp<Track> mActiveTrack;
Phil Burk43b4dcc2015-06-09 16:53:44 -07001525
1526 wp<Track> mPreviousTrack; // used to detect track switch
1527
Richard Folke Tullberg3fae0372017-01-13 09:04:25 +01001528 // This must be initialized for initial condition of mMasterBalance = 0 (disabled).
1529 float mMasterBalanceLeft = 1.f;
1530 float mMasterBalanceRight = 1.f;
1531
Eric Laurent81784c32012-11-19 14:55:58 -08001532public:
1533 virtual bool hasFastMixer() const { return false; }
Andy Hung10cbff12017-02-21 17:30:14 -08001534
1535 virtual int64_t computeWaitTimeNs_l() const override;
Andy Hungf3234512018-07-03 14:51:47 -07001536
1537 status_t threadloop_getHalTimestamp_l(ExtendedTimestamp *timestamp) const override {
1538 // For DIRECT and OFFLOAD threads, query the output sink directly.
1539 if (mOutput != nullptr) {
1540 uint64_t uposition64;
1541 struct timespec time;
1542 if (mOutput->getPresentationPosition(
1543 &uposition64, &time) == OK) {
1544 timestamp->mPosition[ExtendedTimestamp::LOCATION_KERNEL]
1545 = (int64_t)uposition64;
1546 timestamp->mTimeNs[ExtendedTimestamp::LOCATION_KERNEL]
1547 = audio_utils_ns_from_timespec(&time);
1548 return NO_ERROR;
1549 }
1550 }
1551 return INVALID_OPERATION;
1552 }
Eric Laurent81784c32012-11-19 14:55:58 -08001553};
1554
Eric Laurentbfb1b832013-01-07 09:53:42 -08001555class OffloadThread : public DirectOutputThread {
1556public:
1557
1558 OffloadThread(const sp<AudioFlinger>& audioFlinger, AudioStreamOut* output,
jiabinc52b1ff2019-10-31 17:20:42 -07001559 audio_io_handle_t id, bool systemReady);
Eric Laurent6a51d7e2013-10-17 18:59:26 -07001560 virtual ~OffloadThread() {};
Eric Laurente659ef42014-09-29 13:06:46 -07001561 virtual void flushHw_l();
Eric Laurentbfb1b832013-01-07 09:53:42 -08001562
1563protected:
1564 // threadLoop snippets
1565 virtual mixer_state prepareTracks_l(Vector< sp<Track> > *tracksToRemove);
1566 virtual void threadLoop_exit();
Eric Laurentbfb1b832013-01-07 09:53:42 -08001567
1568 virtual bool waitingAsyncCallback();
1569 virtual bool waitingAsyncCallback_l();
Haynes Mathew George05317d22016-05-03 16:34:26 -07001570 virtual void invalidateTracks(audio_stream_type_t streamType);
Eric Laurentbfb1b832013-01-07 09:53:42 -08001571
Eric Laurentde0613d2016-07-22 18:19:11 -07001572 virtual bool keepWakeLock() const { return (mKeepWakeLock || (mDrainSequence & 1)); }
Eric Laurent64667972016-03-30 18:19:46 -07001573
Eric Laurentbfb1b832013-01-07 09:53:42 -08001574private:
Eric Laurentbfb1b832013-01-07 09:53:42 -08001575 size_t mPausedWriteLength; // length in bytes of write interrupted by pause
1576 size_t mPausedBytesRemaining; // bytes still waiting in mixbuffer after resume
Eric Laurent64667972016-03-30 18:19:46 -07001577 bool mKeepWakeLock; // keep wake lock while waiting for write callback
Andy Hungf8044752016-07-27 14:58:11 -07001578 uint64_t mOffloadUnderrunPosition; // Current frame position for offloaded playback
1579 // used and valid only during underrun. ~0 if
1580 // no underrun has occurred during playback and
1581 // is not reset on standby.
Eric Laurentbfb1b832013-01-07 09:53:42 -08001582};
1583
1584class AsyncCallbackThread : public Thread {
1585public:
1586
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -07001587 explicit AsyncCallbackThread(const wp<PlaybackThread>& playbackThread);
Eric Laurentbfb1b832013-01-07 09:53:42 -08001588
1589 virtual ~AsyncCallbackThread();
1590
1591 // Thread virtuals
1592 virtual bool threadLoop();
1593
1594 // RefBase
1595 virtual void onFirstRef();
1596
1597 void exit();
Eric Laurent3b4529e2013-09-05 18:09:19 -07001598 void setWriteBlocked(uint32_t sequence);
1599 void resetWriteBlocked();
1600 void setDraining(uint32_t sequence);
1601 void resetDraining();
Haynes Mathew George4527b9e2016-07-07 19:54:17 -07001602 void setAsyncError();
Eric Laurentbfb1b832013-01-07 09:53:42 -08001603
1604private:
Eric Laurent4de95592013-09-26 15:28:21 -07001605 const wp<PlaybackThread> mPlaybackThread;
Eric Laurent3b4529e2013-09-05 18:09:19 -07001606 // mWriteAckSequence corresponds to the last write sequence passed by the offload thread via
1607 // setWriteBlocked(). The sequence is shifted one bit to the left and the lsb is used
1608 // to indicate that the callback has been received via resetWriteBlocked()
Eric Laurent4de95592013-09-26 15:28:21 -07001609 uint32_t mWriteAckSequence;
Eric Laurent3b4529e2013-09-05 18:09:19 -07001610 // mDrainSequence corresponds to the last drain sequence passed by the offload thread via
1611 // setDraining(). The sequence is shifted one bit to the left and the lsb is used
1612 // to indicate that the callback has been received via resetDraining()
Eric Laurent4de95592013-09-26 15:28:21 -07001613 uint32_t mDrainSequence;
1614 Condition mWaitWorkCV;
1615 Mutex mLock;
Haynes Mathew George4527b9e2016-07-07 19:54:17 -07001616 bool mAsyncError;
Eric Laurentbfb1b832013-01-07 09:53:42 -08001617};
1618
Eric Laurent81784c32012-11-19 14:55:58 -08001619class DuplicatingThread : public MixerThread {
1620public:
1621 DuplicatingThread(const sp<AudioFlinger>& audioFlinger, MixerThread* mainThread,
Eric Laurent72e3f392015-05-20 14:43:50 -07001622 audio_io_handle_t id, bool systemReady);
Eric Laurent81784c32012-11-19 14:55:58 -08001623 virtual ~DuplicatingThread();
1624
1625 // Thread virtuals
1626 void addOutputTrack(MixerThread* thread);
1627 void removeOutputTrack(MixerThread* thread);
1628 uint32_t waitTimeMs() const { return mWaitTimeMs; }
Kevin Rocard069c2712018-03-29 19:09:14 -07001629
Kevin Rocardc86a7f72018-04-03 09:00:09 -07001630 void sendMetadataToBackend_l(
1631 const StreamOutHalInterface::SourceMetadata& metadata) override;
Eric Laurent81784c32012-11-19 14:55:58 -08001632protected:
1633 virtual uint32_t activeSleepTimeUs() const;
Mikhail Naganov01dc5ca2019-03-29 10:12:12 -07001634 void dumpInternals_l(int fd, const Vector<String16>& args) override;
Eric Laurent81784c32012-11-19 14:55:58 -08001635
1636private:
1637 bool outputsReady(const SortedVector< sp<OutputTrack> > &outputTracks);
1638protected:
1639 // threadLoop snippets
1640 virtual void threadLoop_mix();
1641 virtual void threadLoop_sleepTime();
Eric Laurentbfb1b832013-01-07 09:53:42 -08001642 virtual ssize_t threadLoop_write();
Eric Laurent81784c32012-11-19 14:55:58 -08001643 virtual void threadLoop_standby();
1644 virtual void cacheParameters_l();
1645
1646private:
1647 // called from threadLoop, addOutputTrack, removeOutputTrack
1648 virtual void updateWaitTime_l();
1649protected:
1650 virtual void saveOutputTracks();
1651 virtual void clearOutputTracks();
1652private:
1653
1654 uint32_t mWaitTimeMs;
1655 SortedVector < sp<OutputTrack> > outputTracks;
1656 SortedVector < sp<OutputTrack> > mOutputTracks;
1657public:
1658 virtual bool hasFastMixer() const { return false; }
Andy Hung1c86ebe2018-05-29 20:29:08 -07001659 status_t threadloop_getHalTimestamp_l(
1660 ExtendedTimestamp *timestamp) const override {
1661 if (mOutputTracks.size() > 0) {
1662 // forward the first OutputTrack's kernel information for timestamp.
1663 const ExtendedTimestamp trackTimestamp =
1664 mOutputTracks[0]->getClientProxyTimestamp();
1665 if (trackTimestamp.mTimeNs[ExtendedTimestamp::LOCATION_KERNEL] > 0) {
1666 timestamp->mTimeNs[ExtendedTimestamp::LOCATION_KERNEL] =
1667 trackTimestamp.mTimeNs[ExtendedTimestamp::LOCATION_KERNEL];
1668 timestamp->mPosition[ExtendedTimestamp::LOCATION_KERNEL] =
1669 trackTimestamp.mPosition[ExtendedTimestamp::LOCATION_KERNEL];
1670 return OK; // discard server timestamp - that's ignored.
1671 }
1672 }
1673 return INVALID_OPERATION;
1674 }
Eric Laurent81784c32012-11-19 14:55:58 -08001675};
1676
Eric Laurentfa0f6742021-08-17 18:39:44 +02001677class SpatializerThread : public MixerThread {
Eric Laurentb3f315a2021-07-13 15:09:05 +02001678public:
Eric Laurentfa0f6742021-08-17 18:39:44 +02001679 SpatializerThread(const sp<AudioFlinger>& audioFlinger,
Eric Laurentb3f315a2021-07-13 15:09:05 +02001680 AudioStreamOut* output,
1681 audio_io_handle_t id,
1682 bool systemReady,
1683 audio_config_base_t *mixerConfig);
Eric Laurentfa0f6742021-08-17 18:39:44 +02001684 ~SpatializerThread() override {}
Eric Laurentb3f315a2021-07-13 15:09:05 +02001685
1686 bool hasFastMixer() const override { return false; }
1687
1688protected:
1689 void checkOutputStageEffects() override;
1690
1691private:
1692 sp<EffectHandle> mFinalDownMixer;
1693};
1694
Eric Laurent81784c32012-11-19 14:55:58 -08001695// record thread
Glenn Kasten6dd62fb2013-12-05 16:35:58 -08001696class RecordThread : public ThreadBase
Eric Laurent81784c32012-11-19 14:55:58 -08001697{
1698public:
1699
Glenn Kasten6dd62fb2013-12-05 16:35:58 -08001700 class RecordTrack;
Andy Hung73c02e42015-03-29 01:13:58 -07001701
1702 /* The ResamplerBufferProvider is used to retrieve recorded input data from the
1703 * RecordThread. It maintains local state on the relative position of the read
1704 * position of the RecordTrack compared with the RecordThread.
1705 */
Glenn Kasten6dd62fb2013-12-05 16:35:58 -08001706 class ResamplerBufferProvider : public AudioBufferProvider
Glenn Kasten6dd62fb2013-12-05 16:35:58 -08001707 {
1708 public:
Chih-Hung Hsiehe964d4e2016-08-09 14:31:32 -07001709 explicit ResamplerBufferProvider(RecordTrack* recordTrack) :
Andy Hung73c02e42015-03-29 01:13:58 -07001710 mRecordTrack(recordTrack),
1711 mRsmpInUnrel(0), mRsmpInFront(0) { }
Glenn Kasten6dd62fb2013-12-05 16:35:58 -08001712 virtual ~ResamplerBufferProvider() { }
Andy Hung73c02e42015-03-29 01:13:58 -07001713
1714 // called to set the ResamplerBufferProvider to head of the RecordThread data buffer,
1715 // skipping any previous data read from the hal.
1716 virtual void reset();
1717
1718 /* Synchronizes RecordTrack position with the RecordThread.
1719 * Calculates available frames and handle overruns if the RecordThread
1720 * has advanced faster than the ResamplerBufferProvider has retrieved data.
1721 * TODO: why not do this for every getNextBuffer?
1722 *
1723 * Parameters
1724 * framesAvailable: pointer to optional output size_t to store record track
1725 * frames available.
1726 * hasOverrun: pointer to optional boolean, returns true if track has overrun.
1727 */
1728
1729 virtual void sync(size_t *framesAvailable = NULL, bool *hasOverrun = NULL);
1730
Glenn Kasten6dd62fb2013-12-05 16:35:58 -08001731 // AudioBufferProvider interface
Glenn Kastend79072e2016-01-06 08:41:20 -08001732 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer);
Glenn Kasten6dd62fb2013-12-05 16:35:58 -08001733 virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer);
Eric Laurentec376dc2021-04-08 20:41:22 +02001734
1735 int32_t getFront() const { return mRsmpInFront; }
1736 void setFront(int32_t front) { mRsmpInFront = front; }
Glenn Kasten6dd62fb2013-12-05 16:35:58 -08001737 private:
1738 RecordTrack * const mRecordTrack;
Andy Hung73c02e42015-03-29 01:13:58 -07001739 size_t mRsmpInUnrel; // unreleased frames remaining from
1740 // most recent getNextBuffer
1741 // for debug only
1742 int32_t mRsmpInFront; // next available frame
1743 // rolling counter that is never cleared
Glenn Kasten6dd62fb2013-12-05 16:35:58 -08001744 };
1745
Eric Laurent81784c32012-11-19 14:55:58 -08001746#include "RecordTracks.h"
1747
1748 RecordThread(const sp<AudioFlinger>& audioFlinger,
1749 AudioStreamIn *input,
Eric Laurent81784c32012-11-19 14:55:58 -08001750 audio_io_handle_t id,
Eric Laurent72e3f392015-05-20 14:43:50 -07001751 bool systemReady
Glenn Kasten46909e72013-02-26 09:20:22 -08001752 );
Eric Laurent81784c32012-11-19 14:55:58 -08001753 virtual ~RecordThread();
1754
1755 // no addTrack_l ?
1756 void destroyTrack_l(const sp<RecordTrack>& track);
1757 void removeTrack_l(const sp<RecordTrack>& track);
1758
Eric Laurent81784c32012-11-19 14:55:58 -08001759 // Thread virtuals
1760 virtual bool threadLoop();
Eric Laurent555530a2017-02-07 18:17:24 -08001761 virtual void preExit();
Eric Laurent81784c32012-11-19 14:55:58 -08001762
1763 // RefBase
1764 virtual void onFirstRef();
1765
1766 virtual status_t initCheck() const { return (mInput == NULL) ? NO_INIT : NO_ERROR; }
Glenn Kastene198c362013-08-13 09:13:36 -07001767
Glenn Kastenb880f5e2014-05-07 08:43:45 -07001768 virtual sp<MemoryDealer> readOnlyHeap() const { return mReadOnlyHeap; }
1769
Glenn Kasten6dbb5e32014-05-13 10:38:42 -07001770 virtual sp<IMemory> pipeMemory() const { return mPipeMemory; }
1771
Eric Laurent81784c32012-11-19 14:55:58 -08001772 sp<AudioFlinger::RecordThread::RecordTrack> createRecordTrack_l(
1773 const sp<AudioFlinger::Client>& client,
Kevin Rocard1f564ac2018-03-29 13:53:10 -07001774 const audio_attributes_t& attr,
Eric Laurentf14db3c2017-12-08 14:20:36 -08001775 uint32_t *pSampleRate,
Eric Laurent81784c32012-11-19 14:55:58 -08001776 audio_format_t format,
1777 audio_channel_mask_t channelMask,
Glenn Kasten74935e42013-12-19 08:56:45 -08001778 size_t *pFrameCount,
Glenn Kastend848eb42016-03-08 13:42:11 -08001779 audio_session_t sessionId,
Eric Laurentf14db3c2017-12-08 14:20:36 -08001780 size_t *pNotificationFrameCount,
Eric Laurent09f1ed22019-04-24 17:45:17 -07001781 pid_t creatorPid,
Svet Ganov33761132021-05-13 22:51:08 +00001782 const AttributionSourceState& attributionSource,
Eric Laurent05067782016-06-01 18:27:28 -07001783 audio_input_flags_t *flags,
Eric Laurent81784c32012-11-19 14:55:58 -08001784 pid_t tid,
Eric Laurent20b9ef02016-12-05 11:03:16 -08001785 status_t *status /*non-NULL*/,
Eric Laurentec376dc2021-04-08 20:41:22 +02001786 audio_port_handle_t portId,
1787 int32_t maxSharedAudioHistoryMs);
Eric Laurent81784c32012-11-19 14:55:58 -08001788
1789 status_t start(RecordTrack* recordTrack,
1790 AudioSystem::sync_event_t event,
Glenn Kastend848eb42016-03-08 13:42:11 -08001791 audio_session_t triggerSession);
Eric Laurent81784c32012-11-19 14:55:58 -08001792
1793 // ask the thread to stop the specified track, and
1794 // return true if the caller should then do it's part of the stopping process
Glenn Kastena8356f62013-07-25 14:37:52 -07001795 bool stop(RecordTrack* recordTrack);
Eric Laurent81784c32012-11-19 14:55:58 -08001796
Eric Laurent81784c32012-11-19 14:55:58 -08001797 AudioStreamIn* clearInput();
Mikhail Naganov1dc98672016-08-18 17:50:29 -07001798 virtual sp<StreamHalInterface> stream() const;
Eric Laurent81784c32012-11-19 14:55:58 -08001799
Eric Laurent81784c32012-11-19 14:55:58 -08001800
Eric Laurent10351942014-05-08 18:49:52 -07001801 virtual bool checkForNewParameter_l(const String8& keyValuePair,
1802 status_t& status);
1803 virtual void cacheParameters_l() {}
Eric Laurent81784c32012-11-19 14:55:58 -08001804 virtual String8 getParameters(const String8& keys);
Mikhail Naganov88536df2021-07-26 17:30:29 -07001805 virtual void ioConfigChanged(audio_io_config_event_t event, pid_t pid = 0,
Eric Laurent09f1ed22019-04-24 17:45:17 -07001806 audio_port_handle_t portId = AUDIO_PORT_HANDLE_NONE);
Eric Laurent1c333e22014-05-20 10:48:17 -07001807 virtual status_t createAudioPatch_l(const struct audio_patch *patch,
1808 audio_patch_handle_t *handle);
1809 virtual status_t releaseAudioPatch_l(const audio_patch_handle_t handle);
jiabinc52b1ff2019-10-31 17:20:42 -07001810 void updateOutDevices(const DeviceDescriptorBaseVector& outDevices) override;
Eric Laurent5f0fd7b2021-05-07 16:33:26 +02001811 void resizeInputBuffer_l(int32_t maxSharedAudioHistoryMs) override;
Eric Laurent83b88082014-06-20 18:31:16 -07001812
Mikhail Naganov444ecc32018-05-01 17:40:05 -07001813 void addPatchTrack(const sp<PatchRecord>& record);
1814 void deletePatchTrack(const sp<PatchRecord>& record);
Eric Laurent83b88082014-06-20 18:31:16 -07001815
Glenn Kastendeca2ae2014-02-07 10:25:56 -08001816 void readInputParameters_l();
Glenn Kasten5f972c02014-01-13 09:59:31 -08001817 virtual uint32_t getInputFramesLost();
Eric Laurent81784c32012-11-19 14:55:58 -08001818
1819 virtual status_t addEffectChain_l(const sp<EffectChain>& chain);
1820 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain);
Andy Hungc3d62f92019-03-14 13:38:51 -07001821 uint32_t hasAudioSession_l(audio_session_t sessionId) const override {
1822 return ThreadBase::hasAudioSession_l(sessionId, mTracks);
1823 }
Eric Laurent81784c32012-11-19 14:55:58 -08001824
1825 // Return the set of unique session IDs across all tracks.
1826 // The keys are the session IDs, and the associated values are meaningless.
1827 // FIXME replace by Set [and implement Bag/Multiset for other uses].
Glenn Kastend848eb42016-03-08 13:42:11 -08001828 KeyedVector<audio_session_t, bool> sessionIds() const;
Eric Laurent81784c32012-11-19 14:55:58 -08001829
1830 virtual status_t setSyncEvent(const sp<SyncEvent>& event);
1831 virtual bool isValidSyncEvent(const sp<SyncEvent>& event) const;
1832
1833 static void syncStartEventCallback(const wp<SyncEvent>& event);
Eric Laurent81784c32012-11-19 14:55:58 -08001834
Glenn Kasten9b58f632013-07-16 11:37:48 -07001835 virtual size_t frameCount() const { return mFrameCount; }
Glenn Kasten6dbb5e32014-05-13 10:38:42 -07001836 bool hasFastCapture() const { return mFastCapture != 0; }
Mikhail Naganovdc769682018-05-04 15:34:08 -07001837 virtual void toAudioPortConfig(struct audio_port_config *config);
Glenn Kasten9b58f632013-07-16 11:37:48 -07001838
Eric Laurent4c415062016-06-17 16:14:16 -07001839 virtual status_t checkEffectCompatibility_l(const effect_descriptor_t *desc,
1840 audio_session_t sessionId);
1841
Andy Hungdae27702016-10-31 14:01:16 -07001842 virtual void acquireWakeLock_l() {
1843 ThreadBase::acquireWakeLock_l();
1844 mActiveTracks.updatePowerState(this, true /* force */);
1845 }
1846
Eric Laurentd8365c52017-07-16 15:27:05 -07001847 void checkBtNrec();
1848
Svet Ganovf4ddfef2018-01-16 07:37:58 -08001849 // Sets the UID records silence
Eric Laurent5ada82e2019-08-29 17:53:54 -07001850 void setRecordSilenced(audio_port_handle_t portId, bool silenced);
Svet Ganovf4ddfef2018-01-16 07:37:58 -08001851
jiabin653cc0a2018-01-17 17:54:10 -08001852 status_t getActiveMicrophones(std::vector<media::MicrophoneInfo>* activeMicrophones);
1853
Paul McLean12340082019-03-19 09:35:05 -06001854 status_t setPreferredMicrophoneDirection(audio_microphone_direction_t direction);
1855 status_t setPreferredMicrophoneFieldDimension(float zoom);
Paul McLean03a6e6a2018-12-04 10:54:13 -07001856
Kevin Rocard069c2712018-03-29 19:09:14 -07001857 void updateMetadata_l() override;
1858
jiabin01c8f562018-07-19 17:47:28 -07001859 bool fastTrackAvailable() const { return mFastTrackAvail; }
1860
Andy Hungc8fddf32018-08-08 18:32:37 -07001861 bool isTimestampCorrectionEnabled() const override {
1862 // checks popcount for exactly one device.
jiabinc52b1ff2019-10-31 17:20:42 -07001863 return audio_is_input_device(mTimestampCorrectedDevice)
1864 && inDeviceType() == mTimestampCorrectedDevice;
Andy Hungc8fddf32018-08-08 18:32:37 -07001865 }
Mikhail Naganov01dc5ca2019-03-29 10:12:12 -07001866
Eric Laurentec376dc2021-04-08 20:41:22 +02001867 status_t shareAudioHistory(const std::string& sharedAudioPackageName,
1868 audio_session_t sharedSessionId = AUDIO_SESSION_NONE,
1869 int64_t sharedAudioStartMs = -1);
1870 status_t shareAudioHistory_l(const std::string& sharedAudioPackageName,
1871 audio_session_t sharedSessionId = AUDIO_SESSION_NONE,
1872 int64_t sharedAudioStartMs = -1);
Eric Laurent92d0a322021-07-16 15:32:33 +02001873 void resetAudioHistory_l();
Eric Laurentec376dc2021-04-08 20:41:22 +02001874
Jasmine Chaeaa10e42021-05-11 10:11:14 +08001875 virtual bool isStreamInitialized() {
1876 return !(mInput == nullptr || mInput->stream == nullptr);
1877 }
1878
Mikhail Naganov01dc5ca2019-03-29 10:12:12 -07001879protected:
1880 void dumpInternals_l(int fd, const Vector<String16>& args) override;
1881 void dumpTracks_l(int fd, const Vector<String16>& args) override;
1882
Eric Laurent81784c32012-11-19 14:55:58 -08001883private:
Eric Laurent81784c32012-11-19 14:55:58 -08001884 // Enter standby if not already in standby, and set mStandby flag
Glenn Kasten93e471f2013-08-19 08:40:07 -07001885 void standbyIfNotAlreadyInStandby();
Eric Laurent81784c32012-11-19 14:55:58 -08001886
1887 // Call the HAL standby method unconditionally, and don't change mStandby flag
Glenn Kastene198c362013-08-13 09:13:36 -07001888 void inputStandBy();
Eric Laurent81784c32012-11-19 14:55:58 -08001889
Eric Laurentd8365c52017-07-16 15:27:05 -07001890 void checkBtNrec_l();
1891
Eric Laurentec376dc2021-04-08 20:41:22 +02001892 int32_t getOldestFront_l();
1893 void updateFronts_l(int32_t offset);
1894
Eric Laurent81784c32012-11-19 14:55:58 -08001895 AudioStreamIn *mInput;
Mikhail Naganov2534b382019-09-25 13:05:02 -07001896 Source *mSource;
Eric Laurent81784c32012-11-19 14:55:58 -08001897 SortedVector < sp<RecordTrack> > mTracks;
Glenn Kasten2b806402013-11-20 16:37:38 -08001898 // mActiveTracks has dual roles: it indicates the current active track(s), and
Eric Laurent81784c32012-11-19 14:55:58 -08001899 // is used together with mStartStopCond to indicate start()/stop() progress
Andy Hungdae27702016-10-31 14:01:16 -07001900 ActiveTracks<RecordTrack> mActiveTracks;
1901
Eric Laurent81784c32012-11-19 14:55:58 -08001902 Condition mStartStopCond;
Glenn Kasten9b58f632013-07-16 11:37:48 -07001903
Glenn Kasten85948432013-08-19 12:09:05 -07001904 // resampler converts input at HAL Hz to output at AudioRecord client Hz
Glenn Kasten1b291842016-07-18 14:55:21 -07001905 void *mRsmpInBuffer; // size = mRsmpInFramesOA
Glenn Kasten85948432013-08-19 12:09:05 -07001906 size_t mRsmpInFrames; // size of resampler input in frames
1907 size_t mRsmpInFramesP2;// size rounded up to a power-of-2
Glenn Kasten1b291842016-07-18 14:55:21 -07001908 size_t mRsmpInFramesOA;// mRsmpInFramesP2 + over-allocation
Glenn Kasten6dd62fb2013-12-05 16:35:58 -08001909
1910 // rolling index that is never cleared
Glenn Kasten85948432013-08-19 12:09:05 -07001911 int32_t mRsmpInRear; // last filled frame + 1
Glenn Kasten85948432013-08-19 12:09:05 -07001912
Eric Laurent81784c32012-11-19 14:55:58 -08001913 // For dumpsys
Glenn Kastenb880f5e2014-05-07 08:43:45 -07001914 const sp<MemoryDealer> mReadOnlyHeap;
Glenn Kasten6dbb5e32014-05-13 10:38:42 -07001915
1916 // one-time initialization, no locks required
Glenn Kastenb187de12014-12-30 08:18:15 -08001917 sp<FastCapture> mFastCapture; // non-0 if there is also
1918 // a fast capture
Eric Laurent72e3f392015-05-20 14:43:50 -07001919
Glenn Kasten6dbb5e32014-05-13 10:38:42 -07001920 // FIXME audio watchdog thread
1921
1922 // contents are not guaranteed to be consistent, no locks required
1923 FastCaptureDumpState mFastCaptureDumpState;
1924#ifdef STATE_QUEUE_DUMP
1925 // FIXME StateQueue observer and mutator dump fields
1926#endif
1927 // FIXME audio watchdog dump
1928
1929 // accessible only within the threadLoop(), no locks required
1930 // mFastCapture->sq() // for mutating and pushing state
1931 int32_t mFastCaptureFutex; // for cold idle
1932
1933 // The HAL input source is treated as non-blocking,
1934 // but current implementation is blocking
1935 sp<NBAIO_Source> mInputSource;
1936 // The source for the normal capture thread to read from: mInputSource or mPipeSource
1937 sp<NBAIO_Source> mNormalSource;
1938 // If a fast capture is present, the non-blocking pipe sink written to by fast capture,
1939 // otherwise clear
1940 sp<NBAIO_Sink> mPipeSink;
1941 // If a fast capture is present, the non-blocking pipe source read by normal thread,
1942 // otherwise clear
1943 sp<NBAIO_Source> mPipeSource;
1944 // Depth of pipe from fast capture to normal thread and fast clients, always power of 2
1945 size_t mPipeFramesP2;
1946 // If a fast capture is present, the Pipe as IMemory, otherwise clear
1947 sp<IMemory> mPipeMemory;
1948
Sanna Catherine de Treville Wager2a6a9452017-07-28 11:02:01 -07001949 // TODO: add comment and adjust size as needed
Glenn Kasten6dbb5e32014-05-13 10:38:42 -07001950 static const size_t kFastCaptureLogSize = 4 * 1024;
1951 sp<NBLog::Writer> mFastCaptureNBLogWriter;
1952
1953 bool mFastTrackAvail; // true if fast track available
Eric Laurentd8365c52017-07-16 15:27:05 -07001954 // common state to all record threads
1955 std::atomic_bool mBtNrecSuspended;
Andy Hung6427e442018-08-09 12:51:02 -07001956
1957 int64_t mFramesRead = 0; // continuous running counter.
jiabinc52b1ff2019-10-31 17:20:42 -07001958
1959 DeviceDescriptorBaseVector mOutDevices;
Eric Laurentec376dc2021-04-08 20:41:22 +02001960
Eric Laurent5f0fd7b2021-05-07 16:33:26 +02001961 int32_t mMaxSharedAudioHistoryMs = 0;
Eric Laurentec376dc2021-04-08 20:41:22 +02001962 std::string mSharedAudioPackageName = {};
Eric Laurent2407ce32021-04-26 14:56:03 +02001963 int32_t mSharedAudioStartFrames = -1;
Eric Laurentec376dc2021-04-08 20:41:22 +02001964 audio_session_t mSharedAudioSessionId = AUDIO_SESSION_NONE;
Eric Laurent81784c32012-11-19 14:55:58 -08001965};
Eric Laurent6acd1d42017-01-04 14:23:29 -08001966
1967class MmapThread : public ThreadBase
1968{
1969 public:
1970
1971#include "MmapTracks.h"
1972
1973 MmapThread(const sp<AudioFlinger>& audioFlinger, audio_io_handle_t id,
Andy Hungcf10d742020-04-28 15:38:24 -07001974 AudioHwDevice *hwDev, sp<StreamHalInterface> stream, bool systemReady,
1975 bool isOut);
Eric Laurent6acd1d42017-01-04 14:23:29 -08001976 virtual ~MmapThread();
1977
1978 virtual void configure(const audio_attributes_t *attr,
1979 audio_stream_type_t streamType,
1980 audio_session_t sessionId,
1981 const sp<MmapStreamCallback>& callback,
Eric Laurent7aa0ccb2017-08-28 11:12:52 -07001982 audio_port_handle_t deviceId,
Eric Laurent6acd1d42017-01-04 14:23:29 -08001983 audio_port_handle_t portId);
1984
1985 void disconnect();
1986
1987 // MmapStreamInterface
1988 status_t createMmapBuffer(int32_t minSizeFrames,
1989 struct audio_mmap_buffer_info *info);
1990 status_t getMmapPosition(struct audio_mmap_position *position);
jiabind1f1cb62020-03-24 11:57:57 -07001991 status_t start(const AudioClient& client,
1992 const audio_attributes_t *attr,
1993 audio_port_handle_t *handle);
Eric Laurent6acd1d42017-01-04 14:23:29 -08001994 status_t stop(audio_port_handle_t handle);
Eric Laurent18b57012017-02-13 16:23:52 -08001995 status_t standby();
jiabinb7d8c5a2020-08-26 17:24:52 -07001996 virtual status_t getExternalPosition(uint64_t *position, int64_t *timeNaos) = 0;
Eric Laurent6acd1d42017-01-04 14:23:29 -08001997
1998 // RefBase
1999 virtual void onFirstRef();
2000
2001 // Thread virtuals
2002 virtual bool threadLoop();
2003
2004 virtual void threadLoop_exit();
2005 virtual void threadLoop_standby();
Eric Laurent18b57012017-02-13 16:23:52 -08002006 virtual bool shouldStandby_l() { return false; }
Eric Laurent331679c2018-04-16 17:03:16 -07002007 virtual status_t exitStandby();
Eric Laurent6acd1d42017-01-04 14:23:29 -08002008
2009 virtual status_t initCheck() const { return (mHalStream == 0) ? NO_INIT : NO_ERROR; }
2010 virtual size_t frameCount() const { return mFrameCount; }
2011 virtual bool checkForNewParameter_l(const String8& keyValuePair,
2012 status_t& status);
2013 virtual String8 getParameters(const String8& keys);
Mikhail Naganov88536df2021-07-26 17:30:29 -07002014 virtual void ioConfigChanged(audio_io_config_event_t event, pid_t pid = 0,
Eric Laurent09f1ed22019-04-24 17:45:17 -07002015 audio_port_handle_t portId = AUDIO_PORT_HANDLE_NONE);
Eric Laurent6acd1d42017-01-04 14:23:29 -08002016 void readHalParameters_l();
2017 virtual void cacheParameters_l() {}
2018 virtual status_t createAudioPatch_l(const struct audio_patch *patch,
2019 audio_patch_handle_t *handle);
2020 virtual status_t releaseAudioPatch_l(const audio_patch_handle_t handle);
Mikhail Naganovdc769682018-05-04 15:34:08 -07002021 virtual void toAudioPortConfig(struct audio_port_config *config);
Eric Laurent6acd1d42017-01-04 14:23:29 -08002022
2023 virtual sp<StreamHalInterface> stream() const { return mHalStream; }
2024 virtual status_t addEffectChain_l(const sp<EffectChain>& chain);
2025 virtual size_t removeEffectChain_l(const sp<EffectChain>& chain);
2026 virtual status_t checkEffectCompatibility_l(const effect_descriptor_t *desc,
2027 audio_session_t sessionId);
2028
Andy Hungc3d62f92019-03-14 13:38:51 -07002029 uint32_t hasAudioSession_l(audio_session_t sessionId) const override {
2030 // Note: using mActiveTracks as no mTracks here.
2031 return ThreadBase::hasAudioSession_l(sessionId, mActiveTracks);
2032 }
Eric Laurent6acd1d42017-01-04 14:23:29 -08002033 virtual status_t setSyncEvent(const sp<SyncEvent>& event);
2034 virtual bool isValidSyncEvent(const sp<SyncEvent>& event) const;
2035
2036 virtual void checkSilentMode_l() {}
2037 virtual void processVolume_l() {}
2038 void checkInvalidTracks_l();
2039
2040 virtual audio_stream_type_t streamType() { return AUDIO_STREAM_DEFAULT; }
2041
2042 virtual void invalidateTracks(audio_stream_type_t streamType __unused) {}
2043
Eric Laurent331679c2018-04-16 17:03:16 -07002044 // Sets the UID records silence
Eric Laurent5ada82e2019-08-29 17:53:54 -07002045 virtual void setRecordSilenced(audio_port_handle_t portId __unused,
2046 bool silenced __unused) {}
Eric Laurent331679c2018-04-16 17:03:16 -07002047
Jasmine Chaeaa10e42021-05-11 10:11:14 +08002048 virtual bool isStreamInitialized() { return false; }
2049
Eric Laurent6acd1d42017-01-04 14:23:29 -08002050 protected:
Mikhail Naganov01dc5ca2019-03-29 10:12:12 -07002051 void dumpInternals_l(int fd, const Vector<String16>& args) override;
2052 void dumpTracks_l(int fd, const Vector<String16>& args) override;
Eric Laurent6acd1d42017-01-04 14:23:29 -08002053
jiabinc52b1ff2019-10-31 17:20:42 -07002054 /**
2055 * @brief mDeviceId current device port unique identifier
2056 */
2057 audio_port_handle_t mDeviceId = AUDIO_PORT_HANDLE_NONE;
2058
Eric Laurent6acd1d42017-01-04 14:23:29 -08002059 audio_attributes_t mAttr;
2060 audio_session_t mSessionId;
2061 audio_port_handle_t mPortId;
2062
Phil Burk7f6b40d2017-02-09 13:18:38 -08002063 wp<MmapStreamCallback> mCallback;
Eric Laurent6acd1d42017-01-04 14:23:29 -08002064 sp<StreamHalInterface> mHalStream;
2065 sp<DeviceHalInterface> mHalDevice;
2066 AudioHwDevice* const mAudioHwDev;
2067 ActiveTracks<MmapTrack> mActiveTracks;
Eric Laurent67f97292018-04-20 18:05:41 -07002068 float mHalVolFloat;
Eric Laurent331679c2018-04-16 17:03:16 -07002069
2070 int32_t mNoCallbackWarningCount;
2071 static constexpr int32_t kMaxNoCallbackWarnings = 5;
Eric Laurent6acd1d42017-01-04 14:23:29 -08002072};
2073
2074class MmapPlaybackThread : public MmapThread, public VolumeInterface
2075{
2076
2077public:
2078 MmapPlaybackThread(const sp<AudioFlinger>& audioFlinger, audio_io_handle_t id,
jiabinc52b1ff2019-10-31 17:20:42 -07002079 AudioHwDevice *hwDev, AudioStreamOut *output, bool systemReady);
Eric Laurent6acd1d42017-01-04 14:23:29 -08002080 virtual ~MmapPlaybackThread() {}
2081
2082 virtual void configure(const audio_attributes_t *attr,
2083 audio_stream_type_t streamType,
2084 audio_session_t sessionId,
2085 const sp<MmapStreamCallback>& callback,
Eric Laurent7aa0ccb2017-08-28 11:12:52 -07002086 audio_port_handle_t deviceId,
Eric Laurent6acd1d42017-01-04 14:23:29 -08002087 audio_port_handle_t portId);
2088
2089 AudioStreamOut* clearOutput();
2090
2091 // VolumeInterface
2092 virtual void setMasterVolume(float value);
2093 virtual void setMasterMute(bool muted);
2094 virtual void setStreamVolume(audio_stream_type_t stream, float value);
2095 virtual void setStreamMute(audio_stream_type_t stream, bool muted);
2096 virtual float streamVolume(audio_stream_type_t stream) const;
2097
2098 void setMasterMute_l(bool muted) { mMasterMute = muted; }
2099
2100 virtual void invalidateTracks(audio_stream_type_t streamType);
2101
2102 virtual audio_stream_type_t streamType() { return mStreamType; }
2103 virtual void checkSilentMode_l();
Eric Laurent331679c2018-04-16 17:03:16 -07002104 void processVolume_l() override;
Eric Laurent6acd1d42017-01-04 14:23:29 -08002105
Kevin Rocard069c2712018-03-29 19:09:14 -07002106 void updateMetadata_l() override;
2107
Mikhail Naganov32abc2b2018-05-24 12:57:11 -07002108 virtual void toAudioPortConfig(struct audio_port_config *config);
2109
jiabinb7d8c5a2020-08-26 17:24:52 -07002110 status_t getExternalPosition(uint64_t *position, int64_t *timeNanos) override;
2111
Jasmine Chaeaa10e42021-05-11 10:11:14 +08002112 virtual bool isStreamInitialized() {
2113 return !(mOutput == nullptr || mOutput->stream == nullptr);
2114 }
2115
Eric Laurent6acd1d42017-01-04 14:23:29 -08002116protected:
Mikhail Naganov01dc5ca2019-03-29 10:12:12 -07002117 void dumpInternals_l(int fd, const Vector<String16>& args) override;
Eric Laurent6acd1d42017-01-04 14:23:29 -08002118
2119 audio_stream_type_t mStreamType;
2120 float mMasterVolume;
2121 float mStreamVolume;
2122 bool mMasterMute;
2123 bool mStreamMute;
Eric Laurent6acd1d42017-01-04 14:23:29 -08002124 AudioStreamOut* mOutput;
2125};
2126
2127class MmapCaptureThread : public MmapThread
2128{
2129
2130public:
2131 MmapCaptureThread(const sp<AudioFlinger>& audioFlinger, audio_io_handle_t id,
jiabinc52b1ff2019-10-31 17:20:42 -07002132 AudioHwDevice *hwDev, AudioStreamIn *input, bool systemReady);
Eric Laurent6acd1d42017-01-04 14:23:29 -08002133 virtual ~MmapCaptureThread() {}
2134
2135 AudioStreamIn* clearInput();
2136
Eric Laurent331679c2018-04-16 17:03:16 -07002137 status_t exitStandby() override;
Eric Laurent6acd1d42017-01-04 14:23:29 -08002138
Kevin Rocard069c2712018-03-29 19:09:14 -07002139 void updateMetadata_l() override;
Eric Laurent331679c2018-04-16 17:03:16 -07002140 void processVolume_l() override;
Eric Laurent5ada82e2019-08-29 17:53:54 -07002141 void setRecordSilenced(audio_port_handle_t portId,
2142 bool silenced) override;
Kevin Rocard069c2712018-03-29 19:09:14 -07002143
Mikhail Naganov32abc2b2018-05-24 12:57:11 -07002144 virtual void toAudioPortConfig(struct audio_port_config *config);
2145
jiabinb7d8c5a2020-08-26 17:24:52 -07002146 status_t getExternalPosition(uint64_t *position, int64_t *timeNanos) override;
2147
Jasmine Chaeaa10e42021-05-11 10:11:14 +08002148 virtual bool isStreamInitialized() {
2149 return !(mInput == nullptr || mInput->stream == nullptr);
2150 }
2151
Eric Laurent6acd1d42017-01-04 14:23:29 -08002152protected:
2153
2154 AudioStreamIn* mInput;
2155};