xref: /aosp_15_r20/external/oboe/src/aaudio/AAudioLoader.h (revision 05767d913155b055644481607e6fa1e35e2fe72c)
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 typedef int32_t aaudio_spatialization_behavior_t;
73 #endif
74 
75 #ifndef __ANDROID_API_Q__
76 #define __ANDROID_API_Q__ 29
77 #endif
78 
79 #ifndef __ANDROID_API_R__
80 #define __ANDROID_API_R__ 30
81 #endif
82 
83 #ifndef __ANDROID_API_S__
84 #define __ANDROID_API_S__ 31
85 #endif
86 
87 #ifndef __ANDROID_API_S_V2__
88 #define __ANDROID_API_S_V2__ 32
89 #endif
90 
91 #ifndef __ANDROID_API_U__
92 #define __ANDROID_API_U__ 34
93 #endif
94 
95 namespace oboe {
96 
97 /**
98  * The AAudio API was not available in early versions of Android.
99  * To avoid linker errors, we dynamically link with the functions by name using dlsym().
100  * On older versions this linkage will safely fail.
101  */
102 class AAudioLoader {
103   public:
104     // Use signatures for common functions.
105     // Key to letter abbreviations.
106     // S = Stream
107     // B = Builder
108     // I = int32_t
109     // L = int64_t
110     // T = sTate
111     // K = clocKid_t
112     // P = Pointer to following data type
113     // C = Const prefix
114     // H = cHar
115     // U = uint32_t
116     // O = bOol
117 
118     typedef int32_t  (*signature_I_PPB)(AAudioStreamBuilder **builder);
119 
120     typedef const char * (*signature_CPH_I)(int32_t);
121 
122     typedef int32_t (*signature_I_PBPPS)(AAudioStreamBuilder *,
123                                       AAudioStream **stream);  // AAudioStreamBuilder_open()
124 
125     typedef int32_t (*signature_I_PB)(AAudioStreamBuilder *);  // AAudioStreamBuilder_delete()
126     // AAudioStreamBuilder_setSampleRate()
127     typedef void    (*signature_V_PBI)(AAudioStreamBuilder *, int32_t);
128 
129     // AAudioStreamBuilder_setChannelMask()
130     typedef void    (*signature_V_PBU)(AAudioStreamBuilder *, uint32_t);
131 
132     typedef void    (*signature_V_PBCPH)(AAudioStreamBuilder *, const char *);
133 
134     // AAudioStreamBuilder_setPrivacySensitive
135     typedef void    (*signature_V_PBO)(AAudioStreamBuilder *, bool);
136 
137     typedef int32_t (*signature_I_PS)(AAudioStream *);  // AAudioStream_getSampleRate()
138     typedef int64_t (*signature_L_PS)(AAudioStream *);  // AAudioStream_getFramesRead()
139     // AAudioStream_setBufferSizeInFrames()
140     typedef int32_t (*signature_I_PSI)(AAudioStream *, int32_t);
141 
142     typedef void    (*signature_V_PBPDPV)(AAudioStreamBuilder *,
143                                           AAudioStream_dataCallback,
144                                           void *);
145 
146     typedef void    (*signature_V_PBPEPV)(AAudioStreamBuilder *,
147                                           AAudioStream_errorCallback,
148                                           void *);
149 
150     typedef aaudio_format_t (*signature_F_PS)(AAudioStream *stream);
151 
152     typedef int32_t (*signature_I_PSPVIL)(AAudioStream *, void *, int32_t, int64_t);
153     typedef int32_t (*signature_I_PSCPVIL)(AAudioStream *, const void *, int32_t, int64_t);
154 
155     typedef int32_t (*signature_I_PSTPTL)(AAudioStream *,
156                                           aaudio_stream_state_t,
157                                           aaudio_stream_state_t *,
158                                           int64_t);
159 
160     typedef int32_t (*signature_I_PSKPLPL)(AAudioStream *, clockid_t, int64_t *, int64_t *);
161 
162     typedef bool    (*signature_O_PS)(AAudioStream *);
163 
164     typedef uint32_t (*signature_U_PS)(AAudioStream *);
165 
166     static AAudioLoader* getInstance(); // singleton
167 
168     /**
169      * Open the AAudio shared library and load the function pointers.
170      * This can be called multiple times.
171      * It should only be called from one thread.
172      *
173      * The destructor will clean up after the open.
174      *
175      * @return 0 if successful or negative error.
176      */
177     int open();
178 
getLibHandle()179     void *getLibHandle() const { return mLibHandle; }
180 
181     // Function pointers into the AAudio shared library.
182     signature_I_PPB   createStreamBuilder = nullptr;
183 
184     signature_I_PBPPS builder_openStream = nullptr;
185 
186     signature_V_PBI builder_setBufferCapacityInFrames = nullptr;
187     signature_V_PBI builder_setChannelCount = nullptr;
188     signature_V_PBI builder_setDeviceId = nullptr;
189     signature_V_PBI builder_setDirection = nullptr;
190     signature_V_PBI builder_setFormat = nullptr;
191     signature_V_PBI builder_setFramesPerDataCallback = nullptr;
192     signature_V_PBI builder_setPerformanceMode = nullptr;
193     signature_V_PBI builder_setSampleRate = nullptr;
194     signature_V_PBI builder_setSharingMode = nullptr;
195     signature_V_PBU builder_setChannelMask = nullptr;
196 
197     signature_V_PBI builder_setUsage = nullptr;
198     signature_V_PBI builder_setContentType = nullptr;
199     signature_V_PBI builder_setInputPreset = nullptr;
200     signature_V_PBI builder_setSessionId = nullptr;
201 
202     signature_V_PBO builder_setPrivacySensitive = nullptr;
203     signature_V_PBI builder_setAllowedCapturePolicy = nullptr;
204 
205     signature_V_PBCPH builder_setPackageName = nullptr;
206     signature_V_PBCPH builder_setAttributionTag = nullptr;
207 
208     signature_V_PBO builder_setIsContentSpatialized = nullptr;
209     signature_V_PBI builder_setSpatializationBehavior = nullptr;
210 
211     signature_V_PBPDPV  builder_setDataCallback = nullptr;
212     signature_V_PBPEPV  builder_setErrorCallback = nullptr;
213 
214     signature_I_PB      builder_delete = nullptr;
215 
216     signature_F_PS      stream_getFormat = nullptr;
217 
218     signature_I_PSPVIL  stream_read = nullptr;
219     signature_I_PSCPVIL stream_write = nullptr;
220 
221     signature_I_PSTPTL  stream_waitForStateChange = nullptr;
222 
223     signature_I_PSKPLPL stream_getTimestamp = nullptr;
224 
225     signature_I_PS   stream_release = nullptr;
226     signature_I_PS   stream_close = nullptr;
227 
228     signature_I_PS   stream_getChannelCount = nullptr;
229     signature_I_PS   stream_getDeviceId = nullptr;
230 
231     signature_I_PS   stream_getBufferSize = nullptr;
232     signature_I_PS   stream_getBufferCapacity = nullptr;
233     signature_I_PS   stream_getFramesPerBurst = nullptr;
234     signature_I_PS   stream_getState = nullptr;
235     signature_I_PS   stream_getPerformanceMode = nullptr;
236     signature_I_PS   stream_getSampleRate = nullptr;
237     signature_I_PS   stream_getSharingMode = nullptr;
238     signature_I_PS   stream_getXRunCount = nullptr;
239 
240     signature_I_PSI  stream_setBufferSize = nullptr;
241     signature_I_PS   stream_requestStart = nullptr;
242     signature_I_PS   stream_requestPause = nullptr;
243     signature_I_PS   stream_requestFlush = nullptr;
244     signature_I_PS   stream_requestStop = nullptr;
245 
246     signature_L_PS   stream_getFramesRead = nullptr;
247     signature_L_PS   stream_getFramesWritten = nullptr;
248 
249     signature_CPH_I  convertResultToText = nullptr;
250 
251     signature_I_PS   stream_getUsage = nullptr;
252     signature_I_PS   stream_getContentType = nullptr;
253     signature_I_PS   stream_getInputPreset = nullptr;
254     signature_I_PS   stream_getSessionId = nullptr;
255 
256     signature_O_PS   stream_isPrivacySensitive = nullptr;
257     signature_I_PS   stream_getAllowedCapturePolicy = nullptr;
258 
259     signature_U_PS   stream_getChannelMask = nullptr;
260 
261     signature_O_PS   stream_isContentSpatialized = nullptr;
262     signature_I_PS   stream_getSpatializationBehavior = nullptr;
263 
264     signature_I_PS   stream_getHardwareChannelCount = nullptr;
265     signature_I_PS   stream_getHardwareSampleRate = nullptr;
266     signature_F_PS   stream_getHardwareFormat = nullptr;
267 
268   private:
AAudioLoader()269     AAudioLoader() {}
270     ~AAudioLoader();
271 
272     // Load function pointers for specific signatures.
273     signature_I_PPB     load_I_PPB(const char *name);
274     signature_CPH_I     load_CPH_I(const char *name);
275     signature_V_PBI     load_V_PBI(const char *name);
276     signature_V_PBCPH   load_V_PBCPH(const char *name);
277     signature_V_PBPDPV  load_V_PBPDPV(const char *name);
278     signature_V_PBPEPV  load_V_PBPEPV(const char *name);
279     signature_I_PB      load_I_PB(const char *name);
280     signature_I_PBPPS   load_I_PBPPS(const char *name);
281     signature_I_PS      load_I_PS(const char *name);
282     signature_L_PS      load_L_PS(const char *name);
283     signature_F_PS      load_F_PS(const char *name);
284     signature_O_PS      load_O_PS(const char *name);
285     signature_I_PSI     load_I_PSI(const char *name);
286     signature_I_PSPVIL  load_I_PSPVIL(const char *name);
287     signature_I_PSCPVIL load_I_PSCPVIL(const char *name);
288     signature_I_PSTPTL  load_I_PSTPTL(const char *name);
289     signature_I_PSKPLPL load_I_PSKPLPL(const char *name);
290     signature_V_PBU     load_V_PBU(const char *name);
291     signature_U_PS      load_U_PS(const char *name);
292     signature_V_PBO     load_V_PBO(const char *name);
293 
294     void *mLibHandle = nullptr;
295 };
296 
297 } // namespace oboe
298 
299 #endif //OBOE_AAUDIO_LOADER_H_
300