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