1 /*****************************************************************************
2 * portaudio.c : portaudio (v19) audio output plugin
3 *****************************************************************************
4 * Copyright (C) 2002, 2006 the VideoLAN team
7 * Authors: Frederic Ruget <frederic.ruget@free.fr>
8 * Gildas Bazin <gbazin@videolan.org>
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
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
38 #include <portaudio.h>
40 #define FRAME_SIZE 1024 /* The size is in samples, not in bytes */
43 # define PORTAUDIO_IS_SERIOUSLY_BROKEN 1
46 /*****************************************************************************
47 * aout_sys_t: portaudio audio output method descriptor
48 *****************************************************************************/
49 typedef struct pa_thread_t
52 aout_instance_t *p_aout;
55 vlc_mutex_t lock_wait;
58 vlc_mutex_t lock_signal;
65 aout_instance_t *p_aout;
68 PaDeviceIndex i_devices;
70 PaDeviceIndex i_device_id;
71 const PaDeviceInfo *deviceInfo;
73 bool b_chan_reorder; /* do we need channel reordering */
74 int pi_chan_table[AOUT_CHAN_MAX];
75 uint32_t i_channel_mask;
76 uint32_t i_bits_per_sample;
80 static const uint32_t pi_channels_out[] =
81 { AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
82 AOUT_CHAN_CENTER, AOUT_CHAN_LFE,
83 AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT, AOUT_CHAN_REARCENTER,
84 AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT, 0 };
86 #ifdef PORTAUDIO_IS_SERIOUSLY_BROKEN
87 static bool b_init = 0;
88 static pa_thread_t *pa_thread;
89 static void* PORTAUDIOThread( vlc_object_t * );
92 /*****************************************************************************
94 *****************************************************************************/
95 static int Open ( vlc_object_t * );
96 static void Close ( vlc_object_t * );
97 static void Play ( aout_instance_t * );
99 static int PAOpenDevice( aout_instance_t * );
100 static int PAOpenStream( aout_instance_t * );
102 /*****************************************************************************
104 *****************************************************************************/
105 #define DEVICE_TEXT N_("Output device")
106 #define DEVICE_LONGTEXT N_("Portaudio identifier for the output device")
109 set_shortname( "PortAudio" )
110 set_description( N_("PORTAUDIO audio output") )
111 set_category( CAT_AUDIO )
112 set_subcategory( SUBCAT_AUDIO_AOUT )
113 add_integer( "portaudio-audio-device", 0, NULL,
114 DEVICE_TEXT, DEVICE_LONGTEXT, false );
115 add_deprecated_alias( "portaudio-device" ) /* deprecated since 0.9.3 */
116 set_capability( "audio output", 0 )
117 set_callbacks( Open, Close )
120 /* This routine will be called by the PortAudio engine when audio is needed.
121 * It may called at interrupt level on some machines so don't do anything
122 * that could mess up the system like calling malloc() or free().
124 static int paCallback( const void *inputBuffer, void *outputBuffer,
125 unsigned long framesPerBuffer,
126 const PaStreamCallbackTimeInfo *paDate,
127 PaStreamCallbackFlags statusFlags, void *p_cookie )
129 struct aout_sys_t *p_sys = (struct aout_sys_t*) p_cookie;
130 aout_instance_t *p_aout = p_sys->p_aout;
131 aout_buffer_t *p_buffer;
134 out_date = mdate() + (mtime_t) ( 1000000 *
135 ( paDate->outputBufferDacTime - paDate->currentTime ) );
136 p_buffer = aout_OutputNextBuffer( p_aout, out_date, true );
138 if ( p_buffer != NULL )
140 if( p_sys->b_chan_reorder )
142 /* Do the channel reordering here */
143 aout_ChannelReorder( p_buffer->p_buffer, p_buffer->i_nb_bytes,
144 p_sys->i_channels, p_sys->pi_chan_table,
145 p_sys->i_bits_per_sample );
147 vlc_memcpy( outputBuffer, p_buffer->p_buffer,
148 framesPerBuffer * p_sys->i_sample_size );
149 /* aout_BufferFree may be dangereous here, but then so is
150 * aout_OutputNextBuffer (calls aout_BufferFree internally).
151 * one solution would be to link the no longer useful buffers
152 * in a second fifo (in aout_OutputNextBuffer too) and to
153 * wait until we are in Play to do the actual free.
155 aout_BufferFree( p_buffer );
158 /* Audio output buffer shortage -> stop the fill process and wait */
160 vlc_memset( outputBuffer, 0, framesPerBuffer * p_sys->i_sample_size );
165 /*****************************************************************************
166 * Open: open the audio device
167 *****************************************************************************/
168 static int Open( vlc_object_t * p_this )
170 aout_instance_t *p_aout = (aout_instance_t *)p_this;
171 struct aout_sys_t * p_sys;
175 msg_Dbg( p_aout, "entering Open()");
177 /* Allocate p_sys structure */
178 p_sys = (aout_sys_t *)malloc( sizeof(aout_sys_t) );
181 p_sys->p_aout = p_aout;
183 p_aout->output.p_sys = p_sys;
184 p_aout->output.pf_play = Play;
186 /* Retrieve output device id from config */
187 var_Create( p_aout, "portaudio-audio-device", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT);
188 var_Get( p_aout, "portaudio-audio-device", &val );
189 p_sys->i_device_id = val.i_int;
191 #ifdef PORTAUDIO_IS_SERIOUSLY_BROKEN
195 if( PAOpenDevice( p_aout ) != VLC_SUCCESS )
197 msg_Err( p_aout, "cannot open portaudio device" );
202 /* Close device for now. We'll re-open it later on */
203 if( ( i_err = Pa_Terminate() ) != paNoError )
205 msg_Err( p_aout, "closing the device returned %d", i_err );
210 /* Now we need to setup our DirectSound play notification structure */
211 pa_thread = vlc_object_create( p_aout, sizeof(pa_thread_t) );
212 pa_thread->p_aout = p_aout;
213 pa_thread->b_error = false;
214 vlc_mutex_init( &pa_thread->lock_wait );
215 vlc_cond_init( &pa_thread->wait );
216 pa_thread->b_wait = false;
217 vlc_mutex_init( &pa_thread->lock_signal );
218 vlc_cond_init( &pa_thread->signal );
219 pa_thread->b_signal = false;
221 /* Create PORTAUDIOThread */
222 if( vlc_thread_create( pa_thread, "aout", PORTAUDIOThread,
223 VLC_THREAD_PRIORITY_OUTPUT, false ) )
225 msg_Err( p_aout, "cannot create PORTAUDIO thread" );
231 pa_thread->p_aout = p_aout;
232 pa_thread->b_wait = false;
233 pa_thread->b_signal = false;
234 pa_thread->b_error = false;
237 /* Signal start of stream */
238 vlc_mutex_lock( &pa_thread->lock_signal );
239 pa_thread->b_signal = true;
240 vlc_cond_signal( &pa_thread->signal );
241 vlc_mutex_unlock( &pa_thread->lock_signal );
243 /* Wait until thread is ready */
244 vlc_mutex_lock( &pa_thread->lock_wait );
245 if( !pa_thread->b_wait )
246 vlc_cond_wait( &pa_thread->wait, &pa_thread->lock_wait );
247 vlc_mutex_unlock( &pa_thread->lock_wait );
248 pa_thread->b_wait = false;
250 if( pa_thread->b_error )
252 msg_Err( p_aout, "PORTAUDIO thread failed" );
261 if( PAOpenDevice( p_aout ) != VLC_SUCCESS )
263 msg_Err( p_aout, "cannot open portaudio device" );
268 if( PAOpenStream( p_aout ) != VLC_SUCCESS )
270 msg_Err( p_aout, "cannot open portaudio device" );
278 /*****************************************************************************
279 * Close: close the audio device
280 *****************************************************************************/
281 static void Close ( vlc_object_t *p_this )
283 aout_instance_t *p_aout = (aout_instance_t *)p_this;
284 aout_sys_t *p_sys = p_aout->output.p_sys;
287 msg_Dbg( p_aout, "closing portaudio");
289 #ifdef PORTAUDIO_IS_SERIOUSLY_BROKEN
291 /* Signal end of stream */
292 vlc_mutex_lock( &pa_thread->lock_signal );
293 pa_thread->b_signal = true;
294 vlc_cond_signal( &pa_thread->signal );
295 vlc_mutex_unlock( &pa_thread->lock_signal );
297 /* Wait until thread is ready */
298 vlc_mutex_lock( &pa_thread->lock_wait );
299 if( !pa_thread->b_wait )
300 vlc_cond_wait( &pa_thread->wait, &pa_thread->lock_wait );
301 vlc_mutex_unlock( &pa_thread->lock_wait );
302 pa_thread->b_wait = false;
306 i_err = Pa_StopStream( p_sys->p_stream );
307 if( i_err != paNoError )
309 msg_Err( p_aout, "Pa_StopStream: %d (%s)", i_err,
310 Pa_GetErrorText( i_err ) );
312 i_err = Pa_CloseStream( p_sys->p_stream );
313 if( i_err != paNoError )
315 msg_Err( p_aout, "Pa_CloseStream: %d (%s)", i_err,
316 Pa_GetErrorText( i_err ) );
319 i_err = Pa_Terminate();
320 if( i_err != paNoError )
322 msg_Err( p_aout, "Pa_Terminate: %d (%s)", i_err,
323 Pa_GetErrorText( i_err ) );
328 msg_Dbg( p_aout, "portaudio closed");
332 static int PAOpenDevice( aout_instance_t *p_aout )
334 aout_sys_t *p_sys = p_aout->output.p_sys;
335 const PaDeviceInfo *p_pdi;
337 vlc_value_t val, text;
340 /* Initialize portaudio */
341 i_err = Pa_Initialize();
342 if( i_err != paNoError )
344 msg_Err( p_aout, "Pa_Initialize returned %d : %s",
345 i_err, Pa_GetErrorText( i_err ) );
350 p_sys->i_devices = Pa_GetDeviceCount();
351 if( p_sys->i_devices < 0 )
353 i_err = p_sys->i_devices;
354 msg_Err( p_aout, "Pa_GetDeviceCount returned %d : %s", i_err,
355 Pa_GetErrorText( i_err ) );
360 /* Display all devices info */
361 msg_Dbg( p_aout, "number of devices = %d", p_sys->i_devices );
362 for( i = 0; i < p_sys->i_devices; i++ )
364 p_pdi = Pa_GetDeviceInfo( i );
365 msg_Dbg( p_aout, "------------------------------------- #%d", i );
366 msg_Dbg( p_aout, "Name = %s", p_pdi->name );
367 msg_Dbg( p_aout, "Max Inputs = %d, Max Outputs = %d",
368 p_pdi->maxInputChannels, p_pdi->maxOutputChannels );
370 msg_Dbg( p_aout, "-------------------------------------" );
372 msg_Dbg( p_aout, "requested device is #%d", p_sys->i_device_id );
373 if( p_sys->i_device_id >= p_sys->i_devices )
375 msg_Err( p_aout, "device %d does not exist", p_sys->i_device_id );
378 p_sys->deviceInfo = Pa_GetDeviceInfo( p_sys->i_device_id );
380 if( p_sys->deviceInfo->maxOutputChannels < 1 )
382 msg_Err( p_aout, "no channel available" );
386 if( var_Type( p_aout, "audio-device" ) == 0 )
388 var_Create( p_aout, "audio-device", VLC_VAR_INTEGER|VLC_VAR_HASCHOICE);
389 text.psz_string = _("Audio Device");
390 var_Change( p_aout, "audio-device", VLC_VAR_SETTEXT, &text, NULL );
392 if( p_sys->deviceInfo->maxOutputChannels >= 1 )
394 val.i_int = AOUT_VAR_MONO;
395 text.psz_string = N_("Mono");
396 var_Change( p_aout, "audio-device", VLC_VAR_ADDCHOICE,
398 msg_Dbg( p_aout, "device supports 1 channel" );
400 if( p_sys->deviceInfo->maxOutputChannels >= 2 )
402 val.i_int = AOUT_VAR_STEREO;
403 text.psz_string = N_("Stereo");
404 var_Change( p_aout, "audio-device", VLC_VAR_ADDCHOICE,
406 var_Change( p_aout, "audio-device", VLC_VAR_SETDEFAULT,
408 var_Set( p_aout, "audio-device", val );
409 msg_Dbg( p_aout, "device supports 2 channels" );
411 if( p_sys->deviceInfo->maxOutputChannels >= 4 )
413 val.i_int = AOUT_VAR_2F2R;
414 text.psz_string = N_("2 Front 2 Rear");
415 var_Change( p_aout, "audio-device", VLC_VAR_ADDCHOICE,
417 msg_Dbg( p_aout, "device supports 4 channels" );
419 if( p_sys->deviceInfo->maxOutputChannels >= 5 )
421 val.i_int = AOUT_VAR_3F2R;
422 text.psz_string = N_("3 Front 2 Rear");
423 var_Change( p_aout, "audio-device",
424 VLC_VAR_ADDCHOICE, &val, &text );
425 msg_Dbg( p_aout, "device supports 5 channels" );
427 if( p_sys->deviceInfo->maxOutputChannels >= 6 )
429 val.i_int = AOUT_VAR_5_1;
430 text.psz_string = "5.1";
431 var_Change( p_aout, "audio-device", VLC_VAR_ADDCHOICE,
433 msg_Dbg( p_aout, "device supports 5.1 channels" );
436 var_AddCallback( p_aout, "audio-device", aout_ChannelsRestart, NULL );
439 var_Set( p_aout, "intf-change", val );
442 /* Audio format is paFloat32 (always supported by portaudio v19) */
443 p_aout->output.output.i_format = VLC_FOURCC('f','l','3','2');
448 if( ( i_err = Pa_Terminate() ) != paNoError )
450 msg_Err( p_aout, "Pa_Terminate returned %d", i_err );
455 static int PAOpenStream( aout_instance_t *p_aout )
457 aout_sys_t *p_sys = p_aout->output.p_sys;
458 const PaHostErrorInfo* paLastHostErrorInfo = Pa_GetLastHostErrorInfo();
459 PaStreamParameters paStreamParameters;
461 int i_channels, i_err;
462 uint32_t i_channel_mask;
464 if( var_Get( p_aout, "audio-device", &val ) < 0 )
469 if( val.i_int == AOUT_VAR_5_1 )
471 p_aout->output.output.i_physical_channels
472 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
473 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT
476 else if( val.i_int == AOUT_VAR_3F2R )
478 p_aout->output.output.i_physical_channels
479 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
480 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT;
482 else if( val.i_int == AOUT_VAR_2F2R )
484 p_aout->output.output.i_physical_channels
485 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
486 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT;
488 else if( val.i_int == AOUT_VAR_MONO )
490 p_aout->output.output.i_physical_channels = AOUT_CHAN_CENTER;
494 p_aout->output.output.i_physical_channels
495 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
498 i_channels = aout_FormatNbChannels( &p_aout->output.output );
499 msg_Dbg( p_aout, "nb_channels requested = %d", i_channels );
500 i_channel_mask = p_aout->output.output.i_physical_channels;
502 /* Calculate the frame size in bytes */
503 p_sys->i_sample_size = 4 * i_channels;
504 p_aout->output.i_nb_samples = FRAME_SIZE;
505 aout_FormatPrepare( &p_aout->output.output );
506 aout_VolumeSoftInit( p_aout );
508 /* Check for channel reordering */
509 p_aout->output.p_sys->i_channel_mask = i_channel_mask;
510 p_aout->output.p_sys->i_bits_per_sample = 32; /* forced to paFloat32 */
511 p_aout->output.p_sys->i_channels = i_channels;
513 p_aout->output.p_sys->b_chan_reorder =
514 aout_CheckChannelReorder( NULL, pi_channels_out,
515 i_channel_mask, i_channels,
516 p_aout->output.p_sys->pi_chan_table );
518 if( p_aout->output.p_sys->b_chan_reorder )
520 msg_Dbg( p_aout, "channel reordering needed" );
523 paStreamParameters.device = p_sys->i_device_id;
524 paStreamParameters.channelCount = i_channels;
525 paStreamParameters.sampleFormat = paFloat32;
526 paStreamParameters.suggestedLatency =
527 p_sys->deviceInfo->defaultLowOutputLatency;
528 paStreamParameters.hostApiSpecificStreamInfo = NULL;
530 i_err = Pa_OpenStream( &p_sys->p_stream, NULL /* no input */,
531 &paStreamParameters, (double)p_aout->output.output.i_rate,
532 FRAME_SIZE, paClipOff, paCallback, p_sys );
533 if( i_err != paNoError )
535 msg_Err( p_aout, "Pa_OpenStream returns %d : %s", i_err,
536 Pa_GetErrorText( i_err ) );
537 if( i_err == paUnanticipatedHostError )
539 msg_Err( p_aout, "type %d code %ld : %s",
540 paLastHostErrorInfo->hostApiType,
541 paLastHostErrorInfo->errorCode,
542 paLastHostErrorInfo->errorText );
548 i_err = Pa_StartStream( p_sys->p_stream );
549 if( i_err != paNoError )
551 msg_Err( p_aout, "Pa_StartStream() failed" );
552 Pa_CloseStream( p_sys->p_stream );
559 /*****************************************************************************
561 *****************************************************************************/
562 static void Play( aout_instance_t * p_aout )
566 #ifdef PORTAUDIO_IS_SERIOUSLY_BROKEN
567 /*****************************************************************************
568 * PORTAUDIOThread: all interactions with libportaudio.a are handled
569 * in this single thread. Otherwise libportaudio.a is _not_ happy :-(
570 *****************************************************************************/
571 static void* PORTAUDIOThread( vlc_object_t *p_this )
573 pa_thread_t *pa_thread = (pa_thread_t*)p_this;
574 aout_instance_t *p_aout;
577 int canc = vlc_savecancel ();
579 while( vlc_object_alive (pa_thread) )
581 /* Wait for start of stream */
582 vlc_mutex_lock( &pa_thread->lock_signal );
583 if( !pa_thread->b_signal )
584 vlc_cond_wait( &pa_thread->signal, &pa_thread->lock_signal );
585 vlc_mutex_unlock( &pa_thread->lock_signal );
586 pa_thread->b_signal = false;
588 p_aout = pa_thread->p_aout;
589 p_sys = p_aout->output.p_sys;
591 if( PAOpenDevice( p_aout ) != VLC_SUCCESS )
593 msg_Err( p_aout, "cannot open portaudio device" );
594 pa_thread->b_error = true;
597 if( !pa_thread->b_error && PAOpenStream( p_aout ) != VLC_SUCCESS )
599 msg_Err( p_aout, "cannot open portaudio device" );
600 pa_thread->b_error = true;
602 i_err = Pa_Terminate();
603 if( i_err != paNoError )
605 msg_Err( p_aout, "Pa_Terminate: %d (%s)", i_err,
606 Pa_GetErrorText( i_err ) );
610 /* Tell the main thread that we are ready */
611 vlc_mutex_lock( &pa_thread->lock_wait );
612 pa_thread->b_wait = true;
613 vlc_cond_signal( &pa_thread->wait );
614 vlc_mutex_unlock( &pa_thread->lock_wait );
616 /* Wait for end of stream */
617 vlc_mutex_lock( &pa_thread->lock_signal );
618 if( !pa_thread->b_signal )
619 vlc_cond_wait( &pa_thread->signal, &pa_thread->lock_signal );
620 vlc_mutex_unlock( &pa_thread->lock_signal );
621 pa_thread->b_signal = false;
623 if( pa_thread->b_error ) continue;
625 i_err = Pa_StopStream( p_sys->p_stream );
626 if( i_err != paNoError )
628 msg_Err( p_aout, "Pa_StopStream: %d (%s)", i_err,
629 Pa_GetErrorText( i_err ) );
631 i_err = Pa_CloseStream( p_sys->p_stream );
632 if( i_err != paNoError )
634 msg_Err( p_aout, "Pa_CloseStream: %d (%s)", i_err,
635 Pa_GetErrorText( i_err ) );
637 i_err = Pa_Terminate();
638 if( i_err != paNoError )
640 msg_Err( p_aout, "Pa_Terminate: %d (%s)", i_err,
641 Pa_GetErrorText( i_err ) );
644 /* Tell the main thread that we are ready */
645 vlc_mutex_lock( &pa_thread->lock_wait );
646 pa_thread->b_wait = true;
647 vlc_cond_signal( &pa_thread->wait );
648 vlc_mutex_unlock( &pa_thread->lock_wait );
650 vlc_restorecancel (canc);