add new function pa_alsa_build_pollfd() to alsa-util to unify a bit more common code...
[profile/ivi/pulseaudio-panda.git] / src / modules / alsa-util.c
1 /* $Id$ */
2
3 /***
4   This file is part of PulseAudio.
5
6   Copyright 2004-2006 Lennart Poettering
7   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
8
9   PulseAudio is free software; you can redistribute it and/or modify
10   it under the terms of the GNU Lesser General Public License as published
11   by the Free Software Foundation; either version 2 of the License,
12   or (at your option) any later version.
13
14   PulseAudio is distributed in the hope that it will be useful, but
15   WITHOUT ANY WARRANTY; without even the implied warranty of
16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17   General Public License for more details.
18
19   You should have received a copy of the GNU Lesser General Public License
20   along with PulseAudio; if not, write to the Free Software
21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
22   USA.
23 ***/
24
25 #ifdef HAVE_CONFIG_H
26 #include <config.h>
27 #endif
28
29 #include <sys/types.h>
30 #include <limits.h>
31 #include <asoundlib.h>
32
33 #include <pulse/sample.h>
34 #include <pulse/xmalloc.h>
35
36 #include <pulsecore/log.h>
37 #include <pulsecore/macro.h>
38 #include <pulsecore/core-util.h>
39 #include <pulsecore/atomic.h>
40
41 #include "alsa-util.h"
42
43 struct pa_alsa_fdlist {
44     int num_fds;
45     struct pollfd *fds;
46     /* This is a temporary buffer used to avoid lots of mallocs */
47     struct pollfd *work_fds;
48
49     snd_mixer_t *mixer;
50
51     pa_mainloop_api *m;
52     pa_defer_event *defer;
53     pa_io_event **ios;
54
55     int polled;
56
57     void (*cb)(void *userdata);
58     void *userdata;
59 };
60
61 static void io_cb(pa_mainloop_api*a, pa_io_event* e, PA_GCC_UNUSED int fd, pa_io_event_flags_t events, void *userdata) {
62
63     struct pa_alsa_fdlist *fdl = userdata;
64     int err, i;
65     unsigned short revents;
66
67     pa_assert(a);
68     pa_assert(fdl);
69     pa_assert(fdl->mixer);
70     pa_assert(fdl->fds);
71     pa_assert(fdl->work_fds);
72
73     if (fdl->polled)
74         return;
75
76     fdl->polled = 1;
77
78     memcpy(fdl->work_fds, fdl->fds, sizeof(struct pollfd) * fdl->num_fds);
79
80     for (i = 0;i < fdl->num_fds; i++) {
81         if (e == fdl->ios[i]) {
82             if (events & PA_IO_EVENT_INPUT)
83                 fdl->work_fds[i].revents |= POLLIN;
84             if (events & PA_IO_EVENT_OUTPUT)
85                 fdl->work_fds[i].revents |= POLLOUT;
86             if (events & PA_IO_EVENT_ERROR)
87                 fdl->work_fds[i].revents |= POLLERR;
88             if (events & PA_IO_EVENT_HANGUP)
89                 fdl->work_fds[i].revents |= POLLHUP;
90             break;
91         }
92     }
93
94     pa_assert(i != fdl->num_fds);
95
96     if ((err = snd_mixer_poll_descriptors_revents(fdl->mixer, fdl->work_fds, fdl->num_fds, &revents)) < 0) {
97         pa_log_error("Unable to get poll revent: %s", snd_strerror(err));
98         return;
99     }
100
101     a->defer_enable(fdl->defer, 1);
102
103     if (revents)
104         snd_mixer_handle_events(fdl->mixer);
105 }
106
107 static void defer_cb(pa_mainloop_api*a, PA_GCC_UNUSED pa_defer_event* e, void *userdata) {
108     struct pa_alsa_fdlist *fdl = userdata;
109     int num_fds, i, err;
110     struct pollfd *temp;
111
112     pa_assert(a);
113     pa_assert(fdl);
114     pa_assert(fdl->mixer);
115
116     a->defer_enable(fdl->defer, 0);
117
118     num_fds = snd_mixer_poll_descriptors_count(fdl->mixer);
119     pa_assert(num_fds > 0);
120
121     if (num_fds != fdl->num_fds) {
122         if (fdl->fds)
123             pa_xfree(fdl->fds);
124         if (fdl->work_fds)
125             pa_xfree(fdl->work_fds);
126         fdl->fds = pa_xnew0(struct pollfd, num_fds);
127         fdl->work_fds = pa_xnew(struct pollfd, num_fds);
128     }
129
130     memset(fdl->work_fds, 0, sizeof(struct pollfd) * num_fds);
131
132     if ((err = snd_mixer_poll_descriptors(fdl->mixer, fdl->work_fds, num_fds)) < 0) {
133         pa_log_error("Unable to get poll descriptors: %s", snd_strerror(err));
134         return;
135     }
136
137     fdl->polled = 0;
138
139     if (memcmp(fdl->fds, fdl->work_fds, sizeof(struct pollfd) * num_fds) == 0)
140         return;
141
142     if (fdl->ios) {
143         for (i = 0; i < fdl->num_fds; i++)
144             a->io_free(fdl->ios[i]);
145
146         if (num_fds != fdl->num_fds) {
147             pa_xfree(fdl->ios);
148             fdl->ios = NULL;
149         }
150     }
151
152     if (!fdl->ios)
153         fdl->ios = pa_xnew(pa_io_event*, num_fds);
154
155     /* Swap pointers */
156     temp = fdl->work_fds;
157     fdl->work_fds = fdl->fds;
158     fdl->fds = temp;
159
160     fdl->num_fds = num_fds;
161
162     for (i = 0;i < num_fds;i++)
163         fdl->ios[i] = a->io_new(a, fdl->fds[i].fd,
164             ((fdl->fds[i].events & POLLIN) ? PA_IO_EVENT_INPUT : 0) |
165             ((fdl->fds[i].events & POLLOUT) ? PA_IO_EVENT_OUTPUT : 0),
166             io_cb, fdl);
167 }
168
169 struct pa_alsa_fdlist *pa_alsa_fdlist_new(void) {
170     struct pa_alsa_fdlist *fdl;
171
172     fdl = pa_xnew0(struct pa_alsa_fdlist, 1);
173
174     fdl->num_fds = 0;
175     fdl->fds = NULL;
176     fdl->work_fds = NULL;
177     fdl->mixer = NULL;
178     fdl->m = NULL;
179     fdl->defer = NULL;
180     fdl->ios = NULL;
181     fdl->polled = 0;
182
183     return fdl;
184 }
185
186 void pa_alsa_fdlist_free(struct pa_alsa_fdlist *fdl) {
187     pa_assert(fdl);
188
189     if (fdl->defer) {
190         pa_assert(fdl->m);
191         fdl->m->defer_free(fdl->defer);
192     }
193
194     if (fdl->ios) {
195         int i;
196         pa_assert(fdl->m);
197         for (i = 0;i < fdl->num_fds;i++)
198             fdl->m->io_free(fdl->ios[i]);
199         pa_xfree(fdl->ios);
200     }
201
202     if (fdl->fds)
203         pa_xfree(fdl->fds);
204     if (fdl->work_fds)
205         pa_xfree(fdl->work_fds);
206
207     pa_xfree(fdl);
208 }
209
210 int pa_alsa_fdlist_set_mixer(struct pa_alsa_fdlist *fdl, snd_mixer_t *mixer_handle, pa_mainloop_api* m) {
211     pa_assert(fdl);
212     pa_assert(mixer_handle);
213     pa_assert(m);
214     pa_assert(!fdl->m);
215
216     fdl->mixer = mixer_handle;
217     fdl->m = m;
218     fdl->defer = m->defer_new(m, defer_cb, fdl);
219
220     return 0;
221 }
222
223 static int set_format(snd_pcm_t *pcm_handle, snd_pcm_hw_params_t *hwparams, pa_sample_format_t *f) {
224
225     static const snd_pcm_format_t format_trans[] = {
226         [PA_SAMPLE_U8] = SND_PCM_FORMAT_U8,
227         [PA_SAMPLE_ALAW] = SND_PCM_FORMAT_A_LAW,
228         [PA_SAMPLE_ULAW] = SND_PCM_FORMAT_MU_LAW,
229         [PA_SAMPLE_S16LE] = SND_PCM_FORMAT_S16_LE,
230         [PA_SAMPLE_S16BE] = SND_PCM_FORMAT_S16_BE,
231         [PA_SAMPLE_FLOAT32LE] = SND_PCM_FORMAT_FLOAT_LE,
232         [PA_SAMPLE_FLOAT32BE] = SND_PCM_FORMAT_FLOAT_BE,
233         [PA_SAMPLE_S32LE] = SND_PCM_FORMAT_S32_LE,
234         [PA_SAMPLE_S32BE] = SND_PCM_FORMAT_S32_BE,
235     };
236
237     static const pa_sample_format_t try_order[] = {
238         PA_SAMPLE_FLOAT32NE,
239         PA_SAMPLE_FLOAT32RE,
240         PA_SAMPLE_S32NE,
241         PA_SAMPLE_S32RE,
242         PA_SAMPLE_S16NE,
243         PA_SAMPLE_S16RE,
244         PA_SAMPLE_ALAW,
245         PA_SAMPLE_ULAW,
246         PA_SAMPLE_U8,
247         PA_SAMPLE_INVALID
248     };
249
250     int i, ret;
251
252     pa_assert(pcm_handle);
253     pa_assert(f);
254
255     if ((ret = snd_pcm_hw_params_set_format(pcm_handle, hwparams, format_trans[*f])) >= 0)
256         return ret;
257
258     if (*f == PA_SAMPLE_FLOAT32BE)
259         *f = PA_SAMPLE_FLOAT32LE;
260     else if (*f == PA_SAMPLE_FLOAT32LE)
261         *f = PA_SAMPLE_FLOAT32BE;
262     else if (*f == PA_SAMPLE_S16BE)
263         *f = PA_SAMPLE_S16LE;
264     else if (*f == PA_SAMPLE_S16LE)
265         *f = PA_SAMPLE_S16BE;
266     else if (*f == PA_SAMPLE_S32BE)
267         *f = PA_SAMPLE_S32LE;
268     else if (*f == PA_SAMPLE_S32LE)
269         *f = PA_SAMPLE_S32BE;
270     else
271         goto try_auto;
272
273     if ((ret = snd_pcm_hw_params_set_format(pcm_handle, hwparams, format_trans[*f])) >= 0)
274         return ret;
275
276 try_auto:
277
278     for (i = 0; try_order[i] != PA_SAMPLE_INVALID; i++) {
279         *f = try_order[i];
280
281         if ((ret = snd_pcm_hw_params_set_format(pcm_handle, hwparams, format_trans[*f])) >= 0)
282             return ret;
283     }
284
285     return -1;
286 }
287
288 /* Set the hardware parameters of the given ALSA device. Returns the
289  * selected fragment settings in *period and *period_size */
290 int pa_alsa_set_hw_params(
291         snd_pcm_t *pcm_handle,
292         pa_sample_spec *ss,
293         uint32_t *periods,
294         snd_pcm_uframes_t *period_size,
295         snd_pcm_uframes_t tsched_size,
296         pa_bool_t *use_mmap,
297         pa_bool_t *use_tsched,
298         pa_bool_t require_exact_channel_number) {
299
300     int ret = -1;
301     snd_pcm_uframes_t _period_size = *period_size;
302     unsigned int _periods = *periods;
303     snd_pcm_uframes_t buffer_size;
304     unsigned int r = ss->rate;
305     unsigned int c = ss->channels;
306     pa_sample_format_t f = ss->format;
307     snd_pcm_hw_params_t *hwparams;
308     pa_bool_t _use_mmap = use_mmap && *use_mmap;
309     pa_bool_t _use_tsched = use_tsched && *use_tsched;
310     int dir;
311
312     pa_assert(pcm_handle);
313     pa_assert(ss);
314     pa_assert(periods);
315     pa_assert(period_size);
316
317     snd_pcm_hw_params_alloca(&hwparams);
318
319     if ((ret = snd_pcm_hw_params_any(pcm_handle, hwparams)) < 0)
320         goto finish;
321
322     if ((ret = snd_pcm_hw_params_set_rate_resample(pcm_handle, hwparams, 0)) < 0)
323         goto finish;
324
325     if (_use_mmap) {
326         if ((ret = snd_pcm_hw_params_set_access(pcm_handle, hwparams, SND_PCM_ACCESS_MMAP_INTERLEAVED)) < 0) {
327
328             /* mmap() didn't work, fall back to interleaved */
329
330             if ((ret = snd_pcm_hw_params_set_access(pcm_handle, hwparams, SND_PCM_ACCESS_RW_INTERLEAVED)) < 0)
331                 goto finish;
332
333             _use_mmap = FALSE;
334         }
335
336     } else if ((ret = snd_pcm_hw_params_set_access(pcm_handle, hwparams, SND_PCM_ACCESS_RW_INTERLEAVED)) < 0)
337         goto finish;
338
339     if (!_use_mmap)
340         _use_tsched = FALSE;
341
342     if ((ret = set_format(pcm_handle, hwparams, &f)) < 0)
343         goto finish;
344
345     if ((ret = snd_pcm_hw_params_set_rate_near(pcm_handle, hwparams, &r, NULL)) < 0)
346         goto finish;
347
348     /* Adjust the buffer sizes, if we didn't get the rate we were asking for */
349     _period_size = (snd_pcm_uframes_t) (((uint64_t) _period_size * r) / ss->rate);
350     tsched_size = (snd_pcm_uframes_t) (((uint64_t) tsched_size * r) / ss->rate);
351
352     if (require_exact_channel_number) {
353         if ((ret = snd_pcm_hw_params_set_channels(pcm_handle, hwparams, c)) < 0)
354             goto finish;
355     } else {
356         if ((ret = snd_pcm_hw_params_set_channels_near(pcm_handle, hwparams, &c)) < 0)
357             goto finish;
358     }
359
360     if (_use_tsched) {
361         _period_size = tsched_size;
362         _periods = 1;
363
364         pa_assert_se(snd_pcm_hw_params_get_buffer_size_max(hwparams, &buffer_size) == 0);
365         pa_log_debug("Maximum hw buffer size is %u ms", (unsigned) buffer_size * 1000 / r);
366     }
367
368     buffer_size = _periods * _period_size;
369
370     if ((ret = snd_pcm_hw_params_set_periods_integer(pcm_handle, hwparams)) < 0)
371         goto finish;
372
373     if (_periods > 0) {
374         dir = 1;
375         if ((ret = snd_pcm_hw_params_set_periods_near(pcm_handle, hwparams, &_periods, &dir)) < 0) {
376             dir = -1;
377             if ((ret = snd_pcm_hw_params_set_periods_near(pcm_handle, hwparams, &_periods, &dir)) < 0)
378                 goto finish;
379         }
380     }
381
382     if (_period_size > 0)
383         if ((ret = snd_pcm_hw_params_set_buffer_size_near(pcm_handle, hwparams, &buffer_size)) < 0)
384             goto finish;
385
386     if  ((ret = snd_pcm_hw_params(pcm_handle, hwparams)) < 0)
387         goto finish;
388
389     if (ss->rate != r)
390         pa_log_warn("Device %s doesn't support %u Hz, changed to %u Hz.", snd_pcm_name(pcm_handle), ss->rate, r);
391
392     if (ss->channels != c)
393         pa_log_warn("Device %s doesn't support %u channels, changed to %u.", snd_pcm_name(pcm_handle), ss->channels, c);
394
395     if (ss->format != f)
396         pa_log_warn("Device %s doesn't support sample format %s, changed to %s.", snd_pcm_name(pcm_handle), pa_sample_format_to_string(ss->format), pa_sample_format_to_string(f));
397
398     if ((ret = snd_pcm_prepare(pcm_handle)) < 0)
399         goto finish;
400
401     if ((ret = snd_pcm_hw_params_get_period_size(hwparams, &_period_size, &dir)) < 0 ||
402         (ret = snd_pcm_hw_params_get_periods(hwparams, &_periods, &dir)) < 0)
403         goto finish;
404
405     /* If the sample rate deviates too much, we need to resample */
406     if (r < ss->rate*.95 || r > ss->rate*1.05)
407         ss->rate = r;
408     ss->channels = c;
409     ss->format = f;
410
411     pa_assert(_periods > 0);
412     pa_assert(_period_size > 0);
413
414     *periods = _periods;
415     *period_size = _period_size;
416
417     if (use_mmap)
418         *use_mmap = _use_mmap;
419
420     if (use_tsched)
421         *use_tsched = _use_tsched;
422
423     ret = 0;
424
425 finish:
426
427     return ret;
428 }
429
430 int pa_alsa_set_sw_params(snd_pcm_t *pcm, snd_pcm_uframes_t avail_min) {
431     snd_pcm_sw_params_t *swparams;
432     int err;
433
434     pa_assert(pcm);
435
436     snd_pcm_sw_params_alloca(&swparams);
437
438     if ((err = snd_pcm_sw_params_current(pcm, swparams) < 0)) {
439         pa_log_warn("Unable to determine current swparams: %s\n", snd_strerror(err));
440         return err;
441     }
442
443     if ((err = snd_pcm_sw_params_set_stop_threshold(pcm, swparams, (snd_pcm_uframes_t) -1)) < 0) {
444         pa_log_warn("Unable to set stop threshold: %s\n", snd_strerror(err));
445         return err;
446     }
447
448     if ((err = snd_pcm_sw_params_set_start_threshold(pcm, swparams, (snd_pcm_uframes_t) -1)) < 0) {
449         pa_log_warn("Unable to set start threshold: %s\n", snd_strerror(err));
450         return err;
451     }
452
453     if ((err = snd_pcm_sw_params_set_avail_min(pcm, swparams, avail_min)) < 0) {
454         pa_log_error("snd_pcm_sw_params_set_avail_min() failed: %s", snd_strerror(err));
455         return err;
456     }
457
458     if ((err = snd_pcm_sw_params(pcm, swparams)) < 0) {
459         pa_log_warn("Unable to set sw params: %s\n", snd_strerror(err));
460         return err;
461     }
462
463     return 0;
464 }
465
466 struct device_info {
467     pa_channel_map map;
468     const char *name;
469 };
470
471 static const struct device_info device_table[] = {
472     {{ 2, { PA_CHANNEL_POSITION_LEFT, PA_CHANNEL_POSITION_RIGHT } }, "front" },
473
474     {{ 4, { PA_CHANNEL_POSITION_FRONT_LEFT, PA_CHANNEL_POSITION_FRONT_RIGHT,
475             PA_CHANNEL_POSITION_REAR_LEFT, PA_CHANNEL_POSITION_REAR_RIGHT }}, "surround40" },
476
477     {{ 5, { PA_CHANNEL_POSITION_FRONT_LEFT, PA_CHANNEL_POSITION_FRONT_RIGHT,
478             PA_CHANNEL_POSITION_REAR_LEFT, PA_CHANNEL_POSITION_REAR_RIGHT,
479             PA_CHANNEL_POSITION_LFE }}, "surround41" },
480
481     {{ 5, { PA_CHANNEL_POSITION_FRONT_LEFT, PA_CHANNEL_POSITION_FRONT_RIGHT,
482             PA_CHANNEL_POSITION_REAR_LEFT, PA_CHANNEL_POSITION_REAR_RIGHT,
483             PA_CHANNEL_POSITION_CENTER }}, "surround50" },
484
485     {{ 6, { PA_CHANNEL_POSITION_FRONT_LEFT, PA_CHANNEL_POSITION_FRONT_RIGHT,
486             PA_CHANNEL_POSITION_REAR_LEFT, PA_CHANNEL_POSITION_REAR_RIGHT,
487             PA_CHANNEL_POSITION_CENTER, PA_CHANNEL_POSITION_LFE }}, "surround51" },
488
489     {{ 8, { PA_CHANNEL_POSITION_FRONT_LEFT, PA_CHANNEL_POSITION_FRONT_RIGHT,
490             PA_CHANNEL_POSITION_REAR_LEFT, PA_CHANNEL_POSITION_REAR_RIGHT,
491             PA_CHANNEL_POSITION_CENTER, PA_CHANNEL_POSITION_LFE,
492             PA_CHANNEL_POSITION_SIDE_LEFT, PA_CHANNEL_POSITION_SIDE_RIGHT }} , "surround71" },
493
494     {{ 0, { 0 }}, NULL }
495 };
496
497 static pa_bool_t channel_map_superset(const pa_channel_map *a, const pa_channel_map *b) {
498     pa_bool_t in_a[PA_CHANNEL_POSITION_MAX];
499     unsigned i;
500
501     pa_assert(a);
502     pa_assert(b);
503
504     memset(in_a, 0, sizeof(in_a));
505
506     for (i = 0; i < a->channels; i++)
507         in_a[a->map[i]] = TRUE;
508
509     for (i = 0; i < b->channels; i++)
510         if (!in_a[b->map[i]])
511             return FALSE;
512
513     return TRUE;
514 }
515
516 snd_pcm_t *pa_alsa_open_by_device_id(
517         const char *dev_id,
518         char **dev,
519         pa_sample_spec *ss,
520         pa_channel_map* map,
521         int mode,
522         uint32_t *nfrags,
523         snd_pcm_uframes_t *period_size,
524         snd_pcm_uframes_t tsched_size,
525         pa_bool_t *use_mmap,
526         pa_bool_t *use_tsched) {
527
528     int i;
529     int direction = 1;
530     int err;
531     char *d;
532     snd_pcm_t *pcm_handle;
533
534     pa_assert(dev_id);
535     pa_assert(dev);
536     pa_assert(ss);
537     pa_assert(map);
538     pa_assert(nfrags);
539     pa_assert(period_size);
540
541     /* First we try to find a device string with a superset of the
542      * requested channel map and open it without the plug: prefix. We
543      * iterate through our device table from top to bottom and take
544      * the first that matches. If we didn't find a working device that
545      * way, we iterate backwards, and check all devices that do not
546      * provide a superset of the requested channel map.*/
547
548     for (i = 0;; i += direction) {
549         pa_sample_spec try_ss;
550
551         if (i < 0) {
552             pa_assert(direction == -1);
553
554             /* OK, so we iterated backwards, and now are at the
555              * beginning of our list. */
556
557             break;
558
559         } else if (!device_table[i].name) {
560             pa_assert(direction == 1);
561
562             /* OK, so we are at the end of our list. at iterated
563              * forwards. */
564
565             i--;
566             direction = -1;
567         }
568
569         if ((direction > 0) == !channel_map_superset(&device_table[i].map, map))
570             continue;
571
572         d = pa_sprintf_malloc("%s:%s", device_table[i].name, dev_id);
573         pa_log_debug("Trying %s...", d);
574
575         if ((err = snd_pcm_open(&pcm_handle, d, mode,
576                                 SND_PCM_NONBLOCK|
577                                 SND_PCM_NO_AUTO_RESAMPLE|
578                                 SND_PCM_NO_AUTO_CHANNELS|
579                                 SND_PCM_NO_AUTO_FORMAT)) < 0) {
580             pa_log_info("Couldn't open PCM device %s: %s", d, snd_strerror(err));
581             pa_xfree(d);
582             continue;
583         }
584
585         try_ss.channels = device_table[i].map.channels;
586         try_ss.rate = ss->rate;
587         try_ss.format = ss->format;
588
589         if ((err = pa_alsa_set_hw_params(pcm_handle, &try_ss, nfrags, period_size, tsched_size, use_mmap, use_tsched, TRUE)) < 0) {
590             pa_log_info("PCM device %s refused our hw parameters: %s", d, snd_strerror(err));
591             pa_xfree(d);
592             snd_pcm_close(pcm_handle);
593             continue;
594         }
595
596         *ss = try_ss;
597         *map = device_table[i].map;
598         pa_assert(map->channels == ss->channels);
599         *dev = d;
600         return pcm_handle;
601     }
602
603     /* OK, we didn't find any good device, so let's try the raw plughw: stuff */
604
605     d = pa_sprintf_malloc("plughw:%s", dev_id);
606     pa_log_debug("Trying %s as last resort...", d);
607     pcm_handle = pa_alsa_open_by_device_string(d, dev, ss, map, mode, nfrags, period_size, tsched_size, use_mmap, use_tsched);
608     pa_xfree(d);
609
610     return pcm_handle;
611 }
612
613 snd_pcm_t *pa_alsa_open_by_device_string(
614         const char *device,
615         char **dev,
616         pa_sample_spec *ss,
617         pa_channel_map* map,
618         int mode,
619         uint32_t *nfrags,
620         snd_pcm_uframes_t *period_size,
621         snd_pcm_uframes_t tsched_size,
622         pa_bool_t *use_mmap,
623         pa_bool_t *use_tsched) {
624
625     int err;
626     char *d;
627     snd_pcm_t *pcm_handle;
628
629     pa_assert(device);
630     pa_assert(dev);
631     pa_assert(ss);
632     pa_assert(map);
633     pa_assert(nfrags);
634     pa_assert(period_size);
635
636     d = pa_xstrdup(device);
637
638     for (;;) {
639
640         if ((err = snd_pcm_open(&pcm_handle, d, mode, SND_PCM_NONBLOCK|
641                                 SND_PCM_NO_AUTO_RESAMPLE|
642                                 SND_PCM_NO_AUTO_CHANNELS|
643                                 SND_PCM_NO_AUTO_FORMAT)) < 0) {
644             pa_log("Error opening PCM device %s: %s", d, snd_strerror(err));
645             pa_xfree(d);
646             return NULL;
647         }
648
649         if ((err = pa_alsa_set_hw_params(pcm_handle, ss, nfrags, period_size, tsched_size, use_mmap, use_tsched, FALSE)) < 0) {
650
651             if (err == -EPERM) {
652                 /* Hmm, some hw is very exotic, so we retry with plug, if without it didn't work */
653
654                 if (pa_startswith(d, "hw:")) {
655                     char *t = pa_sprintf_malloc("plughw:%s", d+3);
656                     pa_log_debug("Opening the device as '%s' didn't work, retrying with '%s'.", d, t);
657                     pa_xfree(d);
658                     d = t;
659
660                     snd_pcm_close(pcm_handle);
661                     continue;
662                 }
663
664                 pa_log("Failed to set hardware parameters on %s: %s", d, snd_strerror(err));
665                 pa_xfree(d);
666                 snd_pcm_close(pcm_handle);
667                 return NULL;
668             }
669         }
670
671         *dev = d;
672
673         if (ss->channels != map->channels) {
674             pa_assert_se(pa_channel_map_init_auto(map, ss->channels, PA_CHANNEL_MAP_AUX));
675             pa_channel_map_init_auto(map, ss->channels, PA_CHANNEL_MAP_ALSA);
676         }
677
678         return pcm_handle;
679     }
680 }
681
682 int pa_alsa_prepare_mixer(snd_mixer_t *mixer, const char *dev) {
683     int err;
684
685     pa_assert(mixer);
686     pa_assert(dev);
687
688     if ((err = snd_mixer_attach(mixer, dev)) < 0) {
689         pa_log_info("Unable to attach to mixer %s: %s", dev, snd_strerror(err));
690         return -1;
691     }
692
693     if ((err = snd_mixer_selem_register(mixer, NULL, NULL)) < 0) {
694         pa_log_warn("Unable to register mixer: %s", snd_strerror(err));
695         return -1;
696     }
697
698     if ((err = snd_mixer_load(mixer)) < 0) {
699         pa_log_warn("Unable to load mixer: %s", snd_strerror(err));
700         return -1;
701     }
702
703     pa_log_info("Successfully attached to mixer '%s'", dev);
704
705     return 0;
706 }
707
708 snd_mixer_elem_t *pa_alsa_find_elem(snd_mixer_t *mixer, const char *name, const char *fallback) {
709     snd_mixer_elem_t *elem;
710     snd_mixer_selem_id_t *sid = NULL;
711
712     snd_mixer_selem_id_alloca(&sid);
713
714     pa_assert(mixer);
715     pa_assert(name);
716
717     snd_mixer_selem_id_set_name(sid, name);
718
719     if (!(elem = snd_mixer_find_selem(mixer, sid))) {
720         pa_log_info("Cannot find mixer control \"%s\".", snd_mixer_selem_id_get_name(sid));
721
722         if (fallback) {
723             snd_mixer_selem_id_set_name(sid, fallback);
724
725             if (!(elem = snd_mixer_find_selem(mixer, sid)))
726                 pa_log_warn("Cannot find fallback mixer control \"%s\".", snd_mixer_selem_id_get_name(sid));
727         }
728     }
729
730     if (elem)
731         pa_log_info("Using mixer control \"%s\".", snd_mixer_selem_id_get_name(sid));
732
733     return elem;
734 }
735
736 static const snd_mixer_selem_channel_id_t alsa_channel_ids[PA_CHANNEL_POSITION_MAX] = {
737     [PA_CHANNEL_POSITION_MONO] = SND_MIXER_SCHN_MONO, /* The ALSA name is just an alias! */
738
739     [PA_CHANNEL_POSITION_FRONT_CENTER] = SND_MIXER_SCHN_FRONT_CENTER,
740     [PA_CHANNEL_POSITION_FRONT_LEFT] = SND_MIXER_SCHN_FRONT_LEFT,
741     [PA_CHANNEL_POSITION_FRONT_RIGHT] = SND_MIXER_SCHN_FRONT_RIGHT,
742
743     [PA_CHANNEL_POSITION_REAR_CENTER] = SND_MIXER_SCHN_REAR_CENTER,
744     [PA_CHANNEL_POSITION_REAR_LEFT] = SND_MIXER_SCHN_REAR_LEFT,
745     [PA_CHANNEL_POSITION_REAR_RIGHT] = SND_MIXER_SCHN_REAR_RIGHT,
746
747     [PA_CHANNEL_POSITION_LFE] = SND_MIXER_SCHN_WOOFER,
748
749     [PA_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER] = SND_MIXER_SCHN_UNKNOWN,
750     [PA_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER] = SND_MIXER_SCHN_UNKNOWN,
751
752     [PA_CHANNEL_POSITION_SIDE_LEFT] = SND_MIXER_SCHN_SIDE_LEFT,
753     [PA_CHANNEL_POSITION_SIDE_RIGHT] = SND_MIXER_SCHN_SIDE_RIGHT,
754
755     [PA_CHANNEL_POSITION_AUX0] = SND_MIXER_SCHN_UNKNOWN,
756     [PA_CHANNEL_POSITION_AUX1] = SND_MIXER_SCHN_UNKNOWN,
757     [PA_CHANNEL_POSITION_AUX2] = SND_MIXER_SCHN_UNKNOWN,
758     [PA_CHANNEL_POSITION_AUX3] = SND_MIXER_SCHN_UNKNOWN,
759     [PA_CHANNEL_POSITION_AUX4] = SND_MIXER_SCHN_UNKNOWN,
760     [PA_CHANNEL_POSITION_AUX5] = SND_MIXER_SCHN_UNKNOWN,
761     [PA_CHANNEL_POSITION_AUX6] = SND_MIXER_SCHN_UNKNOWN,
762     [PA_CHANNEL_POSITION_AUX7] = SND_MIXER_SCHN_UNKNOWN,
763     [PA_CHANNEL_POSITION_AUX8] = SND_MIXER_SCHN_UNKNOWN,
764     [PA_CHANNEL_POSITION_AUX9] =  SND_MIXER_SCHN_UNKNOWN,
765     [PA_CHANNEL_POSITION_AUX10] = SND_MIXER_SCHN_UNKNOWN,
766     [PA_CHANNEL_POSITION_AUX11] = SND_MIXER_SCHN_UNKNOWN,
767     [PA_CHANNEL_POSITION_AUX12] = SND_MIXER_SCHN_UNKNOWN,
768     [PA_CHANNEL_POSITION_AUX13] = SND_MIXER_SCHN_UNKNOWN,
769     [PA_CHANNEL_POSITION_AUX14] = SND_MIXER_SCHN_UNKNOWN,
770     [PA_CHANNEL_POSITION_AUX15] = SND_MIXER_SCHN_UNKNOWN,
771     [PA_CHANNEL_POSITION_AUX16] = SND_MIXER_SCHN_UNKNOWN,
772     [PA_CHANNEL_POSITION_AUX17] = SND_MIXER_SCHN_UNKNOWN,
773     [PA_CHANNEL_POSITION_AUX18] = SND_MIXER_SCHN_UNKNOWN,
774     [PA_CHANNEL_POSITION_AUX19] = SND_MIXER_SCHN_UNKNOWN,
775     [PA_CHANNEL_POSITION_AUX20] = SND_MIXER_SCHN_UNKNOWN,
776     [PA_CHANNEL_POSITION_AUX21] = SND_MIXER_SCHN_UNKNOWN,
777     [PA_CHANNEL_POSITION_AUX22] = SND_MIXER_SCHN_UNKNOWN,
778     [PA_CHANNEL_POSITION_AUX23] = SND_MIXER_SCHN_UNKNOWN,
779     [PA_CHANNEL_POSITION_AUX24] = SND_MIXER_SCHN_UNKNOWN,
780     [PA_CHANNEL_POSITION_AUX25] = SND_MIXER_SCHN_UNKNOWN,
781     [PA_CHANNEL_POSITION_AUX26] = SND_MIXER_SCHN_UNKNOWN,
782     [PA_CHANNEL_POSITION_AUX27] = SND_MIXER_SCHN_UNKNOWN,
783     [PA_CHANNEL_POSITION_AUX28] = SND_MIXER_SCHN_UNKNOWN,
784     [PA_CHANNEL_POSITION_AUX29] = SND_MIXER_SCHN_UNKNOWN,
785     [PA_CHANNEL_POSITION_AUX30] = SND_MIXER_SCHN_UNKNOWN,
786     [PA_CHANNEL_POSITION_AUX31] = SND_MIXER_SCHN_UNKNOWN,
787
788     [PA_CHANNEL_POSITION_TOP_CENTER] = SND_MIXER_SCHN_UNKNOWN,
789
790     [PA_CHANNEL_POSITION_TOP_FRONT_CENTER] = SND_MIXER_SCHN_UNKNOWN,
791     [PA_CHANNEL_POSITION_TOP_FRONT_LEFT] = SND_MIXER_SCHN_UNKNOWN,
792     [PA_CHANNEL_POSITION_TOP_FRONT_RIGHT] = SND_MIXER_SCHN_UNKNOWN,
793
794     [PA_CHANNEL_POSITION_TOP_REAR_CENTER] = SND_MIXER_SCHN_UNKNOWN,
795     [PA_CHANNEL_POSITION_TOP_REAR_LEFT] = SND_MIXER_SCHN_UNKNOWN,
796     [PA_CHANNEL_POSITION_TOP_REAR_RIGHT] = SND_MIXER_SCHN_UNKNOWN
797 };
798
799
800 int pa_alsa_calc_mixer_map(snd_mixer_elem_t *elem, const pa_channel_map *channel_map, snd_mixer_selem_channel_id_t mixer_map[], pa_bool_t playback) {
801     unsigned i;
802     pa_bool_t alsa_channel_used[SND_MIXER_SCHN_LAST];
803     pa_bool_t mono_used = FALSE;
804
805     pa_assert(elem);
806     pa_assert(channel_map);
807     pa_assert(mixer_map);
808
809     memset(&alsa_channel_used, 0, sizeof(alsa_channel_used));
810
811     if (channel_map->channels > 1 &&
812         ((playback && snd_mixer_selem_has_playback_volume_joined(elem)) ||
813          (!playback && snd_mixer_selem_has_capture_volume_joined(elem)))) {
814         pa_log_info("ALSA device lacks independant volume controls for each channel, falling back to software volume control.");
815         return -1;
816     }
817
818     for (i = 0; i < channel_map->channels; i++) {
819         snd_mixer_selem_channel_id_t id;
820         pa_bool_t is_mono;
821
822         is_mono = channel_map->map[i] == PA_CHANNEL_POSITION_MONO;
823         id = alsa_channel_ids[channel_map->map[i]];
824
825         if (!is_mono && id == SND_MIXER_SCHN_UNKNOWN) {
826             pa_log_info("Configured channel map contains channel '%s' that is unknown to the ALSA mixer. Falling back to software volume control.", pa_channel_position_to_string(channel_map->map[i]));
827             return -1;
828         }
829
830         if ((is_mono && mono_used) || (!is_mono && alsa_channel_used[id])) {
831             pa_log_info("Channel map has duplicate channel '%s', falling back to software volume control.", pa_channel_position_to_string(channel_map->map[i]));
832             return -1;
833         }
834
835         if ((playback && (!snd_mixer_selem_has_playback_channel(elem, id) || (is_mono && !snd_mixer_selem_is_playback_mono(elem)))) ||
836             (!playback && (!snd_mixer_selem_has_capture_channel(elem, id) || (is_mono && !snd_mixer_selem_is_capture_mono(elem))))) {
837
838             pa_log_info("ALSA device lacks separate volumes control for channel '%s', falling back to software volume control.", pa_channel_position_to_string(channel_map->map[i]));
839             return -1;
840         }
841
842         if (is_mono) {
843             mixer_map[i] = SND_MIXER_SCHN_MONO;
844             mono_used = TRUE;
845         } else {
846             mixer_map[i] = id;
847             alsa_channel_used[id] = TRUE;
848         }
849     }
850
851     pa_log_info("All %u channels can be mapped to mixer channels.", channel_map->channels);
852
853     return 0;
854 }
855
856 void pa_alsa_0dB_playback(snd_mixer_elem_t *elem) {
857     long min, max, v;
858
859     pa_assert(elem);
860
861     /* Try to enable 0 dB if possible. If ALSA cannot do dB, then use
862      * raw volume levels and fix them to 75% */
863
864     if (snd_mixer_selem_set_playback_dB_all(elem, 0, -1) >= 0)
865         return;
866
867     if (snd_mixer_selem_set_playback_dB_all(elem, 0, 1) >= 0)
868         return;
869
870     if (snd_mixer_selem_get_playback_volume_range(elem, &min, &max) < 0)
871         return;
872
873     v = min + ((max - min) * 3) / 4; /* 75% */
874
875     if (v <= min)
876         v = max;
877
878     snd_mixer_selem_set_playback_volume_all(elem, v);
879 }
880
881 void pa_alsa_0dB_capture(snd_mixer_elem_t *elem) {
882     long min, max, v;
883
884     pa_assert(elem);
885
886     /* Try to enable 0 dB if possible. If ALSA cannot do dB, then use
887      * raw volume levels and fix them to 75% */
888
889     if (snd_mixer_selem_set_capture_dB_all(elem, 0, -1) >= 0)
890         return;
891
892     if (snd_mixer_selem_set_capture_dB_all(elem, 0, 1) >= 0)
893         return;
894
895     if (snd_mixer_selem_get_capture_volume_range(elem, &min, &max) < 0)
896         return;
897
898     v = min + ((max - min) * 3) / 4; /* 75% */
899
900     if (v <= min)
901         v = max;
902
903     snd_mixer_selem_set_capture_volume_all(elem, v);
904 }
905
906 void pa_alsa_dump(snd_pcm_t *pcm) {
907     int err;
908     snd_output_t *out;
909
910     pa_assert(pcm);
911
912     pa_assert_se(snd_output_buffer_open(&out) == 0);
913
914     if ((err = snd_pcm_dump(pcm, out)) < 0)
915         pa_log_debug("snd_pcm_dump(): %s", snd_strerror(err));
916     else {
917         char *s = NULL;
918         snd_output_buffer_string(out, &s);
919         pa_log_debug("snd_pcm_dump():\n%s", pa_strnull(s));
920     }
921
922     pa_assert_se(snd_output_close(out) == 0);
923 }
924
925 void pa_alsa_dump_status(snd_pcm_t *pcm) {
926     int err;
927     snd_output_t *out;
928     snd_pcm_status_t *status;
929
930     pa_assert(pcm);
931
932     snd_pcm_status_alloca(&status);
933
934     pa_assert_se(snd_output_buffer_open(&out) == 0);
935
936     pa_assert_se(snd_pcm_status(pcm, status) == 0);
937
938     if ((err = snd_pcm_status_dump(status, out)) < 0)
939         pa_log_debug("snd_pcm_dump(): %s", snd_strerror(err));
940     else {
941         char *s = NULL;
942         snd_output_buffer_string(out, &s);
943         pa_log_debug("snd_pcm_dump():\n%s", pa_strnull(s));
944     }
945
946     pa_assert_se(snd_output_close(out) == 0);
947 }
948
949 static void alsa_error_handler(const char *file, int line, const char *function, int err, const char *fmt,...) {
950     va_list ap;
951
952     va_start(ap, fmt);
953
954     pa_log_levelv_meta(PA_LOG_WARN, file, line, function, fmt, ap);
955
956     va_end(ap);
957 }
958
959 static pa_atomic_t n_error_handler_installed = PA_ATOMIC_INIT(0);
960
961 void pa_alsa_redirect_errors_inc(void) {
962     /* This is not really thread safe, but we do our best */
963
964     if (pa_atomic_inc(&n_error_handler_installed) == 0)
965         snd_lib_error_set_handler(alsa_error_handler);
966 }
967
968 void pa_alsa_redirect_errors_dec(void) {
969     int r;
970
971     pa_assert_se((r = pa_atomic_dec(&n_error_handler_installed)) >= 1);
972
973     if (r == 1)
974         snd_lib_error_set_handler(NULL);
975 }
976
977 void pa_alsa_init_proplist(pa_proplist *p, snd_pcm_info_t *pcm_info) {
978
979     static const char * const alsa_class_table[SND_PCM_CLASS_LAST+1] = {
980         [SND_PCM_CLASS_GENERIC] = "generic",
981         [SND_PCM_CLASS_MULTI] = "multi",
982         [SND_PCM_CLASS_MODEM] = "modem",
983         [SND_PCM_CLASS_DIGITIZER] = "digitizer"
984     };
985     static const char * const class_table[SND_PCM_CLASS_LAST+1] = {
986         [SND_PCM_CLASS_GENERIC] = "sound",
987         [SND_PCM_CLASS_MULTI] = NULL,
988         [SND_PCM_CLASS_MODEM] = "modem",
989         [SND_PCM_CLASS_DIGITIZER] = NULL
990     };
991     static const char * const alsa_subclass_table[SND_PCM_SUBCLASS_LAST+1] = {
992         [SND_PCM_SUBCLASS_GENERIC_MIX] = "generic-mix",
993         [SND_PCM_SUBCLASS_MULTI_MIX] = "multi-mix"
994     };
995
996     snd_pcm_class_t class;
997     snd_pcm_subclass_t subclass;
998     const char *n, *id, *sdn;
999     char *cn = NULL, *lcn = NULL;
1000     int card;
1001
1002     pa_assert(p);
1003     pa_assert(pcm_info);
1004
1005     pa_proplist_sets(p, PA_PROP_DEVICE_API, "alsa");
1006
1007     class = snd_pcm_info_get_class(pcm_info);
1008     if (class <= SND_PCM_CLASS_LAST) {
1009         if (class_table[class])
1010             pa_proplist_sets(p, PA_PROP_DEVICE_CLASS, class_table[class]);
1011         if (alsa_class_table[class])
1012             pa_proplist_sets(p, "alsa.class", alsa_class_table[class]);
1013     }
1014     subclass = snd_pcm_info_get_subclass(pcm_info);
1015     if (subclass <= SND_PCM_SUBCLASS_LAST)
1016         if (alsa_subclass_table[subclass])
1017             pa_proplist_sets(p, "alsa.subclass", alsa_subclass_table[subclass]);
1018
1019     if ((n = snd_pcm_info_get_name(pcm_info)))
1020         pa_proplist_sets(p, "alsa.name", n);
1021
1022     if ((id = snd_pcm_info_get_id(pcm_info)))
1023         pa_proplist_sets(p, "alsa.id", id);
1024
1025     pa_proplist_setf(p, "alsa.subdevice", "%u", snd_pcm_info_get_subdevice(pcm_info));
1026     if ((sdn = snd_pcm_info_get_subdevice_name(pcm_info)))
1027         pa_proplist_sets(p, "alsa.subdevice_name", sdn);
1028
1029     pa_proplist_setf(p, "alsa.device", "%u", snd_pcm_info_get_device(pcm_info));
1030
1031     if ((card = snd_pcm_info_get_card(pcm_info)) >= 0) {
1032         pa_proplist_setf(p, "alsa.card", "%i", card);
1033
1034         if (snd_card_get_name(card, &cn) >= 0)
1035             pa_proplist_sets(p, "alsa.card_name", cn);
1036
1037         if (snd_card_get_longname(card, &lcn) >= 0)
1038             pa_proplist_sets(p, "alsa.long_card_name", lcn);
1039     }
1040
1041     if (cn && n)
1042         pa_proplist_setf(p, PA_PROP_DEVICE_DESCRIPTION, "%s - %s", cn, n);
1043     else if (cn)
1044         pa_proplist_sets(p, PA_PROP_DEVICE_DESCRIPTION, cn);
1045     else if (n)
1046         pa_proplist_sets(p, PA_PROP_DEVICE_DESCRIPTION, n);
1047 }
1048
1049 int pa_alsa_recover_from_poll(snd_pcm_t *pcm, int revents) {
1050     snd_pcm_state_t state;
1051     int err;
1052
1053     pa_assert(pcm);
1054
1055     if (revents & POLLERR)
1056         pa_log_warn("Got POLLERR from ALSA");
1057     if (revents & POLLNVAL)
1058         pa_log_warn("Got POLLNVAL from ALSA");
1059     if (revents & POLLHUP)
1060         pa_log_warn("Got POLLHUP from ALSA");
1061
1062     state = snd_pcm_state(pcm);
1063     pa_log_warn("PCM state is %s", snd_pcm_state_name(state));
1064
1065     /* Try to recover from this error */
1066
1067     switch (state) {
1068
1069         case SND_PCM_STATE_XRUN:
1070             if ((err = snd_pcm_recover(pcm, -EPIPE, 1)) != 0) {
1071                 pa_log_warn("Could not recover from POLLERR|POLLNVAL|POLLHUP and XRUN: %s", snd_strerror(err));
1072                 return -1;
1073             }
1074             break;
1075
1076         case SND_PCM_STATE_SUSPENDED:
1077             if ((err = snd_pcm_recover(pcm, -ESTRPIPE, 1)) != 0) {
1078                 pa_log_warn("Could not recover from POLLERR|POLLNVAL|POLLHUP and SUSPENDED: %s", snd_strerror(err));
1079                 return -1;
1080             }
1081             break;
1082
1083         default:
1084
1085             snd_pcm_drop(pcm);
1086
1087             if ((err = snd_pcm_prepare(pcm)) < 0) {
1088                 pa_log_warn("Could not recover from POLLERR|POLLNVAL|POLLHUP with snd_pcm_prepare(): %s", snd_strerror(err));
1089                 return -1;
1090             }
1091             break;
1092     }
1093
1094     return 0;
1095 }
1096
1097 pa_rtpoll_item* pa_alsa_build_pollfd(snd_pcm_t *pcm, pa_rtpoll *rtpoll) {
1098     int n, err;
1099     struct pollfd *pollfd;
1100     pa_rtpoll_item *item;
1101
1102     pa_assert(pcm);
1103
1104     if ((n = snd_pcm_poll_descriptors_count(pcm)) < 0) {
1105         pa_log("snd_pcm_poll_descriptors_count() failed: %s", snd_strerror(n));
1106         return NULL;
1107     }
1108
1109     item = pa_rtpoll_item_new(rtpoll, PA_RTPOLL_NEVER, n);
1110     pollfd = pa_rtpoll_item_get_pollfd(item, NULL);
1111
1112     if ((err = snd_pcm_poll_descriptors(pcm, pollfd, n)) < 0) {
1113         pa_log("snd_pcm_poll_descriptors() failed: %s", snd_strerror(err));
1114         pa_rtpoll_item_free(item);
1115         return NULL;
1116     }
1117
1118     return item;
1119 }