AudioEndpoint.h revision 4485d41bcded0eceec7ec97d50aa2b0e702397a0 
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 getEmptyRoomAvailable(android::WrappingBuffer *wrappingBuffer);
58
59    int32_t getEmptyFramesAvailable();
60    int32_t getFullFramesAvailable();
61
62    void advanceWriteIndex(int32_t deltaFrames);
63
64    /**
65     * Set the read index in the downData queue.
66     * This is needed if the reader is not updating the index itself.
67     */
68    void setDownDataReadCounter(android::fifo_counter_t framesRead);
69    android::fifo_counter_t getDownDataReadCounter();
70
71    void setDownDataWriteCounter(android::fifo_counter_t framesWritten);
72    android::fifo_counter_t getDownDataWriteCounter();
73
74    /**
75     * The result is not valid until after configure() is called.
76     *
77     * @return true if the output buffer read position is not updated, eg. DMA
78     */
79    bool isOutputFreeRunning() const { return mOutputFreeRunning; }
80
81    int32_t setBufferSizeInFrames(int32_t requestedFrames,
82                                  int32_t *actualFrames);
83    int32_t getBufferSizeInFrames() const;
84
85    int32_t getBufferCapacityInFrames() const;
86
87private:
88    android::FifoBuffer    *mUpCommandQueue;
89    android::FifoBuffer    *mDownDataQueue;
90    bool                    mOutputFreeRunning;
91    android::fifo_counter_t mDataReadCounter; // only used if free-running
92    android::fifo_counter_t mDataWriteCounter; // only used if free-running
93};
94
95} // namespace aaudio
96
97#endif //ANDROID_AAUDIO_AUDIO_ENDPOINT_H
98