blob: 663dae29cc10cd5da563971d7cd2106e1e01d339 [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/IAAudioService.h"
30#include "binding/AAudioServiceMessage.h"
Phil Burka9876702020-04-20 18:16:15 -070031#include "core/AudioGlobal.h"
Phil Burkc0c70e32017-02-09 13:18:38 -080032#include "utility/AudioClock.h"
33
Phil Burk39f02dd2017-08-04 09:13:31 -070034#include "AAudioEndpointManager.h"
35#include "AAudioService.h"
36#include "AAudioServiceEndpoint.h"
Phil Burkc0c70e32017-02-09 13:18:38 -080037#include "AAudioServiceStreamBase.h"
38#include "TimestampScheduler.h"
39
40using namespace android; // TODO just import names needed
41using namespace aaudio; // TODO just import names needed
Phil Burk2355edb2016-12-26 13:54:02 -080042
43/**
Phil Burkc0c70e32017-02-09 13:18:38 -080044 * Base class for streams in the service.
45 * @return
Phil Burk2355edb2016-12-26 13:54:02 -080046 */
47
Phil Burk39f02dd2017-08-04 09:13:31 -070048AAudioServiceStreamBase::AAudioServiceStreamBase(AAudioService &audioService)
Phil Burk2355edb2016-12-26 13:54:02 -080049 : mUpMessageQueue(nullptr)
Phil Burk55978892018-01-11 14:56:09 -080050 , mTimestampThread("AATime")
Phil Burka53ffa62018-10-10 16:21:37 -070051 , mAtomicStreamTimestamp()
Phil Burk39f02dd2017-08-04 09:13:31 -070052 , mAudioService(audioService) {
Eric Laurentcb4dae22017-07-01 19:39:32 -070053 mMmapClient.clientUid = -1;
54 mMmapClient.clientPid = -1;
55 mMmapClient.packageName = String16("");
Phil Burk2355edb2016-12-26 13:54:02 -080056}
57
Phil Burk5ed503c2017-02-01 09:38:15 -080058AAudioServiceStreamBase::~AAudioServiceStreamBase() {
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 Burkc0c70e32017-02-09 13:18:38 -0800143 mUpMessageQueue = new 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 Burk7ebbc112020-05-13 15:55:17 -0700182 stop_l();
Phil Burk39f02dd2017-08-04 09:13:31 -0700183
Phil Burk8b4e05e2019-12-17 12:12:09 -0800184 aaudio_result_t result = AAUDIO_OK;
Phil Burk6e2770e2018-05-01 13:03:52 -0700185 sp<AAudioServiceEndpoint> endpoint = mServiceEndpointWeak.promote();
186 if (endpoint == nullptr) {
Phil Burk39f02dd2017-08-04 09:13:31 -0700187 result = AAUDIO_ERROR_INVALID_STATE;
188 } else {
Phil Burk6e2770e2018-05-01 13:03:52 -0700189 endpoint->unregisterStream(this);
190 AAudioEndpointManager &endpointManager = AAudioEndpointManager::getInstance();
191 endpointManager.closeEndpoint(endpoint);
192
193 // AAudioService::closeStream() prevents two threads from closing at the same time.
Phil Burk7ebbc112020-05-13 15:55:17 -0700194 mServiceEndpoint.clear(); // endpoint will hold the pointer after this method returns.
Phil Burk39f02dd2017-08-04 09:13:31 -0700195 }
196
197 {
198 std::lock_guard<std::mutex> lock(mUpMessageQueueLock);
Phil Burk98d6d922017-07-06 11:52:45 -0700199 stopTimestampThread();
Phil Burk98d6d922017-07-06 11:52:45 -0700200 delete mUpMessageQueue;
201 mUpMessageQueue = nullptr;
Phil Burk98d6d922017-07-06 11:52:45 -0700202 }
Phil Burk39f02dd2017-08-04 09:13:31 -0700203
Phil Burkbcc36742017-08-31 17:24:51 -0700204 setState(AAUDIO_STREAM_STATE_CLOSED);
Phil Burka9876702020-04-20 18:16:15 -0700205
206 mediametrics::LogItem(mMetricsId)
207 .set(AMEDIAMETRICS_PROP_EVENT, AMEDIAMETRICS_PROP_EVENT_VALUE_CLOSE)
208 .record();
Phil Burk39f02dd2017-08-04 09:13:31 -0700209 return result;
Phil Burkc0c70e32017-02-09 13:18:38 -0800210}
211
Phil Burkbcc36742017-08-31 17:24:51 -0700212aaudio_result_t AAudioServiceStreamBase::startDevice() {
213 mClientHandle = AUDIO_PORT_HANDLE_NONE;
Phil Burk6e2770e2018-05-01 13:03:52 -0700214 sp<AAudioServiceEndpoint> endpoint = mServiceEndpointWeak.promote();
215 if (endpoint == nullptr) {
216 ALOGE("%s() has no endpoint", __func__);
217 return AAUDIO_ERROR_INVALID_STATE;
218 }
219 return endpoint->startStream(this, &mClientHandle);
Phil Burkbcc36742017-08-31 17:24:51 -0700220}
221
Phil Burk39f02dd2017-08-04 09:13:31 -0700222/**
223 * Start the flow of audio data.
224 *
225 * An AAUDIO_SERVICE_EVENT_STARTED will be sent to the client when complete.
226 */
Phil Burkc0c70e32017-02-09 13:18:38 -0800227aaudio_result_t AAudioServiceStreamBase::start() {
Phil Burk7ebbc112020-05-13 15:55:17 -0700228 std::lock_guard<std::mutex> lock(mLock);
229
Phil Burka9876702020-04-20 18:16:15 -0700230 const int64_t beginNs = AudioClock::getNanoseconds();
Phil Burkbcc36742017-08-31 17:24:51 -0700231 aaudio_result_t result = AAUDIO_OK;
Phil Burk6e2770e2018-05-01 13:03:52 -0700232
Phil Burk7ebbc112020-05-13 15:55:17 -0700233 if (auto state = getState();
234 state == AAUDIO_STREAM_STATE_CLOSED || state == AAUDIO_STREAM_STATE_DISCONNECTED) {
235 ALOGW("%s() already CLOSED, returns INVALID_STATE, handle = %d",
236 __func__, getHandle());
237 return AAUDIO_ERROR_INVALID_STATE;
238 }
239
Phil Burka9876702020-04-20 18:16:15 -0700240 mediametrics::Defer defer([&] {
241 mediametrics::LogItem(mMetricsId)
242 .set(AMEDIAMETRICS_PROP_EVENT, AMEDIAMETRICS_PROP_EVENT_VALUE_START)
Andy Hungea840382020-05-05 21:50:17 -0700243 .set(AMEDIAMETRICS_PROP_EXECUTIONTIMENS, (int64_t)(AudioClock::getNanoseconds() - beginNs))
Phil Burka9876702020-04-20 18:16:15 -0700244 .set(AMEDIAMETRICS_PROP_STATE, AudioGlobal_convertStreamStateToText(getState()))
245 .set(AMEDIAMETRICS_PROP_STATUS, (int32_t)result)
246 .record(); });
247
Eric Laurentcb4dae22017-07-01 19:39:32 -0700248 if (isRunning()) {
Phil Burk7ebbc112020-05-13 15:55:17 -0700249 return result;
Eric Laurentcb4dae22017-07-01 19:39:32 -0700250 }
Phil Burk39f02dd2017-08-04 09:13:31 -0700251
Phil Burk23296382017-11-20 15:45:11 -0800252 setFlowing(false);
Phil Burk762365c2018-12-10 16:02:16 -0800253 setSuspended(false);
Phil Burk23296382017-11-20 15:45:11 -0800254
Phil Burkbcc36742017-08-31 17:24:51 -0700255 // Start with fresh presentation timestamps.
Phil Burka53ffa62018-10-10 16:21:37 -0700256 mAtomicStreamTimestamp.clear();
Phil Burkbcc36742017-08-31 17:24:51 -0700257
Phil Burk39f02dd2017-08-04 09:13:31 -0700258 mClientHandle = AUDIO_PORT_HANDLE_NONE;
Phil Burkbcc36742017-08-31 17:24:51 -0700259 result = startDevice();
260 if (result != AAUDIO_OK) goto error;
261
262 // This should happen at the end of the start.
263 sendServiceEvent(AAUDIO_SERVICE_EVENT_STARTED);
264 setState(AAUDIO_STREAM_STATE_STARTED);
265 mThreadEnabled.store(true);
266 result = mTimestampThread.start(this);
267 if (result != AAUDIO_OK) goto error;
268
269 return result;
270
271error:
Phil Burk7ebbc112020-05-13 15:55:17 -0700272 disconnect_l();
Phil Burk39f02dd2017-08-04 09:13:31 -0700273 return result;
Phil Burkc0c70e32017-02-09 13:18:38 -0800274}
275
276aaudio_result_t AAudioServiceStreamBase::pause() {
Phil Burk7ebbc112020-05-13 15:55:17 -0700277 std::lock_guard<std::mutex> lock(mLock);
278 return pause_l();
279}
280
281aaudio_result_t AAudioServiceStreamBase::pause_l() {
Phil Burk11e8d332017-05-24 09:59:02 -0700282 aaudio_result_t result = AAUDIO_OK;
Eric Laurentcb4dae22017-07-01 19:39:32 -0700283 if (!isRunning()) {
284 return result;
Phil Burkc0c70e32017-02-09 13:18:38 -0800285 }
Phil Burk7ebbc112020-05-13 15:55:17 -0700286 const int64_t beginNs = AudioClock::getNanoseconds();
Phil Burk73af62a2017-10-26 12:11:47 -0700287
Phil Burka9876702020-04-20 18:16:15 -0700288 mediametrics::Defer defer([&] {
289 mediametrics::LogItem(mMetricsId)
290 .set(AMEDIAMETRICS_PROP_EVENT, AMEDIAMETRICS_PROP_EVENT_VALUE_PAUSE)
Andy Hungea840382020-05-05 21:50:17 -0700291 .set(AMEDIAMETRICS_PROP_EXECUTIONTIMENS, (int64_t)(AudioClock::getNanoseconds() - beginNs))
Phil Burka9876702020-04-20 18:16:15 -0700292 .set(AMEDIAMETRICS_PROP_STATE, AudioGlobal_convertStreamStateToText(getState()))
293 .set(AMEDIAMETRICS_PROP_STATUS, (int32_t)result)
294 .record(); });
295
Phil Burk73af62a2017-10-26 12:11:47 -0700296 // Send it now because the timestamp gets rounded up when stopStream() is called below.
297 // Also we don't need the timestamps while we are shutting down.
298 sendCurrentTimestamp();
299
300 result = stopTimestampThread();
301 if (result != AAUDIO_OK) {
Phil Burk7ebbc112020-05-13 15:55:17 -0700302 disconnect_l();
Phil Burk73af62a2017-10-26 12:11:47 -0700303 return result;
304 }
305
Phil Burk6e2770e2018-05-01 13:03:52 -0700306 sp<AAudioServiceEndpoint> endpoint = mServiceEndpointWeak.promote();
307 if (endpoint == nullptr) {
308 ALOGE("%s() has no endpoint", __func__);
Phil Burka9876702020-04-20 18:16:15 -0700309 result = AAUDIO_ERROR_INVALID_STATE; // for MediaMetric tracking
310 return result;
Phil Burk6e2770e2018-05-01 13:03:52 -0700311 }
312 result = endpoint->stopStream(this, mClientHandle);
Phil Burk39f02dd2017-08-04 09:13:31 -0700313 if (result != AAUDIO_OK) {
Phil Burk19e990e2018-03-22 13:59:34 -0700314 ALOGE("%s() mServiceEndpoint returned %d, %s", __func__, result, getTypeText());
Phil Burk7ebbc112020-05-13 15:55:17 -0700315 disconnect_l(); // TODO should we return or pause Base first?
Phil Burk39f02dd2017-08-04 09:13:31 -0700316 }
317
Eric Laurentcb4dae22017-07-01 19:39:32 -0700318 sendServiceEvent(AAUDIO_SERVICE_EVENT_PAUSED);
Phil Burkbcc36742017-08-31 17:24:51 -0700319 setState(AAUDIO_STREAM_STATE_PAUSED);
Phil Burkc0c70e32017-02-09 13:18:38 -0800320 return result;
321}
322
Phil Burk71f35bb2017-04-13 16:05:07 -0700323aaudio_result_t AAudioServiceStreamBase::stop() {
Phil Burk7ebbc112020-05-13 15:55:17 -0700324 std::lock_guard<std::mutex> lock(mLock);
325 return stop_l();
326}
327
328aaudio_result_t AAudioServiceStreamBase::stop_l() {
Phil Burk11e8d332017-05-24 09:59:02 -0700329 aaudio_result_t result = AAUDIO_OK;
Eric Laurentcb4dae22017-07-01 19:39:32 -0700330 if (!isRunning()) {
331 return result;
Phil Burk71f35bb2017-04-13 16:05:07 -0700332 }
Phil Burk7ebbc112020-05-13 15:55:17 -0700333 const int64_t beginNs = AudioClock::getNanoseconds();
Phil Burk39f02dd2017-08-04 09:13:31 -0700334
Phil Burka9876702020-04-20 18:16:15 -0700335 mediametrics::Defer defer([&] {
336 mediametrics::LogItem(mMetricsId)
337 .set(AMEDIAMETRICS_PROP_EVENT, AMEDIAMETRICS_PROP_EVENT_VALUE_STOP)
Andy Hungea840382020-05-05 21:50:17 -0700338 .set(AMEDIAMETRICS_PROP_EXECUTIONTIMENS, (int64_t)(AudioClock::getNanoseconds() - beginNs))
Phil Burka9876702020-04-20 18:16:15 -0700339 .set(AMEDIAMETRICS_PROP_STATE, AudioGlobal_convertStreamStateToText(getState()))
340 .set(AMEDIAMETRICS_PROP_STATUS, (int32_t)result)
341 .record(); });
342
Phil Burk83fb8442017-10-05 16:55:17 -0700343 setState(AAUDIO_STREAM_STATE_STOPPING);
344
Phil Burk73af62a2017-10-26 12:11:47 -0700345 // Send it now because the timestamp gets rounded up when stopStream() is called below.
346 // Also we don't need the timestamps while we are shutting down.
Eric Laurentcb4dae22017-07-01 19:39:32 -0700347 sendCurrentTimestamp(); // warning - this calls a virtual function
348 result = stopTimestampThread();
349 if (result != AAUDIO_OK) {
Phil Burk7ebbc112020-05-13 15:55:17 -0700350 disconnect_l();
Eric Laurentcb4dae22017-07-01 19:39:32 -0700351 return result;
352 }
Phil Burk39f02dd2017-08-04 09:13:31 -0700353
Phil Burk6e2770e2018-05-01 13:03:52 -0700354 sp<AAudioServiceEndpoint> endpoint = mServiceEndpointWeak.promote();
355 if (endpoint == nullptr) {
356 ALOGE("%s() has no endpoint", __func__);
Phil Burka9876702020-04-20 18:16:15 -0700357 result = AAUDIO_ERROR_INVALID_STATE; // for MediaMetric tracking
358 return result;
Phil Burk6e2770e2018-05-01 13:03:52 -0700359 }
Phil Burk39f02dd2017-08-04 09:13:31 -0700360 // TODO wait for data to be played out
Phil Burk6e2770e2018-05-01 13:03:52 -0700361 result = endpoint->stopStream(this, mClientHandle);
Phil Burk39f02dd2017-08-04 09:13:31 -0700362 if (result != AAUDIO_OK) {
Phil Burk6e2770e2018-05-01 13:03:52 -0700363 ALOGE("%s() stopStream returned %d, %s", __func__, result, getTypeText());
Phil Burk7ebbc112020-05-13 15:55:17 -0700364 disconnect_l();
Phil Burk39f02dd2017-08-04 09:13:31 -0700365 // TODO what to do with result here?
366 }
367
Eric Laurentcb4dae22017-07-01 19:39:32 -0700368 sendServiceEvent(AAUDIO_SERVICE_EVENT_STOPPED);
Phil Burkbcc36742017-08-31 17:24:51 -0700369 setState(AAUDIO_STREAM_STATE_STOPPED);
Phil Burk71f35bb2017-04-13 16:05:07 -0700370 return result;
371}
372
Phil Burk98d6d922017-07-06 11:52:45 -0700373aaudio_result_t AAudioServiceStreamBase::stopTimestampThread() {
374 aaudio_result_t result = AAUDIO_OK;
375 // clear flag that tells thread to loop
376 if (mThreadEnabled.exchange(false)) {
Phil Burkbcc36742017-08-31 17:24:51 -0700377 result = mTimestampThread.stop();
Phil Burk98d6d922017-07-06 11:52:45 -0700378 }
379 return result;
380}
381
Phil Burk71f35bb2017-04-13 16:05:07 -0700382aaudio_result_t AAudioServiceStreamBase::flush() {
Phil Burk7ebbc112020-05-13 15:55:17 -0700383 std::lock_guard<std::mutex> lock(mLock);
Phil Burk5cc83c32017-11-28 15:43:18 -0800384 aaudio_result_t result = AAudio_isFlushAllowed(getState());
385 if (result != AAUDIO_OK) {
386 return result;
Phil Burk39f02dd2017-08-04 09:13:31 -0700387 }
Phil Burk7ebbc112020-05-13 15:55:17 -0700388 const int64_t beginNs = AudioClock::getNanoseconds();
Phil Burk5cc83c32017-11-28 15:43:18 -0800389
Phil Burka9876702020-04-20 18:16:15 -0700390 mediametrics::Defer defer([&] {
391 mediametrics::LogItem(mMetricsId)
392 .set(AMEDIAMETRICS_PROP_EVENT, AMEDIAMETRICS_PROP_EVENT_VALUE_FLUSH)
Andy Hungea840382020-05-05 21:50:17 -0700393 .set(AMEDIAMETRICS_PROP_EXECUTIONTIMENS, (int64_t)(AudioClock::getNanoseconds() - beginNs))
Phil Burka9876702020-04-20 18:16:15 -0700394 .set(AMEDIAMETRICS_PROP_STATE, AudioGlobal_convertStreamStateToText(getState()))
395 .set(AMEDIAMETRICS_PROP_STATUS, (int32_t)result)
396 .record(); });
397
Phil Burk39f02dd2017-08-04 09:13:31 -0700398 // Data will get flushed when the client receives the FLUSHED event.
Phil Burk71f35bb2017-04-13 16:05:07 -0700399 sendServiceEvent(AAUDIO_SERVICE_EVENT_FLUSHED);
Phil Burkbcc36742017-08-31 17:24:51 -0700400 setState(AAUDIO_STREAM_STATE_FLUSHED);
Phil Burk71f35bb2017-04-13 16:05:07 -0700401 return AAUDIO_OK;
402}
403
Phil Burkcf5f6d22017-05-26 12:35:07 -0700404// implement Runnable, periodically send timestamps to client
Phil Burka53ffa62018-10-10 16:21:37 -0700405__attribute__((no_sanitize("integer")))
Phil Burkc0c70e32017-02-09 13:18:38 -0800406void AAudioServiceStreamBase::run() {
Phil Burk19e990e2018-03-22 13:59:34 -0700407 ALOGD("%s() %s entering >>>>>>>>>>>>>> TIMESTAMPS", __func__, getTypeText());
Phil Burkc0c70e32017-02-09 13:18:38 -0800408 TimestampScheduler timestampScheduler;
Phil Burk39f02dd2017-08-04 09:13:31 -0700409 timestampScheduler.setBurstPeriod(mFramesPerBurst, getSampleRate());
Phil Burkc0c70e32017-02-09 13:18:38 -0800410 timestampScheduler.start(AudioClock::getNanoseconds());
411 int64_t nextTime = timestampScheduler.nextAbsoluteTime();
Phil Burka53ffa62018-10-10 16:21:37 -0700412 int32_t loopCount = 0;
Phil Burkc0c70e32017-02-09 13:18:38 -0800413 while(mThreadEnabled.load()) {
Phil Burka53ffa62018-10-10 16:21:37 -0700414 loopCount++;
Phil Burkc0c70e32017-02-09 13:18:38 -0800415 if (AudioClock::getNanoseconds() >= nextTime) {
416 aaudio_result_t result = sendCurrentTimestamp();
417 if (result != AAUDIO_OK) {
Phil Burka53ffa62018-10-10 16:21:37 -0700418 ALOGE("%s() timestamp thread got result = %d", __func__, result);
Phil Burkc0c70e32017-02-09 13:18:38 -0800419 break;
420 }
421 nextTime = timestampScheduler.nextAbsoluteTime();
422 } else {
423 // Sleep until it is time to send the next timestamp.
Phil Burk98d6d922017-07-06 11:52:45 -0700424 // TODO Wait for a signal with a timeout so that we can stop more quickly.
Phil Burkc0c70e32017-02-09 13:18:38 -0800425 AudioClock::sleepUntilNanoTime(nextTime);
426 }
427 }
Phil Burka53ffa62018-10-10 16:21:37 -0700428 ALOGD("%s() %s exiting after %d loops <<<<<<<<<<<<<< TIMESTAMPS",
429 __func__, getTypeText(), loopCount);
Phil Burkc0c70e32017-02-09 13:18:38 -0800430}
431
Phil Burk5ef003b2017-06-30 11:43:37 -0700432void AAudioServiceStreamBase::disconnect() {
Phil Burk7ebbc112020-05-13 15:55:17 -0700433 std::lock_guard<std::mutex> lock(mLock);
434 disconnect_l();
435}
436
437void AAudioServiceStreamBase::disconnect_l() {
438 if (getState() != AAUDIO_STREAM_STATE_DISCONNECTED
439 && getState() != AAUDIO_STREAM_STATE_CLOSED) {
440
Phil Burka9876702020-04-20 18:16:15 -0700441 mediametrics::LogItem(mMetricsId)
442 .set(AMEDIAMETRICS_PROP_EVENT, AMEDIAMETRICS_PROP_EVENT_VALUE_DISCONNECT)
443 .set(AMEDIAMETRICS_PROP_STATE, AudioGlobal_convertStreamStateToText(getState()))
444 .record();
Phil Burk7ebbc112020-05-13 15:55:17 -0700445
Phil Burk5ef003b2017-06-30 11:43:37 -0700446 sendServiceEvent(AAUDIO_SERVICE_EVENT_DISCONNECTED);
Phil Burkbcc36742017-08-31 17:24:51 -0700447 setState(AAUDIO_STREAM_STATE_DISCONNECTED);
Phil Burk5ef003b2017-06-30 11:43:37 -0700448 }
Phil Burkc0c70e32017-02-09 13:18:38 -0800449}
450
Phil Burk7ebbc112020-05-13 15:55:17 -0700451aaudio_result_t AAudioServiceStreamBase::registerAudioThread(pid_t clientThreadId,
452 int priority) {
453 std::lock_guard<std::mutex> lock(mLock);
454 aaudio_result_t result = AAUDIO_OK;
455 if (getRegisteredThread() != AAudioServiceStreamBase::ILLEGAL_THREAD_ID) {
456 ALOGE("AAudioService::registerAudioThread(), thread already registered");
457 result = AAUDIO_ERROR_INVALID_STATE;
458 } else {
459 const pid_t ownerPid = IPCThreadState::self()->getCallingPid(); // TODO review
460 setRegisteredThread(clientThreadId);
461 int err = android::requestPriority(ownerPid, clientThreadId,
462 priority, true /* isForApp */);
463 if (err != 0) {
464 ALOGE("AAudioService::registerAudioThread(%d) failed, errno = %d, priority = %d",
465 clientThreadId, errno, priority);
466 result = AAUDIO_ERROR_INTERNAL;
467 }
468 }
469 return result;
470}
471
472aaudio_result_t AAudioServiceStreamBase::unregisterAudioThread(pid_t clientThreadId) {
473 std::lock_guard<std::mutex> lock(mLock);
474 aaudio_result_t result = AAUDIO_OK;
475 if (getRegisteredThread() != clientThreadId) {
476 ALOGE("%s(), wrong thread", __func__);
477 result = AAUDIO_ERROR_ILLEGAL_ARGUMENT;
478 } else {
479 setRegisteredThread(0);
480 }
481 return result;
482}
483
484void AAudioServiceStreamBase::setState(aaudio_stream_state_t state) {
485 // CLOSED is a final state.
486 if (mState != AAUDIO_STREAM_STATE_CLOSED) {
487 mState = state;
488 } else {
489 ALOGW_IF(mState != state, "%s(%d) when already CLOSED", __func__, state);
490 }
491}
492
Phil Burkc0c70e32017-02-09 13:18:38 -0800493aaudio_result_t AAudioServiceStreamBase::sendServiceEvent(aaudio_service_event_t event,
Phil Burk23296382017-11-20 15:45:11 -0800494 double dataDouble) {
Phil Burk5ed503c2017-02-01 09:38:15 -0800495 AAudioServiceMessage command;
496 command.what = AAudioServiceMessage::code::EVENT;
Phil Burk2355edb2016-12-26 13:54:02 -0800497 command.event.event = event;
Phil Burkc0c70e32017-02-09 13:18:38 -0800498 command.event.dataDouble = dataDouble;
Phil Burk23296382017-11-20 15:45:11 -0800499 return writeUpMessageQueue(&command);
500}
501
502aaudio_result_t AAudioServiceStreamBase::sendServiceEvent(aaudio_service_event_t event,
503 int64_t dataLong) {
504 AAudioServiceMessage command;
505 command.what = AAudioServiceMessage::code::EVENT;
506 command.event.event = event;
Phil Burkc0c70e32017-02-09 13:18:38 -0800507 command.event.dataLong = dataLong;
508 return writeUpMessageQueue(&command);
509}
510
Phil Burkf878a8d2019-03-29 17:23:00 -0700511bool AAudioServiceStreamBase::isUpMessageQueueBusy() {
512 std::lock_guard<std::mutex> lock(mUpMessageQueueLock);
513 if (mUpMessageQueue == nullptr) {
514 ALOGE("%s(): mUpMessageQueue null! - stream not open", __func__);
515 return true;
516 }
517 int32_t framesAvailable = mUpMessageQueue->getFifoBuffer()
518 ->getFullFramesAvailable();
519 int32_t capacity = mUpMessageQueue->getFifoBuffer()
520 ->getBufferCapacityInFrames();
521 // Is it half full or more
522 return framesAvailable >= (capacity / 2);
523}
524
Phil Burkc0c70e32017-02-09 13:18:38 -0800525aaudio_result_t AAudioServiceStreamBase::writeUpMessageQueue(AAudioServiceMessage *command) {
Phil Burk39f02dd2017-08-04 09:13:31 -0700526 std::lock_guard<std::mutex> lock(mUpMessageQueueLock);
Phil Burk71f35bb2017-04-13 16:05:07 -0700527 if (mUpMessageQueue == nullptr) {
Phil Burk19e990e2018-03-22 13:59:34 -0700528 ALOGE("%s(): mUpMessageQueue null! - stream not open", __func__);
Phil Burk71f35bb2017-04-13 16:05:07 -0700529 return AAUDIO_ERROR_NULL;
530 }
Phil Burkc0c70e32017-02-09 13:18:38 -0800531 int32_t count = mUpMessageQueue->getFifoBuffer()->write(command, 1);
532 if (count != 1) {
Phil Burk762365c2018-12-10 16:02:16 -0800533 ALOGW("%s(): Queue full. Did client stop? Suspending stream. what = %u, %s",
534 __func__, command->what, getTypeText());
535 setSuspended(true);
Phil Burkc0c70e32017-02-09 13:18:38 -0800536 return AAUDIO_ERROR_WOULD_BLOCK;
537 } else {
538 return AAUDIO_OK;
539 }
540}
541
Phil Burk23296382017-11-20 15:45:11 -0800542aaudio_result_t AAudioServiceStreamBase::sendXRunCount(int32_t xRunCount) {
543 return sendServiceEvent(AAUDIO_SERVICE_EVENT_XRUN, (int64_t) xRunCount);
544}
545
Phil Burkc0c70e32017-02-09 13:18:38 -0800546aaudio_result_t AAudioServiceStreamBase::sendCurrentTimestamp() {
547 AAudioServiceMessage command;
Phil Burkf878a8d2019-03-29 17:23:00 -0700548 // It is not worth filling up the queue with timestamps.
549 // That can cause the stream to get suspended.
550 // So just drop the timestamp if the queue is getting full.
551 if (isUpMessageQueueBusy()) {
552 return AAUDIO_OK;
553 }
554
Phil Burk97350f92017-07-21 15:59:44 -0700555 // Send a timestamp for the clock model.
Phil Burkc0c70e32017-02-09 13:18:38 -0800556 aaudio_result_t result = getFreeRunningPosition(&command.timestamp.position,
557 &command.timestamp.timestamp);
558 if (result == AAUDIO_OK) {
Phil Burk19e990e2018-03-22 13:59:34 -0700559 ALOGV("%s() SERVICE %8lld at %lld", __func__,
Phil Burkbcc36742017-08-31 17:24:51 -0700560 (long long) command.timestamp.position,
561 (long long) command.timestamp.timestamp);
Phil Burk97350f92017-07-21 15:59:44 -0700562 command.what = AAudioServiceMessage::code::TIMESTAMP_SERVICE;
Phil Burkc0c70e32017-02-09 13:18:38 -0800563 result = writeUpMessageQueue(&command);
Phil Burk97350f92017-07-21 15:59:44 -0700564
565 if (result == AAUDIO_OK) {
566 // Send a hardware timestamp for presentation time.
567 result = getHardwareTimestamp(&command.timestamp.position,
568 &command.timestamp.timestamp);
569 if (result == AAUDIO_OK) {
Phil Burk19e990e2018-03-22 13:59:34 -0700570 ALOGV("%s() HARDWARE %8lld at %lld", __func__,
Phil Burkbcc36742017-08-31 17:24:51 -0700571 (long long) command.timestamp.position,
572 (long long) command.timestamp.timestamp);
Phil Burk97350f92017-07-21 15:59:44 -0700573 command.what = AAudioServiceMessage::code::TIMESTAMP_HARDWARE;
574 result = writeUpMessageQueue(&command);
575 }
576 }
577 }
578
Phil Burkbcc36742017-08-31 17:24:51 -0700579 if (result == AAUDIO_ERROR_UNAVAILABLE) { // TODO review best error code
Phil Burk940083c2017-07-17 17:00:02 -0700580 result = AAUDIO_OK; // just not available yet, try again later
Phil Burkc0c70e32017-02-09 13:18:38 -0800581 }
582 return result;
Phil Burk2355edb2016-12-26 13:54:02 -0800583}
584
Phil Burkc0c70e32017-02-09 13:18:38 -0800585/**
586 * Get an immutable description of the in-memory queues
587 * used to communicate with the underlying HAL or Service.
588 */
589aaudio_result_t AAudioServiceStreamBase::getDescription(AudioEndpointParcelable &parcelable) {
Phil Burk7ebbc112020-05-13 15:55:17 -0700590 std::lock_guard<std::mutex> lock(mLock);
Phil Burk523b3042017-09-13 13:03:08 -0700591 {
592 std::lock_guard<std::mutex> lock(mUpMessageQueueLock);
593 if (mUpMessageQueue == nullptr) {
Phil Burk19e990e2018-03-22 13:59:34 -0700594 ALOGE("%s(): mUpMessageQueue null! - stream not open", __func__);
Phil Burk523b3042017-09-13 13:03:08 -0700595 return AAUDIO_ERROR_NULL;
596 }
597 // Gather information on the message queue.
598 mUpMessageQueue->fillParcelable(parcelable,
599 parcelable.mUpMessageQueueParcelable);
600 }
601 return getAudioDataDescription(parcelable);
Phil Burk11e8d332017-05-24 09:59:02 -0700602}
Phil Burk39f02dd2017-08-04 09:13:31 -0700603
604void AAudioServiceStreamBase::onVolumeChanged(float volume) {
605 sendServiceEvent(AAUDIO_SERVICE_EVENT_VOLUME, volume);
606}
Phil Burk94862522017-09-13 21:31:36 -0700607
Phil Burk2fe718b2018-05-14 12:28:32 -0700608int32_t AAudioServiceStreamBase::incrementServiceReferenceCount_l() {
Phil Burk94862522017-09-13 21:31:36 -0700609 return ++mCallingCount;
610}
611
Phil Burk2fe718b2018-05-14 12:28:32 -0700612int32_t AAudioServiceStreamBase::decrementServiceReferenceCount_l() {
613 int32_t count = --mCallingCount;
614 // Each call to increment should be balanced with one call to decrement.
615 assert(count >= 0);
616 return count;
Phil Burk94862522017-09-13 21:31:36 -0700617}