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 10 /* ms */
47 * 10ms of precision when mesasuring latency should be enough,
48 * with 255 buffers we can buffer 2.55s 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;
197 sys->started = false;
199 vlc_mutex_unlock(&sys->lock);
203 static int VolumeSet(audio_output_t *aout, float vol)
205 if (!aout->sys->volumeItf)
208 /* Convert UI volume to linear factor (cube) */
209 vol = vol * vol * vol;
211 /* millibels from linear amplification */
212 int mb = lroundf(2000.f * log10f(vol));
213 if (mb < SL_MILLIBEL_MIN)
214 mb = SL_MILLIBEL_MIN;
216 mb = 0; /* maximum supported level could be higher: GetMaxVolumeLevel */
218 SLresult r = SetVolumeLevel(aout->sys->volumeItf, mb);
219 return (r == SL_RESULT_SUCCESS) ? 0 : -1;
222 static int MuteSet(audio_output_t *aout, bool mute)
224 if (!aout->sys->volumeItf)
227 SLresult r = SetMute(aout->sys->volumeItf, mute);
228 return (r == SL_RESULT_SUCCESS) ? 0 : -1;
231 static void Pause(audio_output_t *aout, bool pause, mtime_t date)
234 aout_sys_t *sys = aout->sys;
235 SetPlayState(sys->playerPlay,
236 pause ? SL_PLAYSTATE_PAUSED : SL_PLAYSTATE_PLAYING);
239 static int WriteBuffer(audio_output_t *aout)
241 aout_sys_t *sys = aout->sys;
242 const size_t unit_size = sys->samples_per_buf * bytesPerSample();
244 block_t *b = sys->p_buffer_chain;
248 /* Check if we can fill at least one buffer unit by chaining blocks */
249 if (b->i_buffer < unit_size) {
252 ssize_t needed = unit_size - b->i_buffer;
253 for (block_t *next = b->p_next; next; next = next->p_next) {
254 needed -= next->i_buffer;
263 SLAndroidSimpleBufferQueueState st;
264 SLresult res = GetState(sys->playerBufferQueue, &st);
265 if (unlikely(res != SL_RESULT_SUCCESS)) {
266 msg_Err(aout, "Could not query buffer queue state in %s (%lu)", __func__, res);
270 if (st.count == OPENSLES_BUFFERS)
274 while (done < unit_size) {
275 size_t cur = b->i_buffer;
276 if (cur > unit_size - done)
277 cur = unit_size - done;
279 memcpy(&sys->buf[unit_size * sys->next_buf + done], b->p_buffer, cur);
284 block_t *next = b->p_next;
285 if (b->i_buffer == 0) {
290 if (done == unit_size)
296 sys->p_buffer_chain = b;
298 sys->pp_buffer_last = &sys->p_buffer_chain;
300 SLresult r = Enqueue(sys->playerBufferQueue,
301 &sys->buf[unit_size * sys->next_buf], unit_size);
303 sys->samples -= sys->samples_per_buf;
305 if (r == SL_RESULT_SUCCESS) {
306 if (++sys->next_buf == OPENSLES_BUFFERS)
310 /* XXX : if writing fails, we don't retry */
311 msg_Err(aout, "error %lu when writing %d bytes %s",
313 (r == SL_RESULT_BUFFER_INSUFFICIENT) ? " (buffer insufficient)" : "");
318 /*****************************************************************************
320 *****************************************************************************/
321 static void Play(audio_output_t *aout, block_t *p_buffer)
323 aout_sys_t *sys = aout->sys;
325 p_buffer->p_next = NULL; /* Make sur our linked list doesn't use old references */
326 vlc_mutex_lock(&sys->lock);
328 sys->samples += p_buffer->i_buffer / bytesPerSample();
330 /* Hold this block until we can write it into the OpenSL buffer */
331 block_ChainLastAppend(&sys->pp_buffer_last, p_buffer);
333 /* Fill OpenSL buffer */
334 while (WriteBuffer(aout))
337 vlc_mutex_unlock(&sys->lock);
340 static void PlayedCallback (SLAndroidSimpleBufferQueueItf caller, void *pContext)
343 audio_output_t *aout = pContext;
344 aout_sys_t *sys = aout->sys;
346 assert (caller == sys->playerBufferQueue);
348 vlc_mutex_lock(&sys->lock);
350 vlc_mutex_unlock(&sys->lock);
352 /*****************************************************************************
354 *****************************************************************************/
355 static int Start(audio_output_t *aout, audio_sample_format_t *restrict fmt)
359 aout_sys_t *sys = aout->sys;
361 // configure audio source - this defines the number of samples you can enqueue.
362 SLDataLocator_AndroidSimpleBufferQueue loc_bufq = {
363 SL_DATALOCATOR_ANDROIDSIMPLEBUFFERQUEUE,
367 SLDataFormat_PCM format_pcm;
368 format_pcm.formatType = SL_DATAFORMAT_PCM;
369 format_pcm.numChannels = 2;
370 format_pcm.samplesPerSec = ((SLuint32) fmt->i_rate * 1000) ;
371 format_pcm.bitsPerSample = SL_PCMSAMPLEFORMAT_FIXED_16;
372 format_pcm.containerSize = SL_PCMSAMPLEFORMAT_FIXED_16;
373 format_pcm.channelMask = SL_SPEAKER_FRONT_LEFT | SL_SPEAKER_FRONT_RIGHT;
374 format_pcm.endianness = SL_BYTEORDER_LITTLEENDIAN;
376 SLDataSource audioSrc = {&loc_bufq, &format_pcm};
378 // configure audio sink
379 SLDataLocator_OutputMix loc_outmix = {
380 SL_DATALOCATOR_OUTPUTMIX,
383 SLDataSink audioSnk = {&loc_outmix, NULL};
385 //create audio player
386 const SLInterfaceID ids2[] = { sys->SL_IID_ANDROIDSIMPLEBUFFERQUEUE, sys->SL_IID_VOLUME };
387 static const SLboolean req2[] = { SL_BOOLEAN_TRUE, SL_BOOLEAN_TRUE };
388 result = CreateAudioPlayer(sys->engineEngine, &sys->playerObject, &audioSrc,
389 &audioSnk, sizeof(ids2) / sizeof(*ids2),
391 CHECK_OPENSL_ERROR("Failed to create audio player");
393 result = Realize(sys->playerObject, SL_BOOLEAN_FALSE);
394 CHECK_OPENSL_ERROR("Failed to realize player object.");
396 result = GetInterface(sys->playerObject, sys->SL_IID_PLAY, &sys->playerPlay);
397 CHECK_OPENSL_ERROR("Failed to get player interface.");
399 result = GetInterface(sys->playerObject, sys->SL_IID_VOLUME, &sys->volumeItf);
400 CHECK_OPENSL_ERROR("failed to get volume interface.");
402 result = GetInterface(sys->playerObject, sys->SL_IID_ANDROIDSIMPLEBUFFERQUEUE,
403 &sys->playerBufferQueue);
404 CHECK_OPENSL_ERROR("Failed to get buff queue interface");
406 result = RegisterCallback(sys->playerBufferQueue, PlayedCallback,
408 CHECK_OPENSL_ERROR("Failed to register buff queue callback.");
410 // set the player's state to playing
411 result = SetPlayState(sys->playerPlay, SL_PLAYSTATE_PLAYING);
412 CHECK_OPENSL_ERROR("Failed to switch to playing state");
414 /* XXX: rounding shouldn't affect us at normal sampling rate */
415 sys->rate = fmt->i_rate;
416 sys->samples_per_buf = OPENSLES_BUFLEN * fmt->i_rate / 1000;
417 sys->buf = malloc(OPENSLES_BUFFERS * sys->samples_per_buf * bytesPerSample());
421 sys->started = false;
424 sys->p_buffer_chain = NULL;
425 sys->pp_buffer_last = &sys->p_buffer_chain;
428 // we want 16bit signed data native endian.
429 fmt->i_format = VLC_CODEC_S16N;
430 fmt->i_physical_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
432 SetPositionUpdatePeriod(sys->playerPlay, AOUT_MIN_PREPARE_TIME * 1000 / CLOCK_FREQ);
434 aout_FormatPrepare(fmt);
439 if (sys->playerObject) {
440 Destroy(sys->playerObject);
441 sys->playerObject = NULL;
447 static void Stop(audio_output_t *aout)
449 aout_sys_t *sys = aout->sys;
451 SetPlayState(sys->playerPlay, SL_PLAYSTATE_STOPPED);
452 //Flush remaining buffers if any.
453 Clear(sys->playerBufferQueue);
456 block_ChainRelease(sys->p_buffer_chain);
458 Destroy(sys->playerObject);
459 sys->playerObject = NULL;
462 /*****************************************************************************
464 *****************************************************************************/
465 static void Close(vlc_object_t *obj)
467 audio_output_t *aout = (audio_output_t *)obj;
468 aout_sys_t *sys = aout->sys;
470 Destroy(sys->outputMixObject);
471 Destroy(sys->engineObject);
472 dlclose(sys->p_so_handle);
473 vlc_mutex_destroy(&sys->lock);
477 static int Open (vlc_object_t *obj)
479 audio_output_t *aout = (audio_output_t *)obj;
483 aout->sys = sys = calloc(1, sizeof(*sys));
484 if (unlikely(sys == NULL))
487 sys->p_so_handle = dlopen("libOpenSLES.so", RTLD_NOW);
488 if (sys->p_so_handle == NULL)
490 msg_Err(aout, "Failed to load libOpenSLES");
494 sys->slCreateEnginePtr = dlsym(sys->p_so_handle, "slCreateEngine");
495 if (unlikely(sys->slCreateEnginePtr == NULL))
497 msg_Err(aout, "Failed to load symbol slCreateEngine");
501 #define OPENSL_DLSYM(dest, name) \
503 const SLInterfaceID *sym = dlsym(sys->p_so_handle, "SL_IID_"name); \
504 if (unlikely(sym == NULL)) \
506 msg_Err(aout, "Failed to load symbol SL_IID_"name); \
512 OPENSL_DLSYM(SL_IID_ANDROIDSIMPLEBUFFERQUEUE, "ANDROIDSIMPLEBUFFERQUEUE");
513 OPENSL_DLSYM(SL_IID_ENGINE, "ENGINE");
514 OPENSL_DLSYM(SL_IID_PLAY, "PLAY");
515 OPENSL_DLSYM(SL_IID_VOLUME, "VOLUME");
519 result = sys->slCreateEnginePtr(&sys->engineObject, 0, NULL, 0, NULL, NULL);
520 CHECK_OPENSL_ERROR("Failed to create engine");
522 // realize the engine in synchronous mode
523 result = Realize(sys->engineObject, SL_BOOLEAN_FALSE);
524 CHECK_OPENSL_ERROR("Failed to realize engine");
526 // get the engine interface, needed to create other objects
527 result = GetInterface(sys->engineObject, sys->SL_IID_ENGINE, &sys->engineEngine);
528 CHECK_OPENSL_ERROR("Failed to get the engine interface");
530 // create output mix, with environmental reverb specified as a non-required interface
531 const SLInterfaceID ids1[] = { sys->SL_IID_VOLUME };
532 const SLboolean req1[] = { SL_BOOLEAN_FALSE };
533 result = CreateOutputMix(sys->engineEngine, &sys->outputMixObject, 1, ids1, req1);
534 CHECK_OPENSL_ERROR("Failed to create output mix");
536 // realize the output mix in synchronous mode
537 result = Realize(sys->outputMixObject, SL_BOOLEAN_FALSE);
538 CHECK_OPENSL_ERROR("Failed to realize output mix");
540 vlc_mutex_init(&sys->lock);
544 aout->time_get = TimeGet;
548 aout->mute_set = MuteSet;
549 aout->volume_set = VolumeSet;
554 if (sys->outputMixObject)
555 Destroy(sys->outputMixObject);
556 if (sys->engineObject)
557 Destroy(sys->engineObject);
558 if (sys->p_so_handle)
559 dlclose(sys->p_so_handle);