Phil Burk | 204a163 | 2017-01-03 17:23:43 -0800 | [diff] [blame] | 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 | |
Phil Burk | 5204d31 | 2017-05-04 17:16:13 -0700 | [diff] [blame] | 17 | #ifndef ANDROID_AAUDIO_AUDIO_ENDPOINT_H |
| 18 | #define ANDROID_AAUDIO_AUDIO_ENDPOINT_H |
Phil Burk | 204a163 | 2017-01-03 17:23:43 -0800 | [diff] [blame] | 19 | |
Phil Burk | 5ed503c | 2017-02-01 09:38:15 -0800 | [diff] [blame] | 20 | #include <aaudio/AAudio.h> |
Phil Burk | 204a163 | 2017-01-03 17:23:43 -0800 | [diff] [blame] | 21 | |
Phil Burk | c0c70e3 | 2017-02-09 13:18:38 -0800 | [diff] [blame] | 22 | #include "binding/AAudioServiceMessage.h" |
| 23 | #include "binding/AudioEndpointParcelable.h" |
Phil Burk | 204a163 | 2017-01-03 17:23:43 -0800 | [diff] [blame] | 24 | #include "fifo/FifoBuffer.h" |
| 25 | |
Phil Burk | 5ed503c | 2017-02-01 09:38:15 -0800 | [diff] [blame] | 26 | namespace aaudio { |
Phil Burk | 204a163 | 2017-01-03 17:23:43 -0800 | [diff] [blame] | 27 | |
Phil Burk | c0c70e3 | 2017-02-09 13:18:38 -0800 | [diff] [blame] | 28 | #define ENDPOINT_DATA_QUEUE_SIZE_MIN 48 |
Phil Burk | 204a163 | 2017-01-03 17:23:43 -0800 | [diff] [blame] | 29 | |
| 30 | /** |
| 31 | * A sink for audio. |
| 32 | * Used by the client code. |
| 33 | */ |
| 34 | class AudioEndpoint { |
| 35 | |
| 36 | public: |
| 37 | AudioEndpoint(); |
| 38 | virtual ~AudioEndpoint(); |
| 39 | |
| 40 | /** |
| 41 | * Configure based on the EndPointDescriptor_t. |
| 42 | */ |
Phil Burk | 5ed503c | 2017-02-01 09:38:15 -0800 | [diff] [blame] | 43 | aaudio_result_t configure(const EndpointDescriptor *pEndpointDescriptor); |
Phil Burk | 204a163 | 2017-01-03 17:23:43 -0800 | [diff] [blame] | 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 | */ |
Phil Burk | 5ed503c | 2017-02-01 09:38:15 -0800 | [diff] [blame] | 49 | aaudio_result_t readUpCommand(AAudioServiceMessage *commandPtr); |
Phil Burk | 204a163 | 2017-01-03 17:23:43 -0800 | [diff] [blame] | 50 | |
| 51 | /** |
| 52 | * Non-blocking write. |
| 53 | * @return framesWritten or a negative error code. |
| 54 | */ |
Phil Burk | 5ed503c | 2017-02-01 09:38:15 -0800 | [diff] [blame] | 55 | aaudio_result_t writeDataNow(const void *buffer, int32_t numFrames); |
Phil Burk | 204a163 | 2017-01-03 17:23:43 -0800 | [diff] [blame] | 56 | |
Phil Burk | 87c9f64 | 2017-05-17 07:22:39 -0700 | [diff] [blame^] | 57 | void getEmptyFramesAvailable(android::WrappingBuffer *wrappingBuffer); |
Phil Burk | c0c70e3 | 2017-02-09 13:18:38 -0800 | [diff] [blame] | 58 | |
Phil Burk | 4485d41 | 2017-05-09 15:55:02 -0700 | [diff] [blame] | 59 | int32_t getEmptyFramesAvailable(); |
Phil Burk | 87c9f64 | 2017-05-17 07:22:39 -0700 | [diff] [blame^] | 60 | |
| 61 | void getFullFramesAvailable(android::WrappingBuffer *wrappingBuffer); |
| 62 | |
Phil Burk | 4485d41 | 2017-05-09 15:55:02 -0700 | [diff] [blame] | 63 | int32_t getFullFramesAvailable(); |
| 64 | |
Phil Burk | 87c9f64 | 2017-05-17 07:22:39 -0700 | [diff] [blame^] | 65 | void advanceReadIndex(int32_t deltaFrames); |
| 66 | |
Phil Burk | c0c70e3 | 2017-02-09 13:18:38 -0800 | [diff] [blame] | 67 | void advanceWriteIndex(int32_t deltaFrames); |
| 68 | |
Phil Burk | 204a163 | 2017-01-03 17:23:43 -0800 | [diff] [blame] | 69 | /** |
| 70 | * Set the read index in the downData queue. |
| 71 | * This is needed if the reader is not updating the index itself. |
| 72 | */ |
Phil Burk | 87c9f64 | 2017-05-17 07:22:39 -0700 | [diff] [blame^] | 73 | void setDataReadCounter(android::fifo_counter_t framesRead); |
Phil Burk | 204a163 | 2017-01-03 17:23:43 -0800 | [diff] [blame] | 74 | |
Phil Burk | 87c9f64 | 2017-05-17 07:22:39 -0700 | [diff] [blame^] | 75 | android::fifo_counter_t getDataReadCounter(); |
| 76 | |
| 77 | void setDataWriteCounter(android::fifo_counter_t framesWritten); |
| 78 | |
| 79 | android::fifo_counter_t getDataWriteCounter(); |
Phil Burk | 204a163 | 2017-01-03 17:23:43 -0800 | [diff] [blame] | 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 | */ |
Phil Burk | 87c9f64 | 2017-05-17 07:22:39 -0700 | [diff] [blame^] | 86 | bool isFreeRunning() const { return mFreeRunning; } |
Phil Burk | 204a163 | 2017-01-03 17:23:43 -0800 | [diff] [blame] | 87 | |
Phil Burk | 3316d5e | 2017-02-15 11:23:01 -0800 | [diff] [blame] | 88 | int32_t setBufferSizeInFrames(int32_t requestedFrames, |
| 89 | int32_t *actualFrames); |
| 90 | int32_t getBufferSizeInFrames() const; |
Phil Burk | 204a163 | 2017-01-03 17:23:43 -0800 | [diff] [blame] | 91 | |
Phil Burk | 3316d5e | 2017-02-15 11:23:01 -0800 | [diff] [blame] | 92 | int32_t getBufferCapacityInFrames() const; |
Phil Burk | 204a163 | 2017-01-03 17:23:43 -0800 | [diff] [blame] | 93 | |
Phil Burk | 204a163 | 2017-01-03 17:23:43 -0800 | [diff] [blame] | 94 | private: |
Phil Burk | c0c70e3 | 2017-02-09 13:18:38 -0800 | [diff] [blame] | 95 | android::FifoBuffer *mUpCommandQueue; |
Phil Burk | 87c9f64 | 2017-05-17 07:22:39 -0700 | [diff] [blame^] | 96 | android::FifoBuffer *mDataQueue; |
| 97 | bool mFreeRunning; |
Phil Burk | c0c70e3 | 2017-02-09 13:18:38 -0800 | [diff] [blame] | 98 | android::fifo_counter_t mDataReadCounter; // only used if free-running |
| 99 | android::fifo_counter_t mDataWriteCounter; // only used if free-running |
Phil Burk | 204a163 | 2017-01-03 17:23:43 -0800 | [diff] [blame] | 100 | }; |
| 101 | |
Phil Burk | 5ed503c | 2017-02-01 09:38:15 -0800 | [diff] [blame] | 102 | } // namespace aaudio |
Phil Burk | 204a163 | 2017-01-03 17:23:43 -0800 | [diff] [blame] | 103 | |
Phil Burk | 5204d31 | 2017-05-04 17:16:13 -0700 | [diff] [blame] | 104 | #endif //ANDROID_AAUDIO_AUDIO_ENDPOINT_H |