1 /*
2     SDL - Simple DirectMedia Layer
3     Copyright (C) 1997-2009 Sam Lantinga
4 
5     This library is free software; you can redistribute it and/or
6     modify it under the terms of the GNU Lesser General Public
7     License as published by the Free Software Foundation; either
8     version 2.1 of the License, or (at your option) any later version.
9 
10     This library is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13     Lesser General Public License for more details.
14 
15     You should have received a copy of the GNU Lesser General Public
16     License along with this library; if not, write to the Free Software
17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18 
19     Sam Lantinga
20     slouken@libsdl.org
21 
22     This file written by Ryan C. Gordon (icculus@icculus.org)
23 */
24 #include "SDL_config.h"
25 #include "SDL_version.h"
26 
27 #include "SDL_rwops.h"
28 #include "SDL_timer.h"
29 #include "SDL_audio.h"
30 #include "../SDL_audiomem.h"
31 #include "../SDL_audio_c.h"
32 #include "../SDL_audiodev_c.h"
33 #include "SDL_androidaudio.h"
34 #include "SDL_mutex.h"
35 #include "SDL_thread.h"
36 #include <jni.h>
37 #include <android/log.h>
38 #include <string.h> // for memset()
39 #include <pthread.h>
40 
41 #define _THIS	SDL_AudioDevice *this
42 
43 /* Audio driver functions */
44 
45 static void ANDROIDAUD_WaitAudio(_THIS);
46 static void ANDROIDAUD_PlayAudio(_THIS);
47 static Uint8 *ANDROIDAUD_GetAudioBuf(_THIS);
48 static void ANDROIDAUD_CloseAudio(_THIS);
49 static void ANDROIDAUD_ThreadInit(_THIS);
50 static void ANDROIDAUD_ThreadDeinit(_THIS);
51 
52 #if SDL_VERSION_ATLEAST(1,3,0)
53 
54 static int ANDROIDAUD_OpenAudio(_THIS, const char *devname, int iscapture);
55 
ANDROIDAUD_DeleteDevice()56 static void ANDROIDAUD_DeleteDevice()
57 {
58 }
59 
ANDROIDAUD_CreateDevice(SDL_AudioDriverImpl * impl)60 static int ANDROIDAUD_CreateDevice(SDL_AudioDriverImpl * impl)
61 {
62 
63 	/* Set the function pointers */
64 	impl->OpenDevice = ANDROIDAUD_OpenAudio;
65 	impl->WaitDevice = ANDROIDAUD_WaitAudio;
66 	impl->PlayDevice = ANDROIDAUD_PlayAudio;
67 	impl->GetDeviceBuf = ANDROIDAUD_GetAudioBuf;
68 	impl->CloseDevice = ANDROIDAUD_CloseAudio;
69 	impl->ThreadInit = ANDROIDAUD_ThreadInit;
70 	impl->WaitDone = ANDROIDAUD_ThreadDeinit;
71 	impl->Deinitialize = ANDROIDAUD_DeleteDevice;
72 	impl->OnlyHasDefaultOutputDevice = 1;
73 
74 	return 1;
75 }
76 
77 AudioBootStrap ANDROIDAUD_bootstrap = {
78 	"android", "SDL Android audio driver",
79 	ANDROIDAUD_CreateDevice, 0
80 };
81 
82 #else
83 
84 static int ANDROIDAUD_OpenAudio(_THIS, SDL_AudioSpec *spec);
85 
ANDROIDAUD_Available(void)86 static int ANDROIDAUD_Available(void)
87 {
88 	return(1);
89 }
90 
ANDROIDAUD_DeleteDevice(SDL_AudioDevice * device)91 static void ANDROIDAUD_DeleteDevice(SDL_AudioDevice *device)
92 {
93 	SDL_free(device);
94 }
95 
ANDROIDAUD_CreateDevice(int devindex)96 static SDL_AudioDevice *ANDROIDAUD_CreateDevice(int devindex)
97 {
98 	SDL_AudioDevice *this;
99 
100 	/* Initialize all variables that we clean on shutdown */
101 	this = (SDL_AudioDevice *)SDL_malloc(sizeof(SDL_AudioDevice));
102 	if ( this ) {
103 		SDL_memset(this, 0, (sizeof *this));
104 		this->hidden = NULL;
105 	} else {
106 		SDL_OutOfMemory();
107 		return(0);
108 	}
109 
110 	/* Set the function pointers */
111 	this->OpenAudio = ANDROIDAUD_OpenAudio;
112 	this->WaitAudio = ANDROIDAUD_WaitAudio;
113 	this->PlayAudio = ANDROIDAUD_PlayAudio;
114 	this->GetAudioBuf = ANDROIDAUD_GetAudioBuf;
115 	this->CloseAudio = ANDROIDAUD_CloseAudio;
116 	this->ThreadInit = ANDROIDAUD_ThreadInit;
117 	this->WaitDone = ANDROIDAUD_ThreadDeinit;
118 	this->free = ANDROIDAUD_DeleteDevice;
119 
120 	return this;
121 }
122 
123 AudioBootStrap ANDROIDAUD_bootstrap = {
124 	"android", "SDL Android audio driver",
125 	ANDROIDAUD_Available, ANDROIDAUD_CreateDevice
126 };
127 
128 #endif
129 
130 
131 static unsigned char * audioBuffer = NULL;
132 static size_t audioBufferSize = 0;
133 
134 // Extremely wicked JNI environment to call Java functions from C code
135 static jbyteArray audioBufferJNI = NULL;
136 static JavaVM *jniVM = NULL;
137 static jobject JavaAudioThread = NULL;
138 static jmethodID JavaInitAudio = NULL;
139 static jmethodID JavaDeinitAudio = NULL;
140 static jmethodID JavaPauseAudioPlayback = NULL;
141 static jmethodID JavaResumeAudioPlayback = NULL;
142 
143 
ANDROIDAUD_GetAudioBuf(_THIS)144 static Uint8 *ANDROIDAUD_GetAudioBuf(_THIS)
145 {
146 	return(audioBuffer);
147 }
148 
149 
150 #if SDL_VERSION_ATLEAST(1,3,0)
ANDROIDAUD_OpenAudio(_THIS,const char * devname,int iscapture)151 static int ANDROIDAUD_OpenAudio (_THIS, const char *devname, int iscapture)
152 {
153 	SDL_AudioSpec *audioFormat = &this->spec;
154 
155 #else
156 static int ANDROIDAUD_OpenAudio (_THIS, SDL_AudioSpec *spec)
157 {
158 	SDL_AudioSpec *audioFormat = spec;
159 #endif
160 
161 	int bytesPerSample;
162 	JNIEnv * jniEnv = NULL;
163 
164 	this->hidden = NULL;
165 
166 	if( ! (audioFormat->format == AUDIO_S8 || audioFormat->format == AUDIO_S16) )
167 	{
168 		__android_log_print(ANDROID_LOG_ERROR, "libSDL", "Application requested unsupported audio format - only S8 and S16 are supported");
169 		return (-1); // TODO: enable format conversion? Don't know how to do that in SDL
170 	}
171 
172 	bytesPerSample = (audioFormat->format & 0xFF) / 8;
173 	audioFormat->format = ( bytesPerSample == 2 ) ? AUDIO_S16 : AUDIO_S8;
174 
175 	__android_log_print(ANDROID_LOG_INFO, "libSDL", "ANDROIDAUD_OpenAudio(): app requested audio bytespersample %d freq %d channels %d samples %d", bytesPerSample, audioFormat->freq, (int)audioFormat->channels, (int)audioFormat->samples);
176 
177 	if(audioFormat->samples <= 0)
178 		audioFormat->samples = 128; // Some sane value
179 	if( audioFormat->samples > 32768 ) // Why anyone need so huge audio buffer?
180 	{
181 		audioFormat->samples = 32768;
182 		__android_log_print(ANDROID_LOG_INFO, "libSDL", "ANDROIDAUD_OpenAudio(): limiting samples size to ", (int)audioFormat->samples);
183 	}
184 
185 	SDL_CalculateAudioSpec(audioFormat);
186 
187 
188 	(*jniVM)->AttachCurrentThread(jniVM, &jniEnv, NULL);
189 
190 	if( !jniEnv )
191 	{
192 		__android_log_print(ANDROID_LOG_ERROR, "libSDL", "ANDROIDAUD_OpenAudio: Java VM AttachCurrentThread() failed");
193 		return (-1); // TODO: enable format conversion? Don't know how to do that in SDL
194 	}
195 
196 	// The returned audioBufferSize may be huge, up to 100 Kb for 44100 because user may have selected large audio buffer to get rid of choppy sound
197 	audioBufferSize = (*jniEnv)->CallIntMethod( jniEnv, JavaAudioThread, JavaInitAudio,
198 					(jint)audioFormat->freq, (jint)audioFormat->channels,
199 					(jint)(( bytesPerSample == 2 ) ? 1 : 0), (jint)(audioFormat->size) );
200 
201 	if( audioBufferSize == 0 )
202 	{
203 		__android_log_print(ANDROID_LOG_INFO, "libSDL", "ANDROIDAUD_OpenAudio(): failed to get audio buffer from JNI");
204 		ANDROIDAUD_CloseAudio(this);
205 		return(-1);
206 	}
207 
208 	/* We cannot call DetachCurrentThread() from main thread or we'll crash */
209 	/* (*jniVM)->DetachCurrentThread(jniVM); */
210 
211 	audioFormat->samples = audioBufferSize / bytesPerSample / audioFormat->channels;
212 	audioFormat->size = audioBufferSize;
213 	__android_log_print(ANDROID_LOG_INFO, "libSDL", "ANDROIDAUD_OpenAudio(): app opened audio bytespersample %d freq %d channels %d bufsize %d", bytesPerSample, audioFormat->freq, (int)audioFormat->channels, audioBufferSize);
214 
215 	SDL_CalculateAudioSpec(audioFormat);
216 
217 #if SDL_VERSION_ATLEAST(1,3,0)
218 	return(1);
219 #else
220 	return(0);
221 #endif
222 }
223 
224 static void ANDROIDAUD_CloseAudio(_THIS)
225 {
226 	//__android_log_print(ANDROID_LOG_INFO, "libSDL", "ANDROIDAUD_CloseAudio()");
227 	JNIEnv * jniEnv = NULL;
228 	(*jniVM)->AttachCurrentThread(jniVM, &jniEnv, NULL);
229 
230 	(*jniEnv)->DeleteGlobalRef(jniEnv, audioBufferJNI);
231 	audioBufferJNI = NULL;
232 	audioBuffer = NULL;
233 	audioBufferSize = 0;
234 
235 	(*jniEnv)->CallIntMethod( jniEnv, JavaAudioThread, JavaDeinitAudio );
236 
237 	/* We cannot call DetachCurrentThread() from main thread or we'll crash */
238 	/* (*jniVM)->DetachCurrentThread(jniVM); */
239 
240 }
241 
242 /* This function waits until it is possible to write a full sound buffer */
243 static void ANDROIDAUD_WaitAudio(_THIS)
244 {
245 	/* We will block in PlayAudio(), do nothing here */
246 }
247 
248 static JNIEnv * jniEnvPlaying = NULL;
249 static jmethodID JavaFillBuffer = NULL;
250 
251 static void ANDROIDAUD_ThreadInit(_THIS)
252 {
253 	jclass JavaAudioThreadClass = NULL;
254 	jmethodID JavaInitThread = NULL;
255 	jmethodID JavaGetBuffer = NULL;
256 	jboolean isCopy = JNI_TRUE;
257 
258 	(*jniVM)->AttachCurrentThread(jniVM, &jniEnvPlaying, NULL);
259 
260 	JavaAudioThreadClass = (*jniEnvPlaying)->GetObjectClass(jniEnvPlaying, JavaAudioThread);
261 	JavaFillBuffer = (*jniEnvPlaying)->GetMethodID(jniEnvPlaying, JavaAudioThreadClass, "fillBuffer", "()I");
262 
263 	/* HACK: raise our own thread priority to max to get rid of "W/AudioFlinger: write blocked for 54 msecs" errors */
264 	JavaInitThread = (*jniEnvPlaying)->GetMethodID(jniEnvPlaying, JavaAudioThreadClass, "initAudioThread", "()I");
265 	(*jniEnvPlaying)->CallIntMethod( jniEnvPlaying, JavaAudioThread, JavaInitThread );
266 
267 	JavaGetBuffer = (*jniEnvPlaying)->GetMethodID(jniEnvPlaying, JavaAudioThreadClass, "getBuffer", "()[B");
268 	audioBufferJNI = (*jniEnvPlaying)->CallObjectMethod( jniEnvPlaying, JavaAudioThread, JavaGetBuffer );
269 	audioBufferJNI = (*jniEnvPlaying)->NewGlobalRef(jniEnvPlaying, audioBufferJNI);
270 	audioBuffer = (unsigned char *) (*jniEnvPlaying)->GetByteArrayElements(jniEnvPlaying, audioBufferJNI, &isCopy);
271 	if( !audioBuffer )
272 	{
273 		__android_log_print(ANDROID_LOG_ERROR, "libSDL", "ANDROIDAUD_ThreadInit() JNI::GetByteArrayElements() failed! we will crash now");
274 		return;
275 	}
276 	if( isCopy == JNI_TRUE )
277 		__android_log_print(ANDROID_LOG_ERROR, "libSDL", "ANDROIDAUD_ThreadInit(): JNI returns a copy of byte array - no audio will be played");
278 
279 	//__android_log_print(ANDROID_LOG_INFO, "libSDL", "ANDROIDAUD_ThreadInit()");
280 	SDL_memset(audioBuffer, this->spec.silence, this->spec.size);
281 };
282 
283 static void ANDROIDAUD_ThreadDeinit(_THIS)
284 {
285 	(*jniVM)->DetachCurrentThread(jniVM);
286 };
287 
288 static void ANDROIDAUD_PlayAudio(_THIS)
289 {
290 	//__android_log_print(ANDROID_LOG_INFO, "libSDL", "ANDROIDAUD_PlayAudio()");
291 	jboolean isCopy = JNI_TRUE;
292 
293 	(*jniEnvPlaying)->ReleaseByteArrayElements(jniEnvPlaying, audioBufferJNI, (jbyte *)audioBuffer, 0);
294 	audioBuffer = NULL;
295 
296 	(*jniEnvPlaying)->CallIntMethod( jniEnvPlaying, JavaAudioThread, JavaFillBuffer );
297 
298 	audioBuffer = (unsigned char *) (*jniEnvPlaying)->GetByteArrayElements(jniEnvPlaying, audioBufferJNI, &isCopy);
299 	if( !audioBuffer )
300 		__android_log_print(ANDROID_LOG_ERROR, "libSDL", "ANDROIDAUD_PlayAudio() JNI::GetByteArrayElements() failed! we will crash now");
301 
302 	if( isCopy == JNI_TRUE )
303 		__android_log_print(ANDROID_LOG_INFO, "libSDL", "ANDROIDAUD_PlayAudio() JNI returns a copy of byte array - that's slow");
304 }
305 
306 int SDL_ANDROID_PauseAudioPlayback(void)
307 {
308 	JNIEnv * jniEnv = NULL;
309 	(*jniVM)->AttachCurrentThread(jniVM, &jniEnv, NULL);
310 	return (*jniEnv)->CallIntMethod( jniEnv, JavaAudioThread, JavaPauseAudioPlayback );
311 };
312 int SDL_ANDROID_ResumeAudioPlayback(void)
313 {
314 	JNIEnv * jniEnv = NULL;
315 	(*jniVM)->AttachCurrentThread(jniVM, &jniEnv, NULL);
316 	return (*jniEnv)->CallIntMethod( jniEnv, JavaAudioThread, JavaResumeAudioPlayback );
317 };
318 
319 
320 #ifndef SDL_JAVA_PACKAGE_PATH
321 #error You have to define SDL_JAVA_PACKAGE_PATH to your package path with dots replaced with underscores, for example "com_example_SanAngeles"
322 #endif
323 #define JAVA_EXPORT_NAME2(name,package) Java_##package##_##name
324 #define JAVA_EXPORT_NAME1(name,package) JAVA_EXPORT_NAME2(name,package)
325 #define JAVA_EXPORT_NAME(name) JAVA_EXPORT_NAME1(name,SDL_JAVA_PACKAGE_PATH)
326 
327 JNIEXPORT jint JNICALL JAVA_EXPORT_NAME(AudioThread_nativeAudioInitJavaCallbacks) (JNIEnv * jniEnv, jobject thiz)
328 {
329 	jclass JavaAudioThreadClass = NULL;
330 	JavaAudioThread = (*jniEnv)->NewGlobalRef(jniEnv, thiz);
331 	JavaAudioThreadClass = (*jniEnv)->GetObjectClass(jniEnv, JavaAudioThread);
332 	JavaInitAudio = (*jniEnv)->GetMethodID(jniEnv, JavaAudioThreadClass, "initAudio", "(IIII)I");
333 	JavaDeinitAudio = (*jniEnv)->GetMethodID(jniEnv, JavaAudioThreadClass, "deinitAudio", "()I");
334 	JavaPauseAudioPlayback = (*jniEnv)->GetMethodID(jniEnv, JavaAudioThreadClass, "pauseAudioPlayback", "()I");
335 	JavaResumeAudioPlayback = (*jniEnv)->GetMethodID(jniEnv, JavaAudioThreadClass, "resumeAudioPlayback", "()I");
336 }
337 
338 JNIEXPORT jint JNICALL JNI_OnLoad(JavaVM *vm, void *reserved)
339 {
340 	jniVM = vm;
341 	return JNI_VERSION_1_2;
342 };
343 
344 JNIEXPORT void JNICALL JNI_OnUnload(JavaVM *vm, void *reserved)
345 {
346 	/* TODO: free JavaAudioThread */
347 	jniVM = vm;
348 };
349 
350