For some unknown reason, the previous commit was not fully done
[vlc.git] / modules / audio_output / alsa.c
1 /*****************************************************************************
2  * alsa.c : alsa plugin for vlc
3  *****************************************************************************
4  * Copyright (C) 2000-2001 VideoLAN
5  * $Id$
6  *
7  * Authors: Henri Fallon <henri@videolan.org> - Original Author
8  *          Jeffrey Baker <jwbaker@acm.org> - Port to ALSA 1.0 API
9  *          John Paul Lorenti <jpl31@columbia.edu> - Device selection
10  *          Arnaud de Bossoreille de Ribou <bozo@via.ecp.fr> - S/PDIF and aout3
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
25  *****************************************************************************/
26
27 /*****************************************************************************
28  * Preamble
29  *****************************************************************************/
30 #include <errno.h>                                                 /* ENOMEM */
31 #include <string.h>                                            /* strerror() */
32 #include <stdlib.h>                            /* calloc(), malloc(), free() */
33
34 #include <vlc/vlc.h>
35
36 #include <vlc/aout.h>
37
38 #include "aout_internal.h"
39
40 /* ALSA part
41    Note: we use the new API which is available since 0.9.0beta10a. */
42 #define ALSA_PCM_NEW_HW_PARAMS_API
43 #define ALSA_PCM_NEW_SW_PARAMS_API
44 #include <alsa/asoundlib.h>
45
46 /*****************************************************************************
47  * aout_sys_t: ALSA audio output method descriptor
48  *****************************************************************************
49  * This structure is part of the audio output thread descriptor.
50  * It describes the ALSA specific properties of an audio device.
51  *****************************************************************************/
52 struct aout_sys_t
53 {
54     snd_pcm_t         * p_snd_pcm;
55     int                 i_period_time;
56
57 #ifdef ALSA_DEBUG
58     snd_output_t      * p_snd_stderr;
59 #endif
60
61     int b_playing;                                         /* playing status */
62     mtime_t start_date;
63
64     vlc_mutex_t lock;
65     vlc_cond_t  wait ;
66
67     snd_pcm_status_t *p_status;
68 };
69
70 #define A52_FRAME_NB 1536
71
72 /* These values are in frames.
73    To convert them to a number of bytes you have to multiply them by the
74    number of channel(s) (eg. 2 for stereo) and the size of a sample (eg.
75    2 for int16_t). */
76 #define ALSA_DEFAULT_PERIOD_SIZE        1024
77 #define ALSA_DEFAULT_BUFFER_SIZE        ( ALSA_DEFAULT_PERIOD_SIZE << 8 )
78 #define ALSA_SPDIF_PERIOD_SIZE          A52_FRAME_NB
79 #define ALSA_SPDIF_BUFFER_SIZE          ( ALSA_SPDIF_PERIOD_SIZE << 4 )
80 /* Why << 4 ? --Meuuh */
81 /* Why not ? --Bozo */
82 /* Right. --Meuuh */
83
84 #define DEFAULT_ALSA_DEVICE N_("default")
85
86 /*****************************************************************************
87  * Local prototypes
88  *****************************************************************************/
89 static int  Open         ( vlc_object_t * );
90 static void Close        ( vlc_object_t * );
91 static void Play         ( aout_instance_t * );
92 static int  ALSAThread   ( aout_instance_t * );
93 static void ALSAFill     ( aout_instance_t * );
94
95 /*****************************************************************************
96  * Module descriptor
97  *****************************************************************************/
98 vlc_module_begin();
99     set_shortname( "ALSA" );
100     set_description( _("ALSA audio output") );
101     set_category( CAT_AUDIO );
102     set_subcategory( SUBCAT_AUDIO_AOUT );
103     add_string( "alsadev", DEFAULT_ALSA_DEVICE, aout_FindAndRestart,
104                 N_("ALSA Device Name"), NULL, VLC_FALSE );
105     set_capability( "audio output", 150 );
106     set_callbacks( Open, Close );
107 vlc_module_end();
108
109 /*****************************************************************************
110  * Probe: probe the audio device for available formats and channels
111  *****************************************************************************/
112 static void Probe( aout_instance_t * p_aout,
113                    const char * psz_device, const char * psz_iec_device,
114                    int *pi_snd_pcm_format )
115 {
116     struct aout_sys_t * p_sys = p_aout->output.p_sys;
117     vlc_value_t val, text;
118     int i_ret;
119
120     var_Create ( p_aout, "audio-device", VLC_VAR_INTEGER | VLC_VAR_HASCHOICE );
121     text.psz_string = _("Audio Device");
122     var_Change( p_aout, "audio-device", VLC_VAR_SETTEXT, &text, NULL );
123
124     /* We'll open the audio device in non blocking mode so we can just exit
125      * when it is already in use, but for the real stuff we'll still use
126      * the blocking mode */
127
128     /* Now test linear PCM capabilities */
129     if ( !(i_ret = snd_pcm_open( &p_sys->p_snd_pcm, psz_device,
130                                  SND_PCM_STREAM_PLAYBACK,
131                                  SND_PCM_NONBLOCK ) ) )
132     {
133         int i_channels;
134         snd_pcm_hw_params_t * p_hw;
135         snd_pcm_hw_params_alloca (&p_hw);
136
137         if ( snd_pcm_hw_params_any( p_sys->p_snd_pcm, p_hw ) < 0 )
138         {
139             msg_Warn( p_aout, "unable to retrieve initial hardware parameters"
140                               ", disabling linear PCM audio" );
141             snd_pcm_close( p_sys->p_snd_pcm );
142             var_Destroy( p_aout, "audio-device" );
143             return;
144         }
145
146         if ( snd_pcm_hw_params_set_format( p_sys->p_snd_pcm, p_hw,
147                                            *pi_snd_pcm_format ) < 0 )
148         {
149             if( *pi_snd_pcm_format != SND_PCM_FORMAT_S16 )
150             {
151                 *pi_snd_pcm_format = SND_PCM_FORMAT_S16;
152                 if ( snd_pcm_hw_params_set_format( p_sys->p_snd_pcm, p_hw,
153                                                    *pi_snd_pcm_format ) < 0 )
154                 {
155                     msg_Warn( p_aout, "unable to set stream sample size and "
156                               "word order, disabling linear PCM audio" );
157                     snd_pcm_close( p_sys->p_snd_pcm );
158                     var_Destroy( p_aout, "audio-device" );
159                     return;
160                 }
161             }
162         }
163
164         i_channels = aout_FormatNbChannels( &p_aout->output.output );
165
166         while ( i_channels > 0 )
167         {
168             if ( !snd_pcm_hw_params_test_channels( p_sys->p_snd_pcm, p_hw,
169                                                    i_channels ) )
170             {
171                 switch ( i_channels )
172                 {
173                 case 1:
174                     val.i_int = AOUT_VAR_MONO;
175                     text.psz_string = N_("Mono");
176                     var_Change( p_aout, "audio-device",
177                                 VLC_VAR_ADDCHOICE, &val, &text );
178                     break;
179                 case 2:
180                     val.i_int = AOUT_VAR_STEREO;
181                     text.psz_string = N_("Stereo");
182                     var_Change( p_aout, "audio-device",
183                                 VLC_VAR_ADDCHOICE, &val, &text );
184                     var_Set( p_aout, "audio-device", val );
185                     break;
186                 case 4:
187                     val.i_int = AOUT_VAR_2F2R;
188                     text.psz_string = N_("2 Front 2 Rear");
189                     var_Change( p_aout, "audio-device",
190                                 VLC_VAR_ADDCHOICE, &val, &text );
191                     break;
192                 case 6:
193                     val.i_int = AOUT_VAR_5_1;
194                     text.psz_string = N_("5.1");
195                     var_Change( p_aout, "audio-device",
196                                 VLC_VAR_ADDCHOICE, &val, &text );
197                     break;
198                 }
199             }
200
201             --i_channels;
202         }
203
204         /* Special case for mono on stereo only boards */
205         i_channels = aout_FormatNbChannels( &p_aout->output.output );        
206         var_Change( p_aout, "audio-device", VLC_VAR_CHOICESCOUNT, &val, NULL );
207         if( val.i_int <= 0 && i_channels == 1 )
208         {
209             if ( !snd_pcm_hw_params_test_channels( p_sys->p_snd_pcm, p_hw, 2 ))
210             {
211                 val.i_int = AOUT_VAR_STEREO;
212                 text.psz_string = N_("Stereo");
213                 var_Change( p_aout, "audio-device",
214                             VLC_VAR_ADDCHOICE, &val, &text );
215                 var_Set( p_aout, "audio-device", val );
216             }
217         }
218         
219         /* Close the previously opened device */
220         snd_pcm_close( p_sys->p_snd_pcm );
221     }
222     else if ( i_ret == -EBUSY )
223     {
224         msg_Warn( p_aout, "audio device: %s is already in use", psz_device );
225     }
226
227     /* Test for S/PDIF device if needed */
228     if ( psz_iec_device )
229     {
230         /* Opening the device should be enough */
231         if ( !(i_ret = snd_pcm_open( &p_sys->p_snd_pcm, psz_iec_device,
232                                      SND_PCM_STREAM_PLAYBACK,
233                                      SND_PCM_NONBLOCK ) ) )
234         {
235             val.i_int = AOUT_VAR_SPDIF;
236             text.psz_string = N_("A/52 over S/PDIF");
237             var_Change( p_aout, "audio-device",
238                         VLC_VAR_ADDCHOICE, &val, &text );
239             if( config_GetInt( p_aout, "spdif" ) )
240                 var_Set( p_aout, "audio-device", val );
241
242             snd_pcm_close( p_sys->p_snd_pcm );
243         }
244         else if ( i_ret == -EBUSY )
245         {
246             msg_Warn( p_aout, "audio device: %s is already in use",
247                       psz_iec_device );
248         }
249     }
250
251     var_Change( p_aout, "audio-device", VLC_VAR_CHOICESCOUNT, &val, NULL );
252     if( val.i_int <= 0 )
253     {
254         /* Probe() has failed. */
255         msg_Dbg( p_aout, "failed to find a useable alsa configuration" );
256         var_Destroy( p_aout, "audio-device" );
257         return;
258     }
259
260     /* Add final settings to the variable */
261     var_AddCallback( p_aout, "audio-device", aout_ChannelsRestart, NULL );
262     val.b_bool = VLC_TRUE;
263     var_Set( p_aout, "intf-change", val );
264 }
265
266 /*****************************************************************************
267  * Open: create a handle and open an alsa device
268  *****************************************************************************
269  * This function opens an alsa device, through the alsa API.
270  *
271  * Note: the only heap-allocated string is psz_device. All the other pointers
272  * are references to psz_device or to stack-allocated data.
273  *****************************************************************************/
274 static int Open( vlc_object_t *p_this )
275 {
276     aout_instance_t * p_aout = (aout_instance_t *)p_this;
277     struct aout_sys_t * p_sys;
278     vlc_value_t val;
279
280     char psz_default_iec_device[128]; /* Buffer used to store the default
281                                          S/PDIF device */
282     char * psz_device, * psz_iec_device; /* device names for PCM and S/PDIF
283                                             output */
284
285     int i_vlc_pcm_format; /* Audio format for VLC's data */
286     int i_snd_pcm_format; /* Audio format for ALSA's data */
287
288     snd_pcm_uframes_t i_buffer_size = 0;
289     snd_pcm_uframes_t i_period_size = 0;
290     int i_channels = 0;
291
292     snd_pcm_hw_params_t *p_hw;
293     snd_pcm_sw_params_t *p_sw;
294
295     int i_snd_rc = -1;
296     int i_old_rate;
297
298     /* Allocate structures */
299     p_aout->output.p_sys = p_sys = malloc( sizeof( aout_sys_t ) );
300     if( p_sys == NULL )
301     {
302         msg_Err( p_aout, "out of memory" );
303         return VLC_ENOMEM;
304     }
305     p_sys->b_playing = VLC_FALSE;
306     p_sys->start_date = 0;
307     p_sys->p_status = (snd_pcm_status_t *)malloc(snd_pcm_status_sizeof());
308     vlc_cond_init( p_aout, &p_sys->wait );
309     vlc_mutex_init( p_aout, &p_sys->lock );
310
311     /* Get device name */
312     if( (psz_device = config_GetPsz( p_aout, "alsadev" )) == NULL )
313     {
314         msg_Err( p_aout, "no audio device given (maybe \"default\" ?)" );
315         free( p_sys );
316         return VLC_EGENERIC;
317     }
318
319     /* Choose the IEC device for S/PDIF output:
320        if the device is overriden by the user then it will be the one
321        otherwise we compute the default device based on the output format. */
322     if( AOUT_FMT_NON_LINEAR( &p_aout->output.output )
323         && !strcmp( psz_device, DEFAULT_ALSA_DEVICE ) )
324     {
325         snprintf( psz_default_iec_device, sizeof(psz_default_iec_device),
326                   "iec958:AES0=0x%x,AES1=0x%x,AES2=0x%x,AES3=0x%x",
327                   IEC958_AES0_CON_EMPHASIS_NONE | IEC958_AES0_NONAUDIO,
328                   IEC958_AES1_CON_ORIGINAL | IEC958_AES1_CON_PCM_CODER,
329                   0,
330                   ( p_aout->output.output.i_rate == 48000 ?
331                     IEC958_AES3_CON_FS_48000 :
332                     ( p_aout->output.output.i_rate == 44100 ?
333                       IEC958_AES3_CON_FS_44100 : IEC958_AES3_CON_FS_32000 ) ) );
334         psz_iec_device = psz_default_iec_device;
335     }
336     else if( AOUT_FMT_NON_LINEAR( &p_aout->output.output ) )
337     {
338         psz_iec_device = psz_device;
339     }
340     else
341     {
342         psz_iec_device = NULL;
343     }
344
345     /* Choose the linear PCM format (read the comment above about FPU
346        and float32) */
347     if( p_aout->p_libvlc->i_cpu & CPU_CAPABILITY_FPU )
348     {
349         i_vlc_pcm_format = VLC_FOURCC('f','l','3','2');
350         i_snd_pcm_format = SND_PCM_FORMAT_FLOAT;
351     }
352     else
353     {
354         i_vlc_pcm_format = AOUT_FMT_S16_NE;
355         i_snd_pcm_format = SND_PCM_FORMAT_S16;
356     }
357
358     /* If the variable doesn't exist then it's the first time we're called
359        and we have to probe the available audio formats and channels */
360     if ( var_Type( p_aout, "audio-device" ) == 0 )
361     {
362         Probe( p_aout, psz_device, psz_iec_device, &i_snd_pcm_format );
363         switch( i_snd_pcm_format )
364         {
365         case SND_PCM_FORMAT_FLOAT:
366             i_vlc_pcm_format = VLC_FOURCC('f','l','3','2');
367             break;
368         case SND_PCM_FORMAT_S16:
369             i_vlc_pcm_format = AOUT_FMT_S16_NE;
370             break;
371         }
372     }
373
374     if ( var_Get( p_aout, "audio-device", &val ) < 0 )
375     {
376         free( p_sys );
377         free( psz_device );
378         return VLC_EGENERIC;
379     }
380
381     if ( val.i_int == AOUT_VAR_SPDIF )
382     {
383         p_aout->output.output.i_format = VLC_FOURCC('s','p','d','i');
384     }
385     else if ( val.i_int == AOUT_VAR_5_1 )
386     {
387         p_aout->output.output.i_format = i_vlc_pcm_format;
388         p_aout->output.output.i_physical_channels
389             = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
390                | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT
391                | AOUT_CHAN_LFE;
392         free( psz_device );
393         psz_device = strdup( "surround51" );
394     }
395     else if ( val.i_int == AOUT_VAR_2F2R )
396     {
397         p_aout->output.output.i_format = i_vlc_pcm_format;
398         p_aout->output.output.i_physical_channels
399             = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
400                | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT;
401         free( psz_device );
402         psz_device = strdup( "surround40" );
403     }
404     else if ( val.i_int == AOUT_VAR_STEREO )
405     {
406         p_aout->output.output.i_format = i_vlc_pcm_format;
407         p_aout->output.output.i_physical_channels
408             = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
409     }
410     else if ( val.i_int == AOUT_VAR_MONO )
411     {
412         p_aout->output.output.i_format = i_vlc_pcm_format;
413         p_aout->output.output.i_physical_channels = AOUT_CHAN_CENTER;
414     }
415
416     else
417     {
418         /* This should not happen ! */
419         msg_Err( p_aout, "internal: can't find audio-device (%i)", val.i_int );
420         free( p_sys );
421         return VLC_EGENERIC;
422     }
423
424 #ifdef ALSA_DEBUG
425     snd_output_stdio_attach( &p_sys->p_snd_stderr, stderr, 0 );
426 #endif
427
428     /* Open the device */
429     if ( AOUT_FMT_NON_LINEAR( &p_aout->output.output ) )
430     {
431         if ( ( i_snd_rc = snd_pcm_open( &p_sys->p_snd_pcm, psz_iec_device,
432                             SND_PCM_STREAM_PLAYBACK, 0 ) ) < 0 )
433         {
434             msg_Err( p_aout, "cannot open ALSA device `%s' (%s)",
435                              psz_iec_device, snd_strerror( i_snd_rc ) );
436             free( p_sys );
437             free( psz_device );
438             return VLC_EGENERIC;
439         }
440         i_buffer_size = ALSA_SPDIF_BUFFER_SIZE;
441         i_snd_pcm_format = SND_PCM_FORMAT_S16;
442         i_channels = 2;
443
444         p_aout->output.i_nb_samples = i_period_size = ALSA_SPDIF_PERIOD_SIZE;
445         p_aout->output.output.i_bytes_per_frame = AOUT_SPDIF_SIZE;
446         p_aout->output.output.i_frame_length = A52_FRAME_NB;
447
448         aout_VolumeNoneInit( p_aout );
449     }
450     else
451     {
452         msg_Dbg( p_aout, "opening ALSA device `%s'", psz_device );
453
454         if ( ( i_snd_rc = snd_pcm_open( &p_sys->p_snd_pcm, psz_device,
455                             SND_PCM_STREAM_PLAYBACK, 0 ) ) < 0 )
456         {
457             msg_Err( p_aout, "cannot open ALSA device `%s' (%s)",
458                              psz_device, snd_strerror( i_snd_rc ) );
459             free( p_sys );
460             free( psz_device );
461             return VLC_EGENERIC;
462         }
463         i_buffer_size = ALSA_DEFAULT_BUFFER_SIZE;
464         i_channels = aout_FormatNbChannels( &p_aout->output.output );
465
466         p_aout->output.i_nb_samples = i_period_size = ALSA_DEFAULT_PERIOD_SIZE;
467
468         aout_VolumeSoftInit( p_aout );
469     }
470
471     /* Free psz_device so that all the remaining data is stack-allocated */
472     free( psz_device );
473
474     p_aout->output.pf_play = Play;
475
476     snd_pcm_hw_params_alloca(&p_hw);
477     snd_pcm_sw_params_alloca(&p_sw);
478
479     /* Get Initial hardware parameters */
480     if ( ( i_snd_rc = snd_pcm_hw_params_any( p_sys->p_snd_pcm, p_hw ) ) < 0 )
481     {
482         msg_Err( p_aout, "unable to retrieve initial hardware parameters (%s)",
483                          snd_strerror( i_snd_rc ) );
484         goto error;
485     }
486
487     /* Set format. */
488     if ( ( i_snd_rc = snd_pcm_hw_params_set_format( p_sys->p_snd_pcm, p_hw,
489                                                     i_snd_pcm_format ) ) < 0 )
490     {
491         msg_Err( p_aout, "unable to set stream sample size and word order (%s)",
492                          snd_strerror( i_snd_rc ) );
493         goto error;
494     }
495
496     if ( ( i_snd_rc = snd_pcm_hw_params_set_access( p_sys->p_snd_pcm, p_hw,
497                                     SND_PCM_ACCESS_RW_INTERLEAVED ) ) < 0 )
498     {
499         msg_Err( p_aout, "unable to set interleaved stream format (%s)",
500                          snd_strerror( i_snd_rc ) );
501         goto error;
502     }
503
504     /* Set channels. */
505     if ( ( i_snd_rc = snd_pcm_hw_params_set_channels( p_sys->p_snd_pcm, p_hw,
506                                                       i_channels ) ) < 0 )
507     {
508         msg_Err( p_aout, "unable to set number of output channels (%s)",
509                          snd_strerror( i_snd_rc ) );
510         goto error;
511     }
512
513     /* Set rate. */
514     i_old_rate = p_aout->output.output.i_rate;
515 #ifdef HAVE_ALSA_NEW_API
516     i_snd_rc = snd_pcm_hw_params_set_rate_near( p_sys->p_snd_pcm, p_hw,
517                                                 &p_aout->output.output.i_rate,
518                                                 NULL );
519 #else
520     i_snd_rc = snd_pcm_hw_params_set_rate_near( p_sys->p_snd_pcm, p_hw,
521                                                 p_aout->output.output.i_rate,
522                                                 NULL );
523 #endif
524     if( i_snd_rc < 0 || p_aout->output.output.i_rate != i_old_rate )
525     {
526         msg_Warn( p_aout, "The rate %d Hz is not supported by your hardware. "
527                   "Using %d Hz instead.\n", i_old_rate,
528                   p_aout->output.output.i_rate );
529     }
530
531     /* Set buffer size. */
532 #ifdef HAVE_ALSA_NEW_API
533     if ( ( i_snd_rc = snd_pcm_hw_params_set_buffer_size_near( p_sys->p_snd_pcm,
534                                     p_hw, &i_buffer_size ) ) < 0 )
535 #else
536     if ( ( i_snd_rc = snd_pcm_hw_params_set_buffer_size_near( p_sys->p_snd_pcm,
537                                     p_hw, i_buffer_size ) ) < 0 )
538 #endif
539     {
540         msg_Err( p_aout, "unable to set buffer size (%s)",
541                          snd_strerror( i_snd_rc ) );
542         goto error;
543     }
544
545     /* Set period size. */
546 #ifdef HAVE_ALSA_NEW_API
547     if ( ( i_snd_rc = snd_pcm_hw_params_set_period_size_near( p_sys->p_snd_pcm,
548                                     p_hw, &i_period_size, NULL ) ) < 0 )
549 #else
550     if ( ( i_snd_rc = snd_pcm_hw_params_set_period_size_near( p_sys->p_snd_pcm,
551                                     p_hw, i_period_size, NULL ) ) < 0 )
552 #endif
553     {
554         msg_Err( p_aout, "unable to set period size (%s)",
555                          snd_strerror( i_snd_rc ) );
556         goto error;
557     }
558     p_aout->output.i_nb_samples = i_period_size;
559
560     /* Commit hardware parameters. */
561     if ( ( i_snd_rc = snd_pcm_hw_params( p_sys->p_snd_pcm, p_hw ) ) < 0 )
562     {
563         msg_Err( p_aout, "unable to commit hardware configuration (%s)",
564                          snd_strerror( i_snd_rc ) );
565         goto error;
566     }
567
568 #ifdef HAVE_ALSA_NEW_API
569     if( ( i_snd_rc = snd_pcm_hw_params_get_period_time( p_hw,
570                                     &p_sys->i_period_time, NULL ) ) < 0 )
571 #else
572     if( ( p_sys->i_period_time =
573                   snd_pcm_hw_params_get_period_time( p_hw, NULL ) ) < 0 )
574 #endif
575     {
576         msg_Err( p_aout, "unable to get period time (%s)",
577                          snd_strerror( i_snd_rc ) );
578         goto error;
579     }
580
581     /* Get Initial software parameters */
582     snd_pcm_sw_params_current( p_sys->p_snd_pcm, p_sw );
583
584     i_snd_rc = snd_pcm_sw_params_set_sleep_min( p_sys->p_snd_pcm, p_sw, 0 );
585
586     i_snd_rc = snd_pcm_sw_params_set_avail_min( p_sys->p_snd_pcm, p_sw,
587                                                 p_aout->output.i_nb_samples );
588
589     /* Commit software parameters. */
590     if ( snd_pcm_sw_params( p_sys->p_snd_pcm, p_sw ) < 0 )
591     {
592         msg_Err( p_aout, "unable to set software configuration" );
593         goto error;
594     }
595
596 #ifdef ALSA_DEBUG
597     snd_output_printf( p_sys->p_snd_stderr, "\nALSA hardware setup:\n\n" );
598     snd_pcm_dump_hw_setup( p_sys->p_snd_pcm, p_sys->p_snd_stderr );
599     snd_output_printf( p_sys->p_snd_stderr, "\nALSA software setup:\n\n" );
600     snd_pcm_dump_sw_setup( p_sys->p_snd_pcm, p_sys->p_snd_stderr );
601     snd_output_printf( p_sys->p_snd_stderr, "\n" );
602 #endif
603
604     /* Create ALSA thread and wait for its readiness. */
605     if( vlc_thread_create( p_aout, "aout", ALSAThread,
606                            VLC_THREAD_PRIORITY_OUTPUT, VLC_FALSE ) )
607     {
608         msg_Err( p_aout, "cannot create ALSA thread (%s)", strerror(errno) );
609         goto error;
610     }
611
612     return 0;
613
614 error:
615     snd_pcm_close( p_sys->p_snd_pcm );
616 #ifdef ALSA_DEBUG
617     snd_output_close( p_sys->p_snd_stderr );
618 #endif
619     free( p_sys );
620     return VLC_EGENERIC;
621 }
622
623 /*****************************************************************************
624  * Play: nothing to do
625  *****************************************************************************/
626 static void Play( aout_instance_t *p_aout )
627 {
628     if( !p_aout->output.p_sys->b_playing )
629     {
630         p_aout->output.p_sys->b_playing = 1;
631
632         /* get the playing date of the first aout buffer */
633         p_aout->output.p_sys->start_date =
634             aout_FifoFirstDate( p_aout, &p_aout->output.fifo );
635
636         /* wake up the audio output thread */
637         vlc_mutex_lock( &p_aout->output.p_sys->lock );
638         vlc_cond_signal( &p_aout->output.p_sys->wait );
639         vlc_mutex_unlock( &p_aout->output.p_sys->lock );
640     }
641 }
642
643 /*****************************************************************************
644  * Close: close the ALSA device
645  *****************************************************************************/
646 static void Close( vlc_object_t *p_this )
647 {
648     aout_instance_t *p_aout = (aout_instance_t *)p_this;
649     struct aout_sys_t * p_sys = p_aout->output.p_sys;
650     int i_snd_rc;
651
652     /* make sure the audio output thread is waken up */
653     vlc_mutex_lock( &p_aout->output.p_sys->lock );
654     vlc_cond_signal( &p_aout->output.p_sys->wait );
655     vlc_mutex_unlock( &p_aout->output.p_sys->lock );
656
657     p_aout->b_die = VLC_TRUE;
658     vlc_thread_join( p_aout );
659     p_aout->b_die = VLC_FALSE;
660
661     i_snd_rc = snd_pcm_close( p_sys->p_snd_pcm );
662
663     if( i_snd_rc > 0 )
664     {
665         msg_Err( p_aout, "failed closing ALSA device (%s)",
666                          snd_strerror( i_snd_rc ) );
667     }
668
669 #ifdef ALSA_DEBUG
670     snd_output_close( p_sys->p_snd_stderr );
671 #endif
672
673     free( p_sys->p_status );
674     free( p_sys );
675 }
676
677 /*****************************************************************************
678  * ALSAThread: asynchronous thread used to DMA the data to the device
679  *****************************************************************************/
680 static int ALSAThread( aout_instance_t * p_aout )
681 {
682     /* Wait for the exact time to start playing (avoids resampling) */
683     vlc_mutex_lock( &p_aout->output.p_sys->lock );
684     if( !p_aout->output.p_sys->start_date )
685         vlc_cond_wait( &p_aout->output.p_sys->wait,
686                        &p_aout->output.p_sys->lock );
687     vlc_mutex_unlock( &p_aout->output.p_sys->lock );
688
689     mwait( p_aout->output.p_sys->start_date - AOUT_PTS_TOLERANCE / 4 );
690
691     while ( !p_aout->b_die )
692     {
693         ALSAFill( p_aout );
694     }
695
696     return 0;
697 }
698
699 /*****************************************************************************
700  * ALSAFill: function used to fill the ALSA buffer as much as possible
701  *****************************************************************************/
702 static void ALSAFill( aout_instance_t * p_aout )
703 {
704     struct aout_sys_t * p_sys = p_aout->output.p_sys;
705
706     aout_buffer_t * p_buffer;
707     snd_pcm_status_t * p_status = p_sys->p_status;
708     snd_timestamp_t ts_next;
709     int i_snd_rc;
710     mtime_t next_date;
711
712     /* Fill in the buffer until space or audio output buffer shortage */
713     {
714         /* Get the status */
715         i_snd_rc = snd_pcm_status( p_sys->p_snd_pcm, p_status );
716         if( i_snd_rc < 0 )
717         {
718             msg_Err( p_aout, "unable to get the device's status (%s)",
719                              snd_strerror( i_snd_rc ) );
720
721             msleep( p_sys->i_period_time >> 1 );
722             return;
723         }
724
725         /* Handle buffer underruns and reget the status */
726         if( snd_pcm_status_get_state( p_status ) == SND_PCM_STATE_XRUN )
727         {
728             /* Prepare the device */
729             i_snd_rc = snd_pcm_prepare( p_sys->p_snd_pcm );
730
731             if( i_snd_rc == 0 )
732             {
733                 msg_Warn( p_aout, "recovered from buffer underrun" );
734
735                 /* Reget the status */
736                 i_snd_rc = snd_pcm_status( p_sys->p_snd_pcm, p_status );
737                 if( i_snd_rc < 0 )
738                 {
739                     msg_Err( p_aout, "unable to get the device's status after "
740                              "recovery (%s)", snd_strerror( i_snd_rc ) );
741
742                     msleep( p_sys->i_period_time >> 1 );
743                     return;
744                 }
745             }
746             else
747             {
748                 msg_Err( p_aout, "unable to recover from buffer underrun" );
749
750                 msleep( p_sys->i_period_time >> 1 );
751                 return;
752             }
753
754             /* Underrun, try to recover as quickly as possible */
755             next_date = mdate();
756         }
757         else
758         {
759             /* Here the device should be either in the RUNNING state.
760              * p_status is valid. */
761
762             snd_pcm_status_get_tstamp( p_status, &ts_next );
763             next_date = (mtime_t)ts_next.tv_sec * 1000000 + ts_next.tv_usec;
764             if( next_date )
765             {
766                 next_date += (mtime_t)snd_pcm_status_get_delay(p_status)
767                         * 1000000 / p_aout->output.output.i_rate;
768             }
769             else
770             {
771                 /* With screwed ALSA drivers the timestamp is always zero;
772                  * use another method then */
773                 snd_pcm_sframes_t delay;
774                 ssize_t i_bytes = 0;
775
776                 if( !snd_pcm_delay( p_sys->p_snd_pcm, &delay ) )
777                 {
778                     i_bytes = snd_pcm_frames_to_bytes(p_sys->p_snd_pcm, delay);
779                 }
780                 next_date = mdate() + (mtime_t)i_bytes * 1000000
781                         / p_aout->output.output.i_bytes_per_frame
782                         / p_aout->output.output.i_rate
783                         * p_aout->output.output.i_frame_length;
784             }
785         }
786
787         p_buffer = aout_OutputNextBuffer( p_aout, next_date,
788                         (p_aout->output.output.i_format ==
789                          VLC_FOURCC('s','p','d','i')) );
790
791         /* Audio output buffer shortage -> stop the fill process and wait */
792         if( p_buffer == NULL )
793         {
794             msleep( p_sys->i_period_time >> 1 );
795             return;
796         }
797
798         i_snd_rc = snd_pcm_writei( p_sys->p_snd_pcm, p_buffer->p_buffer,
799                                    p_buffer->i_nb_samples );
800
801         if( i_snd_rc < 0 )
802         {
803             msg_Err( p_aout, "write failed (%s)",
804                              snd_strerror( i_snd_rc ) );
805         }
806
807         aout_BufferFree( p_buffer );
808     }
809 }