2 This file is part of PulseAudio.
4 Copyright 2004-2008 Lennart Poettering
5 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
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.
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.
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
29 #include <asoundlib.h>
31 #ifdef HAVE_VALGRIND_MEMCHECK_H
32 #include <valgrind/memcheck.h>
35 #include <pulse/xmalloc.h>
36 #include <pulse/util.h>
37 #include <pulse/timeval.h>
39 #include <pulsecore/core-error.h>
40 #include <pulsecore/core.h>
41 #include <pulsecore/module.h>
42 #include <pulsecore/memchunk.h>
43 #include <pulsecore/sink.h>
44 #include <pulsecore/modargs.h>
45 #include <pulsecore/core-util.h>
46 #include <pulsecore/sample-util.h>
47 #include <pulsecore/log.h>
48 #include <pulsecore/macro.h>
49 #include <pulsecore/thread.h>
50 #include <pulsecore/core-error.h>
51 #include <pulsecore/thread-mq.h>
52 #include <pulsecore/rtpoll.h>
53 #include <pulsecore/time-smoother.h>
54 #include <pulsecore/rtclock.h>
56 #include "alsa-util.h"
57 #include "alsa-source.h"
59 #define DEFAULT_DEVICE "default"
60 #define DEFAULT_TSCHED_BUFFER_USEC (2*PA_USEC_PER_SEC) /* 2s */
61 #define DEFAULT_TSCHED_WATERMARK_USEC (20*PA_USEC_PER_MSEC) /* 20ms */
62 #define TSCHED_MIN_SLEEP_USEC (3*PA_USEC_PER_MSEC) /* 3ms */
63 #define TSCHED_MIN_WAKEUP_USEC (3*PA_USEC_PER_MSEC) /* 3ms */
71 pa_thread_mq thread_mq;
74 snd_pcm_t *pcm_handle;
76 pa_alsa_fdlist *mixer_fdl;
77 snd_mixer_t *mixer_handle;
78 snd_mixer_elem_t *mixer_elem;
79 long hw_volume_max, hw_volume_min;
80 long hw_dB_max, hw_dB_min;
81 pa_bool_t hw_dB_supported;
82 pa_bool_t mixer_seperate_channels;
84 pa_cvolume hardware_volume;
86 size_t frame_size, fragment_size, hwbuf_size, tsched_watermark;
91 pa_bool_t use_mmap, use_tsched;
93 pa_rtpoll_item *alsa_rtpoll_item;
95 snd_mixer_selem_channel_id_t mixer_map[SND_MIXER_SCHN_LAST];
97 pa_smoother *smoother;
100 snd_pcm_sframes_t hwbuf_unused_frames;
103 static void userdata_free(struct userdata *u);
105 static void fix_tsched_watermark(struct userdata *u) {
107 size_t min_sleep, min_wakeup;
110 max_use = u->hwbuf_size - (size_t) u->hwbuf_unused_frames * u->frame_size;
112 min_sleep = pa_usec_to_bytes(TSCHED_MIN_SLEEP_USEC, &u->source->sample_spec);
113 min_wakeup = pa_usec_to_bytes(TSCHED_MIN_WAKEUP_USEC, &u->source->sample_spec);
115 if (min_sleep > max_use/2)
116 min_sleep = pa_frame_align(max_use/2, &u->source->sample_spec);
117 if (min_sleep < u->frame_size)
118 min_sleep = u->frame_size;
120 if (min_wakeup > max_use/2)
121 min_wakeup = pa_frame_align(max_use/2, &u->source->sample_spec);
122 if (min_wakeup < u->frame_size)
123 min_wakeup = u->frame_size;
125 if (u->tsched_watermark > max_use-min_sleep)
126 u->tsched_watermark = max_use-min_sleep;
128 if (u->tsched_watermark < min_wakeup)
129 u->tsched_watermark = min_wakeup;
132 static pa_usec_t hw_sleep_time(struct userdata *u, pa_usec_t *sleep_usec, pa_usec_t*process_usec) {
137 usec = pa_source_get_requested_latency_within_thread(u->source);
139 if (usec == (pa_usec_t) -1)
140 usec = pa_bytes_to_usec(u->hwbuf_size, &u->source->sample_spec);
142 /* pa_log_debug("hw buffer time: %u ms", (unsigned) (usec / PA_USEC_PER_MSEC)); */
144 wm = pa_bytes_to_usec(u->tsched_watermark, &u->source->sample_spec);
147 *sleep_usec = usec - wm;
150 *process_usec = *sleep_usec = usec /= 2;
152 /* pa_log_debug("after watermark: %u ms", (unsigned) (*sleep_usec / PA_USEC_PER_MSEC)); */
157 static int try_recover(struct userdata *u, const char *call, int err) {
162 pa_log_debug("%s: %s", call, snd_strerror(err));
164 pa_assert(err != -EAGAIN);
167 pa_log_debug("%s: Buffer overrun!", call);
169 if ((err = snd_pcm_recover(u->pcm_handle, err, 1)) == 0) {
170 snd_pcm_start(u->pcm_handle);
174 pa_log("%s: %s", call, snd_strerror(err));
178 static size_t check_left_to_record(struct userdata *u, snd_pcm_sframes_t n) {
179 size_t left_to_record;
180 size_t rec_space = u->hwbuf_size - (size_t) u->hwbuf_unused_frames*u->frame_size;
182 if ((size_t) n*u->frame_size < rec_space)
183 left_to_record = rec_space - ((size_t) n*u->frame_size);
187 if (left_to_record > 0) {
188 /* pa_log_debug("%0.2f ms left to record", (double) pa_bytes_to_usec(left_to_record, &u->source->sample_spec) / PA_USEC_PER_MSEC); */
190 pa_log_info("Overrun!");
193 size_t old_watermark = u->tsched_watermark;
195 u->tsched_watermark *= 2;
196 fix_tsched_watermark(u);
198 if (old_watermark != u->tsched_watermark)
199 pa_log_notice("Increasing wakeup watermark to %0.2f ms",
200 (double) pa_bytes_to_usec(u->tsched_watermark, &u->source->sample_spec) / PA_USEC_PER_MSEC);
204 return left_to_record;
207 static int mmap_read(struct userdata *u, pa_usec_t *sleep_usec, pa_bool_t polled) {
209 pa_usec_t max_sleep_usec = 0, process_usec = 0;
210 size_t left_to_record;
213 pa_source_assert_ref(u->source);
216 hw_sleep_time(u, &max_sleep_usec, &process_usec);
222 snd_pcm_hwsync(u->pcm_handle);
224 if (PA_UNLIKELY((n = pa_alsa_safe_avail_update(u->pcm_handle, u->hwbuf_size, &u->source->sample_spec)) < 0)) {
226 if ((r = try_recover(u, "snd_pcm_avail_update", (int) n)) == 0)
232 left_to_record = check_left_to_record(u, n);
236 pa_bytes_to_usec(left_to_record, &u->source->sample_spec) > process_usec+max_sleep_usec/2)
239 if (PA_UNLIKELY(n <= 0)) {
241 if (polled && pa_log_ratelimit())
242 pa_log("ALSA woke us up to read new data from the device, but there was actually nothing to read! "
243 "Most likely this is an ALSA driver bug. Please report this issue to the ALSA developers. "
244 "We were woken up with POLLIN set -- however a subsequent snd_pcm_avail_update() returned 0.");
253 const snd_pcm_channel_area_t *areas;
254 snd_pcm_uframes_t offset, frames = (snd_pcm_uframes_t) n;
257 snd_pcm_sframes_t sframes;
259 /* pa_log_debug("%lu frames to read", (unsigned long) frames); */
261 if (PA_UNLIKELY((err = pa_alsa_safe_mmap_begin(u->pcm_handle, &areas, &offset, &frames, u->hwbuf_size, &u->source->sample_spec)) < 0)) {
263 if ((r = try_recover(u, "snd_pcm_mmap_begin", err)) == 0)
269 /* Make sure that if these memblocks need to be copied they will fit into one slot */
270 if (frames > pa_mempool_block_size_max(u->source->core->mempool)/u->frame_size)
271 frames = pa_mempool_block_size_max(u->source->core->mempool)/u->frame_size;
273 /* Check these are multiples of 8 bit */
274 pa_assert((areas[0].first & 7) == 0);
275 pa_assert((areas[0].step & 7)== 0);
277 /* We assume a single interleaved memory buffer */
278 pa_assert((areas[0].first >> 3) == 0);
279 pa_assert((areas[0].step >> 3) == u->frame_size);
281 p = (uint8_t*) areas[0].addr + (offset * u->frame_size);
283 chunk.memblock = pa_memblock_new_fixed(u->core->mempool, p, frames * u->frame_size, TRUE);
284 chunk.length = pa_memblock_get_length(chunk.memblock);
287 pa_source_post(u->source, &chunk);
288 pa_memblock_unref_fixed(chunk.memblock);
290 if (PA_UNLIKELY((sframes = snd_pcm_mmap_commit(u->pcm_handle, offset, frames)) < 0)) {
292 if ((r = try_recover(u, "snd_pcm_mmap_commit", (int) sframes)) == 0)
300 u->frame_index += (int64_t) frames;
302 /* pa_log_debug("read %lu frames", (unsigned long) frames); */
304 if (frames >= (snd_pcm_uframes_t) n)
307 n -= (snd_pcm_sframes_t) frames;
311 *sleep_usec = pa_bytes_to_usec(left_to_record, &u->source->sample_spec) - process_usec;
315 static int unix_read(struct userdata *u, pa_usec_t *sleep_usec, pa_bool_t polled) {
317 pa_usec_t max_sleep_usec = 0, process_usec = 0;
318 size_t left_to_record;
321 pa_source_assert_ref(u->source);
324 hw_sleep_time(u, &max_sleep_usec, &process_usec);
330 snd_pcm_hwsync(u->pcm_handle);
332 if (PA_UNLIKELY((n = pa_alsa_safe_avail_update(u->pcm_handle, u->hwbuf_size, &u->source->sample_spec)) < 0)) {
334 if ((r = try_recover(u, "snd_pcm_avail_update", (int) n)) == 0)
340 left_to_record = check_left_to_record(u, n);
344 pa_bytes_to_usec(left_to_record, &u->source->sample_spec) > process_usec+max_sleep_usec/2)
347 if (PA_UNLIKELY(n <= 0)) {
349 if (polled && pa_log_ratelimit())
350 pa_log("ALSA woke us up to read new data from the device, but there was actually nothing to read! "
351 "Most likely this is an ALSA driver bug. Please report this issue to the ALSA developers. "
352 "We were woken up with POLLIN set -- however a subsequent snd_pcm_avail_update() returned 0.");
361 snd_pcm_sframes_t frames;
364 chunk.memblock = pa_memblock_new(u->core->mempool, (size_t) -1);
366 frames = (snd_pcm_sframes_t) (pa_memblock_get_length(chunk.memblock) / u->frame_size);
371 /* pa_log_debug("%lu frames to read", (unsigned long) n); */
373 p = pa_memblock_acquire(chunk.memblock);
374 frames = snd_pcm_readi(u->pcm_handle, (uint8_t*) p, (snd_pcm_uframes_t) frames);
375 pa_memblock_release(chunk.memblock);
377 pa_assert(frames != 0);
379 if (PA_UNLIKELY(frames < 0)) {
380 pa_memblock_unref(chunk.memblock);
382 if ((r = try_recover(u, "snd_pcm_readi", (int) (frames))) == 0)
389 chunk.length = (size_t) frames * u->frame_size;
391 pa_source_post(u->source, &chunk);
392 pa_memblock_unref(chunk.memblock);
396 u->frame_index += frames;
398 /* pa_log_debug("read %lu frames", (unsigned long) frames); */
407 *sleep_usec = pa_bytes_to_usec(left_to_record, &u->source->sample_spec) - process_usec;
411 static void update_smoother(struct userdata *u) {
412 snd_pcm_sframes_t delay = 0;
415 pa_usec_t now1, now2;
418 pa_assert(u->pcm_handle);
420 /* Let's update the time smoother */
422 snd_pcm_hwsync(u->pcm_handle);
423 snd_pcm_avail_update(u->pcm_handle);
425 if (PA_UNLIKELY((err = snd_pcm_delay(u->pcm_handle, &delay)) < 0)) {
426 pa_log_warn("Failed to get delay: %s", snd_strerror(err));
430 frames = u->frame_index + delay;
432 now1 = pa_rtclock_usec();
433 now2 = pa_bytes_to_usec((uint64_t) frames * u->frame_size, &u->source->sample_spec);
435 pa_smoother_put(u->smoother, now1, now2);
438 static pa_usec_t source_get_latency(struct userdata *u) {
441 pa_usec_t now1, now2;
445 now1 = pa_rtclock_usec();
446 now2 = pa_smoother_get(u->smoother, now1);
448 delay = (int64_t) now2 - (int64_t) pa_bytes_to_usec((uint64_t) u->frame_index * u->frame_size, &u->source->sample_spec);
451 r = (pa_usec_t) delay;
456 static int build_pollfd(struct userdata *u) {
458 pa_assert(u->pcm_handle);
460 if (u->alsa_rtpoll_item)
461 pa_rtpoll_item_free(u->alsa_rtpoll_item);
463 if (!(u->alsa_rtpoll_item = pa_alsa_build_pollfd(u->pcm_handle, u->rtpoll)))
469 static int suspend(struct userdata *u) {
471 pa_assert(u->pcm_handle);
473 pa_smoother_pause(u->smoother, pa_rtclock_usec());
476 snd_pcm_close(u->pcm_handle);
477 u->pcm_handle = NULL;
479 if (u->alsa_rtpoll_item) {
480 pa_rtpoll_item_free(u->alsa_rtpoll_item);
481 u->alsa_rtpoll_item = NULL;
484 pa_log_info("Device suspended...");
489 static int update_sw_params(struct userdata *u) {
490 snd_pcm_uframes_t avail_min;
495 /* Use the full buffer if noone asked us for anything specific */
496 u->hwbuf_unused_frames = 0;
501 if ((latency = pa_source_get_requested_latency_within_thread(u->source)) != (pa_usec_t) -1) {
504 pa_log_debug("latency set to %0.2fms", (double) latency / PA_USEC_PER_MSEC);
506 b = pa_usec_to_bytes(latency, &u->source->sample_spec);
508 /* We need at least one sample in our buffer */
510 if (PA_UNLIKELY(b < u->frame_size))
513 u->hwbuf_unused_frames = (snd_pcm_sframes_t)
514 (PA_LIKELY(b < u->hwbuf_size) ?
515 ((u->hwbuf_size - b) / u->frame_size) : 0);
518 fix_tsched_watermark(u);
521 pa_log_debug("hwbuf_unused_frames=%lu", (unsigned long) u->hwbuf_unused_frames);
526 pa_usec_t sleep_usec, process_usec;
528 hw_sleep_time(u, &sleep_usec, &process_usec);
529 avail_min += pa_usec_to_bytes(sleep_usec, &u->source->sample_spec) / u->frame_size;
532 pa_log_debug("setting avail_min=%lu", (unsigned long) avail_min);
534 if ((err = pa_alsa_set_sw_params(u->pcm_handle, avail_min)) < 0) {
535 pa_log("Failed to set software parameters: %s", snd_strerror(err));
542 static int unsuspend(struct userdata *u) {
547 snd_pcm_uframes_t period_size;
550 pa_assert(!u->pcm_handle);
552 pa_log_info("Trying resume...");
554 snd_config_update_free_global();
556 if ((err = snd_pcm_open(&u->pcm_handle, u->device_name, SND_PCM_STREAM_CAPTURE,
557 /*SND_PCM_NONBLOCK|*/
558 SND_PCM_NO_AUTO_RESAMPLE|
559 SND_PCM_NO_AUTO_CHANNELS|
560 SND_PCM_NO_AUTO_FORMAT)) < 0) {
561 pa_log("Error opening PCM device %s: %s", u->device_name, snd_strerror(err));
565 ss = u->source->sample_spec;
566 nfrags = u->nfragments;
567 period_size = u->fragment_size / u->frame_size;
571 if ((err = pa_alsa_set_hw_params(u->pcm_handle, &ss, &nfrags, &period_size, u->hwbuf_size / u->frame_size, &b, &d, TRUE)) < 0) {
572 pa_log("Failed to set hardware parameters: %s", snd_strerror(err));
576 if (b != u->use_mmap || d != u->use_tsched) {
577 pa_log_warn("Resume failed, couldn't get original access mode.");
581 if (!pa_sample_spec_equal(&ss, &u->source->sample_spec)) {
582 pa_log_warn("Resume failed, couldn't restore original sample settings.");
586 if (nfrags != u->nfragments || period_size*u->frame_size != u->fragment_size) {
587 pa_log_warn("Resume failed, couldn't restore original fragment settings. (Old: %lu*%lu, New %lu*%lu)",
588 (unsigned long) u->nfragments, (unsigned long) u->fragment_size,
589 (unsigned long) nfrags, period_size * u->frame_size);
593 if (update_sw_params(u) < 0)
596 if (build_pollfd(u) < 0)
599 /* FIXME: We need to reload the volume somehow */
601 snd_pcm_start(u->pcm_handle);
602 pa_smoother_resume(u->smoother, pa_rtclock_usec());
604 pa_log_info("Resumed successfully...");
610 snd_pcm_close(u->pcm_handle);
611 u->pcm_handle = NULL;
617 static int source_process_msg(pa_msgobject *o, int code, void *data, int64_t offset, pa_memchunk *chunk) {
618 struct userdata *u = PA_SOURCE(o)->userdata;
622 case PA_SOURCE_MESSAGE_GET_LATENCY: {
626 r = source_get_latency(u);
628 *((pa_usec_t*) data) = r;
633 case PA_SOURCE_MESSAGE_SET_STATE:
635 switch ((pa_source_state_t) PA_PTR_TO_UINT(data)) {
637 case PA_SOURCE_SUSPENDED:
638 pa_assert(PA_SOURCE_IS_OPENED(u->source->thread_info.state));
646 case PA_SOURCE_RUNNING:
648 if (u->source->thread_info.state == PA_SOURCE_INIT) {
649 if (build_pollfd(u) < 0)
652 snd_pcm_start(u->pcm_handle);
655 if (u->source->thread_info.state == PA_SOURCE_SUSPENDED) {
656 if (unsuspend(u) < 0)
662 case PA_SOURCE_UNLINKED:
664 case PA_SOURCE_INVALID_STATE:
671 return pa_source_process_msg(o, code, data, offset, chunk);
674 static int mixer_callback(snd_mixer_elem_t *elem, unsigned int mask) {
675 struct userdata *u = snd_mixer_elem_get_callback_private(elem);
678 pa_assert(u->mixer_handle);
680 if (mask == SND_CTL_EVENT_MASK_REMOVE)
683 if (mask & SND_CTL_EVENT_MASK_VALUE) {
684 pa_source_get_volume(u->source, TRUE);
685 pa_source_get_mute(u->source, TRUE);
691 static pa_volume_t from_alsa_volume(struct userdata *u, long alsa_vol) {
693 return (pa_volume_t) round(((double) (alsa_vol - u->hw_volume_min) * PA_VOLUME_NORM) /
694 (double) (u->hw_volume_max - u->hw_volume_min));
697 static long to_alsa_volume(struct userdata *u, pa_volume_t vol) {
700 alsa_vol = (long) round(((double) vol * (double) (u->hw_volume_max - u->hw_volume_min))
701 / PA_VOLUME_NORM) + u->hw_volume_min;
703 return PA_CLAMP_UNLIKELY(alsa_vol, u->hw_volume_min, u->hw_volume_max);
706 static int source_get_volume_cb(pa_source *s) {
707 struct userdata *u = s->userdata;
711 char t[PA_CVOLUME_SNPRINT_MAX];
714 pa_assert(u->mixer_elem);
716 if (u->mixer_seperate_channels) {
718 r.channels = s->sample_spec.channels;
720 for (i = 0; i < s->sample_spec.channels; i++) {
723 if (u->hw_dB_supported) {
725 if ((err = snd_mixer_selem_get_capture_dB(u->mixer_elem, u->mixer_map[i], &alsa_vol)) < 0)
728 #ifdef HAVE_VALGRIND_MEMCHECK_H
729 VALGRIND_MAKE_MEM_DEFINED(&alsa_vol, sizeof(alsa_vol));
732 r.values[i] = pa_sw_volume_from_dB((double) (alsa_vol - u->hw_dB_max) / 100.0);
735 if ((err = snd_mixer_selem_get_capture_volume(u->mixer_elem, u->mixer_map[i], &alsa_vol)) < 0)
738 r.values[i] = from_alsa_volume(u, alsa_vol);
745 if (u->hw_dB_supported) {
747 if ((err = snd_mixer_selem_get_capture_dB(u->mixer_elem, SND_MIXER_SCHN_MONO, &alsa_vol)) < 0)
750 #ifdef HAVE_VALGRIND_MEMCHECK_H
751 VALGRIND_MAKE_MEM_DEFINED(&alsa_vol, sizeof(alsa_vol));
754 pa_cvolume_set(&r, s->sample_spec.channels, pa_sw_volume_from_dB((double) (alsa_vol - u->hw_dB_max) / 100.0));
758 if ((err = snd_mixer_selem_get_capture_volume(u->mixer_elem, SND_MIXER_SCHN_MONO, &alsa_vol)) < 0)
761 pa_cvolume_set(&r, s->sample_spec.channels, from_alsa_volume(u, alsa_vol));
765 pa_log_debug("Read hardware volume: %s", pa_cvolume_snprint(t, sizeof(t), &r));
767 if (!pa_cvolume_equal(&u->hardware_volume, &r)) {
769 u->hardware_volume = s->volume = r;
771 if (u->hw_dB_supported) {
774 /* Hmm, so the hardware volume changed, let's reset our software volume */
776 pa_cvolume_reset(&reset, s->sample_spec.channels);
777 pa_source_set_soft_volume(s, &reset);
784 pa_log_error("Unable to read volume: %s", snd_strerror(err));
789 static int source_set_volume_cb(pa_source *s) {
790 struct userdata *u = s->userdata;
796 pa_assert(u->mixer_elem);
798 if (u->mixer_seperate_channels) {
800 r.channels = s->sample_spec.channels;
802 for (i = 0; i < s->sample_spec.channels; i++) {
806 vol = s->volume.values[i];
808 if (u->hw_dB_supported) {
810 alsa_vol = (long) (pa_sw_volume_to_dB(vol) * 100);
811 alsa_vol += u->hw_dB_max;
812 alsa_vol = PA_CLAMP_UNLIKELY(alsa_vol, u->hw_dB_min, u->hw_dB_max);
814 if ((err = snd_mixer_selem_set_capture_dB(u->mixer_elem, u->mixer_map[i], alsa_vol, 1)) < 0)
817 if ((err = snd_mixer_selem_get_capture_dB(u->mixer_elem, u->mixer_map[i], &alsa_vol)) < 0)
820 #ifdef HAVE_VALGRIND_MEMCHECK_H
821 VALGRIND_MAKE_MEM_DEFINED(&alsa_vol, sizeof(alsa_vol));
824 r.values[i] = pa_sw_volume_from_dB((double) (alsa_vol - u->hw_dB_max) / 100.0);
827 alsa_vol = to_alsa_volume(u, vol);
829 if ((err = snd_mixer_selem_set_capture_volume(u->mixer_elem, u->mixer_map[i], alsa_vol)) < 0)
832 if ((err = snd_mixer_selem_get_capture_volume(u->mixer_elem, u->mixer_map[i], &alsa_vol)) < 0)
835 r.values[i] = from_alsa_volume(u, alsa_vol);
843 vol = pa_cvolume_max(&s->volume);
845 if (u->hw_dB_supported) {
846 alsa_vol = (long) (pa_sw_volume_to_dB(vol) * 100);
847 alsa_vol += u->hw_dB_max;
848 alsa_vol = PA_CLAMP_UNLIKELY(alsa_vol, u->hw_dB_min, u->hw_dB_max);
850 if ((err = snd_mixer_selem_set_capture_dB_all(u->mixer_elem, alsa_vol, 1)) < 0)
853 if ((err = snd_mixer_selem_get_capture_dB(u->mixer_elem, SND_MIXER_SCHN_MONO, &alsa_vol)) < 0)
856 #ifdef HAVE_VALGRIND_MEMCHECK_H
857 VALGRIND_MAKE_MEM_DEFINED(&alsa_vol, sizeof(alsa_vol));
860 pa_cvolume_set(&r, s->volume.channels, pa_sw_volume_from_dB((double) (alsa_vol - u->hw_dB_max) / 100.0));
863 alsa_vol = to_alsa_volume(u, vol);
865 if ((err = snd_mixer_selem_set_capture_volume_all(u->mixer_elem, alsa_vol)) < 0)
868 if ((err = snd_mixer_selem_get_capture_volume(u->mixer_elem, SND_MIXER_SCHN_MONO, &alsa_vol)) < 0)
871 pa_cvolume_set(&r, s->sample_spec.channels, from_alsa_volume(u, alsa_vol));
875 u->hardware_volume = r;
877 if (u->hw_dB_supported) {
878 char t[PA_CVOLUME_SNPRINT_MAX];
880 /* Match exactly what the user requested by software */
882 pa_sw_cvolume_divide(&r, &s->volume, &r);
883 pa_source_set_soft_volume(s, &r);
885 pa_log_debug("Requested volume: %s", pa_cvolume_snprint(t, sizeof(t), &s->volume));
886 pa_log_debug("Got hardware volume: %s", pa_cvolume_snprint(t, sizeof(t), &u->hardware_volume));
887 pa_log_debug("Calculated software volume: %s", pa_cvolume_snprint(t, sizeof(t), &r));
891 /* We can't match exactly what the user requested, hence let's
892 * at least tell the user about it */
899 pa_log_error("Unable to set volume: %s", snd_strerror(err));
904 static int source_get_mute_cb(pa_source *s) {
905 struct userdata *u = s->userdata;
909 pa_assert(u->mixer_elem);
911 if ((err = snd_mixer_selem_get_capture_switch(u->mixer_elem, 0, &sw)) < 0) {
912 pa_log_error("Unable to get switch: %s", snd_strerror(err));
921 static int source_set_mute_cb(pa_source *s) {
922 struct userdata *u = s->userdata;
926 pa_assert(u->mixer_elem);
928 if ((err = snd_mixer_selem_set_capture_switch_all(u->mixer_elem, !s->muted)) < 0) {
929 pa_log_error("Unable to set switch: %s", snd_strerror(err));
936 static void source_update_requested_latency_cb(pa_source *s) {
937 struct userdata *u = s->userdata;
946 static void thread_func(void *userdata) {
947 struct userdata *u = userdata;
948 unsigned short revents = 0;
952 pa_log_debug("Thread starting up");
954 if (u->core->realtime_scheduling)
955 pa_make_realtime(u->core->realtime_priority);
957 pa_thread_mq_install(&u->thread_mq);
958 pa_rtpoll_install(u->rtpoll);
963 /* pa_log_debug("loop"); */
965 /* Read some data and pass it to the sources */
966 if (PA_SOURCE_IS_OPENED(u->source->thread_info.state)) {
968 pa_usec_t sleep_usec = 0;
971 work_done = mmap_read(u, &sleep_usec, revents & POLLIN);
973 work_done = unix_read(u, &sleep_usec, revents & POLLIN);
978 /* pa_log_debug("work_done = %i", work_done); */
986 /* OK, the capture buffer is now empty, let's
987 * calculate when to wake up next */
989 /* pa_log_debug("Waking up in %0.2fms (sound card clock).", (double) sleep_usec / PA_USEC_PER_MSEC); */
991 /* Convert from the sound card time domain to the
992 * system time domain */
993 cusec = pa_smoother_translate(u->smoother, pa_rtclock_usec(), sleep_usec);
995 /* pa_log_debug("Waking up in %0.2fms (system clock).", (double) cusec / PA_USEC_PER_MSEC); */
997 /* We don't trust the conversion, so we wake up whatever comes first */
998 pa_rtpoll_set_timer_relative(u->rtpoll, PA_MIN(sleep_usec, cusec));
1000 } else if (u->use_tsched)
1002 /* OK, we're in an invalid state, let's disable our timers */
1003 pa_rtpoll_set_timer_disabled(u->rtpoll);
1005 /* Hmm, nothing to do. Let's sleep */
1006 if ((ret = pa_rtpoll_run(u->rtpoll, TRUE)) < 0)
1012 /* Tell ALSA about this and process its response */
1013 if (PA_SOURCE_IS_OPENED(u->source->thread_info.state)) {
1014 struct pollfd *pollfd;
1018 pollfd = pa_rtpoll_item_get_pollfd(u->alsa_rtpoll_item, &n);
1020 if ((err = snd_pcm_poll_descriptors_revents(u->pcm_handle, pollfd, n, &revents)) < 0) {
1021 pa_log("snd_pcm_poll_descriptors_revents() failed: %s", snd_strerror(err));
1025 if (revents & (POLLOUT|POLLERR|POLLNVAL|POLLHUP|POLLPRI)) {
1026 if (pa_alsa_recover_from_poll(u->pcm_handle, revents) < 0)
1029 snd_pcm_start(u->pcm_handle);
1032 if (revents && u->use_tsched && pa_log_ratelimit())
1033 pa_log_debug("Wakeup from ALSA!%s%s", (revents & POLLIN) ? " INPUT" : "", (revents & POLLOUT) ? " OUTPUT" : "");
1039 /* If this was no regular exit from the loop we have to continue
1040 * processing messages until we received PA_MESSAGE_SHUTDOWN */
1041 pa_asyncmsgq_post(u->thread_mq.outq, PA_MSGOBJECT(u->core), PA_CORE_MESSAGE_UNLOAD_MODULE, u->module, 0, NULL, NULL);
1042 pa_asyncmsgq_wait_for(u->thread_mq.inq, PA_MESSAGE_SHUTDOWN);
1045 pa_log_debug("Thread shutting down");
1048 static void set_source_name(pa_source_new_data *data, pa_modargs *ma, const char *device_id, const char *device_name) {
1054 pa_assert(device_name);
1056 if ((n = pa_modargs_get_value(ma, "source_name", NULL))) {
1057 pa_source_new_data_set_name(data, n);
1058 data->namereg_fail = TRUE;
1062 if ((n = pa_modargs_get_value(ma, "name", NULL)))
1063 data->namereg_fail = TRUE;
1065 n = device_id ? device_id : device_name;
1066 data->namereg_fail = FALSE;
1069 t = pa_sprintf_malloc("alsa_input.%s", n);
1070 pa_source_new_data_set_name(data, t);
1074 pa_source *pa_alsa_source_new(pa_module *m, pa_modargs *ma, const char*driver, pa_card *card, const pa_alsa_profile_info *profile) {
1076 struct userdata *u = NULL;
1077 const char *dev_id = NULL;
1080 uint32_t nfrags, hwbuf_size, frag_size, tsched_size, tsched_watermark;
1081 snd_pcm_uframes_t period_frames, tsched_frames;
1083 snd_pcm_info_t *pcm_info = NULL;
1085 pa_bool_t use_mmap = TRUE, b, use_tsched = TRUE, d;
1086 pa_source_new_data data;
1088 snd_pcm_info_alloca(&pcm_info);
1092 ss = m->core->default_sample_spec;
1093 if (pa_modargs_get_sample_spec_and_channel_map(ma, &ss, &map, PA_CHANNEL_MAP_ALSA) < 0) {
1094 pa_log("Failed to parse sample specification");
1098 frame_size = pa_frame_size(&ss);
1100 nfrags = m->core->default_n_fragments;
1101 frag_size = (uint32_t) pa_usec_to_bytes(m->core->default_fragment_size_msec*PA_USEC_PER_MSEC, &ss);
1103 frag_size = (uint32_t) frame_size;
1104 tsched_size = (uint32_t) pa_usec_to_bytes(DEFAULT_TSCHED_BUFFER_USEC, &ss);
1105 tsched_watermark = (uint32_t) pa_usec_to_bytes(DEFAULT_TSCHED_WATERMARK_USEC, &ss);
1107 if (pa_modargs_get_value_u32(ma, "fragments", &nfrags) < 0 ||
1108 pa_modargs_get_value_u32(ma, "fragment_size", &frag_size) < 0 ||
1109 pa_modargs_get_value_u32(ma, "tsched_buffer_size", &tsched_size) < 0 ||
1110 pa_modargs_get_value_u32(ma, "tsched_buffer_watermark", &tsched_watermark) < 0) {
1111 pa_log("Failed to parse buffer metrics");
1115 hwbuf_size = frag_size * nfrags;
1116 period_frames = frag_size/frame_size;
1117 tsched_frames = tsched_size/frame_size;
1119 if (pa_modargs_get_value_boolean(ma, "mmap", &use_mmap) < 0) {
1120 pa_log("Failed to parse mmap argument.");
1124 if (pa_modargs_get_value_boolean(ma, "tsched", &use_tsched) < 0) {
1125 pa_log("Failed to parse timer_scheduling argument.");
1129 if (use_tsched && !pa_rtclock_hrtimer()) {
1130 pa_log_notice("Disabling timer-based scheduling because high-resolution timers are not available from the kernel.");
1134 u = pa_xnew0(struct userdata, 1);
1137 u->use_mmap = use_mmap;
1138 u->use_tsched = use_tsched;
1139 u->rtpoll = pa_rtpoll_new();
1140 pa_thread_mq_init(&u->thread_mq, m->core->mainloop, u->rtpoll);
1141 u->alsa_rtpoll_item = NULL;
1143 u->smoother = pa_smoother_new(DEFAULT_TSCHED_WATERMARK_USEC, DEFAULT_TSCHED_WATERMARK_USEC, TRUE, 5);
1144 pa_smoother_set_time_offset(u->smoother, pa_rtclock_usec());
1151 if (!(dev_id = pa_modargs_get_value(ma, "device_id", NULL))) {
1152 pa_log("device_id= not set");
1156 if (!(u->pcm_handle = pa_alsa_open_by_device_id_profile(
1160 SND_PCM_STREAM_CAPTURE,
1161 &nfrags, &period_frames, tsched_frames,
1165 } else if ((dev_id = pa_modargs_get_value(ma, "device_id", NULL))) {
1167 if (!(u->pcm_handle = pa_alsa_open_by_device_id_auto(
1171 SND_PCM_STREAM_CAPTURE,
1172 &nfrags, &period_frames, tsched_frames,
1178 if (!(u->pcm_handle = pa_alsa_open_by_device_string(
1179 pa_modargs_get_value(ma, "device", DEFAULT_DEVICE),
1182 SND_PCM_STREAM_CAPTURE,
1183 &nfrags, &period_frames, tsched_frames,
1188 pa_assert(u->device_name);
1189 pa_log_info("Successfully opened device %s.", u->device_name);
1192 pa_log_info("Selected configuration '%s' (%s).", profile->description, profile->name);
1194 if (use_mmap && !b) {
1195 pa_log_info("Device doesn't support mmap(), falling back to UNIX read/write mode.");
1196 u->use_mmap = use_mmap = FALSE;
1199 if (use_tsched && (!b || !d)) {
1200 pa_log_info("Cannot enabled timer-based scheduling, falling back to sound IRQ scheduling.");
1201 u->use_tsched = use_tsched = FALSE;
1205 pa_log_info("Successfully enabled mmap() mode.");
1208 pa_log_info("Successfully enabled timer-based scheduling mode.");
1210 if ((err = snd_pcm_info(u->pcm_handle, pcm_info)) < 0) {
1211 pa_log("Error fetching PCM info: %s", snd_strerror(err));
1215 /* ALSA might tweak the sample spec, so recalculate the frame size */
1216 frame_size = pa_frame_size(&ss);
1218 if ((err = snd_mixer_open(&u->mixer_handle, 0)) < 0)
1219 pa_log("Error opening mixer: %s", snd_strerror(err));
1221 pa_bool_t found = FALSE;
1223 if (pa_alsa_prepare_mixer(u->mixer_handle, u->device_name) >= 0)
1226 snd_pcm_info_t* info;
1228 snd_pcm_info_alloca(&info);
1230 if (snd_pcm_info(u->pcm_handle, info) >= 0) {
1234 if ((card_idx = snd_pcm_info_get_card(info)) >= 0) {
1236 md = pa_sprintf_malloc("hw:%i", card_idx);
1238 if (strcmp(u->device_name, md))
1239 if (pa_alsa_prepare_mixer(u->mixer_handle, md) >= 0)
1247 if (!(u->mixer_elem = pa_alsa_find_elem(u->mixer_handle, "Capture", "Mic", FALSE)))
1251 snd_mixer_close(u->mixer_handle);
1252 u->mixer_handle = NULL;
1256 pa_source_new_data_init(&data);
1257 data.driver = driver;
1260 set_source_name(&data, ma, dev_id, u->device_name);
1261 pa_source_new_data_set_sample_spec(&data, &ss);
1262 pa_source_new_data_set_channel_map(&data, &map);
1264 pa_alsa_init_proplist_pcm(m->core, data.proplist, pcm_info);
1265 pa_proplist_sets(data.proplist, PA_PROP_DEVICE_STRING, u->device_name);
1266 pa_proplist_setf(data.proplist, PA_PROP_DEVICE_BUFFERING_BUFFER_SIZE, "%lu", (unsigned long) (period_frames * frame_size * nfrags));
1267 pa_proplist_setf(data.proplist, PA_PROP_DEVICE_BUFFERING_FRAGMENT_SIZE, "%lu", (unsigned long) (period_frames * frame_size));
1268 pa_proplist_sets(data.proplist, PA_PROP_DEVICE_ACCESS_MODE, u->use_tsched ? "mmap+timer" : (u->use_mmap ? "mmap" : "serial"));
1271 pa_proplist_sets(data.proplist, PA_PROP_DEVICE_PROFILE_NAME, profile->name);
1272 pa_proplist_sets(data.proplist, PA_PROP_DEVICE_PROFILE_DESCRIPTION, profile->description);
1275 u->source = pa_source_new(m->core, &data, PA_SOURCE_HARDWARE|PA_SOURCE_LATENCY);
1276 pa_source_new_data_done(&data);
1279 pa_log("Failed to create source object");
1283 u->source->parent.process_msg = source_process_msg;
1284 u->source->update_requested_latency = source_update_requested_latency_cb;
1285 u->source->userdata = u;
1287 pa_source_set_asyncmsgq(u->source, u->thread_mq.inq);
1288 pa_source_set_rtpoll(u->source, u->rtpoll);
1290 u->frame_size = frame_size;
1291 u->fragment_size = frag_size = (uint32_t) (period_frames * frame_size);
1292 u->nfragments = nfrags;
1293 u->hwbuf_size = u->fragment_size * nfrags;
1294 u->hwbuf_unused_frames = 0;
1295 u->tsched_watermark = tsched_watermark;
1297 u->hw_dB_supported = FALSE;
1298 u->hw_dB_min = u->hw_dB_max = 0;
1299 u->hw_volume_min = u->hw_volume_max = 0;
1300 u->mixer_seperate_channels = FALSE;
1301 pa_cvolume_mute(&u->hardware_volume, u->source->sample_spec.channels);
1304 fix_tsched_watermark(u);
1306 pa_source_set_latency_range(u->source,
1307 !use_tsched ? pa_bytes_to_usec(u->hwbuf_size, &ss) : (pa_usec_t) -1,
1308 pa_bytes_to_usec(u->hwbuf_size, &ss));
1310 pa_log_info("Using %u fragments of size %lu bytes, buffer time is %0.2fms",
1311 nfrags, (long unsigned) u->fragment_size,
1312 (double) pa_bytes_to_usec(u->hwbuf_size, &ss) / PA_USEC_PER_MSEC);
1315 pa_log_info("Time scheduling watermark is %0.2fms",
1316 (double) pa_bytes_to_usec(u->tsched_watermark, &ss) / PA_USEC_PER_MSEC);
1318 if (update_sw_params(u) < 0)
1321 if (u->mixer_handle) {
1322 pa_assert(u->mixer_elem);
1324 if (snd_mixer_selem_has_capture_volume(u->mixer_elem)) {
1325 pa_bool_t suitable = FALSE;
1327 if (snd_mixer_selem_get_capture_volume_range(u->mixer_elem, &u->hw_volume_min, &u->hw_volume_max) < 0)
1328 pa_log_info("Failed to get volume range. Falling back to software volume control.");
1329 else if (u->hw_volume_min >= u->hw_volume_max)
1330 pa_log_warn("Your kernel driver is broken: it reports a volume range from %li to %li which makes no sense.", u->hw_volume_min, u->hw_volume_max);
1332 pa_log_info("Volume ranges from %li to %li.", u->hw_volume_min, u->hw_volume_max);
1337 if (snd_mixer_selem_get_capture_dB_range(u->mixer_elem, &u->hw_dB_min, &u->hw_dB_max) < 0)
1338 pa_log_info("Mixer doesn't support dB information.");
1340 #ifdef HAVE_VALGRIND_MEMCHECK_H
1341 VALGRIND_MAKE_MEM_DEFINED(&u->hw_dB_min, sizeof(u->hw_dB_min));
1342 VALGRIND_MAKE_MEM_DEFINED(&u->hw_dB_max, sizeof(u->hw_dB_max));
1345 if (u->hw_dB_min >= u->hw_dB_max)
1346 pa_log_warn("Your kernel driver is broken: it reports a volume range from %0.2f dB to %0.2f dB which makes no sense.", (double) u->hw_dB_min/100.0, (double) u->hw_dB_max/100.0);
1348 pa_log_info("Volume ranges from %0.2f dB to %0.2f dB.", (double) u->hw_dB_min/100.0, (double) u->hw_dB_max/100.0);
1349 u->hw_dB_supported = TRUE;
1351 if (u->hw_dB_max > 0) {
1352 u->source->base_volume = pa_sw_volume_from_dB(- (double) u->hw_dB_max/100.0);
1353 pa_log_info("Fixing base volume to %0.2f dB", pa_sw_volume_to_dB(u->source->base_volume));
1355 pa_log_info("No particular base volume set, fixing to 0 dB");
1360 if (!u->hw_dB_supported &&
1361 u->hw_volume_max - u->hw_volume_min < 3) {
1363 pa_log_info("Device has less than 4 volume levels. Falling back to software volume control.");
1369 u->mixer_seperate_channels = pa_alsa_calc_mixer_map(u->mixer_elem, &map, u->mixer_map, FALSE) >= 0;
1371 u->source->get_volume = source_get_volume_cb;
1372 u->source->set_volume = source_set_volume_cb;
1373 u->source->flags |= PA_SOURCE_HW_VOLUME_CTRL | (u->hw_dB_supported ? PA_SOURCE_DECIBEL_VOLUME : 0);
1374 pa_log_info("Using hardware volume control. Hardware dB scale %s.", u->hw_dB_supported ? "supported" : "not supported");
1376 pa_log_info("Using software volume control.");
1379 if (snd_mixer_selem_has_capture_switch(u->mixer_elem)) {
1380 u->source->get_mute = source_get_mute_cb;
1381 u->source->set_mute = source_set_mute_cb;
1382 u->source->flags |= PA_SOURCE_HW_MUTE_CTRL;
1384 pa_log_info("Using software mute control.");
1386 u->mixer_fdl = pa_alsa_fdlist_new();
1388 if (pa_alsa_fdlist_set_mixer(u->mixer_fdl, u->mixer_handle, m->core->mainloop) < 0) {
1389 pa_log("Failed to initialize file descriptor monitoring");
1393 snd_mixer_elem_set_callback(u->mixer_elem, mixer_callback);
1394 snd_mixer_elem_set_callback_private(u->mixer_elem, u);
1396 u->mixer_fdl = NULL;
1398 pa_alsa_dump(u->pcm_handle);
1400 if (!(u->thread = pa_thread_new(thread_func, u))) {
1401 pa_log("Failed to create thread.");
1404 /* Get initial mixer settings */
1405 if (data.volume_is_set) {
1406 if (u->source->set_volume)
1407 u->source->set_volume(u->source);
1409 if (u->source->get_volume)
1410 u->source->get_volume(u->source);
1413 if (data.muted_is_set) {
1414 if (u->source->set_mute)
1415 u->source->set_mute(u->source);
1417 if (u->source->get_mute)
1418 u->source->get_mute(u->source);
1421 pa_source_put(u->source);
1432 static void userdata_free(struct userdata *u) {
1436 pa_source_unlink(u->source);
1439 pa_asyncmsgq_send(u->thread_mq.inq, NULL, PA_MESSAGE_SHUTDOWN, NULL, 0, NULL);
1440 pa_thread_free(u->thread);
1443 pa_thread_mq_done(&u->thread_mq);
1446 pa_source_unref(u->source);
1448 if (u->alsa_rtpoll_item)
1449 pa_rtpoll_item_free(u->alsa_rtpoll_item);
1452 pa_rtpoll_free(u->rtpoll);
1455 pa_alsa_fdlist_free(u->mixer_fdl);
1457 if (u->mixer_handle)
1458 snd_mixer_close(u->mixer_handle);
1460 if (u->pcm_handle) {
1461 snd_pcm_drop(u->pcm_handle);
1462 snd_pcm_close(u->pcm_handle);
1466 pa_smoother_free(u->smoother);
1468 pa_xfree(u->device_name);
1472 void pa_alsa_source_free(pa_source *s) {
1475 pa_source_assert_ref(s);
1476 pa_assert_se(u = s->userdata);