1 /*
2 * Copyright (C) 2017 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
17
18 #define LOG_TAG "AAudioServiceEndpointShared"
19 //#define LOG_NDEBUG 0
20 #include <utils/Log.h>
21
22 #include <iomanip>
23 #include <iostream>
24 #include <sstream>
25
26 #include "binding/AAudioServiceMessage.h"
27 #include "client/AudioStreamInternal.h"
28 #include "client/AudioStreamInternalPlay.h"
29 #include "core/AudioStreamBuilder.h"
30
31 #include "AAudioServiceEndpointShared.h"
32 #include "AAudioServiceStreamShared.h"
33 #include "AAudioServiceStreamMMAP.h"
34 #include "AAudioMixer.h"
35 #include "AAudioService.h"
36
37 using namespace android;
38 using namespace aaudio;
39
40 // This is the maximum size in frames. The effective size can be tuned smaller at runtime.
41 #define DEFAULT_BUFFER_CAPACITY (48 * 8)
42
AAudioServiceEndpointShared(AudioStreamInternal * streamInternal)43 AAudioServiceEndpointShared::AAudioServiceEndpointShared(AudioStreamInternal *streamInternal)
44 : mStreamInternal(streamInternal) {}
45
dump() const46 std::string AAudioServiceEndpointShared::dump() const {
47 std::stringstream result;
48
49 result << " SHARED: sharing exclusive stream with handle = 0x"
50 << std::setfill('0') << std::setw(8)
51 << std::hex << mStreamInternal->getServiceHandle()
52 << std::dec << std::setfill(' ');
53 result << ", XRuns = " << mStreamInternal->getXRunCount();
54 result << "\n";
55 result << " Running Stream Count: " << mRunningStreamCount << "\n";
56
57 result << AAudioServiceEndpoint::dump();
58 return result.str();
59 }
60
61 // Share an AudioStreamInternal.
open(const aaudio::AAudioStreamRequest & request)62 aaudio_result_t AAudioServiceEndpointShared::open(const aaudio::AAudioStreamRequest &request) {
63 aaudio_result_t result = AAUDIO_OK;
64 const AAudioStreamConfiguration &configuration = request.getConstantConfiguration();
65
66 copyFrom(configuration);
67 mRequestedDeviceId = configuration.getDeviceId();
68
69 AudioStreamBuilder builder;
70 builder.copyFrom(configuration);
71
72 builder.setSharingMode(AAUDIO_SHARING_MODE_EXCLUSIVE);
73 // Don't fall back to SHARED because that would cause recursion.
74 builder.setSharingModeMatchRequired(true);
75
76 builder.setBufferCapacity(DEFAULT_BUFFER_CAPACITY);
77
78 result = mStreamInternal->open(builder);
79
80 setSampleRate(mStreamInternal->getSampleRate());
81 setSamplesPerFrame(mStreamInternal->getSamplesPerFrame());
82 setDeviceId(mStreamInternal->getDeviceId());
83 setSessionId(mStreamInternal->getSessionId());
84 setFormat(AUDIO_FORMAT_PCM_FLOAT); // force for mixer
85 mFramesPerBurst = mStreamInternal->getFramesPerBurst();
86
87 return result;
88 }
89
close()90 void AAudioServiceEndpointShared::close() {
91 stopSharingThread();
92 getStreamInternal()->safeReleaseClose();
93 }
94
95 // Glue between C and C++ callbacks.
aaudio_endpoint_thread_proc(void * arg)96 static void *aaudio_endpoint_thread_proc(void *arg) {
97 assert(arg != nullptr);
98 ALOGD("%s() called", __func__);
99
100 // Prevent the stream from being deleted while being used.
101 // This is just for extra safety. It is probably not needed because
102 // this callback should be joined before the stream is closed.
103 AAudioServiceEndpointShared *endpointPtr =
104 static_cast<AAudioServiceEndpointShared *>(arg);
105 android::sp<AAudioServiceEndpointShared> endpoint(endpointPtr);
106 // Balance the incStrong() in startSharingThread_l().
107 endpoint->decStrong(nullptr);
108
109 void *result = endpoint->callbackLoop();
110 // Close now so that the HW resource is freed and we can open a new device.
111 if (!endpoint->isConnected()) {
112 ALOGD("%s() call safeReleaseCloseFromCallback()", __func__);
113 // Release and close under a lock with no check for callback collisions.
114 endpoint->getStreamInternal()->safeReleaseCloseInternal();
115 }
116
117 return result;
118 }
119
startSharingThread_l()120 aaudio_result_t aaudio::AAudioServiceEndpointShared::startSharingThread_l() {
121 // Launch the callback loop thread.
122 int64_t periodNanos = getStreamInternal()->getFramesPerBurst()
123 * AAUDIO_NANOS_PER_SECOND
124 / getSampleRate();
125 mCallbackEnabled.store(true);
126 // Prevent this object from getting deleted before the thread has a chance to create
127 // its strong pointer. Assume the thread will call decStrong().
128 this->incStrong(nullptr);
129 aaudio_result_t result = getStreamInternal()->createThread(periodNanos,
130 aaudio_endpoint_thread_proc,
131 this);
132 if (result != AAUDIO_OK) {
133 this->decStrong(nullptr); // Because the thread won't do it.
134 }
135 return result;
136 }
137
stopSharingThread()138 aaudio_result_t aaudio::AAudioServiceEndpointShared::stopSharingThread() {
139 mCallbackEnabled.store(false);
140 return getStreamInternal()->joinThread(NULL);
141 }
142
startStream(sp<AAudioServiceStreamBase> sharedStream,audio_port_handle_t * clientHandle)143 aaudio_result_t AAudioServiceEndpointShared::startStream(
144 sp<AAudioServiceStreamBase> sharedStream,
145 audio_port_handle_t *clientHandle)
146 NO_THREAD_SAFETY_ANALYSIS {
147 aaudio_result_t result = AAUDIO_OK;
148
149 {
150 std::lock_guard<std::mutex> lock(mLockStreams);
151 if (++mRunningStreamCount == 1) { // atomic
152 result = getStreamInternal()->systemStart();
153 if (result != AAUDIO_OK) {
154 --mRunningStreamCount;
155 } else {
156 result = startSharingThread_l();
157 if (result != AAUDIO_OK) {
158 getStreamInternal()->systemStopFromApp();
159 --mRunningStreamCount;
160 }
161 }
162 }
163 }
164
165 if (result == AAUDIO_OK) {
166 const audio_attributes_t attr = getAudioAttributesFrom(sharedStream.get());
167 result = getStreamInternal()->startClient(
168 sharedStream->getAudioClient(), &attr, clientHandle);
169 if (result != AAUDIO_OK) {
170 if (--mRunningStreamCount == 0) { // atomic
171 stopSharingThread();
172 getStreamInternal()->systemStopFromApp();
173 }
174 }
175 }
176
177 return result;
178 }
179
stopStream(sp<AAudioServiceStreamBase> sharedStream,audio_port_handle_t clientHandle)180 aaudio_result_t AAudioServiceEndpointShared::stopStream(sp<AAudioServiceStreamBase> sharedStream,
181 audio_port_handle_t clientHandle) {
182 // Ignore result.
183 (void) getStreamInternal()->stopClient(clientHandle);
184
185 if (--mRunningStreamCount == 0) { // atomic
186 stopSharingThread(); // the sharing thread locks mLockStreams
187 getStreamInternal()->systemStopFromApp();
188 }
189 return AAUDIO_OK;
190 }
191
192 // Get timestamp that was written by the real-time service thread, eg. mixer.
getFreeRunningPosition(int64_t * positionFrames,int64_t * timeNanos)193 aaudio_result_t AAudioServiceEndpointShared::getFreeRunningPosition(int64_t *positionFrames,
194 int64_t *timeNanos) {
195 if (mAtomicEndpointTimestamp.isValid()) {
196 Timestamp timestamp = mAtomicEndpointTimestamp.read();
197 *positionFrames = timestamp.getPosition();
198 *timeNanos = timestamp.getNanoseconds();
199 return AAUDIO_OK;
200 } else {
201 return AAUDIO_ERROR_UNAVAILABLE;
202 }
203 }
204
getTimestamp(int64_t * positionFrames,int64_t * timeNanos)205 aaudio_result_t AAudioServiceEndpointShared::getTimestamp(int64_t *positionFrames,
206 int64_t *timeNanos) {
207 aaudio_result_t result = mStreamInternal->getTimestamp(CLOCK_MONOTONIC, positionFrames, timeNanos);
208 if (result == AAUDIO_ERROR_INVALID_STATE) {
209 // getTimestamp() can return AAUDIO_ERROR_INVALID_STATE if the stream has
210 // not completely started. This can cause a race condition that kills the
211 // timestamp service thread. So we reduce the error to a less serious one
212 // that allows the timestamp thread to continue.
213 result = AAUDIO_ERROR_UNAVAILABLE;
214 }
215 return result;
216 }
217