• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright 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 OBOE_AAUDIO_LOADER_H_
18 #define OBOE_AAUDIO_LOADER_H_
19 
20 #include <unistd.h>
21 #include "oboe/Definitions.h"
22 
23 // If the NDK is before O then define this in your build
24 // so that AAudio.h will not be included.
25 #ifdef OBOE_NO_INCLUDE_AAUDIO
26 
27 // Define missing types from AAudio.h
28 typedef int32_t aaudio_stream_state_t;
29 typedef int32_t aaudio_direction_t;
30 typedef int32_t aaudio_format_t;
31 typedef int32_t aaudio_data_callback_result_t;
32 typedef int32_t aaudio_result_t;
33 typedef int32_t aaudio_sharing_mode_t;
34 typedef int32_t aaudio_performance_mode_t;
35 
36 typedef struct AAudioStreamStruct         AAudioStream;
37 typedef struct AAudioStreamBuilderStruct  AAudioStreamBuilder;
38 
39 typedef aaudio_data_callback_result_t (*AAudioStream_dataCallback)(
40         AAudioStream *stream,
41         void *userData,
42         void *audioData,
43         int32_t numFrames);
44 
45 typedef void (*AAudioStream_errorCallback)(
46         AAudioStream *stream,
47         void *userData,
48         aaudio_result_t error);
49 
50 // These were defined in P
51 typedef int32_t aaudio_usage_t;
52 typedef int32_t aaudio_content_type_t;
53 typedef int32_t aaudio_input_preset_t;
54 typedef int32_t aaudio_session_id_t;
55 
56 // There are a few definitions used by Oboe.
57 #define AAUDIO_OK                      static_cast<aaudio_result_t>(Result::OK)
58 #define AAUDIO_ERROR_TIMEOUT           static_cast<aaudio_result_t>(Result::ErrorTimeout)
59 #define AAUDIO_STREAM_STATE_STARTING   static_cast<aaudio_stream_state_t>(StreamState::Starting)
60 #define AAUDIO_STREAM_STATE_STARTED    static_cast<aaudio_stream_state_t>(StreamState::Started)
61 #else
62 #include <aaudio/AAudio.h>
63 #endif
64 
65 #ifndef __NDK_MAJOR__
66 #define __NDK_MAJOR__ 0
67 #endif
68 
69 #if __NDK_MAJOR__ < 24
70 // Defined in SC_V2
71 typedef uint32_t aaudio_channel_mask_t;
72 #endif
73 
74 #ifndef __ANDROID_API_S__
75 #define __ANDROID_API_S__ 31
76 #endif
77 
78 #ifndef __ANDROID_API_S_V2__
79 #define __ANDROID_API_S_V2__ 32
80 #endif
81 
82 namespace oboe {
83 
84 /**
85  * The AAudio API was not available in early versions of Android.
86  * To avoid linker errors, we dynamically link with the functions by name using dlsym().
87  * On older versions this linkage will safely fail.
88  */
89 class AAudioLoader {
90   public:
91     // Use signatures for common functions.
92     // Key to letter abbreviations.
93     // S = Stream
94     // B = Builder
95     // I = int32_t
96     // L = int64_t
97     // T = sTate
98     // K = clocKid_t
99     // P = Pointer to following data type
100     // C = Const prefix
101     // H = cHar
102     // U = uint32_t
103     typedef int32_t  (*signature_I_PPB)(AAudioStreamBuilder **builder);
104 
105     typedef const char * (*signature_CPH_I)(int32_t);
106 
107     typedef int32_t (*signature_I_PBPPS)(AAudioStreamBuilder *,
108                                       AAudioStream **stream);  // AAudioStreamBuilder_open()
109 
110     typedef int32_t (*signature_I_PB)(AAudioStreamBuilder *);  // AAudioStreamBuilder_delete()
111     // AAudioStreamBuilder_setSampleRate()
112     typedef void    (*signature_V_PBI)(AAudioStreamBuilder *, int32_t);
113 
114     // AAudioStreamBuilder_setChannelMask()
115     typedef void    (*signature_V_PBU)(AAudioStreamBuilder *, uint32_t);
116 
117     typedef void    (*signature_V_PBCPH)(AAudioStreamBuilder *, const char *);
118 
119     typedef int32_t (*signature_I_PS)(AAudioStream *);  // AAudioStream_getSampleRate()
120     typedef int64_t (*signature_L_PS)(AAudioStream *);  // AAudioStream_getFramesRead()
121     // AAudioStream_setBufferSizeInFrames()
122     typedef int32_t (*signature_I_PSI)(AAudioStream *, int32_t);
123 
124     typedef void    (*signature_V_PBPDPV)(AAudioStreamBuilder *,
125                                           AAudioStream_dataCallback,
126                                           void *);
127 
128     typedef void    (*signature_V_PBPEPV)(AAudioStreamBuilder *,
129                                           AAudioStream_errorCallback,
130                                           void *);
131 
132     typedef aaudio_format_t (*signature_F_PS)(AAudioStream *stream);
133 
134     typedef int32_t (*signature_I_PSPVIL)(AAudioStream *, void *, int32_t, int64_t);
135     typedef int32_t (*signature_I_PSCPVIL)(AAudioStream *, const void *, int32_t, int64_t);
136 
137     typedef int32_t (*signature_I_PSTPTL)(AAudioStream *,
138                                           aaudio_stream_state_t,
139                                           aaudio_stream_state_t *,
140                                           int64_t);
141 
142     typedef int32_t (*signature_I_PSKPLPL)(AAudioStream *, clockid_t, int64_t *, int64_t *);
143 
144     typedef bool    (*signature_B_PS)(AAudioStream *);
145 
146     typedef uint32_t (*signature_U_PS)(AAudioStream *);
147 
148     static AAudioLoader* getInstance(); // singleton
149 
150     /**
151      * Open the AAudio shared library and load the function pointers.
152      * This can be called multiple times.
153      * It should only be called from one thread.
154      *
155      * The destructor will clean up after the open.
156      *
157      * @return 0 if successful or negative error.
158      */
159     int open();
160 
getLibHandle()161     void *getLibHandle() const { return mLibHandle; }
162 
163     // Function pointers into the AAudio shared library.
164     signature_I_PPB   createStreamBuilder = nullptr;
165 
166     signature_I_PBPPS builder_openStream = nullptr;
167 
168     signature_V_PBI builder_setBufferCapacityInFrames = nullptr;
169     signature_V_PBI builder_setChannelCount = nullptr;
170     signature_V_PBI builder_setDeviceId = nullptr;
171     signature_V_PBI builder_setDirection = nullptr;
172     signature_V_PBI builder_setFormat = nullptr;
173     signature_V_PBI builder_setFramesPerDataCallback = nullptr;
174     signature_V_PBI builder_setPerformanceMode = nullptr;
175     signature_V_PBI builder_setSampleRate = nullptr;
176     signature_V_PBI builder_setSharingMode = nullptr;
177     signature_V_PBU builder_setChannelMask = nullptr;
178 
179     signature_V_PBI builder_setUsage = nullptr;
180     signature_V_PBI builder_setContentType = nullptr;
181     signature_V_PBI builder_setInputPreset = nullptr;
182     signature_V_PBI builder_setSessionId = nullptr;
183 
184     signature_V_PBCPH builder_setPackageName = nullptr;
185     signature_V_PBCPH builder_setAttributionTag = nullptr;
186 
187     signature_V_PBPDPV  builder_setDataCallback = nullptr;
188     signature_V_PBPEPV  builder_setErrorCallback = nullptr;
189 
190     signature_I_PB      builder_delete = nullptr;
191 
192     signature_F_PS      stream_getFormat = nullptr;
193 
194     signature_I_PSPVIL  stream_read = nullptr;
195     signature_I_PSCPVIL stream_write = nullptr;
196 
197     signature_I_PSTPTL  stream_waitForStateChange = nullptr;
198 
199     signature_I_PSKPLPL stream_getTimestamp = nullptr;
200 
201     signature_I_PS   stream_close = nullptr;
202 
203     signature_I_PS   stream_getChannelCount = nullptr;
204     signature_I_PS   stream_getDeviceId = nullptr;
205 
206     signature_I_PS   stream_getBufferSize = nullptr;
207     signature_I_PS   stream_getBufferCapacity = nullptr;
208     signature_I_PS   stream_getFramesPerBurst = nullptr;
209     signature_I_PS   stream_getState = nullptr;
210     signature_I_PS   stream_getPerformanceMode = nullptr;
211     signature_I_PS   stream_getSampleRate = nullptr;
212     signature_I_PS   stream_getSharingMode = nullptr;
213     signature_I_PS   stream_getXRunCount = nullptr;
214 
215     signature_I_PSI  stream_setBufferSize = nullptr;
216     signature_I_PS   stream_requestStart = nullptr;
217     signature_I_PS   stream_requestPause = nullptr;
218     signature_I_PS   stream_requestFlush = nullptr;
219     signature_I_PS   stream_requestStop = nullptr;
220 
221     signature_L_PS   stream_getFramesRead = nullptr;
222     signature_L_PS   stream_getFramesWritten = nullptr;
223 
224     signature_CPH_I  convertResultToText = nullptr;
225 
226     signature_I_PS   stream_getUsage = nullptr;
227     signature_I_PS   stream_getContentType = nullptr;
228     signature_I_PS   stream_getInputPreset = nullptr;
229     signature_I_PS   stream_getSessionId = nullptr;
230 
231     signature_U_PS   stream_getChannelMask = nullptr;
232 
233   private:
AAudioLoader()234     AAudioLoader() {}
235     ~AAudioLoader();
236 
237     // Load function pointers for specific signatures.
238     signature_I_PPB     load_I_PPB(const char *name);
239     signature_CPH_I     load_CPH_I(const char *name);
240     signature_V_PBI     load_V_PBI(const char *name);
241     signature_V_PBCPH   load_V_PBCPH(const char *name);
242     signature_V_PBPDPV  load_V_PBPDPV(const char *name);
243     signature_V_PBPEPV  load_V_PBPEPV(const char *name);
244     signature_I_PB      load_I_PB(const char *name);
245     signature_I_PBPPS   load_I_PBPPS(const char *name);
246     signature_I_PS      load_I_PS(const char *name);
247     signature_L_PS      load_L_PS(const char *name);
248     signature_F_PS      load_F_PS(const char *name);
249     signature_B_PS      load_B_PS(const char *name);
250     signature_I_PSI     load_I_PSI(const char *name);
251     signature_I_PSPVIL  load_I_PSPVIL(const char *name);
252     signature_I_PSCPVIL load_I_PSCPVIL(const char *name);
253     signature_I_PSTPTL  load_I_PSTPTL(const char *name);
254     signature_I_PSKPLPL load_I_PSKPLPL(const char *name);
255     signature_V_PBU     load_V_PBU(const char *name);
256     signature_U_PS      load_U_PS(const char *name);
257 
258     void *mLibHandle = nullptr;
259 };
260 
261 } // namespace oboe
262 
263 #endif //OBOE_AAUDIO_LOADER_H_
264