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 
26 namespace aaudio {
27 
28 #define ENDPOINT_DATA_QUEUE_SIZE_MIN   48
29 
30 /**
31  * A sink for audio.
32  * Used by the client code.
33  */
34 class AudioEndpoint {
35 
36 public:
37     AudioEndpoint();
38 
39     /**
40      * Configure based on the EndPointDescriptor_t.
41      */
42     aaudio_result_t configure(const EndpointDescriptor *pEndpointDescriptor,
43                               aaudio_direction_t direction);
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     int32_t getEmptyFramesAvailable(android::WrappingBuffer *wrappingBuffer);
52 
53     int32_t getEmptyFramesAvailable();
54 
55     int32_t getFullFramesAvailable(android::WrappingBuffer *wrappingBuffer);
56 
57     int32_t getFullFramesAvailable();
58 
59     void advanceReadIndex(int32_t deltaFrames);
60 
61     void advanceWriteIndex(int32_t deltaFrames);
62 
63     /**
64      * Set the read index in the downData queue.
65      * This is needed if the reader is not updating the index itself.
66      */
67     void setDataReadCounter(android::fifo_counter_t framesRead);
68 
69     android::fifo_counter_t getDataReadCounter() const;
70 
71     void setDataWriteCounter(android::fifo_counter_t framesWritten);
72 
73     android::fifo_counter_t getDataWriteCounter() const;
74 
75     /**
76      * The result is not valid until after configure() is called.
77      *
78      * @return true if the output buffer read position is not updated, eg. DMA
79      */
isFreeRunning()80     bool isFreeRunning() const { return mFreeRunning; }
81 
82     int32_t setBufferSizeInFrames(int32_t requestedFrames,
83                                   int32_t *actualFrames);
84     int32_t getBufferSizeInFrames() const;
85 
86     int32_t getBufferCapacityInFrames() const;
87 
88     /**
89      * Write zeros to the data queue memory.
90      */
91     void eraseDataMemory();
92 
93     void dump() const;
94 
95 private:
96     std::unique_ptr<android::FifoBuffer> mUpCommandQueue;
97     std::unique_ptr<android::FifoBuffer> mDataQueue;
98     bool                    mFreeRunning;
99     android::fifo_counter_t mDataReadCounter; // only used if free-running
100     android::fifo_counter_t mDataWriteCounter; // only used if free-running
101 };
102 
103 } // namespace aaudio
104 
105 #endif //ANDROID_AAUDIO_AUDIO_ENDPOINT_H
106