1 /*****************************************************************************
2 * audiotrack.c: Android Java AudioTrack audio output module
3 *****************************************************************************
4 * Copyright © 2012-2015 VLC authors and VideoLAN, VideoLabs
6 * Authors: Thomas Guillem <thomas@gllm.fr>
7 * Ming Hu <tewilove@gmail.com>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
32 #include <sys/queue.h>
34 #include <vlc_atomic.h>
35 #include <vlc_common.h>
36 #include <vlc_plugin.h>
38 #include <vlc_threads.h>
40 /* Maximum VLC buffers queued by the internal queue in microseconds. This delay
41 * doesn't include audiotrack delay */
42 #define MAX_QUEUE_US INT64_C(1000000) // 1000ms
44 static int Open( vlc_object_t * );
45 static void Close( vlc_object_t * );
48 typedef TAILQ_HEAD(, thread_cmd) THREAD_CMD_QUEUE;
55 /* Owned by JNIThread */
56 jobject p_audiotrack; /* AudioTrack ref */
57 jobject p_audioTimestamp; /* AudioTimestamp ref */
58 jbyteArray p_bytearray; /* ByteArray ref (for Write) */
59 size_t i_bytearray_size; /* size of the ByteArray */
60 jobject p_bytebuffer; /* ByteBuffer ref (for WriteV21) */
61 audio_sample_format_t fmt; /* fmt setup by Start */
62 uint32_t i_pos_initial; /* initial position set by getPlaybackHeadPosition */
63 uint32_t i_samples_written; /* number of samples written since last flush */
64 uint32_t i_bytes_per_frame; /* byte per frame */
65 uint32_t i_max_audiotrack_samples;
66 mtime_t i_play_time; /* time when play was called */
67 bool b_audiotrack_exception; /* true if audiotrack throwed an exception */
69 /* JNIThread control */
74 /* Shared between two threads, must be locked */
75 bool b_thread_run; /* is thread alive */
76 THREAD_CMD_QUEUE thread_cmd_queue; /* thread cmd queue */
77 uint32_t i_samples_queued; /* number of samples queued */
80 /* Soft volume helper */
81 #include "audio_output/volume.h"
83 //#define AUDIOTRACK_USE_FLOAT
84 // TODO: activate getTimestamp for new android versions
85 //#define AUDIOTRACK_USE_TIMESTAMP
88 set_shortname( "AudioTrack" )
89 set_description( N_( "Android AudioTrack audio output" ) )
90 set_capability( "audio output", 180 )
91 set_category( CAT_AUDIO )
92 set_subcategory( SUBCAT_AUDIO_AOUT )
94 add_shortcut( "audiotrack" )
95 set_callbacks( Open, Close )
100 TAILQ_ENTRY(thread_cmd) next;
112 audio_sample_format_t *p_fmt;
128 audio_sample_format_t *p_fmt;
135 void ( *pf_destroy )( struct thread_cmd * );
138 #define THREAD_NAME "android_audiotrack"
140 extern int jni_attach_thread(JNIEnv **env, const char *thread_name);
141 extern void jni_detach_thread();
142 extern int jni_get_env(JNIEnv **env);
157 jmethodID getPlaybackHeadPosition;
158 jmethodID getTimestamp;
159 jmethodID getMinBufferSize;
160 jint STATE_INITIALIZED;
163 jint ERROR_BAD_VALUE;
164 jint ERROR_INVALID_OPERATION;
165 jint WRITE_NON_BLOCKING;
168 jint ENCODING_PCM_8BIT;
169 jint ENCODING_PCM_16BIT;
170 jint ENCODING_PCM_FLOAT;
171 bool has_ENCODING_PCM_FLOAT;
172 jint CHANNEL_OUT_MONO;
173 jint CHANNEL_OUT_STEREO;
176 jint ERROR_DEAD_OBJECT;
177 bool has_ERROR_DEAD_OBJECT;
183 jfieldID framePosition;
188 /* init all jni fields.
189 * Done only one time during the first initialisation */
191 InitJNIFields( audio_output_t *p_aout )
193 static vlc_mutex_t lock = VLC_STATIC_MUTEX;
194 static int i_init_state = -1;
195 bool ret, b_attached = false;
200 vlc_mutex_lock( &lock );
202 if( i_init_state != -1 )
205 if( jni_get_env(&env) < 0 )
207 jni_attach_thread( &env, THREAD_NAME );
216 #define CHECK_EXCEPTION( what, critical ) do { \
217 if( (*env)->ExceptionOccurred( env ) ) \
219 msg_Err( p_aout, "%s failed", what ); \
220 (*env)->ExceptionClear( env ); \
228 #define GET_CLASS( str, critical ) do { \
229 clazz = (*env)->FindClass( env, (str) ); \
230 CHECK_EXCEPTION( str, critical ); \
232 #define GET_ID( get, id, str, args, critical ) do { \
233 jfields.id = (*env)->get( env, clazz, (str), (args) ); \
234 CHECK_EXCEPTION( #get, critical ); \
236 #define GET_CONST_INT( id, str, critical ) do { \
238 field = (*env)->GetStaticFieldID( env, clazz, (str), "I" ); \
239 CHECK_EXCEPTION( #id, critical ); \
242 jfields.id = (*env)->GetStaticIntField( env, clazz, field ); \
243 CHECK_EXCEPTION( #id, critical ); \
247 /* AudioTrack class init */
248 GET_CLASS( "android/media/AudioTrack", true );
249 jfields.AudioTrack.clazz = (jclass) (*env)->NewGlobalRef( env, clazz );
250 CHECK_EXCEPTION( "NewGlobalRef", true );
252 GET_ID( GetMethodID, AudioTrack.ctor, "<init>", "(IIIIII)V", true );
253 GET_ID( GetMethodID, AudioTrack.release, "release", "()V", true );
254 GET_ID( GetMethodID, AudioTrack.getState, "getState", "()I", true );
255 GET_ID( GetMethodID, AudioTrack.play, "play", "()V", true );
256 GET_ID( GetMethodID, AudioTrack.stop, "stop", "()V", true );
257 GET_ID( GetMethodID, AudioTrack.flush, "flush", "()V", true );
258 GET_ID( GetMethodID, AudioTrack.pause, "pause", "()V", true );
260 GET_ID( GetMethodID, AudioTrack.writeV21, "write", "(Ljava/nio/ByteBuffer;II)I", false );
261 if( jfields.AudioTrack.writeV21 )
263 jfields.AudioTrack.write = NULL;
264 GET_CONST_INT( AudioTrack.WRITE_NON_BLOCKING, "WRITE_NON_BLOCKING", true );
266 GET_ID( GetMethodID, AudioTrack.write, "write", "([BII)I", true );
268 #ifdef AUDIOTRACK_USE_TIMESTAMP
269 GET_ID( GetMethodID, AudioTrack.getTimestamp,
270 "getTimestamp", "(Landroid/media/AudioTimestamp;)Z", false );
272 GET_ID( GetMethodID, AudioTrack.getPlaybackHeadPosition,
273 "getPlaybackHeadPosition", "()I", true );
275 GET_ID( GetStaticMethodID, AudioTrack.getMinBufferSize, "getMinBufferSize",
277 GET_CONST_INT( AudioTrack.STATE_INITIALIZED, "STATE_INITIALIZED", true );
278 GET_CONST_INT( AudioTrack.MODE_STREAM, "MODE_STREAM", true );
279 GET_CONST_INT( AudioTrack.ERROR, "ERROR", true );
280 GET_CONST_INT( AudioTrack.ERROR_BAD_VALUE , "ERROR_BAD_VALUE", true );
281 GET_CONST_INT( AudioTrack.ERROR_INVALID_OPERATION,
282 "ERROR_INVALID_OPERATION", true );
284 /* AudioTimestamp class init (if any) */
285 if( jfields.AudioTrack.getTimestamp )
287 GET_CLASS( "android/media/AudioTimestamp", true );
288 jfields.AudioTimestamp.clazz = (jclass) (*env)->NewGlobalRef( env,
290 CHECK_EXCEPTION( "NewGlobalRef", true );
292 GET_ID( GetMethodID, AudioTimestamp.ctor, "<init>", "()V", true );
293 GET_ID( GetFieldID, AudioTimestamp.framePosition,
294 "framePosition", "J", true );
295 GET_ID( GetFieldID, AudioTimestamp.nanoTime,
296 "nanoTime", "J", true );
299 jfields.AudioTimestamp.clazz = NULL;
300 jfields.AudioTimestamp.ctor = NULL;
301 jfields.AudioTimestamp.framePosition = NULL;
302 jfields.AudioTimestamp.nanoTime = NULL;
305 /* AudioFormat class init */
306 GET_CLASS( "android/media/AudioFormat", true );
307 GET_CONST_INT( AudioFormat.ENCODING_PCM_8BIT, "ENCODING_PCM_8BIT", true );
308 GET_CONST_INT( AudioFormat.ENCODING_PCM_16BIT, "ENCODING_PCM_16BIT", true );
309 #ifdef AUDIOTRACK_USE_FLOAT
310 GET_CONST_INT( AudioFormat.ENCODING_PCM_FLOAT, "ENCODING_PCM_FLOAT",
312 jfields.AudioFormat.has_ENCODING_PCM_FLOAT = field != NULL;
314 jfields.AudioFormat.has_ENCODING_PCM_FLOAT = false;
316 GET_CONST_INT( AudioFormat.CHANNEL_OUT_MONO, "CHANNEL_OUT_MONO", true );
317 GET_CONST_INT( AudioFormat.CHANNEL_OUT_STEREO, "CHANNEL_OUT_STEREO", true );
319 /* AudioManager class init */
320 GET_CLASS( "android/media/AudioManager", true );
321 GET_CONST_INT( AudioManager.ERROR_DEAD_OBJECT, "ERROR_DEAD_OBJECT", false );
322 jfields.AudioManager.has_ERROR_DEAD_OBJECT = field != NULL;
323 GET_CONST_INT( AudioManager.STREAM_MUSIC, "STREAM_MUSIC", true );
325 #undef CHECK_EXCEPTION
332 ret = i_init_state == 1;
334 msg_Err( p_aout, "AudioTrack jni init failed" );
337 vlc_mutex_unlock( &lock );
342 check_exception( JNIEnv *env, audio_output_t *p_aout,
345 if( (*env)->ExceptionOccurred( env ) )
347 aout_sys_t *p_sys = p_aout->sys;
349 p_sys->b_audiotrack_exception = true;
350 (*env)->ExceptionClear( env );
351 msg_Err( p_aout, "AudioTrack.%s triggered an exception !", method );
356 #define CHECK_AT_EXCEPTION( method ) check_exception( env, p_aout, method )
358 #define JNI_CALL( what, obj, method, ... ) (*env)->what( env, obj, method, ##__VA_ARGS__ )
360 #define JNI_CALL_INT( obj, method, ... ) JNI_CALL( CallIntMethod, obj, method, ##__VA_ARGS__ )
361 #define JNI_CALL_BOOL( obj, method, ... ) JNI_CALL( CallBooleanMethod, obj, method, ##__VA_ARGS__ )
362 #define JNI_CALL_VOID( obj, method, ... ) JNI_CALL( CallVoidMethod, obj, method, ##__VA_ARGS__ )
363 #define JNI_CALL_STATIC_INT( clazz, method, ... ) JNI_CALL( CallStaticIntMethod, clazz, method, ##__VA_ARGS__ )
365 #define JNI_AT_NEW( ... ) JNI_CALL( NewObject, jfields.AudioTrack.clazz, jfields.AudioTrack.ctor, ##__VA_ARGS__ )
366 #define JNI_AT_CALL_INT( method, ... ) JNI_CALL_INT( p_sys->p_audiotrack, jfields.AudioTrack.method, ##__VA_ARGS__ )
367 #define JNI_AT_CALL_BOOL( method, ... ) JNI_CALL_BOOL( p_sys->p_audiotrack, jfields.AudioTrack.method, ##__VA_ARGS__ )
368 #define JNI_AT_CALL_VOID( method, ... ) JNI_CALL_VOID( p_sys->p_audiotrack, jfields.AudioTrack.method, ##__VA_ARGS__ )
369 #define JNI_AT_CALL_STATIC_INT( method, ... ) JNI_CALL( CallStaticIntMethod, jfields.AudioTrack.clazz, jfields.AudioTrack.method, ##__VA_ARGS__ )
371 #define JNI_AUDIOTIMESTAMP_GET_LONG( field ) JNI_CALL( GetLongField, p_sys->p_audioTimestamp, jfields.AudioTimestamp.field )
373 static inline mtime_t
374 frames_to_us( aout_sys_t *p_sys, uint32_t i_nb_frames )
376 return i_nb_frames * CLOCK_FREQ / p_sys->fmt.i_rate;
378 #define FRAMES_TO_US(x) frames_to_us( p_sys, (x) )
380 static struct thread_cmd *
381 ThreadCmd_New( int id )
383 struct thread_cmd *p_cmd = calloc( 1, sizeof(struct thread_cmd) );
392 ThreadCmd_InsertHead( aout_sys_t *p_sys, struct thread_cmd *p_cmd )
394 TAILQ_INSERT_HEAD( &p_sys->thread_cmd_queue, p_cmd, next);
395 vlc_cond_signal( &p_sys->cond );
399 ThreadCmd_InsertTail( aout_sys_t *p_sys, struct thread_cmd *p_cmd )
401 TAILQ_INSERT_TAIL( &p_sys->thread_cmd_queue, p_cmd, next);
402 vlc_cond_signal( &p_sys->cond );
406 ThreadCmd_Wait( aout_sys_t *p_sys, struct thread_cmd *p_cmd )
408 while( p_cmd->id != CMD_DONE )
409 vlc_cond_wait( &p_sys->cond, &p_sys->mutex );
411 return p_cmd->id == CMD_DONE;
415 ThreadCmd_FlushQueue( aout_sys_t *p_sys )
417 struct thread_cmd *p_cmd, *p_cmd_next;
419 for ( p_cmd = TAILQ_FIRST( &p_sys->thread_cmd_queue );
420 p_cmd != NULL; p_cmd = p_cmd_next )
422 p_cmd_next = TAILQ_NEXT( p_cmd, next );
423 TAILQ_REMOVE( &p_sys->thread_cmd_queue, p_cmd, next );
424 if( p_cmd->pf_destroy )
425 p_cmd->pf_destroy( p_cmd );
430 JNIThread_InitDelay( JNIEnv *env, audio_output_t *p_aout )
432 aout_sys_t *p_sys = p_aout->sys;
434 if( p_sys->p_audiotrack )
435 p_sys->i_pos_initial = JNI_AT_CALL_INT( getPlaybackHeadPosition );
437 p_sys->i_pos_initial = 0;
439 /* HACK: On some broken devices, head position is still moving after a
440 * flush or a stop. So, wait for the head position to be stabilized. */
441 if( unlikely( p_sys->i_pos_initial != 0 ) )
445 i_last_pos = p_sys->i_pos_initial;
447 p_sys->i_pos_initial = JNI_AT_CALL_INT( getPlaybackHeadPosition );
448 } while( p_sys->i_pos_initial != i_last_pos );
450 p_sys->i_samples_written = 0;
451 p_sys->i_samples_queued = 0;
455 JNIThread_GetAudioTrackPos( JNIEnv *env, audio_output_t *p_aout )
457 aout_sys_t *p_sys = p_aout->sys;
460 * getPlaybackHeadPosition: Returns the playback head position expressed in
461 * frames. Though the "int" type is signed 32-bits, the value should be
462 * reinterpreted as if it is unsigned 32-bits. That is, the next position
463 * after 0x7FFFFFFF is (int) 0x80000000. This is a continuously advancing
464 * counter. It will wrap (overflow) periodically, for example approximately
465 * once every 27:03:11 hours:minutes:seconds at 44.1 kHz. It is reset to
466 * zero by flush(), reload(), and stop().
469 return JNI_AT_CALL_INT( getPlaybackHeadPosition ) - p_sys->i_pos_initial;
473 JNIThread_TimeGet( JNIEnv *env, audio_output_t *p_aout, mtime_t *p_delay )
475 aout_sys_t *p_sys = p_aout->sys;
477 uint32_t i_audiotrack_delay = 0;
479 if( p_sys->i_samples_queued == 0 )
481 if( p_sys->p_audioTimestamp )
483 mtime_t i_current_time = mdate();
485 * getTimestamp: Poll for a timestamp on demand.
487 * If you need to track timestamps during initial warmup or after a
488 * routing or mode change, you should request a new timestamp once per
489 * second until the reported timestamps show that the audio clock is
490 * stable. Thereafter, query for a new timestamp approximately once
491 * every 10 seconds to once per minute. Calling this method more often
492 * is inefficient. It is also counter-productive to call this method
493 * more often than recommended, because the short-term differences
494 * between successive timestamp reports are not meaningful. If you need
495 * a high-resolution mapping between frame position and presentation
496 * time, consider implementing that at application level, based on
497 * low-resolution timestamps.
500 if( JNI_AT_CALL_BOOL( getTimestamp, p_sys->p_audioTimestamp ) )
502 jlong i_frame_time = JNI_AUDIOTIMESTAMP_GET_LONG( nanoTime ) / 1000;
503 /* frame time should be after last play time
504 * frame time shouldn't be in the future
505 * frame time should be less than 10 seconds old */
506 if( i_frame_time > p_sys->i_play_time
507 && i_current_time > i_frame_time
508 && ( i_current_time - i_frame_time ) <= INT64_C(10000000) )
510 jlong i_time_diff = i_current_time - i_frame_time;
511 jlong i_frames_diff = i_time_diff * p_sys->fmt.i_rate
513 i_frame_pos = JNI_AUDIOTIMESTAMP_GET_LONG( framePosition )
515 if( p_sys->i_samples_written > i_frame_pos )
516 i_audiotrack_delay = p_sys->i_samples_written - i_frame_pos;
520 if( i_audiotrack_delay == 0 )
522 uint32_t i_audiotrack_pos = JNIThread_GetAudioTrackPos( env, p_aout );
524 if( p_sys->i_samples_written > i_audiotrack_pos )
525 i_audiotrack_delay = p_sys->i_samples_written - i_audiotrack_pos;
528 if( i_audiotrack_delay > 0 )
530 *p_delay = FRAMES_TO_US( p_sys->i_samples_queued + i_audiotrack_delay );
537 JNIThread_Start( JNIEnv *env, audio_output_t *p_aout )
539 struct aout_sys_t *p_sys = p_aout->sys;
540 int i_size, i_min_buffer_size, i_channel_config, i_rate, i_format,
541 i_format_size, i_nb_channels;
542 jobject p_audiotrack;
544 /* 4000 <= frequency <= 48000 */
545 i_rate = p_sys->fmt.i_rate;
551 /* We can only accept U8, S16N, and FL32 (depending on Android version) */
552 if( p_sys->fmt.i_format != VLC_CODEC_U8
553 && p_sys->fmt.i_format != VLC_CODEC_S16N
554 && p_sys->fmt.i_format != VLC_CODEC_FL32 )
555 p_sys->fmt.i_format = VLC_CODEC_S16N;
557 if( p_sys->fmt.i_format == VLC_CODEC_FL32
558 && !jfields.AudioFormat.has_ENCODING_PCM_FLOAT )
559 p_sys->fmt.i_format = VLC_CODEC_S16N;
561 if( p_sys->fmt.i_format == VLC_CODEC_S16N )
563 i_format = jfields.AudioFormat.ENCODING_PCM_16BIT;
565 } else if( p_sys->fmt.i_format == VLC_CODEC_FL32 )
567 i_format = jfields.AudioFormat.ENCODING_PCM_FLOAT;
571 i_format = jfields.AudioFormat.ENCODING_PCM_8BIT;
574 p_sys->fmt.i_original_channels = p_sys->fmt.i_physical_channels;
576 i_nb_channels = aout_FormatNbChannels( &p_sys->fmt );
577 switch( i_nb_channels )
580 i_channel_config = jfields.AudioFormat.CHANNEL_OUT_MONO;
581 p_sys->fmt.i_physical_channels = AOUT_CHAN_CENTER;
584 i_nb_channels = 2; // XXX: AudioTrack handle only stereo for now
586 i_channel_config = jfields.AudioFormat.CHANNEL_OUT_STEREO;
587 p_sys->fmt.i_physical_channels = AOUT_CHANS_STEREO;
591 i_min_buffer_size = JNI_AT_CALL_STATIC_INT( getMinBufferSize, i_rate,
592 i_channel_config, i_format );
593 if( i_min_buffer_size <= 0 )
595 msg_Warn( p_aout, "getMinBufferSize returned an invalid size" ) ;
596 /* use a defaut min buffer size (shouldn't happen) */
597 i_min_buffer_size = i_nb_channels * i_format_size * 2048;
600 i_size = i_min_buffer_size * 4;
601 p_sys->i_bytes_per_frame = i_nb_channels * i_format_size;
602 p_sys->i_max_audiotrack_samples = i_size / p_sys->i_bytes_per_frame;
604 /* create AudioTrack object */
605 p_audiotrack = JNI_AT_NEW( jfields.AudioManager.STREAM_MUSIC, i_rate,
606 i_channel_config, i_format, i_size,
607 jfields.AudioTrack.MODE_STREAM );
608 if( CHECK_AT_EXCEPTION( "AudioTrack<init>" ) || !p_audiotrack )
610 p_sys->p_audiotrack = (*env)->NewGlobalRef( env, p_audiotrack );
611 (*env)->DeleteLocalRef( env, p_audiotrack );
612 if( !p_sys->p_audiotrack )
614 if( JNI_AT_CALL_INT( getState ) != jfields.AudioTrack.STATE_INITIALIZED )
616 msg_Err( p_aout, "AudioTrack init failed" );
620 if( jfields.AudioTimestamp.clazz )
622 /* create AudioTimestamp object */
623 jobject p_audioTimestamp = JNI_CALL( NewObject,
624 jfields.AudioTimestamp.clazz,
625 jfields.AudioTimestamp.ctor );
626 if( !p_audioTimestamp )
628 p_sys->p_audioTimestamp = (*env)->NewGlobalRef( env, p_audioTimestamp );
629 (*env)->DeleteLocalRef( env, p_audioTimestamp );
630 if( !p_sys->p_audioTimestamp )
634 p_sys->fmt.i_rate = i_rate;
636 JNI_AT_CALL_VOID( play );
637 CHECK_AT_EXCEPTION( "play" );
638 p_sys->i_play_time = mdate();
642 if( p_sys->p_audiotrack )
644 JNI_AT_CALL_VOID( release );
645 (*env)->DeleteGlobalRef( env, p_sys->p_audiotrack );
646 p_sys->p_audiotrack = NULL;
652 JNIThread_Stop( JNIEnv *env, audio_output_t *p_aout )
654 aout_sys_t *p_sys = p_aout->sys;
656 if( !p_sys->b_audiotrack_exception )
658 JNI_AT_CALL_VOID( stop );
659 if( !CHECK_AT_EXCEPTION( "stop" ) )
660 JNI_AT_CALL_VOID( release );
662 p_sys->b_audiotrack_exception = false;
663 (*env)->DeleteGlobalRef( env, p_sys->p_audiotrack );
664 p_sys->p_audiotrack = NULL;
666 if( p_sys->p_audioTimestamp )
668 (*env)->DeleteGlobalRef( env, p_sys->p_audioTimestamp );
669 p_sys->p_audioTimestamp = NULL;
674 * Non blocking write function.
675 * Do a calculation between current position and audiotrack position and assure
676 * that we won't wait in AudioTrack.write() method
679 JNIThread_Write( JNIEnv *env, audio_output_t *p_aout, block_t *p_buffer )
681 aout_sys_t *p_sys = p_aout->sys;
682 uint8_t *p_data = p_buffer->p_buffer;
685 uint32_t i_audiotrack_pos;
686 uint32_t i_samples_pending;
688 i_audiotrack_pos = JNIThread_GetAudioTrackPos( env, p_aout );
689 if( i_audiotrack_pos > p_sys->i_samples_written )
691 msg_Warn( p_aout, "audiotrack position is ahead. Should NOT happen" );
692 JNIThread_InitDelay( env, p_aout );
695 i_samples_pending = p_sys->i_samples_written - i_audiotrack_pos;
697 /* check if audiotrack buffer is not full before writing on it. */
698 if( i_samples_pending >= p_sys->i_max_audiotrack_samples )
700 i_samples = __MIN( p_sys->i_max_audiotrack_samples - i_samples_pending,
701 p_buffer->i_nb_samples );
703 i_data = i_samples * p_sys->i_bytes_per_frame;
705 /* check if we need to realloc a ByteArray */
706 if( i_data > p_sys->i_bytearray_size )
708 jbyteArray p_bytearray;
710 if( p_sys->p_bytearray )
712 (*env)->DeleteGlobalRef( env, p_sys->p_bytearray );
713 p_sys->p_bytearray = NULL;
716 p_bytearray = (*env)->NewByteArray( env, i_data );
719 p_sys->p_bytearray = (*env)->NewGlobalRef( env, p_bytearray );
720 (*env)->DeleteLocalRef( env, p_bytearray );
722 p_sys->i_bytearray_size = i_data;
724 if( !p_sys->p_bytearray )
725 return jfields.AudioTrack.ERROR_BAD_VALUE;
727 /* copy p_buffer in to ByteArray */
728 (*env)->SetByteArrayRegion( env, p_sys->p_bytearray, 0, i_data,
731 return JNI_AT_CALL_INT( write, p_sys->p_bytearray, 0, i_data );
735 * JNIThread_Write doesn't always work on Lollipop. Probably because audiotrack
736 * buffer size is bigger than the one we pass in ctor arguments (and there is
737 * no way to know it). It's not an issue since there is a new write method that
741 JNIThread_WriteV21( JNIEnv *env, audio_output_t *p_aout, block_t *p_buffer )
743 aout_sys_t *p_sys = p_aout->sys;
746 if( !p_sys->p_bytebuffer )
748 jobject p_bytebuffer;
750 p_bytebuffer = (*env)->NewDirectByteBuffer( env, p_buffer->p_buffer,
751 p_buffer->i_buffer );
753 return jfields.AudioTrack.ERROR_BAD_VALUE;
755 p_sys->p_bytebuffer = (*env)->NewGlobalRef( env, p_bytebuffer );
756 (*env)->DeleteLocalRef( env, p_bytebuffer );
758 if( !p_sys->p_bytebuffer || (*env)->ExceptionOccurred( env ) )
760 p_sys->p_bytebuffer = NULL;
761 (*env)->ExceptionClear( env );
762 return jfields.AudioTrack.ERROR_BAD_VALUE;
766 i_ret = JNI_AT_CALL_INT( writeV21, p_sys->p_bytebuffer, p_buffer->i_buffer,
767 jfields.AudioTrack.WRITE_NON_BLOCKING );
770 /* don't delete the bytebuffer if we wrote nothing, keep it for next
772 (*env)->DeleteGlobalRef( env, p_sys->p_bytebuffer );
773 p_sys->p_bytebuffer = NULL;
779 JNIThread_Play( JNIEnv *env, audio_output_t *p_aout,
780 block_t **pp_buffer, mtime_t *p_wait )
782 aout_sys_t *p_sys = p_aout->sys;
783 block_t *p_buffer = *pp_buffer;
786 if( jfields.AudioTrack.writeV21 )
787 i_ret = JNIThread_WriteV21( env, p_aout, p_buffer );
789 i_ret = JNIThread_Write( env, p_aout, p_buffer );
792 if( jfields.AudioManager.has_ERROR_DEAD_OBJECT
793 && i_ret == jfields.AudioManager.ERROR_DEAD_OBJECT )
795 msg_Warn( p_aout, "ERROR_DEAD_OBJECT: "
796 "try recreating AudioTrack" );
797 JNIThread_Stop( env, p_aout );
798 i_ret = JNIThread_Start( env, p_aout );
802 if( i_ret == jfields.AudioTrack.ERROR_INVALID_OPERATION )
803 str = "ERROR_INVALID_OPERATION";
804 else if( i_ret == jfields.AudioTrack.ERROR_BAD_VALUE )
805 str = "ERROR_BAD_VALUE";
808 msg_Err( p_aout, "Write failed: %s", str );
810 } else if( i_ret == 0 )
812 /* audiotrack internal buffer is full, wait a little: between 10ms and
813 * 20ms depending on devices or rate */
814 *p_wait = FRAMES_TO_US( p_sys->i_max_audiotrack_samples / 20 );
817 uint32_t i_samples = i_ret / p_sys->i_bytes_per_frame;
818 p_sys->i_samples_queued -= i_samples;
819 p_sys->i_samples_written += i_samples;
821 p_buffer->p_buffer += i_ret;
822 p_buffer->i_buffer -= i_ret;
823 p_buffer->i_nb_samples -= i_samples;
824 if( p_buffer->i_buffer == 0 )
828 return i_ret >= 0 ? VLC_SUCCESS : VLC_EGENERIC;
832 JNIThread_Pause( JNIEnv *env, audio_output_t *p_aout,
833 bool b_pause, mtime_t i_date )
835 VLC_UNUSED( i_date );
837 aout_sys_t *p_sys = p_aout->sys;
841 JNI_AT_CALL_VOID( pause );
842 CHECK_AT_EXCEPTION( "pause" );
845 JNI_AT_CALL_VOID( play );
846 CHECK_AT_EXCEPTION( "play" );
847 p_sys->i_play_time = mdate();
852 JNIThread_Flush( JNIEnv *env, audio_output_t *p_aout,
855 aout_sys_t *p_sys = p_aout->sys;
858 * stop(): Stops playing the audio data. When used on an instance created
859 * in MODE_STREAM mode, audio will stop playing after the last buffer that
860 * was written has been played. For an immediate stop, use pause(),
861 * followed by flush() to discard audio data that hasn't been played back
864 * flush(): Flushes the audio data currently queued for playback. Any data
865 * that has not been played back will be discarded. No-op if not stopped
866 * or paused, or if the track's creation mode is not MODE_STREAM.
870 JNI_AT_CALL_VOID( stop );
871 if( CHECK_AT_EXCEPTION( "stop" ) )
875 JNI_AT_CALL_VOID( pause );
876 if( CHECK_AT_EXCEPTION( "pause" ) )
878 JNI_AT_CALL_VOID( flush );
880 JNI_AT_CALL_VOID( play );
881 CHECK_AT_EXCEPTION( "play" );
882 p_sys->i_play_time = mdate();
884 if( p_sys->p_bytebuffer )
886 (*env)->DeleteGlobalRef( env, p_sys->p_bytebuffer );
887 p_sys->p_bytebuffer = NULL;
892 JNIThread( void *data )
894 audio_output_t *p_aout = data;
895 aout_sys_t *p_sys = p_aout->sys;
896 bool b_error = false;
897 bool b_paused = false;
898 block_t *p_buffer = NULL;
899 mtime_t i_play_deadline = 0;
902 jni_attach_thread( &env, THREAD_NAME );
904 vlc_mutex_lock( &p_sys->mutex );
908 while( p_sys->b_thread_run )
910 struct thread_cmd *p_cmd;
911 bool b_remove_cmd = true;
913 /* wait to process a command */
914 while( ( p_cmd = TAILQ_FIRST( &p_sys->thread_cmd_queue ) ) == NULL
915 && p_sys->b_thread_run )
916 vlc_cond_wait( &p_sys->cond, &p_sys->mutex );
918 if( !p_sys->b_thread_run || p_cmd == NULL )
921 if( b_paused && p_cmd->id == CMD_PLAY )
923 vlc_cond_wait( &p_sys->cond, &p_sys->mutex );
927 if( p_cmd->id == CMD_PLAY && i_play_deadline > 0 )
929 if( mdate() > i_play_deadline )
934 while( p_cmd == TAILQ_FIRST( &p_sys->thread_cmd_queue )
935 && i_ret != ETIMEDOUT && p_sys->b_thread_run )
936 i_ret = vlc_cond_timedwait( &p_sys->cond, &p_sys->mutex,
942 /* process a command */
946 assert( !p_sys->p_audiotrack );
948 p_cmd->out.start.i_ret = -1;
951 p_sys->fmt = *p_cmd->in.start.p_fmt;
952 p_cmd->out.start.i_ret =
953 JNIThread_Start( env, p_aout );
954 JNIThread_InitDelay( env, p_aout );
955 p_cmd->out.start.p_fmt = &p_sys->fmt;
959 assert( p_sys->p_audiotrack );
960 JNIThread_Stop( env, p_aout );
961 JNIThread_InitDelay( env, p_aout );
968 mtime_t i_play_wait = 0;
970 assert( p_sys->p_audiotrack );
973 if( p_buffer == NULL )
974 p_buffer = p_cmd->in.play.p_buffer;
975 b_error = JNIThread_Play( env, p_aout, &p_buffer,
976 &i_play_wait ) != VLC_SUCCESS;
977 if( p_buffer != NULL )
978 b_remove_cmd = false;
979 if( i_play_wait > 0 )
980 i_play_deadline = mdate() + i_play_wait;
984 assert( p_sys->p_audiotrack );
987 JNIThread_Pause( env, p_aout,
988 p_cmd->in.pause.b_pause,
989 p_cmd->in.pause.i_date );
990 b_paused = p_cmd->in.pause.b_pause;
993 assert( p_sys->p_audiotrack );
996 p_cmd->out.time_get.i_ret =
997 JNIThread_TimeGet( env, p_aout,
998 &p_cmd->out.time_get.i_delay );
1001 assert( p_sys->p_audiotrack );
1004 JNIThread_Flush( env, p_aout,
1005 p_cmd->in.flush.b_wait );
1006 JNIThread_InitDelay( env, p_aout );
1010 vlc_assert_unreachable();
1012 if( p_sys->b_audiotrack_exception )
1017 TAILQ_REMOVE( &p_sys->thread_cmd_queue, p_cmd, next );
1018 p_cmd->id = CMD_DONE;
1019 if( p_cmd->pf_destroy )
1020 p_cmd->pf_destroy( p_cmd );
1023 /* signal that command is processed */
1024 vlc_cond_signal( &p_sys->cond );
1029 if( p_sys->p_bytearray )
1030 (*env)->DeleteGlobalRef( env, p_sys->p_bytearray );
1031 if( p_sys->p_bytebuffer )
1032 (*env)->DeleteGlobalRef( env, p_sys->p_bytebuffer );
1033 jni_detach_thread();
1035 vlc_mutex_unlock( &p_sys->mutex );
1040 Start( audio_output_t *p_aout, audio_sample_format_t *restrict p_fmt )
1042 int i_ret = VLC_EGENERIC;
1043 struct thread_cmd *p_cmd;
1044 aout_sys_t *p_sys = p_aout->sys;
1046 vlc_mutex_lock( &p_sys->mutex );
1048 p_cmd = ThreadCmd_New( CMD_START );
1051 /* ask the thread to process the Start command */
1052 p_cmd->in.start.p_fmt = p_fmt;
1054 ThreadCmd_InsertHead( p_sys, p_cmd );
1055 if( ThreadCmd_Wait( p_sys, p_cmd ) )
1057 i_ret = p_cmd->out.start.i_ret;
1058 if( i_ret == VLC_SUCCESS )
1059 *p_fmt = *p_cmd->out.start.p_fmt;
1064 vlc_mutex_unlock( &p_sys->mutex );
1066 if( i_ret == VLC_SUCCESS )
1067 aout_SoftVolumeStart( p_aout );
1073 Stop( audio_output_t *p_aout )
1075 aout_sys_t *p_sys = p_aout->sys;
1076 struct thread_cmd *p_cmd;
1078 vlc_mutex_lock( &p_sys->mutex );
1080 ThreadCmd_FlushQueue( p_sys );
1082 p_cmd = ThreadCmd_New( CMD_STOP );
1085 /* ask the thread to process the Stop command */
1086 ThreadCmd_InsertHead( p_sys, p_cmd );
1087 ThreadCmd_Wait( p_sys, p_cmd );
1092 vlc_mutex_unlock( &p_sys->mutex );
1096 PlayCmd_Destroy( struct thread_cmd *p_cmd )
1098 block_Release( p_cmd->in.play.p_buffer );
1103 Play( audio_output_t *p_aout, block_t *p_buffer )
1105 aout_sys_t *p_sys = p_aout->sys;
1106 struct thread_cmd *p_cmd;
1108 vlc_mutex_lock( &p_sys->mutex );
1110 while( p_sys->i_samples_queued != 0
1111 && FRAMES_TO_US( p_sys->i_samples_queued +
1112 p_buffer->i_nb_samples ) >= MAX_QUEUE_US )
1113 vlc_cond_wait( &p_sys->cond, &p_sys->mutex );
1115 p_cmd = ThreadCmd_New( CMD_PLAY );
1118 /* ask the thread to process the Play command */
1119 p_cmd->in.play.p_buffer = p_buffer;
1120 p_cmd->pf_destroy = PlayCmd_Destroy;
1122 ThreadCmd_InsertTail( p_sys, p_cmd );
1124 p_sys->i_samples_queued += p_buffer->i_nb_samples;
1126 block_Release( p_cmd->in.play.p_buffer );
1128 vlc_mutex_unlock( &p_sys->mutex );
1132 Pause( audio_output_t *p_aout, bool b_pause, mtime_t i_date )
1134 aout_sys_t *p_sys = p_aout->sys;
1135 struct thread_cmd *p_cmd;
1137 vlc_mutex_lock( &p_sys->mutex );
1139 p_cmd = ThreadCmd_New( CMD_PAUSE );
1142 /* ask the thread to process the Pause command */
1143 p_cmd->in.pause.b_pause = b_pause;
1144 p_cmd->in.pause.i_date = i_date;
1146 ThreadCmd_InsertHead( p_sys, p_cmd );
1147 ThreadCmd_Wait( p_sys, p_cmd );
1152 vlc_mutex_unlock( &p_sys->mutex );
1156 Flush( audio_output_t *p_aout, bool b_wait )
1158 aout_sys_t *p_sys = p_aout->sys;
1159 struct thread_cmd *p_cmd;
1161 vlc_mutex_lock( &p_sys->mutex );
1163 ThreadCmd_FlushQueue( p_sys );
1165 p_cmd = ThreadCmd_New( CMD_FLUSH );
1168 /* ask the thread to process the Flush command */
1169 p_cmd->in.flush.b_wait = b_wait;
1171 ThreadCmd_InsertHead( p_sys, p_cmd );
1172 ThreadCmd_Wait( p_sys, p_cmd );
1177 vlc_mutex_unlock( &p_sys->mutex );
1181 TimeGet( audio_output_t *p_aout, mtime_t *restrict p_delay )
1183 aout_sys_t *p_sys = p_aout->sys;
1184 struct thread_cmd *p_cmd;
1187 vlc_mutex_lock( &p_sys->mutex );
1189 p_cmd = ThreadCmd_New( CMD_TIME_GET );
1192 ThreadCmd_InsertHead( p_sys, p_cmd );
1193 ThreadCmd_Wait( p_sys, p_cmd );
1195 i_ret = p_cmd->out.time_get.i_ret;
1196 *p_delay = p_cmd->out.time_get.i_delay;
1200 vlc_mutex_unlock( &p_sys->mutex );
1207 Open( vlc_object_t *obj )
1209 audio_output_t *p_aout = (audio_output_t *) obj;
1212 if( !InitJNIFields( p_aout ) )
1213 return VLC_EGENERIC;
1215 p_sys = calloc( 1, sizeof (aout_sys_t) );
1217 if( unlikely( p_sys == NULL ) )
1220 vlc_mutex_init( &p_sys->mutex );
1221 vlc_cond_init( &p_sys->cond );
1222 TAILQ_INIT( &p_sys->thread_cmd_queue );
1224 p_aout->sys = p_sys;
1225 p_aout->start = Start;
1226 p_aout->stop = Stop;
1227 p_aout->play = Play;
1228 p_aout->pause = Pause;
1229 p_aout->flush = Flush;
1230 p_aout->time_get = TimeGet;
1232 aout_SoftVolumeInit( p_aout );
1234 /* create JNIThread */
1235 p_sys->b_thread_run = true;
1236 if( vlc_clone( &p_sys->thread,
1237 JNIThread, p_aout, VLC_THREAD_PRIORITY_AUDIO ) )
1239 msg_Err( p_aout, "JNIThread creation failed" );
1240 p_sys->b_thread_run = false;
1242 return VLC_EGENERIC;
1249 Close( vlc_object_t *obj )
1251 audio_output_t *p_aout = (audio_output_t *) obj;
1252 aout_sys_t *p_sys = p_aout->sys;
1254 /* kill the thread */
1255 vlc_mutex_lock( &p_sys->mutex );
1256 if( p_sys->b_thread_run )
1258 p_sys->b_thread_run = false;
1259 vlc_cond_signal( &p_sys->cond );
1260 vlc_mutex_unlock( &p_sys->mutex );
1261 vlc_join( p_sys->thread, NULL );
1263 vlc_mutex_unlock( &p_sys->mutex );
1265 vlc_mutex_destroy( &p_sys->mutex );
1266 vlc_cond_destroy( &p_sys->cond );