]> git.sesse.net Git - vlc/blob - modules/audio_output/alsa.c
ALSA: favor channel maps with fewer unused channels
[vlc] / modules / audio_output / alsa.c
1 /*****************************************************************************
2  * alsa.c : alsa plugin for vlc
3  *****************************************************************************
4  * Copyright (C) 2000-2010 VLC authors and VideoLAN
5  * Copyright (C) 2009-2011 RĂ©mi Denis-Courmont
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 it
13  * under the terms of the GNU Lesser General Public License as published by
14  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
21  *
22  * You should have received a copy of the GNU Lesser General Public License
23  * along with this program; if not, write to the Free Software Foundation,
24  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <assert.h>
32
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
35 #include <vlc_dialog.h>
36 #include <vlc_aout.h>
37 #include <vlc_cpu.h>
38
39 #include <alsa/asoundlib.h>
40 #include <alsa/version.h>
41
42 /** Private data for an ALSA PCM playback stream */
43 struct aout_sys_t
44 {
45     snd_pcm_t *pcm;
46     unsigned rate; /**< Sample rate */
47     vlc_fourcc_t format; /**< Sample format */
48     uint8_t chans_table[AOUT_CHAN_MAX]; /**< Channels order table */
49     uint8_t chans_to_reorder; /**< Number of channels to reorder */
50
51     bool soft_mute;
52     float soft_gain;
53     char *device;
54 };
55
56 #include "volume.h"
57
58 #define A52_FRAME_NB 1536
59
60 static int Open (vlc_object_t *);
61 static void Close (vlc_object_t *);
62 static int EnumDevices (vlc_object_t *, char const *, char ***, char ***);
63
64 #define AUDIO_DEV_TEXT N_("Audio output device")
65 #define AUDIO_DEV_LONGTEXT N_("Audio output device (using ALSA syntax).")
66
67 #define AUDIO_CHAN_TEXT N_("Audio output channels")
68 #define AUDIO_CHAN_LONGTEXT N_("Channels available for audio output. " \
69     "If the input has more channels than the output, it will be down-mixed. " \
70     "This parameter is ignored when digital pass-through is active.")
71 static const int channels[] = {
72     AOUT_CHAN_CENTER, AOUT_CHANS_STEREO, AOUT_CHANS_4_0, AOUT_CHANS_4_1,
73     AOUT_CHANS_5_0, AOUT_CHANS_5_1, AOUT_CHANS_7_1,
74 };
75 static const char *const channels_text[] = {
76     N_("Mono"), N_("Stereo"), N_("Surround 4.0"), N_("Surround 4.1"),
77     N_("Surround 5.0"), N_("Surround 5.1"), N_("Surround 7.1"),
78 };
79
80 vlc_module_begin ()
81     set_shortname( "ALSA" )
82     set_description( N_("ALSA audio output") )
83     set_category( CAT_AUDIO )
84     set_subcategory( SUBCAT_AUDIO_AOUT )
85     add_string ("alsa-audio-device", "default",
86                 AUDIO_DEV_TEXT, AUDIO_DEV_LONGTEXT, false)
87         change_string_cb (EnumDevices)
88     add_integer ("alsa-audio-channels", AOUT_CHANS_FRONT,
89                  AUDIO_CHAN_TEXT, AUDIO_CHAN_LONGTEXT, false)
90         change_integer_list (channels, channels_text)
91     add_sw_gain ()
92     set_capability( "audio output", 150 )
93     set_callbacks( Open, Close )
94 vlc_module_end ()
95
96
97 /** Helper for ALSA -> VLC debugging output */
98 static void Dump (vlc_object_t *obj, const char *msg,
99                   int (*cb)(void *, snd_output_t *), void *p)
100 {
101     snd_output_t *output;
102     char *str;
103
104     if (unlikely(snd_output_buffer_open (&output)))
105         return;
106
107     int val = cb (p, output);
108     if (val)
109     {
110         msg_Warn (obj, "cannot get info: %s", snd_strerror (val));
111         return;
112     }
113
114     size_t len = snd_output_buffer_string (output, &str);
115     if (len > 0 && str[len - 1])
116         len--; /* strip trailing newline */
117     msg_Dbg (obj, "%s%.*s", msg, (int)len, str);
118     snd_output_close (output);
119 }
120 #define Dump(o, m, cb, p) \
121         Dump(VLC_OBJECT(o), m, (int (*)(void *, snd_output_t *))(cb), p)
122
123 static void DumpDevice (vlc_object_t *obj, snd_pcm_t *pcm)
124 {
125     snd_pcm_info_t *info;
126
127     Dump (obj, " ", snd_pcm_dump, pcm);
128     snd_pcm_info_alloca (&info);
129     if (snd_pcm_info (pcm, info) == 0)
130     {
131         msg_Dbg (obj, " device name   : %s", snd_pcm_info_get_name (info));
132         msg_Dbg (obj, " device ID     : %s", snd_pcm_info_get_id (info));
133         msg_Dbg (obj, " subdevice name: %s",
134                 snd_pcm_info_get_subdevice_name (info));
135     }
136 }
137
138 static void DumpDeviceStatus (vlc_object_t *obj, snd_pcm_t *pcm)
139 {
140     snd_pcm_status_t *status;
141
142     snd_pcm_status_alloca (&status);
143     snd_pcm_status (pcm, status);
144     Dump (obj, "current status:\n", snd_pcm_status_dump, status);
145 }
146 #define DumpDeviceStatus(o, p) DumpDeviceStatus(VLC_OBJECT(o), p)
147
148 #if (SND_LIB_VERSION >= 0x01001B)
149 static const uint16_t vlc_chans[] = {
150     [SND_CHMAP_MONO] = AOUT_CHAN_CENTER,
151     [SND_CHMAP_FL]   = AOUT_CHAN_LEFT,
152     [SND_CHMAP_FR]   = AOUT_CHAN_RIGHT,
153     [SND_CHMAP_RL]   = AOUT_CHAN_REARLEFT,
154     [SND_CHMAP_RR]   = AOUT_CHAN_REARRIGHT,
155     [SND_CHMAP_FC]   = AOUT_CHAN_CENTER,
156     [SND_CHMAP_LFE]  = AOUT_CHAN_LFE,
157     [SND_CHMAP_SL]   = AOUT_CHAN_MIDDLELEFT,
158     [SND_CHMAP_SR]   = AOUT_CHAN_MIDDLERIGHT,
159     [SND_CHMAP_RC]   = AOUT_CHAN_REARCENTER,
160 };
161
162 static int Map2Mask (vlc_object_t *obj, const snd_pcm_chmap_t *restrict map)
163 {
164     uint16_t mask = 0;
165
166     for (unsigned i = 0; i < map->channels; i++)
167     {
168         const unsigned pos = map->pos[i];
169         uint_fast16_t vlc_chan = 0;
170
171         if (pos < sizeof (vlc_chans) / sizeof (vlc_chans[0]))
172             vlc_chan = vlc_chans[pos];
173         if (vlc_chan == 0)
174         {
175             msg_Dbg (obj, " %s channel %u position %u", "unsupported", i, pos);
176             return -1;
177         }
178         if (mask & vlc_chan)
179         {
180             msg_Dbg (obj, " %s channel %u position %u", "duplicate", i, pos);
181             return -1;
182         }
183         mask |= vlc_chan;
184     }
185     return mask;
186 }
187
188 /**
189  * Compares a fixed ALSA channels map with the VLC channels order.
190  */
191 static unsigned SetupChannelsFixed(const snd_pcm_chmap_t *restrict map,
192                                uint16_t *restrict maskp, uint8_t *restrict tab)
193 {
194     uint32_t chans_out[AOUT_CHAN_MAX];
195     uint16_t mask = 0;
196
197     for (unsigned i = 0; i < map->channels; i++)
198     {
199         uint_fast16_t vlc_chan = vlc_chans[map->pos[i]];
200
201         chans_out[i] = vlc_chan;
202         mask |= vlc_chan;
203     }
204
205     *maskp = mask;
206     return aout_CheckChannelReorder(NULL, chans_out, mask, tab);
207 }
208
209 /**
210  * Negotiate channels mapping.
211  */
212 static unsigned SetupChannels (vlc_object_t *obj, snd_pcm_t *pcm,
213                                uint16_t *restrict mask, uint8_t *restrict tab)
214 {
215     snd_pcm_chmap_query_t **maps = snd_pcm_query_chmaps (pcm);
216     if (maps == NULL)
217     {   /* Fallback to default order if unknown */
218         msg_Dbg(obj, "channels map not provided");
219         return 0;
220     }
221
222     /* Find most appropriate available channels map */
223     unsigned best_offset, best_score = 0, to_reorder = 0;
224
225     for (snd_pcm_chmap_query_t *const *p = maps; *p != NULL; p++)
226     {
227         snd_pcm_chmap_query_t *map = *p;
228
229         switch (map->type)
230         {
231             case SND_CHMAP_TYPE_FIXED:
232             case SND_CHMAP_TYPE_PAIRED:
233             case SND_CHMAP_TYPE_VAR:
234                 break;
235             default:
236                 msg_Err (obj, "unknown channels map type %u", map->type);
237                 continue;
238         }
239
240         int chans = Map2Mask (obj, &map->map);
241         if (chans == -1)
242             continue;
243
244         unsigned score = (popcount (chans & *mask) << 8)
245                        | (255 - popcount (chans));
246         if (score > best_score)
247         {
248             best_offset = p - maps;
249             best_score = score;
250         }
251     }
252
253     if (best_score == 0)
254     {
255         msg_Err (obj, "cannot find supported channels map");
256         goto out;
257     }
258
259     const snd_pcm_chmap_t *map = &maps[best_offset]->map;
260     msg_Dbg (obj, "using channels map %u, type %u, %u channel(s)", best_offset,
261              maps[best_offset]->type, map->channels);
262
263     /* Setup channels map */
264     to_reorder = SetupChannelsFixed(map, mask, tab);
265
266     /* TODO: avoid reordering for PAIRED and VAR types */
267     //snd_pcm_set_chmap (pcm, ...)
268 out:
269     snd_pcm_free_chmaps (maps);
270     return to_reorder;
271 }
272 #else /* (SND_LIB_VERSION < 0x01001B) */
273 # define SetupChannels(obj, pcm, mask, tab) (0)
274 #endif
275
276 static int TimeGet (audio_output_t *aout, mtime_t *);
277 static void Play (audio_output_t *, block_t *);
278 static void Pause (audio_output_t *, bool, mtime_t);
279 static void PauseDummy (audio_output_t *, bool, mtime_t);
280 static void Flush (audio_output_t *, bool);
281
282 /** Initializes an ALSA playback stream */
283 static int Start (audio_output_t *aout, audio_sample_format_t *restrict fmt)
284 {
285     aout_sys_t *sys = aout->sys;
286     snd_pcm_format_t pcm_format; /* ALSA sample format */
287     bool spdif = false;
288
289     switch (fmt->i_format)
290     {
291         case VLC_CODEC_FL64:
292             pcm_format = SND_PCM_FORMAT_FLOAT64;
293             break;
294         case VLC_CODEC_FL32:
295             pcm_format = SND_PCM_FORMAT_FLOAT;
296             break;
297         case VLC_CODEC_S32N:
298             pcm_format = SND_PCM_FORMAT_S32;
299             break;
300         case VLC_CODEC_S16N:
301             pcm_format = SND_PCM_FORMAT_S16;
302             break;
303         case VLC_CODEC_U8:
304             pcm_format = SND_PCM_FORMAT_U8;
305             break;
306         default:
307             if (AOUT_FMT_SPDIF(fmt))
308                 spdif = var_InheritBool (aout, "spdif");
309             if (spdif)
310             {
311                 fmt->i_format = VLC_CODEC_SPDIFL;
312                 pcm_format = SND_PCM_FORMAT_S16;
313             }
314             else
315             if (HAVE_FPU)
316             {
317                 fmt->i_format = VLC_CODEC_FL32;
318                 pcm_format = SND_PCM_FORMAT_FLOAT;
319             }
320             else
321             {
322                 fmt->i_format = VLC_CODEC_S16N;
323                 pcm_format = SND_PCM_FORMAT_S16;
324             }
325     }
326
327     const char *device = sys->device;
328     char *devbuf = NULL;
329     /* Choose the IEC device for S/PDIF output */
330     if (spdif && !strcmp (device, "default"))
331     {
332         unsigned aes3;
333
334         switch (fmt->i_rate)
335         {
336 #define FS(freq) \
337             case freq: aes3 = IEC958_AES3_CON_FS_ ## freq; break;
338             FS( 44100) /* def. */ FS( 48000) FS( 32000)
339             FS( 22050)            FS( 24000)
340             FS( 88200) FS(768000) FS( 96000)
341             FS(176400)            FS(192000)
342 #undef FS
343             default:
344                 aes3 = IEC958_AES3_CON_FS_NOTID;
345                 break;
346         }
347
348         if (asprintf (&devbuf,
349                       "iec958:AES0=0x%x,AES1=0x%x,AES2=0x%x,AES3=0x%x",
350                       IEC958_AES0_CON_EMPHASIS_NONE | IEC958_AES0_NONAUDIO,
351                       IEC958_AES1_CON_ORIGINAL | IEC958_AES1_CON_PCM_CODER,
352                       0, aes3) == -1)
353             return VLC_ENOMEM;
354         device = devbuf;
355     }
356
357     /* Open the device */
358     snd_pcm_t *pcm;
359     /* VLC always has a resampler. No need for ALSA's. */
360     const int mode = SND_PCM_NO_AUTO_RESAMPLE;
361
362     int val = snd_pcm_open (&pcm, device, SND_PCM_STREAM_PLAYBACK, mode);
363     free (devbuf);
364     if (val != 0)
365     {
366         msg_Err (aout, "cannot open ALSA device \"%s\": %s", sys->device,
367                  snd_strerror (val));
368         dialog_Fatal (aout, _("Audio output failed"),
369                       _("The audio device \"%s\" could not be used:\n%s."),
370                       sys->device, snd_strerror (val));
371         return VLC_EGENERIC;
372     }
373     sys->pcm = pcm;
374
375     /* Print some potentially useful debug */
376     msg_Dbg (aout, "using ALSA device: %s", sys->device);
377     DumpDevice (VLC_OBJECT(aout), pcm);
378
379     /* Get Initial hardware parameters */
380     snd_pcm_hw_params_t *hw;
381     unsigned param;
382
383     snd_pcm_hw_params_alloca (&hw);
384     snd_pcm_hw_params_any (pcm, hw);
385     Dump (aout, "initial hardware setup:\n", snd_pcm_hw_params_dump, hw);
386
387     val = snd_pcm_hw_params_set_rate_resample(pcm, hw, 0);
388     if (val)
389     {
390         msg_Err (aout, "cannot disable resampling: %s", snd_strerror (val));
391         goto error;
392     }
393
394     val = snd_pcm_hw_params_set_access (pcm, hw,
395                                         SND_PCM_ACCESS_RW_INTERLEAVED);
396     if (val)
397     {
398         msg_Err (aout, "cannot set access mode: %s", snd_strerror (val));
399         goto error;
400     }
401
402     /* Set sample format */
403     if (snd_pcm_hw_params_test_format (pcm, hw, pcm_format) == 0)
404         ;
405     else
406     if (snd_pcm_hw_params_test_format (pcm, hw, SND_PCM_FORMAT_FLOAT) == 0)
407     {
408         fmt->i_format = VLC_CODEC_FL32;
409         pcm_format = SND_PCM_FORMAT_FLOAT;
410     }
411     else
412     if (snd_pcm_hw_params_test_format (pcm, hw, SND_PCM_FORMAT_S32) == 0)
413     {
414         fmt->i_format = VLC_CODEC_S32N;
415         pcm_format = SND_PCM_FORMAT_S32;
416     }
417     else
418     if (snd_pcm_hw_params_test_format (pcm, hw, SND_PCM_FORMAT_S16) == 0)
419     {
420         fmt->i_format = VLC_CODEC_S16N;
421         pcm_format = SND_PCM_FORMAT_S16;
422     }
423     else
424     {
425         msg_Err (aout, "no supported sample format");
426         goto error;
427     }
428
429     val = snd_pcm_hw_params_set_format (pcm, hw, pcm_format);
430     if (val)
431     {
432         msg_Err (aout, "cannot set sample format: %s", snd_strerror (val));
433         goto error;
434     }
435
436     /* Set channels count */
437     unsigned channels;
438     if (!spdif)
439     {
440         uint16_t map = var_InheritInteger (aout, "alsa-audio-channels");
441
442         sys->chans_to_reorder = SetupChannels (VLC_OBJECT(aout), pcm, &map,
443                                                sys->chans_table);
444         fmt->i_physical_channels = map;
445         fmt->i_original_channels = map;
446         channels = popcount (map);
447     }
448     else
449     {
450         sys->chans_to_reorder = 0;
451         channels = 2;
452     }
453
454     /* By default, ALSA plug will pad missing channels with zeroes, which is
455      * usually fine. However, it will also discard extraneous channels, which
456      * is not acceptable. Thus the user must configure the physically
457      * available channels, and VLC will downmix if needed. */
458     val = snd_pcm_hw_params_set_channels (pcm, hw, channels);
459     if (val)
460     {
461         msg_Err (aout, "cannot set %u channels: %s", channels,
462                  snd_strerror (val));
463         goto error;
464     }
465
466     /* Set sample rate */
467     val = snd_pcm_hw_params_set_rate_near (pcm, hw, &fmt->i_rate, NULL);
468     if (val)
469     {
470         msg_Err (aout, "cannot set sample rate: %s", snd_strerror (val));
471         goto error;
472     }
473     sys->rate = fmt->i_rate;
474
475     /* Set buffer size */
476     param = AOUT_MAX_ADVANCE_TIME;
477     val = snd_pcm_hw_params_set_buffer_time_near (pcm, hw, &param, NULL);
478     if (val)
479     {
480         msg_Err (aout, "cannot set buffer duration: %s", snd_strerror (val));
481         goto error;
482     }
483 #if 0
484     val = snd_pcm_hw_params_get_buffer_time (hw, &param, NULL);
485     if (val)
486     {
487         msg_Warn (aout, "cannot get buffer time: %s", snd_strerror(val));
488         param = AOUT_MIN_PREPARE_TIME;
489     }
490     else
491         param /= 2;
492 #else /* work-around for period-long latency outputs (e.g. PulseAudio): */
493     param = AOUT_MIN_PREPARE_TIME;
494 #endif
495     val = snd_pcm_hw_params_set_period_time_near (pcm, hw, &param, NULL);
496     if (val)
497     {
498         msg_Err (aout, "cannot set period: %s", snd_strerror (val));
499         goto error;
500     }
501
502     /* Commit hardware parameters */
503     val = snd_pcm_hw_params (pcm, hw);
504     if (val < 0)
505     {
506         msg_Err (aout, "cannot commit hardware parameters: %s",
507                  snd_strerror (val));
508         goto error;
509     }
510     Dump (aout, "final HW setup:\n", snd_pcm_hw_params_dump, hw);
511
512     /* Get Initial software parameters */
513     snd_pcm_sw_params_t *sw;
514
515     snd_pcm_sw_params_alloca (&sw);
516     snd_pcm_sw_params_current (pcm, sw);
517     Dump (aout, "initial software parameters:\n", snd_pcm_sw_params_dump, sw);
518
519     /* START REVISIT */
520     //snd_pcm_sw_params_set_avail_min( pcm, sw, i_period_size );
521     // FIXME: useful?
522     val = snd_pcm_sw_params_set_start_threshold (pcm, sw, 1);
523     if( val < 0 )
524     {
525         msg_Err( aout, "unable to set start threshold (%s)",
526                  snd_strerror( val ) );
527         goto error;
528     }
529     /* END REVISIT */
530
531     /* Commit software parameters. */
532     val = snd_pcm_sw_params (pcm, sw);
533     if (val)
534     {
535         msg_Err (aout, "cannot commit software parameters: %s",
536                  snd_strerror (val));
537         goto error;
538     }
539     Dump (aout, "final software parameters:\n", snd_pcm_sw_params_dump, sw);
540
541     val = snd_pcm_prepare (pcm);
542     if (val)
543     {
544         msg_Err (aout, "cannot prepare device: %s", snd_strerror (val));
545         goto error;
546     }
547
548     /* Setup audio_output_t */
549     if (spdif)
550     {
551         fmt->i_bytes_per_frame = AOUT_SPDIF_SIZE;
552         fmt->i_frame_length = A52_FRAME_NB;
553     }
554     sys->format = fmt->i_format;
555
556     aout->time_get = TimeGet;
557     aout->play = Play;
558     if (snd_pcm_hw_params_can_pause (hw))
559         aout->pause = Pause;
560     else
561     {
562         aout->pause = PauseDummy;
563         msg_Warn (aout, "device cannot be paused");
564     }
565     aout->flush = Flush;
566     aout_SoftVolumeStart (aout);
567     return 0;
568
569 error:
570     snd_pcm_close (pcm);
571     return VLC_EGENERIC;
572 }
573
574 static int TimeGet (audio_output_t *aout, mtime_t *restrict delay)
575 {
576     aout_sys_t *sys = aout->sys;
577     snd_pcm_sframes_t frames;
578
579     int val = snd_pcm_delay (sys->pcm, &frames);
580     if (val)
581     {
582         msg_Err (aout, "cannot estimate delay: %s", snd_strerror (val));
583         return -1;
584     }
585     *delay = frames * CLOCK_FREQ / sys->rate;
586     return 0;
587 }
588
589 /**
590  * Queues one audio buffer to the hardware.
591  */
592 static void Play (audio_output_t *aout, block_t *block)
593 {
594     aout_sys_t *sys = aout->sys;
595
596     if (sys->chans_to_reorder != 0)
597         aout_ChannelReorder(block->p_buffer, block->i_buffer,
598                            sys->chans_to_reorder, sys->chans_table, sys->format);
599
600     snd_pcm_t *pcm = sys->pcm;
601
602     /* TODO: better overflow handling */
603     /* TODO: no period wake ups */
604
605     while (block->i_nb_samples > 0)
606     {
607         snd_pcm_sframes_t frames;
608
609         frames = snd_pcm_writei (pcm, block->p_buffer, block->i_nb_samples);
610         if (frames >= 0)
611         {
612             size_t bytes = snd_pcm_frames_to_bytes (pcm, frames);
613             block->i_nb_samples -= frames;
614             block->p_buffer += bytes;
615             block->i_buffer -= bytes;
616             // pts, length
617         }
618         else  
619         {
620             int val = snd_pcm_recover (pcm, frames, 1);
621             if (val)
622             {
623                 msg_Err (aout, "cannot recover playback stream: %s",
624                          snd_strerror (val));
625                 DumpDeviceStatus (aout, pcm);
626                 break;
627             }
628             msg_Warn (aout, "cannot write samples: %s", snd_strerror (frames));
629         }
630     }
631     block_Release (block);
632 }
633
634 /**
635  * Pauses/resumes the audio playback.
636  */
637 static void Pause (audio_output_t *aout, bool pause, mtime_t date)
638 {
639     snd_pcm_t *pcm = aout->sys->pcm;
640
641     int val = snd_pcm_pause (pcm, pause);
642     if (unlikely(val))
643         PauseDummy (aout, pause, date);
644 }
645
646 static void PauseDummy (audio_output_t *aout, bool pause, mtime_t date)
647 {
648     snd_pcm_t *pcm = aout->sys->pcm;
649
650     /* Stupid device cannot pause. Discard samples. */
651     if (pause)
652         snd_pcm_drop (pcm);
653     else
654         snd_pcm_prepare (pcm);
655     (void) date;
656 }
657
658 /**
659  * Flushes/drains the audio playback buffer.
660  */
661 static void Flush (audio_output_t *aout, bool wait)
662 {
663     snd_pcm_t *pcm = aout->sys->pcm;
664
665     if (wait)
666         snd_pcm_drain (pcm);
667     else
668         snd_pcm_drop (pcm);
669     snd_pcm_prepare (pcm);
670 }
671
672
673 /**
674  * Releases the audio output.
675  */
676 static void Stop (audio_output_t *aout)
677 {
678     aout_sys_t *sys = aout->sys;
679     snd_pcm_t *pcm = sys->pcm;
680
681     snd_pcm_drop (pcm);
682     snd_pcm_close (pcm);
683 }
684
685 /**
686  * Enumerates ALSA output devices.
687  */
688 static int EnumDevices(vlc_object_t *obj, char const *varname,
689                        char ***restrict idp, char ***restrict namep)
690 {
691     void **hints;
692
693     msg_Dbg (obj, "Available ALSA PCM devices:");
694     if (snd_device_name_hint(-1, "pcm", &hints) < 0)
695         return -1;
696
697     char **ids = NULL, **names = NULL;
698     unsigned n = 0;
699
700     for (size_t i = 0; hints[i] != NULL; i++)
701     {
702         void *hint = hints[i];
703
704         char *name = snd_device_name_get_hint(hint, "NAME");
705         if (unlikely(name == NULL))
706             continue;
707
708         char *desc = snd_device_name_get_hint(hint, "DESC");
709         if (desc != NULL)
710             for (char *lf = strchr(desc, '\n'); lf; lf = strchr(lf, '\n'))
711                  *lf = ' ';
712         msg_Dbg (obj, "%s (%s)", (desc != NULL) ? desc : name, name);
713
714         ids = xrealloc (ids, (n + 1) * sizeof (*ids));
715         names = xrealloc (names, (n + 1) * sizeof (*names));
716         ids[n] = name;
717         names[n] = desc;
718         n++;
719     }
720
721     snd_device_name_free_hint(hints);
722     *idp = ids;
723     *namep = names;
724     (void) varname;
725     return n;
726 }
727
728 static int DeviceSelect (audio_output_t *aout, const char *id)
729 {
730     aout_sys_t *sys = aout->sys;
731
732     char *device = strdup (id ? id : "default");
733     if (unlikely(device == NULL))
734         return -1;
735
736     free (sys->device);
737     sys->device = device;
738     aout_DeviceReport (aout, device);
739     aout_RestartRequest (aout, AOUT_RESTART_OUTPUT);
740     return 0;
741 }
742
743 static int Open(vlc_object_t *obj)
744 {
745     audio_output_t *aout = (audio_output_t *)obj;
746     aout_sys_t *sys = malloc (sizeof (*sys));
747
748     if (unlikely(sys == NULL))
749         return VLC_ENOMEM;
750     sys->device = var_InheritString (aout, "alsa-audio-device");
751     if (unlikely(sys->device == NULL))
752         goto error;
753
754     aout->sys = sys;
755     aout->start = Start;
756     aout->stop = Stop;
757     aout_SoftVolumeInit (aout);
758     aout->device_select = DeviceSelect;
759     aout_DeviceReport (aout, sys->device);
760
761     /* ALSA does not support hot-plug events so list devices at startup */
762     char **ids, **names;
763     int count = EnumDevices (VLC_OBJECT(aout), NULL, &ids, &names);
764     if (count >= 0)
765     {
766         for (int i = 0; i < count; i++)
767         {
768             aout_HotplugReport (aout, ids[i], names[i]);
769             free (names[i]);
770             free (ids[i]);
771         }
772         free (names);
773         free (ids);
774     }
775
776     return VLC_SUCCESS;
777 error:
778     free (sys);
779     return VLC_ENOMEM;
780 }
781
782 static void Close(vlc_object_t *obj)
783 {
784     audio_output_t *aout = (audio_output_t *)obj;
785     aout_sys_t *sys = aout->sys;
786
787     free (sys->device);
788     free (sys);
789 }