4 This file is part of PulseAudio.
6 Copyright 2004-2006 Lennart Poettering
7 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
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.
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.
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
32 #ifdef HAVE_SYS_POLL_H
38 #include <asoundlib.h>
40 #include <pulse/xmalloc.h>
42 #include <pulsecore/core.h>
43 #include <pulsecore/module.h>
44 #include <pulsecore/memchunk.h>
45 #include <pulsecore/sink.h>
46 #include <pulsecore/modargs.h>
47 #include <pulsecore/core-util.h>
48 #include <pulsecore/sample-util.h>
49 #include <pulsecore/log.h>
51 #include "alsa-util.h"
52 #include "module-alsa-sink-symdef.h"
54 PA_MODULE_AUTHOR("Lennart Poettering")
55 PA_MODULE_DESCRIPTION("ALSA Sink")
56 PA_MODULE_VERSION(PACKAGE_VERSION)
58 "sink_name=<name for the sink> "
59 "device=<ALSA device> "
60 "format=<sample format> "
61 "channels=<number of channels> "
63 "fragments=<number of fragments> "
64 "fragment_size=<fragment size> "
65 "channel_map=<channel map>")
68 snd_pcm_t *pcm_handle;
69 snd_mixer_t *mixer_handle;
70 snd_mixer_elem_t *mixer_elem;
72 struct pa_alsa_fdlist *pcm_fdl;
73 struct pa_alsa_fdlist *mixer_fdl;
74 long hw_volume_max, hw_volume_min;
76 size_t frame_size, fragment_size;
77 pa_memchunk memchunk, silence;
81 static const char* const valid_modargs[] = {
93 #define DEFAULT_DEVICE "default"
95 static void update_usage(struct userdata *u) {
96 pa_module_set_used(u->module, u->sink ? pa_sink_used_by(u->sink) : 0);
99 static void clear_up(struct userdata *u) {
103 pa_sink_disconnect(u->sink);
104 pa_sink_unref(u->sink);
109 pa_alsa_fdlist_free(u->pcm_fdl);
111 pa_alsa_fdlist_free(u->mixer_fdl);
113 u->pcm_fdl = u->mixer_fdl = NULL;
115 if (u->mixer_handle) {
116 snd_mixer_close(u->mixer_handle);
117 u->mixer_handle = NULL;
121 snd_pcm_drop(u->pcm_handle);
122 snd_pcm_close(u->pcm_handle);
123 u->pcm_handle = NULL;
127 static int xrun_recovery(struct userdata *u) {
131 pa_log_info("*** ALSA-XRUN (playback) ***");
133 if ((ret = snd_pcm_prepare(u->pcm_handle)) < 0) {
134 pa_log("snd_pcm_prepare() failed: %s", snd_strerror(-ret));
137 pa_module_unload_request(u->module);
144 static void do_write(struct userdata *u) {
150 pa_memchunk *memchunk = NULL;
151 snd_pcm_sframes_t frames;
153 if (u->memchunk.memblock)
154 memchunk = &u->memchunk;
156 if (pa_sink_render(u->sink, u->fragment_size, &u->memchunk) < 0)
157 memchunk = &u->silence;
159 memchunk = &u->memchunk;
162 assert(memchunk->memblock && memchunk->memblock->data && memchunk->length && memchunk->memblock->length && (memchunk->length % u->frame_size) == 0);
164 if ((frames = snd_pcm_writei(u->pcm_handle, (uint8_t*) memchunk->memblock->data + memchunk->index, memchunk->length / u->frame_size)) < 0) {
165 if (frames == -EAGAIN)
168 if (frames == -EPIPE) {
169 if (xrun_recovery(u) < 0)
175 pa_log("snd_pcm_writei() failed: %s", snd_strerror(-frames));
178 pa_module_unload_request(u->module);
182 if (memchunk == &u->memchunk) {
183 size_t l = frames * u->frame_size;
184 memchunk->index += l;
185 memchunk->length -= l;
187 if (memchunk->length == 0) {
188 pa_memblock_unref(memchunk->memblock);
189 memchunk->memblock = NULL;
190 memchunk->index = memchunk->length = 0;
198 static void fdl_callback(void *userdata) {
199 struct userdata *u = userdata;
202 if (snd_pcm_state(u->pcm_handle) == SND_PCM_STATE_XRUN)
203 if (xrun_recovery(u) < 0)
209 static int mixer_callback(snd_mixer_elem_t *elem, unsigned int mask) {
210 struct userdata *u = snd_mixer_elem_get_callback_private(elem);
212 assert(u && u->mixer_handle);
214 if (mask == SND_CTL_EVENT_MASK_REMOVE)
217 if (mask & SND_CTL_EVENT_MASK_VALUE) {
218 if (u->sink->get_hw_volume)
219 u->sink->get_hw_volume(u->sink);
220 if (u->sink->get_hw_mute)
221 u->sink->get_hw_mute(u->sink);
222 pa_subscription_post(u->sink->core,
223 PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE,
230 static pa_usec_t sink_get_latency_cb(pa_sink *s) {
232 struct userdata *u = s->userdata;
233 snd_pcm_sframes_t frames;
236 assert(s && u && u->sink);
238 if ((err = snd_pcm_delay(u->pcm_handle, &frames)) < 0) {
239 pa_log("failed to get delay: %s", snd_strerror(err));
240 s->get_latency = NULL;
247 r += pa_bytes_to_usec(frames * u->frame_size, &s->sample_spec);
249 if (u->memchunk.memblock)
250 r += pa_bytes_to_usec(u->memchunk.length, &s->sample_spec);
255 static int sink_get_hw_volume_cb(pa_sink *s) {
256 struct userdata *u = s->userdata;
261 assert(u->mixer_elem);
263 for (i = 0; i < s->hw_volume.channels; i++) {
266 assert(snd_mixer_selem_has_playback_channel(u->mixer_elem, i));
268 if ((err = snd_mixer_selem_get_playback_volume(u->mixer_elem, i, &vol)) < 0)
271 set_vol = (long) roundf(((float) s->hw_volume.values[i] * (u->hw_volume_max - u->hw_volume_min)) / PA_VOLUME_NORM) + u->hw_volume_min;
273 /* Try to avoid superfluous volume changes */
275 s->hw_volume.values[i] = (pa_volume_t) roundf(((float) (vol - u->hw_volume_min) * PA_VOLUME_NORM) / (u->hw_volume_max - u->hw_volume_min));
281 pa_log_error("Unable to read volume: %s", snd_strerror(err));
282 s->get_hw_volume = NULL;
283 s->set_hw_volume = NULL;
287 static int sink_set_hw_volume_cb(pa_sink *s) {
288 struct userdata *u = s->userdata;
294 assert(u->mixer_elem);
296 for (i = 0; i < s->hw_volume.channels; i++) {
299 assert(snd_mixer_selem_has_playback_channel(u->mixer_elem, i));
301 vol = s->hw_volume.values[i];
303 if (vol > PA_VOLUME_NORM)
304 vol = PA_VOLUME_NORM;
306 alsa_vol = (long) roundf(((float) vol * (u->hw_volume_max - u->hw_volume_min)) / PA_VOLUME_NORM) + u->hw_volume_min;
308 if ((err = snd_mixer_selem_set_playback_volume(u->mixer_elem, i, alsa_vol)) < 0)
315 pa_log_error("Unable to set volume: %s", snd_strerror(err));
316 s->get_hw_volume = NULL;
317 s->set_hw_volume = NULL;
321 static int sink_get_hw_mute_cb(pa_sink *s) {
322 struct userdata *u = s->userdata;
325 assert(u && u->mixer_elem);
327 err = snd_mixer_selem_get_playback_switch(u->mixer_elem, 0, &sw);
329 pa_log_error("Unable to get switch: %s", snd_strerror(err));
330 s->get_hw_mute = NULL;
331 s->set_hw_mute = NULL;
340 static int sink_set_hw_mute_cb(pa_sink *s) {
341 struct userdata *u = s->userdata;
344 assert(u && u->mixer_elem);
346 err = snd_mixer_selem_set_playback_switch_all(u->mixer_elem, !s->hw_muted);
348 pa_log_error("Unable to set switch: %s", snd_strerror(err));
349 s->get_hw_mute = NULL;
350 s->set_hw_mute = NULL;
357 int pa__init(pa_core *c, pa_module*m) {
358 pa_modargs *ma = NULL;
360 struct userdata *u = NULL;
364 uint32_t periods, fragsize;
365 snd_pcm_uframes_t period_size;
367 snd_pcm_info_t *pcm_info = NULL;
371 char *name_buf = NULL;
374 if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
375 pa_log("failed to parse module arguments");
379 ss = c->default_sample_spec;
380 if (pa_modargs_get_sample_spec_and_channel_map(ma, &ss, &map, PA_CHANNEL_MAP_ALSA) < 0) {
381 pa_log("failed to parse sample specification and channel map");
385 frame_size = pa_frame_size(&ss);
387 /* Fix latency to 100ms */
389 fragsize = pa_bytes_per_second(&ss)/128;
391 if (pa_modargs_get_value_u32(ma, "fragments", &periods) < 0 || pa_modargs_get_value_u32(ma, "fragment_size", &fragsize) < 0) {
392 pa_log("failed to parse buffer metrics");
395 period_size = fragsize/frame_size;
397 u = pa_xnew0(struct userdata, 1);
401 snd_config_update_free_global();
402 if ((err = snd_pcm_open(&u->pcm_handle, dev = pa_modargs_get_value(ma, "device", DEFAULT_DEVICE), SND_PCM_STREAM_PLAYBACK, SND_PCM_NONBLOCK)) < 0) {
403 pa_log("Error opening PCM device %s: %s", dev, snd_strerror(err));
407 if ((err = snd_pcm_info_malloc(&pcm_info)) < 0 ||
408 (err = snd_pcm_info(u->pcm_handle, pcm_info)) < 0) {
409 pa_log("Error fetching PCM info: %s", snd_strerror(err));
413 if ((err = pa_alsa_set_hw_params(u->pcm_handle, &ss, &periods, &period_size)) < 0) {
414 pa_log("Failed to set hardware parameters: %s", snd_strerror(err));
418 if (ss.channels != map.channels)
419 /* Seems ALSA didn't like the channel number, so let's fix the channel map */
420 pa_channel_map_init_auto(&map, ss.channels, PA_CHANNEL_MAP_ALSA);
422 if ((err = snd_mixer_open(&u->mixer_handle, 0)) < 0) {
423 pa_log("Error opening mixer: %s", snd_strerror(err));
427 if ((pa_alsa_prepare_mixer(u->mixer_handle, dev) < 0) ||
428 !(u->mixer_elem = pa_alsa_find_elem(u->mixer_handle, "PCM", "Master"))) {
429 snd_mixer_close(u->mixer_handle);
430 u->mixer_handle = NULL;
433 if ((name = pa_modargs_get_value(ma, "sink_name", NULL)))
436 name = name_buf = pa_sprintf_malloc("alsa_output.%s", dev);
440 if (!(u->sink = pa_sink_new(c, __FILE__, name, namereg_fail, &ss, &map))) {
441 pa_log("Failed to create sink object");
445 u->sink->is_hardware = 1;
446 u->sink->get_latency = sink_get_latency_cb;
447 if (u->mixer_handle) {
448 assert(u->mixer_elem);
449 if (snd_mixer_selem_has_playback_volume(u->mixer_elem)) {
452 for (i = 0;i < ss.channels;i++) {
453 if (!snd_mixer_selem_has_playback_channel(u->mixer_elem, i))
457 if (i == ss.channels) {
458 u->sink->get_hw_volume = sink_get_hw_volume_cb;
459 u->sink->set_hw_volume = sink_set_hw_volume_cb;
460 snd_mixer_selem_get_playback_volume_range(
461 u->mixer_elem, &u->hw_volume_min, &u->hw_volume_max);
464 if (snd_mixer_selem_has_playback_switch(u->mixer_elem)) {
465 u->sink->get_hw_mute = sink_get_hw_mute_cb;
466 u->sink->set_hw_mute = sink_set_hw_mute_cb;
469 u->sink->userdata = u;
470 pa_sink_set_owner(u->sink, m);
471 pa_sink_set_description(u->sink, t = pa_sprintf_malloc("ALSA PCM on %s (%s)", dev, snd_pcm_info_get_name(pcm_info)));
474 u->pcm_fdl = pa_alsa_fdlist_new();
476 if (pa_alsa_fdlist_init_pcm(u->pcm_fdl, u->pcm_handle, c->mainloop, fdl_callback, u) < 0) {
477 pa_log("failed to initialise file descriptor monitoring");
481 if (u->mixer_handle) {
482 u->mixer_fdl = pa_alsa_fdlist_new();
483 assert(u->mixer_fdl);
484 if (pa_alsa_fdlist_init_mixer(u->mixer_fdl, u->mixer_handle, c->mainloop) < 0) {
485 pa_log("failed to initialise file descriptor monitoring");
488 snd_mixer_elem_set_callback(u->mixer_elem, mixer_callback);
489 snd_mixer_elem_set_callback_private(u->mixer_elem, u);
493 u->frame_size = frame_size;
494 u->fragment_size = period_size * frame_size;
496 pa_log_info("using %u fragments of size %lu bytes.", periods, (long unsigned)u->fragment_size);
498 u->silence.memblock = pa_memblock_new(c->mempool, u->silence.length = u->fragment_size);
499 assert(u->silence.memblock);
500 pa_silence_memblock(u->silence.memblock, &ss);
501 u->silence.index = 0;
503 u->memchunk.memblock = NULL;
504 u->memchunk.index = u->memchunk.length = 0;
508 /* Get initial mixer settings */
509 if (u->sink->get_hw_volume)
510 u->sink->get_hw_volume(u->sink);
511 if (u->sink->get_hw_mute)
512 u->sink->get_hw_mute(u->sink);
522 snd_pcm_info_free(pcm_info);
534 void pa__done(pa_core *c, pa_module*m) {
538 if (!(u = m->userdata))
543 if (u->memchunk.memblock)
544 pa_memblock_unref(u->memchunk.memblock);
545 if (u->silence.memblock)
546 pa_memblock_unref(u->silence.memblock);