blob: 976996d226e46baf920e448ce9d456519ad38dd4 [file] [log] [blame]
* Copyright (C) 2016 The Android Open Source Project
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* See the License for the specific language governing permissions and
* limitations under the License.
#include <assert.h>
#include <mutex>
#include <android-base/thread_annotations.h>
#include <media/AidlConversion.h>
#include <media/AudioClient.h>
#include <utils/RefBase.h>
#include "fifo/FifoBuffer.h"
#include "binding/AudioEndpointParcelable.h"
#include "binding/AAudioServiceMessage.h"
#include "binding/AAudioStreamRequest.h"
#include "core/AAudioStreamParameters.h"
#include "utility/AAudioUtilities.h"
#include "utility/AudioClock.h"
#include "SharedRingBuffer.h"
#include "AAudioThread.h"
namespace android {
class AAudioService;
namespace aaudio {
class AAudioServiceEndpoint;
// We expect the queue to only have a few commands.
// This should be way more than we need.
* Each instance of AAudioServiceStreamBase corresponds to a client stream.
* It uses a subclass of AAudioServiceEndpoint to communicate with the underlying device or port.
class AAudioServiceStreamBase
: public virtual android::RefBase
, public AAudioStreamParameters
, public Runnable {
explicit AAudioServiceStreamBase(android::AAudioService &aAudioService);
virtual ~AAudioServiceStreamBase();
enum {
static std::string dumpHeader();
// does not include EOL
virtual std::string dump() const;
* Open the device.
virtual aaudio_result_t open(const aaudio::AAudioStreamRequest &request) = 0;
// We log the CLOSE from the close() method. We needed this separate method to log the OPEN
// because we had to wait until we generated the handle.
void logOpen(aaudio_handle_t streamHandle);
aaudio_result_t close() EXCLUDES(mLock);
* Start the flow of audio data.
* This is not guaranteed to be synchronous but it currently is.
* An AAUDIO_SERVICE_EVENT_STARTED will be sent to the client when complete.
aaudio_result_t start() EXCLUDES(mLock);
* Stop the flow of data so that start() can resume without loss of data.
* This is not guaranteed to be synchronous but it currently is.
* An AAUDIO_SERVICE_EVENT_PAUSED will be sent to the client when complete.
aaudio_result_t pause() EXCLUDES(mLock);
* Stop the flow of data after the currently queued data has finished playing.
* This is not guaranteed to be synchronous but it currently is.
* An AAUDIO_SERVICE_EVENT_STOPPED will be sent to the client when complete.
aaudio_result_t stop() EXCLUDES(mLock);
* Discard any data held by the underlying HAL or Service.
* An AAUDIO_SERVICE_EVENT_FLUSHED will be sent to the client when complete.
aaudio_result_t flush() EXCLUDES(mLock);
virtual aaudio_result_t startClient(const android::AudioClient& client,
const audio_attributes_t *attr __unused,
audio_port_handle_t *clientHandle __unused) {
ALOGD("AAudioServiceStreamBase::startClient(%p, ...) AAUDIO_ERROR_UNAVAILABLE", &client);
virtual aaudio_result_t stopClient(audio_port_handle_t clientHandle __unused) {
ALOGD("AAudioServiceStreamBase::stopClient(%d) AAUDIO_ERROR_UNAVAILABLE", clientHandle);
aaudio_result_t registerAudioThread(pid_t clientThreadId, int priority) EXCLUDES(mLock);
aaudio_result_t unregisterAudioThread(pid_t clientThreadId) EXCLUDES(mLock);
bool isRunning() const {
* Fill in a parcelable description of stream.
aaudio_result_t getDescription(AudioEndpointParcelable &parcelable) EXCLUDES(mLock);
void setRegisteredThread(pid_t pid) {
mRegisteredClientThread = pid;
pid_t getRegisteredThread() const {
return mRegisteredClientThread;
int32_t getFramesPerBurst() const {
return mFramesPerBurst;
void run() override; // to implement Runnable
void disconnect() EXCLUDES(mLock);
const android::AudioClient &getAudioClient() {
return mMmapClient;
uid_t getOwnerUserId() const {
return VALUE_OR_FATAL(android::aidl2legacy_int32_t_uid_t(
pid_t getOwnerProcessId() const {
return VALUE_OR_FATAL(android::aidl2legacy_int32_t_pid_t(;
aaudio_handle_t getHandle() const {
return mHandle;
void setHandle(aaudio_handle_t handle) {
mHandle = handle;
audio_port_handle_t getPortHandle() const {
return mClientHandle;
aaudio_stream_state_t getState() const {
return mState;
void onVolumeChanged(float volume);
* Set false when the stream is started.
* Set true when data is first read from the stream.
* @param b
void setFlowing(bool b) {
mFlowing = b;
bool isFlowing() const {
return mFlowing;
* Set false when the stream should not longer be processed.
* This may be caused by a message queue overflow.
* Set true when stream is started.
* @param suspended
void setSuspended(bool suspended) {
mSuspended = suspended;
bool isSuspended() const {
return mSuspended;
bool isCloseNeeded() const {
return mCloseNeeded.load();
* Mark this stream as needing to be closed.
* Once marked for closing, it cannot be unmarked.
void markCloseNeeded() {;
virtual const char *getTypeText() const { return "Base"; }
* Open the device.
aaudio_result_t open(const aaudio::AAudioStreamRequest &request,
aaudio_sharing_mode_t sharingMode);
virtual aaudio_result_t close_l() REQUIRES(mLock);
virtual aaudio_result_t pause_l() REQUIRES(mLock);
virtual aaudio_result_t stop_l() REQUIRES(mLock);
void disconnect_l() REQUIRES(mLock);
void setState(aaudio_stream_state_t state);
* Device specific startup.
* @return AAUDIO_OK or negative error.
virtual aaudio_result_t startDevice();
aaudio_result_t writeUpMessageQueue(AAudioServiceMessage *command);
aaudio_result_t sendCurrentTimestamp() EXCLUDES(mLock);
aaudio_result_t sendXRunCount(int32_t xRunCount);
* @param positionFrames
* @param timeNanos
* @return AAUDIO_OK or AAUDIO_ERROR_UNAVAILABLE or other negative error
virtual aaudio_result_t getFreeRunningPosition(int64_t *positionFrames, int64_t *timeNanos) = 0;
virtual aaudio_result_t getHardwareTimestamp(int64_t *positionFrames, int64_t *timeNanos) = 0;
virtual aaudio_result_t getAudioDataDescription(AudioEndpointParcelable &parcelable) = 0;
aaudio_stream_state_t mState = AAUDIO_STREAM_STATE_UNINITIALIZED;
bool isDisconnected_l() const REQUIRES(mLock) {
return mDisconnected;
void setDisconnected_l(bool flag) REQUIRES(mLock) {
mDisconnected = flag;
pid_t mRegisteredClientThread = ILLEGAL_THREAD_ID;
std::mutex mUpMessageQueueLock;
std::shared_ptr<SharedRingBuffer> mUpMessageQueue;
AAudioThread mTimestampThread;
// This is used by one thread to tell another thread to exit. So it must be atomic.
std::atomic<bool> mThreadEnabled{false};
int32_t mFramesPerBurst = 0;
android::AudioClient mMmapClient; // set in open, used in MMAP start()
// TODO rename mClientHandle to mPortHandle to be more consistent with AudioFlinger.
audio_port_handle_t mClientHandle = AUDIO_PORT_HANDLE_NONE;
SimpleDoubleBuffer<Timestamp> mAtomicStreamTimestamp;
android::AAudioService &mAudioService;
// The mServiceEndpoint variable can be accessed by multiple threads.
// So we access it by locally promoting a weak pointer to a smart pointer,
// which is thread-safe.
android::sp<AAudioServiceEndpoint> mServiceEndpoint;
android::wp<AAudioServiceEndpoint> mServiceEndpointWeak;
std::string mMetricsId; // set once during open()
aaudio_result_t stopTimestampThread();
* Send a message to the client with an int64_t data value.
aaudio_result_t sendServiceEvent(aaudio_service_event_t event,
int64_t dataLong = 0);
* Send a message to the client with a double data value.
aaudio_result_t sendServiceEvent(aaudio_service_event_t event,
double dataDouble);
* @return true if the queue is getting full.
bool isUpMessageQueueBusy();
aaudio_handle_t mHandle = -1;
bool mFlowing = false;
// This indicates that a stream that is being referenced by a binder call
// and needs to closed.
std::atomic<bool> mCloseNeeded{false}; // TODO remove
// This indicate that a running stream should not be processed because of an error,
// for example a full message queue. Note that this atomic is unrelated to mCloseNeeded.
std::atomic<bool> mSuspended{false};
bool mDisconnected GUARDED_BY(mLock) {false};
// Locking order is important.
// Acquire mLock before acquiring AAudioServiceEndpoint::mLockStreams
std::mutex mLock; // Prevent start/stop/close etcetera from colliding
} /* namespace aaudio */