xref: /aosp_15_r20/frameworks/av/services/oboeservice/AAudioServiceEndpoint.cpp (revision ec779b8e0859a360c3d303172224686826e6e0e1)
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 #define LOG_TAG "AAudioServiceEndpoint"
18 //#define LOG_NDEBUG 0
19 #include <utils/Log.h>
20 
21 #include <algorithm>
22 #include <assert.h>
23 #include <map>
24 #include <mutex>
25 #include <sstream>
26 #include <vector>
27 
28 #include <system/aaudio/AAudio.h>
29 #include <utils/Singleton.h>
30 
31 
32 #include "core/AudioStreamBuilder.h"
33 
34 #include "AAudioEndpointManager.h"
35 #include "AAudioClientTracker.h"
36 #include "AAudioServiceEndpoint.h"
37 #include "AAudioServiceStreamShared.h"
38 
39 using namespace android;  // TODO just import names needed
40 using namespace aaudio;   // TODO just import names needed
41 
~AAudioServiceEndpoint()42 AAudioServiceEndpoint::~AAudioServiceEndpoint() {
43     ALOGD("%s() called", __func__);
44 }
45 
dump() const46 std::string AAudioServiceEndpoint::dump() const NO_THREAD_SAFETY_ANALYSIS {
47     std::stringstream result;
48 
49     const bool isLocked = AAudio_tryUntilTrue(
50             [this]()->bool { return mLockStreams.try_lock(); } /* f */,
51             50 /* times */,
52             20 /* sleepMs */);
53     if (!isLocked) {
54         result << "AAudioServiceEndpoint may be deadlocked\n";
55     }
56 
57     result << "    Direction:            " << ((getDirection() == AAUDIO_DIRECTION_OUTPUT)
58                                    ? "OUTPUT" : "INPUT") << "\n";
59     result << "    Requested Device Id:  " << mRequestedDeviceId << "\n";
60     result << "    Device Ids:           " << android::toString(getDeviceIds()).c_str() << "\n";
61     result << "    Sample Rate:          " << getSampleRate() << "\n";
62     result << "    Channel Count:        " << getSamplesPerFrame() << "\n";
63     result << "    Channel Mask:         0x" << std::hex << getChannelMask() << std::dec << "\n";
64     result << "    Format:               " << getFormat()
65                                            << " (" << audio_format_to_string(getFormat()) << ")\n";
66     result << "    Frames Per Burst:     " << mFramesPerBurst << "\n";
67     result << "    Usage:                " << getUsage() << "\n";
68     result << "    ContentType:          " << getContentType() << "\n";
69     result << "    InputPreset:          " << getInputPreset() << "\n";
70     result << "    Reference Count:      " << mOpenCount << "\n";
71     result << "    Session Id:           " << getSessionId() << "\n";
72     result << "    Privacy Sensitive:    " << isPrivacySensitive() << "\n";
73     result << "    Hardware Channel Count:" << getHardwareSamplesPerFrame() << "\n";
74     result << "    Hardware Format:      " << getHardwareFormat() << " ("
75                                            << audio_format_to_string(getHardwareFormat()) << ")\n";
76     result << "    Hardware Sample Rate: " << getHardwareSampleRate() << "\n";
77     result << "    Connected:            " << mConnected.load() << "\n";
78     result << "    Registered Streams:" << "\n";
79     result << AAudioServiceStreamShared::dumpHeader() << "\n";
80     for (const auto& stream : mRegisteredStreams) {
81         result << stream->dump() << "\n";
82     }
83 
84     if (isLocked) {
85         mLockStreams.unlock();
86     }
87     return result.str();
88 }
89 
90 // @return true if stream found
isStreamRegistered(audio_port_handle_t portHandle)91 bool AAudioServiceEndpoint::isStreamRegistered(audio_port_handle_t portHandle) {
92     const std::lock_guard<std::mutex> lock(mLockStreams);
93     for (const auto& stream : mRegisteredStreams) {
94         if (stream->getPortHandle() == portHandle) {
95             return true;
96         }
97     }
98     return false;
99 }
100 
101 std::vector<android::sp<AAudioServiceStreamBase>>
disconnectRegisteredStreams()102         AAudioServiceEndpoint::disconnectRegisteredStreams() {
103     std::vector<android::sp<AAudioServiceStreamBase>> streamsDisconnected;
104     {
105         const std::lock_guard<std::mutex> lock(mLockStreams);
106         mRegisteredStreams.swap(streamsDisconnected);
107     }
108     mConnected.store(false);
109     // We need to stop all the streams before we disconnect them.
110     // Otherwise there is a race condition where the first disconnected app
111     // tries to reopen a stream as MMAP but is blocked by the second stream,
112     // which hasn't stopped yet. Then the first app ends up with a Legacy stream.
113     for (const auto &stream : streamsDisconnected) {
114         ALOGD("%s() - stop(), port = %d", __func__, stream->getPortHandle());
115         stream->stop();
116     }
117     for (const auto &stream : streamsDisconnected) {
118         ALOGD("%s() - disconnect(), port = %d", __func__, stream->getPortHandle());
119         stream->disconnect();
120     }
121     return streamsDisconnected;
122 }
123 
releaseRegisteredStreams()124 void AAudioServiceEndpoint::releaseRegisteredStreams() {
125     // List of streams to be closed after we disconnect everything.
126     const std::vector<android::sp<AAudioServiceStreamBase>> streamsToClose
127             = disconnectRegisteredStreams();
128 
129     // Close outside the lock to avoid recursive locks.
130     AAudioService *aaudioService = AAudioClientTracker::getInstance().getAAudioService();
131     for (const auto& serviceStream : streamsToClose) {
132         ALOGD("%s() - close stream 0x%08X", __func__, serviceStream->getHandle());
133         aaudioService->closeStream(serviceStream);
134     }
135 }
136 
registerStream(const sp<AAudioServiceStreamBase> & stream)137 aaudio_result_t AAudioServiceEndpoint::registerStream(const sp<AAudioServiceStreamBase>& stream) {
138     const std::lock_guard<std::mutex> lock(mLockStreams);
139     mRegisteredStreams.push_back(stream);
140     return AAUDIO_OK;
141 }
142 
unregisterStream(const sp<AAudioServiceStreamBase> & stream)143 aaudio_result_t AAudioServiceEndpoint::unregisterStream(const sp<AAudioServiceStreamBase>& stream) {
144     const std::lock_guard<std::mutex> lock(mLockStreams);
145     mRegisteredStreams.erase(std::remove(
146             mRegisteredStreams.begin(), mRegisteredStreams.end(), stream),
147                              mRegisteredStreams.end());
148     return AAUDIO_OK;
149 }
150 
matches(const AAudioStreamConfiguration & configuration)151 bool AAudioServiceEndpoint::matches(const AAudioStreamConfiguration& configuration) {
152     if (!mConnected.load()) {
153         return false; // Only use an endpoint if it is connected to a device.
154     }
155     if (configuration.getDirection() != getDirection()) {
156         return false;
157     }
158     if (!configuration.getDeviceIds().empty() &&
159         !android::areDeviceIdsEqual(configuration.getDeviceIds(), getDeviceIds())) {
160         return false;
161     }
162     if (configuration.getSessionId() != AAUDIO_SESSION_ID_ALLOCATE &&
163         configuration.getSessionId() != getSessionId()) {
164         return false;
165     }
166     if (configuration.getSampleRate() != AAUDIO_UNSPECIFIED &&
167         configuration.getSampleRate() != getSampleRate()) {
168         return false;
169     }
170     if (configuration.getSamplesPerFrame() != AAUDIO_UNSPECIFIED &&
171         configuration.getSamplesPerFrame() != getSamplesPerFrame()) {
172         return false;
173     }
174     if (configuration.getChannelMask() != AAUDIO_UNSPECIFIED &&
175         configuration.getChannelMask() != getChannelMask()) {
176         return false;
177     }
178     return true;
179 }
180 
181 // static
getAudioAttributesFrom(const AAudioStreamParameters * params)182 audio_attributes_t AAudioServiceEndpoint::getAudioAttributesFrom(
183         const AAudioStreamParameters *params) {
184     if (params == nullptr) {
185         return {};
186     }
187     const aaudio_direction_t direction = params->getDirection();
188 
189     const audio_content_type_t contentType =
190             AAudioConvert_contentTypeToInternal(params->getContentType());
191     // Usage only used for OUTPUT
192     const audio_usage_t usage = (direction == AAUDIO_DIRECTION_OUTPUT)
193             ? AAudioConvert_usageToInternal(params->getUsage())
194             : AUDIO_USAGE_UNKNOWN;
195     const audio_source_t source = (direction == AAUDIO_DIRECTION_INPUT)
196             ? AAudioConvert_inputPresetToAudioSource(params->getInputPreset())
197             : AUDIO_SOURCE_DEFAULT;
198     audio_flags_mask_t flags;
199     std::string tags;
200     if (direction == AAUDIO_DIRECTION_OUTPUT) {
201         flags = AAudio_computeAudioFlagsMask(
202                         params->getAllowedCapturePolicy(),
203                         params->getSpatializationBehavior(),
204                         params->isContentSpatialized(),
205                         AUDIO_OUTPUT_FLAG_FAST);
206         tags = params->getTagsAsString();
207     } else {
208         flags = static_cast<audio_flags_mask_t>(AUDIO_FLAG_LOW_LATENCY
209                 | AAudioConvert_privacySensitiveToAudioFlagsMask(params->isPrivacySensitive()));
210     }
211     audio_attributes_t nativeAttributes = {
212             .content_type = contentType,
213             .usage = usage,
214             .source = source,
215             .flags = flags,
216             .tags = ""
217     };
218     if (!tags.empty()) {
219         strncpy(nativeAttributes.tags, tags.c_str(), AUDIO_ATTRIBUTES_TAGS_MAX_SIZE);
220         nativeAttributes.tags[AUDIO_ATTRIBUTES_TAGS_MAX_SIZE - 1] = '\0';
221     }
222     return nativeAttributes;
223 }
224