1 /*****************************************************************************
2 * opensles_android.c : audio output for android native code
3 *****************************************************************************
4 * Copyright © 2011-2012 VideoLAN
6 * Authors: Dominique Martinet <asmadeus@codewreck.org>
7 * Hugo Beauzée-Luyssen <beauze.h@gmail.com>
8 * Rafaël Carré <funman@videolanorg>
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU Lesser General Public License as published by
12 * the Free Software Foundation; either version 2.1 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
41 #include <SLES/OpenSLES.h>
42 #include <SLES/OpenSLES_Android.h>
44 #define OPENSLES_BUFFERS 255 /* maximum number of buffers */
45 #define OPENSLES_BUFLEN 4 /* ms */
47 * 4ms of precision when mesasuring latency should be plenty enough,
48 * with 255 buffers we can buffer ~1s of audio.
51 #define CHECK_OPENSL_ERROR(msg) \
52 if (unlikely(result != SL_RESULT_SUCCESS)) \
54 msg_Err(aout, msg" (%lu)", result); \
58 typedef SLresult (*slCreateEngine_t)(
59 SLObjectItf*, SLuint32, const SLEngineOption*, SLuint32,
60 const SLInterfaceID*, const SLboolean*);
62 #define Destroy(a) (*a)->Destroy(a);
63 #define SetPlayState(a, b) (*a)->SetPlayState(a, b)
64 #define RegisterCallback(a, b, c) (*a)->RegisterCallback(a, b, c)
65 #define GetInterface(a, b, c) (*a)->GetInterface(a, b, c)
66 #define Realize(a, b) (*a)->Realize(a, b)
67 #define CreateOutputMix(a, b, c, d, e) (*a)->CreateOutputMix(a, b, c, d, e)
68 #define CreateAudioPlayer(a, b, c, d, e, f, g) \
69 (*a)->CreateAudioPlayer(a, b, c, d, e, f, g)
70 #define Enqueue(a, b, c) (*a)->Enqueue(a, b, c)
71 #define Clear(a) (*a)->Clear(a)
72 #define GetState(a, b) (*a)->GetState(a, b)
73 #define SetPositionUpdatePeriod(a, b) (*a)->SetPositionUpdatePeriod(a, b)
74 #define SetVolumeLevel(a, b) (*a)->SetVolumeLevel(a, b)
75 #define SetMute(a, b) (*a)->SetMute(a, b)
77 /*****************************************************************************
79 *****************************************************************************/
83 SLObjectItf engineObject;
84 SLObjectItf outputMixObject;
85 SLAndroidSimpleBufferQueueItf playerBufferQueue;
86 SLObjectItf playerObject;
87 SLVolumeItf volumeItf;
88 SLEngineItf engineEngine;
94 slCreateEngine_t slCreateEnginePtr;
95 SLInterfaceID SL_IID_ENGINE;
96 SLInterfaceID SL_IID_ANDROIDSIMPLEBUFFERQUEUE;
97 SLInterfaceID SL_IID_VOLUME;
98 SLInterfaceID SL_IID_PLAY;
104 /* audio buffered through opensles */
106 size_t samples_per_buf;
111 /* if we can measure latency already */
114 /* audio not yet buffered through opensles */
115 block_t *p_buffer_chain;
116 block_t **pp_buffer_last;
120 /*****************************************************************************
122 *****************************************************************************/
123 static int Open (vlc_object_t *);
124 static void Close (vlc_object_t *);
126 /*****************************************************************************
128 *****************************************************************************/
131 set_description(N_("OpenSLES audio output"))
132 set_shortname(N_("OpenSLES"))
133 set_category(CAT_AUDIO)
134 set_subcategory(SUBCAT_AUDIO_AOUT)
136 set_capability("audio output", 170)
137 add_shortcut("opensles", "android")
138 set_callbacks(Open, Close)
141 /*****************************************************************************
143 *****************************************************************************/
145 static inline int bytesPerSample(void)
147 return 2 /* S16 */ * 2 /* stereo */;
150 static int TimeGet(audio_output_t* aout, mtime_t* restrict drift)
152 aout_sys_t *sys = aout->sys;
154 SLAndroidSimpleBufferQueueState st;
155 SLresult res = GetState(sys->playerBufferQueue, &st);
156 if (unlikely(res != SL_RESULT_SUCCESS)) {
157 msg_Err(aout, "Could not query buffer queue state in TimeGet (%lu)", res);
161 vlc_mutex_lock(&sys->lock);
162 bool started = sys->started;
163 vlc_mutex_unlock(&sys->lock);
168 *drift = (CLOCK_FREQ * OPENSLES_BUFLEN * st.count / 1000)
169 + sys->samples * CLOCK_FREQ / sys->rate;
171 /* msg_Dbg(aout, "latency %"PRId64" ms, %d/%d buffers", *drift / 1000,
172 (int)st.count, OPENSLES_BUFFERS); */
177 static void Flush(audio_output_t *aout, bool drain)
179 aout_sys_t *sys = aout->sys;
183 if (!TimeGet(aout, &delay))
186 vlc_mutex_lock(&sys->lock);
187 SetPlayState(sys->playerPlay, SL_PLAYSTATE_STOPPED);
188 Clear(sys->playerBufferQueue);
189 SetPlayState(sys->playerPlay, SL_PLAYSTATE_PLAYING);
191 /* release audio data not yet written to opensles */
192 block_ChainRelease(sys->p_buffer_chain);
193 sys->p_buffer_chain = NULL;
194 sys->pp_buffer_last = &sys->p_buffer_chain;
196 sys->started = false;
198 vlc_mutex_unlock(&sys->lock);
202 static int VolumeSet(audio_output_t *aout, float vol)
204 /* Convert UI volume to linear factor (cube) */
205 vol = vol * vol * vol;
207 /* millibels from linear amplification */
208 int mb = lroundf(2000.f * log10f(vol));
209 if (mb < SL_MILLIBEL_MIN)
210 mb = SL_MILLIBEL_MIN;
212 mb = 0; /* maximum supported level could be higher: GetMaxVolumeLevel */
214 SLresult r = SetVolumeLevel(aout->sys->volumeItf, mb);
215 return (r == SL_RESULT_SUCCESS) ? 0 : -1;
218 static int MuteSet(audio_output_t *aout, bool mute)
220 SLresult r = SetMute(aout->sys->volumeItf, mute);
221 return (r == SL_RESULT_SUCCESS) ? 0 : -1;
224 static void Pause(audio_output_t *aout, bool pause, mtime_t date)
227 aout_sys_t *sys = aout->sys;
228 SetPlayState(sys->playerPlay,
229 pause ? SL_PLAYSTATE_PAUSED : SL_PLAYSTATE_PLAYING);
232 static int WriteBuffer(audio_output_t *aout)
234 aout_sys_t *sys = aout->sys;
235 const size_t unit_size = sys->samples_per_buf * bytesPerSample();
237 block_t *b = sys->p_buffer_chain;
241 /* Check if we can fill at least one buffer unit by chaining blocks */
242 if (b->i_buffer < unit_size) {
245 ssize_t needed = unit_size - b->i_buffer;
246 for (block_t *next = b->p_next; next; next = next->p_next) {
247 needed -= next->i_buffer;
256 SLAndroidSimpleBufferQueueState st;
257 SLresult res = GetState(sys->playerBufferQueue, &st);
258 if (unlikely(res != SL_RESULT_SUCCESS)) {
259 msg_Err(aout, "Could not query buffer queue state in %s (%lu)", __func__, res);
263 if (st.count == OPENSLES_BUFFERS)
267 while (done < unit_size) {
268 size_t cur = b->i_buffer;
269 if (cur > unit_size - done)
270 cur = unit_size - done;
272 memcpy(&sys->buf[unit_size * sys->next_buf + done], b->p_buffer, cur);
277 block_t *next = b->p_next;
278 if (b->i_buffer == 0) {
283 if (done == unit_size)
289 sys->p_buffer_chain = b;
291 sys->pp_buffer_last = &sys->p_buffer_chain;
293 SLresult r = Enqueue(sys->playerBufferQueue,
294 &sys->buf[unit_size * sys->next_buf], unit_size);
296 sys->samples -= sys->samples_per_buf;
298 if (r == SL_RESULT_SUCCESS) {
299 if (++sys->next_buf == OPENSLES_BUFFERS)
303 /* XXX : if writing fails, we don't retry */
304 msg_Err(aout, "error %lu when writing %d bytes %s",
306 (r == SL_RESULT_BUFFER_INSUFFICIENT) ? " (buffer insufficient)" : "");
311 /*****************************************************************************
313 *****************************************************************************/
314 static void Play(audio_output_t *aout, block_t *p_buffer)
316 aout_sys_t *sys = aout->sys;
318 p_buffer->p_next = NULL; /* Make sur our linked list doesn't use old references */
319 vlc_mutex_lock(&sys->lock);
321 sys->samples += p_buffer->i_buffer / bytesPerSample();
323 /* Hold this block until we can write it into the OpenSL buffer */
324 block_ChainLastAppend(&sys->pp_buffer_last, p_buffer);
326 /* Fill OpenSL buffer */
327 while (WriteBuffer(aout))
330 vlc_mutex_unlock(&sys->lock);
333 static void PlayedCallback (SLAndroidSimpleBufferQueueItf caller, void *pContext)
336 audio_output_t *aout = pContext;
337 aout_sys_t *sys = aout->sys;
339 assert (caller == sys->playerBufferQueue);
341 vlc_mutex_lock(&sys->lock);
343 vlc_mutex_unlock(&sys->lock);
345 /*****************************************************************************
347 *****************************************************************************/
348 static void Clean(aout_sys_t *sys)
350 if (sys->playerObject)
351 Destroy(sys->playerObject);
352 if (sys->outputMixObject)
353 Destroy(sys->outputMixObject);
354 if (sys->engineObject)
355 Destroy(sys->engineObject);
358 static int Start(audio_output_t *aout, audio_sample_format_t *restrict fmt)
362 aout_sys_t *sys = aout->sys;
364 // configure audio source - this defines the number of samples you can enqueue.
365 SLDataLocator_AndroidSimpleBufferQueue loc_bufq = {
366 SL_DATALOCATOR_ANDROIDSIMPLEBUFFERQUEUE,
370 SLDataFormat_PCM format_pcm;
371 format_pcm.formatType = SL_DATAFORMAT_PCM;
372 format_pcm.numChannels = 2;
373 format_pcm.samplesPerSec = ((SLuint32) fmt->i_rate * 1000) ;
374 format_pcm.bitsPerSample = SL_PCMSAMPLEFORMAT_FIXED_16;
375 format_pcm.containerSize = SL_PCMSAMPLEFORMAT_FIXED_16;
376 format_pcm.channelMask = SL_SPEAKER_FRONT_LEFT | SL_SPEAKER_FRONT_RIGHT;
377 format_pcm.endianness = SL_BYTEORDER_LITTLEENDIAN;
379 SLDataSource audioSrc = {&loc_bufq, &format_pcm};
381 // configure audio sink
382 SLDataLocator_OutputMix loc_outmix = {
383 SL_DATALOCATOR_OUTPUTMIX,
386 SLDataSink audioSnk = {&loc_outmix, NULL};
388 //create audio player
389 const SLInterfaceID ids2[] = { sys->SL_IID_ANDROIDSIMPLEBUFFERQUEUE, sys->SL_IID_VOLUME };
390 static const SLboolean req2[] = { SL_BOOLEAN_TRUE, SL_BOOLEAN_TRUE };
391 result = CreateAudioPlayer(sys->engineEngine, &sys->playerObject, &audioSrc,
392 &audioSnk, sizeof(ids2) / sizeof(*ids2),
394 CHECK_OPENSL_ERROR("Failed to create audio player");
396 result = Realize(sys->playerObject, SL_BOOLEAN_FALSE);
397 CHECK_OPENSL_ERROR("Failed to realize player object.");
399 result = GetInterface(sys->playerObject, sys->SL_IID_PLAY, &sys->playerPlay);
400 CHECK_OPENSL_ERROR("Failed to get player interface.");
402 result = GetInterface(sys->playerObject, sys->SL_IID_VOLUME, &sys->volumeItf);
403 CHECK_OPENSL_ERROR("failed to get volume interface.");
405 result = GetInterface(sys->playerObject, sys->SL_IID_ANDROIDSIMPLEBUFFERQUEUE,
406 &sys->playerBufferQueue);
407 CHECK_OPENSL_ERROR("Failed to get buff queue interface");
409 result = RegisterCallback(sys->playerBufferQueue, PlayedCallback,
411 CHECK_OPENSL_ERROR("Failed to register buff queue callback.");
413 // set the player's state to playing
414 result = SetPlayState(sys->playerPlay, SL_PLAYSTATE_PLAYING);
415 CHECK_OPENSL_ERROR("Failed to switch to playing state");
417 /* XXX: rounding shouldn't affect us at normal sampling rate */
418 sys->rate = fmt->i_rate;
419 sys->samples_per_buf = OPENSLES_BUFLEN * fmt->i_rate / 1000;
420 sys->buf = malloc(OPENSLES_BUFFERS * sys->samples_per_buf * bytesPerSample());
424 sys->started = false;
427 sys->p_buffer_chain = NULL;
428 sys->pp_buffer_last = &sys->p_buffer_chain;
430 // we want 16bit signed data native endian.
431 fmt->i_format = VLC_CODEC_S16N;
432 fmt->i_physical_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
434 SetPositionUpdatePeriod(sys->playerPlay, AOUT_MIN_PREPARE_TIME * 1000 / CLOCK_FREQ);
436 aout_FormatPrepare(fmt);
445 static void Stop(audio_output_t *aout)
447 aout_sys_t *sys = aout->sys;
449 SetPlayState(sys->playerPlay, SL_PLAYSTATE_STOPPED);
450 //Flush remaining buffers if any.
451 Clear(sys->playerBufferQueue);
454 block_ChainRelease(sys->p_buffer_chain);
457 /*****************************************************************************
459 *****************************************************************************/
460 static void Close(vlc_object_t *obj)
462 audio_output_t *aout = (audio_output_t *)obj;
463 aout_sys_t *sys = aout->sys;
466 dlclose(sys->p_so_handle);
467 vlc_mutex_destroy(&sys->lock);
471 static int Open (vlc_object_t *obj)
473 audio_output_t *aout = (audio_output_t *)obj;
477 aout->sys = sys = calloc(1, sizeof(*sys));
478 if (unlikely(sys == NULL))
481 sys->p_so_handle = dlopen("libOpenSLES.so", RTLD_NOW);
482 if (sys->p_so_handle == NULL)
484 msg_Err(aout, "Failed to load libOpenSLES");
488 sys->slCreateEnginePtr = dlsym(sys->p_so_handle, "slCreateEngine");
489 if (unlikely(sys->slCreateEnginePtr == NULL))
491 msg_Err(aout, "Failed to load symbol slCreateEngine");
495 #define OPENSL_DLSYM(dest, name) \
497 const SLInterfaceID *sym = dlsym(sys->p_so_handle, "SL_IID_"name); \
498 if (unlikely(sym == NULL)) \
500 msg_Err(aout, "Failed to load symbol SL_IID_"name); \
506 OPENSL_DLSYM(SL_IID_ANDROIDSIMPLEBUFFERQUEUE, "ANDROIDSIMPLEBUFFERQUEUE");
507 OPENSL_DLSYM(SL_IID_ENGINE, "ENGINE");
508 OPENSL_DLSYM(SL_IID_PLAY, "PLAY");
509 OPENSL_DLSYM(SL_IID_VOLUME, "VOLUME");
513 result = sys->slCreateEnginePtr(&sys->engineObject, 0, NULL, 0, NULL, NULL);
514 CHECK_OPENSL_ERROR("Failed to create engine");
516 // realize the engine in synchronous mode
517 result = Realize(sys->engineObject, SL_BOOLEAN_FALSE);
518 CHECK_OPENSL_ERROR("Failed to realize engine");
520 // get the engine interface, needed to create other objects
521 result = GetInterface(sys->engineObject, sys->SL_IID_ENGINE, &sys->engineEngine);
522 CHECK_OPENSL_ERROR("Failed to get the engine interface");
524 // create output mix, with environmental reverb specified as a non-required interface
525 const SLInterfaceID ids1[] = { sys->SL_IID_VOLUME };
526 const SLboolean req1[] = { SL_BOOLEAN_FALSE };
527 result = CreateOutputMix(sys->engineEngine, &sys->outputMixObject, 1, ids1, req1);
528 CHECK_OPENSL_ERROR("Failed to create output mix");
530 // realize the output mix in synchronous mode
531 result = Realize(sys->outputMixObject, SL_BOOLEAN_FALSE);
532 CHECK_OPENSL_ERROR("Failed to realize output mix");
534 vlc_mutex_init(&sys->lock);
538 aout->time_get = TimeGet;
542 aout->mute_set = MuteSet;
543 aout->volume_set = VolumeSet;
549 if (sys->p_so_handle)
550 dlclose(sys->p_so_handle);