AudioEndpoint.h revision 87c9f646a94259d7c321c3b3d5947fa1778f5ac2 
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#ifndef ANDROID_AAUDIO_AUDIO_ENDPOINT_H
18#define ANDROID_AAUDIO_AUDIO_ENDPOINT_H
19
20#include <aaudio/AAudio.h>
21
22#include "binding/AAudioServiceMessage.h"
23#include "binding/AudioEndpointParcelable.h"
24#include "fifo/FifoBuffer.h"
25
26namespace aaudio {
27
28#define ENDPOINT_DATA_QUEUE_SIZE_MIN   48
29
30/**
31 * A sink for audio.
32 * Used by the client code.
33 */
34class AudioEndpoint {
35
36public:
37    AudioEndpoint();
38    virtual ~AudioEndpoint();
39
40    /**
41     * Configure based on the EndPointDescriptor_t.
42     */
43    aaudio_result_t configure(const EndpointDescriptor *pEndpointDescriptor);
44
45    /**
46     * Read from a command passed up from the Server.
47     * @return 1 if command received, 0 for no command, or negative error.
48     */
49    aaudio_result_t readUpCommand(AAudioServiceMessage *commandPtr);
50
51    /**
52     * Non-blocking write.
53     * @return framesWritten or a negative error code.
54     */
55    aaudio_result_t writeDataNow(const void *buffer, int32_t numFrames);
56
57    void getEmptyFramesAvailable(android::WrappingBuffer *wrappingBuffer);
58
59    int32_t getEmptyFramesAvailable();
60
61    void getFullFramesAvailable(android::WrappingBuffer *wrappingBuffer);
62
63    int32_t getFullFramesAvailable();
64
65    void advanceReadIndex(int32_t deltaFrames);
66
67    void advanceWriteIndex(int32_t deltaFrames);
68
69    /**
70     * Set the read index in the downData queue.
71     * This is needed if the reader is not updating the index itself.
72     */
73    void setDataReadCounter(android::fifo_counter_t framesRead);
74
75    android::fifo_counter_t getDataReadCounter();
76
77    void setDataWriteCounter(android::fifo_counter_t framesWritten);
78
79    android::fifo_counter_t getDataWriteCounter();
80
81    /**
82     * The result is not valid until after configure() is called.
83     *
84     * @return true if the output buffer read position is not updated, eg. DMA
85     */
86    bool isFreeRunning() const { return mFreeRunning; }
87
88    int32_t setBufferSizeInFrames(int32_t requestedFrames,
89                                  int32_t *actualFrames);
90    int32_t getBufferSizeInFrames() const;
91
92    int32_t getBufferCapacityInFrames() const;
93
94private:
95    android::FifoBuffer    *mUpCommandQueue;
96    android::FifoBuffer    *mDataQueue;
97    bool                    mFreeRunning;
98    android::fifo_counter_t mDataReadCounter; // only used if free-running
99    android::fifo_counter_t mDataWriteCounter; // only used if free-running
100};
101
102} // namespace aaudio
103
104#endif //ANDROID_AAUDIO_AUDIO_ENDPOINT_H
105