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.1 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
30 #include <asoundlib.h>
32 #include <pulse/rtclock.h>
33 #include <pulse/timeval.h>
34 #include <pulse/volume.h>
35 #include <pulse/xmalloc.h>
37 #include <pulsecore/core.h>
38 #include <pulsecore/i18n.h>
39 #include <pulsecore/module.h>
40 #include <pulsecore/memchunk.h>
41 #include <pulsecore/sink.h>
42 #include <pulsecore/modargs.h>
43 #include <pulsecore/core-rtclock.h>
44 #include <pulsecore/core-util.h>
45 #include <pulsecore/sample-util.h>
46 #include <pulsecore/log.h>
47 #include <pulsecore/macro.h>
48 #include <pulsecore/thread.h>
49 #include <pulsecore/thread-mq.h>
50 #include <pulsecore/rtpoll.h>
51 #include <pulsecore/time-smoother.h>
53 #include <modules/reserve-wrap.h>
55 #include "alsa-util.h"
56 #include "alsa-source.h"
58 /* #define DEBUG_TIMING */
60 #define DEFAULT_DEVICE "default"
62 #define DEFAULT_TSCHED_BUFFER_USEC (2*PA_USEC_PER_SEC) /* 2s */
63 #define DEFAULT_TSCHED_WATERMARK_USEC (20*PA_USEC_PER_MSEC) /* 20ms */
65 #define TSCHED_WATERMARK_INC_STEP_USEC (10*PA_USEC_PER_MSEC) /* 10ms */
66 #define TSCHED_WATERMARK_DEC_STEP_USEC (5*PA_USEC_PER_MSEC) /* 5ms */
67 #define TSCHED_WATERMARK_VERIFY_AFTER_USEC (20*PA_USEC_PER_SEC) /* 20s */
68 #define TSCHED_WATERMARK_INC_THRESHOLD_USEC (0*PA_USEC_PER_MSEC) /* 0ms */
69 #define TSCHED_WATERMARK_DEC_THRESHOLD_USEC (100*PA_USEC_PER_MSEC) /* 100ms */
70 #define TSCHED_WATERMARK_STEP_USEC (10*PA_USEC_PER_MSEC) /* 10ms */
72 #define TSCHED_MIN_SLEEP_USEC (10*PA_USEC_PER_MSEC) /* 10ms */
73 #define TSCHED_MIN_WAKEUP_USEC (4*PA_USEC_PER_MSEC) /* 4ms */
75 #define SMOOTHER_WINDOW_USEC (10*PA_USEC_PER_SEC) /* 10s */
76 #define SMOOTHER_ADJUST_USEC (1*PA_USEC_PER_SEC) /* 1s */
78 #define SMOOTHER_MIN_INTERVAL (2*PA_USEC_PER_MSEC) /* 2ms */
79 #define SMOOTHER_MAX_INTERVAL (200*PA_USEC_PER_MSEC) /* 200ms */
81 #define VOLUME_ACCURACY (PA_VOLUME_NORM/100)
89 pa_thread_mq thread_mq;
92 snd_pcm_t *pcm_handle;
95 pa_alsa_fdlist *mixer_fdl;
96 pa_alsa_mixer_pdata *mixer_pd;
97 snd_mixer_t *mixer_handle;
98 pa_alsa_path_set *mixer_path_set;
99 pa_alsa_path *mixer_path;
101 pa_cvolume hardware_volume;
110 tsched_watermark_ref,
116 watermark_inc_threshold,
117 watermark_dec_threshold;
119 pa_usec_t watermark_dec_not_before;
120 pa_usec_t min_latency_ref;
122 char *device_name; /* name of the PCM device */
123 char *control_device; /* name of the control device */
125 pa_bool_t use_mmap:1, use_tsched:1, deferred_volume:1, fixed_latency_range:1;
129 pa_rtpoll_item *alsa_rtpoll_item;
131 pa_smoother *smoother;
133 pa_usec_t smoother_interval;
134 pa_usec_t last_smoother_update;
136 pa_reserve_wrapper *reserve;
137 pa_hook_slot *reserve_slot;
138 pa_reserve_monitor_wrapper *monitor;
139 pa_hook_slot *monitor_slot;
142 static void userdata_free(struct userdata *u);
144 static pa_hook_result_t reserve_cb(pa_reserve_wrapper *r, void *forced, struct userdata *u) {
148 if (pa_source_suspend(u->source, TRUE, PA_SUSPEND_APPLICATION) < 0)
149 return PA_HOOK_CANCEL;
154 static void reserve_done(struct userdata *u) {
157 if (u->reserve_slot) {
158 pa_hook_slot_free(u->reserve_slot);
159 u->reserve_slot = NULL;
163 pa_reserve_wrapper_unref(u->reserve);
168 static void reserve_update(struct userdata *u) {
169 const char *description;
172 if (!u->source || !u->reserve)
175 if ((description = pa_proplist_gets(u->source->proplist, PA_PROP_DEVICE_DESCRIPTION)))
176 pa_reserve_wrapper_set_application_device_name(u->reserve, description);
179 static int reserve_init(struct userdata *u, const char *dname) {
188 if (pa_in_system_mode())
191 if (!(rname = pa_alsa_get_reserve_name(dname)))
194 /* We are resuming, try to lock the device */
195 u->reserve = pa_reserve_wrapper_get(u->core, rname);
203 pa_assert(!u->reserve_slot);
204 u->reserve_slot = pa_hook_connect(pa_reserve_wrapper_hook(u->reserve), PA_HOOK_NORMAL, (pa_hook_cb_t) reserve_cb, u);
209 static pa_hook_result_t monitor_cb(pa_reserve_monitor_wrapper *w, void* busy, struct userdata *u) {
215 b = PA_PTR_TO_UINT(busy) && !u->reserve;
217 pa_source_suspend(u->source, b, PA_SUSPEND_APPLICATION);
221 static void monitor_done(struct userdata *u) {
224 if (u->monitor_slot) {
225 pa_hook_slot_free(u->monitor_slot);
226 u->monitor_slot = NULL;
230 pa_reserve_monitor_wrapper_unref(u->monitor);
235 static int reserve_monitor_init(struct userdata *u, const char *dname) {
241 if (pa_in_system_mode())
244 if (!(rname = pa_alsa_get_reserve_name(dname)))
247 /* We are resuming, try to lock the device */
248 u->monitor = pa_reserve_monitor_wrapper_get(u->core, rname);
254 pa_assert(!u->monitor_slot);
255 u->monitor_slot = pa_hook_connect(pa_reserve_monitor_wrapper_hook(u->monitor), PA_HOOK_NORMAL, (pa_hook_cb_t) monitor_cb, u);
260 static void fix_min_sleep_wakeup(struct userdata *u) {
261 size_t max_use, max_use_2;
264 pa_assert(u->use_tsched);
266 max_use = u->hwbuf_size - u->hwbuf_unused;
267 max_use_2 = pa_frame_align(max_use/2, &u->source->sample_spec);
269 u->min_sleep = pa_usec_to_bytes(TSCHED_MIN_SLEEP_USEC, &u->source->sample_spec);
270 u->min_sleep = PA_CLAMP(u->min_sleep, u->frame_size, max_use_2);
272 u->min_wakeup = pa_usec_to_bytes(TSCHED_MIN_WAKEUP_USEC, &u->source->sample_spec);
273 u->min_wakeup = PA_CLAMP(u->min_wakeup, u->frame_size, max_use_2);
276 static void fix_tsched_watermark(struct userdata *u) {
279 pa_assert(u->use_tsched);
281 max_use = u->hwbuf_size - u->hwbuf_unused;
283 if (u->tsched_watermark > max_use - u->min_sleep)
284 u->tsched_watermark = max_use - u->min_sleep;
286 if (u->tsched_watermark < u->min_wakeup)
287 u->tsched_watermark = u->min_wakeup;
290 static void increase_watermark(struct userdata *u) {
291 size_t old_watermark;
292 pa_usec_t old_min_latency, new_min_latency;
295 pa_assert(u->use_tsched);
297 /* First, just try to increase the watermark */
298 old_watermark = u->tsched_watermark;
299 u->tsched_watermark = PA_MIN(u->tsched_watermark * 2, u->tsched_watermark + u->watermark_inc_step);
300 fix_tsched_watermark(u);
302 if (old_watermark != u->tsched_watermark) {
303 pa_log_info("Increasing wakeup watermark to %0.2f ms",
304 (double) pa_bytes_to_usec(u->tsched_watermark, &u->source->sample_spec) / PA_USEC_PER_MSEC);
308 /* Hmm, we cannot increase the watermark any further, hence let's
309 raise the latency unless doing so was disabled in
311 if (u->fixed_latency_range)
314 old_min_latency = u->source->thread_info.min_latency;
315 new_min_latency = PA_MIN(old_min_latency * 2, old_min_latency + TSCHED_WATERMARK_INC_STEP_USEC);
316 new_min_latency = PA_MIN(new_min_latency, u->source->thread_info.max_latency);
318 if (old_min_latency != new_min_latency) {
319 pa_log_info("Increasing minimal latency to %0.2f ms",
320 (double) new_min_latency / PA_USEC_PER_MSEC);
322 pa_source_set_latency_range_within_thread(u->source, new_min_latency, u->source->thread_info.max_latency);
325 /* When we reach this we're officialy fucked! */
328 static void decrease_watermark(struct userdata *u) {
329 size_t old_watermark;
333 pa_assert(u->use_tsched);
335 now = pa_rtclock_now();
337 if (u->watermark_dec_not_before <= 0)
340 if (u->watermark_dec_not_before > now)
343 old_watermark = u->tsched_watermark;
345 if (u->tsched_watermark < u->watermark_dec_step)
346 u->tsched_watermark = u->tsched_watermark / 2;
348 u->tsched_watermark = PA_MAX(u->tsched_watermark / 2, u->tsched_watermark - u->watermark_dec_step);
350 fix_tsched_watermark(u);
352 if (old_watermark != u->tsched_watermark)
353 pa_log_info("Decreasing wakeup watermark to %0.2f ms",
354 (double) pa_bytes_to_usec(u->tsched_watermark, &u->source->sample_spec) / PA_USEC_PER_MSEC);
356 /* We don't change the latency range*/
359 u->watermark_dec_not_before = now + TSCHED_WATERMARK_VERIFY_AFTER_USEC;
362 static void hw_sleep_time(struct userdata *u, pa_usec_t *sleep_usec, pa_usec_t*process_usec) {
365 pa_assert(sleep_usec);
366 pa_assert(process_usec);
369 pa_assert(u->use_tsched);
371 usec = pa_source_get_requested_latency_within_thread(u->source);
373 if (usec == (pa_usec_t) -1)
374 usec = pa_bytes_to_usec(u->hwbuf_size, &u->source->sample_spec);
376 wm = pa_bytes_to_usec(u->tsched_watermark, &u->source->sample_spec);
381 *sleep_usec = usec - wm;
385 pa_log_debug("Buffer time: %lu ms; Sleep time: %lu ms; Process time: %lu ms",
386 (unsigned long) (usec / PA_USEC_PER_MSEC),
387 (unsigned long) (*sleep_usec / PA_USEC_PER_MSEC),
388 (unsigned long) (*process_usec / PA_USEC_PER_MSEC));
392 static int try_recover(struct userdata *u, const char *call, int err) {
397 pa_log_debug("%s: %s", call, pa_alsa_strerror(err));
399 pa_assert(err != -EAGAIN);
402 pa_log_debug("%s: Buffer overrun!", call);
404 if (err == -ESTRPIPE)
405 pa_log_debug("%s: System suspended!", call);
407 if ((err = snd_pcm_recover(u->pcm_handle, err, 1)) < 0) {
408 pa_log("%s: %s", call, pa_alsa_strerror(err));
416 static size_t check_left_to_record(struct userdata *u, size_t n_bytes, pa_bool_t on_timeout) {
417 size_t left_to_record;
418 size_t rec_space = u->hwbuf_size - u->hwbuf_unused;
419 pa_bool_t overrun = FALSE;
421 /* We use <= instead of < for this check here because an overrun
422 * only happens after the last sample was processed, not already when
423 * it is removed from the buffer. This is particularly important
424 * when block transfer is used. */
426 if (n_bytes <= rec_space)
427 left_to_record = rec_space - n_bytes;
430 /* We got a dropout. What a mess! */
438 if (pa_log_ratelimit(PA_LOG_INFO))
439 pa_log_info("Overrun!");
443 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);
447 pa_bool_t reset_not_before = TRUE;
449 if (overrun || left_to_record < u->watermark_inc_threshold)
450 increase_watermark(u);
451 else if (left_to_record > u->watermark_dec_threshold) {
452 reset_not_before = FALSE;
454 /* We decrease the watermark only if have actually
455 * been woken up by a timeout. If something else woke
456 * us up it's too easy to fulfill the deadlines... */
459 decrease_watermark(u);
462 if (reset_not_before)
463 u->watermark_dec_not_before = 0;
466 return left_to_record;
469 static int mmap_read(struct userdata *u, pa_usec_t *sleep_usec, pa_bool_t polled, pa_bool_t on_timeout) {
470 pa_bool_t work_done = FALSE;
471 pa_usec_t max_sleep_usec = 0, process_usec = 0;
472 size_t left_to_record;
476 pa_source_assert_ref(u->source);
479 hw_sleep_time(u, &max_sleep_usec, &process_usec);
485 pa_bool_t after_avail = TRUE;
487 if (PA_UNLIKELY((n = pa_alsa_safe_avail(u->pcm_handle, u->hwbuf_size, &u->source->sample_spec)) < 0)) {
489 if ((r = try_recover(u, "snd_pcm_avail", (int) n)) == 0)
495 n_bytes = (size_t) n * u->frame_size;
498 pa_log_debug("avail: %lu", (unsigned long) n_bytes);
501 left_to_record = check_left_to_record(u, n_bytes, on_timeout);
506 pa_bytes_to_usec(left_to_record, &u->source->sample_spec) > process_usec+max_sleep_usec/2) {
508 pa_log_debug("Not reading, because too early.");
513 if (PA_UNLIKELY(n_bytes <= 0)) {
517 char *dn = pa_alsa_get_driver_name_by_pcm(u->pcm_handle);
518 pa_log(_("ALSA woke us up to read new data from the device, but there was actually nothing to read!\n"
519 "Most likely this is a bug in the ALSA driver '%s'. Please report this issue to the ALSA developers.\n"
520 "We were woken up with POLLIN set -- however a subsequent snd_pcm_avail() returned 0 or another value < min_avail."),
526 pa_log_debug("Not reading, because not necessary.");
534 pa_log_debug("Not filling up, because already too many iterations.");
543 pa_log_debug("Reading");
550 const snd_pcm_channel_area_t *areas;
551 snd_pcm_uframes_t offset, frames;
552 snd_pcm_sframes_t sframes;
554 frames = (snd_pcm_uframes_t) (n_bytes / u->frame_size);
555 /* pa_log_debug("%lu frames to read", (unsigned long) frames); */
557 if (PA_UNLIKELY((err = pa_alsa_safe_mmap_begin(u->pcm_handle, &areas, &offset, &frames, u->hwbuf_size, &u->source->sample_spec)) < 0)) {
559 if (!after_avail && err == -EAGAIN)
562 if ((r = try_recover(u, "snd_pcm_mmap_begin", err)) == 0)
568 /* Make sure that if these memblocks need to be copied they will fit into one slot */
569 if (frames > pa_mempool_block_size_max(u->core->mempool)/u->frame_size)
570 frames = pa_mempool_block_size_max(u->core->mempool)/u->frame_size;
572 if (!after_avail && frames == 0)
575 pa_assert(frames > 0);
578 /* Check these are multiples of 8 bit */
579 pa_assert((areas[0].first & 7) == 0);
580 pa_assert((areas[0].step & 7)== 0);
582 /* We assume a single interleaved memory buffer */
583 pa_assert((areas[0].first >> 3) == 0);
584 pa_assert((areas[0].step >> 3) == u->frame_size);
586 p = (uint8_t*) areas[0].addr + (offset * u->frame_size);
588 chunk.memblock = pa_memblock_new_fixed(u->core->mempool, p, frames * u->frame_size, TRUE);
589 chunk.length = pa_memblock_get_length(chunk.memblock);
592 pa_source_post(u->source, &chunk);
593 pa_memblock_unref_fixed(chunk.memblock);
595 if (PA_UNLIKELY((sframes = snd_pcm_mmap_commit(u->pcm_handle, offset, frames)) < 0)) {
597 if ((r = try_recover(u, "snd_pcm_mmap_commit", (int) sframes)) == 0)
605 u->read_count += frames * u->frame_size;
608 pa_log_debug("Read %lu bytes (of possible %lu bytes)", (unsigned long) (frames * u->frame_size), (unsigned long) n_bytes);
611 if ((size_t) frames * u->frame_size >= n_bytes)
614 n_bytes -= (size_t) frames * u->frame_size;
619 *sleep_usec = pa_bytes_to_usec(left_to_record, &u->source->sample_spec);
620 process_usec = pa_bytes_to_usec(u->tsched_watermark, &u->source->sample_spec);
622 if (*sleep_usec > process_usec)
623 *sleep_usec -= process_usec;
628 return work_done ? 1 : 0;
631 static int unix_read(struct userdata *u, pa_usec_t *sleep_usec, pa_bool_t polled, pa_bool_t on_timeout) {
632 int work_done = FALSE;
633 pa_usec_t max_sleep_usec = 0, process_usec = 0;
634 size_t left_to_record;
638 pa_source_assert_ref(u->source);
641 hw_sleep_time(u, &max_sleep_usec, &process_usec);
647 pa_bool_t after_avail = TRUE;
649 if (PA_UNLIKELY((n = pa_alsa_safe_avail(u->pcm_handle, u->hwbuf_size, &u->source->sample_spec)) < 0)) {
651 if ((r = try_recover(u, "snd_pcm_avail", (int) n)) == 0)
657 n_bytes = (size_t) n * u->frame_size;
658 left_to_record = check_left_to_record(u, n_bytes, on_timeout);
663 pa_bytes_to_usec(left_to_record, &u->source->sample_spec) > process_usec+max_sleep_usec/2)
666 if (PA_UNLIKELY(n_bytes <= 0)) {
670 char *dn = pa_alsa_get_driver_name_by_pcm(u->pcm_handle);
671 pa_log(_("ALSA woke us up to read new data from the device, but there was actually nothing to read!\n"
672 "Most likely this is a bug in the ALSA driver '%s'. Please report this issue to the ALSA developers.\n"
673 "We were woken up with POLLIN set -- however a subsequent snd_pcm_avail() returned 0 or another value < min_avail."),
683 pa_log_debug("Not filling up, because already too many iterations.");
693 snd_pcm_sframes_t frames;
696 chunk.memblock = pa_memblock_new(u->core->mempool, (size_t) -1);
698 frames = (snd_pcm_sframes_t) (pa_memblock_get_length(chunk.memblock) / u->frame_size);
700 if (frames > (snd_pcm_sframes_t) (n_bytes/u->frame_size))
701 frames = (snd_pcm_sframes_t) (n_bytes/u->frame_size);
703 /* pa_log_debug("%lu frames to read", (unsigned long) n); */
705 p = pa_memblock_acquire(chunk.memblock);
706 frames = snd_pcm_readi(u->pcm_handle, (uint8_t*) p, (snd_pcm_uframes_t) frames);
707 pa_memblock_release(chunk.memblock);
709 if (PA_UNLIKELY(frames < 0)) {
710 pa_memblock_unref(chunk.memblock);
712 if (!after_avail && (int) frames == -EAGAIN)
715 if ((r = try_recover(u, "snd_pcm_readi", (int) frames)) == 0)
721 if (!after_avail && frames == 0) {
722 pa_memblock_unref(chunk.memblock);
726 pa_assert(frames > 0);
730 chunk.length = (size_t) frames * u->frame_size;
732 pa_source_post(u->source, &chunk);
733 pa_memblock_unref(chunk.memblock);
737 u->read_count += frames * u->frame_size;
739 /* pa_log_debug("read %lu frames", (unsigned long) frames); */
741 if ((size_t) frames * u->frame_size >= n_bytes)
744 n_bytes -= (size_t) frames * u->frame_size;
749 *sleep_usec = pa_bytes_to_usec(left_to_record, &u->source->sample_spec);
750 process_usec = pa_bytes_to_usec(u->tsched_watermark, &u->source->sample_spec);
752 if (*sleep_usec > process_usec)
753 *sleep_usec -= process_usec;
758 return work_done ? 1 : 0;
761 static void update_smoother(struct userdata *u) {
762 snd_pcm_sframes_t delay = 0;
765 pa_usec_t now1 = 0, now2;
766 snd_pcm_status_t *status;
768 snd_pcm_status_alloca(&status);
771 pa_assert(u->pcm_handle);
773 /* Let's update the time smoother */
775 if (PA_UNLIKELY((err = pa_alsa_safe_delay(u->pcm_handle, &delay, u->hwbuf_size, &u->source->sample_spec, TRUE)) < 0)) {
776 pa_log_warn("Failed to get delay: %s", pa_alsa_strerror(err));
780 if (PA_UNLIKELY((err = snd_pcm_status(u->pcm_handle, status)) < 0))
781 pa_log_warn("Failed to get timestamp: %s", pa_alsa_strerror(err));
783 snd_htimestamp_t htstamp = { 0, 0 };
784 snd_pcm_status_get_htstamp(status, &htstamp);
785 now1 = pa_timespec_load(&htstamp);
788 /* Hmm, if the timestamp is 0, then it wasn't set and we take the current time */
790 now1 = pa_rtclock_now();
792 /* check if the time since the last update is bigger than the interval */
793 if (u->last_smoother_update > 0)
794 if (u->last_smoother_update + u->smoother_interval > now1)
797 position = u->read_count + ((uint64_t) delay * (uint64_t) u->frame_size);
798 now2 = pa_bytes_to_usec(position, &u->source->sample_spec);
800 pa_smoother_put(u->smoother, now1, now2);
802 u->last_smoother_update = now1;
803 /* exponentially increase the update interval up to the MAX limit */
804 u->smoother_interval = PA_MIN (u->smoother_interval * 2, SMOOTHER_MAX_INTERVAL);
807 static pa_usec_t source_get_latency(struct userdata *u) {
809 pa_usec_t now1, now2;
813 now1 = pa_rtclock_now();
814 now2 = pa_smoother_get(u->smoother, now1);
816 delay = (int64_t) now2 - (int64_t) pa_bytes_to_usec(u->read_count, &u->source->sample_spec);
818 return delay >= 0 ? (pa_usec_t) delay : 0;
821 static int build_pollfd(struct userdata *u) {
823 pa_assert(u->pcm_handle);
825 if (u->alsa_rtpoll_item)
826 pa_rtpoll_item_free(u->alsa_rtpoll_item);
828 if (!(u->alsa_rtpoll_item = pa_alsa_build_pollfd(u->pcm_handle, u->rtpoll)))
834 /* Called from IO context */
835 static int suspend(struct userdata *u) {
837 pa_assert(u->pcm_handle);
839 pa_smoother_pause(u->smoother, pa_rtclock_now());
842 snd_pcm_close(u->pcm_handle);
843 u->pcm_handle = NULL;
845 if (u->alsa_rtpoll_item) {
846 pa_rtpoll_item_free(u->alsa_rtpoll_item);
847 u->alsa_rtpoll_item = NULL;
850 pa_log_info("Device suspended...");
855 /* Called from IO context */
856 static int update_sw_params(struct userdata *u) {
857 snd_pcm_uframes_t avail_min;
862 /* Use the full buffer if no one asked us for anything specific */
868 if ((latency = pa_source_get_requested_latency_within_thread(u->source)) != (pa_usec_t) -1) {
871 pa_log_debug("latency set to %0.2fms", (double) latency / PA_USEC_PER_MSEC);
873 b = pa_usec_to_bytes(latency, &u->source->sample_spec);
875 /* We need at least one sample in our buffer */
877 if (PA_UNLIKELY(b < u->frame_size))
880 u->hwbuf_unused = PA_LIKELY(b < u->hwbuf_size) ? (u->hwbuf_size - b) : 0;
883 fix_min_sleep_wakeup(u);
884 fix_tsched_watermark(u);
887 pa_log_debug("hwbuf_unused=%lu", (unsigned long) u->hwbuf_unused);
892 pa_usec_t sleep_usec, process_usec;
894 hw_sleep_time(u, &sleep_usec, &process_usec);
895 avail_min += pa_usec_to_bytes(sleep_usec, &u->source->sample_spec) / u->frame_size;
898 pa_log_debug("setting avail_min=%lu", (unsigned long) avail_min);
900 if ((err = pa_alsa_set_sw_params(u->pcm_handle, avail_min, !u->use_tsched)) < 0) {
901 pa_log("Failed to set software parameters: %s", pa_alsa_strerror(err));
908 /* Called from IO Context on unsuspend or from main thread when creating source */
909 static void reset_watermark(struct userdata *u, size_t tsched_watermark, pa_sample_spec *ss,
912 u->tsched_watermark = pa_usec_to_bytes_round_up(pa_bytes_to_usec_round_up(tsched_watermark, ss),
913 &u->source->sample_spec);
915 u->watermark_inc_step = pa_usec_to_bytes(TSCHED_WATERMARK_INC_STEP_USEC, &u->source->sample_spec);
916 u->watermark_dec_step = pa_usec_to_bytes(TSCHED_WATERMARK_DEC_STEP_USEC, &u->source->sample_spec);
918 u->watermark_inc_threshold = pa_usec_to_bytes_round_up(TSCHED_WATERMARK_INC_THRESHOLD_USEC, &u->source->sample_spec);
919 u->watermark_dec_threshold = pa_usec_to_bytes_round_up(TSCHED_WATERMARK_DEC_THRESHOLD_USEC, &u->source->sample_spec);
921 fix_min_sleep_wakeup(u);
922 fix_tsched_watermark(u);
925 pa_source_set_latency_range_within_thread(u->source,
927 pa_bytes_to_usec(u->hwbuf_size, ss));
929 pa_source_set_latency_range(u->source,
931 pa_bytes_to_usec(u->hwbuf_size, ss));
933 /* work-around assert in pa_source_set_latency_within_thead,
934 keep track of min_latency and reuse it when
935 this routine is called from IO context */
936 u->min_latency_ref = u->source->thread_info.min_latency;
939 pa_log_info("Time scheduling watermark is %0.2fms",
940 (double) pa_bytes_to_usec(u->tsched_watermark, ss) / PA_USEC_PER_MSEC);
943 /* Called from IO context */
944 static int unsuspend(struct userdata *u) {
948 snd_pcm_uframes_t period_size, buffer_size;
951 pa_assert(!u->pcm_handle);
953 pa_log_info("Trying resume...");
955 if ((err = snd_pcm_open(&u->pcm_handle, u->device_name, SND_PCM_STREAM_CAPTURE,
957 SND_PCM_NO_AUTO_RESAMPLE|
958 SND_PCM_NO_AUTO_CHANNELS|
959 SND_PCM_NO_AUTO_FORMAT)) < 0) {
960 pa_log("Error opening PCM device %s: %s", u->device_name, pa_alsa_strerror(err));
964 ss = u->source->sample_spec;
965 period_size = u->fragment_size / u->frame_size;
966 buffer_size = u->hwbuf_size / u->frame_size;
970 if ((err = pa_alsa_set_hw_params(u->pcm_handle, &ss, &period_size, &buffer_size, 0, &b, &d, TRUE)) < 0) {
971 pa_log("Failed to set hardware parameters: %s", pa_alsa_strerror(err));
975 if (b != u->use_mmap || d != u->use_tsched) {
976 pa_log_warn("Resume failed, couldn't get original access mode.");
980 if (!pa_sample_spec_equal(&ss, &u->source->sample_spec)) {
981 pa_log_warn("Resume failed, couldn't restore original sample settings.");
985 if (period_size*u->frame_size != u->fragment_size ||
986 buffer_size*u->frame_size != u->hwbuf_size) {
987 pa_log_warn("Resume failed, couldn't restore original fragment settings. (Old: %lu/%lu, New %lu/%lu)",
988 (unsigned long) u->hwbuf_size, (unsigned long) u->fragment_size,
989 (unsigned long) (buffer_size*u->frame_size), (unsigned long) (period_size*u->frame_size));
993 if (update_sw_params(u) < 0)
996 if (build_pollfd(u) < 0)
999 /* FIXME: We need to reload the volume somehow */
1002 pa_smoother_reset(u->smoother, pa_rtclock_now(), TRUE);
1003 u->smoother_interval = SMOOTHER_MIN_INTERVAL;
1004 u->last_smoother_update = 0;
1008 /* reset the watermark to the value defined when source was created */
1010 reset_watermark(u, u->tsched_watermark_ref, &u->source->sample_spec, TRUE);
1012 pa_log_info("Resumed successfully...");
1017 if (u->pcm_handle) {
1018 snd_pcm_close(u->pcm_handle);
1019 u->pcm_handle = NULL;
1025 /* Called from IO context */
1026 static int source_process_msg(pa_msgobject *o, int code, void *data, int64_t offset, pa_memchunk *chunk) {
1027 struct userdata *u = PA_SOURCE(o)->userdata;
1031 case PA_SOURCE_MESSAGE_GET_LATENCY: {
1035 r = source_get_latency(u);
1037 *((pa_usec_t*) data) = r;
1042 case PA_SOURCE_MESSAGE_SET_STATE:
1044 switch ((pa_source_state_t) PA_PTR_TO_UINT(data)) {
1046 case PA_SOURCE_SUSPENDED: {
1049 pa_assert(PA_SOURCE_IS_OPENED(u->source->thread_info.state));
1051 if ((r = suspend(u)) < 0)
1057 case PA_SOURCE_IDLE:
1058 case PA_SOURCE_RUNNING: {
1061 if (u->source->thread_info.state == PA_SOURCE_INIT) {
1062 if (build_pollfd(u) < 0)
1066 if (u->source->thread_info.state == PA_SOURCE_SUSPENDED) {
1067 if ((r = unsuspend(u)) < 0)
1074 case PA_SOURCE_UNLINKED:
1075 case PA_SOURCE_INIT:
1076 case PA_SOURCE_INVALID_STATE:
1083 return pa_source_process_msg(o, code, data, offset, chunk);
1086 /* Called from main context */
1087 static int source_set_state_cb(pa_source *s, pa_source_state_t new_state) {
1088 pa_source_state_t old_state;
1091 pa_source_assert_ref(s);
1092 pa_assert_se(u = s->userdata);
1094 old_state = pa_source_get_state(u->source);
1096 if (PA_SOURCE_IS_OPENED(old_state) && new_state == PA_SOURCE_SUSPENDED)
1098 else if (old_state == PA_SOURCE_SUSPENDED && PA_SOURCE_IS_OPENED(new_state))
1099 if (reserve_init(u, u->device_name) < 0)
1100 return -PA_ERR_BUSY;
1105 static int ctl_mixer_callback(snd_mixer_elem_t *elem, unsigned int mask) {
1106 struct userdata *u = snd_mixer_elem_get_callback_private(elem);
1109 pa_assert(u->mixer_handle);
1111 if (mask == SND_CTL_EVENT_MASK_REMOVE)
1114 if (!PA_SOURCE_IS_LINKED(u->source->state))
1117 if (u->source->suspend_cause & PA_SUSPEND_SESSION) {
1118 pa_source_set_mixer_dirty(u->source, TRUE);
1122 if (mask & SND_CTL_EVENT_MASK_VALUE) {
1123 pa_source_get_volume(u->source, TRUE);
1124 pa_source_get_mute(u->source, TRUE);
1130 static int io_mixer_callback(snd_mixer_elem_t *elem, unsigned int mask) {
1131 struct userdata *u = snd_mixer_elem_get_callback_private(elem);
1134 pa_assert(u->mixer_handle);
1136 if (mask == SND_CTL_EVENT_MASK_REMOVE)
1139 if (u->source->suspend_cause & PA_SUSPEND_SESSION) {
1140 pa_source_set_mixer_dirty(u->source, TRUE);
1144 if (mask & SND_CTL_EVENT_MASK_VALUE)
1145 pa_source_update_volume_and_mute(u->source);
1150 static void source_get_volume_cb(pa_source *s) {
1151 struct userdata *u = s->userdata;
1153 char vol_str_pcnt[PA_CVOLUME_SNPRINT_MAX];
1156 pa_assert(u->mixer_path);
1157 pa_assert(u->mixer_handle);
1159 if (pa_alsa_path_get_volume(u->mixer_path, u->mixer_handle, &s->channel_map, &r) < 0)
1162 /* Shift down by the base volume, so that 0dB becomes maximum volume */
1163 pa_sw_cvolume_multiply_scalar(&r, &r, s->base_volume);
1165 pa_log_debug("Read hardware volume: %s", pa_cvolume_snprint(vol_str_pcnt, sizeof(vol_str_pcnt), &r));
1167 if (u->mixer_path->has_dB) {
1168 char vol_str_db[PA_SW_CVOLUME_SNPRINT_DB_MAX];
1170 pa_log_debug(" in dB: %s", pa_sw_cvolume_snprint_dB(vol_str_db, sizeof(vol_str_db), &r));
1173 if (pa_cvolume_equal(&u->hardware_volume, &r))
1176 s->real_volume = u->hardware_volume = r;
1178 /* Hmm, so the hardware volume changed, let's reset our software volume */
1179 if (u->mixer_path->has_dB)
1180 pa_source_set_soft_volume(s, NULL);
1183 static void source_set_volume_cb(pa_source *s) {
1184 struct userdata *u = s->userdata;
1186 char vol_str_pcnt[PA_CVOLUME_SNPRINT_MAX];
1187 pa_bool_t deferred_volume = !!(s->flags & PA_SOURCE_DEFERRED_VOLUME);
1190 pa_assert(u->mixer_path);
1191 pa_assert(u->mixer_handle);
1193 /* Shift up by the base volume */
1194 pa_sw_cvolume_divide_scalar(&r, &s->real_volume, s->base_volume);
1196 if (pa_alsa_path_set_volume(u->mixer_path, u->mixer_handle, &s->channel_map, &r, deferred_volume, !deferred_volume) < 0)
1199 /* Shift down by the base volume, so that 0dB becomes maximum volume */
1200 pa_sw_cvolume_multiply_scalar(&r, &r, s->base_volume);
1202 u->hardware_volume = r;
1204 if (u->mixer_path->has_dB) {
1205 pa_cvolume new_soft_volume;
1206 pa_bool_t accurate_enough;
1207 char vol_str_db[PA_SW_CVOLUME_SNPRINT_DB_MAX];
1209 /* Match exactly what the user requested by software */
1210 pa_sw_cvolume_divide(&new_soft_volume, &s->real_volume, &u->hardware_volume);
1212 /* If the adjustment to do in software is only minimal we
1213 * can skip it. That saves us CPU at the expense of a bit of
1216 (pa_cvolume_min(&new_soft_volume) >= (PA_VOLUME_NORM - VOLUME_ACCURACY)) &&
1217 (pa_cvolume_max(&new_soft_volume) <= (PA_VOLUME_NORM + VOLUME_ACCURACY));
1219 pa_log_debug("Requested volume: %s", pa_cvolume_snprint(vol_str_pcnt, sizeof(vol_str_pcnt), &s->real_volume));
1220 pa_log_debug(" in dB: %s", pa_sw_cvolume_snprint_dB(vol_str_db, sizeof(vol_str_db), &s->real_volume));
1221 pa_log_debug("Got hardware volume: %s", pa_cvolume_snprint(vol_str_pcnt, sizeof(vol_str_pcnt), &u->hardware_volume));
1222 pa_log_debug(" in dB: %s", pa_sw_cvolume_snprint_dB(vol_str_db, sizeof(vol_str_db), &u->hardware_volume));
1223 pa_log_debug("Calculated software volume: %s (accurate-enough=%s)",
1224 pa_cvolume_snprint(vol_str_pcnt, sizeof(vol_str_pcnt), &new_soft_volume),
1225 pa_yes_no(accurate_enough));
1226 pa_log_debug(" in dB: %s", pa_sw_cvolume_snprint_dB(vol_str_db, sizeof(vol_str_db), &new_soft_volume));
1228 if (!accurate_enough)
1229 s->soft_volume = new_soft_volume;
1232 pa_log_debug("Wrote hardware volume: %s", pa_cvolume_snprint(vol_str_pcnt, sizeof(vol_str_pcnt), &r));
1234 /* We can't match exactly what the user requested, hence let's
1235 * at least tell the user about it */
1241 static void source_write_volume_cb(pa_source *s) {
1242 struct userdata *u = s->userdata;
1243 pa_cvolume hw_vol = s->thread_info.current_hw_volume;
1246 pa_assert(u->mixer_path);
1247 pa_assert(u->mixer_handle);
1248 pa_assert(s->flags & PA_SOURCE_DEFERRED_VOLUME);
1250 /* Shift up by the base volume */
1251 pa_sw_cvolume_divide_scalar(&hw_vol, &hw_vol, s->base_volume);
1253 if (pa_alsa_path_set_volume(u->mixer_path, u->mixer_handle, &s->channel_map, &hw_vol, TRUE, TRUE) < 0)
1254 pa_log_error("Writing HW volume failed");
1257 pa_bool_t accurate_enough;
1259 /* Shift down by the base volume, so that 0dB becomes maximum volume */
1260 pa_sw_cvolume_multiply_scalar(&hw_vol, &hw_vol, s->base_volume);
1262 pa_sw_cvolume_divide(&tmp_vol, &hw_vol, &s->thread_info.current_hw_volume);
1264 (pa_cvolume_min(&tmp_vol) >= (PA_VOLUME_NORM - VOLUME_ACCURACY)) &&
1265 (pa_cvolume_max(&tmp_vol) <= (PA_VOLUME_NORM + VOLUME_ACCURACY));
1267 if (!accurate_enough) {
1269 char db[2][PA_SW_CVOLUME_SNPRINT_DB_MAX];
1270 char pcnt[2][PA_CVOLUME_SNPRINT_MAX];
1273 pa_log_debug("Written HW volume did not match with the request: %s (request) != %s",
1274 pa_cvolume_snprint(vol.pcnt[0], sizeof(vol.pcnt[0]), &s->thread_info.current_hw_volume),
1275 pa_cvolume_snprint(vol.pcnt[1], sizeof(vol.pcnt[1]), &hw_vol));
1276 pa_log_debug(" in dB: %s (request) != %s",
1277 pa_sw_cvolume_snprint_dB(vol.db[0], sizeof(vol.db[0]), &s->thread_info.current_hw_volume),
1278 pa_sw_cvolume_snprint_dB(vol.db[1], sizeof(vol.db[1]), &hw_vol));
1283 static void source_get_mute_cb(pa_source *s) {
1284 struct userdata *u = s->userdata;
1288 pa_assert(u->mixer_path);
1289 pa_assert(u->mixer_handle);
1291 if (pa_alsa_path_get_mute(u->mixer_path, u->mixer_handle, &b) < 0)
1297 static void source_set_mute_cb(pa_source *s) {
1298 struct userdata *u = s->userdata;
1301 pa_assert(u->mixer_path);
1302 pa_assert(u->mixer_handle);
1304 pa_alsa_path_set_mute(u->mixer_path, u->mixer_handle, s->muted);
1307 static void mixer_volume_init(struct userdata *u) {
1310 if (!u->mixer_path->has_volume) {
1311 pa_source_set_write_volume_callback(u->source, NULL);
1312 pa_source_set_get_volume_callback(u->source, NULL);
1313 pa_source_set_set_volume_callback(u->source, NULL);
1315 pa_log_info("Driver does not support hardware volume control, falling back to software volume control.");
1317 pa_source_set_get_volume_callback(u->source, source_get_volume_cb);
1318 pa_source_set_set_volume_callback(u->source, source_set_volume_cb);
1320 if (u->mixer_path->has_dB && u->deferred_volume) {
1321 pa_source_set_write_volume_callback(u->source, source_write_volume_cb);
1322 pa_log_info("Successfully enabled deferred volume.");
1324 pa_source_set_write_volume_callback(u->source, NULL);
1326 if (u->mixer_path->has_dB) {
1327 pa_source_enable_decibel_volume(u->source, TRUE);
1328 pa_log_info("Hardware volume ranges from %0.2f dB to %0.2f dB.", u->mixer_path->min_dB, u->mixer_path->max_dB);
1330 u->source->base_volume = pa_sw_volume_from_dB(-u->mixer_path->max_dB);
1331 u->source->n_volume_steps = PA_VOLUME_NORM+1;
1333 pa_log_info("Fixing base volume to %0.2f dB", pa_sw_volume_to_dB(u->source->base_volume));
1335 pa_source_enable_decibel_volume(u->source, FALSE);
1336 pa_log_info("Hardware volume ranges from %li to %li.", u->mixer_path->min_volume, u->mixer_path->max_volume);
1338 u->source->base_volume = PA_VOLUME_NORM;
1339 u->source->n_volume_steps = u->mixer_path->max_volume - u->mixer_path->min_volume + 1;
1342 pa_log_info("Using hardware volume control. Hardware dB scale %s.", u->mixer_path->has_dB ? "supported" : "not supported");
1345 if (!u->mixer_path->has_mute) {
1346 pa_source_set_get_mute_callback(u->source, NULL);
1347 pa_source_set_set_mute_callback(u->source, NULL);
1348 pa_log_info("Driver does not support hardware mute control, falling back to software mute control.");
1350 pa_source_set_get_mute_callback(u->source, source_get_mute_cb);
1351 pa_source_set_set_mute_callback(u->source, source_set_mute_cb);
1352 pa_log_info("Using hardware mute control.");
1356 static int source_set_port_cb(pa_source *s, pa_device_port *p) {
1357 struct userdata *u = s->userdata;
1358 pa_alsa_port_data *data;
1362 pa_assert(u->mixer_handle);
1364 data = PA_DEVICE_PORT_DATA(p);
1366 pa_assert_se(u->mixer_path = data->path);
1367 pa_alsa_path_select(u->mixer_path, data->setting, u->mixer_handle, s->muted);
1369 mixer_volume_init(u);
1373 if (s->flags & PA_SOURCE_DEFERRED_VOLUME) {
1374 if (s->write_volume)
1384 static void source_update_requested_latency_cb(pa_source *s) {
1385 struct userdata *u = s->userdata;
1387 pa_assert(u->use_tsched); /* only when timer scheduling is used
1388 * we can dynamically adjust the
1394 update_sw_params(u);
1397 static pa_bool_t source_update_rate_cb(pa_source *s, uint32_t rate)
1399 struct userdata *u = s->userdata;
1401 pa_bool_t supported = FALSE;
1405 for (i = 0; u->rates[i]; i++) {
1406 if (u->rates[i] == rate) {
1413 pa_log_info("Sink does not support sample rate of %d Hz", rate);
1417 if (!PA_SOURCE_IS_OPENED(s->state)) {
1418 pa_log_info("Updating rate for device %s, new rate is %d", u->device_name, rate);
1419 u->source->sample_spec.rate = rate;
1426 static void thread_func(void *userdata) {
1427 struct userdata *u = userdata;
1428 unsigned short revents = 0;
1432 pa_log_debug("Thread starting up");
1434 if (u->core->realtime_scheduling)
1435 pa_make_realtime(u->core->realtime_priority);
1437 pa_thread_mq_install(&u->thread_mq);
1441 pa_usec_t rtpoll_sleep = 0;
1444 pa_log_debug("Loop");
1447 /* Read some data and pass it to the sources */
1448 if (PA_SOURCE_IS_OPENED(u->source->thread_info.state)) {
1450 pa_usec_t sleep_usec = 0;
1451 pa_bool_t on_timeout = pa_rtpoll_timer_elapsed(u->rtpoll);
1454 pa_log_info("Starting capture.");
1455 snd_pcm_start(u->pcm_handle);
1457 pa_smoother_resume(u->smoother, pa_rtclock_now(), TRUE);
1463 work_done = mmap_read(u, &sleep_usec, revents & POLLIN, on_timeout);
1465 work_done = unix_read(u, &sleep_usec, revents & POLLIN, on_timeout);
1470 /* pa_log_debug("work_done = %i", work_done); */
1475 if (u->use_tsched) {
1478 /* OK, the capture buffer is now empty, let's
1479 * calculate when to wake up next */
1481 /* pa_log_debug("Waking up in %0.2fms (sound card clock).", (double) sleep_usec / PA_USEC_PER_MSEC); */
1483 /* Convert from the sound card time domain to the
1484 * system time domain */
1485 cusec = pa_smoother_translate(u->smoother, pa_rtclock_now(), sleep_usec);
1487 /* pa_log_debug("Waking up in %0.2fms (system clock).", (double) cusec / PA_USEC_PER_MSEC); */
1489 /* We don't trust the conversion, so we wake up whatever comes first */
1490 rtpoll_sleep = PA_MIN(sleep_usec, cusec);
1494 if (u->source->flags & PA_SOURCE_DEFERRED_VOLUME) {
1495 pa_usec_t volume_sleep;
1496 pa_source_volume_change_apply(u->source, &volume_sleep);
1497 if (volume_sleep > 0) {
1498 if (rtpoll_sleep > 0)
1499 rtpoll_sleep = PA_MIN(volume_sleep, rtpoll_sleep);
1501 rtpoll_sleep = volume_sleep;
1505 if (rtpoll_sleep > 0)
1506 pa_rtpoll_set_timer_relative(u->rtpoll, rtpoll_sleep);
1508 pa_rtpoll_set_timer_disabled(u->rtpoll);
1510 /* Hmm, nothing to do. Let's sleep */
1511 if ((ret = pa_rtpoll_run(u->rtpoll, TRUE)) < 0)
1514 if (u->source->flags & PA_SOURCE_DEFERRED_VOLUME)
1515 pa_source_volume_change_apply(u->source, NULL);
1520 /* Tell ALSA about this and process its response */
1521 if (PA_SOURCE_IS_OPENED(u->source->thread_info.state)) {
1522 struct pollfd *pollfd;
1526 pollfd = pa_rtpoll_item_get_pollfd(u->alsa_rtpoll_item, &n);
1528 if ((err = snd_pcm_poll_descriptors_revents(u->pcm_handle, pollfd, n, &revents)) < 0) {
1529 pa_log("snd_pcm_poll_descriptors_revents() failed: %s", pa_alsa_strerror(err));
1533 if (revents & ~POLLIN) {
1534 if (pa_alsa_recover_from_poll(u->pcm_handle, revents) < 0)
1539 } else if (revents && u->use_tsched && pa_log_ratelimit(PA_LOG_DEBUG))
1540 pa_log_debug("Wakeup from ALSA!");
1547 /* If this was no regular exit from the loop we have to continue
1548 * processing messages until we received PA_MESSAGE_SHUTDOWN */
1549 pa_asyncmsgq_post(u->thread_mq.outq, PA_MSGOBJECT(u->core), PA_CORE_MESSAGE_UNLOAD_MODULE, u->module, 0, NULL, NULL);
1550 pa_asyncmsgq_wait_for(u->thread_mq.inq, PA_MESSAGE_SHUTDOWN);
1553 pa_log_debug("Thread shutting down");
1556 static void set_source_name(pa_source_new_data *data, pa_modargs *ma, const char *device_id, const char *device_name, pa_alsa_mapping *mapping) {
1562 pa_assert(device_name);
1564 if ((n = pa_modargs_get_value(ma, "source_name", NULL))) {
1565 pa_source_new_data_set_name(data, n);
1566 data->namereg_fail = TRUE;
1570 if ((n = pa_modargs_get_value(ma, "name", NULL)))
1571 data->namereg_fail = TRUE;
1573 n = device_id ? device_id : device_name;
1574 data->namereg_fail = FALSE;
1578 t = pa_sprintf_malloc("alsa_input.%s.%s", n, mapping->name);
1580 t = pa_sprintf_malloc("alsa_input.%s", n);
1582 pa_source_new_data_set_name(data, t);
1586 static void find_mixer(struct userdata *u, pa_alsa_mapping *mapping, const char *element, pa_bool_t ignore_dB) {
1589 if (!mapping && !element)
1592 if (!(u->mixer_handle = pa_alsa_open_mixer_for_pcm(u->pcm_handle, &u->control_device, &hctl))) {
1593 pa_log_info("Failed to find a working mixer device.");
1599 if (!(u->mixer_path = pa_alsa_path_synthesize(element, PA_ALSA_DIRECTION_INPUT)))
1602 if (pa_alsa_path_probe(u->mixer_path, u->mixer_handle, hctl, ignore_dB) < 0)
1605 pa_log_debug("Probed mixer path %s:", u->mixer_path->name);
1606 pa_alsa_path_dump(u->mixer_path);
1607 } else if (!(u->mixer_path_set = mapping->input_path_set))
1614 if (u->mixer_path) {
1615 pa_alsa_path_free(u->mixer_path);
1616 u->mixer_path = NULL;
1619 if (u->mixer_handle) {
1620 snd_mixer_close(u->mixer_handle);
1621 u->mixer_handle = NULL;
1625 static int setup_mixer(struct userdata *u, pa_bool_t ignore_dB) {
1626 pa_bool_t need_mixer_callback = FALSE;
1630 if (!u->mixer_handle)
1633 if (u->source->active_port) {
1634 pa_alsa_port_data *data;
1636 /* We have a list of supported paths, so let's activate the
1637 * one that has been chosen as active */
1639 data = PA_DEVICE_PORT_DATA(u->source->active_port);
1640 u->mixer_path = data->path;
1642 pa_alsa_path_select(data->path, data->setting, u->mixer_handle, u->source->muted);
1646 if (!u->mixer_path && u->mixer_path_set)
1647 u->mixer_path = pa_hashmap_first(u->mixer_path_set->paths);
1649 if (u->mixer_path) {
1650 /* Hmm, we have only a single path, then let's activate it */
1652 pa_alsa_path_select(u->mixer_path, u->mixer_path->settings, u->mixer_handle, u->source->muted);
1657 mixer_volume_init(u);
1659 /* Will we need to register callbacks? */
1660 if (u->mixer_path_set && u->mixer_path_set->paths) {
1664 PA_HASHMAP_FOREACH(p, u->mixer_path_set->paths, state) {
1665 if (p->has_volume || p->has_mute)
1666 need_mixer_callback = TRUE;
1669 else if (u->mixer_path)
1670 need_mixer_callback = u->mixer_path->has_volume || u->mixer_path->has_mute;
1672 if (need_mixer_callback) {
1673 int (*mixer_callback)(snd_mixer_elem_t *, unsigned int);
1674 if (u->source->flags & PA_SOURCE_DEFERRED_VOLUME) {
1675 u->mixer_pd = pa_alsa_mixer_pdata_new();
1676 mixer_callback = io_mixer_callback;
1678 if (pa_alsa_set_mixer_rtpoll(u->mixer_pd, u->mixer_handle, u->rtpoll) < 0) {
1679 pa_log("Failed to initialize file descriptor monitoring");
1683 u->mixer_fdl = pa_alsa_fdlist_new();
1684 mixer_callback = ctl_mixer_callback;
1686 if (pa_alsa_fdlist_set_handle(u->mixer_fdl, u->mixer_handle, NULL, u->core->mainloop) < 0) {
1687 pa_log("Failed to initialize file descriptor monitoring");
1692 if (u->mixer_path_set)
1693 pa_alsa_path_set_set_callback(u->mixer_path_set, u->mixer_handle, mixer_callback, u);
1695 pa_alsa_path_set_callback(u->mixer_path, u->mixer_handle, mixer_callback, u);
1701 pa_source *pa_alsa_source_new(pa_module *m, pa_modargs *ma, const char*driver, pa_card *card, pa_alsa_mapping *mapping) {
1703 struct userdata *u = NULL;
1704 const char *dev_id = NULL;
1706 uint32_t alternate_sample_rate;
1708 uint32_t nfrags, frag_size, buffer_size, tsched_size, tsched_watermark;
1709 snd_pcm_uframes_t period_frames, buffer_frames, tsched_frames;
1711 pa_bool_t use_mmap = TRUE, b, use_tsched = TRUE, d, ignore_dB = FALSE, namereg_fail = FALSE, deferred_volume = FALSE, fixed_latency_range = FALSE;
1712 pa_source_new_data data;
1713 pa_alsa_profile_set *profile_set = NULL;
1718 ss = m->core->default_sample_spec;
1719 map = m->core->default_channel_map;
1720 if (pa_modargs_get_sample_spec_and_channel_map(ma, &ss, &map, PA_CHANNEL_MAP_ALSA) < 0) {
1721 pa_log("Failed to parse sample specification and channel map");
1725 alternate_sample_rate = m->core->alternate_sample_rate;
1726 if (pa_modargs_get_alternate_sample_rate(ma, &alternate_sample_rate) < 0) {
1727 pa_log("Failed to parse alternate sample rate");
1731 frame_size = pa_frame_size(&ss);
1733 nfrags = m->core->default_n_fragments;
1734 frag_size = (uint32_t) pa_usec_to_bytes(m->core->default_fragment_size_msec*PA_USEC_PER_MSEC, &ss);
1736 frag_size = (uint32_t) frame_size;
1737 tsched_size = (uint32_t) pa_usec_to_bytes(DEFAULT_TSCHED_BUFFER_USEC, &ss);
1738 tsched_watermark = (uint32_t) pa_usec_to_bytes(DEFAULT_TSCHED_WATERMARK_USEC, &ss);
1740 if (pa_modargs_get_value_u32(ma, "fragments", &nfrags) < 0 ||
1741 pa_modargs_get_value_u32(ma, "fragment_size", &frag_size) < 0 ||
1742 pa_modargs_get_value_u32(ma, "tsched_buffer_size", &tsched_size) < 0 ||
1743 pa_modargs_get_value_u32(ma, "tsched_buffer_watermark", &tsched_watermark) < 0) {
1744 pa_log("Failed to parse buffer metrics");
1748 buffer_size = nfrags * frag_size;
1750 period_frames = frag_size/frame_size;
1751 buffer_frames = buffer_size/frame_size;
1752 tsched_frames = tsched_size/frame_size;
1754 if (pa_modargs_get_value_boolean(ma, "mmap", &use_mmap) < 0) {
1755 pa_log("Failed to parse mmap argument.");
1759 if (pa_modargs_get_value_boolean(ma, "tsched", &use_tsched) < 0) {
1760 pa_log("Failed to parse tsched argument.");
1764 if (pa_modargs_get_value_boolean(ma, "ignore_dB", &ignore_dB) < 0) {
1765 pa_log("Failed to parse ignore_dB argument.");
1769 deferred_volume = m->core->deferred_volume;
1770 if (pa_modargs_get_value_boolean(ma, "deferred_volume", &deferred_volume) < 0) {
1771 pa_log("Failed to parse deferred_volume argument.");
1775 if (pa_modargs_get_value_boolean(ma, "fixed_latency_range", &fixed_latency_range) < 0) {
1776 pa_log("Failed to parse fixed_latency_range argument.");
1780 use_tsched = pa_alsa_may_tsched(use_tsched);
1782 u = pa_xnew0(struct userdata, 1);
1785 u->use_mmap = use_mmap;
1786 u->use_tsched = use_tsched;
1787 u->deferred_volume = deferred_volume;
1788 u->fixed_latency_range = fixed_latency_range;
1790 u->rtpoll = pa_rtpoll_new();
1791 pa_thread_mq_init(&u->thread_mq, m->core->mainloop, u->rtpoll);
1793 u->smoother = pa_smoother_new(
1794 SMOOTHER_ADJUST_USEC,
1795 SMOOTHER_WINDOW_USEC,
1801 u->smoother_interval = SMOOTHER_MIN_INTERVAL;
1803 dev_id = pa_modargs_get_value(
1805 pa_modargs_get_value(ma, "device", DEFAULT_DEVICE));
1807 u->paths_dir = pa_xstrdup(pa_modargs_get_value(ma, "paths_dir", NULL));
1809 if (reserve_init(u, dev_id) < 0)
1812 if (reserve_monitor_init(u, dev_id) < 0)
1820 if (!(dev_id = pa_modargs_get_value(ma, "device_id", NULL))) {
1821 pa_log("device_id= not set");
1825 if (!(u->pcm_handle = pa_alsa_open_by_device_id_mapping(
1829 SND_PCM_STREAM_CAPTURE,
1830 &period_frames, &buffer_frames, tsched_frames,
1834 } else if ((dev_id = pa_modargs_get_value(ma, "device_id", NULL))) {
1836 if (!(profile_set = pa_alsa_profile_set_new(NULL, &map)))
1839 if (!(u->pcm_handle = pa_alsa_open_by_device_id_auto(
1843 SND_PCM_STREAM_CAPTURE,
1844 &period_frames, &buffer_frames, tsched_frames,
1845 &b, &d, profile_set, &mapping)))
1850 if (!(u->pcm_handle = pa_alsa_open_by_device_string(
1851 pa_modargs_get_value(ma, "device", DEFAULT_DEVICE),
1854 SND_PCM_STREAM_CAPTURE,
1855 &period_frames, &buffer_frames, tsched_frames,
1860 pa_assert(u->device_name);
1861 pa_log_info("Successfully opened device %s.", u->device_name);
1863 if (pa_alsa_pcm_is_modem(u->pcm_handle)) {
1864 pa_log_notice("Device %s is modem, refusing further initialization.", u->device_name);
1869 pa_log_info("Selected mapping '%s' (%s).", mapping->description, mapping->name);
1871 if (use_mmap && !b) {
1872 pa_log_info("Device doesn't support mmap(), falling back to UNIX read/write mode.");
1873 u->use_mmap = use_mmap = FALSE;
1876 if (use_tsched && (!b || !d)) {
1877 pa_log_info("Cannot enable timer-based scheduling, falling back to sound IRQ scheduling.");
1878 u->use_tsched = use_tsched = FALSE;
1882 pa_log_info("Successfully enabled mmap() mode.");
1884 if (u->use_tsched) {
1885 pa_log_info("Successfully enabled timer-based scheduling mode.");
1886 if (u->fixed_latency_range)
1887 pa_log_info("Disabling latency range changes on overrun");
1890 u->rates = pa_alsa_get_supported_rates(u->pcm_handle);
1892 pa_log_error("Failed to find any supported sample rates.");
1896 /* ALSA might tweak the sample spec, so recalculate the frame size */
1897 frame_size = pa_frame_size(&ss);
1899 find_mixer(u, mapping, pa_modargs_get_value(ma, "control", NULL), ignore_dB);
1901 pa_source_new_data_init(&data);
1902 data.driver = driver;
1905 set_source_name(&data, ma, dev_id, u->device_name, mapping);
1907 /* We need to give pa_modargs_get_value_boolean() a pointer to a local
1908 * variable instead of using &data.namereg_fail directly, because
1909 * data.namereg_fail is a bitfield and taking the address of a bitfield
1910 * variable is impossible. */
1911 namereg_fail = data.namereg_fail;
1912 if (pa_modargs_get_value_boolean(ma, "namereg_fail", &namereg_fail) < 0) {
1913 pa_log("Failed to parse namereg_fail argument.");
1914 pa_source_new_data_done(&data);
1917 data.namereg_fail = namereg_fail;
1919 pa_source_new_data_set_sample_spec(&data, &ss);
1920 pa_source_new_data_set_channel_map(&data, &map);
1921 pa_source_new_data_set_alternate_sample_rate(&data, alternate_sample_rate);
1923 pa_alsa_init_proplist_pcm(m->core, data.proplist, u->pcm_handle);
1924 pa_proplist_sets(data.proplist, PA_PROP_DEVICE_STRING, u->device_name);
1925 pa_proplist_setf(data.proplist, PA_PROP_DEVICE_BUFFERING_BUFFER_SIZE, "%lu", (unsigned long) (buffer_frames * frame_size));
1926 pa_proplist_setf(data.proplist, PA_PROP_DEVICE_BUFFERING_FRAGMENT_SIZE, "%lu", (unsigned long) (period_frames * frame_size));
1927 pa_proplist_sets(data.proplist, PA_PROP_DEVICE_ACCESS_MODE, u->use_tsched ? "mmap+timer" : (u->use_mmap ? "mmap" : "serial"));
1930 pa_proplist_sets(data.proplist, PA_PROP_DEVICE_PROFILE_NAME, mapping->name);
1931 pa_proplist_sets(data.proplist, PA_PROP_DEVICE_PROFILE_DESCRIPTION, mapping->description);
1934 pa_alsa_init_description(data.proplist);
1936 if (u->control_device)
1937 pa_alsa_init_proplist_ctl(data.proplist, u->control_device);
1939 if (pa_modargs_get_proplist(ma, "source_properties", data.proplist, PA_UPDATE_REPLACE) < 0) {
1940 pa_log("Invalid properties");
1941 pa_source_new_data_done(&data);
1945 if (u->mixer_path_set)
1946 pa_alsa_add_ports(&data, u->mixer_path_set, card);
1948 u->source = pa_source_new(m->core, &data, PA_SOURCE_HARDWARE|PA_SOURCE_LATENCY|(u->use_tsched ? PA_SOURCE_DYNAMIC_LATENCY : 0));
1949 pa_source_new_data_done(&data);
1952 pa_log("Failed to create source object");
1956 if (pa_modargs_get_value_u32(ma, "deferred_volume_safety_margin",
1957 &u->source->thread_info.volume_change_safety_margin) < 0) {
1958 pa_log("Failed to parse deferred_volume_safety_margin parameter");
1962 if (pa_modargs_get_value_s32(ma, "deferred_volume_extra_delay",
1963 &u->source->thread_info.volume_change_extra_delay) < 0) {
1964 pa_log("Failed to parse deferred_volume_extra_delay parameter");
1968 u->source->parent.process_msg = source_process_msg;
1970 u->source->update_requested_latency = source_update_requested_latency_cb;
1971 u->source->set_state = source_set_state_cb;
1972 u->source->set_port = source_set_port_cb;
1973 if (u->source->alternate_sample_rate)
1974 u->source->update_rate = source_update_rate_cb;
1975 u->source->userdata = u;
1977 pa_source_set_asyncmsgq(u->source, u->thread_mq.inq);
1978 pa_source_set_rtpoll(u->source, u->rtpoll);
1980 u->frame_size = frame_size;
1981 u->fragment_size = frag_size = (size_t) (period_frames * frame_size);
1982 u->hwbuf_size = buffer_size = (size_t) (buffer_frames * frame_size);
1983 pa_cvolume_mute(&u->hardware_volume, u->source->sample_spec.channels);
1985 pa_log_info("Using %0.1f fragments of size %lu bytes (%0.2fms), buffer size is %lu bytes (%0.2fms)",
1986 (double) u->hwbuf_size / (double) u->fragment_size,
1987 (long unsigned) u->fragment_size,
1988 (double) pa_bytes_to_usec(u->fragment_size, &ss) / PA_USEC_PER_MSEC,
1989 (long unsigned) u->hwbuf_size,
1990 (double) pa_bytes_to_usec(u->hwbuf_size, &ss) / PA_USEC_PER_MSEC);
1992 if (u->use_tsched) {
1993 u->tsched_watermark_ref = tsched_watermark;
1994 reset_watermark(u, u->tsched_watermark_ref, &ss, FALSE);
1997 pa_source_set_fixed_latency(u->source, pa_bytes_to_usec(u->hwbuf_size, &ss));
2001 if (update_sw_params(u) < 0)
2004 if (setup_mixer(u, ignore_dB) < 0)
2007 pa_alsa_dump(PA_LOG_DEBUG, u->pcm_handle);
2009 if (!(u->thread = pa_thread_new("alsa-source", thread_func, u))) {
2010 pa_log("Failed to create thread.");
2014 /* Get initial mixer settings */
2015 if (data.volume_is_set) {
2016 if (u->source->set_volume)
2017 u->source->set_volume(u->source);
2019 if (u->source->get_volume)
2020 u->source->get_volume(u->source);
2023 if (data.muted_is_set) {
2024 if (u->source->set_mute)
2025 u->source->set_mute(u->source);
2027 if (u->source->get_mute)
2028 u->source->get_mute(u->source);
2031 if ((data.volume_is_set || data.muted_is_set) && u->source->write_volume)
2032 u->source->write_volume(u->source);
2034 pa_source_put(u->source);
2037 pa_alsa_profile_set_free(profile_set);
2047 pa_alsa_profile_set_free(profile_set);
2052 static void userdata_free(struct userdata *u) {
2056 pa_source_unlink(u->source);
2059 pa_asyncmsgq_send(u->thread_mq.inq, NULL, PA_MESSAGE_SHUTDOWN, NULL, 0, NULL);
2060 pa_thread_free(u->thread);
2063 pa_thread_mq_done(&u->thread_mq);
2066 pa_source_unref(u->source);
2069 pa_alsa_mixer_pdata_free(u->mixer_pd);
2071 if (u->alsa_rtpoll_item)
2072 pa_rtpoll_item_free(u->alsa_rtpoll_item);
2075 pa_rtpoll_free(u->rtpoll);
2077 if (u->pcm_handle) {
2078 snd_pcm_drop(u->pcm_handle);
2079 snd_pcm_close(u->pcm_handle);
2083 pa_alsa_fdlist_free(u->mixer_fdl);
2085 if (u->mixer_path && !u->mixer_path_set)
2086 pa_alsa_path_free(u->mixer_path);
2088 if (u->mixer_handle)
2089 snd_mixer_close(u->mixer_handle);
2092 pa_smoother_free(u->smoother);
2100 pa_xfree(u->device_name);
2101 pa_xfree(u->control_device);
2102 pa_xfree(u->paths_dir);
2106 void pa_alsa_source_free(pa_source *s) {
2109 pa_source_assert_ref(s);
2110 pa_assert_se(u = s->userdata);