blob: 97360918855841374759e35d30706990ef9ce2c5 [file] [log] [blame]
Phil Burk2355edb2016-12-26 13:54:02 -08001/*
2 * Copyright (C) 2016 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Eric Laurentcb4dae22017-07-01 19:39:32 -070017#define LOG_TAG "AAudioServiceStreamBase"
Phil Burk2355edb2016-12-26 13:54:02 -080018//#define LOG_NDEBUG 0
19#include <utils/Log.h>
20
Phil Burka5222e22017-07-28 13:31:14 -070021#include <iomanip>
22#include <iostream>
Phil Burkc0c70e32017-02-09 13:18:38 -080023#include <mutex>
Phil Burk2355edb2016-12-26 13:54:02 -080024
Phil Burka9876702020-04-20 18:16:15 -070025#include <media/MediaMetricsItem.h>
26#include <media/TypeConverter.h>
Phil Burk7ebbc112020-05-13 15:55:17 -070027#include <mediautils/SchedulingPolicyService.h>
Phil Burka9876702020-04-20 18:16:15 -070028
Phil Burkc0c70e32017-02-09 13:18:38 -080029#include "binding/AAudioServiceMessage.h"
Phil Burka9876702020-04-20 18:16:15 -070030#include "core/AudioGlobal.h"
Phil Burkc0c70e32017-02-09 13:18:38 -080031#include "utility/AudioClock.h"
32
Phil Burk39f02dd2017-08-04 09:13:31 -070033#include "AAudioEndpointManager.h"
34#include "AAudioService.h"
35#include "AAudioServiceEndpoint.h"
Phil Burkc0c70e32017-02-09 13:18:38 -080036#include "AAudioServiceStreamBase.h"
37#include "TimestampScheduler.h"
38
39using namespace android; // TODO just import names needed
40using namespace aaudio; // TODO just import names needed
Phil Burk2355edb2016-12-26 13:54:02 -080041
42/**
Phil Burkc0c70e32017-02-09 13:18:38 -080043 * Base class for streams in the service.
44 * @return
Phil Burk2355edb2016-12-26 13:54:02 -080045 */
46
Phil Burk39f02dd2017-08-04 09:13:31 -070047AAudioServiceStreamBase::AAudioServiceStreamBase(AAudioService &audioService)
Phil Burk8f4fe502020-07-15 23:54:50 +000048 : mTimestampThread("AATime")
Phil Burka53ffa62018-10-10 16:21:37 -070049 , mAtomicStreamTimestamp()
Phil Burk39f02dd2017-08-04 09:13:31 -070050 , mAudioService(audioService) {
Eric Laurentcb4dae22017-07-01 19:39:32 -070051 mMmapClient.clientUid = -1;
52 mMmapClient.clientPid = -1;
53 mMmapClient.packageName = String16("");
Phil Burk2355edb2016-12-26 13:54:02 -080054}
55
Phil Burk5ed503c2017-02-01 09:38:15 -080056AAudioServiceStreamBase::~AAudioServiceStreamBase() {
Phil Burk8f4fe502020-07-15 23:54:50 +000057 ALOGD("%s() called", __func__);
58
Phil Burka9876702020-04-20 18:16:15 -070059 // May not be set if open failed.
60 if (mMetricsId.size() > 0) {
61 mediametrics::LogItem(mMetricsId)
62 .set(AMEDIAMETRICS_PROP_EVENT, AMEDIAMETRICS_PROP_EVENT_VALUE_DTOR)
63 .set(AMEDIAMETRICS_PROP_STATE, AudioGlobal_convertStreamStateToText(getState()))
64 .record();
65 }
66
Phil Burk5a26e662017-07-07 12:44:48 -070067 // If the stream is deleted when OPEN or in use then audio resources will leak.
68 // This would indicate an internal error. So we want to find this ASAP.
Phil Burkbcc36742017-08-31 17:24:51 -070069 LOG_ALWAYS_FATAL_IF(!(getState() == AAUDIO_STREAM_STATE_CLOSED
70 || getState() == AAUDIO_STREAM_STATE_UNINITIALIZED
71 || getState() == AAUDIO_STREAM_STATE_DISCONNECTED),
Phil Burk8b4e05e2019-12-17 12:12:09 -080072 "service stream %p still open, state = %d",
73 this, getState());
Phil Burk2355edb2016-12-26 13:54:02 -080074}
75
Phil Burka5222e22017-07-28 13:31:14 -070076std::string AAudioServiceStreamBase::dumpHeader() {
Phil Burkbbd52862018-04-13 11:37:42 -070077 return std::string(" T Handle UId Port Run State Format Burst Chan Capacity");
Phil Burka5222e22017-07-28 13:31:14 -070078}
79
Phil Burk4501b352017-06-29 18:12:36 -070080std::string AAudioServiceStreamBase::dump() const {
81 std::stringstream result;
82
Phil Burka5222e22017-07-28 13:31:14 -070083 result << " 0x" << std::setfill('0') << std::setw(8) << std::hex << mHandle
84 << std::dec << std::setfill(' ') ;
85 result << std::setw(6) << mMmapClient.clientUid;
Phil Burkbbd52862018-04-13 11:37:42 -070086 result << std::setw(7) << mClientHandle;
Phil Burka5222e22017-07-28 13:31:14 -070087 result << std::setw(4) << (isRunning() ? "yes" : " no");
Phil Burkbcc36742017-08-31 17:24:51 -070088 result << std::setw(6) << getState();
Phil Burk39f02dd2017-08-04 09:13:31 -070089 result << std::setw(7) << getFormat();
Phil Burka5222e22017-07-28 13:31:14 -070090 result << std::setw(6) << mFramesPerBurst;
Phil Burk39f02dd2017-08-04 09:13:31 -070091 result << std::setw(5) << getSamplesPerFrame();
92 result << std::setw(9) << getBufferCapacity();
Phil Burk4501b352017-06-29 18:12:36 -070093
94 return result.str();
95}
96
Phil Burka9876702020-04-20 18:16:15 -070097void AAudioServiceStreamBase::logOpen(aaudio_handle_t streamHandle) {
98 // This is the first log sent from the AAudio Service for a stream.
99 mMetricsId = std::string(AMEDIAMETRICS_KEY_PREFIX_AUDIO_STREAM)
100 + std::to_string(streamHandle);
101
102 audio_attributes_t attributes = AAudioServiceEndpoint::getAudioAttributesFrom(this);
103
104 // Once this item is logged by the server, the client with the same PID, UID
105 // can also log properties.
106 mediametrics::LogItem(mMetricsId)
107 .setPid(getOwnerProcessId())
108 .setUid(getOwnerUserId())
Andy Hungd203eb62020-04-27 09:12:46 -0700109 .set(AMEDIAMETRICS_PROP_ALLOWUID, (int32_t)getOwnerUserId())
Phil Burka9876702020-04-20 18:16:15 -0700110 .set(AMEDIAMETRICS_PROP_EVENT, AMEDIAMETRICS_PROP_EVENT_VALUE_OPEN)
111 // the following are immutable
112 .set(AMEDIAMETRICS_PROP_BUFFERCAPACITYFRAMES, (int32_t)getBufferCapacity())
113 .set(AMEDIAMETRICS_PROP_BURSTFRAMES, (int32_t)getFramesPerBurst())
114 .set(AMEDIAMETRICS_PROP_CHANNELCOUNT, (int32_t)getSamplesPerFrame())
115 .set(AMEDIAMETRICS_PROP_CONTENTTYPE, toString(attributes.content_type).c_str())
116 .set(AMEDIAMETRICS_PROP_DIRECTION,
117 AudioGlobal_convertDirectionToText(getDirection()))
118 .set(AMEDIAMETRICS_PROP_ENCODING, toString(getFormat()).c_str())
119 .set(AMEDIAMETRICS_PROP_ROUTEDDEVICEID, (int32_t)getDeviceId())
120 .set(AMEDIAMETRICS_PROP_SAMPLERATE, (int32_t)getSampleRate())
121 .set(AMEDIAMETRICS_PROP_SESSIONID, (int32_t)getSessionId())
122 .set(AMEDIAMETRICS_PROP_SOURCE, toString(attributes.source).c_str())
123 .set(AMEDIAMETRICS_PROP_USAGE, toString(attributes.usage).c_str())
124 .record();
125}
126
Phil Burk15f97c92018-09-04 14:06:27 -0700127aaudio_result_t AAudioServiceStreamBase::open(const aaudio::AAudioStreamRequest &request) {
Phil Burk39f02dd2017-08-04 09:13:31 -0700128 AAudioEndpointManager &mEndpointManager = AAudioEndpointManager::getInstance();
129 aaudio_result_t result = AAUDIO_OK;
Eric Laurentcb4dae22017-07-01 19:39:32 -0700130
131 mMmapClient.clientUid = request.getUserId();
132 mMmapClient.clientPid = request.getProcessId();
Phil Burk39f02dd2017-08-04 09:13:31 -0700133 mMmapClient.packageName.setTo(String16("")); // TODO What should we do here?
Eric Laurentcb4dae22017-07-01 19:39:32 -0700134
Phil Burk39f02dd2017-08-04 09:13:31 -0700135 // Limit scope of lock to avoid recursive lock in close().
136 {
137 std::lock_guard<std::mutex> lock(mUpMessageQueueLock);
138 if (mUpMessageQueue != nullptr) {
Phil Burk19e990e2018-03-22 13:59:34 -0700139 ALOGE("%s() called twice", __func__);
Phil Burk39f02dd2017-08-04 09:13:31 -0700140 return AAUDIO_ERROR_INVALID_STATE;
141 }
142
Phil Burk8f4fe502020-07-15 23:54:50 +0000143 mUpMessageQueue = std::make_shared<SharedRingBuffer>();
Phil Burk39f02dd2017-08-04 09:13:31 -0700144 result = mUpMessageQueue->allocate(sizeof(AAudioServiceMessage),
145 QUEUE_UP_CAPACITY_COMMANDS);
146 if (result != AAUDIO_OK) {
147 goto error;
148 }
149
Phil Burk6e2770e2018-05-01 13:03:52 -0700150 // This is not protected by a lock because the stream cannot be
151 // referenced until the service returns a handle to the client.
152 // So only one thread can open a stream.
Phil Burk39f02dd2017-08-04 09:13:31 -0700153 mServiceEndpoint = mEndpointManager.openEndpoint(mAudioService,
Phil Burk15f97c92018-09-04 14:06:27 -0700154 request);
Phil Burk39f02dd2017-08-04 09:13:31 -0700155 if (mServiceEndpoint == nullptr) {
Phil Burk39f02dd2017-08-04 09:13:31 -0700156 result = AAUDIO_ERROR_UNAVAILABLE;
157 goto error;
158 }
Phil Burk6e2770e2018-05-01 13:03:52 -0700159 // Save a weak pointer that we will use to access the endpoint.
160 mServiceEndpointWeak = mServiceEndpoint;
161
Phil Burk39f02dd2017-08-04 09:13:31 -0700162 mFramesPerBurst = mServiceEndpoint->getFramesPerBurst();
163 copyFrom(*mServiceEndpoint);
Phil Burkc0c70e32017-02-09 13:18:38 -0800164 }
Phil Burk39f02dd2017-08-04 09:13:31 -0700165 return result;
166
167error:
168 close();
169 return result;
Phil Burkc0c70e32017-02-09 13:18:38 -0800170}
Phil Burkdec33ab2017-01-17 14:48:16 -0800171
Phil Burkc0c70e32017-02-09 13:18:38 -0800172aaudio_result_t AAudioServiceStreamBase::close() {
Phil Burk7ebbc112020-05-13 15:55:17 -0700173 std::lock_guard<std::mutex> lock(mLock);
174 return close_l();
175}
176
177aaudio_result_t AAudioServiceStreamBase::close_l() {
Phil Burkbcc36742017-08-31 17:24:51 -0700178 if (getState() == AAUDIO_STREAM_STATE_CLOSED) {
Phil Burk39f02dd2017-08-04 09:13:31 -0700179 return AAUDIO_OK;
180 }
181
Phil Burk8f4fe502020-07-15 23:54:50 +0000182 // This will call stopTimestampThread() and also stop the stream,
183 // just in case it was not already stopped.
Phil Burk7ebbc112020-05-13 15:55:17 -0700184 stop_l();
Phil Burk39f02dd2017-08-04 09:13:31 -0700185
Phil Burk8b4e05e2019-12-17 12:12:09 -0800186 aaudio_result_t result = AAUDIO_OK;
Phil Burk6e2770e2018-05-01 13:03:52 -0700187 sp<AAudioServiceEndpoint> endpoint = mServiceEndpointWeak.promote();
188 if (endpoint == nullptr) {
Phil Burk39f02dd2017-08-04 09:13:31 -0700189 result = AAUDIO_ERROR_INVALID_STATE;
190 } else {
Phil Burk6e2770e2018-05-01 13:03:52 -0700191 endpoint->unregisterStream(this);
192 AAudioEndpointManager &endpointManager = AAudioEndpointManager::getInstance();
193 endpointManager.closeEndpoint(endpoint);
194
195 // AAudioService::closeStream() prevents two threads from closing at the same time.
Phil Burk7ebbc112020-05-13 15:55:17 -0700196 mServiceEndpoint.clear(); // endpoint will hold the pointer after this method returns.
Phil Burk39f02dd2017-08-04 09:13:31 -0700197 }
198
Phil Burkbcc36742017-08-31 17:24:51 -0700199 setState(AAUDIO_STREAM_STATE_CLOSED);
Phil Burka9876702020-04-20 18:16:15 -0700200
201 mediametrics::LogItem(mMetricsId)
202 .set(AMEDIAMETRICS_PROP_EVENT, AMEDIAMETRICS_PROP_EVENT_VALUE_CLOSE)
203 .record();
Phil Burk39f02dd2017-08-04 09:13:31 -0700204 return result;
Phil Burkc0c70e32017-02-09 13:18:38 -0800205}
206
Phil Burkbcc36742017-08-31 17:24:51 -0700207aaudio_result_t AAudioServiceStreamBase::startDevice() {
208 mClientHandle = AUDIO_PORT_HANDLE_NONE;
Phil Burk6e2770e2018-05-01 13:03:52 -0700209 sp<AAudioServiceEndpoint> endpoint = mServiceEndpointWeak.promote();
210 if (endpoint == nullptr) {
211 ALOGE("%s() has no endpoint", __func__);
212 return AAUDIO_ERROR_INVALID_STATE;
213 }
214 return endpoint->startStream(this, &mClientHandle);
Phil Burkbcc36742017-08-31 17:24:51 -0700215}
216
Phil Burk39f02dd2017-08-04 09:13:31 -0700217/**
218 * Start the flow of audio data.
219 *
220 * An AAUDIO_SERVICE_EVENT_STARTED will be sent to the client when complete.
221 */
Phil Burkc0c70e32017-02-09 13:18:38 -0800222aaudio_result_t AAudioServiceStreamBase::start() {
Phil Burk7ebbc112020-05-13 15:55:17 -0700223 std::lock_guard<std::mutex> lock(mLock);
224
Phil Burka9876702020-04-20 18:16:15 -0700225 const int64_t beginNs = AudioClock::getNanoseconds();
Phil Burkbcc36742017-08-31 17:24:51 -0700226 aaudio_result_t result = AAUDIO_OK;
Phil Burk6e2770e2018-05-01 13:03:52 -0700227
Phil Burk7ebbc112020-05-13 15:55:17 -0700228 if (auto state = getState();
229 state == AAUDIO_STREAM_STATE_CLOSED || state == AAUDIO_STREAM_STATE_DISCONNECTED) {
230 ALOGW("%s() already CLOSED, returns INVALID_STATE, handle = %d",
231 __func__, getHandle());
232 return AAUDIO_ERROR_INVALID_STATE;
233 }
234
Phil Burka9876702020-04-20 18:16:15 -0700235 mediametrics::Defer defer([&] {
236 mediametrics::LogItem(mMetricsId)
237 .set(AMEDIAMETRICS_PROP_EVENT, AMEDIAMETRICS_PROP_EVENT_VALUE_START)
Andy Hungea840382020-05-05 21:50:17 -0700238 .set(AMEDIAMETRICS_PROP_EXECUTIONTIMENS, (int64_t)(AudioClock::getNanoseconds() - beginNs))
Phil Burka9876702020-04-20 18:16:15 -0700239 .set(AMEDIAMETRICS_PROP_STATE, AudioGlobal_convertStreamStateToText(getState()))
240 .set(AMEDIAMETRICS_PROP_STATUS, (int32_t)result)
241 .record(); });
242
Eric Laurentcb4dae22017-07-01 19:39:32 -0700243 if (isRunning()) {
Phil Burk7ebbc112020-05-13 15:55:17 -0700244 return result;
Eric Laurentcb4dae22017-07-01 19:39:32 -0700245 }
Phil Burk39f02dd2017-08-04 09:13:31 -0700246
Phil Burk23296382017-11-20 15:45:11 -0800247 setFlowing(false);
Phil Burk762365c2018-12-10 16:02:16 -0800248 setSuspended(false);
Phil Burk23296382017-11-20 15:45:11 -0800249
Phil Burkbcc36742017-08-31 17:24:51 -0700250 // Start with fresh presentation timestamps.
Phil Burka53ffa62018-10-10 16:21:37 -0700251 mAtomicStreamTimestamp.clear();
Phil Burkbcc36742017-08-31 17:24:51 -0700252
Phil Burk39f02dd2017-08-04 09:13:31 -0700253 mClientHandle = AUDIO_PORT_HANDLE_NONE;
Phil Burkbcc36742017-08-31 17:24:51 -0700254 result = startDevice();
255 if (result != AAUDIO_OK) goto error;
256
257 // This should happen at the end of the start.
258 sendServiceEvent(AAUDIO_SERVICE_EVENT_STARTED);
259 setState(AAUDIO_STREAM_STATE_STARTED);
260 mThreadEnabled.store(true);
261 result = mTimestampThread.start(this);
262 if (result != AAUDIO_OK) goto error;
263
264 return result;
265
266error:
Phil Burk7ebbc112020-05-13 15:55:17 -0700267 disconnect_l();
Phil Burk39f02dd2017-08-04 09:13:31 -0700268 return result;
Phil Burkc0c70e32017-02-09 13:18:38 -0800269}
270
271aaudio_result_t AAudioServiceStreamBase::pause() {
Phil Burk7ebbc112020-05-13 15:55:17 -0700272 std::lock_guard<std::mutex> lock(mLock);
273 return pause_l();
274}
275
276aaudio_result_t AAudioServiceStreamBase::pause_l() {
Phil Burk11e8d332017-05-24 09:59:02 -0700277 aaudio_result_t result = AAUDIO_OK;
Eric Laurentcb4dae22017-07-01 19:39:32 -0700278 if (!isRunning()) {
279 return result;
Phil Burkc0c70e32017-02-09 13:18:38 -0800280 }
Phil Burk7ebbc112020-05-13 15:55:17 -0700281 const int64_t beginNs = AudioClock::getNanoseconds();
Phil Burk73af62a2017-10-26 12:11:47 -0700282
Phil Burka9876702020-04-20 18:16:15 -0700283 mediametrics::Defer defer([&] {
284 mediametrics::LogItem(mMetricsId)
285 .set(AMEDIAMETRICS_PROP_EVENT, AMEDIAMETRICS_PROP_EVENT_VALUE_PAUSE)
Andy Hungea840382020-05-05 21:50:17 -0700286 .set(AMEDIAMETRICS_PROP_EXECUTIONTIMENS, (int64_t)(AudioClock::getNanoseconds() - beginNs))
Phil Burka9876702020-04-20 18:16:15 -0700287 .set(AMEDIAMETRICS_PROP_STATE, AudioGlobal_convertStreamStateToText(getState()))
288 .set(AMEDIAMETRICS_PROP_STATUS, (int32_t)result)
289 .record(); });
290
Phil Burk73af62a2017-10-26 12:11:47 -0700291 // Send it now because the timestamp gets rounded up when stopStream() is called below.
292 // Also we don't need the timestamps while we are shutting down.
293 sendCurrentTimestamp();
294
295 result = stopTimestampThread();
296 if (result != AAUDIO_OK) {
Phil Burk7ebbc112020-05-13 15:55:17 -0700297 disconnect_l();
Phil Burk73af62a2017-10-26 12:11:47 -0700298 return result;
299 }
300
Phil Burk6e2770e2018-05-01 13:03:52 -0700301 sp<AAudioServiceEndpoint> endpoint = mServiceEndpointWeak.promote();
302 if (endpoint == nullptr) {
303 ALOGE("%s() has no endpoint", __func__);
Phil Burka9876702020-04-20 18:16:15 -0700304 result = AAUDIO_ERROR_INVALID_STATE; // for MediaMetric tracking
305 return result;
Phil Burk6e2770e2018-05-01 13:03:52 -0700306 }
307 result = endpoint->stopStream(this, mClientHandle);
Phil Burk39f02dd2017-08-04 09:13:31 -0700308 if (result != AAUDIO_OK) {
Phil Burk19e990e2018-03-22 13:59:34 -0700309 ALOGE("%s() mServiceEndpoint returned %d, %s", __func__, result, getTypeText());
Phil Burk7ebbc112020-05-13 15:55:17 -0700310 disconnect_l(); // TODO should we return or pause Base first?
Phil Burk39f02dd2017-08-04 09:13:31 -0700311 }
312
Eric Laurentcb4dae22017-07-01 19:39:32 -0700313 sendServiceEvent(AAUDIO_SERVICE_EVENT_PAUSED);
Phil Burkbcc36742017-08-31 17:24:51 -0700314 setState(AAUDIO_STREAM_STATE_PAUSED);
Phil Burkc0c70e32017-02-09 13:18:38 -0800315 return result;
316}
317
Phil Burk71f35bb2017-04-13 16:05:07 -0700318aaudio_result_t AAudioServiceStreamBase::stop() {
Phil Burk7ebbc112020-05-13 15:55:17 -0700319 std::lock_guard<std::mutex> lock(mLock);
320 return stop_l();
321}
322
323aaudio_result_t AAudioServiceStreamBase::stop_l() {
Phil Burk11e8d332017-05-24 09:59:02 -0700324 aaudio_result_t result = AAUDIO_OK;
Eric Laurentcb4dae22017-07-01 19:39:32 -0700325 if (!isRunning()) {
326 return result;
Phil Burk71f35bb2017-04-13 16:05:07 -0700327 }
Phil Burk7ebbc112020-05-13 15:55:17 -0700328 const int64_t beginNs = AudioClock::getNanoseconds();
Phil Burk39f02dd2017-08-04 09:13:31 -0700329
Phil Burka9876702020-04-20 18:16:15 -0700330 mediametrics::Defer defer([&] {
331 mediametrics::LogItem(mMetricsId)
332 .set(AMEDIAMETRICS_PROP_EVENT, AMEDIAMETRICS_PROP_EVENT_VALUE_STOP)
Andy Hungea840382020-05-05 21:50:17 -0700333 .set(AMEDIAMETRICS_PROP_EXECUTIONTIMENS, (int64_t)(AudioClock::getNanoseconds() - beginNs))
Phil Burka9876702020-04-20 18:16:15 -0700334 .set(AMEDIAMETRICS_PROP_STATE, AudioGlobal_convertStreamStateToText(getState()))
335 .set(AMEDIAMETRICS_PROP_STATUS, (int32_t)result)
336 .record(); });
337
Phil Burk83fb8442017-10-05 16:55:17 -0700338 setState(AAUDIO_STREAM_STATE_STOPPING);
339
Phil Burk73af62a2017-10-26 12:11:47 -0700340 // Send it now because the timestamp gets rounded up when stopStream() is called below.
341 // Also we don't need the timestamps while we are shutting down.
Eric Laurentcb4dae22017-07-01 19:39:32 -0700342 sendCurrentTimestamp(); // warning - this calls a virtual function
343 result = stopTimestampThread();
344 if (result != AAUDIO_OK) {
Phil Burk7ebbc112020-05-13 15:55:17 -0700345 disconnect_l();
Eric Laurentcb4dae22017-07-01 19:39:32 -0700346 return result;
347 }
Phil Burk39f02dd2017-08-04 09:13:31 -0700348
Phil Burk6e2770e2018-05-01 13:03:52 -0700349 sp<AAudioServiceEndpoint> endpoint = mServiceEndpointWeak.promote();
350 if (endpoint == nullptr) {
351 ALOGE("%s() has no endpoint", __func__);
Phil Burka9876702020-04-20 18:16:15 -0700352 result = AAUDIO_ERROR_INVALID_STATE; // for MediaMetric tracking
353 return result;
Phil Burk6e2770e2018-05-01 13:03:52 -0700354 }
Phil Burk39f02dd2017-08-04 09:13:31 -0700355 // TODO wait for data to be played out
Phil Burk6e2770e2018-05-01 13:03:52 -0700356 result = endpoint->stopStream(this, mClientHandle);
Phil Burk39f02dd2017-08-04 09:13:31 -0700357 if (result != AAUDIO_OK) {
Phil Burk6e2770e2018-05-01 13:03:52 -0700358 ALOGE("%s() stopStream returned %d, %s", __func__, result, getTypeText());
Phil Burk7ebbc112020-05-13 15:55:17 -0700359 disconnect_l();
Phil Burk39f02dd2017-08-04 09:13:31 -0700360 // TODO what to do with result here?
361 }
362
Eric Laurentcb4dae22017-07-01 19:39:32 -0700363 sendServiceEvent(AAUDIO_SERVICE_EVENT_STOPPED);
Phil Burkbcc36742017-08-31 17:24:51 -0700364 setState(AAUDIO_STREAM_STATE_STOPPED);
Phil Burk71f35bb2017-04-13 16:05:07 -0700365 return result;
366}
367
Phil Burk98d6d922017-07-06 11:52:45 -0700368aaudio_result_t AAudioServiceStreamBase::stopTimestampThread() {
369 aaudio_result_t result = AAUDIO_OK;
370 // clear flag that tells thread to loop
371 if (mThreadEnabled.exchange(false)) {
Phil Burkbcc36742017-08-31 17:24:51 -0700372 result = mTimestampThread.stop();
Phil Burk98d6d922017-07-06 11:52:45 -0700373 }
374 return result;
375}
376
Phil Burk71f35bb2017-04-13 16:05:07 -0700377aaudio_result_t AAudioServiceStreamBase::flush() {
Phil Burk7ebbc112020-05-13 15:55:17 -0700378 std::lock_guard<std::mutex> lock(mLock);
Phil Burk5cc83c32017-11-28 15:43:18 -0800379 aaudio_result_t result = AAudio_isFlushAllowed(getState());
380 if (result != AAUDIO_OK) {
381 return result;
Phil Burk39f02dd2017-08-04 09:13:31 -0700382 }
Phil Burk7ebbc112020-05-13 15:55:17 -0700383 const int64_t beginNs = AudioClock::getNanoseconds();
Phil Burk5cc83c32017-11-28 15:43:18 -0800384
Phil Burka9876702020-04-20 18:16:15 -0700385 mediametrics::Defer defer([&] {
386 mediametrics::LogItem(mMetricsId)
387 .set(AMEDIAMETRICS_PROP_EVENT, AMEDIAMETRICS_PROP_EVENT_VALUE_FLUSH)
Andy Hungea840382020-05-05 21:50:17 -0700388 .set(AMEDIAMETRICS_PROP_EXECUTIONTIMENS, (int64_t)(AudioClock::getNanoseconds() - beginNs))
Phil Burka9876702020-04-20 18:16:15 -0700389 .set(AMEDIAMETRICS_PROP_STATE, AudioGlobal_convertStreamStateToText(getState()))
390 .set(AMEDIAMETRICS_PROP_STATUS, (int32_t)result)
391 .record(); });
392
Phil Burk39f02dd2017-08-04 09:13:31 -0700393 // Data will get flushed when the client receives the FLUSHED event.
Phil Burk71f35bb2017-04-13 16:05:07 -0700394 sendServiceEvent(AAUDIO_SERVICE_EVENT_FLUSHED);
Phil Burkbcc36742017-08-31 17:24:51 -0700395 setState(AAUDIO_STREAM_STATE_FLUSHED);
Phil Burk71f35bb2017-04-13 16:05:07 -0700396 return AAUDIO_OK;
397}
398
Phil Burkcf5f6d22017-05-26 12:35:07 -0700399// implement Runnable, periodically send timestamps to client
Phil Burka53ffa62018-10-10 16:21:37 -0700400__attribute__((no_sanitize("integer")))
Phil Burkc0c70e32017-02-09 13:18:38 -0800401void AAudioServiceStreamBase::run() {
Phil Burk19e990e2018-03-22 13:59:34 -0700402 ALOGD("%s() %s entering >>>>>>>>>>>>>> TIMESTAMPS", __func__, getTypeText());
Phil Burkc0c70e32017-02-09 13:18:38 -0800403 TimestampScheduler timestampScheduler;
Phil Burk39f02dd2017-08-04 09:13:31 -0700404 timestampScheduler.setBurstPeriod(mFramesPerBurst, getSampleRate());
Phil Burkc0c70e32017-02-09 13:18:38 -0800405 timestampScheduler.start(AudioClock::getNanoseconds());
406 int64_t nextTime = timestampScheduler.nextAbsoluteTime();
Phil Burka53ffa62018-10-10 16:21:37 -0700407 int32_t loopCount = 0;
Phil Burkc0c70e32017-02-09 13:18:38 -0800408 while(mThreadEnabled.load()) {
Phil Burka53ffa62018-10-10 16:21:37 -0700409 loopCount++;
Phil Burkc0c70e32017-02-09 13:18:38 -0800410 if (AudioClock::getNanoseconds() >= nextTime) {
411 aaudio_result_t result = sendCurrentTimestamp();
412 if (result != AAUDIO_OK) {
Phil Burka53ffa62018-10-10 16:21:37 -0700413 ALOGE("%s() timestamp thread got result = %d", __func__, result);
Phil Burkc0c70e32017-02-09 13:18:38 -0800414 break;
415 }
416 nextTime = timestampScheduler.nextAbsoluteTime();
417 } else {
418 // Sleep until it is time to send the next timestamp.
Phil Burk98d6d922017-07-06 11:52:45 -0700419 // TODO Wait for a signal with a timeout so that we can stop more quickly.
Phil Burkc0c70e32017-02-09 13:18:38 -0800420 AudioClock::sleepUntilNanoTime(nextTime);
421 }
422 }
Phil Burka53ffa62018-10-10 16:21:37 -0700423 ALOGD("%s() %s exiting after %d loops <<<<<<<<<<<<<< TIMESTAMPS",
424 __func__, getTypeText(), loopCount);
Phil Burkc0c70e32017-02-09 13:18:38 -0800425}
426
Phil Burk5ef003b2017-06-30 11:43:37 -0700427void AAudioServiceStreamBase::disconnect() {
Phil Burk7ebbc112020-05-13 15:55:17 -0700428 std::lock_guard<std::mutex> lock(mLock);
429 disconnect_l();
430}
431
432void AAudioServiceStreamBase::disconnect_l() {
433 if (getState() != AAUDIO_STREAM_STATE_DISCONNECTED
434 && getState() != AAUDIO_STREAM_STATE_CLOSED) {
435
Phil Burka9876702020-04-20 18:16:15 -0700436 mediametrics::LogItem(mMetricsId)
437 .set(AMEDIAMETRICS_PROP_EVENT, AMEDIAMETRICS_PROP_EVENT_VALUE_DISCONNECT)
438 .set(AMEDIAMETRICS_PROP_STATE, AudioGlobal_convertStreamStateToText(getState()))
439 .record();
Phil Burk7ebbc112020-05-13 15:55:17 -0700440
Phil Burk5ef003b2017-06-30 11:43:37 -0700441 sendServiceEvent(AAUDIO_SERVICE_EVENT_DISCONNECTED);
Phil Burkbcc36742017-08-31 17:24:51 -0700442 setState(AAUDIO_STREAM_STATE_DISCONNECTED);
Phil Burk5ef003b2017-06-30 11:43:37 -0700443 }
Phil Burkc0c70e32017-02-09 13:18:38 -0800444}
445
Phil Burk7ebbc112020-05-13 15:55:17 -0700446aaudio_result_t AAudioServiceStreamBase::registerAudioThread(pid_t clientThreadId,
447 int priority) {
448 std::lock_guard<std::mutex> lock(mLock);
449 aaudio_result_t result = AAUDIO_OK;
450 if (getRegisteredThread() != AAudioServiceStreamBase::ILLEGAL_THREAD_ID) {
451 ALOGE("AAudioService::registerAudioThread(), thread already registered");
452 result = AAUDIO_ERROR_INVALID_STATE;
453 } else {
454 const pid_t ownerPid = IPCThreadState::self()->getCallingPid(); // TODO review
455 setRegisteredThread(clientThreadId);
456 int err = android::requestPriority(ownerPid, clientThreadId,
457 priority, true /* isForApp */);
458 if (err != 0) {
459 ALOGE("AAudioService::registerAudioThread(%d) failed, errno = %d, priority = %d",
460 clientThreadId, errno, priority);
461 result = AAUDIO_ERROR_INTERNAL;
462 }
463 }
464 return result;
465}
466
467aaudio_result_t AAudioServiceStreamBase::unregisterAudioThread(pid_t clientThreadId) {
468 std::lock_guard<std::mutex> lock(mLock);
469 aaudio_result_t result = AAUDIO_OK;
470 if (getRegisteredThread() != clientThreadId) {
471 ALOGE("%s(), wrong thread", __func__);
472 result = AAUDIO_ERROR_ILLEGAL_ARGUMENT;
473 } else {
474 setRegisteredThread(0);
475 }
476 return result;
477}
478
479void AAudioServiceStreamBase::setState(aaudio_stream_state_t state) {
480 // CLOSED is a final state.
481 if (mState != AAUDIO_STREAM_STATE_CLOSED) {
482 mState = state;
483 } else {
484 ALOGW_IF(mState != state, "%s(%d) when already CLOSED", __func__, state);
485 }
486}
487
Phil Burkc0c70e32017-02-09 13:18:38 -0800488aaudio_result_t AAudioServiceStreamBase::sendServiceEvent(aaudio_service_event_t event,
Phil Burk23296382017-11-20 15:45:11 -0800489 double dataDouble) {
Phil Burk5ed503c2017-02-01 09:38:15 -0800490 AAudioServiceMessage command;
491 command.what = AAudioServiceMessage::code::EVENT;
Phil Burk2355edb2016-12-26 13:54:02 -0800492 command.event.event = event;
Phil Burkc0c70e32017-02-09 13:18:38 -0800493 command.event.dataDouble = dataDouble;
Phil Burk23296382017-11-20 15:45:11 -0800494 return writeUpMessageQueue(&command);
495}
496
497aaudio_result_t AAudioServiceStreamBase::sendServiceEvent(aaudio_service_event_t event,
498 int64_t dataLong) {
499 AAudioServiceMessage command;
500 command.what = AAudioServiceMessage::code::EVENT;
501 command.event.event = event;
Phil Burkc0c70e32017-02-09 13:18:38 -0800502 command.event.dataLong = dataLong;
503 return writeUpMessageQueue(&command);
504}
505
Phil Burkf878a8d2019-03-29 17:23:00 -0700506bool AAudioServiceStreamBase::isUpMessageQueueBusy() {
507 std::lock_guard<std::mutex> lock(mUpMessageQueueLock);
508 if (mUpMessageQueue == nullptr) {
509 ALOGE("%s(): mUpMessageQueue null! - stream not open", __func__);
510 return true;
511 }
Phil Burkf878a8d2019-03-29 17:23:00 -0700512 // Is it half full or more
Phil Burk8f4fe502020-07-15 23:54:50 +0000513 return mUpMessageQueue->getFractionalFullness() >= 0.5;
Phil Burkf878a8d2019-03-29 17:23:00 -0700514}
515
Phil Burkc0c70e32017-02-09 13:18:38 -0800516aaudio_result_t AAudioServiceStreamBase::writeUpMessageQueue(AAudioServiceMessage *command) {
Phil Burk39f02dd2017-08-04 09:13:31 -0700517 std::lock_guard<std::mutex> lock(mUpMessageQueueLock);
Phil Burk71f35bb2017-04-13 16:05:07 -0700518 if (mUpMessageQueue == nullptr) {
Phil Burk19e990e2018-03-22 13:59:34 -0700519 ALOGE("%s(): mUpMessageQueue null! - stream not open", __func__);
Phil Burk71f35bb2017-04-13 16:05:07 -0700520 return AAUDIO_ERROR_NULL;
521 }
Phil Burkc0c70e32017-02-09 13:18:38 -0800522 int32_t count = mUpMessageQueue->getFifoBuffer()->write(command, 1);
523 if (count != 1) {
Phil Burk762365c2018-12-10 16:02:16 -0800524 ALOGW("%s(): Queue full. Did client stop? Suspending stream. what = %u, %s",
525 __func__, command->what, getTypeText());
526 setSuspended(true);
Phil Burkc0c70e32017-02-09 13:18:38 -0800527 return AAUDIO_ERROR_WOULD_BLOCK;
528 } else {
529 return AAUDIO_OK;
530 }
531}
532
Phil Burk23296382017-11-20 15:45:11 -0800533aaudio_result_t AAudioServiceStreamBase::sendXRunCount(int32_t xRunCount) {
534 return sendServiceEvent(AAUDIO_SERVICE_EVENT_XRUN, (int64_t) xRunCount);
535}
536
Phil Burkc0c70e32017-02-09 13:18:38 -0800537aaudio_result_t AAudioServiceStreamBase::sendCurrentTimestamp() {
538 AAudioServiceMessage command;
Phil Burkf878a8d2019-03-29 17:23:00 -0700539 // It is not worth filling up the queue with timestamps.
540 // That can cause the stream to get suspended.
541 // So just drop the timestamp if the queue is getting full.
542 if (isUpMessageQueueBusy()) {
543 return AAUDIO_OK;
544 }
545
Phil Burk97350f92017-07-21 15:59:44 -0700546 // Send a timestamp for the clock model.
Phil Burkc0c70e32017-02-09 13:18:38 -0800547 aaudio_result_t result = getFreeRunningPosition(&command.timestamp.position,
548 &command.timestamp.timestamp);
549 if (result == AAUDIO_OK) {
Phil Burk19e990e2018-03-22 13:59:34 -0700550 ALOGV("%s() SERVICE %8lld at %lld", __func__,
Phil Burkbcc36742017-08-31 17:24:51 -0700551 (long long) command.timestamp.position,
552 (long long) command.timestamp.timestamp);
Phil Burk97350f92017-07-21 15:59:44 -0700553 command.what = AAudioServiceMessage::code::TIMESTAMP_SERVICE;
Phil Burkc0c70e32017-02-09 13:18:38 -0800554 result = writeUpMessageQueue(&command);
Phil Burk97350f92017-07-21 15:59:44 -0700555
556 if (result == AAUDIO_OK) {
557 // Send a hardware timestamp for presentation time.
558 result = getHardwareTimestamp(&command.timestamp.position,
559 &command.timestamp.timestamp);
560 if (result == AAUDIO_OK) {
Phil Burk19e990e2018-03-22 13:59:34 -0700561 ALOGV("%s() HARDWARE %8lld at %lld", __func__,
Phil Burkbcc36742017-08-31 17:24:51 -0700562 (long long) command.timestamp.position,
563 (long long) command.timestamp.timestamp);
Phil Burk97350f92017-07-21 15:59:44 -0700564 command.what = AAudioServiceMessage::code::TIMESTAMP_HARDWARE;
565 result = writeUpMessageQueue(&command);
566 }
567 }
568 }
569
Phil Burkbcc36742017-08-31 17:24:51 -0700570 if (result == AAUDIO_ERROR_UNAVAILABLE) { // TODO review best error code
Phil Burk940083c2017-07-17 17:00:02 -0700571 result = AAUDIO_OK; // just not available yet, try again later
Phil Burkc0c70e32017-02-09 13:18:38 -0800572 }
573 return result;
Phil Burk2355edb2016-12-26 13:54:02 -0800574}
575
Phil Burkc0c70e32017-02-09 13:18:38 -0800576/**
577 * Get an immutable description of the in-memory queues
578 * used to communicate with the underlying HAL or Service.
579 */
580aaudio_result_t AAudioServiceStreamBase::getDescription(AudioEndpointParcelable &parcelable) {
Phil Burk7ebbc112020-05-13 15:55:17 -0700581 std::lock_guard<std::mutex> lock(mLock);
Phil Burk523b3042017-09-13 13:03:08 -0700582 {
583 std::lock_guard<std::mutex> lock(mUpMessageQueueLock);
584 if (mUpMessageQueue == nullptr) {
Phil Burk19e990e2018-03-22 13:59:34 -0700585 ALOGE("%s(): mUpMessageQueue null! - stream not open", __func__);
Phil Burk523b3042017-09-13 13:03:08 -0700586 return AAUDIO_ERROR_NULL;
587 }
588 // Gather information on the message queue.
589 mUpMessageQueue->fillParcelable(parcelable,
590 parcelable.mUpMessageQueueParcelable);
591 }
592 return getAudioDataDescription(parcelable);
Phil Burk11e8d332017-05-24 09:59:02 -0700593}
Phil Burk39f02dd2017-08-04 09:13:31 -0700594
595void AAudioServiceStreamBase::onVolumeChanged(float volume) {
596 sendServiceEvent(AAUDIO_SERVICE_EVENT_VOLUME, volume);
597}
Phil Burk94862522017-09-13 21:31:36 -0700598
Phil Burk2fe718b2018-05-14 12:28:32 -0700599int32_t AAudioServiceStreamBase::incrementServiceReferenceCount_l() {
Phil Burk94862522017-09-13 21:31:36 -0700600 return ++mCallingCount;
601}
602
Phil Burk2fe718b2018-05-14 12:28:32 -0700603int32_t AAudioServiceStreamBase::decrementServiceReferenceCount_l() {
604 int32_t count = --mCallingCount;
605 // Each call to increment should be balanced with one call to decrement.
606 assert(count >= 0);
607 return count;
Phil Burk94862522017-09-13 21:31:36 -0700608}