blob: 78f9787f04c702479e435260d6749e60e5d727bd [file] [log] [blame]
/*
* Copyright (C) 2017 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
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef AAUDIO_AAUDIO_SERVICE_STREAM_SHARED_H
#define AAUDIO_AAUDIO_SERVICE_STREAM_SHARED_H
#include "fifo/FifoBuffer.h"
#include "binding/AAudioServiceMessage.h"
#include "binding/AAudioStreamRequest.h"
#include "binding/AAudioStreamConfiguration.h"
#include "AAudioService.h"
#include "AAudioServiceStreamBase.h"
namespace aaudio {
// We expect the queue to only have a few commands.
// This should be way more than we need.
#define QUEUE_UP_CAPACITY_COMMANDS (128)
class AAudioEndpointManager;
class AAudioServiceEndpoint;
class SharedRingBuffer;
/**
* One of these is created for every MODE_SHARED stream in the AAudioService.
*
* Each Shared stream will register itself with an AAudioServiceEndpoint when it is opened.
*/
class AAudioServiceStreamShared : public AAudioServiceStreamBase {
public:
explicit AAudioServiceStreamShared(android::AAudioService &aAudioService);
virtual ~AAudioServiceStreamShared() = default;
static std::string dumpHeader();
std::string dump() const override;
aaudio_result_t open(const aaudio::AAudioStreamRequest &request) override;
void writeDataIfRoom(int64_t mmapFramesRead, const void *buffer, int32_t numFrames);
/**
* This must only be called under getAudioDataQueueLock().
* @return
*/
std::shared_ptr<SharedRingBuffer> getAudioDataQueue_l()
REQUIRES(audioDataQueueLock) {
return mAudioDataQueue;
}
/* Keep a record of when a buffer transfer completed.
* This allows for a more accurate timing model.
*/
void markTransferTime(Timestamp &timestamp);
void setTimestampPositionOffset(int64_t deltaFrames) {
mTimestampPositionOffset.store(deltaFrames);
}
void incrementXRunCount() {
sendXRunCount(++mXRunCount);
}
int32_t getXRunCount() const {
return mXRunCount.load();
}
const char *getTypeText() const override { return "Shared"; }
// This is public so that the thread safety annotation, GUARDED_BY(),
// Can work when another object takes the lock.
mutable std::mutex audioDataQueueLock;
protected:
aaudio_result_t getAudioDataDescription_l(
AudioEndpointParcelable* parcelable) REQUIRES(mLock) override;
aaudio_result_t getFreeRunningPosition_l(
int64_t *positionFrames, int64_t *timeNanos) REQUIRES(mLock) override;
aaudio_result_t getHardwareTimestamp_l(
int64_t *positionFrames, int64_t *timeNanos) REQUIRES(mLock) override;
/**
* @param requestedCapacityFrames
* @param framesPerBurst
* @return capacity or negative error
*/
static int32_t calculateBufferCapacity(int32_t requestedCapacityFrames,
int32_t framesPerBurst);
private:
std::shared_ptr<SharedRingBuffer> mAudioDataQueue GUARDED_BY(audioDataQueueLock);
std::atomic<int64_t> mTimestampPositionOffset;
std::atomic<int32_t> mXRunCount;
};
} /* namespace aaudio */
#endif //AAUDIO_AAUDIO_SERVICE_STREAM_SHARED_H