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
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 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 General Public License for more details.
20 * You should have received a copy of the GNU 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>
40 #include <SLES/OpenSLES.h>
41 #include <SLES/OpenSLES_Android.h>
43 // Maximum number of buffers to enqueue.
46 #define Destroy(a) (*a)->Destroy(a);
47 #define SetPlayState(a, b) (*a)->SetPlayState(a, b)
48 #define RegisterCallback(a, b, c) (*a)->RegisterCallback(a, b, c)
49 #define GetInterface(a, b, c) (*a)->GetInterface(a, b, c)
50 #define Realize(a, b) (*a)->Realize(a, b)
51 #define CreateOutputMix(a, b, c, d, e) (*a)->CreateOutputMix(a, b, c, d, e)
52 #define CreateAudioPlayer(a, b, c, d, e, f, g) \
53 (*a)->CreateAudioPlayer(a, b, c, d, e, f, g)
54 #define Enqueue(a, b, c) (*a)->Enqueue(a, b, c)
55 #define Clear(a) (*a)->Clear(a)
56 #define GetState(a, b) (*a)->GetState(a, b)
58 /*****************************************************************************
59 * aout_sys_t: audio output method descriptor
60 *****************************************************************************
61 * This structure is part of the audio output thread descriptor.
62 * It describes the direct sound specific properties of an audio device.
63 *****************************************************************************/
66 SLObjectItf engineObject;
67 SLObjectItf outputMixObject;
68 SLAndroidSimpleBufferQueueItf playerBufferQueue;
69 SLObjectItf playerObject;
81 /*****************************************************************************
83 *****************************************************************************/
84 static int Open ( vlc_object_t * );
85 static void Close ( vlc_object_t * );
87 /*****************************************************************************
89 *****************************************************************************/
92 set_description( N_("OpenSLES audio output") )
93 set_shortname( N_("OpenSLES") )
94 set_category( CAT_AUDIO )
95 set_subcategory( SUBCAT_AUDIO_AOUT )
97 set_capability( "audio output", 170 )
98 add_shortcut( "opensles", "android" )
99 set_callbacks( Open, Close )
103 static void Clean( aout_sys_t *p_sys )
105 if( p_sys->playerObject )
106 Destroy( p_sys->playerObject );
107 if( p_sys->outputMixObject )
108 Destroy( p_sys->outputMixObject );
109 if( p_sys->engineObject )
110 Destroy( p_sys->engineObject );
112 if( p_sys->p_so_handle )
113 dlclose( p_sys->p_so_handle );
118 static void Flush(audio_output_t *p_aout, bool wait)
120 (void)wait; /* FIXME */
121 aout_sys_t *p_sys = p_aout->sys;
123 vlc_mutex_lock( &p_sys->lock );
124 SetPlayState( p_sys->playerPlay, SL_PLAYSTATE_STOPPED );
125 Clear( p_sys->playerBufferQueue );
126 SetPlayState( p_sys->playerPlay, SL_PLAYSTATE_PLAYING );
127 block_ChainRelease( p_sys->p_chain );
128 p_sys->p_chain = NULL;
129 p_sys->pp_last = &p_sys->p_chain;
130 vlc_mutex_unlock( &p_sys->lock );
133 static void Pause(audio_output_t *p_aout, bool pause, mtime_t date)
136 aout_sys_t *p_sys = p_aout->sys;
137 SetPlayState( p_sys->playerPlay,
138 pause ? SL_PLAYSTATE_PAUSED : SL_PLAYSTATE_PLAYING );
141 /*****************************************************************************
143 *****************************************************************************/
144 static void Play( audio_output_t *p_aout, block_t *p_buffer )
146 aout_sys_t *p_sys = p_aout->sys;
148 block_t **pp_last, *p_block;
150 SLAndroidSimpleBufferQueueState st;
151 SLresult res = GetState(p_sys->playerBufferQueue, &st);
152 if (unlikely(res != SL_RESULT_SUCCESS)) {
153 msg_Err(p_aout, "Could not query buffer queue state (%lu)", res);
157 if (!p_buffer->i_length) {
158 p_buffer->i_length = (mtime_t)(p_buffer->i_buffer / 2 / p_aout->format.i_channels) * CLOCK_FREQ / p_aout->format.i_rate;
161 vlc_mutex_lock( &p_sys->lock );
163 mtime_t delay = p_sys->length;
164 p_sys->length += p_buffer->i_length;
166 /* If something bad happens, we must remove this buffer from the FIFO */
167 pp_last = p_sys->pp_last;
170 block_ChainLastAppend( &p_sys->pp_last, p_buffer );
171 vlc_mutex_unlock( &p_sys->lock );
173 if (delay && st.count) {
174 aout_TimeReport(p_aout, p_buffer->i_pts - delay);
179 SLresult result = Enqueue( p_sys->playerBufferQueue, p_buffer->p_buffer,
180 p_buffer->i_buffer );
184 case SL_RESULT_BUFFER_INSUFFICIENT:
185 msg_Err( p_aout, "buffer insufficient");
189 // Wait a bit to retry.
190 // FIXME: buffer in aout_sys_t and retry at next Play() call
196 msg_Warn( p_aout, "Error %lu, dropping buffer", result );
197 vlc_mutex_lock( &p_sys->lock );
198 p_sys->pp_last = pp_last;
200 p_sys->length -= p_buffer->i_length;
201 vlc_mutex_unlock( &p_sys->lock );
202 block_Release( p_buffer );
203 case SL_RESULT_SUCCESS:
209 static void PlayedCallback (SLAndroidSimpleBufferQueueItf caller, void *pContext )
213 audio_output_t *p_aout = pContext;
214 aout_sys_t *p_sys = p_aout->sys;
216 assert (caller == p_sys->playerBufferQueue);
218 vlc_mutex_lock( &p_sys->lock );
220 p_block = p_sys->p_chain;
223 p_sys->p_chain = p_sys->p_chain->p_next;
224 /* if we exhausted our fifo, we must reset the pointer to the last
227 p_sys->pp_last = &p_sys->p_chain;
229 p_sys->length -= p_block->i_length;
231 vlc_mutex_unlock( &p_sys->lock );
233 block_Release( p_block );
235 /*****************************************************************************
237 *****************************************************************************/
238 static int Open( vlc_object_t *p_this )
240 audio_output_t *p_aout = (audio_output_t *)p_this;
242 SLEngineItf engineEngine;
244 /* Allocate structure */
245 p_aout->sys = calloc( 1, sizeof( aout_sys_t ) );
246 if( unlikely( p_aout->sys == NULL ) )
249 aout_sys_t *p_sys = p_aout->sys;
251 //Acquiring LibOpenSLES symbols :
252 p_sys->p_so_handle = dlopen( "libOpenSLES.so", RTLD_NOW );
253 if( p_sys->p_so_handle == NULL )
255 msg_Err( p_aout, "Failed to load libOpenSLES" );
259 typedef SLresult (*slCreateEngine_t)(
260 SLObjectItf*, SLuint32, const SLEngineOption*, SLuint32,
261 const SLInterfaceID*, const SLboolean* );
262 slCreateEngine_t slCreateEnginePtr = NULL;
264 SLInterfaceID *SL_IID_ENGINE;
265 SLInterfaceID *SL_IID_ANDROIDSIMPLEBUFFERQUEUE;
266 SLInterfaceID *SL_IID_VOLUME;
267 SLInterfaceID *SL_IID_PLAY;
269 #define OPENSL_DLSYM( dest, handle, name ) \
270 dest = dlsym( handle, name ); \
273 msg_Err( p_aout, "Failed to load symbol %s", name ); \
277 OPENSL_DLSYM( slCreateEnginePtr, p_sys->p_so_handle, "slCreateEngine" );
278 OPENSL_DLSYM( SL_IID_ANDROIDSIMPLEBUFFERQUEUE, p_sys->p_so_handle,
279 "SL_IID_ANDROIDSIMPLEBUFFERQUEUE" );
280 OPENSL_DLSYM( SL_IID_ENGINE, p_sys->p_so_handle, "SL_IID_ENGINE" );
281 OPENSL_DLSYM( SL_IID_PLAY, p_sys->p_so_handle, "SL_IID_PLAY" );
282 OPENSL_DLSYM( SL_IID_VOLUME, p_sys->p_so_handle, "SL_IID_VOLUME" );
285 #define CHECK_OPENSL_ERROR( msg ) \
286 if( unlikely( result != SL_RESULT_SUCCESS ) ) \
288 msg_Err( p_aout, msg" (%lu)", result ); \
293 result = slCreateEnginePtr( &p_sys->engineObject, 0, NULL, 0, NULL, NULL );
294 CHECK_OPENSL_ERROR( "Failed to create engine" );
296 // realize the engine in synchronous mode
297 result = Realize( p_sys->engineObject, SL_BOOLEAN_FALSE );
298 CHECK_OPENSL_ERROR( "Failed to realize engine" );
300 // get the engine interface, needed to create other objects
301 result = GetInterface( p_sys->engineObject, *SL_IID_ENGINE, &engineEngine );
302 CHECK_OPENSL_ERROR( "Failed to get the engine interface" );
304 // create output mix, with environmental reverb specified as a non-required interface
305 const SLInterfaceID ids1[] = { *SL_IID_VOLUME };
306 const SLboolean req1[] = { SL_BOOLEAN_FALSE };
307 result = CreateOutputMix( engineEngine, &p_sys->outputMixObject, 1, ids1, req1 );
308 CHECK_OPENSL_ERROR( "Failed to create output mix" );
310 // realize the output mix in synchronous mode
311 result = Realize( p_sys->outputMixObject, SL_BOOLEAN_FALSE );
312 CHECK_OPENSL_ERROR( "Failed to realize output mix" );
315 // configure audio source - this defines the number of samples you can enqueue.
316 SLDataLocator_AndroidSimpleBufferQueue loc_bufq = {
317 SL_DATALOCATOR_ANDROIDSIMPLEBUFFERQUEUE,
321 SLDataFormat_PCM format_pcm;
322 format_pcm.formatType = SL_DATAFORMAT_PCM;
323 format_pcm.numChannels = 2;
324 format_pcm.samplesPerSec = ((SLuint32) p_aout->format.i_rate * 1000) ;
325 format_pcm.bitsPerSample = SL_PCMSAMPLEFORMAT_FIXED_16;
326 format_pcm.containerSize = SL_PCMSAMPLEFORMAT_FIXED_16;
327 format_pcm.channelMask = SL_SPEAKER_FRONT_LEFT | SL_SPEAKER_FRONT_RIGHT;
328 format_pcm.endianness = SL_BYTEORDER_LITTLEENDIAN;
330 SLDataSource audioSrc = {&loc_bufq, &format_pcm};
332 // configure audio sink
333 SLDataLocator_OutputMix loc_outmix = {
334 SL_DATALOCATOR_OUTPUTMIX,
335 p_sys->outputMixObject
337 SLDataSink audioSnk = {&loc_outmix, NULL};
339 //create audio player
340 const SLInterfaceID ids2[] = { *SL_IID_ANDROIDSIMPLEBUFFERQUEUE };
341 static const SLboolean req2[] = { SL_BOOLEAN_TRUE };
342 result = CreateAudioPlayer( engineEngine, &p_sys->playerObject, &audioSrc,
343 &audioSnk, sizeof( ids2 ) / sizeof( *ids2 ),
345 CHECK_OPENSL_ERROR( "Failed to create audio player" );
347 result = Realize( p_sys->playerObject, SL_BOOLEAN_FALSE );
348 CHECK_OPENSL_ERROR( "Failed to realize player object." );
350 result = GetInterface( p_sys->playerObject, *SL_IID_PLAY, &p_sys->playerPlay );
351 CHECK_OPENSL_ERROR( "Failed to get player interface." );
353 result = GetInterface( p_sys->playerObject, *SL_IID_ANDROIDSIMPLEBUFFERQUEUE,
354 &p_sys->playerBufferQueue );
355 CHECK_OPENSL_ERROR( "Failed to get buff queue interface" );
357 result = RegisterCallback( p_sys->playerBufferQueue, PlayedCallback,
359 CHECK_OPENSL_ERROR( "Failed to register buff queue callback." );
362 // set the player's state to playing
363 result = SetPlayState( p_sys->playerPlay, SL_PLAYSTATE_PLAYING );
364 CHECK_OPENSL_ERROR( "Failed to switch to playing state" );
366 vlc_mutex_init( &p_sys->lock );
367 p_sys->p_chain = NULL;
368 p_sys->pp_last = &p_sys->p_chain;
370 // we want 16bit signed data little endian.
371 p_aout->format.i_format = VLC_CODEC_S16L;
372 p_aout->format.i_physical_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
373 p_aout->pf_play = Play;
374 p_aout->pf_pause = Pause;
375 p_aout->pf_flush = Flush;
377 aout_FormatPrepare( &p_aout->format );
385 /*****************************************************************************
387 *****************************************************************************/
388 static void Close( vlc_object_t *p_this )
390 audio_output_t *p_aout = (audio_output_t*)p_this;
391 aout_sys_t *p_sys = p_aout->sys;
393 SetPlayState( p_sys->playerPlay, SL_PLAYSTATE_STOPPED );
394 //Flush remaining buffers if any.
395 Clear( p_sys->playerBufferQueue );
396 block_ChainRelease( p_sys->p_chain );
397 vlc_mutex_destroy( &p_sys->lock );