1 /*
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 
17 #define LOG_TAG "AAudioServiceStreamBase"
18 //#define LOG_NDEBUG 0
19 #include <utils/Log.h>
20 
21 #include <iomanip>
22 #include <iostream>
23 #include <mutex>
24 
25 #include <media/MediaMetricsItem.h>
26 #include <media/TypeConverter.h>
27 #include <mediautils/SchedulingPolicyService.h>
28 
29 #include "binding/IAAudioService.h"
30 #include "binding/AAudioServiceMessage.h"
31 #include "core/AudioGlobal.h"
32 #include "utility/AudioClock.h"
33 
34 #include "AAudioEndpointManager.h"
35 #include "AAudioService.h"
36 #include "AAudioServiceEndpoint.h"
37 #include "AAudioServiceStreamBase.h"
38 #include "TimestampScheduler.h"
39 
40 using namespace android;  // TODO just import names needed
41 using namespace aaudio;   // TODO just import names needed
42 
43 /**
44  * Base class for streams in the service.
45  * @return
46  */
47 
AAudioServiceStreamBase(AAudioService & audioService)48 AAudioServiceStreamBase::AAudioServiceStreamBase(AAudioService &audioService)
49         : mUpMessageQueue(nullptr)
50         , mTimestampThread("AATime")
51         , mAtomicStreamTimestamp()
52         , mAudioService(audioService) {
53     mMmapClient.clientUid = -1;
54     mMmapClient.clientPid = -1;
55     mMmapClient.packageName = String16("");
56 }
57 
~AAudioServiceStreamBase()58 AAudioServiceStreamBase::~AAudioServiceStreamBase() {
59     // 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 
67     // 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.
69     LOG_ALWAYS_FATAL_IF(!(getState() == AAUDIO_STREAM_STATE_CLOSED
70                         || getState() == AAUDIO_STREAM_STATE_UNINITIALIZED
71                         || getState() == AAUDIO_STREAM_STATE_DISCONNECTED),
72                         "service stream %p still open, state = %d",
73                         this, getState());
74 }
75 
dumpHeader()76 std::string AAudioServiceStreamBase::dumpHeader() {
77     return std::string("    T   Handle   UId   Port Run State Format Burst Chan Capacity");
78 }
79 
dump() const80 std::string AAudioServiceStreamBase::dump() const {
81     std::stringstream result;
82 
83     result << "    0x" << std::setfill('0') << std::setw(8) << std::hex << mHandle
84            << std::dec << std::setfill(' ') ;
85     result << std::setw(6) << mMmapClient.clientUid;
86     result << std::setw(7) << mClientHandle;
87     result << std::setw(4) << (isRunning() ? "yes" : " no");
88     result << std::setw(6) << getState();
89     result << std::setw(7) << getFormat();
90     result << std::setw(6) << mFramesPerBurst;
91     result << std::setw(5) << getSamplesPerFrame();
92     result << std::setw(9) << getBufferCapacity();
93 
94     return result.str();
95 }
96 
logOpen(aaudio_handle_t streamHandle)97 void 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())
109         .set(AMEDIAMETRICS_PROP_ALLOWUID, (int32_t)getOwnerUserId())
110         .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 
open(const aaudio::AAudioStreamRequest & request)127 aaudio_result_t AAudioServiceStreamBase::open(const aaudio::AAudioStreamRequest &request) {
128     AAudioEndpointManager &mEndpointManager = AAudioEndpointManager::getInstance();
129     aaudio_result_t result = AAUDIO_OK;
130 
131     mMmapClient.clientUid = request.getUserId();
132     mMmapClient.clientPid = request.getProcessId();
133     mMmapClient.packageName.setTo(String16("")); // TODO What should we do here?
134 
135     // Limit scope of lock to avoid recursive lock in close().
136     {
137         std::lock_guard<std::mutex> lock(mUpMessageQueueLock);
138         if (mUpMessageQueue != nullptr) {
139             ALOGE("%s() called twice", __func__);
140             return AAUDIO_ERROR_INVALID_STATE;
141         }
142 
143         mUpMessageQueue = new SharedRingBuffer();
144         result = mUpMessageQueue->allocate(sizeof(AAudioServiceMessage),
145                                            QUEUE_UP_CAPACITY_COMMANDS);
146         if (result != AAUDIO_OK) {
147             goto error;
148         }
149 
150         // 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.
153         mServiceEndpoint = mEndpointManager.openEndpoint(mAudioService,
154                                                          request);
155         if (mServiceEndpoint == nullptr) {
156             result = AAUDIO_ERROR_UNAVAILABLE;
157             goto error;
158         }
159         // Save a weak pointer that we will use to access the endpoint.
160         mServiceEndpointWeak = mServiceEndpoint;
161 
162         mFramesPerBurst = mServiceEndpoint->getFramesPerBurst();
163         copyFrom(*mServiceEndpoint);
164     }
165     return result;
166 
167 error:
168     close();
169     return result;
170 }
171 
close()172 aaudio_result_t AAudioServiceStreamBase::close() {
173     std::lock_guard<std::mutex> lock(mLock);
174     return close_l();
175 }
176 
close_l()177 aaudio_result_t AAudioServiceStreamBase::close_l() {
178     if (getState() == AAUDIO_STREAM_STATE_CLOSED) {
179         return AAUDIO_OK;
180     }
181 
182     stop_l();
183 
184     aaudio_result_t result = AAUDIO_OK;
185     sp<AAudioServiceEndpoint> endpoint = mServiceEndpointWeak.promote();
186     if (endpoint == nullptr) {
187         result = AAUDIO_ERROR_INVALID_STATE;
188     } else {
189         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.
194         mServiceEndpoint.clear(); // endpoint will hold the pointer after this method returns.
195     }
196 
197     {
198         std::lock_guard<std::mutex> lock(mUpMessageQueueLock);
199         stopTimestampThread();
200         delete mUpMessageQueue;
201         mUpMessageQueue = nullptr;
202     }
203 
204     setState(AAUDIO_STREAM_STATE_CLOSED);
205 
206     mediametrics::LogItem(mMetricsId)
207         .set(AMEDIAMETRICS_PROP_EVENT, AMEDIAMETRICS_PROP_EVENT_VALUE_CLOSE)
208         .record();
209     return result;
210 }
211 
startDevice()212 aaudio_result_t AAudioServiceStreamBase::startDevice() {
213     mClientHandle = AUDIO_PORT_HANDLE_NONE;
214     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);
220 }
221 
222 /**
223  * Start the flow of audio data.
224  *
225  * An AAUDIO_SERVICE_EVENT_STARTED will be sent to the client when complete.
226  */
start()227 aaudio_result_t AAudioServiceStreamBase::start() {
228     std::lock_guard<std::mutex> lock(mLock);
229 
230     const int64_t beginNs = AudioClock::getNanoseconds();
231     aaudio_result_t result = AAUDIO_OK;
232 
233     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 
240     mediametrics::Defer defer([&] {
241         mediametrics::LogItem(mMetricsId)
242             .set(AMEDIAMETRICS_PROP_EVENT, AMEDIAMETRICS_PROP_EVENT_VALUE_START)
243             .set(AMEDIAMETRICS_PROP_EXECUTIONTIMENS, (int64_t)(AudioClock::getNanoseconds() - beginNs))
244             .set(AMEDIAMETRICS_PROP_STATE, AudioGlobal_convertStreamStateToText(getState()))
245             .set(AMEDIAMETRICS_PROP_STATUS, (int32_t)result)
246             .record(); });
247 
248     if (isRunning()) {
249         return result;
250     }
251 
252     setFlowing(false);
253     setSuspended(false);
254 
255     // Start with fresh presentation timestamps.
256     mAtomicStreamTimestamp.clear();
257 
258     mClientHandle = AUDIO_PORT_HANDLE_NONE;
259     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 
271 error:
272     disconnect_l();
273     return result;
274 }
275 
pause()276 aaudio_result_t AAudioServiceStreamBase::pause() {
277     std::lock_guard<std::mutex> lock(mLock);
278     return pause_l();
279 }
280 
pause_l()281 aaudio_result_t AAudioServiceStreamBase::pause_l() {
282     aaudio_result_t result = AAUDIO_OK;
283     if (!isRunning()) {
284         return result;
285     }
286     const int64_t beginNs = AudioClock::getNanoseconds();
287 
288     mediametrics::Defer defer([&] {
289         mediametrics::LogItem(mMetricsId)
290             .set(AMEDIAMETRICS_PROP_EVENT, AMEDIAMETRICS_PROP_EVENT_VALUE_PAUSE)
291             .set(AMEDIAMETRICS_PROP_EXECUTIONTIMENS, (int64_t)(AudioClock::getNanoseconds() - beginNs))
292             .set(AMEDIAMETRICS_PROP_STATE, AudioGlobal_convertStreamStateToText(getState()))
293             .set(AMEDIAMETRICS_PROP_STATUS, (int32_t)result)
294             .record(); });
295 
296     // 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) {
302         disconnect_l();
303         return result;
304     }
305 
306     sp<AAudioServiceEndpoint> endpoint = mServiceEndpointWeak.promote();
307     if (endpoint == nullptr) {
308         ALOGE("%s() has no endpoint", __func__);
309         result =  AAUDIO_ERROR_INVALID_STATE; // for MediaMetric tracking
310         return result;
311     }
312     result = endpoint->stopStream(this, mClientHandle);
313     if (result != AAUDIO_OK) {
314         ALOGE("%s() mServiceEndpoint returned %d, %s", __func__, result, getTypeText());
315         disconnect_l(); // TODO should we return or pause Base first?
316     }
317 
318     sendServiceEvent(AAUDIO_SERVICE_EVENT_PAUSED);
319     setState(AAUDIO_STREAM_STATE_PAUSED);
320     return result;
321 }
322 
stop()323 aaudio_result_t AAudioServiceStreamBase::stop() {
324     std::lock_guard<std::mutex> lock(mLock);
325     return stop_l();
326 }
327 
stop_l()328 aaudio_result_t AAudioServiceStreamBase::stop_l() {
329     aaudio_result_t result = AAUDIO_OK;
330     if (!isRunning()) {
331         return result;
332     }
333     const int64_t beginNs = AudioClock::getNanoseconds();
334 
335     mediametrics::Defer defer([&] {
336         mediametrics::LogItem(mMetricsId)
337             .set(AMEDIAMETRICS_PROP_EVENT, AMEDIAMETRICS_PROP_EVENT_VALUE_STOP)
338             .set(AMEDIAMETRICS_PROP_EXECUTIONTIMENS, (int64_t)(AudioClock::getNanoseconds() - beginNs))
339             .set(AMEDIAMETRICS_PROP_STATE, AudioGlobal_convertStreamStateToText(getState()))
340             .set(AMEDIAMETRICS_PROP_STATUS, (int32_t)result)
341             .record(); });
342 
343     setState(AAUDIO_STREAM_STATE_STOPPING);
344 
345     // 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.
347     sendCurrentTimestamp(); // warning - this calls a virtual function
348     result = stopTimestampThread();
349     if (result != AAUDIO_OK) {
350         disconnect_l();
351         return result;
352     }
353 
354     sp<AAudioServiceEndpoint> endpoint = mServiceEndpointWeak.promote();
355     if (endpoint == nullptr) {
356         ALOGE("%s() has no endpoint", __func__);
357         result =  AAUDIO_ERROR_INVALID_STATE; // for MediaMetric tracking
358         return result;
359     }
360     // TODO wait for data to be played out
361     result = endpoint->stopStream(this, mClientHandle);
362     if (result != AAUDIO_OK) {
363         ALOGE("%s() stopStream returned %d, %s", __func__, result, getTypeText());
364         disconnect_l();
365         // TODO what to do with result here?
366     }
367 
368     sendServiceEvent(AAUDIO_SERVICE_EVENT_STOPPED);
369     setState(AAUDIO_STREAM_STATE_STOPPED);
370     return result;
371 }
372 
stopTimestampThread()373 aaudio_result_t AAudioServiceStreamBase::stopTimestampThread() {
374     aaudio_result_t result = AAUDIO_OK;
375     // clear flag that tells thread to loop
376     if (mThreadEnabled.exchange(false)) {
377         result = mTimestampThread.stop();
378     }
379     return result;
380 }
381 
flush()382 aaudio_result_t AAudioServiceStreamBase::flush() {
383     std::lock_guard<std::mutex> lock(mLock);
384     aaudio_result_t result = AAudio_isFlushAllowed(getState());
385     if (result != AAUDIO_OK) {
386         return result;
387     }
388     const int64_t beginNs = AudioClock::getNanoseconds();
389 
390     mediametrics::Defer defer([&] {
391         mediametrics::LogItem(mMetricsId)
392             .set(AMEDIAMETRICS_PROP_EVENT, AMEDIAMETRICS_PROP_EVENT_VALUE_FLUSH)
393             .set(AMEDIAMETRICS_PROP_EXECUTIONTIMENS, (int64_t)(AudioClock::getNanoseconds() - beginNs))
394             .set(AMEDIAMETRICS_PROP_STATE, AudioGlobal_convertStreamStateToText(getState()))
395             .set(AMEDIAMETRICS_PROP_STATUS, (int32_t)result)
396             .record(); });
397 
398     // Data will get flushed when the client receives the FLUSHED event.
399     sendServiceEvent(AAUDIO_SERVICE_EVENT_FLUSHED);
400     setState(AAUDIO_STREAM_STATE_FLUSHED);
401     return AAUDIO_OK;
402 }
403 
404 // implement Runnable, periodically send timestamps to client
405 __attribute__((no_sanitize("integer")))
run()406 void AAudioServiceStreamBase::run() {
407     ALOGD("%s() %s entering >>>>>>>>>>>>>> TIMESTAMPS", __func__, getTypeText());
408     TimestampScheduler timestampScheduler;
409     timestampScheduler.setBurstPeriod(mFramesPerBurst, getSampleRate());
410     timestampScheduler.start(AudioClock::getNanoseconds());
411     int64_t nextTime = timestampScheduler.nextAbsoluteTime();
412     int32_t loopCount = 0;
413     while(mThreadEnabled.load()) {
414         loopCount++;
415         if (AudioClock::getNanoseconds() >= nextTime) {
416             aaudio_result_t result = sendCurrentTimestamp();
417             if (result != AAUDIO_OK) {
418                 ALOGE("%s() timestamp thread got result = %d", __func__, result);
419                 break;
420             }
421             nextTime = timestampScheduler.nextAbsoluteTime();
422         } else  {
423             // Sleep until it is time to send the next timestamp.
424             // TODO Wait for a signal with a timeout so that we can stop more quickly.
425             AudioClock::sleepUntilNanoTime(nextTime);
426         }
427     }
428     ALOGD("%s() %s exiting after %d loops <<<<<<<<<<<<<< TIMESTAMPS",
429           __func__, getTypeText(), loopCount);
430 }
431 
disconnect()432 void AAudioServiceStreamBase::disconnect() {
433     std::lock_guard<std::mutex> lock(mLock);
434     disconnect_l();
435 }
436 
disconnect_l()437 void AAudioServiceStreamBase::disconnect_l() {
438     if (getState() != AAUDIO_STREAM_STATE_DISCONNECTED
439         && getState() != AAUDIO_STREAM_STATE_CLOSED) {
440 
441         mediametrics::LogItem(mMetricsId)
442             .set(AMEDIAMETRICS_PROP_EVENT, AMEDIAMETRICS_PROP_EVENT_VALUE_DISCONNECT)
443             .set(AMEDIAMETRICS_PROP_STATE, AudioGlobal_convertStreamStateToText(getState()))
444             .record();
445 
446         sendServiceEvent(AAUDIO_SERVICE_EVENT_DISCONNECTED);
447         setState(AAUDIO_STREAM_STATE_DISCONNECTED);
448     }
449 }
450 
registerAudioThread(pid_t clientThreadId,int priority)451 aaudio_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 
unregisterAudioThread(pid_t clientThreadId)472 aaudio_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 
setState(aaudio_stream_state_t state)484 void 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 
sendServiceEvent(aaudio_service_event_t event,double dataDouble)493 aaudio_result_t AAudioServiceStreamBase::sendServiceEvent(aaudio_service_event_t event,
494                                                           double  dataDouble) {
495     AAudioServiceMessage command;
496     command.what = AAudioServiceMessage::code::EVENT;
497     command.event.event = event;
498     command.event.dataDouble = dataDouble;
499     return writeUpMessageQueue(&command);
500 }
501 
sendServiceEvent(aaudio_service_event_t event,int64_t dataLong)502 aaudio_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;
507     command.event.dataLong = dataLong;
508     return writeUpMessageQueue(&command);
509 }
510 
isUpMessageQueueBusy()511 bool 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 
writeUpMessageQueue(AAudioServiceMessage * command)525 aaudio_result_t AAudioServiceStreamBase::writeUpMessageQueue(AAudioServiceMessage *command) {
526     std::lock_guard<std::mutex> lock(mUpMessageQueueLock);
527     if (mUpMessageQueue == nullptr) {
528         ALOGE("%s(): mUpMessageQueue null! - stream not open", __func__);
529         return AAUDIO_ERROR_NULL;
530     }
531     int32_t count = mUpMessageQueue->getFifoBuffer()->write(command, 1);
532     if (count != 1) {
533         ALOGW("%s(): Queue full. Did client stop? Suspending stream. what = %u, %s",
534               __func__, command->what, getTypeText());
535         setSuspended(true);
536         return AAUDIO_ERROR_WOULD_BLOCK;
537     } else {
538         return AAUDIO_OK;
539     }
540 }
541 
sendXRunCount(int32_t xRunCount)542 aaudio_result_t AAudioServiceStreamBase::sendXRunCount(int32_t xRunCount) {
543     return sendServiceEvent(AAUDIO_SERVICE_EVENT_XRUN, (int64_t) xRunCount);
544 }
545 
sendCurrentTimestamp()546 aaudio_result_t AAudioServiceStreamBase::sendCurrentTimestamp() {
547     AAudioServiceMessage command;
548     // 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 
555     // Send a timestamp for the clock model.
556     aaudio_result_t result = getFreeRunningPosition(&command.timestamp.position,
557                                                     &command.timestamp.timestamp);
558     if (result == AAUDIO_OK) {
559         ALOGV("%s() SERVICE  %8lld at %lld", __func__,
560               (long long) command.timestamp.position,
561               (long long) command.timestamp.timestamp);
562         command.what = AAudioServiceMessage::code::TIMESTAMP_SERVICE;
563         result = writeUpMessageQueue(&command);
564 
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) {
570                 ALOGV("%s() HARDWARE %8lld at %lld", __func__,
571                       (long long) command.timestamp.position,
572                       (long long) command.timestamp.timestamp);
573                 command.what = AAudioServiceMessage::code::TIMESTAMP_HARDWARE;
574                 result = writeUpMessageQueue(&command);
575             }
576         }
577     }
578 
579     if (result == AAUDIO_ERROR_UNAVAILABLE) { // TODO review best error code
580         result = AAUDIO_OK; // just not available yet, try again later
581     }
582     return result;
583 }
584 
585 /**
586  * Get an immutable description of the in-memory queues
587  * used to communicate with the underlying HAL or Service.
588  */
getDescription(AudioEndpointParcelable & parcelable)589 aaudio_result_t AAudioServiceStreamBase::getDescription(AudioEndpointParcelable &parcelable) {
590     std::lock_guard<std::mutex> lock(mLock);
591     {
592         std::lock_guard<std::mutex> lock(mUpMessageQueueLock);
593         if (mUpMessageQueue == nullptr) {
594             ALOGE("%s(): mUpMessageQueue null! - stream not open", __func__);
595             return AAUDIO_ERROR_NULL;
596         }
597         // Gather information on the message queue.
598         mUpMessageQueue->fillParcelable(parcelable,
599                                         parcelable.mUpMessageQueueParcelable);
600     }
601     return getAudioDataDescription(parcelable);
602 }
603 
onVolumeChanged(float volume)604 void AAudioServiceStreamBase::onVolumeChanged(float volume) {
605     sendServiceEvent(AAUDIO_SERVICE_EVENT_VOLUME, volume);
606 }
607 
incrementServiceReferenceCount_l()608 int32_t AAudioServiceStreamBase::incrementServiceReferenceCount_l() {
609     return ++mCallingCount;
610 }
611 
decrementServiceReferenceCount_l()612 int32_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;
617 }
618