blob: 14c45f766a77564a3817925a0d5b53c03f220a49 [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
19#define LOG_TAG "AudioFlinger"
20//#define LOG_NDEBUG 0
Mikhail Naganov938be412019-09-04 11:38:47 -070021#define ATRACE_TAG ATRACE_TAG_AUDIO
Eric Laurent81784c32012-11-19 14:55:58 -080022
Glenn Kasten153b9fe2013-07-15 11:23:36 -070023#include "Configuration.h"
Glenn Kastenad8510a2015-02-17 16:24:07 -080024#include <linux/futex.h>
Eric Laurent81784c32012-11-19 14:55:58 -080025#include <math.h>
Elliott Hughesee499292014-05-21 17:55:51 -070026#include <sys/syscall.h>
Eric Laurent81784c32012-11-19 14:55:58 -080027#include <utils/Log.h>
Mikhail Naganov938be412019-09-04 11:38:47 -070028#include <utils/Trace.h>
Eric Laurent81784c32012-11-19 14:55:58 -080029
30#include <private/media/AudioTrackShared.h>
31
Eric Laurent81784c32012-11-19 14:55:58 -080032#include "AudioFlinger.h"
Eric Laurent81784c32012-11-19 14:55:58 -080033
Glenn Kastenda6ef132013-01-10 12:31:01 -080034#include <media/nbaio/Pipe.h>
35#include <media/nbaio/PipeReader.h>
Kuowei Lid4adbdb2020-08-13 14:44:25 +080036#include <media/AudioValidator.h>
Andy Hung89816052017-01-11 17:08:23 -080037#include <media/RecordBufferConverter.h>
Andy Hungab7ef302018-05-15 19:35:29 -070038#include <mediautils/ServiceUtilities.h>
Glenn Kastenc56f3422014-03-21 17:53:17 -070039#include <audio_utils/minifloat.h>
Glenn Kastenda6ef132013-01-10 12:31:01 -080040
Eric Laurent81784c32012-11-19 14:55:58 -080041// ----------------------------------------------------------------------------
42
43// Note: the following macro is used for extremely verbose logging message. In
44// order to run with ALOG_ASSERT turned on, we need to have LOG_NDEBUG set to
45// 0; but one side effect of this is to turn all LOGV's as well. Some messages
46// are so verbose that we want to suppress them even when we have ALOG_ASSERT
47// turned on. Do not uncomment the #def below unless you really know what you
48// are doing and want to see all of the extremely verbose messages.
49//#define VERY_VERY_VERBOSE_LOGGING
50#ifdef VERY_VERY_VERBOSE_LOGGING
51#define ALOGVV ALOGV
52#else
53#define ALOGVV(a...) do { } while(0)
54#endif
55
Kuowei Lid4adbdb2020-08-13 14:44:25 +080056// TODO: Remove when this is put into AidlConversionUtil.h
57#define VALUE_OR_RETURN_BINDER_STATUS(x) \
58 ({ \
59 auto _tmp = (x); \
60 if (!_tmp.ok()) return ::android::aidl_utils::binderStatusFromStatusT(_tmp.error()); \
61 std::move(_tmp.value()); \
62 })
63
Eric Laurent81784c32012-11-19 14:55:58 -080064namespace android {
65
Kuowei Lid4adbdb2020-08-13 14:44:25 +080066using ::android::aidl_utils::binderStatusFromStatusT;
Ytai Ben-Tsvibdc293a2020-11-02 17:01:38 -080067using binder::Status;
Svet Ganov33761132021-05-13 22:51:08 +000068using content::AttributionSourceState;
Ivan Lozano8cf3a072017-08-09 09:01:33 -070069using media::VolumeShaper;
Eric Laurent81784c32012-11-19 14:55:58 -080070// ----------------------------------------------------------------------------
71// TrackBase
72// ----------------------------------------------------------------------------
Andy Hung9d84af52018-09-12 18:03:44 -070073#undef LOG_TAG
74#define LOG_TAG "AF::TrackBase"
Eric Laurent81784c32012-11-19 14:55:58 -080075
Glenn Kastenda6ef132013-01-10 12:31:01 -080076static volatile int32_t nextTrackId = 55;
77
Eric Laurent81784c32012-11-19 14:55:58 -080078// TrackBase constructor must be called with AudioFlinger::mLock held
79AudioFlinger::ThreadBase::TrackBase::TrackBase(
80 ThreadBase *thread,
81 const sp<Client>& client,
Kevin Rocard1f564ac2018-03-29 13:53:10 -070082 const audio_attributes_t& attr,
Eric Laurent81784c32012-11-19 14:55:58 -080083 uint32_t sampleRate,
84 audio_format_t format,
85 audio_channel_mask_t channelMask,
86 size_t frameCount,
Eric Laurent83b88082014-06-20 18:31:16 -070087 void *buffer,
Andy Hung8fe68032017-06-05 16:17:51 -070088 size_t bufferSize,
Glenn Kastend848eb42016-03-08 13:42:11 -080089 audio_session_t sessionId,
Eric Laurent09f1ed22019-04-24 17:45:17 -070090 pid_t creatorPid,
Andy Hung1f12a8a2016-11-07 16:10:30 -080091 uid_t clientUid,
Glenn Kastend776ac62014-05-07 09:16:09 -070092 bool isOut,
Dmitry Sidorenkova41c2732023-05-15 13:47:07 -070093 const alloc_type alloc,
Eric Laurent20b9ef02016-12-05 11:03:16 -080094 track_type type,
Andy Hungb68f5eb2019-12-03 16:49:17 -080095 audio_port_handle_t portId,
96 std::string metricsId)
Eric Laurent81784c32012-11-19 14:55:58 -080097 : RefBase(),
98 mThread(thread),
Dmitry Sidorenkova41c2732023-05-15 13:47:07 -070099 mAllocType(alloc),
Eric Laurent81784c32012-11-19 14:55:58 -0800100 mClient(client),
101 mCblk(NULL),
Andy Hung8fe68032017-06-05 16:17:51 -0700102 // mBuffer, mBufferSize
Eric Laurent81784c32012-11-19 14:55:58 -0800103 mState(IDLE),
Kevin Rocard1f564ac2018-03-29 13:53:10 -0700104 mAttr(attr),
Eric Laurent81784c32012-11-19 14:55:58 -0800105 mSampleRate(sampleRate),
106 mFormat(format),
107 mChannelMask(channelMask),
Andy Hunge5412692014-05-16 11:25:07 -0700108 mChannelCount(isOut ?
109 audio_channel_count_from_out_mask(channelMask) :
110 audio_channel_count_from_in_mask(channelMask)),
Phil Burkfdb3c072016-02-09 10:47:02 -0800111 mFrameSize(audio_has_proportional_frames(format) ?
Eric Laurent81784c32012-11-19 14:55:58 -0800112 mChannelCount * audio_bytes_per_sample(format) : sizeof(int8_t)),
113 mFrameCount(frameCount),
Glenn Kastene3aa6592012-12-04 12:22:46 -0800114 mSessionId(sessionId),
115 mIsOut(isOut),
Eric Laurentbfb1b832013-01-07 09:53:42 -0800116 mId(android_atomic_inc(&nextTrackId)),
Eric Laurent83b88082014-06-20 18:31:16 -0700117 mTerminated(false),
Eric Laurentaaa44472014-09-12 17:41:50 -0700118 mType(type),
Kevin Rocard153f92d2018-12-18 18:33:28 -0800119 mThreadIoHandle(thread ? thread->id() : AUDIO_IO_HANDLE_NONE),
Eric Laurent6acd1d42017-01-04 14:23:29 -0800120 mPortId(portId),
Eric Laurent09f1ed22019-04-24 17:45:17 -0700121 mIsInvalid(false),
Andy Hungc2b11cb2020-04-22 09:04:01 -0700122 mTrackMetrics(std::move(metricsId), isOut),
Eric Laurent09f1ed22019-04-24 17:45:17 -0700123 mCreatorPid(creatorPid)
Eric Laurent81784c32012-11-19 14:55:58 -0800124{
Marco Nelissendcb346b2015-09-09 10:47:29 -0700125 const uid_t callingUid = IPCThreadState::self()->getCallingUid();
Andy Hung4ef19fa2018-05-15 19:35:29 -0700126 if (!isAudioServerOrMediaServerUid(callingUid) || clientUid == AUDIO_UID_INVALID) {
Andy Hung1f12a8a2016-11-07 16:10:30 -0800127 ALOGW_IF(clientUid != AUDIO_UID_INVALID && clientUid != callingUid,
Andy Hung9d84af52018-09-12 18:03:44 -0700128 "%s(%d): uid %d tried to pass itself off as %d",
129 __func__, mId, callingUid, clientUid);
Andy Hung1f12a8a2016-11-07 16:10:30 -0800130 clientUid = callingUid;
Marco Nelissen462fd2f2013-01-14 14:12:05 -0800131 }
132 // clientUid contains the uid of the app that is responsible for this track, so we can blame
133 // battery usage on it.
134 mUid = clientUid;
135
Eric Laurent81784c32012-11-19 14:55:58 -0800136 // ALOGD("Creating track with %d buffers @ %d bytes", bufferCount, bufferSize);
Andy Hung1883f692017-02-13 18:48:39 -0800137
Andy Hung8fe68032017-06-05 16:17:51 -0700138 size_t minBufferSize = buffer == NULL ? roundup(frameCount) : frameCount;
Andy Hung1883f692017-02-13 18:48:39 -0800139 // check overflow when computing bufferSize due to multiplication by mFrameSize.
Andy Hung8fe68032017-06-05 16:17:51 -0700140 if (minBufferSize < frameCount // roundup rounds down for values above UINT_MAX / 2
Andy Hung1883f692017-02-13 18:48:39 -0800141 || mFrameSize == 0 // format needs to be correct
Andy Hung8fe68032017-06-05 16:17:51 -0700142 || minBufferSize > SIZE_MAX / mFrameSize) {
Andy Hung1883f692017-02-13 18:48:39 -0800143 android_errorWriteLog(0x534e4554, "34749571");
144 return;
145 }
Andy Hung8fe68032017-06-05 16:17:51 -0700146 minBufferSize *= mFrameSize;
147
148 if (buffer == nullptr) {
149 bufferSize = minBufferSize; // allocated here.
150 } else if (minBufferSize > bufferSize) {
151 android_errorWriteLog(0x534e4554, "38340117");
152 return;
153 }
Andy Hung1883f692017-02-13 18:48:39 -0800154
Eric Laurent81784c32012-11-19 14:55:58 -0800155 size_t size = sizeof(audio_track_cblk_t);
Eric Laurent83b88082014-06-20 18:31:16 -0700156 if (buffer == NULL && alloc == ALLOC_CBLK) {
Andy Hung1883f692017-02-13 18:48:39 -0800157 // check overflow when computing allocation size for streaming tracks.
158 if (size > SIZE_MAX - bufferSize) {
159 android_errorWriteLog(0x534e4554, "34749571");
160 return;
161 }
Eric Laurent81784c32012-11-19 14:55:58 -0800162 size += bufferSize;
163 }
164
165 if (client != 0) {
166 mCblkMemory = client->heap()->allocate(size);
Glenn Kasten663c2242013-09-24 11:52:37 -0700167 if (mCblkMemory == 0 ||
Ytai Ben-Tsvi7dd39722019-09-05 15:14:30 -0700168 (mCblk = static_cast<audio_track_cblk_t *>(mCblkMemory->unsecurePointer())) == NULL) {
Andy Hung9d84af52018-09-12 18:03:44 -0700169 ALOGE("%s(%d): not enough memory for AudioTrack size=%zu", __func__, mId, size);
Eric Laurent81784c32012-11-19 14:55:58 -0800170 client->heap()->dump("AudioTrack");
Glenn Kasten663c2242013-09-24 11:52:37 -0700171 mCblkMemory.clear();
Eric Laurent81784c32012-11-19 14:55:58 -0800172 return;
173 }
174 } else {
Andy Hungafb31482017-02-13 18:50:48 -0800175 mCblk = (audio_track_cblk_t *) malloc(size);
176 if (mCblk == NULL) {
Andy Hung9d84af52018-09-12 18:03:44 -0700177 ALOGE("%s(%d): not enough memory for AudioTrack size=%zu", __func__, mId, size);
Andy Hungafb31482017-02-13 18:50:48 -0800178 return;
179 }
Eric Laurent81784c32012-11-19 14:55:58 -0800180 }
181
182 // construct the shared structure in-place.
183 if (mCblk != NULL) {
184 new(mCblk) audio_track_cblk_t();
Glenn Kastenc263ca02014-06-04 20:31:46 -0700185 switch (alloc) {
186 case ALLOC_READONLY: {
Glenn Kastend776ac62014-05-07 09:16:09 -0700187 const sp<MemoryDealer> roHeap(thread->readOnlyHeap());
188 if (roHeap == 0 ||
189 (mBufferMemory = roHeap->allocate(bufferSize)) == 0 ||
Ytai Ben-Tsvi7dd39722019-09-05 15:14:30 -0700190 (mBuffer = mBufferMemory->unsecurePointer()) == NULL) {
Andy Hung9d84af52018-09-12 18:03:44 -0700191 ALOGE("%s(%d): not enough memory for read-only buffer size=%zu",
192 __func__, mId, bufferSize);
Glenn Kastend776ac62014-05-07 09:16:09 -0700193 if (roHeap != 0) {
194 roHeap->dump("buffer");
195 }
196 mCblkMemory.clear();
197 mBufferMemory.clear();
198 return;
199 }
Eric Laurent81784c32012-11-19 14:55:58 -0800200 memset(mBuffer, 0, bufferSize);
Glenn Kastenc263ca02014-06-04 20:31:46 -0700201 } break;
202 case ALLOC_PIPE:
203 mBufferMemory = thread->pipeMemory();
204 // mBuffer is the virtual address as seen from current process (mediaserver),
Ytai Ben-Tsvi7dd39722019-09-05 15:14:30 -0700205 // and should normally be coming from mBufferMemory->unsecurePointer().
Glenn Kastenc263ca02014-06-04 20:31:46 -0700206 // However in this case the TrackBase does not reference the buffer directly.
207 // It should references the buffer via the pipe.
208 // Therefore, to detect incorrect usage of the buffer, we set mBuffer to NULL.
209 mBuffer = NULL;
Andy Hung8fe68032017-06-05 16:17:51 -0700210 bufferSize = 0;
Glenn Kastenc263ca02014-06-04 20:31:46 -0700211 break;
212 case ALLOC_CBLK:
Glenn Kastend776ac62014-05-07 09:16:09 -0700213 // clear all buffers
Eric Laurent83b88082014-06-20 18:31:16 -0700214 if (buffer == NULL) {
Glenn Kastend776ac62014-05-07 09:16:09 -0700215 mBuffer = (char*)mCblk + sizeof(audio_track_cblk_t);
216 memset(mBuffer, 0, bufferSize);
217 } else {
Eric Laurent83b88082014-06-20 18:31:16 -0700218 mBuffer = buffer;
Glenn Kasten9f80dd22012-12-18 15:57:32 -0800219#if 0
Glenn Kastend776ac62014-05-07 09:16:09 -0700220 mCblk->mFlags = CBLK_FORCEREADY; // FIXME hack, need to fix the track ready logic
Glenn Kasten9f80dd22012-12-18 15:57:32 -0800221#endif
Glenn Kastend776ac62014-05-07 09:16:09 -0700222 }
Glenn Kastenc263ca02014-06-04 20:31:46 -0700223 break;
Eric Laurent83b88082014-06-20 18:31:16 -0700224 case ALLOC_LOCAL:
225 mBuffer = calloc(1, bufferSize);
226 break;
227 case ALLOC_NONE:
228 mBuffer = buffer;
229 break;
Andy Hung8fe68032017-06-05 16:17:51 -0700230 default:
Andy Hung9d84af52018-09-12 18:03:44 -0700231 LOG_ALWAYS_FATAL("%s(%d): invalid allocation type: %d", __func__, mId, (int)alloc);
Eric Laurent81784c32012-11-19 14:55:58 -0800232 }
Andy Hung8fe68032017-06-05 16:17:51 -0700233 mBufferSize = bufferSize;
Glenn Kastenda6ef132013-01-10 12:31:01 -0800234
Glenn Kasten46909e72013-02-26 09:20:22 -0800235#ifdef TEE_SINK
Andy Hung8946a282018-04-19 20:04:56 -0700236 mTee.set(sampleRate, mChannelCount, format, NBAIO_Tee::TEE_FLAG_TRACK);
Glenn Kasten46909e72013-02-26 09:20:22 -0800237#endif
Andy Hung959b5b82021-09-24 10:46:20 -0700238 // mState is mirrored for the client to read.
239 mState.setMirror(&mCblk->mState);
240 // ensure our state matches up until we consolidate the enumeration.
241 static_assert(CBLK_STATE_IDLE == IDLE);
242 static_assert(CBLK_STATE_PAUSING == PAUSING);
Eric Laurent81784c32012-11-19 14:55:58 -0800243 }
244}
245
Svet Ganov33761132021-05-13 22:51:08 +0000246// TODO b/182392769: use attribution source util
247static AttributionSourceState audioServerAttributionSource(pid_t pid) {
248 AttributionSourceState attributionSource{};
249 attributionSource.uid = AID_AUDIOSERVER;
250 attributionSource.pid = pid;
251 attributionSource.token = sp<BBinder>::make();
252 return attributionSource;
Philip P. Moltmannbda45752020-07-17 16:41:18 -0700253}
254
Eric Laurent83b88082014-06-20 18:31:16 -0700255status_t AudioFlinger::ThreadBase::TrackBase::initCheck() const
256{
257 status_t status;
258 if (mType == TYPE_OUTPUT || mType == TYPE_PATCH) {
259 status = cblk() != NULL ? NO_ERROR : NO_MEMORY;
260 } else {
261 status = getCblk() != 0 ? NO_ERROR : NO_MEMORY;
262 }
263 return status;
264}
265
Eric Laurent81784c32012-11-19 14:55:58 -0800266AudioFlinger::ThreadBase::TrackBase::~TrackBase()
267{
Glenn Kastene3aa6592012-12-04 12:22:46 -0800268 // delete the proxy before deleting the shared memory it refers to, to avoid dangling reference
Eric Laurent5bba2f62016-03-18 11:14:14 -0700269 mServerProxy.clear();
Andy Hung689e82c2019-08-21 17:53:17 -0700270 releaseCblk();
Eric Laurent81784c32012-11-19 14:55:58 -0800271 mCblkMemory.clear(); // free the shared memory before releasing the heap it belongs to
272 if (mClient != 0) {
Eric Laurent021cf962014-05-13 10:18:14 -0700273 // Client destructor must run with AudioFlinger client mutex locked
274 Mutex::Autolock _l(mClient->audioFlinger()->mClientLock);
Eric Laurent81784c32012-11-19 14:55:58 -0800275 // If the client's reference count drops to zero, the associated destructor
276 // must run with AudioFlinger lock held. Thus the explicit clear() rather than
277 // relying on the automatic clear() at end of scope.
278 mClient.clear();
279 }
Dmitry Sidorenkova41c2732023-05-15 13:47:07 -0700280 if (mAllocType == ALLOC_LOCAL) {
281 free(mBuffer);
282 mBuffer = nullptr;
283 }
Eric Laurent3bcffa12014-06-12 18:38:45 -0700284 // flush the binder command buffer
285 IPCThreadState::self()->flushCommands();
Eric Laurent81784c32012-11-19 14:55:58 -0800286}
287
288// AudioBufferProvider interface
289// getNextBuffer() = 0;
Glenn Kastend79072e2016-01-06 08:41:20 -0800290// This implementation of releaseBuffer() is used by Track and RecordTrack
Eric Laurent81784c32012-11-19 14:55:58 -0800291void AudioFlinger::ThreadBase::TrackBase::releaseBuffer(AudioBufferProvider::Buffer* buffer)
292{
Glenn Kasten46909e72013-02-26 09:20:22 -0800293#ifdef TEE_SINK
Andy Hung8946a282018-04-19 20:04:56 -0700294 mTee.write(buffer->raw, buffer->frameCount);
Glenn Kasten46909e72013-02-26 09:20:22 -0800295#endif
Glenn Kastenda6ef132013-01-10 12:31:01 -0800296
Glenn Kasten9f80dd22012-12-18 15:57:32 -0800297 ServerProxy::Buffer buf;
298 buf.mFrameCount = buffer->frameCount;
299 buf.mRaw = buffer->raw;
Eric Laurent81784c32012-11-19 14:55:58 -0800300 buffer->frameCount = 0;
Glenn Kasten9f80dd22012-12-18 15:57:32 -0800301 buffer->raw = NULL;
302 mServerProxy->releaseBuffer(&buf);
Eric Laurent81784c32012-11-19 14:55:58 -0800303}
304
Andy Hung068e08e2023-05-15 19:02:55 -0700305status_t AudioFlinger::ThreadBase::TrackBase::setSyncEvent(
306 const sp<audioflinger::SyncEvent>& event)
Eric Laurent81784c32012-11-19 14:55:58 -0800307{
Andy Hung068e08e2023-05-15 19:02:55 -0700308 mSyncEvents.emplace_back(event);
Eric Laurent81784c32012-11-19 14:55:58 -0800309 return NO_ERROR;
310}
311
Andy Hung71ba4b32022-10-06 12:09:49 -0700312AudioFlinger::ThreadBase::PatchTrackBase::PatchTrackBase(const sp<ClientProxy>& proxy,
Kevin Rocard45986c72018-12-18 18:22:59 -0800313 const ThreadBase& thread,
314 const Timeout& timeout)
315 : mProxy(proxy)
316{
317 if (timeout) {
318 setPeerTimeout(*timeout);
319 } else {
320 // Double buffer mixer
321 uint64_t mixBufferNs = ((uint64_t)2 * thread.frameCount() * 1000000000) /
322 thread.sampleRate();
323 setPeerTimeout(std::chrono::nanoseconds{mixBufferNs});
324 }
325}
326
327void AudioFlinger::ThreadBase::PatchTrackBase::setPeerTimeout(std::chrono::nanoseconds timeout) {
328 mPeerTimeout.tv_sec = timeout.count() / std::nano::den;
329 mPeerTimeout.tv_nsec = timeout.count() % std::nano::den;
330}
331
332
Eric Laurent81784c32012-11-19 14:55:58 -0800333// ----------------------------------------------------------------------------
334// Playback
335// ----------------------------------------------------------------------------
Andy Hung9d84af52018-09-12 18:03:44 -0700336#undef LOG_TAG
337#define LOG_TAG "AF::TrackHandle"
Eric Laurent81784c32012-11-19 14:55:58 -0800338
339AudioFlinger::TrackHandle::TrackHandle(const sp<AudioFlinger::PlaybackThread::Track>& track)
340 : BnAudioTrack(),
341 mTrack(track)
342{
Andy Hung225aef62022-12-06 16:33:20 -0800343 setMinSchedulerPolicy(SCHED_NORMAL, ANDROID_PRIORITY_AUDIO);
Eric Laurent81784c32012-11-19 14:55:58 -0800344}
345
346AudioFlinger::TrackHandle::~TrackHandle() {
347 // just stop the track on deletion, associated resources
348 // will be freed from the main thread once all pending buffers have
349 // been played. Unless it's not in the active track list, in which
350 // case we free everything now...
351 mTrack->destroy();
352}
353
Ytai Ben-Tsvibdc293a2020-11-02 17:01:38 -0800354Status AudioFlinger::TrackHandle::getCblk(
355 std::optional<media::SharedFileRegion>* _aidl_return) {
356 *_aidl_return = legacy2aidl_NullableIMemory_SharedFileRegion(mTrack->getCblk()).value();
357 return Status::ok();
Eric Laurent81784c32012-11-19 14:55:58 -0800358}
359
Ytai Ben-Tsvibdc293a2020-11-02 17:01:38 -0800360Status AudioFlinger::TrackHandle::start(int32_t* _aidl_return) {
361 *_aidl_return = mTrack->start();
362 return Status::ok();
Eric Laurent81784c32012-11-19 14:55:58 -0800363}
364
Ytai Ben-Tsvibdc293a2020-11-02 17:01:38 -0800365Status AudioFlinger::TrackHandle::stop() {
Eric Laurent81784c32012-11-19 14:55:58 -0800366 mTrack->stop();
Ytai Ben-Tsvibdc293a2020-11-02 17:01:38 -0800367 return Status::ok();
Eric Laurent81784c32012-11-19 14:55:58 -0800368}
369
Ytai Ben-Tsvibdc293a2020-11-02 17:01:38 -0800370Status AudioFlinger::TrackHandle::flush() {
Eric Laurent81784c32012-11-19 14:55:58 -0800371 mTrack->flush();
Ytai Ben-Tsvibdc293a2020-11-02 17:01:38 -0800372 return Status::ok();
Eric Laurent81784c32012-11-19 14:55:58 -0800373}
374
Ytai Ben-Tsvibdc293a2020-11-02 17:01:38 -0800375Status AudioFlinger::TrackHandle::pause() {
Eric Laurent81784c32012-11-19 14:55:58 -0800376 mTrack->pause();
Ytai Ben-Tsvibdc293a2020-11-02 17:01:38 -0800377 return Status::ok();
Eric Laurent81784c32012-11-19 14:55:58 -0800378}
379
Ytai Ben-Tsvibdc293a2020-11-02 17:01:38 -0800380Status AudioFlinger::TrackHandle::attachAuxEffect(int32_t effectId,
381 int32_t* _aidl_return) {
382 *_aidl_return = mTrack->attachAuxEffect(effectId);
383 return Status::ok();
Eric Laurent81784c32012-11-19 14:55:58 -0800384}
385
Ytai Ben-Tsvibdc293a2020-11-02 17:01:38 -0800386Status AudioFlinger::TrackHandle::setParameters(const std::string& keyValuePairs,
387 int32_t* _aidl_return) {
388 *_aidl_return = mTrack->setParameters(String8(keyValuePairs.c_str()));
389 return Status::ok();
Glenn Kasten3dcd00d2013-07-17 10:10:23 -0700390}
391
Ytai Ben-Tsvibdc293a2020-11-02 17:01:38 -0800392Status AudioFlinger::TrackHandle::selectPresentation(int32_t presentationId, int32_t programId,
393 int32_t* _aidl_return) {
394 *_aidl_return = mTrack->selectPresentation(presentationId, programId);
395 return Status::ok();
Mikhail Naganovac917ac2018-11-28 14:03:52 -0800396}
397
Ytai Ben-Tsvibdc293a2020-11-02 17:01:38 -0800398Status AudioFlinger::TrackHandle::getTimestamp(media::AudioTimestampInternal* timestamp,
399 int32_t* _aidl_return) {
400 AudioTimestamp legacy;
401 *_aidl_return = mTrack->getTimestamp(legacy);
402 if (*_aidl_return != OK) {
403 return Status::ok();
404 }
Andy Hung973638a2020-12-08 20:47:45 -0800405 *timestamp = legacy2aidl_AudioTimestamp_AudioTimestampInternal(legacy).value();
Ytai Ben-Tsvibdc293a2020-11-02 17:01:38 -0800406 return Status::ok();
Andy Hung9fc8b5c2017-01-24 13:36:48 -0800407}
408
Ytai Ben-Tsvibdc293a2020-11-02 17:01:38 -0800409Status AudioFlinger::TrackHandle::signal() {
410 mTrack->signal();
411 return Status::ok();
Andy Hung9fc8b5c2017-01-24 13:36:48 -0800412}
413
Ytai Ben-Tsvibdc293a2020-11-02 17:01:38 -0800414Status AudioFlinger::TrackHandle::applyVolumeShaper(
415 const media::VolumeShaperConfiguration& configuration,
416 const media::VolumeShaperOperation& operation,
417 int32_t* _aidl_return) {
418 sp<VolumeShaper::Configuration> conf = new VolumeShaper::Configuration();
419 *_aidl_return = conf->readFromParcelable(configuration);
420 if (*_aidl_return != OK) {
421 return Status::ok();
422 }
423
424 sp<VolumeShaper::Operation> op = new VolumeShaper::Operation();
425 *_aidl_return = op->readFromParcelable(operation);
426 if (*_aidl_return != OK) {
427 return Status::ok();
428 }
429
430 *_aidl_return = mTrack->applyVolumeShaper(conf, op);
431 return Status::ok();
Glenn Kasten53cec222013-08-29 09:01:02 -0700432}
433
Ytai Ben-Tsvibdc293a2020-11-02 17:01:38 -0800434Status AudioFlinger::TrackHandle::getVolumeShaperState(
435 int32_t id,
436 std::optional<media::VolumeShaperState>* _aidl_return) {
437 sp<VolumeShaper::State> legacy = mTrack->getVolumeShaperState(id);
438 if (legacy == nullptr) {
439 _aidl_return->reset();
440 return Status::ok();
441 }
442 media::VolumeShaperState aidl;
443 legacy->writeToParcelable(&aidl);
444 *_aidl_return = aidl;
445 return Status::ok();
Eric Laurent81784c32012-11-19 14:55:58 -0800446}
447
Mikhail Naganova77d5552022-12-18 02:48:14 +0000448Status AudioFlinger::TrackHandle::getDualMonoMode(
449 media::audio::common::AudioDualMonoMode* _aidl_return)
Kuowei Lid4adbdb2020-08-13 14:44:25 +0800450{
451 audio_dual_mono_mode_t mode = AUDIO_DUAL_MONO_MODE_OFF;
452 const status_t status = mTrack->getDualMonoMode(&mode)
453 ?: AudioValidator::validateDualMonoMode(mode);
454 if (status == OK) {
455 *_aidl_return = VALUE_OR_RETURN_BINDER_STATUS(
456 legacy2aidl_audio_dual_mono_mode_t_AudioDualMonoMode(mode));
457 }
458 return binderStatusFromStatusT(status);
459}
460
461Status AudioFlinger::TrackHandle::setDualMonoMode(
Mikhail Naganova77d5552022-12-18 02:48:14 +0000462 media::audio::common::AudioDualMonoMode mode)
Kuowei Lid4adbdb2020-08-13 14:44:25 +0800463{
464 const auto localMonoMode = VALUE_OR_RETURN_BINDER_STATUS(
465 aidl2legacy_AudioDualMonoMode_audio_dual_mono_mode_t(mode));
466 return binderStatusFromStatusT(AudioValidator::validateDualMonoMode(localMonoMode)
467 ?: mTrack->setDualMonoMode(localMonoMode));
468}
469
470Status AudioFlinger::TrackHandle::getAudioDescriptionMixLevel(float* _aidl_return)
471{
472 float leveldB = -std::numeric_limits<float>::infinity();
473 const status_t status = mTrack->getAudioDescriptionMixLevel(&leveldB)
474 ?: AudioValidator::validateAudioDescriptionMixLevel(leveldB);
475 if (status == OK) *_aidl_return = leveldB;
476 return binderStatusFromStatusT(status);
477}
478
479Status AudioFlinger::TrackHandle::setAudioDescriptionMixLevel(float leveldB)
480{
481 return binderStatusFromStatusT(AudioValidator::validateAudioDescriptionMixLevel(leveldB)
482 ?: mTrack->setAudioDescriptionMixLevel(leveldB));
483}
484
485Status AudioFlinger::TrackHandle::getPlaybackRateParameters(
Mikhail Naganova77d5552022-12-18 02:48:14 +0000486 media::audio::common::AudioPlaybackRate* _aidl_return)
Kuowei Lid4adbdb2020-08-13 14:44:25 +0800487{
488 audio_playback_rate_t localPlaybackRate{};
489 status_t status = mTrack->getPlaybackRateParameters(&localPlaybackRate)
490 ?: AudioValidator::validatePlaybackRate(localPlaybackRate);
491 if (status == NO_ERROR) {
492 *_aidl_return = VALUE_OR_RETURN_BINDER_STATUS(
493 legacy2aidl_audio_playback_rate_t_AudioPlaybackRate(localPlaybackRate));
494 }
495 return binderStatusFromStatusT(status);
496}
497
498Status AudioFlinger::TrackHandle::setPlaybackRateParameters(
Mikhail Naganova77d5552022-12-18 02:48:14 +0000499 const media::audio::common::AudioPlaybackRate& playbackRate)
Kuowei Lid4adbdb2020-08-13 14:44:25 +0800500{
501 const audio_playback_rate_t localPlaybackRate = VALUE_OR_RETURN_BINDER_STATUS(
502 aidl2legacy_AudioPlaybackRate_audio_playback_rate_t(playbackRate));
503 return binderStatusFromStatusT(AudioValidator::validatePlaybackRate(localPlaybackRate)
504 ?: mTrack->setPlaybackRateParameters(localPlaybackRate));
505}
506
Eric Laurent81784c32012-11-19 14:55:58 -0800507// ----------------------------------------------------------------------------
Jean-Michel Trivi74e01fa2019-02-25 12:18:09 -0800508// AppOp for audio playback
509// -------------------------------
Mikhail Naganovf7e3a3a2019-04-22 16:43:26 -0700510
511// static
512sp<AudioFlinger::PlaybackThread::OpPlayAudioMonitor>
513AudioFlinger::PlaybackThread::OpPlayAudioMonitor::createIfNeeded(
Vlad Popa103be862023-07-10 20:27:41 -0700514 AudioFlinger::ThreadBase* thread,
Svet Ganov33761132021-05-13 22:51:08 +0000515 const AttributionSourceState& attributionSource, const audio_attributes_t& attr, int id,
Philip P. Moltmannbda45752020-07-17 16:41:18 -0700516 audio_stream_type_t streamType)
Jean-Michel Trivi74e01fa2019-02-25 12:18:09 -0800517{
Vlad Popa103be862023-07-10 20:27:41 -0700518 Vector<String16> packages;
519 const uid_t uid = VALUE_OR_FATAL(aidl2legacy_int32_t_uid_t(attributionSource.uid));
Colin Crossb8a9dbb2020-08-27 04:12:26 +0000520 getPackagesForUid(uid, packages);
Eric Laurent9066ad32019-05-20 14:40:10 -0700521 if (isServiceUid(uid)) {
Eric Laurent9066ad32019-05-20 14:40:10 -0700522 if (packages.isEmpty()) {
523 ALOGD("OpPlayAudio: not muting track:%d usage:%d for service UID %d",
524 id,
525 attr.usage,
526 uid);
527 return nullptr;
528 }
Jean-Michel Trivi74e01fa2019-02-25 12:18:09 -0800529 }
530 // stream type has been filtered by audio policy to indicate whether it can be muted
531 if (streamType == AUDIO_STREAM_ENFORCED_AUDIBLE) {
Eric Laurent2dab0302019-05-08 18:15:55 -0700532 ALOGD("OpPlayAudio: not muting track:%d usage:%d ENFORCED_AUDIBLE", id, attr.usage);
Mikhail Naganovf7e3a3a2019-04-22 16:43:26 -0700533 return nullptr;
Jean-Michel Trivi74e01fa2019-02-25 12:18:09 -0800534 }
Eric Laurent2dab0302019-05-08 18:15:55 -0700535 if ((attr.flags & AUDIO_FLAG_BYPASS_INTERRUPTION_POLICY)
536 == AUDIO_FLAG_BYPASS_INTERRUPTION_POLICY) {
537 ALOGD("OpPlayAudio: not muting track:%d flags %#x have FLAG_BYPASS_INTERRUPTION_POLICY",
538 id, attr.flags);
539 return nullptr;
540 }
Vlad Popa103be862023-07-10 20:27:41 -0700541 return sp<OpPlayAudioMonitor>::make(thread, attributionSource, attr.usage, id, uid);
Mikhail Naganovf7e3a3a2019-04-22 16:43:26 -0700542}
543
544AudioFlinger::PlaybackThread::OpPlayAudioMonitor::OpPlayAudioMonitor(
Vlad Popa103be862023-07-10 20:27:41 -0700545 AudioFlinger::ThreadBase* thread,
546 const AttributionSourceState& attributionSource,
547 audio_usage_t usage, int id, uid_t uid)
548 : mThread(wp<AudioFlinger::ThreadBase>::fromExisting(thread)),
549 mHasOpPlayAudio(true),
550 mAttributionSource(attributionSource),
551 mUsage((int32_t)usage),
552 mId(id),
553 mUid(uid),
554 mPackageName(VALUE_OR_FATAL(aidl2legacy_string_view_String16(
555 attributionSource.packageName.value_or("")))) {}
Jean-Michel Trivi74e01fa2019-02-25 12:18:09 -0800556
557AudioFlinger::PlaybackThread::OpPlayAudioMonitor::~OpPlayAudioMonitor()
558{
559 if (mOpCallback != 0) {
560 mAppOpsManager.stopWatchingMode(mOpCallback);
561 }
562 mOpCallback.clear();
563}
564
Mikhail Naganovf7e3a3a2019-04-22 16:43:26 -0700565void AudioFlinger::PlaybackThread::OpPlayAudioMonitor::onFirstRef()
566{
Vlad Popad2152122023-08-02 18:36:04 -0700567 // make sure not to broadcast the initial state since it is not needed and could
568 // cause a deadlock since this method can be called with the mThread->mLock held
569 checkPlayAudioForUsage(/*doBroadcast=*/false);
Svet Ganov33761132021-05-13 22:51:08 +0000570 if (mAttributionSource.packageName.has_value()) {
Mikhail Naganovf7e3a3a2019-04-22 16:43:26 -0700571 mOpCallback = new PlayAudioOpCallback(this);
Philip P. Moltmannbda45752020-07-17 16:41:18 -0700572 mAppOpsManager.startWatchingMode(AppOpsManager::OP_PLAY_AUDIO,
Vlad Popa103be862023-07-10 20:27:41 -0700573 mPackageName, mOpCallback);
Mikhail Naganovf7e3a3a2019-04-22 16:43:26 -0700574 }
575}
576
Jean-Michel Trivi74e01fa2019-02-25 12:18:09 -0800577bool AudioFlinger::PlaybackThread::OpPlayAudioMonitor::hasOpPlayAudio() const {
578 return mHasOpPlayAudio.load();
579}
580
Jean-Michel Trividdf87ef2019-08-20 15:42:04 -0700581// Note this method is never called (and never to be) for audio server / patch record track
Jean-Michel Trivi74e01fa2019-02-25 12:18:09 -0800582// - not called from constructor due to check on UID,
583// - not called from PlayAudioOpCallback because the callback is not installed in this case
Vlad Popad2152122023-08-02 18:36:04 -0700584void AudioFlinger::PlaybackThread::OpPlayAudioMonitor::checkPlayAudioForUsage(bool doBroadcast)
Jean-Michel Trivi74e01fa2019-02-25 12:18:09 -0800585{
Vlad Popa103be862023-07-10 20:27:41 -0700586 const bool hasAppOps = mAttributionSource.packageName.has_value()
587 && mAppOpsManager.checkAudioOpNoThrow(
588 AppOpsManager::OP_PLAY_AUDIO, mUsage, mUid, mPackageName) ==
589 AppOpsManager::MODE_ALLOWED;
590
591 bool shouldChange = !hasAppOps; // check if we need to update.
592 if (mHasOpPlayAudio.compare_exchange_strong(shouldChange, hasAppOps)) {
593 ALOGD("OpPlayAudio: track:%d usage:%d %smuted", mId, mUsage, hasAppOps ? "not " : "");
Vlad Popad2152122023-08-02 18:36:04 -0700594 if (doBroadcast) {
595 auto thread = mThread.promote();
596 if (thread != nullptr && thread->type() == AudioFlinger::ThreadBase::OFFLOAD) {
597 // Wake up Thread if offloaded, otherwise it may be several seconds for update.
598 Mutex::Autolock _l(thread->mLock);
599 thread->broadcast_l();
600 }
Vlad Popa103be862023-07-10 20:27:41 -0700601 }
Jean-Michel Trivi74e01fa2019-02-25 12:18:09 -0800602 }
603}
604
605AudioFlinger::PlaybackThread::OpPlayAudioMonitor::PlayAudioOpCallback::PlayAudioOpCallback(
606 const wp<OpPlayAudioMonitor>& monitor) : mMonitor(monitor)
607{ }
608
609void AudioFlinger::PlaybackThread::OpPlayAudioMonitor::PlayAudioOpCallback::opChanged(int32_t op,
610 const String16& packageName) {
611 // we only have uid, so we need to check all package names anyway
612 UNUSED(packageName);
613 if (op != AppOpsManager::OP_PLAY_AUDIO) {
614 return;
615 }
616 sp<OpPlayAudioMonitor> monitor = mMonitor.promote();
617 if (monitor != NULL) {
Vlad Popad2152122023-08-02 18:36:04 -0700618 monitor->checkPlayAudioForUsage(/*doBroadcast=*/true);
Jean-Michel Trivi74e01fa2019-02-25 12:18:09 -0800619 }
620}
621
Eric Laurent9066ad32019-05-20 14:40:10 -0700622// static
623void AudioFlinger::PlaybackThread::OpPlayAudioMonitor::getPackagesForUid(
624 uid_t uid, Vector<String16>& packages)
625{
626 PermissionController permissionController;
627 permissionController.getPackagesForUid(uid, packages);
628}
629
Jean-Michel Trivi74e01fa2019-02-25 12:18:09 -0800630// ----------------------------------------------------------------------------
Andy Hung9d84af52018-09-12 18:03:44 -0700631#undef LOG_TAG
632#define LOG_TAG "AF::Track"
Eric Laurent81784c32012-11-19 14:55:58 -0800633
634// Track constructor must be called with AudioFlinger::mLock and ThreadBase::mLock held
635AudioFlinger::PlaybackThread::Track::Track(
636 PlaybackThread *thread,
637 const sp<Client>& client,
638 audio_stream_type_t streamType,
Kevin Rocard1f564ac2018-03-29 13:53:10 -0700639 const audio_attributes_t& attr,
Eric Laurent81784c32012-11-19 14:55:58 -0800640 uint32_t sampleRate,
641 audio_format_t format,
642 audio_channel_mask_t channelMask,
643 size_t frameCount,
Eric Laurent83b88082014-06-20 18:31:16 -0700644 void *buffer,
Andy Hung8fe68032017-06-05 16:17:51 -0700645 size_t bufferSize,
Eric Laurent81784c32012-11-19 14:55:58 -0800646 const sp<IMemory>& sharedBuffer,
Glenn Kastend848eb42016-03-08 13:42:11 -0800647 audio_session_t sessionId,
Eric Laurent09f1ed22019-04-24 17:45:17 -0700648 pid_t creatorPid,
Svet Ganov33761132021-05-13 22:51:08 +0000649 const AttributionSourceState& attributionSource,
Eric Laurent05067782016-06-01 18:27:28 -0700650 audio_output_flags_t flags,
Eric Laurent20b9ef02016-12-05 11:03:16 -0800651 track_type type,
Kevin Rocard01c7d9e2019-09-18 11:24:52 +0100652 audio_port_handle_t portId,
jiabinf042b9b2021-05-07 23:46:28 +0000653 size_t frameCountToBeReady,
Eric Laurentb0a7bc92022-04-05 15:06:08 +0200654 float speed,
655 bool isSpatialized)
Kevin Rocard1f564ac2018-03-29 13:53:10 -0700656 : TrackBase(thread, client, attr, sampleRate, format, channelMask, frameCount,
Ytai Ben-Tsvi7dd39722019-09-05 15:14:30 -0700657 // TODO: Using unsecurePointer() has some associated security pitfalls
658 // (see declaration for details).
659 // Either document why it is safe in this case or address the
660 // issue (e.g. by copying).
661 (sharedBuffer != 0) ? sharedBuffer->unsecurePointer() : buffer,
Andy Hung8fe68032017-06-05 16:17:51 -0700662 (sharedBuffer != 0) ? sharedBuffer->size() : bufferSize,
Philip P. Moltmannbda45752020-07-17 16:41:18 -0700663 sessionId, creatorPid,
Svet Ganov33761132021-05-13 22:51:08 +0000664 VALUE_OR_FATAL(aidl2legacy_int32_t_uid_t(attributionSource.uid)), true /*isOut*/,
Eric Laurent83b88082014-06-20 18:31:16 -0700665 (type == TYPE_PATCH) ? ( buffer == NULL ? ALLOC_LOCAL : ALLOC_NONE) : ALLOC_CBLK,
Andy Hungb68f5eb2019-12-03 16:49:17 -0800666 type,
667 portId,
668 std::string(AMEDIAMETRICS_KEY_PREFIX_AUDIO_TRACK) + std::to_string(portId)),
Eric Laurent81784c32012-11-19 14:55:58 -0800669 mFillingUpStatus(FS_INVALID),
670 // mRetryCount initialized later when needed
671 mSharedBuffer(sharedBuffer),
672 mStreamType(streamType),
rago94a1ee82017-07-21 15:11:02 -0700673 mMainBuffer(thread->sinkBuffer()),
Eric Laurent81784c32012-11-19 14:55:58 -0800674 mAuxBuffer(NULL),
675 mAuxEffectId(0), mHasVolumeController(false),
Andy Hunge10393e2015-06-12 13:59:33 -0700676 mFrameMap(16 /* sink-frame-to-track-frame map memory */),
Ivan Lozano8cf3a072017-08-09 09:01:33 -0700677 mVolumeHandler(new media::VolumeHandler(sampleRate)),
Vlad Popa103be862023-07-10 20:27:41 -0700678 mOpPlayAudioMonitor(OpPlayAudioMonitor::createIfNeeded(thread, attributionSource, attr, id(),
Philip P. Moltmannbda45752020-07-17 16:41:18 -0700679 streamType)),
Andy Hunge10393e2015-06-12 13:59:33 -0700680 // mSinkTimestamp
Eric Laurent81784c32012-11-19 14:55:58 -0800681 mFastIndex(-1),
Glenn Kasten5736c352012-12-04 12:12:34 -0800682 mCachedVolume(1.0),
Kevin Rocard12381092018-04-11 09:19:59 -0700683 /* The track might not play immediately after being active, similarly as if its volume was 0.
684 * When the track starts playing, its volume will be computed. */
685 mFinalVolume(0.f),
Haynes Mathew George7844f672014-01-15 12:32:55 -0800686 mResumeToStopping(false),
Eric Laurent05067782016-06-01 18:27:28 -0700687 mFlushHwPending(false),
jiabinf042b9b2021-05-07 23:46:28 +0000688 mFlags(flags),
Eric Laurentb0a7bc92022-04-05 15:06:08 +0200689 mSpeed(speed),
690 mIsSpatialized(isSpatialized)
Eric Laurent81784c32012-11-19 14:55:58 -0800691{
Eric Laurent83b88082014-06-20 18:31:16 -0700692 // client == 0 implies sharedBuffer == 0
693 ALOG_ASSERT(!(client == 0 && sharedBuffer != 0));
694
Andy Hung9d84af52018-09-12 18:03:44 -0700695 ALOGV_IF(sharedBuffer != 0, "%s(%d): sharedBuffer: %p, size: %zu",
Ytai Ben-Tsvi7dd39722019-09-05 15:14:30 -0700696 __func__, mId, sharedBuffer->unsecurePointer(), sharedBuffer->size());
Eric Laurent83b88082014-06-20 18:31:16 -0700697
Glenn Kasten3ef14ef2014-03-13 15:08:51 -0700698 if (mCblk == NULL) {
699 return;
Eric Laurent81784c32012-11-19 14:55:58 -0800700 }
Glenn Kasten3ef14ef2014-03-13 15:08:51 -0700701
Svet Ganov33761132021-05-13 22:51:08 +0000702 uid_t uid = VALUE_OR_FATAL(aidl2legacy_int32_t_uid_t(attributionSource.uid));
Andy Hung689e82c2019-08-21 17:53:17 -0700703 if (!thread->isTrackAllowed_l(channelMask, format, sessionId, uid)) {
704 ALOGE("%s(%d): no more tracks available", __func__, mId);
705 releaseCblk(); // this makes the track invalid.
706 return;
707 }
708
Glenn Kasten3ef14ef2014-03-13 15:08:51 -0700709 if (sharedBuffer == 0) {
710 mAudioTrackServerProxy = new AudioTrackServerProxy(mCblk, mBuffer, frameCount,
Eric Laurent83b88082014-06-20 18:31:16 -0700711 mFrameSize, !isExternalTrack(), sampleRate);
Glenn Kasten3ef14ef2014-03-13 15:08:51 -0700712 } else {
713 mAudioTrackServerProxy = new StaticAudioTrackServerProxy(mCblk, mBuffer, frameCount,
Kevin Rocard36862032019-10-10 10:52:19 +0100714 mFrameSize, sampleRate);
Glenn Kasten3ef14ef2014-03-13 15:08:51 -0700715 }
716 mServerProxy = mAudioTrackServerProxy;
Andy Hung3c7f47a2021-03-16 17:30:09 -0700717 mServerProxy->setStartThresholdInFrames(frameCountToBeReady); // update the Cblk value
Glenn Kasten3ef14ef2014-03-13 15:08:51 -0700718
Glenn Kasten3ef14ef2014-03-13 15:08:51 -0700719 // only allocate a fast track index if we were able to allocate a normal track name
Eric Laurent05067782016-06-01 18:27:28 -0700720 if (flags & AUDIO_OUTPUT_FLAG_FAST) {
Andy Hunga5427822015-09-11 16:15:35 -0700721 // FIXME: Not calling framesReadyIsCalledByMultipleThreads() exposes a potential
722 // race with setSyncEvent(). However, if we call it, we cannot properly start
723 // static fast tracks (SoundPool) immediately after stopping.
724 //mAudioTrackServerProxy->framesReadyIsCalledByMultipleThreads();
Glenn Kasten3ef14ef2014-03-13 15:08:51 -0700725 ALOG_ASSERT(thread->mFastTrackAvailMask != 0);
726 int i = __builtin_ctz(thread->mFastTrackAvailMask);
Glenn Kastendc2c50b2016-04-21 08:13:14 -0700727 ALOG_ASSERT(0 < i && i < (int)FastMixerState::sMaxFastTracks);
Glenn Kasten3ef14ef2014-03-13 15:08:51 -0700728 // FIXME This is too eager. We allocate a fast track index before the
729 // fast track becomes active. Since fast tracks are a scarce resource,
730 // this means we are potentially denying other more important fast tracks from
731 // being created. It would be better to allocate the index dynamically.
732 mFastIndex = i;
Glenn Kasten3ef14ef2014-03-13 15:08:51 -0700733 thread->mFastTrackAvailMask &= ~(1 << i);
734 }
Andy Hung8946a282018-04-19 20:04:56 -0700735
Dean Wheatley7b036912020-06-18 16:22:11 +1000736 mServerLatencySupported = checkServerLatencySupported(format, flags);
Andy Hung8946a282018-04-19 20:04:56 -0700737#ifdef TEE_SINK
738 mTee.setId(std::string("_") + std::to_string(mThreadIoHandle)
Kevin Rocard51f0e982019-02-01 19:19:11 -0800739 + "_" + std::to_string(mId) + "_T");
Andy Hung8946a282018-04-19 20:04:56 -0700740#endif
jiabin57303cc2018-12-18 15:45:57 -0800741
jiabineb3bda02020-06-30 14:07:03 -0700742 if (thread->supportsHapticPlayback()) {
743 // If the track is attached to haptic playback thread, it is potentially to have
744 // HapticGenerator effect, which will generate haptic data, on the track. In that case,
745 // external vibration is always created for all tracks attached to haptic playback thread.
jiabin57303cc2018-12-18 15:45:57 -0800746 mAudioVibrationController = new AudioVibrationController(this);
Svet Ganov33761132021-05-13 22:51:08 +0000747 std::string packageName = attributionSource.packageName.has_value() ?
748 attributionSource.packageName.value() : "";
jiabin57303cc2018-12-18 15:45:57 -0800749 mExternalVibration = new os::ExternalVibration(
Philip P. Moltmannbda45752020-07-17 16:41:18 -0700750 mUid, packageName, mAttr, mAudioVibrationController);
jiabin57303cc2018-12-18 15:45:57 -0800751 }
Andy Hungb68f5eb2019-12-03 16:49:17 -0800752
753 // Once this item is logged by the server, the client can add properties.
Andy Hunga629bd12020-06-05 16:03:53 -0700754 const char * const traits = sharedBuffer == 0 ? "" : "static";
Andy Hung5837c7f2021-02-25 10:48:24 -0800755 mTrackMetrics.logConstructor(creatorPid, uid, id(), traits, streamType);
Eric Laurent81784c32012-11-19 14:55:58 -0800756}
757
758AudioFlinger::PlaybackThread::Track::~Track()
759{
Andy Hung9d84af52018-09-12 18:03:44 -0700760 ALOGV("%s(%d)", __func__, mId);
Glenn Kasten0c72b242013-09-11 09:14:16 -0700761
762 // The destructor would clear mSharedBuffer,
763 // but it will not push the decremented reference count,
764 // leaving the client's IMemory dangling indefinitely.
765 // This prevents that leak.
766 if (mSharedBuffer != 0) {
767 mSharedBuffer.clear();
Glenn Kasten0c72b242013-09-11 09:14:16 -0700768 }
Eric Laurent81784c32012-11-19 14:55:58 -0800769}
770
Glenn Kasten03003332013-08-06 15:40:54 -0700771status_t AudioFlinger::PlaybackThread::Track::initCheck() const
772{
773 status_t status = TrackBase::initCheck();
Andy Hungc0691382018-09-12 18:01:57 -0700774 if (status == NO_ERROR && mCblk == nullptr) {
Glenn Kasten03003332013-08-06 15:40:54 -0700775 status = NO_MEMORY;
776 }
777 return status;
778}
779
Eric Laurent81784c32012-11-19 14:55:58 -0800780void AudioFlinger::PlaybackThread::Track::destroy()
781{
782 // NOTE: destroyTrack_l() can remove a strong reference to this Track
783 // by removing it from mTracks vector, so there is a risk that this Tracks's
784 // destructor is called. As the destructor needs to lock mLock,
785 // we must acquire a strong reference on this Track before locking mLock
786 // here so that the destructor is called only when exiting this function.
787 // On the other hand, as long as Track::destroy() is only called by
788 // TrackHandle destructor, the TrackHandle still holds a strong ref on
789 // this Track with its member mTrack.
790 sp<Track> keep(this);
791 { // scope for mLock
Eric Laurentaaa44472014-09-12 17:41:50 -0700792 bool wasActive = false;
Eric Laurent81784c32012-11-19 14:55:58 -0800793 sp<ThreadBase> thread = mThread.promote();
794 if (thread != 0) {
Eric Laurent81784c32012-11-19 14:55:58 -0800795 Mutex::Autolock _l(thread->mLock);
796 PlaybackThread *playbackThread = (PlaybackThread *)thread.get();
Eric Laurentaaa44472014-09-12 17:41:50 -0700797 wasActive = playbackThread->destroyTrack_l(this);
798 }
799 if (isExternalTrack() && !wasActive) {
Eric Laurentd7fe0862018-07-14 16:48:01 -0700800 AudioSystem::releaseOutput(mPortId);
Eric Laurent81784c32012-11-19 14:55:58 -0800801 }
802 }
Kevin Rocardc43ea142019-01-31 18:17:37 -0800803 forEachTeePatchTrack([](auto patchTrack) { patchTrack->destroy(); });
Eric Laurent81784c32012-11-19 14:55:58 -0800804}
805
Andy Hungf6ab58d2018-05-25 12:50:39 -0700806void AudioFlinger::PlaybackThread::Track::appendDumpHeader(String8& result)
Eric Laurent81784c32012-11-19 14:55:58 -0800807{
Eric Laurent973db022018-11-20 14:54:31 -0800808 result.appendFormat("Type Id Active Client Session Port Id S Flags "
Kevin Rocard5f2136e2018-05-11 22:03:00 -0700809 " Format Chn mask SRate "
810 "ST Usg CT "
811 " G db L dB R dB VS dB "
812 " Server FrmCnt FrmRdy F Underruns Flushed"
813 "%s\n",
814 isServerLatencySupported() ? " Latency" : "");
Eric Laurent81784c32012-11-19 14:55:58 -0800815}
816
Andy Hung2c6c3bb2017-06-16 14:01:45 -0700817void AudioFlinger::PlaybackThread::Track::appendDump(String8& result, bool active)
Eric Laurent81784c32012-11-19 14:55:58 -0800818{
Andy Hung2c6c3bb2017-06-16 14:01:45 -0700819 char trackType;
820 switch (mType) {
821 case TYPE_DEFAULT:
822 case TYPE_OUTPUT:
Andy Hungf6ab58d2018-05-25 12:50:39 -0700823 if (isStatic()) {
Andy Hung2c6c3bb2017-06-16 14:01:45 -0700824 trackType = 'S'; // static
825 } else {
826 trackType = ' '; // normal
Eric Laurentbfb1b832013-01-07 09:53:42 -0800827 }
Andy Hung2c6c3bb2017-06-16 14:01:45 -0700828 break;
829 case TYPE_PATCH:
830 trackType = 'P';
831 break;
832 default:
833 trackType = '?';
Eric Laurent81784c32012-11-19 14:55:58 -0800834 }
Andy Hung2c6c3bb2017-06-16 14:01:45 -0700835
836 if (isFastTrack()) {
Andy Hungc0691382018-09-12 18:01:57 -0700837 result.appendFormat("F%d %c %6d", mFastIndex, trackType, mId);
Andy Hung2c6c3bb2017-06-16 14:01:45 -0700838 } else {
Andy Hungc0691382018-09-12 18:01:57 -0700839 result.appendFormat(" %c %6d", trackType, mId);
Andy Hung2c6c3bb2017-06-16 14:01:45 -0700840 }
841
Eric Laurent81784c32012-11-19 14:55:58 -0800842 char nowInUnderrun;
843 switch (mObservedUnderruns.mBitFields.mMostRecent) {
844 case UNDERRUN_FULL:
845 nowInUnderrun = ' ';
846 break;
847 case UNDERRUN_PARTIAL:
848 nowInUnderrun = '<';
849 break;
850 case UNDERRUN_EMPTY:
851 nowInUnderrun = '*';
852 break;
853 default:
854 nowInUnderrun = '?';
855 break;
856 }
Andy Hungda540db2017-04-20 14:06:17 -0700857
Andy Hung2c6c3bb2017-06-16 14:01:45 -0700858 char fillingStatus;
859 switch (mFillingUpStatus) {
860 case FS_INVALID:
861 fillingStatus = 'I';
862 break;
863 case FS_FILLING:
864 fillingStatus = 'f';
865 break;
866 case FS_FILLED:
867 fillingStatus = 'F';
868 break;
869 case FS_ACTIVE:
870 fillingStatus = 'A';
871 break;
872 default:
873 fillingStatus = '?';
874 break;
875 }
876
877 // clip framesReadySafe to max representation in dump
878 const size_t framesReadySafe =
879 std::min(mAudioTrackServerProxy->framesReadySafe(), (size_t)99999999);
880
881 // obtain volumes
882 const gain_minifloat_packed_t vlr = mAudioTrackServerProxy->getVolumeLR();
883 const std::pair<float /* volume */, bool /* active */> vsVolume =
884 mVolumeHandler->getLastVolume();
885
886 // Our effective frame count is obtained by ServerProxy::getBufferSizeInFrames()
887 // as it may be reduced by the application.
888 const size_t bufferSizeInFrames = (size_t)mAudioTrackServerProxy->getBufferSizeInFrames();
889 // Check whether the buffer size has been modified by the app.
890 const char modifiedBufferChar = bufferSizeInFrames < mFrameCount
891 ? 'r' /* buffer reduced */: bufferSizeInFrames > mFrameCount
892 ? 'e' /* error */ : ' ' /* identical */;
893
Eric Laurent973db022018-11-20 14:54:31 -0800894 result.appendFormat("%7s %6u %7u %7u %2s 0x%03X "
Kevin Rocard5f2136e2018-05-11 22:03:00 -0700895 "%08X %08X %6u "
896 "%2u %3x %2x "
897 "%5.2g %5.2g %5.2g %5.2g%c "
898 "%08X %6zu%c %6zu %c %9u%c %7u",
Marco Nelissenb2208842014-02-07 14:00:50 -0800899 active ? "yes" : "no",
Andy Hung4ef19fa2018-05-15 19:35:29 -0700900 (mClient == 0) ? getpid() : mClient->pid(),
Andy Hung2c6c3bb2017-06-16 14:01:45 -0700901 mSessionId,
Eric Laurent973db022018-11-20 14:54:31 -0800902 mPortId,
Andy Hunge2e830f2019-12-03 12:54:46 -0800903 getTrackStateAsCodedString(),
Andy Hung2c6c3bb2017-06-16 14:01:45 -0700904 mCblk->mFlags,
905
Eric Laurent81784c32012-11-19 14:55:58 -0800906 mFormat,
907 mChannelMask,
Andy Hungcef2daa2018-06-01 15:31:49 -0700908 sampleRate(),
Andy Hung2c6c3bb2017-06-16 14:01:45 -0700909
910 mStreamType,
Kevin Rocard5f2136e2018-05-11 22:03:00 -0700911 mAttr.usage,
912 mAttr.content_type,
913
914 20.0 * log10(mFinalVolume),
Glenn Kastenc56f3422014-03-21 17:53:17 -0700915 20.0 * log10(float_from_gain(gain_minifloat_unpack_left(vlr))),
916 20.0 * log10(float_from_gain(gain_minifloat_unpack_right(vlr))),
Andy Hungda540db2017-04-20 14:06:17 -0700917 20.0 * log10(vsVolume.first), // VolumeShaper(s) total volume
918 vsVolume.second ? 'A' : ' ', // if any VolumeShapers active
Andy Hung2c6c3bb2017-06-16 14:01:45 -0700919
Glenn Kastenf20e1d82013-07-12 09:45:18 -0700920 mCblk->mServer,
Andy Hung2c6c3bb2017-06-16 14:01:45 -0700921 bufferSizeInFrames,
922 modifiedBufferChar,
923 framesReadySafe,
924 fillingStatus,
Glenn Kasten82aaf942013-07-17 16:05:07 -0700925 mAudioTrackServerProxy->getUnderrunFrames(),
Andy Hung2148bf02016-11-28 19:01:02 -0800926 nowInUnderrun,
Andy Hungf6ab58d2018-05-25 12:50:39 -0700927 (unsigned)mAudioTrackServerProxy->framesFlushed() % 10000000
Andy Hung2c6c3bb2017-06-16 14:01:45 -0700928 );
Andy Hungcef2daa2018-06-01 15:31:49 -0700929
930 if (isServerLatencySupported()) {
931 double latencyMs;
932 bool fromTrack;
933 if (getTrackLatencyMs(&latencyMs, &fromTrack) == OK) {
934 // Show latency in msec, followed by 't' if from track timestamp (the most accurate)
935 // or 'k' if estimated from kernel because track frames haven't been presented yet.
936 result.appendFormat(" %7.2lf %c", latencyMs, fromTrack ? 't' : 'k');
Andy Hungf6ab58d2018-05-25 12:50:39 -0700937 } else {
Andy Hungcef2daa2018-06-01 15:31:49 -0700938 result.appendFormat("%10s", mCblk->mServer != 0 ? "unavail" : "new");
Andy Hungf6ab58d2018-05-25 12:50:39 -0700939 }
940 }
941 result.append("\n");
Eric Laurent81784c32012-11-19 14:55:58 -0800942}
943
Glenn Kasten9f80dd22012-12-18 15:57:32 -0800944uint32_t AudioFlinger::PlaybackThread::Track::sampleRate() const {
945 return mAudioTrackServerProxy->getSampleRate();
946}
947
Eric Laurent81784c32012-11-19 14:55:58 -0800948// AudioBufferProvider interface
Kevin Rocard153f92d2018-12-18 18:33:28 -0800949status_t AudioFlinger::PlaybackThread::Track::getNextBuffer(AudioBufferProvider::Buffer* buffer)
Eric Laurent81784c32012-11-19 14:55:58 -0800950{
Glenn Kasten9f80dd22012-12-18 15:57:32 -0800951 ServerProxy::Buffer buf;
952 size_t desiredFrames = buffer->frameCount;
953 buf.mFrameCount = desiredFrames;
954 status_t status = mServerProxy->obtainBuffer(&buf);
955 buffer->frameCount = buf.mFrameCount;
956 buffer->raw = buf.mRaw;
Andy Hungfc629172020-06-22 10:06:23 -0700957 if (buf.mFrameCount == 0 && !isStopping() && !isStopped() && !isPaused() && !isOffloaded()) {
Andy Hung9d84af52018-09-12 18:03:44 -0700958 ALOGV("%s(%d): underrun, framesReady(%zu) < framesDesired(%zd), state: %d",
Andy Hung959b5b82021-09-24 10:46:20 -0700959 __func__, mId, buf.mFrameCount, desiredFrames, (int)mState);
Glenn Kasten82aaf942013-07-17 16:05:07 -0700960 mAudioTrackServerProxy->tallyUnderrunFrames(desiredFrames);
Phil Burk2812d9e2016-01-04 10:34:30 -0800961 } else {
962 mAudioTrackServerProxy->tallyUnderrunFrames(0);
Eric Laurent81784c32012-11-19 14:55:58 -0800963 }
Glenn Kasten9f80dd22012-12-18 15:57:32 -0800964 return status;
Eric Laurent81784c32012-11-19 14:55:58 -0800965}
966
Kevin Rocard153f92d2018-12-18 18:33:28 -0800967void AudioFlinger::PlaybackThread::Track::releaseBuffer(AudioBufferProvider::Buffer* buffer)
968{
969 interceptBuffer(*buffer);
970 TrackBase::releaseBuffer(buffer);
971}
972
973// TODO: compensate for time shift between HW modules.
974void AudioFlinger::PlaybackThread::Track::interceptBuffer(
Kevin Rocarda134b002019-02-07 18:05:31 -0800975 const AudioBufferProvider::Buffer& sourceBuffer) {
Kevin Rocard6057fa22019-02-08 14:08:07 -0800976 auto start = std::chrono::steady_clock::now();
Kevin Rocarda134b002019-02-07 18:05:31 -0800977 const size_t frameCount = sourceBuffer.frameCount;
Kevin Rocardd83b08a2019-02-27 15:05:54 -0800978 if (frameCount == 0) {
979 return; // No audio to intercept.
980 // Additionally PatchProxyBufferProvider::obtainBuffer (called by PathTrack::getNextBuffer)
981 // does not allow 0 frame size request contrary to getNextBuffer
982 }
983 for (auto& teePatch : mTeePatches) {
984 RecordThread::PatchRecord* patchRecord = teePatch.patchRecord.get();
Mikhail Naganov8296c252019-09-25 14:59:54 -0700985 const size_t framesWritten = patchRecord->writeFrames(
986 sourceBuffer.i8, frameCount, mFrameSize);
987 const size_t framesLeft = frameCount - framesWritten;
Kevin Rocarda134b002019-02-07 18:05:31 -0800988 ALOGW_IF(framesLeft != 0, "%s(%d) PatchRecord %d can not provide big enough "
989 "buffer %zu/%zu, dropping %zu frames", __func__, mId, patchRecord->mId,
990 framesWritten, frameCount, framesLeft);
Kevin Rocard153f92d2018-12-18 18:33:28 -0800991 }
Kevin Rocard6057fa22019-02-08 14:08:07 -0800992 auto spent = ceil<std::chrono::microseconds>(std::chrono::steady_clock::now() - start);
993 using namespace std::chrono_literals;
994 // Average is ~20us per track, this should virtually never be logged (Logging takes >200us)
Kevin Rocard01c7d9e2019-09-18 11:24:52 +0100995 ALOGD_IF(spent > 500us, "%s: took %lldus to intercept %zu tracks", __func__,
Kevin Rocard6057fa22019-02-08 14:08:07 -0800996 spent.count(), mTeePatches.size());
Kevin Rocard153f92d2018-12-18 18:33:28 -0800997}
998
Glenn Kasten6466c9e2013-08-23 10:54:07 -0700999// ExtendedAudioBufferProvider interface
1000
Andy Hung27876c02014-09-09 18:07:55 -07001001// framesReady() may return an approximation of the number of frames if called
1002// from a different thread than the one calling Proxy->obtainBuffer() and
1003// Proxy->releaseBuffer(). Also note there is no mutual exclusion in the
1004// AudioTrackServerProxy so be especially careful calling with FastTracks.
Eric Laurent81784c32012-11-19 14:55:58 -08001005size_t AudioFlinger::PlaybackThread::Track::framesReady() const {
Andy Hung27876c02014-09-09 18:07:55 -07001006 if (mSharedBuffer != 0 && (isStopped() || isStopping())) {
1007 // Static tracks return zero frames immediately upon stopping (for FastTracks).
1008 // The remainder of the buffer is not drained.
1009 return 0;
1010 }
Glenn Kasten9f80dd22012-12-18 15:57:32 -08001011 return mAudioTrackServerProxy->framesReady();
Eric Laurent81784c32012-11-19 14:55:58 -08001012}
1013
Andy Hung818e7a32016-02-16 18:08:07 -08001014int64_t AudioFlinger::PlaybackThread::Track::framesReleased() const
Glenn Kasten6466c9e2013-08-23 10:54:07 -07001015{
1016 return mAudioTrackServerProxy->framesReleased();
1017}
1018
Andy Hung818e7a32016-02-16 18:08:07 -08001019void AudioFlinger::PlaybackThread::Track::onTimestamp(const ExtendedTimestamp &timestamp)
Andy Hung6ae58432016-02-16 18:32:24 -08001020{
1021 // This call comes from a FastTrack and should be kept lockless.
1022 // The server side frames are already translated to client frames.
Andy Hung818e7a32016-02-16 18:08:07 -08001023 mAudioTrackServerProxy->setTimestamp(timestamp);
Andy Hung6ae58432016-02-16 18:32:24 -08001024
Andy Hung818e7a32016-02-16 18:08:07 -08001025 // We do not set drained here, as FastTrack timestamp may not go to very last frame.
Andy Hungcef2daa2018-06-01 15:31:49 -07001026
1027 // Compute latency.
1028 // TODO: Consider whether the server latency may be passed in by FastMixer
1029 // as a constant for all active FastTracks.
1030 const double latencyMs = timestamp.getOutputServerLatencyMs(sampleRate());
1031 mServerLatencyFromTrack.store(true);
1032 mServerLatencyMs.store(latencyMs);
Andy Hung6ae58432016-02-16 18:32:24 -08001033}
1034
Eric Laurent81784c32012-11-19 14:55:58 -08001035// Don't call for fast tracks; the framesReady() could result in priority inversion
1036bool AudioFlinger::PlaybackThread::Track::isReady() const {
Krishnankutty Kolathappilly8d6c2922014-02-04 16:23:42 -08001037 if (mFillingUpStatus != FS_FILLING || isStopped() || isPausing()) {
1038 return true;
1039 }
1040
Eric Laurent16498512014-03-17 17:22:08 -07001041 if (isStopping()) {
1042 if (framesReady() > 0) {
1043 mFillingUpStatus = FS_FILLED;
1044 }
Eric Laurent81784c32012-11-19 14:55:58 -08001045 return true;
1046 }
1047
Kevin Rocard01c7d9e2019-09-18 11:24:52 +01001048 size_t bufferSizeInFrames = mServerProxy->getBufferSizeInFrames();
Andy Hung3c7f47a2021-03-16 17:30:09 -07001049 // Note: mServerProxy->getStartThresholdInFrames() is clamped.
1050 const size_t startThresholdInFrames = mServerProxy->getStartThresholdInFrames();
1051 const size_t framesToBeReady = std::clamp( // clamp again to validate client values.
1052 std::min(startThresholdInFrames, bufferSizeInFrames), size_t(1), mFrameCount);
Kevin Rocard01c7d9e2019-09-18 11:24:52 +01001053
1054 if (framesReady() >= framesToBeReady || (mCblk->mFlags & CBLK_FORCEREADY)) {
1055 ALOGV("%s(%d): consider track ready with %zu/%zu, target was %zu)",
1056 __func__, mId, framesReady(), bufferSizeInFrames, framesToBeReady);
Eric Laurent81784c32012-11-19 14:55:58 -08001057 mFillingUpStatus = FS_FILLED;
Glenn Kasten96f60d82013-07-12 10:21:18 -07001058 android_atomic_and(~CBLK_FORCEREADY, &mCblk->mFlags);
Eric Laurent81784c32012-11-19 14:55:58 -08001059 return true;
1060 }
1061 return false;
1062}
1063
Glenn Kasten0f11b512014-01-31 16:18:54 -08001064status_t AudioFlinger::PlaybackThread::Track::start(AudioSystem::sync_event_t event __unused,
Glenn Kastend848eb42016-03-08 13:42:11 -08001065 audio_session_t triggerSession __unused)
Eric Laurent81784c32012-11-19 14:55:58 -08001066{
1067 status_t status = NO_ERROR;
Andy Hungc0691382018-09-12 18:01:57 -07001068 ALOGV("%s(%d): calling pid %d session %d",
1069 __func__, mId, IPCThreadState::self()->getCallingPid(), mSessionId);
Eric Laurent81784c32012-11-19 14:55:58 -08001070
1071 sp<ThreadBase> thread = mThread.promote();
1072 if (thread != 0) {
Eric Laurent813e2a72013-08-31 12:59:48 -07001073 if (isOffloaded()) {
1074 Mutex::Autolock _laf(thread->mAudioFlinger->mLock);
1075 Mutex::Autolock _lth(thread->mLock);
1076 sp<EffectChain> ec = thread->getEffectChain_l(mSessionId);
Eric Laurent5baf2af2013-09-12 17:37:00 -07001077 if (thread->mAudioFlinger->isNonOffloadableGlobalEffectEnabled_l() ||
1078 (ec != 0 && ec->isNonOffloadableEnabled())) {
Eric Laurent813e2a72013-08-31 12:59:48 -07001079 invalidate();
1080 return PERMISSION_DENIED;
1081 }
1082 }
1083 Mutex::Autolock _lth(thread->mLock);
Eric Laurent81784c32012-11-19 14:55:58 -08001084 track_state state = mState;
1085 // here the track could be either new, or restarted
1086 // in both cases "unstop" the track
Eric Laurentbfb1b832013-01-07 09:53:42 -08001087
Krishnankutty Kolathappilly8d6c2922014-02-04 16:23:42 -08001088 // initial state-stopping. next state-pausing.
1089 // What if resume is called ?
1090
Zhou Song1ed46a22020-08-17 15:36:56 +08001091 if (state == FLUSHED) {
1092 // avoid underrun glitches when starting after flush
1093 reset();
1094 }
1095
kuowei.li576f1362021-05-11 18:02:32 +08001096 // clear mPauseHwPending because of pause (and possibly flush) during underrun.
1097 mPauseHwPending = false;
Krishnankutty Kolathappilly8d6c2922014-02-04 16:23:42 -08001098 if (state == PAUSED || state == PAUSING) {
Eric Laurentbfb1b832013-01-07 09:53:42 -08001099 if (mResumeToStopping) {
1100 // happened we need to resume to STOPPING_1
1101 mState = TrackBase::STOPPING_1;
Andy Hungc0691382018-09-12 18:01:57 -07001102 ALOGV("%s(%d): PAUSED => STOPPING_1 on thread %d",
1103 __func__, mId, (int)mThreadIoHandle);
Eric Laurentbfb1b832013-01-07 09:53:42 -08001104 } else {
1105 mState = TrackBase::RESUMING;
Andy Hungc0691382018-09-12 18:01:57 -07001106 ALOGV("%s(%d): PAUSED => RESUMING on thread %d",
1107 __func__, mId, (int)mThreadIoHandle);
Eric Laurentbfb1b832013-01-07 09:53:42 -08001108 }
Eric Laurent81784c32012-11-19 14:55:58 -08001109 } else {
1110 mState = TrackBase::ACTIVE;
Andy Hungc0691382018-09-12 18:01:57 -07001111 ALOGV("%s(%d): ? => ACTIVE on thread %d",
1112 __func__, mId, (int)mThreadIoHandle);
Eric Laurent81784c32012-11-19 14:55:58 -08001113 }
1114
yucliu91503922022-07-20 17:40:39 -07001115 PlaybackThread *playbackThread = (PlaybackThread *)thread.get();
1116
1117 // states to reset position info for pcm tracks
1118 if (audio_is_linear_pcm(mFormat)
Andy Hunge10393e2015-06-12 13:59:33 -07001119 && (state == IDLE || state == STOPPED || state == FLUSHED)) {
1120 mFrameMap.reset();
yucliu91503922022-07-20 17:40:39 -07001121
1122 if (!isFastTrack() && (isDirect() || isOffloaded())) {
1123 // Start point of track -> sink frame map. If the HAL returns a
1124 // frame position smaller than the first written frame in
1125 // updateTrackFrameInfo, the timestamp can be interpolated
1126 // instead of using a larger value.
1127 mFrameMap.push(mAudioTrackServerProxy->framesReleased(),
1128 playbackThread->framesWritten());
1129 }
Andy Hunge10393e2015-06-12 13:59:33 -07001130 }
Haynes Mathew George240934b2015-03-11 18:25:50 -07001131 if (isFastTrack()) {
1132 // refresh fast track underruns on start because that field is never cleared
1133 // by the fast mixer; furthermore, the same track can be recycled, i.e. start
1134 // after stop.
1135 mObservedUnderruns = playbackThread->getFastTrackUnderruns(mFastIndex);
1136 }
Eric Laurentbfb1b832013-01-07 09:53:42 -08001137 status = playbackThread->addTrack_l(this);
1138 if (status == INVALID_OPERATION || status == PERMISSION_DENIED) {
Eric Laurent81784c32012-11-19 14:55:58 -08001139 triggerEvents(AudioSystem::SYNC_EVENT_PRESENTATION_COMPLETE);
Eric Laurentbfb1b832013-01-07 09:53:42 -08001140 // restore previous state if start was rejected by policy manager
1141 if (status == PERMISSION_DENIED) {
1142 mState = state;
1143 }
1144 }
Andy Hung1d3556d2018-03-29 16:30:14 -07001145
Andy Hungb68f5eb2019-12-03 16:49:17 -08001146 // Audio timing metrics are computed a few mix cycles after starting.
1147 {
1148 mLogStartCountdown = LOG_START_COUNTDOWN;
1149 mLogStartTimeNs = systemTime();
1150 mLogStartFrames = mAudioTrackServerProxy->getTimestamp()
Andy Hung62921122020-05-18 10:47:31 -07001151 .mPosition[ExtendedTimestamp::LOCATION_KERNEL];
1152 mLogLatencyMs = 0.;
Andy Hungb68f5eb2019-12-03 16:49:17 -08001153 }
Andy Hungcb6cc752022-05-19 19:24:51 -07001154 mLogForceVolumeUpdate = true; // at least one volume logged for metrics when starting.
Andy Hungb68f5eb2019-12-03 16:49:17 -08001155
Andy Hung1d3556d2018-03-29 16:30:14 -07001156 if (status == NO_ERROR || status == ALREADY_EXISTS) {
1157 // for streaming tracks, remove the buffer read stop limit.
1158 mAudioTrackServerProxy->start();
1159 }
1160
Eric Laurentbfb1b832013-01-07 09:53:42 -08001161 // track was already in the active list, not a problem
1162 if (status == ALREADY_EXISTS) {
1163 status = NO_ERROR;
Glenn Kasten12022ff2013-10-17 11:32:39 -07001164 } else {
1165 // Acknowledge any pending flush(), so that subsequent new data isn't discarded.
1166 // It is usually unsafe to access the server proxy from a binder thread.
1167 // But in this case we know the mixer thread (whether normal mixer or fast mixer)
1168 // isn't looking at this track yet: we still hold the normal mixer thread lock,
1169 // and for fast tracks the track is not yet in the fast mixer thread's active set.
Andy Hunge6fb82a2015-09-09 14:39:02 -07001170 // For static tracks, this is used to acknowledge change in position or loop.
Eric Laurent564d1442015-09-09 12:26:52 -07001171 ServerProxy::Buffer buffer;
1172 buffer.mFrameCount = 1;
1173 (void) mAudioTrackServerProxy->obtainBuffer(&buffer, true /*ackFlush*/);
Eric Laurent81784c32012-11-19 14:55:58 -08001174 }
1175 } else {
1176 status = BAD_VALUE;
1177 }
Kevin Rocardc43ea142019-01-31 18:17:37 -08001178 if (status == NO_ERROR) {
1179 forEachTeePatchTrack([](auto patchTrack) { patchTrack->start(); });
1180 }
Eric Laurent81784c32012-11-19 14:55:58 -08001181 return status;
1182}
1183
1184void AudioFlinger::PlaybackThread::Track::stop()
1185{
Andy Hungc0691382018-09-12 18:01:57 -07001186 ALOGV("%s(%d): calling pid %d", __func__, mId, IPCThreadState::self()->getCallingPid());
Eric Laurent81784c32012-11-19 14:55:58 -08001187 sp<ThreadBase> thread = mThread.promote();
1188 if (thread != 0) {
1189 Mutex::Autolock _l(thread->mLock);
1190 track_state state = mState;
1191 if (state == RESUMING || state == ACTIVE || state == PAUSING || state == PAUSED) {
1192 // If the track is not active (PAUSED and buffers full), flush buffers
1193 PlaybackThread *playbackThread = (PlaybackThread *)thread.get();
1194 if (playbackThread->mActiveTracks.indexOf(this) < 0) {
1195 reset();
1196 mState = STOPPED;
Eric Laurentab5cdba2014-06-09 17:22:27 -07001197 } else if (!isFastTrack() && !isOffloaded() && !isDirect()) {
Eric Laurent81784c32012-11-19 14:55:58 -08001198 mState = STOPPED;
1199 } else {
Eric Laurentbfb1b832013-01-07 09:53:42 -08001200 // For fast tracks prepareTracks_l() will set state to STOPPING_2
1201 // presentation is complete
1202 // For an offloaded track this starts a drain and state will
1203 // move to STOPPING_2 when drain completes and then STOPPED
Eric Laurent81784c32012-11-19 14:55:58 -08001204 mState = STOPPING_1;
Eric Laurente93cc032016-05-05 10:15:10 -07001205 if (isOffloaded()) {
1206 mRetryCount = PlaybackThread::kMaxTrackStopRetriesOffload;
1207 }
Eric Laurent81784c32012-11-19 14:55:58 -08001208 }
Eric Laurentb369caf2015-03-30 20:51:47 -07001209 playbackThread->broadcast_l();
Andy Hungc0691382018-09-12 18:01:57 -07001210 ALOGV("%s(%d): not stopping/stopped => stopping/stopped on thread %d",
1211 __func__, mId, (int)mThreadIoHandle);
Eric Laurent81784c32012-11-19 14:55:58 -08001212 }
Eric Laurent81784c32012-11-19 14:55:58 -08001213 }
Kevin Rocardc43ea142019-01-31 18:17:37 -08001214 forEachTeePatchTrack([](auto patchTrack) { patchTrack->stop(); });
Eric Laurent81784c32012-11-19 14:55:58 -08001215}
1216
1217void AudioFlinger::PlaybackThread::Track::pause()
1218{
Andy Hungc0691382018-09-12 18:01:57 -07001219 ALOGV("%s(%d): calling pid %d", __func__, mId, IPCThreadState::self()->getCallingPid());
Eric Laurent81784c32012-11-19 14:55:58 -08001220 sp<ThreadBase> thread = mThread.promote();
1221 if (thread != 0) {
1222 Mutex::Autolock _l(thread->mLock);
Eric Laurentbfb1b832013-01-07 09:53:42 -08001223 PlaybackThread *playbackThread = (PlaybackThread *)thread.get();
1224 switch (mState) {
1225 case STOPPING_1:
1226 case STOPPING_2:
1227 if (!isOffloaded()) {
1228 /* nothing to do if track is not offloaded */
1229 break;
1230 }
1231
1232 // Offloaded track was draining, we need to carry on draining when resumed
1233 mResumeToStopping = true;
Chih-Hung Hsieh2b487032018-09-13 14:16:02 -07001234 FALLTHROUGH_INTENDED;
Eric Laurentbfb1b832013-01-07 09:53:42 -08001235 case ACTIVE:
1236 case RESUMING:
Eric Laurent81784c32012-11-19 14:55:58 -08001237 mState = PAUSING;
Andy Hungc0691382018-09-12 18:01:57 -07001238 ALOGV("%s(%d): ACTIVE/RESUMING => PAUSING on thread %d",
1239 __func__, mId, (int)mThreadIoHandle);
Kuowei Li23666472021-01-20 10:23:25 +08001240 if (isOffloadedOrDirect()) {
1241 mPauseHwPending = true;
1242 }
Eric Laurentede6c3b2013-09-19 14:37:46 -07001243 playbackThread->broadcast_l();
Eric Laurentbfb1b832013-01-07 09:53:42 -08001244 break;
Eric Laurent81784c32012-11-19 14:55:58 -08001245
Eric Laurentbfb1b832013-01-07 09:53:42 -08001246 default:
1247 break;
Eric Laurent81784c32012-11-19 14:55:58 -08001248 }
1249 }
Kevin Rocardc43ea142019-01-31 18:17:37 -08001250 // Pausing the TeePatch to avoid a glitch on underrun, at the cost of buffered audio loss.
1251 forEachTeePatchTrack([](auto patchTrack) { patchTrack->pause(); });
Eric Laurent81784c32012-11-19 14:55:58 -08001252}
1253
1254void AudioFlinger::PlaybackThread::Track::flush()
1255{
Andy Hungc0691382018-09-12 18:01:57 -07001256 ALOGV("%s(%d)", __func__, mId);
Eric Laurent81784c32012-11-19 14:55:58 -08001257 sp<ThreadBase> thread = mThread.promote();
1258 if (thread != 0) {
1259 Mutex::Autolock _l(thread->mLock);
Eric Laurent81784c32012-11-19 14:55:58 -08001260 PlaybackThread *playbackThread = (PlaybackThread *)thread.get();
Eric Laurentbfb1b832013-01-07 09:53:42 -08001261
Phil Burk4bb650b2016-09-09 12:11:17 -07001262 // Flush the ring buffer now if the track is not active in the PlaybackThread.
1263 // Otherwise the flush would not be done until the track is resumed.
1264 // Requires FastTrack removal be BLOCK_UNTIL_ACKED
1265 if (playbackThread->mActiveTracks.indexOf(this) < 0) {
1266 (void)mServerProxy->flushBufferIfNeeded();
1267 }
1268
Eric Laurentbfb1b832013-01-07 09:53:42 -08001269 if (isOffloaded()) {
1270 // If offloaded we allow flush during any state except terminated
1271 // and keep the track active to avoid problems if user is seeking
1272 // rapidly and underlying hardware has a significant delay handling
1273 // a pause
1274 if (isTerminated()) {
1275 return;
1276 }
1277
Andy Hung9d84af52018-09-12 18:03:44 -07001278 ALOGV("%s(%d): offload flush", __func__, mId);
Eric Laurent81784c32012-11-19 14:55:58 -08001279 reset();
Eric Laurentbfb1b832013-01-07 09:53:42 -08001280
1281 if (mState == STOPPING_1 || mState == STOPPING_2) {
Andy Hung9d84af52018-09-12 18:03:44 -07001282 ALOGV("%s(%d): flushed in STOPPING_1 or 2 state, change state to ACTIVE",
1283 __func__, mId);
Eric Laurentbfb1b832013-01-07 09:53:42 -08001284 mState = ACTIVE;
1285 }
1286
Haynes Mathew George7844f672014-01-15 12:32:55 -08001287 mFlushHwPending = true;
Eric Laurentbfb1b832013-01-07 09:53:42 -08001288 mResumeToStopping = false;
1289 } else {
1290 if (mState != STOPPING_1 && mState != STOPPING_2 && mState != STOPPED &&
1291 mState != PAUSED && mState != PAUSING && mState != IDLE && mState != FLUSHED) {
1292 return;
1293 }
1294 // No point remaining in PAUSED state after a flush => go to
1295 // FLUSHED state
1296 mState = FLUSHED;
1297 // do not reset the track if it is still in the process of being stopped or paused.
1298 // this will be done by prepareTracks_l() when the track is stopped.
1299 // prepareTracks_l() will see mState == FLUSHED, then
1300 // remove from active track list, reset(), and trigger presentation complete
Eric Laurentd1f69b02014-12-15 14:33:13 -08001301 if (isDirect()) {
1302 mFlushHwPending = true;
1303 }
Eric Laurentbfb1b832013-01-07 09:53:42 -08001304 if (playbackThread->mActiveTracks.indexOf(this) < 0) {
1305 reset();
1306 }
Eric Laurent81784c32012-11-19 14:55:58 -08001307 }
Eric Laurentbfb1b832013-01-07 09:53:42 -08001308 // Prevent flush being lost if the track is flushed and then resumed
1309 // before mixer thread can run. This is important when offloading
1310 // because the hardware buffer could hold a large amount of audio
Eric Laurentede6c3b2013-09-19 14:37:46 -07001311 playbackThread->broadcast_l();
Eric Laurent81784c32012-11-19 14:55:58 -08001312 }
Kevin Rocardc43ea142019-01-31 18:17:37 -08001313 // Flush the Tee to avoid on resume playing old data and glitching on the transition to new data
1314 forEachTeePatchTrack([](auto patchTrack) { patchTrack->flush(); });
Eric Laurent81784c32012-11-19 14:55:58 -08001315}
1316
Haynes Mathew George7844f672014-01-15 12:32:55 -08001317// must be called with thread lock held
1318void AudioFlinger::PlaybackThread::Track::flushAck()
1319{
Andy Hung71ba4b32022-10-06 12:09:49 -07001320 if (!isOffloaded() && !isDirect()) {
Haynes Mathew George7844f672014-01-15 12:32:55 -08001321 return;
Andy Hung71ba4b32022-10-06 12:09:49 -07001322 }
Haynes Mathew George7844f672014-01-15 12:32:55 -08001323
Phil Burk4bb650b2016-09-09 12:11:17 -07001324 // Clear the client ring buffer so that the app can prime the buffer while paused.
1325 // Otherwise it might not get cleared until playback is resumed and obtainBuffer() is called.
1326 mServerProxy->flushBufferIfNeeded();
1327
Haynes Mathew George7844f672014-01-15 12:32:55 -08001328 mFlushHwPending = false;
1329}
1330
Kuowei Li23666472021-01-20 10:23:25 +08001331void AudioFlinger::PlaybackThread::Track::pauseAck()
1332{
1333 mPauseHwPending = false;
1334}
1335
Eric Laurent81784c32012-11-19 14:55:58 -08001336void AudioFlinger::PlaybackThread::Track::reset()
1337{
1338 // Do not reset twice to avoid discarding data written just after a flush and before
1339 // the audioflinger thread detects the track is stopped.
1340 if (!mResetDone) {
Eric Laurent81784c32012-11-19 14:55:58 -08001341 // Force underrun condition to avoid false underrun callback until first data is
1342 // written to buffer
Glenn Kasten96f60d82013-07-12 10:21:18 -07001343 android_atomic_and(~CBLK_FORCEREADY, &mCblk->mFlags);
Eric Laurent81784c32012-11-19 14:55:58 -08001344 mFillingUpStatus = FS_FILLING;
1345 mResetDone = true;
1346 if (mState == FLUSHED) {
1347 mState = IDLE;
1348 }
1349 }
1350}
1351
Eric Laurentbfb1b832013-01-07 09:53:42 -08001352status_t AudioFlinger::PlaybackThread::Track::setParameters(const String8& keyValuePairs)
1353{
1354 sp<ThreadBase> thread = mThread.promote();
1355 if (thread == 0) {
Andy Hung9d84af52018-09-12 18:03:44 -07001356 ALOGE("%s(%d): thread is dead", __func__, mId);
Eric Laurentbfb1b832013-01-07 09:53:42 -08001357 return FAILED_TRANSACTION;
1358 } else if ((thread->type() == ThreadBase::DIRECT) ||
1359 (thread->type() == ThreadBase::OFFLOAD)) {
1360 return thread->setParameters(keyValuePairs);
1361 } else {
1362 return PERMISSION_DENIED;
1363 }
1364}
1365
Mikhail Naganovac917ac2018-11-28 14:03:52 -08001366status_t AudioFlinger::PlaybackThread::Track::selectPresentation(int presentationId,
1367 int programId) {
1368 sp<ThreadBase> thread = mThread.promote();
1369 if (thread == 0) {
1370 ALOGE("thread is dead");
1371 return FAILED_TRANSACTION;
1372 } else if ((thread->type() == ThreadBase::DIRECT) || (thread->type() == ThreadBase::OFFLOAD)) {
1373 DirectOutputThread *directOutputThread = static_cast<DirectOutputThread*>(thread.get());
1374 return directOutputThread->selectPresentation(presentationId, programId);
1375 }
1376 return INVALID_OPERATION;
1377}
1378
Andy Hung9fc8b5c2017-01-24 13:36:48 -08001379VolumeShaper::Status AudioFlinger::PlaybackThread::Track::applyVolumeShaper(
1380 const sp<VolumeShaper::Configuration>& configuration,
1381 const sp<VolumeShaper::Operation>& operation)
1382{
Andy Hungee86cee2022-12-13 19:19:53 -08001383 VolumeShaper::Status status = mVolumeHandler->applyVolumeShaper(configuration, operation);
Andy Hung10cbff12017-02-21 17:30:14 -08001384
1385 if (isOffloadedOrDirect()) {
1386 // Signal thread to fetch new volume.
1387 sp<ThreadBase> thread = mThread.promote();
1388 if (thread != 0) {
Kevin Rocard5f2136e2018-05-11 22:03:00 -07001389 Mutex::Autolock _l(thread->mLock);
Andy Hung10cbff12017-02-21 17:30:14 -08001390 thread->broadcast_l();
1391 }
1392 }
1393 return status;
Andy Hung9fc8b5c2017-01-24 13:36:48 -08001394}
1395
1396sp<VolumeShaper::State> AudioFlinger::PlaybackThread::Track::getVolumeShaperState(int id)
1397{
1398 // Note: We don't check if Thread exists.
1399
1400 // mVolumeHandler is thread safe.
1401 return mVolumeHandler->getVolumeShaperState(id);
1402}
1403
Kevin Rocard12381092018-04-11 09:19:59 -07001404void AudioFlinger::PlaybackThread::Track::setFinalVolume(float volume)
1405{
1406 if (mFinalVolume != volume) { // Compare to an epsilon if too many meaningless updates
1407 mFinalVolume = volume;
1408 setMetadataHasChanged();
Andy Hungcb6cc752022-05-19 19:24:51 -07001409 mLogForceVolumeUpdate = true;
1410 }
1411 if (mLogForceVolumeUpdate) {
1412 mLogForceVolumeUpdate = false;
1413 mTrackMetrics.logVolume(mFinalVolume);
Kevin Rocard12381092018-04-11 09:19:59 -07001414 }
1415}
1416
1417void AudioFlinger::PlaybackThread::Track::copyMetadataTo(MetadataInserter& backInserter) const
1418{
Eric Laurent49e39282022-06-24 18:42:45 +02001419 // Do not forward metadata for PatchTrack with unspecified stream type
1420 if (mStreamType == AUDIO_STREAM_PATCH) {
1421 return;
1422 }
1423
Eric Laurent94579172020-11-20 18:41:04 +01001424 playback_track_metadata_v7_t metadata;
1425 metadata.base = {
Kevin Rocard12381092018-04-11 09:19:59 -07001426 .usage = mAttr.usage,
1427 .content_type = mAttr.content_type,
1428 .gain = mFinalVolume,
1429 };
Eric Laurentfdf99502021-11-26 19:05:02 +01001430
1431 // When attributes are undefined, derive default values from stream type.
1432 // See AudioAttributes.java, usageForStreamType() and Builder.setInternalLegacyStreamType()
1433 if (mAttr.usage == AUDIO_USAGE_UNKNOWN) {
1434 switch (mStreamType) {
1435 case AUDIO_STREAM_VOICE_CALL:
1436 metadata.base.usage = AUDIO_USAGE_VOICE_COMMUNICATION;
1437 metadata.base.content_type = AUDIO_CONTENT_TYPE_SPEECH;
1438 break;
1439 case AUDIO_STREAM_SYSTEM:
1440 metadata.base.usage = AUDIO_USAGE_ASSISTANCE_SONIFICATION;
1441 metadata.base.content_type = AUDIO_CONTENT_TYPE_SONIFICATION;
1442 break;
1443 case AUDIO_STREAM_RING:
1444 metadata.base.usage = AUDIO_USAGE_NOTIFICATION_TELEPHONY_RINGTONE;
1445 metadata.base.content_type = AUDIO_CONTENT_TYPE_SONIFICATION;
1446 break;
1447 case AUDIO_STREAM_MUSIC:
1448 metadata.base.usage = AUDIO_USAGE_MEDIA;
1449 metadata.base.content_type = AUDIO_CONTENT_TYPE_MUSIC;
1450 break;
1451 case AUDIO_STREAM_ALARM:
1452 metadata.base.usage = AUDIO_USAGE_ALARM;
1453 metadata.base.content_type = AUDIO_CONTENT_TYPE_SONIFICATION;
1454 break;
1455 case AUDIO_STREAM_NOTIFICATION:
1456 metadata.base.usage = AUDIO_USAGE_NOTIFICATION;
1457 metadata.base.content_type = AUDIO_CONTENT_TYPE_SONIFICATION;
1458 break;
1459 case AUDIO_STREAM_DTMF:
1460 metadata.base.usage = AUDIO_USAGE_VOICE_COMMUNICATION_SIGNALLING;
1461 metadata.base.content_type = AUDIO_CONTENT_TYPE_SONIFICATION;
1462 break;
1463 case AUDIO_STREAM_ACCESSIBILITY:
1464 metadata.base.usage = AUDIO_USAGE_ASSISTANCE_ACCESSIBILITY;
1465 metadata.base.content_type = AUDIO_CONTENT_TYPE_SPEECH;
1466 break;
1467 case AUDIO_STREAM_ASSISTANT:
1468 metadata.base.usage = AUDIO_USAGE_ASSISTANT;
1469 metadata.base.content_type = AUDIO_CONTENT_TYPE_SPEECH;
1470 break;
1471 case AUDIO_STREAM_REROUTING:
1472 metadata.base.usage = AUDIO_USAGE_VIRTUAL_SOURCE;
1473 // unknown content type
1474 break;
1475 case AUDIO_STREAM_CALL_ASSISTANT:
1476 metadata.base.usage = AUDIO_USAGE_CALL_ASSISTANT;
1477 metadata.base.content_type = AUDIO_CONTENT_TYPE_SPEECH;
1478 break;
1479 default:
1480 break;
1481 }
1482 }
1483
Eric Laurent78b07302022-10-07 16:20:34 +02001484 metadata.channel_mask = mChannelMask;
Eric Laurent94579172020-11-20 18:41:04 +01001485 strncpy(metadata.tags, mAttr.tags, AUDIO_ATTRIBUTES_TAGS_MAX_SIZE);
1486 *backInserter++ = metadata;
Kevin Rocard12381092018-04-11 09:19:59 -07001487}
1488
Kevin Rocard153f92d2018-12-18 18:33:28 -08001489void AudioFlinger::PlaybackThread::Track::setTeePatches(TeePatches teePatches) {
Kevin Rocardc43ea142019-01-31 18:17:37 -08001490 forEachTeePatchTrack([](auto patchTrack) { patchTrack->destroy(); });
Kevin Rocard153f92d2018-12-18 18:33:28 -08001491 mTeePatches = std::move(teePatches);
jiabinf042b9b2021-05-07 23:46:28 +00001492 if (mState == TrackBase::ACTIVE || mState == TrackBase::RESUMING ||
1493 mState == TrackBase::STOPPING_1) {
1494 forEachTeePatchTrack([](auto patchTrack) { patchTrack->start(); });
1495 }
Kevin Rocard153f92d2018-12-18 18:33:28 -08001496}
1497
Glenn Kasten573d80a2013-08-26 09:36:23 -07001498status_t AudioFlinger::PlaybackThread::Track::getTimestamp(AudioTimestamp& timestamp)
1499{
Andy Hung818e7a32016-02-16 18:08:07 -08001500 if (!isOffloaded() && !isDirect()) {
1501 return INVALID_OPERATION; // normal tracks handled through SSQ
Glenn Kastenfe346c72013-08-30 13:28:22 -07001502 }
Glenn Kasten573d80a2013-08-26 09:36:23 -07001503 sp<ThreadBase> thread = mThread.promote();
1504 if (thread == 0) {
Glenn Kastenfe346c72013-08-30 13:28:22 -07001505 return INVALID_OPERATION;
Glenn Kasten573d80a2013-08-26 09:36:23 -07001506 }
Phil Burk6140c792015-03-19 14:30:21 -07001507
Glenn Kasten573d80a2013-08-26 09:36:23 -07001508 Mutex::Autolock _l(thread->mLock);
1509 PlaybackThread *playbackThread = (PlaybackThread *)thread.get();
Andy Hung818e7a32016-02-16 18:08:07 -08001510 return playbackThread->getTimestamp_l(timestamp);
Glenn Kasten573d80a2013-08-26 09:36:23 -07001511}
1512
Eric Laurent81784c32012-11-19 14:55:58 -08001513status_t AudioFlinger::PlaybackThread::Track::attachAuxEffect(int EffectId)
1514{
Eric Laurent81784c32012-11-19 14:55:58 -08001515 sp<ThreadBase> thread = mThread.promote();
Eric Laurent6c796322019-04-09 14:13:17 -07001516 if (thread == nullptr) {
1517 return DEAD_OBJECT;
1518 }
Eric Laurent81784c32012-11-19 14:55:58 -08001519
Eric Laurent6c796322019-04-09 14:13:17 -07001520 sp<PlaybackThread> dstThread = (PlaybackThread *)thread.get();
1521 sp<PlaybackThread> srcThread; // srcThread is initialized by call to moveAuxEffectToIo()
1522 sp<AudioFlinger> af = mClient->audioFlinger();
1523 status_t status = af->moveAuxEffectToIo(EffectId, dstThread, &srcThread);
Eric Laurent81784c32012-11-19 14:55:58 -08001524
Eric Laurent6c796322019-04-09 14:13:17 -07001525 if (EffectId != 0 && status == NO_ERROR) {
1526 status = dstThread->attachAuxEffect(this, EffectId);
1527 if (status == NO_ERROR) {
1528 AudioSystem::moveEffectsToIo(std::vector<int>(EffectId), dstThread->id());
Eric Laurent81784c32012-11-19 14:55:58 -08001529 }
Eric Laurent6c796322019-04-09 14:13:17 -07001530 }
1531
1532 if (status != NO_ERROR && srcThread != nullptr) {
1533 af->moveAuxEffectToIo(EffectId, srcThread, &dstThread);
Eric Laurent81784c32012-11-19 14:55:58 -08001534 }
1535 return status;
1536}
1537
1538void AudioFlinger::PlaybackThread::Track::setAuxBuffer(int EffectId, int32_t *buffer)
1539{
1540 mAuxEffectId = EffectId;
1541 mAuxBuffer = buffer;
1542}
1543
Andy Hung59de4262021-06-14 10:53:54 -07001544// presentationComplete verified by frames, used by Mixed tracks.
Andy Hung818e7a32016-02-16 18:08:07 -08001545bool AudioFlinger::PlaybackThread::Track::presentationComplete(
1546 int64_t framesWritten, size_t audioHalFrames)
Eric Laurent81784c32012-11-19 14:55:58 -08001547{
Andy Hung818e7a32016-02-16 18:08:07 -08001548 // TODO: improve this based on FrameMap if it exists, to ensure full drain.
1549 // This assists in proper timestamp computation as well as wakelock management.
1550
Eric Laurent81784c32012-11-19 14:55:58 -08001551 // a track is considered presented when the total number of frames written to audio HAL
1552 // corresponds to the number of frames written when presentationComplete() is called for the
1553 // first time (mPresentationCompleteFrames == 0) plus the buffer filling status at that time.
Eric Laurentbfb1b832013-01-07 09:53:42 -08001554 // For an offloaded track the HAL+h/w delay is variable so a HAL drain() is used
1555 // to detect when all frames have been played. In this case framesWritten isn't
1556 // useful because it doesn't always reflect whether there is data in the h/w
1557 // buffers, particularly if a track has been paused and resumed during draining
Andy Hung9d84af52018-09-12 18:03:44 -07001558 ALOGV("%s(%d): presentationComplete() mPresentationCompleteFrames %lld framesWritten %lld",
1559 __func__, mId,
Andy Hung818e7a32016-02-16 18:08:07 -08001560 (long long)mPresentationCompleteFrames, (long long)framesWritten);
Eric Laurent81784c32012-11-19 14:55:58 -08001561 if (mPresentationCompleteFrames == 0) {
1562 mPresentationCompleteFrames = framesWritten + audioHalFrames;
Andy Hung59de4262021-06-14 10:53:54 -07001563 ALOGV("%s(%d): set:"
Andy Hung9d84af52018-09-12 18:03:44 -07001564 " mPresentationCompleteFrames %lld audioHalFrames %zu",
1565 __func__, mId,
Andy Hung818e7a32016-02-16 18:08:07 -08001566 (long long)mPresentationCompleteFrames, audioHalFrames);
Eric Laurent81784c32012-11-19 14:55:58 -08001567 }
Eric Laurentbfb1b832013-01-07 09:53:42 -08001568
Andy Hungc54b1ff2016-02-23 14:07:07 -08001569 bool complete;
Andy Hung59de4262021-06-14 10:53:54 -07001570 if (isFastTrack()) { // does not go through linear map
Glenn Kastenc42e9b42016-03-21 11:35:03 -07001571 complete = framesWritten >= (int64_t) mPresentationCompleteFrames;
Andy Hung59de4262021-06-14 10:53:54 -07001572 ALOGV("%s(%d): %s framesWritten:%lld mPresentationCompleteFrames:%lld",
1573 __func__, mId, (complete ? "complete" : "waiting"),
1574 (long long) framesWritten, (long long) mPresentationCompleteFrames);
Andy Hungc54b1ff2016-02-23 14:07:07 -08001575 } else { // Normal tracks, OutputTracks, and PatchTracks
Glenn Kastenc42e9b42016-03-21 11:35:03 -07001576 complete = framesWritten >= (int64_t) mPresentationCompleteFrames
Andy Hungc54b1ff2016-02-23 14:07:07 -08001577 && mAudioTrackServerProxy->isDrained();
1578 }
1579
1580 if (complete) {
Andy Hung59de4262021-06-14 10:53:54 -07001581 notifyPresentationComplete();
Eric Laurent81784c32012-11-19 14:55:58 -08001582 return true;
1583 }
1584 return false;
1585}
1586
Andy Hung59de4262021-06-14 10:53:54 -07001587// presentationComplete checked by time, used by DirectTracks.
1588bool AudioFlinger::PlaybackThread::Track::presentationComplete(uint32_t latencyMs)
1589{
1590 // For Offloaded or Direct tracks.
1591
1592 // For a direct track, we incorporated time based testing for presentationComplete.
1593
1594 // For an offloaded track the HAL+h/w delay is variable so a HAL drain() is used
1595 // to detect when all frames have been played. In this case latencyMs isn't
1596 // useful because it doesn't always reflect whether there is data in the h/w
1597 // buffers, particularly if a track has been paused and resumed during draining
1598
1599 constexpr float MIN_SPEED = 0.125f; // min speed scaling allowed for timely response.
1600 if (mPresentationCompleteTimeNs == 0) {
1601 mPresentationCompleteTimeNs = systemTime() + latencyMs * 1e6 / fmax(mSpeed, MIN_SPEED);
1602 ALOGV("%s(%d): set: latencyMs %u mPresentationCompleteTimeNs:%lld",
1603 __func__, mId, latencyMs, (long long) mPresentationCompleteTimeNs);
1604 }
1605
1606 bool complete;
1607 if (isOffloaded()) {
1608 complete = true;
1609 } else { // Direct
1610 complete = systemTime() >= mPresentationCompleteTimeNs;
1611 ALOGV("%s(%d): %s", __func__, mId, (complete ? "complete" : "waiting"));
1612 }
1613 if (complete) {
1614 notifyPresentationComplete();
1615 return true;
1616 }
1617 return false;
1618}
1619
1620void AudioFlinger::PlaybackThread::Track::notifyPresentationComplete()
1621{
1622 // This only triggers once. TODO: should we enforce this?
1623 triggerEvents(AudioSystem::SYNC_EVENT_PRESENTATION_COMPLETE);
1624 mAudioTrackServerProxy->setStreamEndDone();
1625}
1626
Eric Laurent81784c32012-11-19 14:55:58 -08001627void AudioFlinger::PlaybackThread::Track::triggerEvents(AudioSystem::sync_event_t type)
1628{
Andy Hung068e08e2023-05-15 19:02:55 -07001629 for (auto it = mSyncEvents.begin(); it != mSyncEvents.end();) {
1630 if ((*it)->type() == type) {
Andy Hung93bb5732023-05-04 21:16:34 -07001631 ALOGV("%s: triggering SyncEvent type %d", __func__, type);
Andy Hung068e08e2023-05-15 19:02:55 -07001632 (*it)->trigger();
1633 it = mSyncEvents.erase(it);
Ivan Lozano5ec161b2017-12-06 10:00:28 -08001634 } else {
Andy Hung068e08e2023-05-15 19:02:55 -07001635 ++it;
Eric Laurent81784c32012-11-19 14:55:58 -08001636 }
1637 }
1638}
1639
1640// implement VolumeBufferProvider interface
1641
Glenn Kastenc56f3422014-03-21 17:53:17 -07001642gain_minifloat_packed_t AudioFlinger::PlaybackThread::Track::getVolumeLR()
Eric Laurent81784c32012-11-19 14:55:58 -08001643{
1644 // called by FastMixer, so not allowed to take any locks, block, or do I/O including logs
1645 ALOG_ASSERT(isFastTrack() && (mCblk != NULL));
Glenn Kastenc56f3422014-03-21 17:53:17 -07001646 gain_minifloat_packed_t vlr = mAudioTrackServerProxy->getVolumeLR();
1647 float vl = float_from_gain(gain_minifloat_unpack_left(vlr));
1648 float vr = float_from_gain(gain_minifloat_unpack_right(vlr));
Eric Laurent81784c32012-11-19 14:55:58 -08001649 // track volumes come from shared memory, so can't be trusted and must be clamped
Glenn Kastenc56f3422014-03-21 17:53:17 -07001650 if (vl > GAIN_FLOAT_UNITY) {
1651 vl = GAIN_FLOAT_UNITY;
Eric Laurent81784c32012-11-19 14:55:58 -08001652 }
Glenn Kastenc56f3422014-03-21 17:53:17 -07001653 if (vr > GAIN_FLOAT_UNITY) {
1654 vr = GAIN_FLOAT_UNITY;
Eric Laurent81784c32012-11-19 14:55:58 -08001655 }
1656 // now apply the cached master volume and stream type volume;
1657 // this is trusted but lacks any synchronization or barrier so may be stale
1658 float v = mCachedVolume;
1659 vl *= v;
1660 vr *= v;
Glenn Kastenc56f3422014-03-21 17:53:17 -07001661 // re-combine into packed minifloat
1662 vlr = gain_minifloat_pack(gain_from_float(vl), gain_from_float(vr));
Eric Laurent81784c32012-11-19 14:55:58 -08001663 // FIXME look at mute, pause, and stop flags
1664 return vlr;
1665}
1666
Andy Hung068e08e2023-05-15 19:02:55 -07001667status_t AudioFlinger::PlaybackThread::Track::setSyncEvent(
1668 const sp<audioflinger::SyncEvent>& event)
Eric Laurent81784c32012-11-19 14:55:58 -08001669{
Eric Laurentbfb1b832013-01-07 09:53:42 -08001670 if (isTerminated() || mState == PAUSED ||
Eric Laurent81784c32012-11-19 14:55:58 -08001671 ((framesReady() == 0) && ((mSharedBuffer != 0) ||
1672 (mState == STOPPED)))) {
Andy Hung9d84af52018-09-12 18:03:44 -07001673 ALOGW("%s(%d): in invalid state %d on session %d %s mode, framesReady %zu",
1674 __func__, mId,
Andy Hung959b5b82021-09-24 10:46:20 -07001675 (int)mState, mSessionId, (mSharedBuffer != 0) ? "static" : "stream", framesReady());
Eric Laurent81784c32012-11-19 14:55:58 -08001676 event->cancel();
1677 return INVALID_OPERATION;
1678 }
1679 (void) TrackBase::setSyncEvent(event);
1680 return NO_ERROR;
1681}
1682
Glenn Kasten5736c352012-12-04 12:12:34 -08001683void AudioFlinger::PlaybackThread::Track::invalidate()
1684{
Eric Laurent6acd1d42017-01-04 14:23:29 -08001685 TrackBase::invalidate();
Eric Laurent4d231dc2016-03-11 18:38:23 -08001686 signalClientFlag(CBLK_INVALID);
Eric Laurent4d231dc2016-03-11 18:38:23 -08001687}
1688
1689void AudioFlinger::PlaybackThread::Track::disable()
1690{
Kevin Rocard01c7d9e2019-09-18 11:24:52 +01001691 // TODO(b/142394888): the filling status should also be reset to filling
Eric Laurent4d231dc2016-03-11 18:38:23 -08001692 signalClientFlag(CBLK_DISABLED);
1693}
1694
1695void AudioFlinger::PlaybackThread::Track::signalClientFlag(int32_t flag)
1696{
Glenn Kasten9f80dd22012-12-18 15:57:32 -08001697 // FIXME should use proxy, and needs work
1698 audio_track_cblk_t* cblk = mCblk;
Eric Laurent4d231dc2016-03-11 18:38:23 -08001699 android_atomic_or(flag, &cblk->mFlags);
Glenn Kasten9f80dd22012-12-18 15:57:32 -08001700 android_atomic_release_store(0x40000000, &cblk->mFutex);
1701 // client is not in server, so FUTEX_WAKE is needed instead of FUTEX_WAKE_PRIVATE
Elliott Hughesee499292014-05-21 17:55:51 -07001702 (void) syscall(__NR_futex, &cblk->mFutex, FUTEX_WAKE, INT_MAX);
Glenn Kasten5736c352012-12-04 12:12:34 -08001703}
1704
Eric Laurent59fe0102013-09-27 18:48:26 -07001705void AudioFlinger::PlaybackThread::Track::signal()
1706{
1707 sp<ThreadBase> thread = mThread.promote();
1708 if (thread != 0) {
1709 PlaybackThread *t = (PlaybackThread *)thread.get();
1710 Mutex::Autolock _l(t->mLock);
1711 t->broadcast_l();
1712 }
1713}
1714
Kuowei Lid4adbdb2020-08-13 14:44:25 +08001715status_t AudioFlinger::PlaybackThread::Track::getDualMonoMode(audio_dual_mono_mode_t* mode)
1716{
1717 status_t status = INVALID_OPERATION;
1718 if (isOffloadedOrDirect()) {
1719 sp<ThreadBase> thread = mThread.promote();
1720 if (thread != nullptr) {
1721 PlaybackThread *t = (PlaybackThread *)thread.get();
1722 Mutex::Autolock _l(t->mLock);
1723 status = t->mOutput->stream->getDualMonoMode(mode);
1724 ALOGD_IF((status == NO_ERROR) && (mDualMonoMode != *mode),
1725 "%s: mode %d inconsistent", __func__, mDualMonoMode);
1726 }
1727 }
1728 return status;
1729}
1730
1731status_t AudioFlinger::PlaybackThread::Track::setDualMonoMode(audio_dual_mono_mode_t mode)
1732{
1733 status_t status = INVALID_OPERATION;
1734 if (isOffloadedOrDirect()) {
1735 sp<ThreadBase> thread = mThread.promote();
1736 if (thread != nullptr) {
1737 auto t = static_cast<PlaybackThread *>(thread.get());
1738 Mutex::Autolock lock(t->mLock);
1739 status = t->mOutput->stream->setDualMonoMode(mode);
1740 if (status == NO_ERROR) {
1741 mDualMonoMode = mode;
1742 }
1743 }
1744 }
1745 return status;
1746}
1747
1748status_t AudioFlinger::PlaybackThread::Track::getAudioDescriptionMixLevel(float* leveldB)
1749{
1750 status_t status = INVALID_OPERATION;
1751 if (isOffloadedOrDirect()) {
1752 sp<ThreadBase> thread = mThread.promote();
1753 if (thread != nullptr) {
1754 auto t = static_cast<PlaybackThread *>(thread.get());
1755 Mutex::Autolock lock(t->mLock);
1756 status = t->mOutput->stream->getAudioDescriptionMixLevel(leveldB);
1757 ALOGD_IF((status == NO_ERROR) && (mAudioDescriptionMixLevel != *leveldB),
1758 "%s: level %.3f inconsistent", __func__, mAudioDescriptionMixLevel);
1759 }
1760 }
1761 return status;
1762}
1763
1764status_t AudioFlinger::PlaybackThread::Track::setAudioDescriptionMixLevel(float leveldB)
1765{
1766 status_t status = INVALID_OPERATION;
1767 if (isOffloadedOrDirect()) {
1768 sp<ThreadBase> thread = mThread.promote();
1769 if (thread != nullptr) {
1770 auto t = static_cast<PlaybackThread *>(thread.get());
1771 Mutex::Autolock lock(t->mLock);
1772 status = t->mOutput->stream->setAudioDescriptionMixLevel(leveldB);
1773 if (status == NO_ERROR) {
1774 mAudioDescriptionMixLevel = leveldB;
1775 }
1776 }
1777 }
1778 return status;
1779}
1780
1781status_t AudioFlinger::PlaybackThread::Track::getPlaybackRateParameters(
1782 audio_playback_rate_t* playbackRate)
1783{
1784 status_t status = INVALID_OPERATION;
1785 if (isOffloadedOrDirect()) {
1786 sp<ThreadBase> thread = mThread.promote();
1787 if (thread != nullptr) {
1788 auto t = static_cast<PlaybackThread *>(thread.get());
1789 Mutex::Autolock lock(t->mLock);
1790 status = t->mOutput->stream->getPlaybackRateParameters(playbackRate);
1791 ALOGD_IF((status == NO_ERROR) &&
1792 !isAudioPlaybackRateEqual(mPlaybackRateParameters, *playbackRate),
1793 "%s: playbackRate inconsistent", __func__);
1794 }
1795 }
1796 return status;
1797}
1798
1799status_t AudioFlinger::PlaybackThread::Track::setPlaybackRateParameters(
1800 const audio_playback_rate_t& playbackRate)
1801{
1802 status_t status = INVALID_OPERATION;
1803 if (isOffloadedOrDirect()) {
1804 sp<ThreadBase> thread = mThread.promote();
1805 if (thread != nullptr) {
1806 auto t = static_cast<PlaybackThread *>(thread.get());
1807 Mutex::Autolock lock(t->mLock);
1808 status = t->mOutput->stream->setPlaybackRateParameters(playbackRate);
1809 if (status == NO_ERROR) {
1810 mPlaybackRateParameters = playbackRate;
1811 }
1812 }
1813 }
1814 return status;
1815}
1816
Krishnankutty Kolathappilly8d6c2922014-02-04 16:23:42 -08001817//To be called with thread lock held
1818bool AudioFlinger::PlaybackThread::Track::isResumePending() {
Andy Hung71ba4b32022-10-06 12:09:49 -07001819 if (mState == RESUMING) {
Krishnankutty Kolathappilly8d6c2922014-02-04 16:23:42 -08001820 return true;
Andy Hung71ba4b32022-10-06 12:09:49 -07001821 }
Krishnankutty Kolathappilly8d6c2922014-02-04 16:23:42 -08001822 /* Resume is pending if track was stopping before pause was called */
1823 if (mState == STOPPING_1 &&
Andy Hung71ba4b32022-10-06 12:09:49 -07001824 mResumeToStopping) {
Krishnankutty Kolathappilly8d6c2922014-02-04 16:23:42 -08001825 return true;
Andy Hung71ba4b32022-10-06 12:09:49 -07001826 }
Krishnankutty Kolathappilly8d6c2922014-02-04 16:23:42 -08001827
1828 return false;
1829}
1830
1831//To be called with thread lock held
1832void AudioFlinger::PlaybackThread::Track::resumeAck() {
Andy Hung71ba4b32022-10-06 12:09:49 -07001833 if (mState == RESUMING) {
Krishnankutty Kolathappilly8d6c2922014-02-04 16:23:42 -08001834 mState = ACTIVE;
Andy Hung71ba4b32022-10-06 12:09:49 -07001835 }
Haynes Mathew George2d3ca682014-03-07 13:43:49 -08001836
Krishnankutty Kolathappilly8d6c2922014-02-04 16:23:42 -08001837 // Other possibility of pending resume is stopping_1 state
1838 // Do not update the state from stopping as this prevents
Haynes Mathew George2d3ca682014-03-07 13:43:49 -08001839 // drain being called.
1840 if (mState == STOPPING_1) {
1841 mResumeToStopping = false;
1842 }
Krishnankutty Kolathappilly8d6c2922014-02-04 16:23:42 -08001843}
Andy Hunge10393e2015-06-12 13:59:33 -07001844
1845//To be called with thread lock held
1846void AudioFlinger::PlaybackThread::Track::updateTrackFrameInfo(
Andy Hung818e7a32016-02-16 18:08:07 -08001847 int64_t trackFramesReleased, int64_t sinkFramesWritten,
Andy Hungcef2daa2018-06-01 15:31:49 -07001848 uint32_t halSampleRate, const ExtendedTimestamp &timeStamp) {
Andy Hung30282562018-08-08 18:27:03 -07001849 // Make the kernel frametime available.
1850 const FrameTime ft{
1851 timeStamp.mPosition[ExtendedTimestamp::LOCATION_KERNEL],
1852 timeStamp.mTimeNs[ExtendedTimestamp::LOCATION_KERNEL]};
1853 // ALOGD("FrameTime: %lld %lld", (long long)ft.frames, (long long)ft.timeNs);
1854 mKernelFrameTime.store(ft);
1855 if (!audio_is_linear_pcm(mFormat)) {
1856 return;
1857 }
1858
Andy Hung818e7a32016-02-16 18:08:07 -08001859 //update frame map
Andy Hunge10393e2015-06-12 13:59:33 -07001860 mFrameMap.push(trackFramesReleased, sinkFramesWritten);
Andy Hung818e7a32016-02-16 18:08:07 -08001861
1862 // adjust server times and set drained state.
1863 //
1864 // Our timestamps are only updated when the track is on the Thread active list.
1865 // We need to ensure that tracks are not removed before full drain.
1866 ExtendedTimestamp local = timeStamp;
Andy Hungcef2daa2018-06-01 15:31:49 -07001867 bool drained = true; // default assume drained, if no server info found
Andy Hung818e7a32016-02-16 18:08:07 -08001868 bool checked = false;
1869 for (int i = ExtendedTimestamp::LOCATION_MAX - 1;
1870 i >= ExtendedTimestamp::LOCATION_SERVER; --i) {
1871 // Lookup the track frame corresponding to the sink frame position.
1872 if (local.mTimeNs[i] > 0) {
1873 local.mPosition[i] = mFrameMap.findX(local.mPosition[i]);
1874 // check drain state from the latest stage in the pipeline.
Andy Hung6d7b1192016-05-07 22:59:48 -07001875 if (!checked && i <= ExtendedTimestamp::LOCATION_KERNEL) {
Andy Hungcef2daa2018-06-01 15:31:49 -07001876 drained = local.mPosition[i] >= mAudioTrackServerProxy->framesReleased();
Andy Hung818e7a32016-02-16 18:08:07 -08001877 checked = true;
1878 }
1879 }
Andy Hunge10393e2015-06-12 13:59:33 -07001880 }
Andy Hungcef2daa2018-06-01 15:31:49 -07001881
Andy Hung93bb5732023-05-04 21:16:34 -07001882 ALOGV("%s: trackFramesReleased:%lld sinkFramesWritten:%lld setDrained: %d",
1883 __func__, (long long)trackFramesReleased, (long long)sinkFramesWritten, drained);
Andy Hungcef2daa2018-06-01 15:31:49 -07001884 mAudioTrackServerProxy->setDrained(drained);
Andy Hungea2b9c02016-02-12 17:06:53 -08001885 // Set correction for flushed frames that are not accounted for in released.
Andy Hungea2b9c02016-02-12 17:06:53 -08001886 local.mFlushed = mAudioTrackServerProxy->framesFlushed();
Andy Hung818e7a32016-02-16 18:08:07 -08001887 mServerProxy->setTimestamp(local);
Andy Hungcef2daa2018-06-01 15:31:49 -07001888
1889 // Compute latency info.
1890 const bool useTrackTimestamp = !drained;
1891 const double latencyMs = useTrackTimestamp
1892 ? local.getOutputServerLatencyMs(sampleRate())
1893 : timeStamp.getOutputServerLatencyMs(halSampleRate);
1894
1895 mServerLatencyFromTrack.store(useTrackTimestamp);
1896 mServerLatencyMs.store(latencyMs);
Andy Hungb68f5eb2019-12-03 16:49:17 -08001897
Andy Hung62921122020-05-18 10:47:31 -07001898 if (mLogStartCountdown > 0
1899 && local.mTimeNs[ExtendedTimestamp::LOCATION_KERNEL] > 0
1900 && local.mPosition[ExtendedTimestamp::LOCATION_KERNEL] > 0)
1901 {
1902 if (mLogStartCountdown > 1) {
1903 --mLogStartCountdown;
1904 } else if (latencyMs < mLogLatencyMs) { // wait for latency to stabilize (dip)
1905 mLogStartCountdown = 0;
Andy Hungb68f5eb2019-12-03 16:49:17 -08001906 // startup is the difference in times for the current timestamp and our start
1907 double startUpMs =
Andy Hung62921122020-05-18 10:47:31 -07001908 (local.mTimeNs[ExtendedTimestamp::LOCATION_KERNEL] - mLogStartTimeNs) * 1e-6;
Andy Hungb68f5eb2019-12-03 16:49:17 -08001909 // adjust for frames played.
Andy Hung62921122020-05-18 10:47:31 -07001910 startUpMs -= (local.mPosition[ExtendedTimestamp::LOCATION_KERNEL] - mLogStartFrames)
1911 * 1e3 / mSampleRate;
1912 ALOGV("%s: latencyMs:%lf startUpMs:%lf"
1913 " localTime:%lld startTime:%lld"
1914 " localPosition:%lld startPosition:%lld",
1915 __func__, latencyMs, startUpMs,
1916 (long long)local.mTimeNs[ExtendedTimestamp::LOCATION_KERNEL],
Andy Hungb68f5eb2019-12-03 16:49:17 -08001917 (long long)mLogStartTimeNs,
Andy Hung62921122020-05-18 10:47:31 -07001918 (long long)local.mPosition[ExtendedTimestamp::LOCATION_KERNEL],
Andy Hungb68f5eb2019-12-03 16:49:17 -08001919 (long long)mLogStartFrames);
Andy Hungc2b11cb2020-04-22 09:04:01 -07001920 mTrackMetrics.logLatencyAndStartup(latencyMs, startUpMs);
Andy Hungb68f5eb2019-12-03 16:49:17 -08001921 }
Andy Hung62921122020-05-18 10:47:31 -07001922 mLogLatencyMs = latencyMs;
Andy Hungb68f5eb2019-12-03 16:49:17 -08001923 }
Andy Hunge10393e2015-06-12 13:59:33 -07001924}
1925
SPeak Shen0db56b32022-11-11 00:28:50 +08001926bool AudioFlinger::PlaybackThread::Track::AudioVibrationController::setMute(bool muted) {
jiabin57303cc2018-12-18 15:45:57 -08001927 sp<ThreadBase> thread = mTrack->mThread.promote();
1928 if (thread != 0) {
1929 // Lock for updating mHapticPlaybackEnabled.
1930 Mutex::Autolock _l(thread->mLock);
1931 PlaybackThread *playbackThread = (PlaybackThread *)thread.get();
1932 if ((mTrack->channelMask() & AUDIO_CHANNEL_HAPTIC_ALL) != AUDIO_CHANNEL_NONE
1933 && playbackThread->mHapticChannelCount > 0) {
SPeak Shen0db56b32022-11-11 00:28:50 +08001934 mTrack->setHapticPlaybackEnabled(!muted);
1935 return true;
jiabin57303cc2018-12-18 15:45:57 -08001936 }
1937 }
SPeak Shen0db56b32022-11-11 00:28:50 +08001938 return false;
1939}
1940
1941binder::Status AudioFlinger::PlaybackThread::Track::AudioVibrationController::mute(
1942 /*out*/ bool *ret) {
1943 *ret = setMute(true);
jiabin57303cc2018-12-18 15:45:57 -08001944 return binder::Status::ok();
1945}
1946
1947binder::Status AudioFlinger::PlaybackThread::Track::AudioVibrationController::unmute(
1948 /*out*/ bool *ret) {
SPeak Shen0db56b32022-11-11 00:28:50 +08001949 *ret = setMute(false);
jiabin57303cc2018-12-18 15:45:57 -08001950 return binder::Status::ok();
1951}
1952
Eric Laurent81784c32012-11-19 14:55:58 -08001953// ----------------------------------------------------------------------------
Andy Hung9d84af52018-09-12 18:03:44 -07001954#undef LOG_TAG
1955#define LOG_TAG "AF::OutputTrack"
Eric Laurent81784c32012-11-19 14:55:58 -08001956
Eric Laurent81784c32012-11-19 14:55:58 -08001957AudioFlinger::PlaybackThread::OutputTrack::OutputTrack(
1958 PlaybackThread *playbackThread,
1959 DuplicatingThread *sourceThread,
1960 uint32_t sampleRate,
1961 audio_format_t format,
1962 audio_channel_mask_t channelMask,
Marco Nelissen462fd2f2013-01-14 14:12:05 -08001963 size_t frameCount,
Svet Ganov33761132021-05-13 22:51:08 +00001964 const AttributionSourceState& attributionSource)
Eric Laurent223fd5c2014-11-11 13:43:36 -08001965 : Track(playbackThread, NULL, AUDIO_STREAM_PATCH,
Kevin Rocard1f564ac2018-03-29 13:53:10 -07001966 audio_attributes_t{} /* currently unused for output track */,
Eric Laurent223fd5c2014-11-11 13:43:36 -08001967 sampleRate, format, channelMask, frameCount,
Andy Hung8fe68032017-06-05 16:17:51 -07001968 nullptr /* buffer */, (size_t)0 /* bufferSize */, nullptr /* sharedBuffer */,
Svet Ganov33761132021-05-13 22:51:08 +00001969 AUDIO_SESSION_NONE, getpid(), attributionSource, AUDIO_OUTPUT_FLAG_NONE,
Glenn Kastend848eb42016-03-08 13:42:11 -08001970 TYPE_OUTPUT),
Eric Laurent5bba2f62016-03-18 11:14:14 -07001971 mActive(false), mSourceThread(sourceThread)
Eric Laurent81784c32012-11-19 14:55:58 -08001972{
1973
1974 if (mCblk != NULL) {
Eric Laurent81784c32012-11-19 14:55:58 -08001975 mOutBuffer.frameCount = 0;
1976 playbackThread->mTracks.add(this);
Andy Hung9d84af52018-09-12 18:03:44 -07001977 ALOGV("%s(): mCblk %p, mBuffer %p, "
Glenn Kastenc42e9b42016-03-21 11:35:03 -07001978 "frameCount %zu, mChannelMask 0x%08x",
Andy Hung9d84af52018-09-12 18:03:44 -07001979 __func__, mCblk, mBuffer,
Glenn Kasten74935e42013-12-19 08:56:45 -08001980 frameCount, mChannelMask);
Glenn Kastene3aa6592012-12-04 12:22:46 -08001981 // since client and server are in the same process,
1982 // the buffer has the same virtual address on both sides
Glenn Kasten529c61b2014-07-18 15:31:02 -07001983 mClientProxy = new AudioTrackClientProxy(mCblk, mBuffer, mFrameCount, mFrameSize,
1984 true /*clientInServer*/);
Glenn Kastenc56f3422014-03-21 17:53:17 -07001985 mClientProxy->setVolumeLR(GAIN_MINIFLOAT_PACKED_UNITY);
Eric Laurent8d2d4932013-04-25 12:56:18 -07001986 mClientProxy->setSendLevel(0.0);
1987 mClientProxy->setSampleRate(sampleRate);
Eric Laurent81784c32012-11-19 14:55:58 -08001988 } else {
Andy Hung9d84af52018-09-12 18:03:44 -07001989 ALOGW("%s(%d): Error creating output track on thread %d",
1990 __func__, mId, (int)mThreadIoHandle);
Eric Laurent81784c32012-11-19 14:55:58 -08001991 }
1992}
1993
1994AudioFlinger::PlaybackThread::OutputTrack::~OutputTrack()
1995{
1996 clearBufferQueue();
Glenn Kastene3aa6592012-12-04 12:22:46 -08001997 // superclass destructor will now delete the server proxy and shared memory both refer to
Eric Laurent81784c32012-11-19 14:55:58 -08001998}
1999
2000status_t AudioFlinger::PlaybackThread::OutputTrack::start(AudioSystem::sync_event_t event,
Glenn Kastend848eb42016-03-08 13:42:11 -08002001 audio_session_t triggerSession)
Eric Laurent81784c32012-11-19 14:55:58 -08002002{
2003 status_t status = Track::start(event, triggerSession);
2004 if (status != NO_ERROR) {
2005 return status;
2006 }
2007
2008 mActive = true;
2009 mRetryCount = 127;
2010 return status;
2011}
2012
2013void AudioFlinger::PlaybackThread::OutputTrack::stop()
2014{
2015 Track::stop();
2016 clearBufferQueue();
2017 mOutBuffer.frameCount = 0;
2018 mActive = false;
2019}
2020
Andy Hung1c86ebe2018-05-29 20:29:08 -07002021ssize_t AudioFlinger::PlaybackThread::OutputTrack::write(void* data, uint32_t frames)
Eric Laurent81784c32012-11-19 14:55:58 -08002022{
2023 Buffer *pInBuffer;
2024 Buffer inBuffer;
Eric Laurent81784c32012-11-19 14:55:58 -08002025 inBuffer.frameCount = frames;
Andy Hungc25b84a2015-01-14 19:04:10 -08002026 inBuffer.raw = data;
Eric Laurent81784c32012-11-19 14:55:58 -08002027
2028 uint32_t waitTimeLeftMs = mSourceThread->waitTimeMs();
2029
2030 if (!mActive && frames != 0) {
Andy Hung5bedff62015-01-16 11:05:32 -08002031 (void) start();
Eric Laurent81784c32012-11-19 14:55:58 -08002032 }
2033
2034 while (waitTimeLeftMs) {
2035 // First write pending buffers, then new data
2036 if (mBufferQueue.size()) {
2037 pInBuffer = mBufferQueue.itemAt(0);
2038 } else {
2039 pInBuffer = &inBuffer;
2040 }
2041
2042 if (pInBuffer->frameCount == 0) {
2043 break;
2044 }
2045
2046 if (mOutBuffer.frameCount == 0) {
2047 mOutBuffer.frameCount = pInBuffer->frameCount;
2048 nsecs_t startTime = systemTime();
Glenn Kasten9f80dd22012-12-18 15:57:32 -08002049 status_t status = obtainBuffer(&mOutBuffer, waitTimeLeftMs);
Eric Laurent4d231dc2016-03-11 18:38:23 -08002050 if (status != NO_ERROR && status != NOT_ENOUGH_DATA) {
Andy Hung9d84af52018-09-12 18:03:44 -07002051 ALOGV("%s(%d): thread %d no more output buffers; status %d",
2052 __func__, mId,
2053 (int)mThreadIoHandle, status);
Eric Laurent81784c32012-11-19 14:55:58 -08002054 break;
2055 }
2056 uint32_t waitTimeMs = (uint32_t)ns2ms(systemTime() - startTime);
2057 if (waitTimeLeftMs >= waitTimeMs) {
2058 waitTimeLeftMs -= waitTimeMs;
2059 } else {
2060 waitTimeLeftMs = 0;
2061 }
Eric Laurent4d231dc2016-03-11 18:38:23 -08002062 if (status == NOT_ENOUGH_DATA) {
2063 restartIfDisabled();
2064 continue;
2065 }
Eric Laurent81784c32012-11-19 14:55:58 -08002066 }
2067
2068 uint32_t outFrames = pInBuffer->frameCount > mOutBuffer.frameCount ? mOutBuffer.frameCount :
2069 pInBuffer->frameCount;
Andy Hungc25b84a2015-01-14 19:04:10 -08002070 memcpy(mOutBuffer.raw, pInBuffer->raw, outFrames * mFrameSize);
Glenn Kasten9f80dd22012-12-18 15:57:32 -08002071 Proxy::Buffer buf;
2072 buf.mFrameCount = outFrames;
2073 buf.mRaw = NULL;
2074 mClientProxy->releaseBuffer(&buf);
Eric Laurent4d231dc2016-03-11 18:38:23 -08002075 restartIfDisabled();
Eric Laurent81784c32012-11-19 14:55:58 -08002076 pInBuffer->frameCount -= outFrames;
Andy Hungc25b84a2015-01-14 19:04:10 -08002077 pInBuffer->raw = (int8_t *)pInBuffer->raw + outFrames * mFrameSize;
Eric Laurent81784c32012-11-19 14:55:58 -08002078 mOutBuffer.frameCount -= outFrames;
Andy Hungc25b84a2015-01-14 19:04:10 -08002079 mOutBuffer.raw = (int8_t *)mOutBuffer.raw + outFrames * mFrameSize;
Eric Laurent81784c32012-11-19 14:55:58 -08002080
2081 if (pInBuffer->frameCount == 0) {
2082 if (mBufferQueue.size()) {
2083 mBufferQueue.removeAt(0);
Andy Hungc25b84a2015-01-14 19:04:10 -08002084 free(pInBuffer->mBuffer);
Yunlian Jiang8adc8082017-06-06 15:59:44 -07002085 if (pInBuffer != &inBuffer) {
2086 delete pInBuffer;
2087 }
Andy Hung9d84af52018-09-12 18:03:44 -07002088 ALOGV("%s(%d): thread %d released overflow buffer %zu",
2089 __func__, mId,
2090 (int)mThreadIoHandle, mBufferQueue.size());
Eric Laurent81784c32012-11-19 14:55:58 -08002091 } else {
2092 break;
2093 }
2094 }
2095 }
2096
2097 // If we could not write all frames, allocate a buffer and queue it for next time.
2098 if (inBuffer.frameCount) {
2099 sp<ThreadBase> thread = mThread.promote();
2100 if (thread != 0 && !thread->standby()) {
2101 if (mBufferQueue.size() < kMaxOverFlowBuffers) {
2102 pInBuffer = new Buffer;
Andy Hung71ba4b32022-10-06 12:09:49 -07002103 const size_t bufferSize = inBuffer.frameCount * mFrameSize;
2104 pInBuffer->mBuffer = malloc(bufferSize);
2105 LOG_ALWAYS_FATAL_IF(pInBuffer->mBuffer == nullptr,
2106 "%s: Unable to malloc size %zu", __func__, bufferSize);
Eric Laurent81784c32012-11-19 14:55:58 -08002107 pInBuffer->frameCount = inBuffer.frameCount;
Andy Hungc25b84a2015-01-14 19:04:10 -08002108 pInBuffer->raw = pInBuffer->mBuffer;
2109 memcpy(pInBuffer->raw, inBuffer.raw, inBuffer.frameCount * mFrameSize);
Eric Laurent81784c32012-11-19 14:55:58 -08002110 mBufferQueue.add(pInBuffer);
Andy Hung9d84af52018-09-12 18:03:44 -07002111 ALOGV("%s(%d): thread %d adding overflow buffer %zu", __func__, mId,
2112 (int)mThreadIoHandle, mBufferQueue.size());
Andy Hung1c86ebe2018-05-29 20:29:08 -07002113 // audio data is consumed (stored locally); set frameCount to 0.
2114 inBuffer.frameCount = 0;
Eric Laurent81784c32012-11-19 14:55:58 -08002115 } else {
Andy Hung9d84af52018-09-12 18:03:44 -07002116 ALOGW("%s(%d): thread %d no more overflow buffers",
2117 __func__, mId, (int)mThreadIoHandle);
Andy Hung1c86ebe2018-05-29 20:29:08 -07002118 // TODO: return error for this.
Eric Laurent81784c32012-11-19 14:55:58 -08002119 }
2120 }
2121 }
2122
Andy Hungc25b84a2015-01-14 19:04:10 -08002123 // Calling write() with a 0 length buffer means that no more data will be written:
2124 // We rely on stop() to set the appropriate flags to allow the remaining frames to play out.
2125 if (frames == 0 && mBufferQueue.size() == 0 && mActive) {
2126 stop();
Eric Laurent81784c32012-11-19 14:55:58 -08002127 }
2128
Andy Hung1c86ebe2018-05-29 20:29:08 -07002129 return frames - inBuffer.frameCount; // number of frames consumed.
Eric Laurent81784c32012-11-19 14:55:58 -08002130}
2131
Kevin Rocard12381092018-04-11 09:19:59 -07002132void AudioFlinger::PlaybackThread::OutputTrack::copyMetadataTo(MetadataInserter& backInserter) const
2133{
2134 std::lock_guard<std::mutex> lock(mTrackMetadatasMutex);
2135 backInserter = std::copy(mTrackMetadatas.begin(), mTrackMetadatas.end(), backInserter);
2136}
2137
2138void AudioFlinger::PlaybackThread::OutputTrack::setMetadatas(const SourceMetadatas& metadatas) {
2139 {
2140 std::lock_guard<std::mutex> lock(mTrackMetadatasMutex);
2141 mTrackMetadatas = metadatas;
2142 }
2143 // No need to adjust metadata track volumes as OutputTrack volumes are always 0dBFS.
2144 setMetadataHasChanged();
2145}
2146
Eric Laurent81784c32012-11-19 14:55:58 -08002147status_t AudioFlinger::PlaybackThread::OutputTrack::obtainBuffer(
2148 AudioBufferProvider::Buffer* buffer, uint32_t waitTimeMs)
2149{
Glenn Kasten9f80dd22012-12-18 15:57:32 -08002150 ClientProxy::Buffer buf;
2151 buf.mFrameCount = buffer->frameCount;
2152 struct timespec timeout;
2153 timeout.tv_sec = waitTimeMs / 1000;
2154 timeout.tv_nsec = (int) (waitTimeMs % 1000) * 1000000;
2155 status_t status = mClientProxy->obtainBuffer(&buf, &timeout);
2156 buffer->frameCount = buf.mFrameCount;
2157 buffer->raw = buf.mRaw;
2158 return status;
Eric Laurent81784c32012-11-19 14:55:58 -08002159}
2160
Eric Laurent81784c32012-11-19 14:55:58 -08002161void AudioFlinger::PlaybackThread::OutputTrack::clearBufferQueue()
2162{
2163 size_t size = mBufferQueue.size();
2164
2165 for (size_t i = 0; i < size; i++) {
2166 Buffer *pBuffer = mBufferQueue.itemAt(i);
Andy Hungc25b84a2015-01-14 19:04:10 -08002167 free(pBuffer->mBuffer);
Eric Laurent81784c32012-11-19 14:55:58 -08002168 delete pBuffer;
2169 }
2170 mBufferQueue.clear();
2171}
2172
Eric Laurent4d231dc2016-03-11 18:38:23 -08002173void AudioFlinger::PlaybackThread::OutputTrack::restartIfDisabled()
2174{
2175 int32_t flags = android_atomic_and(~CBLK_DISABLED, &mCblk->mFlags);
2176 if (mActive && (flags & CBLK_DISABLED)) {
2177 start();
2178 }
2179}
Eric Laurent81784c32012-11-19 14:55:58 -08002180
Andy Hung9d84af52018-09-12 18:03:44 -07002181// ----------------------------------------------------------------------------
2182#undef LOG_TAG
2183#define LOG_TAG "AF::PatchTrack"
2184
Eric Laurent83b88082014-06-20 18:31:16 -07002185AudioFlinger::PlaybackThread::PatchTrack::PatchTrack(PlaybackThread *playbackThread,
Eric Laurent3bcf8592015-04-03 12:13:24 -07002186 audio_stream_type_t streamType,
Eric Laurent83b88082014-06-20 18:31:16 -07002187 uint32_t sampleRate,
2188 audio_channel_mask_t channelMask,
2189 audio_format_t format,
2190 size_t frameCount,
2191 void *buffer,
Andy Hung8fe68032017-06-05 16:17:51 -07002192 size_t bufferSize,
Kevin Rocard45986c72018-12-18 18:22:59 -08002193 audio_output_flags_t flags,
Kevin Rocard01c7d9e2019-09-18 11:24:52 +01002194 const Timeout& timeout,
2195 size_t frameCountToBeReady)
Eric Laurent3bcf8592015-04-03 12:13:24 -07002196 : Track(playbackThread, NULL, streamType,
Kevin Rocard1f564ac2018-03-29 13:53:10 -07002197 audio_attributes_t{} /* currently unused for patch track */,
Eric Laurent223fd5c2014-11-11 13:43:36 -08002198 sampleRate, format, channelMask, frameCount,
Andy Hung8fe68032017-06-05 16:17:51 -07002199 buffer, bufferSize, nullptr /* sharedBuffer */,
Svet Ganov33761132021-05-13 22:51:08 +00002200 AUDIO_SESSION_NONE, getpid(), audioServerAttributionSource(getpid()), flags,
Philip P. Moltmannbda45752020-07-17 16:41:18 -07002201 TYPE_PATCH, AUDIO_PORT_HANDLE_NONE, frameCountToBeReady),
gaoxiupei8e3a5682023-07-07 20:30:23 +08002202 PatchTrackBase(mCblk ? new ClientProxy(mCblk, mBuffer, frameCount, mFrameSize, true, true)
2203 : nullptr,
Kevin Rocard45986c72018-12-18 18:22:59 -08002204 *playbackThread, timeout)
Eric Laurent83b88082014-06-20 18:31:16 -07002205{
Andy Hung9d84af52018-09-12 18:03:44 -07002206 ALOGV("%s(%d): sampleRate %d mPeerTimeout %d.%03d sec",
2207 __func__, mId, sampleRate,
Eric Laurent83b88082014-06-20 18:31:16 -07002208 (int)mPeerTimeout.tv_sec,
2209 (int)(mPeerTimeout.tv_nsec / 1000000));
2210}
2211
2212AudioFlinger::PlaybackThread::PatchTrack::~PatchTrack()
2213{
Andy Hungabfab202019-03-07 19:45:54 -08002214 ALOGV("%s(%d)", __func__, mId);
Eric Laurent83b88082014-06-20 18:31:16 -07002215}
2216
Mikhail Naganovcaf59942019-09-25 14:05:29 -07002217size_t AudioFlinger::PlaybackThread::PatchTrack::framesReady() const
2218{
2219 if (mPeerProxy && mPeerProxy->producesBufferOnDemand()) {
2220 return std::numeric_limits<size_t>::max();
2221 } else {
2222 return Track::framesReady();
2223 }
2224}
2225
Eric Laurent4d231dc2016-03-11 18:38:23 -08002226status_t AudioFlinger::PlaybackThread::PatchTrack::start(AudioSystem::sync_event_t event,
Kevin Rocard5f2136e2018-05-11 22:03:00 -07002227 audio_session_t triggerSession)
Eric Laurent4d231dc2016-03-11 18:38:23 -08002228{
2229 status_t status = Track::start(event, triggerSession);
2230 if (status != NO_ERROR) {
2231 return status;
2232 }
2233 android_atomic_and(~CBLK_DISABLED, &mCblk->mFlags);
2234 return status;
2235}
2236
Eric Laurent83b88082014-06-20 18:31:16 -07002237// AudioBufferProvider interface
2238status_t AudioFlinger::PlaybackThread::PatchTrack::getNextBuffer(
Glenn Kastend79072e2016-01-06 08:41:20 -08002239 AudioBufferProvider::Buffer* buffer)
Eric Laurent83b88082014-06-20 18:31:16 -07002240{
Andy Hung9d84af52018-09-12 18:03:44 -07002241 ALOG_ASSERT(mPeerProxy != 0, "%s(%d): called without peer proxy", __func__, mId);
Eric Laurent83b88082014-06-20 18:31:16 -07002242 Proxy::Buffer buf;
2243 buf.mFrameCount = buffer->frameCount;
Mikhail Naganov938be412019-09-04 11:38:47 -07002244 if (ATRACE_ENABLED()) {
2245 std::string traceName("PTnReq");
2246 traceName += std::to_string(id());
2247 ATRACE_INT(traceName.c_str(), buf.mFrameCount);
2248 }
Eric Laurent83b88082014-06-20 18:31:16 -07002249 status_t status = mPeerProxy->obtainBuffer(&buf, &mPeerTimeout);
Andy Hung9d84af52018-09-12 18:03:44 -07002250 ALOGV_IF(status != NO_ERROR, "%s(%d): getNextBuffer status %d", __func__, mId, status);
Eric Laurentc2730ba2014-07-20 15:47:07 -07002251 buffer->frameCount = buf.mFrameCount;
Mikhail Naganov938be412019-09-04 11:38:47 -07002252 if (ATRACE_ENABLED()) {
2253 std::string traceName("PTnObt");
2254 traceName += std::to_string(id());
2255 ATRACE_INT(traceName.c_str(), buf.mFrameCount);
2256 }
Eric Laurent83b88082014-06-20 18:31:16 -07002257 if (buf.mFrameCount == 0) {
2258 return WOULD_BLOCK;
2259 }
Glenn Kastend79072e2016-01-06 08:41:20 -08002260 status = Track::getNextBuffer(buffer);
Eric Laurent83b88082014-06-20 18:31:16 -07002261 return status;
2262}
2263
2264void AudioFlinger::PlaybackThread::PatchTrack::releaseBuffer(AudioBufferProvider::Buffer* buffer)
2265{
Andy Hung9d84af52018-09-12 18:03:44 -07002266 ALOG_ASSERT(mPeerProxy != 0, "%s(%d): called without peer proxy", __func__, mId);
Eric Laurent83b88082014-06-20 18:31:16 -07002267 Proxy::Buffer buf;
2268 buf.mFrameCount = buffer->frameCount;
2269 buf.mRaw = buffer->raw;
2270 mPeerProxy->releaseBuffer(&buf);
Andy Hung71ba4b32022-10-06 12:09:49 -07002271 TrackBase::releaseBuffer(buffer); // Note: this is the base class.
Eric Laurent83b88082014-06-20 18:31:16 -07002272}
2273
2274status_t AudioFlinger::PlaybackThread::PatchTrack::obtainBuffer(Proxy::Buffer* buffer,
2275 const struct timespec *timeOut)
2276{
Eric Laurent4d231dc2016-03-11 18:38:23 -08002277 status_t status = NO_ERROR;
2278 static const int32_t kMaxTries = 5;
2279 int32_t tryCounter = kMaxTries;
Andy Hungf62e1a22018-05-08 18:32:11 -07002280 const size_t originalFrameCount = buffer->mFrameCount;
Eric Laurent4d231dc2016-03-11 18:38:23 -08002281 do {
2282 if (status == NOT_ENOUGH_DATA) {
2283 restartIfDisabled();
Andy Hungf62e1a22018-05-08 18:32:11 -07002284 buffer->mFrameCount = originalFrameCount; // cleared on error, must be restored.
Eric Laurent4d231dc2016-03-11 18:38:23 -08002285 }
2286 status = mProxy->obtainBuffer(buffer, timeOut);
2287 } while ((status == NOT_ENOUGH_DATA) && (tryCounter-- > 0));
2288 return status;
Eric Laurent83b88082014-06-20 18:31:16 -07002289}
2290
2291void AudioFlinger::PlaybackThread::PatchTrack::releaseBuffer(Proxy::Buffer* buffer)
2292{
2293 mProxy->releaseBuffer(buffer);
Eric Laurent4d231dc2016-03-11 18:38:23 -08002294 restartIfDisabled();
naoki miyazuf37f9982019-11-28 11:18:18 +09002295
2296 // Check if the PatchTrack has enough data to write once in releaseBuffer().
2297 // If not, prevent an underrun from occurring by moving the track into FS_FILLING;
2298 // this logic avoids glitches when suspending A2DP with AudioPlaybackCapture.
2299 // TODO: perhaps underrun avoidance could be a track property checked in isReady() instead.
2300 if (mFillingUpStatus == FS_ACTIVE
2301 && audio_is_linear_pcm(mFormat)
2302 && !isOffloadedOrDirect()) {
2303 if (sp<ThreadBase> thread = mThread.promote();
2304 thread != 0) {
2305 PlaybackThread *playbackThread = (PlaybackThread *)thread.get();
2306 const size_t frameCount = playbackThread->frameCount() * sampleRate()
2307 / playbackThread->sampleRate();
2308 if (framesReady() < frameCount) {
2309 ALOGD("%s(%d) Not enough data, wait for buffer to fill", __func__, mId);
2310 mFillingUpStatus = FS_FILLING;
2311 }
2312 }
2313 }
Eric Laurent4d231dc2016-03-11 18:38:23 -08002314}
2315
2316void AudioFlinger::PlaybackThread::PatchTrack::restartIfDisabled()
2317{
Eric Laurent83b88082014-06-20 18:31:16 -07002318 if (android_atomic_and(~CBLK_DISABLED, &mCblk->mFlags) & CBLK_DISABLED) {
Andy Hung9d84af52018-09-12 18:03:44 -07002319 ALOGW("%s(%d): disabled due to previous underrun, restarting", __func__, mId);
Eric Laurent83b88082014-06-20 18:31:16 -07002320 start();
2321 }
Eric Laurent83b88082014-06-20 18:31:16 -07002322}
2323
Eric Laurent81784c32012-11-19 14:55:58 -08002324// ----------------------------------------------------------------------------
2325// Record
2326// ----------------------------------------------------------------------------
Jean-Michel Trividdf87ef2019-08-20 15:42:04 -07002327
2328
Andy Hung9d84af52018-09-12 18:03:44 -07002329#undef LOG_TAG
2330#define LOG_TAG "AF::RecordHandle"
Eric Laurent81784c32012-11-19 14:55:58 -08002331
2332AudioFlinger::RecordHandle::RecordHandle(
2333 const sp<AudioFlinger::RecordThread::RecordTrack>& recordTrack)
2334 : BnAudioRecord(),
2335 mRecordTrack(recordTrack)
2336{
Andy Hung225aef62022-12-06 16:33:20 -08002337 setMinSchedulerPolicy(SCHED_NORMAL, ANDROID_PRIORITY_AUDIO);
Eric Laurent81784c32012-11-19 14:55:58 -08002338}
2339
2340AudioFlinger::RecordHandle::~RecordHandle() {
2341 stop_nonvirtual();
2342 mRecordTrack->destroy();
2343}
2344
Ivan Lozanoff6900d2017-08-01 15:47:38 -07002345binder::Status AudioFlinger::RecordHandle::start(int /*AudioSystem::sync_event_t*/ event,
2346 int /*audio_session_t*/ triggerSession) {
Andy Hung9d84af52018-09-12 18:03:44 -07002347 ALOGV("%s()", __func__);
Andy Hung1131b6e2020-12-08 20:47:45 -08002348 return binderStatusFromStatusT(
Ivan Lozanoff6900d2017-08-01 15:47:38 -07002349 mRecordTrack->start((AudioSystem::sync_event_t)event, (audio_session_t) triggerSession));
Eric Laurent81784c32012-11-19 14:55:58 -08002350}
2351
Ivan Lozanoff6900d2017-08-01 15:47:38 -07002352binder::Status AudioFlinger::RecordHandle::stop() {
Eric Laurent81784c32012-11-19 14:55:58 -08002353 stop_nonvirtual();
Ivan Lozanoff6900d2017-08-01 15:47:38 -07002354 return binder::Status::ok();
Eric Laurent81784c32012-11-19 14:55:58 -08002355}
2356
2357void AudioFlinger::RecordHandle::stop_nonvirtual() {
Andy Hung9d84af52018-09-12 18:03:44 -07002358 ALOGV("%s()", __func__);
Eric Laurent81784c32012-11-19 14:55:58 -08002359 mRecordTrack->stop();
2360}
2361
jiabin653cc0a2018-01-17 17:54:10 -08002362binder::Status AudioFlinger::RecordHandle::getActiveMicrophones(
Mikhail Naganov2a6a3012023-02-13 11:45:03 -08002363 std::vector<media::MicrophoneInfoFw>* activeMicrophones) {
Andy Hung9d84af52018-09-12 18:03:44 -07002364 ALOGV("%s()", __func__);
Mikhail Naganov2a6a3012023-02-13 11:45:03 -08002365 return binderStatusFromStatusT(mRecordTrack->getActiveMicrophones(activeMicrophones));
jiabin653cc0a2018-01-17 17:54:10 -08002366}
2367
Paul McLean12340082019-03-19 09:35:05 -06002368binder::Status AudioFlinger::RecordHandle::setPreferredMicrophoneDirection(
Paul McLean03a6e6a2018-12-04 10:54:13 -07002369 int /*audio_microphone_direction_t*/ direction) {
2370 ALOGV("%s()", __func__);
Andy Hung1131b6e2020-12-08 20:47:45 -08002371 return binderStatusFromStatusT(mRecordTrack->setPreferredMicrophoneDirection(
Paul McLean03a6e6a2018-12-04 10:54:13 -07002372 static_cast<audio_microphone_direction_t>(direction)));
2373}
2374
Paul McLean12340082019-03-19 09:35:05 -06002375binder::Status AudioFlinger::RecordHandle::setPreferredMicrophoneFieldDimension(float zoom) {
Paul McLean03a6e6a2018-12-04 10:54:13 -07002376 ALOGV("%s()", __func__);
Andy Hung1131b6e2020-12-08 20:47:45 -08002377 return binderStatusFromStatusT(mRecordTrack->setPreferredMicrophoneFieldDimension(zoom));
Paul McLean03a6e6a2018-12-04 10:54:13 -07002378}
2379
Eric Laurentec376dc2021-04-08 20:41:22 +02002380binder::Status AudioFlinger::RecordHandle::shareAudioHistory(
2381 const std::string& sharedAudioPackageName, int64_t sharedAudioStartMs) {
2382 return binderStatusFromStatusT(
2383 mRecordTrack->shareAudioHistory(sharedAudioPackageName, sharedAudioStartMs));
2384}
2385
Eric Laurent81784c32012-11-19 14:55:58 -08002386// ----------------------------------------------------------------------------
Andy Hung9d84af52018-09-12 18:03:44 -07002387#undef LOG_TAG
2388#define LOG_TAG "AF::RecordTrack"
Eric Laurent81784c32012-11-19 14:55:58 -08002389
Glenn Kasten05997e22014-03-13 15:08:33 -07002390// RecordTrack constructor must be called with AudioFlinger::mLock and ThreadBase::mLock held
Eric Laurent81784c32012-11-19 14:55:58 -08002391AudioFlinger::RecordThread::RecordTrack::RecordTrack(
2392 RecordThread *thread,
2393 const sp<Client>& client,
Kevin Rocard1f564ac2018-03-29 13:53:10 -07002394 const audio_attributes_t& attr,
Eric Laurent81784c32012-11-19 14:55:58 -08002395 uint32_t sampleRate,
2396 audio_format_t format,
2397 audio_channel_mask_t channelMask,
2398 size_t frameCount,
Eric Laurent83b88082014-06-20 18:31:16 -07002399 void *buffer,
Andy Hung8fe68032017-06-05 16:17:51 -07002400 size_t bufferSize,
Glenn Kastend848eb42016-03-08 13:42:11 -08002401 audio_session_t sessionId,
Eric Laurent09f1ed22019-04-24 17:45:17 -07002402 pid_t creatorPid,
Svet Ganov33761132021-05-13 22:51:08 +00002403 const AttributionSourceState& attributionSource,
Eric Laurent05067782016-06-01 18:27:28 -07002404 audio_input_flags_t flags,
Eric Laurent20b9ef02016-12-05 11:03:16 -08002405 track_type type,
Eric Laurentec376dc2021-04-08 20:41:22 +02002406 audio_port_handle_t portId,
Eric Laurent2407ce32021-04-26 14:56:03 +02002407 int32_t startFrames)
Kevin Rocard1f564ac2018-03-29 13:53:10 -07002408 : TrackBase(thread, client, attr, sampleRate, format,
Eric Laurent09f1ed22019-04-24 17:45:17 -07002409 channelMask, frameCount, buffer, bufferSize, sessionId,
Philip P. Moltmannbda45752020-07-17 16:41:18 -07002410 creatorPid,
Svet Ganov33761132021-05-13 22:51:08 +00002411 VALUE_OR_FATAL(aidl2legacy_int32_t_uid_t(attributionSource.uid)),
Philip P. Moltmannbda45752020-07-17 16:41:18 -07002412 false /*isOut*/,
Eric Laurent83b88082014-06-20 18:31:16 -07002413 (type == TYPE_DEFAULT) ?
Eric Laurent05067782016-06-01 18:27:28 -07002414 ((flags & AUDIO_INPUT_FLAG_FAST) ? ALLOC_PIPE : ALLOC_CBLK) :
Eric Laurent83b88082014-06-20 18:31:16 -07002415 ((buffer == NULL) ? ALLOC_LOCAL : ALLOC_NONE),
Andy Hungb68f5eb2019-12-03 16:49:17 -08002416 type, portId,
2417 std::string(AMEDIAMETRICS_KEY_PREFIX_AUDIO_RECORD) + std::to_string(portId)),
Andy Hung97a893e2015-03-29 01:03:07 -07002418 mOverflow(false),
Andy Hung4c6afaf2015-06-12 18:23:35 -07002419 mResamplerBufferProvider(NULL), // initialize in case of early constructor exit
Eric Laurent05067782016-06-01 18:27:28 -07002420 mRecordBufferConverter(NULL),
jiabin9378eb92018-05-02 15:26:35 -07002421 mFlags(flags),
Jean-Michel Trividdf87ef2019-08-20 15:42:04 -07002422 mSilenced(false),
Eric Laurent2407ce32021-04-26 14:56:03 +02002423 mStartFrames(startFrames)
Eric Laurent81784c32012-11-19 14:55:58 -08002424{
Glenn Kasten3ef14ef2014-03-13 15:08:51 -07002425 if (mCblk == NULL) {
2426 return;
Glenn Kasten9f80dd22012-12-18 15:57:32 -08002427 }
Glenn Kasten6dd62fb2013-12-05 16:35:58 -08002428
Mikhail Naganov7c6ae982018-06-14 12:33:38 -07002429 if (!isDirect()) {
2430 mRecordBufferConverter = new RecordBufferConverter(
2431 thread->mChannelMask, thread->mFormat, thread->mSampleRate,
2432 channelMask, format, sampleRate);
2433 // Check if the RecordBufferConverter construction was successful.
2434 // If not, don't continue with construction.
2435 //
2436 // NOTE: It would be extremely rare that the record track cannot be created
2437 // for the current device, but a pending or future device change would make
2438 // the record track configuration valid.
2439 if (mRecordBufferConverter->initCheck() != NO_ERROR) {
Andy Hung9d84af52018-09-12 18:03:44 -07002440 ALOGE("%s(%d): RecordTrack unable to create record buffer converter", __func__, mId);
Mikhail Naganov7c6ae982018-06-14 12:33:38 -07002441 return;
2442 }
Andy Hung97a893e2015-03-29 01:03:07 -07002443 }
2444
Andy Hung6ae58432016-02-16 18:32:24 -08002445 mServerProxy = new AudioRecordServerProxy(mCblk, mBuffer, frameCount,
Andy Hung3f0c9022016-01-15 17:49:46 -08002446 mFrameSize, !isExternalTrack());
Andy Hung3f0c9022016-01-15 17:49:46 -08002447
Andy Hung97a893e2015-03-29 01:03:07 -07002448 mResamplerBufferProvider = new ResamplerBufferProvider(this);
Glenn Kastenc263ca02014-06-04 20:31:46 -07002449
Eric Laurent05067782016-06-01 18:27:28 -07002450 if (flags & AUDIO_INPUT_FLAG_FAST) {
Glenn Kastenc263ca02014-06-04 20:31:46 -07002451 ALOG_ASSERT(thread->mFastTrackAvail);
2452 thread->mFastTrackAvail = false;
Andy Hung000adb52018-06-01 15:43:26 -07002453 } else {
2454 // TODO: only Normal Record has timestamps (Fast Record does not).
Andy Hung5d3d9562018-10-04 19:27:26 -07002455 mServerLatencySupported = checkServerLatencySupported(mFormat, flags);
Glenn Kastenc263ca02014-06-04 20:31:46 -07002456 }
Andy Hung8946a282018-04-19 20:04:56 -07002457#ifdef TEE_SINK
2458 mTee.setId(std::string("_") + std::to_string(mThreadIoHandle)
2459 + "_" + std::to_string(mId)
2460 + "_R");
2461#endif
Andy Hungb68f5eb2019-12-03 16:49:17 -08002462
2463 // Once this item is logged by the server, the client can add properties.
Andy Hung94235282021-03-24 15:50:14 -07002464 mTrackMetrics.logConstructor(creatorPid, uid(), id());
Eric Laurent81784c32012-11-19 14:55:58 -08002465}
2466
2467AudioFlinger::RecordThread::RecordTrack::~RecordTrack()
2468{
Andy Hung9d84af52018-09-12 18:03:44 -07002469 ALOGV("%s()", __func__);
Andy Hung97a893e2015-03-29 01:03:07 -07002470 delete mRecordBufferConverter;
Glenn Kasten6dd62fb2013-12-05 16:35:58 -08002471 delete mResamplerBufferProvider;
Eric Laurent81784c32012-11-19 14:55:58 -08002472}
2473
Andy Hung97a893e2015-03-29 01:03:07 -07002474status_t AudioFlinger::RecordThread::RecordTrack::initCheck() const
2475{
2476 status_t status = TrackBase::initCheck();
2477 if (status == NO_ERROR && mServerProxy == 0) {
2478 status = BAD_VALUE;
2479 }
2480 return status;
2481}
2482
Eric Laurent81784c32012-11-19 14:55:58 -08002483// AudioBufferProvider interface
Glenn Kastend79072e2016-01-06 08:41:20 -08002484status_t AudioFlinger::RecordThread::RecordTrack::getNextBuffer(AudioBufferProvider::Buffer* buffer)
Eric Laurent81784c32012-11-19 14:55:58 -08002485{
Glenn Kasten9f80dd22012-12-18 15:57:32 -08002486 ServerProxy::Buffer buf;
2487 buf.mFrameCount = buffer->frameCount;
2488 status_t status = mServerProxy->obtainBuffer(&buf);
2489 buffer->frameCount = buf.mFrameCount;
2490 buffer->raw = buf.mRaw;
2491 if (buf.mFrameCount == 0) {
2492 // FIXME also wake futex so that overrun is noticed more quickly
Glenn Kasten96f60d82013-07-12 10:21:18 -07002493 (void) android_atomic_or(CBLK_OVERRUN, &mCblk->mFlags);
Eric Laurent81784c32012-11-19 14:55:58 -08002494 }
Glenn Kasten9f80dd22012-12-18 15:57:32 -08002495 return status;
Eric Laurent81784c32012-11-19 14:55:58 -08002496}
2497
2498status_t AudioFlinger::RecordThread::RecordTrack::start(AudioSystem::sync_event_t event,
Glenn Kastend848eb42016-03-08 13:42:11 -08002499 audio_session_t triggerSession)
Eric Laurent81784c32012-11-19 14:55:58 -08002500{
2501 sp<ThreadBase> thread = mThread.promote();
2502 if (thread != 0) {
2503 RecordThread *recordThread = (RecordThread *)thread.get();
2504 return recordThread->start(this, event, triggerSession);
2505 } else {
Eric Laurentd52a28c2020-08-21 17:10:39 -07002506 ALOGW("%s track %d: thread was destroyed", __func__, portId());
2507 return DEAD_OBJECT;
Eric Laurent81784c32012-11-19 14:55:58 -08002508 }
2509}
2510
2511void AudioFlinger::RecordThread::RecordTrack::stop()
2512{
2513 sp<ThreadBase> thread = mThread.promote();
2514 if (thread != 0) {
2515 RecordThread *recordThread = (RecordThread *)thread.get();
Eric Laurent83b88082014-06-20 18:31:16 -07002516 if (recordThread->stop(this) && isExternalTrack()) {
Eric Laurentfee19762018-01-29 18:44:13 -08002517 AudioSystem::stopInput(mPortId);
Eric Laurent81784c32012-11-19 14:55:58 -08002518 }
2519 }
2520}
2521
2522void AudioFlinger::RecordThread::RecordTrack::destroy()
2523{
2524 // see comments at AudioFlinger::PlaybackThread::Track::destroy()
2525 sp<RecordTrack> keep(this);
2526 {
Andy Hungce685402018-10-05 17:23:27 -07002527 track_state priorState = mState;
Eric Laurent81784c32012-11-19 14:55:58 -08002528 sp<ThreadBase> thread = mThread.promote();
2529 if (thread != 0) {
Eric Laurent81784c32012-11-19 14:55:58 -08002530 Mutex::Autolock _l(thread->mLock);
2531 RecordThread *recordThread = (RecordThread *) thread.get();
Andy Hungce685402018-10-05 17:23:27 -07002532 priorState = mState;
Eric Laurentec376dc2021-04-08 20:41:22 +02002533 if (!mSharedAudioPackageName.empty()) {
Eric Laurent92d0a322021-07-16 15:32:33 +02002534 recordThread->resetAudioHistory_l();
Eric Laurentec376dc2021-04-08 20:41:22 +02002535 }
Andy Hungce685402018-10-05 17:23:27 -07002536 recordThread->destroyTrack_l(this); // move mState to STOPPED, terminate
2537 }
2538 // APM portid/client management done outside of lock.
2539 // NOTE: if thread doesn't exist, the input descriptor probably doesn't either.
2540 if (isExternalTrack()) {
2541 switch (priorState) {
2542 case ACTIVE: // invalidated while still active
2543 case STARTING_2: // invalidated/start-aborted after startInput successfully called
2544 case PAUSING: // invalidated while in the middle of stop() pausing (still active)
2545 AudioSystem::stopInput(mPortId);
2546 break;
2547
2548 case STARTING_1: // invalidated/start-aborted and startInput not successful
2549 case PAUSED: // OK, not active
2550 case IDLE: // OK, not active
2551 break;
2552
2553 case STOPPED: // unexpected (destroyed)
2554 default:
2555 LOG_ALWAYS_FATAL("%s(%d): invalid prior state: %d", __func__, mId, priorState);
2556 }
2557 AudioSystem::releaseInput(mPortId);
Eric Laurent81784c32012-11-19 14:55:58 -08002558 }
2559 }
2560}
2561
Eric Laurent9a54bc22013-09-09 09:08:44 -07002562void AudioFlinger::RecordThread::RecordTrack::invalidate()
2563{
Eric Laurent6acd1d42017-01-04 14:23:29 -08002564 TrackBase::invalidate();
Eric Laurent9a54bc22013-09-09 09:08:44 -07002565 // FIXME should use proxy, and needs work
2566 audio_track_cblk_t* cblk = mCblk;
2567 android_atomic_or(CBLK_INVALID, &cblk->mFlags);
2568 android_atomic_release_store(0x40000000, &cblk->mFutex);
2569 // client is not in server, so FUTEX_WAKE is needed instead of FUTEX_WAKE_PRIVATE
Elliott Hughesee499292014-05-21 17:55:51 -07002570 (void) syscall(__NR_futex, &cblk->mFutex, FUTEX_WAKE, INT_MAX);
Eric Laurent9a54bc22013-09-09 09:08:44 -07002571}
2572
Eric Laurent81784c32012-11-19 14:55:58 -08002573
Andy Hung000adb52018-06-01 15:43:26 -07002574void AudioFlinger::RecordThread::RecordTrack::appendDumpHeader(String8& result)
Eric Laurent81784c32012-11-19 14:55:58 -08002575{
Eric Laurent973db022018-11-20 14:54:31 -08002576 result.appendFormat("Active Id Client Session Port Id S Flags "
Andy Hung9d84af52018-09-12 18:03:44 -07002577 " Format Chn mask SRate Source "
Kevin Rocard5f2136e2018-05-11 22:03:00 -07002578 " Server FrmCnt FrmRdy Sil%s\n",
2579 isServerLatencySupported() ? " Latency" : "");
Eric Laurent81784c32012-11-19 14:55:58 -08002580}
2581
Andy Hung2c6c3bb2017-06-16 14:01:45 -07002582void AudioFlinger::RecordThread::RecordTrack::appendDump(String8& result, bool active)
Eric Laurent81784c32012-11-19 14:55:58 -08002583{
Eric Laurent973db022018-11-20 14:54:31 -08002584 result.appendFormat("%c%5s %6d %6u %7u %7u %2s 0x%03X "
Kevin Rocard5f2136e2018-05-11 22:03:00 -07002585 "%08X %08X %6u %6X "
Andy Hung000adb52018-06-01 15:43:26 -07002586 "%08X %6zu %6zu %3c",
Andy Hung2c6c3bb2017-06-16 14:01:45 -07002587 isFastTrack() ? 'F' : ' ',
Marco Nelissenb2208842014-02-07 14:00:50 -08002588 active ? "yes" : "no",
Andy Hung9d84af52018-09-12 18:03:44 -07002589 mId,
Andy Hung4ef19fa2018-05-15 19:35:29 -07002590 (mClient == 0) ? getpid() : mClient->pid(),
Andy Hung2c6c3bb2017-06-16 14:01:45 -07002591 mSessionId,
Eric Laurent973db022018-11-20 14:54:31 -08002592 mPortId,
Andy Hunge2e830f2019-12-03 12:54:46 -08002593 getTrackStateAsCodedString(),
Andy Hung2c6c3bb2017-06-16 14:01:45 -07002594 mCblk->mFlags,
2595
Eric Laurent81784c32012-11-19 14:55:58 -08002596 mFormat,
2597 mChannelMask,
Andy Hung2c6c3bb2017-06-16 14:01:45 -07002598 mSampleRate,
Kevin Rocard5f2136e2018-05-11 22:03:00 -07002599 mAttr.source,
Glenn Kasten6dd62fb2013-12-05 16:35:58 -08002600
Andy Hung2c6c3bb2017-06-16 14:01:45 -07002601 mCblk->mServer,
Jean-Michel Trivi7d665ab2018-04-11 17:26:51 -07002602 mFrameCount,
Andy Hung000adb52018-06-01 15:43:26 -07002603 mServerProxy->framesReadySafe(),
Jean-Michel Trivi7d665ab2018-04-11 17:26:51 -07002604 isSilenced() ? 's' : 'n'
Andy Hung2c6c3bb2017-06-16 14:01:45 -07002605 );
Andy Hung000adb52018-06-01 15:43:26 -07002606 if (isServerLatencySupported()) {
2607 double latencyMs;
2608 bool fromTrack;
2609 if (getTrackLatencyMs(&latencyMs, &fromTrack) == OK) {
2610 // Show latency in msec, followed by 't' if from track timestamp (the most accurate)
2611 // or 'k' if estimated from kernel (usually for debugging).
2612 result.appendFormat(" %7.2lf %c", latencyMs, fromTrack ? 't' : 'k');
2613 } else {
2614 result.appendFormat("%10s", mCblk->mServer != 0 ? "unavail" : "new");
2615 }
2616 }
2617 result.append("\n");
Eric Laurent81784c32012-11-19 14:55:58 -08002618}
2619
Andy Hung93bb5732023-05-04 21:16:34 -07002620// This is invoked by SyncEvent callback.
Andy Hung068e08e2023-05-15 19:02:55 -07002621void AudioFlinger::RecordThread::RecordTrack::handleSyncStartEvent(
2622 const sp<audioflinger::SyncEvent>& event)
Glenn Kasten25f4aa82014-02-07 10:50:43 -08002623{
Andy Hung93bb5732023-05-04 21:16:34 -07002624 size_t framesToDrop = 0;
2625 sp<ThreadBase> threadBase = mThread.promote();
2626 if (threadBase != 0) {
2627 // TODO: use actual buffer filling status instead of 2 buffers when info is available
2628 // from audio HAL
2629 framesToDrop = threadBase->mFrameCount * 2;
Glenn Kasten25f4aa82014-02-07 10:50:43 -08002630 }
Andy Hung93bb5732023-05-04 21:16:34 -07002631
2632 mSynchronizedRecordState.onPlaybackFinished(event, framesToDrop);
Glenn Kasten25f4aa82014-02-07 10:50:43 -08002633}
2634
2635void AudioFlinger::RecordThread::RecordTrack::clearSyncStartEvent()
2636{
Andy Hung93bb5732023-05-04 21:16:34 -07002637 mSynchronizedRecordState.clear();
Glenn Kasten25f4aa82014-02-07 10:50:43 -08002638}
2639
Andy Hung3f0c9022016-01-15 17:49:46 -08002640void AudioFlinger::RecordThread::RecordTrack::updateTrackFrameInfo(
2641 int64_t trackFramesReleased, int64_t sourceFramesRead,
2642 uint32_t halSampleRate, const ExtendedTimestamp &timestamp)
2643{
Andy Hung30282562018-08-08 18:27:03 -07002644 // Make the kernel frametime available.
2645 const FrameTime ft{
2646 timestamp.mPosition[ExtendedTimestamp::LOCATION_KERNEL],
2647 timestamp.mTimeNs[ExtendedTimestamp::LOCATION_KERNEL]};
2648 // ALOGD("FrameTime: %lld %lld", (long long)ft.frames, (long long)ft.timeNs);
2649 mKernelFrameTime.store(ft);
2650 if (!audio_is_linear_pcm(mFormat)) {
Atneya Nair497fff12022-01-18 16:23:04 -05002651 // Stream is direct, return provided timestamp with no conversion
2652 mServerProxy->setTimestamp(timestamp);
Andy Hung30282562018-08-08 18:27:03 -07002653 return;
2654 }
2655
Andy Hung3f0c9022016-01-15 17:49:46 -08002656 ExtendedTimestamp local = timestamp;
2657
2658 // Convert HAL frames to server-side track frames at track sample rate.
2659 // We use trackFramesReleased and sourceFramesRead as an anchor point.
2660 for (int i = ExtendedTimestamp::LOCATION_SERVER; i < ExtendedTimestamp::LOCATION_MAX; ++i) {
2661 if (local.mTimeNs[i] != 0) {
2662 const int64_t relativeServerFrames = local.mPosition[i] - sourceFramesRead;
2663 const int64_t relativeTrackFrames = relativeServerFrames
2664 * mSampleRate / halSampleRate; // TODO: potential computation overflow
2665 local.mPosition[i] = relativeTrackFrames + trackFramesReleased;
2666 }
2667 }
Andy Hung6ae58432016-02-16 18:32:24 -08002668 mServerProxy->setTimestamp(local);
Andy Hung000adb52018-06-01 15:43:26 -07002669
2670 // Compute latency info.
2671 const bool useTrackTimestamp = true; // use track unless debugging.
2672 const double latencyMs = - (useTrackTimestamp
2673 ? local.getOutputServerLatencyMs(sampleRate())
2674 : timestamp.getOutputServerLatencyMs(halSampleRate));
2675
2676 mServerLatencyFromTrack.store(useTrackTimestamp);
2677 mServerLatencyMs.store(latencyMs);
Andy Hung3f0c9022016-01-15 17:49:46 -08002678}
Eric Laurent83b88082014-06-20 18:31:16 -07002679
jiabin653cc0a2018-01-17 17:54:10 -08002680status_t AudioFlinger::RecordThread::RecordTrack::getActiveMicrophones(
Mikhail Naganov2a6a3012023-02-13 11:45:03 -08002681 std::vector<media::MicrophoneInfoFw>* activeMicrophones)
jiabin653cc0a2018-01-17 17:54:10 -08002682{
2683 sp<ThreadBase> thread = mThread.promote();
2684 if (thread != 0) {
2685 RecordThread *recordThread = (RecordThread *)thread.get();
2686 return recordThread->getActiveMicrophones(activeMicrophones);
2687 } else {
2688 return BAD_VALUE;
2689 }
2690}
2691
Paul McLean12340082019-03-19 09:35:05 -06002692status_t AudioFlinger::RecordThread::RecordTrack::setPreferredMicrophoneDirection(
Paul McLean03a6e6a2018-12-04 10:54:13 -07002693 audio_microphone_direction_t direction) {
2694 sp<ThreadBase> thread = mThread.promote();
2695 if (thread != 0) {
2696 RecordThread *recordThread = (RecordThread *)thread.get();
Paul McLean12340082019-03-19 09:35:05 -06002697 return recordThread->setPreferredMicrophoneDirection(direction);
Paul McLean03a6e6a2018-12-04 10:54:13 -07002698 } else {
2699 return BAD_VALUE;
2700 }
2701}
2702
Paul McLean12340082019-03-19 09:35:05 -06002703status_t AudioFlinger::RecordThread::RecordTrack::setPreferredMicrophoneFieldDimension(float zoom) {
Paul McLean03a6e6a2018-12-04 10:54:13 -07002704 sp<ThreadBase> thread = mThread.promote();
2705 if (thread != 0) {
2706 RecordThread *recordThread = (RecordThread *)thread.get();
Paul McLean12340082019-03-19 09:35:05 -06002707 return recordThread->setPreferredMicrophoneFieldDimension(zoom);
Paul McLean03a6e6a2018-12-04 10:54:13 -07002708 } else {
2709 return BAD_VALUE;
2710 }
2711}
2712
Eric Laurentec376dc2021-04-08 20:41:22 +02002713status_t AudioFlinger::RecordThread::RecordTrack::shareAudioHistory(
2714 const std::string& sharedAudioPackageName, int64_t sharedAudioStartMs) {
2715
2716 const uid_t callingUid = IPCThreadState::self()->getCallingUid();
2717 const pid_t callingPid = IPCThreadState::self()->getCallingPid();
2718 if (callingUid != mUid || callingPid != mCreatorPid) {
2719 return PERMISSION_DENIED;
2720 }
2721
Svet Ganov33761132021-05-13 22:51:08 +00002722 AttributionSourceState attributionSource{};
2723 attributionSource.uid = VALUE_OR_RETURN_STATUS(legacy2aidl_uid_t_int32_t(callingUid));
2724 attributionSource.pid = VALUE_OR_RETURN_STATUS(legacy2aidl_uid_t_int32_t(callingPid));
2725 attributionSource.token = sp<BBinder>::make();
2726 if (!captureHotwordAllowed(attributionSource)) {
Eric Laurentec376dc2021-04-08 20:41:22 +02002727 return PERMISSION_DENIED;
2728 }
2729
2730 sp<ThreadBase> thread = mThread.promote();
2731 if (thread != 0) {
2732 RecordThread *recordThread = (RecordThread *)thread.get();
2733 status_t status = recordThread->shareAudioHistory(
2734 sharedAudioPackageName, mSessionId, sharedAudioStartMs);
2735 if (status == NO_ERROR) {
2736 mSharedAudioPackageName = sharedAudioPackageName;
2737 }
2738 return status;
2739 } else {
2740 return BAD_VALUE;
2741 }
2742}
2743
Eric Laurent78b07302022-10-07 16:20:34 +02002744void AudioFlinger::RecordThread::RecordTrack::copyMetadataTo(MetadataInserter& backInserter) const
2745{
2746
2747 // Do not forward PatchRecord metadata with unspecified audio source
2748 if (mAttr.source == AUDIO_SOURCE_DEFAULT) {
2749 return;
2750 }
2751
2752 // No track is invalid as this is called after prepareTrack_l in the same critical section
2753 record_track_metadata_v7_t metadata;
2754 metadata.base = {
2755 .source = mAttr.source,
2756 .gain = 1, // capture tracks do not have volumes
2757 };
2758 metadata.channel_mask = mChannelMask;
2759 strncpy(metadata.tags, mAttr.tags, AUDIO_ATTRIBUTES_TAGS_MAX_SIZE);
2760
2761 *backInserter++ = metadata;
2762}
Eric Laurentec376dc2021-04-08 20:41:22 +02002763
Andy Hung9d84af52018-09-12 18:03:44 -07002764// ----------------------------------------------------------------------------
2765#undef LOG_TAG
2766#define LOG_TAG "AF::PatchRecord"
2767
Eric Laurent83b88082014-06-20 18:31:16 -07002768AudioFlinger::RecordThread::PatchRecord::PatchRecord(RecordThread *recordThread,
2769 uint32_t sampleRate,
2770 audio_channel_mask_t channelMask,
2771 audio_format_t format,
2772 size_t frameCount,
2773 void *buffer,
Andy Hung8fe68032017-06-05 16:17:51 -07002774 size_t bufferSize,
Kevin Rocard45986c72018-12-18 18:22:59 -08002775 audio_input_flags_t flags,
Eric Laurent78b07302022-10-07 16:20:34 +02002776 const Timeout& timeout,
2777 audio_source_t source)
Kevin Rocard1f564ac2018-03-29 13:53:10 -07002778 : RecordTrack(recordThread, NULL,
Eric Laurent78b07302022-10-07 16:20:34 +02002779 audio_attributes_t{ .source = source } ,
Kevin Rocard1f564ac2018-03-29 13:53:10 -07002780 sampleRate, format, channelMask, frameCount,
Philip P. Moltmannbda45752020-07-17 16:41:18 -07002781 buffer, bufferSize, AUDIO_SESSION_NONE, getpid(),
Svet Ganov33761132021-05-13 22:51:08 +00002782 audioServerAttributionSource(getpid()), flags, TYPE_PATCH),
gaoxiupei8e3a5682023-07-07 20:30:23 +08002783 PatchTrackBase(mCblk ? new ClientProxy(mCblk, mBuffer, frameCount, mFrameSize, false, true)
2784 : nullptr,
Kevin Rocard45986c72018-12-18 18:22:59 -08002785 *recordThread, timeout)
Eric Laurent83b88082014-06-20 18:31:16 -07002786{
Andy Hung9d84af52018-09-12 18:03:44 -07002787 ALOGV("%s(%d): sampleRate %d mPeerTimeout %d.%03d sec",
2788 __func__, mId, sampleRate,
Eric Laurent83b88082014-06-20 18:31:16 -07002789 (int)mPeerTimeout.tv_sec,
2790 (int)(mPeerTimeout.tv_nsec / 1000000));
2791}
2792
2793AudioFlinger::RecordThread::PatchRecord::~PatchRecord()
2794{
Andy Hungabfab202019-03-07 19:45:54 -08002795 ALOGV("%s(%d)", __func__, mId);
Eric Laurent83b88082014-06-20 18:31:16 -07002796}
2797
Mikhail Naganov8296c252019-09-25 14:59:54 -07002798static size_t writeFramesHelper(
2799 AudioBufferProvider* dest, const void* src, size_t frameCount, size_t frameSize)
2800{
2801 AudioBufferProvider::Buffer patchBuffer;
2802 patchBuffer.frameCount = frameCount;
2803 auto status = dest->getNextBuffer(&patchBuffer);
2804 if (status != NO_ERROR) {
2805 ALOGW("%s PathRecord getNextBuffer failed with error %d: %s",
2806 __func__, status, strerror(-status));
2807 return 0;
2808 }
2809 ALOG_ASSERT(patchBuffer.frameCount <= frameCount);
2810 memcpy(patchBuffer.raw, src, patchBuffer.frameCount * frameSize);
2811 size_t framesWritten = patchBuffer.frameCount;
2812 dest->releaseBuffer(&patchBuffer);
2813 return framesWritten;
2814}
2815
2816// static
2817size_t AudioFlinger::RecordThread::PatchRecord::writeFrames(
2818 AudioBufferProvider* dest, const void* src, size_t frameCount, size_t frameSize)
2819{
2820 size_t framesWritten = writeFramesHelper(dest, src, frameCount, frameSize);
2821 // On buffer wrap, the buffer frame count will be less than requested,
2822 // when this happens a second buffer needs to be used to write the leftover audio
2823 const size_t framesLeft = frameCount - framesWritten;
2824 if (framesWritten != 0 && framesLeft != 0) {
2825 framesWritten += writeFramesHelper(dest, (const char*)src + framesWritten * frameSize,
2826 framesLeft, frameSize);
2827 }
2828 return framesWritten;
2829}
2830
Eric Laurent83b88082014-06-20 18:31:16 -07002831// AudioBufferProvider interface
2832status_t AudioFlinger::RecordThread::PatchRecord::getNextBuffer(
Glenn Kastend79072e2016-01-06 08:41:20 -08002833 AudioBufferProvider::Buffer* buffer)
Eric Laurent83b88082014-06-20 18:31:16 -07002834{
Andy Hung9d84af52018-09-12 18:03:44 -07002835 ALOG_ASSERT(mPeerProxy != 0, "%s(%d): called without peer proxy", __func__, mId);
Eric Laurent83b88082014-06-20 18:31:16 -07002836 Proxy::Buffer buf;
2837 buf.mFrameCount = buffer->frameCount;
2838 status_t status = mPeerProxy->obtainBuffer(&buf, &mPeerTimeout);
2839 ALOGV_IF(status != NO_ERROR,
Andy Hung9d84af52018-09-12 18:03:44 -07002840 "%s(%d): mPeerProxy->obtainBuffer status %d", __func__, mId, status);
Eric Laurentc2730ba2014-07-20 15:47:07 -07002841 buffer->frameCount = buf.mFrameCount;
Mikhail Naganov938be412019-09-04 11:38:47 -07002842 if (ATRACE_ENABLED()) {
2843 std::string traceName("PRnObt");
2844 traceName += std::to_string(id());
2845 ATRACE_INT(traceName.c_str(), buf.mFrameCount);
2846 }
Eric Laurent83b88082014-06-20 18:31:16 -07002847 if (buf.mFrameCount == 0) {
2848 return WOULD_BLOCK;
2849 }
Glenn Kastend79072e2016-01-06 08:41:20 -08002850 status = RecordTrack::getNextBuffer(buffer);
Eric Laurent83b88082014-06-20 18:31:16 -07002851 return status;
2852}
2853
2854void AudioFlinger::RecordThread::PatchRecord::releaseBuffer(AudioBufferProvider::Buffer* buffer)
2855{
Andy Hung9d84af52018-09-12 18:03:44 -07002856 ALOG_ASSERT(mPeerProxy != 0, "%s(%d): called without peer proxy", __func__, mId);
Eric Laurent83b88082014-06-20 18:31:16 -07002857 Proxy::Buffer buf;
2858 buf.mFrameCount = buffer->frameCount;
2859 buf.mRaw = buffer->raw;
2860 mPeerProxy->releaseBuffer(&buf);
2861 TrackBase::releaseBuffer(buffer);
2862}
2863
2864status_t AudioFlinger::RecordThread::PatchRecord::obtainBuffer(Proxy::Buffer* buffer,
2865 const struct timespec *timeOut)
2866{
2867 return mProxy->obtainBuffer(buffer, timeOut);
2868}
2869
2870void AudioFlinger::RecordThread::PatchRecord::releaseBuffer(Proxy::Buffer* buffer)
2871{
2872 mProxy->releaseBuffer(buffer);
2873}
2874
Mikhail Naganovcaf59942019-09-25 14:05:29 -07002875#undef LOG_TAG
2876#define LOG_TAG "AF::PthrPatchRecord"
2877
2878static std::unique_ptr<void, decltype(free)*> allocAligned(size_t alignment, size_t size)
2879{
2880 void *ptr = nullptr;
2881 (void)posix_memalign(&ptr, alignment, size);
Andy Hung71ba4b32022-10-06 12:09:49 -07002882 return {ptr, free};
Mikhail Naganovcaf59942019-09-25 14:05:29 -07002883}
2884
2885AudioFlinger::RecordThread::PassthruPatchRecord::PassthruPatchRecord(
2886 RecordThread *recordThread,
2887 uint32_t sampleRate,
2888 audio_channel_mask_t channelMask,
2889 audio_format_t format,
2890 size_t frameCount,
Eric Laurent78b07302022-10-07 16:20:34 +02002891 audio_input_flags_t flags,
2892 audio_source_t source)
Mikhail Naganovcaf59942019-09-25 14:05:29 -07002893 : PatchRecord(recordThread, sampleRate, channelMask, format, frameCount,
Eric Laurent78b07302022-10-07 16:20:34 +02002894 nullptr /*buffer*/, 0 /*bufferSize*/, flags, {} /* timeout */, source),
Mikhail Naganovcaf59942019-09-25 14:05:29 -07002895 mPatchRecordAudioBufferProvider(*this),
2896 mSinkBuffer(allocAligned(32, mFrameCount * mFrameSize)),
2897 mStubBuffer(allocAligned(32, mFrameCount * mFrameSize))
2898{
2899 memset(mStubBuffer.get(), 0, mFrameCount * mFrameSize);
2900}
2901
2902sp<StreamInHalInterface> AudioFlinger::RecordThread::PassthruPatchRecord::obtainStream(
2903 sp<ThreadBase>* thread)
2904{
2905 *thread = mThread.promote();
2906 if (!*thread) return nullptr;
2907 RecordThread *recordThread = static_cast<RecordThread*>((*thread).get());
2908 Mutex::Autolock _l(recordThread->mLock);
2909 return recordThread->mInput ? recordThread->mInput->stream : nullptr;
2910}
2911
2912// PatchProxyBufferProvider methods are called on DirectOutputThread
2913status_t AudioFlinger::RecordThread::PassthruPatchRecord::obtainBuffer(
2914 Proxy::Buffer* buffer, const struct timespec* timeOut)
2915{
2916 if (mUnconsumedFrames) {
2917 buffer->mFrameCount = std::min(buffer->mFrameCount, mUnconsumedFrames);
2918 // mUnconsumedFrames is decreased in releaseBuffer to use actual frame consumption figure.
2919 return PatchRecord::obtainBuffer(buffer, timeOut);
2920 }
2921
2922 // Otherwise, execute a read from HAL and write into the buffer.
2923 nsecs_t startTimeNs = 0;
2924 if (timeOut && (timeOut->tv_sec != 0 || timeOut->tv_nsec != 0) && timeOut->tv_sec != INT_MAX) {
2925 // Will need to correct timeOut by elapsed time.
2926 startTimeNs = systemTime();
2927 }
2928 const size_t framesToRead = std::min(buffer->mFrameCount, mFrameCount);
2929 buffer->mFrameCount = 0;
2930 buffer->mRaw = nullptr;
2931 sp<ThreadBase> thread;
2932 sp<StreamInHalInterface> stream = obtainStream(&thread);
2933 if (!stream) return NO_INIT; // If there is no stream, RecordThread is not reading.
2934
2935 status_t result = NO_ERROR;
Mikhail Naganovcaf59942019-09-25 14:05:29 -07002936 size_t bytesRead = 0;
2937 {
2938 ATRACE_NAME("read");
2939 result = stream->read(mSinkBuffer.get(), framesToRead * mFrameSize, &bytesRead);
2940 if (result != NO_ERROR) goto stream_error;
2941 if (bytesRead == 0) return NO_ERROR;
2942 }
2943
2944 {
2945 std::lock_guard<std::mutex> lock(mReadLock);
2946 mReadBytes += bytesRead;
2947 mReadError = NO_ERROR;
2948 }
2949 mReadCV.notify_one();
2950 // writeFrames handles wraparound and should write all the provided frames.
2951 // If it couldn't, there is something wrong with the client/server buffer of the software patch.
2952 buffer->mFrameCount = writeFrames(
2953 &mPatchRecordAudioBufferProvider,
2954 mSinkBuffer.get(), bytesRead / mFrameSize, mFrameSize);
2955 ALOGW_IF(buffer->mFrameCount < bytesRead / mFrameSize,
2956 "Lost %zu frames obtained from HAL", bytesRead / mFrameSize - buffer->mFrameCount);
2957 mUnconsumedFrames = buffer->mFrameCount;
Mikhail Naganov4de49972019-10-07 09:53:58 -07002958 struct timespec newTimeOut;
Mikhail Naganovcaf59942019-09-25 14:05:29 -07002959 if (startTimeNs) {
Mikhail Naganov4de49972019-10-07 09:53:58 -07002960 // Correct the timeout by elapsed time.
2961 nsecs_t newTimeOutNs = audio_utils_ns_from_timespec(timeOut) - (systemTime() - startTimeNs);
Mikhail Naganovcaf59942019-09-25 14:05:29 -07002962 if (newTimeOutNs < 0) newTimeOutNs = 0;
2963 newTimeOut.tv_sec = newTimeOutNs / NANOS_PER_SECOND;
2964 newTimeOut.tv_nsec = newTimeOutNs - newTimeOut.tv_sec * NANOS_PER_SECOND;
Mikhail Naganov4de49972019-10-07 09:53:58 -07002965 timeOut = &newTimeOut;
Mikhail Naganovcaf59942019-09-25 14:05:29 -07002966 }
Mikhail Naganov4de49972019-10-07 09:53:58 -07002967 return PatchRecord::obtainBuffer(buffer, timeOut);
Mikhail Naganovcaf59942019-09-25 14:05:29 -07002968
2969stream_error:
2970 stream->standby();
2971 {
2972 std::lock_guard<std::mutex> lock(mReadLock);
2973 mReadError = result;
2974 }
2975 mReadCV.notify_one();
2976 return result;
2977}
2978
2979void AudioFlinger::RecordThread::PassthruPatchRecord::releaseBuffer(Proxy::Buffer* buffer)
2980{
2981 if (buffer->mFrameCount <= mUnconsumedFrames) {
2982 mUnconsumedFrames -= buffer->mFrameCount;
2983 } else {
2984 ALOGW("Write side has consumed more frames than we had: %zu > %zu",
2985 buffer->mFrameCount, mUnconsumedFrames);
2986 mUnconsumedFrames = 0;
2987 }
2988 PatchRecord::releaseBuffer(buffer);
2989}
2990
2991// AudioBufferProvider and Source methods are called on RecordThread
2992// 'read' emulates actual audio data with 0's. This is OK as 'getNextBuffer'
2993// and 'releaseBuffer' are stubbed out and ignore their input.
2994// It's not possible to retrieve actual data here w/o blocking 'obtainBuffer'
2995// until we copy it.
2996status_t AudioFlinger::RecordThread::PassthruPatchRecord::read(
2997 void* buffer, size_t bytes, size_t* read)
2998{
2999 bytes = std::min(bytes, mFrameCount * mFrameSize);
3000 {
3001 std::unique_lock<std::mutex> lock(mReadLock);
3002 mReadCV.wait(lock, [&]{ return mReadError != NO_ERROR || mReadBytes != 0; });
3003 if (mReadError != NO_ERROR) {
3004 mLastReadFrames = 0;
3005 return mReadError;
3006 }
3007 *read = std::min(bytes, mReadBytes);
3008 mReadBytes -= *read;
3009 }
3010 mLastReadFrames = *read / mFrameSize;
3011 memset(buffer, 0, *read);
3012 return 0;
3013}
3014
3015status_t AudioFlinger::RecordThread::PassthruPatchRecord::getCapturePosition(
3016 int64_t* frames, int64_t* time)
3017{
3018 sp<ThreadBase> thread;
3019 sp<StreamInHalInterface> stream = obtainStream(&thread);
3020 return stream ? stream->getCapturePosition(frames, time) : NO_INIT;
3021}
3022
3023status_t AudioFlinger::RecordThread::PassthruPatchRecord::standby()
3024{
3025 // RecordThread issues 'standby' command in two major cases:
3026 // 1. Error on read--this case is handled in 'obtainBuffer'.
3027 // 2. Track is stopping--as PassthruPatchRecord assumes continuous
3028 // output, this can only happen when the software patch
3029 // is being torn down. In this case, the RecordThread
3030 // will terminate and close the HAL stream.
3031 return 0;
3032}
3033
3034// As the buffer gets filled in obtainBuffer, here we only simulate data consumption.
3035status_t AudioFlinger::RecordThread::PassthruPatchRecord::getNextBuffer(
3036 AudioBufferProvider::Buffer* buffer)
3037{
3038 buffer->frameCount = mLastReadFrames;
3039 buffer->raw = buffer->frameCount != 0 ? mStubBuffer.get() : nullptr;
3040 return NO_ERROR;
3041}
3042
3043void AudioFlinger::RecordThread::PassthruPatchRecord::releaseBuffer(
3044 AudioBufferProvider::Buffer* buffer)
3045{
3046 buffer->frameCount = 0;
3047 buffer->raw = nullptr;
3048}
3049
Andy Hung9d84af52018-09-12 18:03:44 -07003050// ----------------------------------------------------------------------------
3051#undef LOG_TAG
3052#define LOG_TAG "AF::MmapTrack"
Eric Laurent6acd1d42017-01-04 14:23:29 -08003053
3054AudioFlinger::MmapThread::MmapTrack::MmapTrack(ThreadBase *thread,
Kevin Rocard1f564ac2018-03-29 13:53:10 -07003055 const audio_attributes_t& attr,
Eric Laurent6acd1d42017-01-04 14:23:29 -08003056 uint32_t sampleRate,
3057 audio_format_t format,
3058 audio_channel_mask_t channelMask,
3059 audio_session_t sessionId,
Kevin Rocard5f2136e2018-05-11 22:03:00 -07003060 bool isOut,
Svet Ganov33761132021-05-13 22:51:08 +00003061 const AttributionSourceState& attributionSource,
Eric Laurent09f1ed22019-04-24 17:45:17 -07003062 pid_t creatorPid,
Eric Laurent6acd1d42017-01-04 14:23:29 -08003063 audio_port_handle_t portId)
Kevin Rocard1f564ac2018-03-29 13:53:10 -07003064 : TrackBase(thread, NULL, attr, sampleRate, format,
Andy Hung8fe68032017-06-05 16:17:51 -07003065 channelMask, (size_t)0 /* frameCount */,
3066 nullptr /* buffer */, (size_t)0 /* bufferSize */,
Philip P. Moltmannbda45752020-07-17 16:41:18 -07003067 sessionId, creatorPid,
Svet Ganov33761132021-05-13 22:51:08 +00003068 VALUE_OR_FATAL(aidl2legacy_int32_t_uid_t(attributionSource.uid)),
Philip P. Moltmannbda45752020-07-17 16:41:18 -07003069 isOut,
Eric Laurent6acd1d42017-01-04 14:23:29 -08003070 ALLOC_NONE,
Andy Hungc2b11cb2020-04-22 09:04:01 -07003071 TYPE_DEFAULT, portId,
3072 std::string(AMEDIAMETRICS_KEY_PREFIX_AUDIO_MMAP) + std::to_string(portId)),
Svet Ganov33761132021-05-13 22:51:08 +00003073 mPid(VALUE_OR_FATAL(aidl2legacy_int32_t_uid_t(attributionSource.pid))),
Philip P. Moltmannbda45752020-07-17 16:41:18 -07003074 mSilenced(false), mSilencedNotified(false)
Eric Laurent6acd1d42017-01-04 14:23:29 -08003075{
Andy Hungc2b11cb2020-04-22 09:04:01 -07003076 // Once this item is logged by the server, the client can add properties.
Andy Hung94235282021-03-24 15:50:14 -07003077 mTrackMetrics.logConstructor(creatorPid, uid(), id());
Eric Laurent6acd1d42017-01-04 14:23:29 -08003078}
3079
3080AudioFlinger::MmapThread::MmapTrack::~MmapTrack()
3081{
3082}
3083
3084status_t AudioFlinger::MmapThread::MmapTrack::initCheck() const
3085{
3086 return NO_ERROR;
3087}
3088
3089status_t AudioFlinger::MmapThread::MmapTrack::start(AudioSystem::sync_event_t event __unused,
Kevin Rocard5f2136e2018-05-11 22:03:00 -07003090 audio_session_t triggerSession __unused)
Eric Laurent6acd1d42017-01-04 14:23:29 -08003091{
3092 return NO_ERROR;
3093}
3094
3095void AudioFlinger::MmapThread::MmapTrack::stop()
3096{
3097}
3098
3099// AudioBufferProvider interface
3100status_t AudioFlinger::MmapThread::MmapTrack::getNextBuffer(AudioBufferProvider::Buffer* buffer)
3101{
3102 buffer->frameCount = 0;
3103 buffer->raw = nullptr;
3104 return INVALID_OPERATION;
3105}
3106
3107// ExtendedAudioBufferProvider interface
3108size_t AudioFlinger::MmapThread::MmapTrack::framesReady() const {
3109 return 0;
3110}
3111
3112int64_t AudioFlinger::MmapThread::MmapTrack::framesReleased() const
3113{
3114 return 0;
3115}
3116
3117void AudioFlinger::MmapThread::MmapTrack::onTimestamp(const ExtendedTimestamp &timestamp __unused)
3118{
3119}
3120
Kevin Rocard5f2136e2018-05-11 22:03:00 -07003121void AudioFlinger::MmapThread::MmapTrack::appendDumpHeader(String8& result)
Eric Laurent6acd1d42017-01-04 14:23:29 -08003122{
Eric Laurent973db022018-11-20 14:54:31 -08003123 result.appendFormat("Client Session Port Id Format Chn mask SRate Flags %s\n",
Kevin Rocard5f2136e2018-05-11 22:03:00 -07003124 isOut() ? "Usg CT": "Source");
Eric Laurent6acd1d42017-01-04 14:23:29 -08003125}
3126
Andy Hung2c6c3bb2017-06-16 14:01:45 -07003127void AudioFlinger::MmapThread::MmapTrack::appendDump(String8& result, bool active __unused)
Eric Laurent6acd1d42017-01-04 14:23:29 -08003128{
Eric Laurent973db022018-11-20 14:54:31 -08003129 result.appendFormat("%6u %7u %7u %08X %08X %6u 0x%03X ",
Andy Hung2c6c3bb2017-06-16 14:01:45 -07003130 mPid,
3131 mSessionId,
Eric Laurent973db022018-11-20 14:54:31 -08003132 mPortId,
Eric Laurent6acd1d42017-01-04 14:23:29 -08003133 mFormat,
3134 mChannelMask,
Kevin Rocard5f2136e2018-05-11 22:03:00 -07003135 mSampleRate,
3136 mAttr.flags);
3137 if (isOut()) {
3138 result.appendFormat("%3x %2x", mAttr.usage, mAttr.content_type);
3139 } else {
3140 result.appendFormat("%6x", mAttr.source);
3141 }
3142 result.append("\n");
Eric Laurent6acd1d42017-01-04 14:23:29 -08003143}
3144
Glenn Kasten63238ef2015-03-02 15:50:29 -08003145} // namespace android