]> git.sesse.net Git - vlc/blob - modules/audio_output/alsa.c
auhal: ignore invalid default audio device changes (fixes #9374)
[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 #if 1 /* work-around for period-long latency outputs (e.g. PulseAudio): */
476     param = AOUT_MIN_PREPARE_TIME;
477     val = snd_pcm_hw_params_set_period_time_near (pcm, hw, &param, NULL);
478     if (val)
479     {
480         msg_Err (aout, "cannot set period: %s", snd_strerror (val));
481         goto error;
482     }
483 #endif
484     /* Set buffer size */
485     param = AOUT_MAX_ADVANCE_TIME;
486     val = snd_pcm_hw_params_set_buffer_time_near (pcm, hw, &param, NULL);
487     if (val)
488     {
489         msg_Err (aout, "cannot set buffer duration: %s", snd_strerror (val));
490         goto error;
491     }
492 #if 0
493     val = snd_pcm_hw_params_get_buffer_time (hw, &param, NULL);
494     if (val)
495     {
496         msg_Warn (aout, "cannot get buffer time: %s", snd_strerror(val));
497         param = AOUT_MIN_PREPARE_TIME;
498     }
499     else
500         param /= 2;
501     val = snd_pcm_hw_params_set_period_time_near (pcm, hw, &param, NULL);
502     if (val)
503     {
504         msg_Err (aout, "cannot set period: %s", snd_strerror (val));
505         goto error;
506     }
507 #endif
508
509     /* Commit hardware parameters */
510     val = snd_pcm_hw_params (pcm, hw);
511     if (val < 0)
512     {
513         msg_Err (aout, "cannot commit hardware parameters: %s",
514                  snd_strerror (val));
515         goto error;
516     }
517     Dump (aout, "final HW setup:\n", snd_pcm_hw_params_dump, hw);
518
519     /* Get Initial software parameters */
520     snd_pcm_sw_params_t *sw;
521
522     snd_pcm_sw_params_alloca (&sw);
523     snd_pcm_sw_params_current (pcm, sw);
524     Dump (aout, "initial software parameters:\n", snd_pcm_sw_params_dump, sw);
525
526     /* START REVISIT */
527     //snd_pcm_sw_params_set_avail_min( pcm, sw, i_period_size );
528     // FIXME: useful?
529     val = snd_pcm_sw_params_set_start_threshold (pcm, sw, 1);
530     if( val < 0 )
531     {
532         msg_Err( aout, "unable to set start threshold (%s)",
533                  snd_strerror( val ) );
534         goto error;
535     }
536     /* END REVISIT */
537
538     /* Commit software parameters. */
539     val = snd_pcm_sw_params (pcm, sw);
540     if (val)
541     {
542         msg_Err (aout, "cannot commit software parameters: %s",
543                  snd_strerror (val));
544         goto error;
545     }
546     Dump (aout, "final software parameters:\n", snd_pcm_sw_params_dump, sw);
547
548     val = snd_pcm_prepare (pcm);
549     if (val)
550     {
551         msg_Err (aout, "cannot prepare device: %s", snd_strerror (val));
552         goto error;
553     }
554
555     /* Setup audio_output_t */
556     if (spdif)
557     {
558         fmt->i_bytes_per_frame = AOUT_SPDIF_SIZE;
559         fmt->i_frame_length = A52_FRAME_NB;
560     }
561     sys->format = fmt->i_format;
562
563     aout->time_get = TimeGet;
564     aout->play = Play;
565     if (snd_pcm_hw_params_can_pause (hw))
566         aout->pause = Pause;
567     else
568     {
569         aout->pause = PauseDummy;
570         msg_Warn (aout, "device cannot be paused");
571     }
572     aout->flush = Flush;
573     aout_SoftVolumeStart (aout);
574     return 0;
575
576 error:
577     snd_pcm_close (pcm);
578     return VLC_EGENERIC;
579 }
580
581 static int TimeGet (audio_output_t *aout, mtime_t *restrict delay)
582 {
583     aout_sys_t *sys = aout->sys;
584     snd_pcm_sframes_t frames;
585
586     int val = snd_pcm_delay (sys->pcm, &frames);
587     if (val)
588     {
589         msg_Err (aout, "cannot estimate delay: %s", snd_strerror (val));
590         return -1;
591     }
592     *delay = frames * CLOCK_FREQ / sys->rate;
593     return 0;
594 }
595
596 /**
597  * Queues one audio buffer to the hardware.
598  */
599 static void Play (audio_output_t *aout, block_t *block)
600 {
601     aout_sys_t *sys = aout->sys;
602
603     if (sys->chans_to_reorder != 0)
604         aout_ChannelReorder(block->p_buffer, block->i_buffer,
605                            sys->chans_to_reorder, sys->chans_table, sys->format);
606
607     snd_pcm_t *pcm = sys->pcm;
608
609     /* TODO: better overflow handling */
610     /* TODO: no period wake ups */
611
612     while (block->i_nb_samples > 0)
613     {
614         snd_pcm_sframes_t frames;
615
616         frames = snd_pcm_writei (pcm, block->p_buffer, block->i_nb_samples);
617         if (frames >= 0)
618         {
619             size_t bytes = snd_pcm_frames_to_bytes (pcm, frames);
620             block->i_nb_samples -= frames;
621             block->p_buffer += bytes;
622             block->i_buffer -= bytes;
623             // pts, length
624         }
625         else  
626         {
627             int val = snd_pcm_recover (pcm, frames, 1);
628             if (val)
629             {
630                 msg_Err (aout, "cannot recover playback stream: %s",
631                          snd_strerror (val));
632                 DumpDeviceStatus (aout, pcm);
633                 break;
634             }
635             msg_Warn (aout, "cannot write samples: %s", snd_strerror (frames));
636         }
637     }
638     block_Release (block);
639 }
640
641 /**
642  * Pauses/resumes the audio playback.
643  */
644 static void Pause (audio_output_t *aout, bool pause, mtime_t date)
645 {
646     snd_pcm_t *pcm = aout->sys->pcm;
647
648     int val = snd_pcm_pause (pcm, pause);
649     if (unlikely(val))
650         PauseDummy (aout, pause, date);
651 }
652
653 static void PauseDummy (audio_output_t *aout, bool pause, mtime_t date)
654 {
655     snd_pcm_t *pcm = aout->sys->pcm;
656
657     /* Stupid device cannot pause. Discard samples. */
658     if (pause)
659         snd_pcm_drop (pcm);
660     else
661         snd_pcm_prepare (pcm);
662     (void) date;
663 }
664
665 /**
666  * Flushes/drains the audio playback buffer.
667  */
668 static void Flush (audio_output_t *aout, bool wait)
669 {
670     snd_pcm_t *pcm = aout->sys->pcm;
671
672     if (wait)
673         snd_pcm_drain (pcm);
674     else
675         snd_pcm_drop (pcm);
676     snd_pcm_prepare (pcm);
677 }
678
679
680 /**
681  * Releases the audio output.
682  */
683 static void Stop (audio_output_t *aout)
684 {
685     aout_sys_t *sys = aout->sys;
686     snd_pcm_t *pcm = sys->pcm;
687
688     snd_pcm_drop (pcm);
689     snd_pcm_close (pcm);
690 }
691
692 /**
693  * Enumerates ALSA output devices.
694  */
695 static int EnumDevices(vlc_object_t *obj, char const *varname,
696                        char ***restrict idp, char ***restrict namep)
697 {
698     void **hints;
699
700     msg_Dbg (obj, "Available ALSA PCM devices:");
701     if (snd_device_name_hint(-1, "pcm", &hints) < 0)
702         return -1;
703
704     char **ids = NULL, **names = NULL;
705     unsigned n = 0;
706
707     for (size_t i = 0; hints[i] != NULL; i++)
708     {
709         void *hint = hints[i];
710
711         char *name = snd_device_name_get_hint(hint, "NAME");
712         if (unlikely(name == NULL))
713             continue;
714
715         char *desc = snd_device_name_get_hint(hint, "DESC");
716         if (desc != NULL)
717             for (char *lf = strchr(desc, '\n'); lf; lf = strchr(lf, '\n'))
718                  *lf = ' ';
719         msg_Dbg (obj, "%s (%s)", (desc != NULL) ? desc : name, name);
720
721         ids = xrealloc (ids, (n + 1) * sizeof (*ids));
722         names = xrealloc (names, (n + 1) * sizeof (*names));
723         ids[n] = name;
724         names[n] = desc;
725         n++;
726     }
727
728     snd_device_name_free_hint(hints);
729     *idp = ids;
730     *namep = names;
731     (void) varname;
732     return n;
733 }
734
735 static int DeviceSelect (audio_output_t *aout, const char *id)
736 {
737     aout_sys_t *sys = aout->sys;
738
739     char *device = strdup (id ? id : "default");
740     if (unlikely(device == NULL))
741         return -1;
742
743     free (sys->device);
744     sys->device = device;
745     aout_DeviceReport (aout, device);
746     aout_RestartRequest (aout, AOUT_RESTART_OUTPUT);
747     return 0;
748 }
749
750 static int Open(vlc_object_t *obj)
751 {
752     audio_output_t *aout = (audio_output_t *)obj;
753     aout_sys_t *sys = malloc (sizeof (*sys));
754
755     if (unlikely(sys == NULL))
756         return VLC_ENOMEM;
757     sys->device = var_InheritString (aout, "alsa-audio-device");
758     if (unlikely(sys->device == NULL))
759         goto error;
760
761     aout->sys = sys;
762     aout->start = Start;
763     aout->stop = Stop;
764     aout_SoftVolumeInit (aout);
765     aout->device_select = DeviceSelect;
766     aout_DeviceReport (aout, sys->device);
767
768     /* ALSA does not support hot-plug events so list devices at startup */
769     char **ids, **names;
770     int count = EnumDevices (VLC_OBJECT(aout), NULL, &ids, &names);
771     if (count >= 0)
772     {
773         for (int i = 0; i < count; i++)
774         {
775             aout_HotplugReport (aout, ids[i], names[i]);
776             free (names[i]);
777             free (ids[i]);
778         }
779         free (names);
780         free (ids);
781     }
782
783     return VLC_SUCCESS;
784 error:
785     free (sys);
786     return VLC_ENOMEM;
787 }
788
789 static void Close(vlc_object_t *obj)
790 {
791     audio_output_t *aout = (audio_output_t *)obj;
792     aout_sys_t *sys = aout->sys;
793
794     free (sys->device);
795     free (sys);
796 }