git.sesse.net Git - vlc/blob - modules/audio_output/opensles_android.c

   1 /*****************************************************************************
   2  * opensles_android.c : audio output for android native code
   3  *****************************************************************************
   4  * Copyright © 2011-2012 VideoLAN
   5  *
   6  * Authors: Dominique Martinet <asmadeus@codewreck.org>
   7  *          Hugo Beauzée-Luyssen <beauze.h@gmail.com>
   8  *          Rafaël Carré <funman@videolanorg>
   9  *
  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.
  14  *
  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.
  19  *
  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  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28
  29 #ifdef HAVE_CONFIG_H
  30 # include "config.h"
  31 #endif
  32
  33 #include <vlc_common.h>
  34 #include <vlc_plugin.h>
  35 #include <vlc_aout.h>
  36 #include <assert.h>
  37 #include <dlfcn.h>
  38
  39 // For native audio
  40 #include <SLES/OpenSLES.h>
  41 #include <SLES/OpenSLES_Android.h>
  42
  43 // Maximum number of buffers to enqueue.
  44 #define BUFF_QUEUE  42
  45
  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)
  57
  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  *****************************************************************************/
  64 struct aout_sys_t
  65 {
  66     SLObjectItf                     engineObject;
  67     SLObjectItf                     outputMixObject;
  68     SLAndroidSimpleBufferQueueItf   playerBufferQueue;
  69     SLObjectItf                     playerObject;
  70
  71     SLPlayItf                       playerPlay;
  72
  73     vlc_mutex_t                     lock;
  74     block_t                        *p_chain;
  75     block_t                       **pp_last;
  76     mtime_t                         length;
  77
  78     void                           *p_so_handle;
  79     audio_sample_format_t           format;
  80 };
  81
  82 /*****************************************************************************
  83  * Local prototypes.
  84  *****************************************************************************/
  85 static int  Open        ( vlc_object_t * );
  86
  87 /*****************************************************************************
  88  * Module descriptor
  89  *****************************************************************************/
  90
  91 vlc_module_begin ()
  92     set_description( N_("OpenSLES audio output") )
  93     set_shortname( N_("OpenSLES") )
  94     set_category( CAT_AUDIO )
  95     set_subcategory( SUBCAT_AUDIO_AOUT )
  96
  97     set_capability( "audio output", 170 )
  98     add_shortcut( "opensles", "android" )
  99     set_callbacks( Open, NULL )
 100 vlc_module_end ()
 101
 102
 103 static void Clean( aout_sys_t *p_sys )
 104 {
 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 );
 111
 112     if( p_sys->p_so_handle )
 113         dlclose( p_sys->p_so_handle );
 114
 115     free( p_sys );
 116 }
 117
 118 static void Flush(audio_output_t *p_aout, bool wait)
 119 {
 120     (void)wait; /* FIXME */
 121     aout_sys_t *p_sys = p_aout->sys;
 122
 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 );
 131 }
 132
 133 static void Pause(audio_output_t *p_aout, bool pause, mtime_t date)
 134 {
 135     (void)date;
 136     aout_sys_t *p_sys = p_aout->sys;
 137     SetPlayState( p_sys->playerPlay,
 138         pause ? SL_PLAYSTATE_PAUSED : SL_PLAYSTATE_PLAYING );
 139 }
 140
 141 static int TimeGet(audio_output_t* p_aout, mtime_t* restrict drift)
 142 {
 143     aout_sys_t *p_sys = p_aout->sys;
 144     mtime_t delay = p_sys->length;
 145     SLAndroidSimpleBufferQueueState st;
 146     SLresult res = GetState(p_sys->playerBufferQueue, &st);
 147     if (unlikely(res != SL_RESULT_SUCCESS)) {
 148         msg_Err(p_aout, "Could not query buffer queue state in TimeGet (%lu)", res);
 149         return -1;
 150     }
 151
 152     *drift = (delay && st.count) ? delay : 0;
 153     return 0;
 154 }
 155
 156 /*****************************************************************************
 157  * Play: play a sound
 158  *****************************************************************************/
 159 static void Play( audio_output_t *p_aout, block_t *p_buffer )
 160 {
 161     aout_sys_t *p_sys = p_aout->sys;
 162     int tries = 5;
 163     block_t **pp_last, *p_block;
 164
 165     SLAndroidSimpleBufferQueueState st;
 166     SLresult res = GetState(p_sys->playerBufferQueue, &st);
 167     if (unlikely(res != SL_RESULT_SUCCESS)) {
 168         msg_Err(p_aout, "Could not query buffer queue state (%lu)", res);
 169         st.count = 0;
 170     }
 171
 172     if (!p_buffer->i_length) {
 173         p_buffer->i_length = (mtime_t)(p_buffer->i_buffer / 2 / p_sys->format.i_channels) * CLOCK_FREQ / p_sys->format.i_rate;
 174     }
 175
 176     vlc_mutex_lock( &p_sys->lock );
 177
 178     p_sys->length += p_buffer->i_length;
 179
 180     /* If something bad happens, we must remove this buffer from the FIFO */
 181     pp_last = p_sys->pp_last;
 182     p_block = *pp_last;
 183
 184     block_ChainLastAppend( &p_sys->pp_last, p_buffer );
 185     vlc_mutex_unlock( &p_sys->lock );
 186
 187     for (;;)
 188     {
 189         SLresult result = Enqueue( p_sys->playerBufferQueue, p_buffer->p_buffer,
 190                             p_buffer->i_buffer );
 191
 192         switch (result)
 193         {
 194         case SL_RESULT_BUFFER_INSUFFICIENT:
 195             msg_Err( p_aout, "buffer insufficient");
 196
 197             if (tries--)
 198             {
 199                 // Wait a bit to retry.
 200                 // FIXME: buffer in aout_sys_t and retry at next Play() call
 201                 msleep(CLOCK_FREQ);
 202                 continue;
 203             }
 204
 205         default:
 206             msg_Warn( p_aout, "Error %lu, dropping buffer", result );
 207             vlc_mutex_lock( &p_sys->lock );
 208             p_sys->pp_last = pp_last;
 209             *pp_last = p_block;
 210             p_sys->length -= p_buffer->i_length;
 211             vlc_mutex_unlock( &p_sys->lock );
 212             block_Release( p_buffer );
 213         case SL_RESULT_SUCCESS:
 214             return;
 215         }
 216     }
 217 }
 218
 219 static void PlayedCallback (SLAndroidSimpleBufferQueueItf caller, void *pContext )
 220 {
 221     (void)caller;
 222     block_t *p_block;
 223     audio_output_t *p_aout = pContext;
 224     aout_sys_t *p_sys = p_aout->sys;
 225
 226     assert (caller == p_sys->playerBufferQueue);
 227
 228     vlc_mutex_lock( &p_sys->lock );
 229
 230     p_block = p_sys->p_chain;
 231     assert( p_block );
 232
 233     p_sys->p_chain = p_sys->p_chain->p_next;
 234     /* if we exhausted our fifo, we must reset the pointer to the last
 235      * appended block */
 236     if (!p_sys->p_chain)
 237         p_sys->pp_last = &p_sys->p_chain;
 238
 239     p_sys->length -= p_block->i_length;
 240
 241     vlc_mutex_unlock( &p_sys->lock );
 242
 243     block_Release( p_block );
 244 }
 245 /*****************************************************************************
 246  * Open
 247  *****************************************************************************/
 248 static int Start( audio_output_t *p_aout, audio_sample_format_t *restrict fmt )
 249 {
 250     SLresult       result;
 251     SLEngineItf    engineEngine;
 252
 253     /* Allocate structure */
 254     p_aout->sys = calloc( 1, sizeof( aout_sys_t ) );
 255     if( unlikely( p_aout->sys == NULL ) )
 256         return VLC_ENOMEM;
 257
 258     aout_sys_t *p_sys = p_aout->sys;
 259
 260     //Acquiring LibOpenSLES symbols :
 261     p_sys->p_so_handle = dlopen( "libOpenSLES.so", RTLD_NOW );
 262     if( p_sys->p_so_handle == NULL )
 263     {
 264         msg_Err( p_aout, "Failed to load libOpenSLES" );
 265         goto error;
 266     }
 267
 268     typedef SLresult (*slCreateEngine_t)(
 269             SLObjectItf*, SLuint32, const SLEngineOption*, SLuint32,
 270             const SLInterfaceID*, const SLboolean* );
 271     slCreateEngine_t    slCreateEnginePtr = NULL;
 272
 273     SLInterfaceID *SL_IID_ENGINE;
 274     SLInterfaceID *SL_IID_ANDROIDSIMPLEBUFFERQUEUE;
 275     SLInterfaceID *SL_IID_VOLUME;
 276     SLInterfaceID *SL_IID_PLAY;
 277
 278 #define OPENSL_DLSYM( dest, handle, name )                   \
 279     dest = dlsym( handle, name );                            \
 280     if( dest == NULL )                                       \
 281     {                                                        \
 282         msg_Err( p_aout, "Failed to load symbol %s", name ); \
 283         goto error;                                          \
 284     }
 285
 286     OPENSL_DLSYM( slCreateEnginePtr, p_sys->p_so_handle, "slCreateEngine" );
 287     OPENSL_DLSYM( SL_IID_ANDROIDSIMPLEBUFFERQUEUE, p_sys->p_so_handle,
 288                  "SL_IID_ANDROIDSIMPLEBUFFERQUEUE" );
 289     OPENSL_DLSYM( SL_IID_ENGINE, p_sys->p_so_handle, "SL_IID_ENGINE" );
 290     OPENSL_DLSYM( SL_IID_PLAY, p_sys->p_so_handle, "SL_IID_PLAY" );
 291     OPENSL_DLSYM( SL_IID_VOLUME, p_sys->p_so_handle, "SL_IID_VOLUME" );
 292
 293
 294 #define CHECK_OPENSL_ERROR( msg )                   \
 295     if( unlikely( result != SL_RESULT_SUCCESS ) )   \
 296     {                                               \
 297         msg_Err( p_aout, msg" (%lu)", result );     \
 298         goto error;                                 \
 299     }
 300
 301     // create engine
 302     result = slCreateEnginePtr( &p_sys->engineObject, 0, NULL, 0, NULL, NULL );
 303     CHECK_OPENSL_ERROR( "Failed to create engine" );
 304
 305     // realize the engine in synchronous mode
 306     result = Realize( p_sys->engineObject, SL_BOOLEAN_FALSE );
 307     CHECK_OPENSL_ERROR( "Failed to realize engine" );
 308
 309     // get the engine interface, needed to create other objects
 310     result = GetInterface( p_sys->engineObject, *SL_IID_ENGINE, &engineEngine );
 311     CHECK_OPENSL_ERROR( "Failed to get the engine interface" );
 312
 313     // create output mix, with environmental reverb specified as a non-required interface
 314     const SLInterfaceID ids1[] = { *SL_IID_VOLUME };
 315     const SLboolean req1[] = { SL_BOOLEAN_FALSE };
 316     result = CreateOutputMix( engineEngine, &p_sys->outputMixObject, 1, ids1, req1 );
 317     CHECK_OPENSL_ERROR( "Failed to create output mix" );
 318
 319     // realize the output mix in synchronous mode
 320     result = Realize( p_sys->outputMixObject, SL_BOOLEAN_FALSE );
 321     CHECK_OPENSL_ERROR( "Failed to realize output mix" );
 322
 323
 324     // configure audio source - this defines the number of samples you can enqueue.
 325     SLDataLocator_AndroidSimpleBufferQueue loc_bufq = {
 326         SL_DATALOCATOR_ANDROIDSIMPLEBUFFERQUEUE,
 327         BUFF_QUEUE
 328     };
 329
 330     SLDataFormat_PCM format_pcm;
 331     format_pcm.formatType       = SL_DATAFORMAT_PCM;
 332     format_pcm.numChannels      = 2;
 333     format_pcm.samplesPerSec    = ((SLuint32) fmt->i_rate * 1000) ;
 334     format_pcm.bitsPerSample    = SL_PCMSAMPLEFORMAT_FIXED_16;
 335     format_pcm.containerSize    = SL_PCMSAMPLEFORMAT_FIXED_16;
 336     format_pcm.channelMask      = SL_SPEAKER_FRONT_LEFT | SL_SPEAKER_FRONT_RIGHT;
 337     format_pcm.endianness       = SL_BYTEORDER_LITTLEENDIAN;
 338
 339     SLDataSource audioSrc = {&loc_bufq, &format_pcm};
 340
 341     // configure audio sink
 342     SLDataLocator_OutputMix loc_outmix = {
 343         SL_DATALOCATOR_OUTPUTMIX,
 344         p_sys->outputMixObject
 345     };
 346     SLDataSink audioSnk = {&loc_outmix, NULL};
 347
 348     //create audio player
 349     const SLInterfaceID ids2[] = { *SL_IID_ANDROIDSIMPLEBUFFERQUEUE };
 350     static const SLboolean req2[] = { SL_BOOLEAN_TRUE };
 351     result = CreateAudioPlayer( engineEngine, &p_sys->playerObject, &audioSrc,
 352                                     &audioSnk, sizeof( ids2 ) / sizeof( *ids2 ),
 353                                     ids2, req2 );
 354     CHECK_OPENSL_ERROR( "Failed to create audio player" );
 355
 356     result = Realize( p_sys->playerObject, SL_BOOLEAN_FALSE );
 357     CHECK_OPENSL_ERROR( "Failed to realize player object." );
 358
 359     result = GetInterface( p_sys->playerObject, *SL_IID_PLAY, &p_sys->playerPlay );
 360     CHECK_OPENSL_ERROR( "Failed to get player interface." );
 361
 362     result = GetInterface( p_sys->playerObject, *SL_IID_ANDROIDSIMPLEBUFFERQUEUE,
 363                                                   &p_sys->playerBufferQueue );
 364     CHECK_OPENSL_ERROR( "Failed to get buff queue interface" );
 365
 366     result = RegisterCallback( p_sys->playerBufferQueue, PlayedCallback,
 367                                    (void*)p_aout);
 368     CHECK_OPENSL_ERROR( "Failed to register buff queue callback." );
 369
 370
 371     // set the player's state to playing
 372     result = SetPlayState( p_sys->playerPlay, SL_PLAYSTATE_PLAYING );
 373     CHECK_OPENSL_ERROR( "Failed to switch to playing state" );
 374
 375     vlc_mutex_init( &p_sys->lock );
 376     p_sys->p_chain = NULL;
 377     p_sys->pp_last = &p_sys->p_chain;
 378
 379     // we want 16bit signed data little endian.
 380     fmt->i_format              = VLC_CODEC_S16L;
 381     fmt->i_physical_channels   = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
 382     p_aout->play               = Play;
 383     p_aout->pause              = Pause;
 384     p_aout->flush               = Flush;
 385
 386     aout_FormatPrepare( fmt );
 387
 388     p_sys->format = *fmt;
 389
 390     return VLC_SUCCESS;
 391 error:
 392     Clean( p_sys );
 393     return VLC_EGENERIC;
 394 }
 395
 396 /*****************************************************************************
 397  * Close
 398  *****************************************************************************/
 399 static void Stop( audio_output_t *p_aout )
 400 {
 401     aout_sys_t     *p_sys = p_aout->sys;
 402
 403     SetPlayState( p_sys->playerPlay, SL_PLAYSTATE_STOPPED );
 404     //Flush remaining buffers if any.
 405     Clear( p_sys->playerBufferQueue );
 406     block_ChainRelease( p_sys->p_chain );
 407     vlc_mutex_destroy( &p_sys->lock );
 408     Clean( p_sys );
 409 }
 410
 411 static int Open (vlc_object_t *obj)
 412 {
 413     audio_output_t *aout = (audio_output_t *)obj;
 414
 415     /* FIXME: set volume/mute here */
 416     aout->start = Start;
 417     aout->stop = Stop;
 418     aout->time_get = TimeGet;
 419     return VLC_SUCCESS;
 420 }