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
29 #include <asoundlib.h>
31 #include <pulse/rtclock.h>
32 #include <pulse/timeval.h>
33 #include <pulse/volume.h>
34 #include <pulse/xmalloc.h>
36 #include <pulsecore/core.h>
37 #include <pulsecore/i18n.h>
38 #include <pulsecore/module.h>
39 #include <pulsecore/memchunk.h>
40 #include <pulsecore/sink.h>
41 #include <pulsecore/modargs.h>
42 #include <pulsecore/core-rtclock.h>
43 #include <pulsecore/core-util.h>
44 #include <pulsecore/sample-util.h>
45 #include <pulsecore/log.h>
46 #include <pulsecore/macro.h>
47 #include <pulsecore/thread.h>
48 #include <pulsecore/thread-mq.h>
49 #include <pulsecore/rtpoll.h>
50 #include <pulsecore/time-smoother.h>
52 #include <modules/reserve-wrap.h>
54 #include "alsa-util.h"
55 #include "alsa-source.h"
57 /* #define DEBUG_TIMING */
59 #define DEFAULT_DEVICE "default"
61 #define DEFAULT_TSCHED_BUFFER_USEC (2*PA_USEC_PER_SEC) /* 2s */
62 #define DEFAULT_TSCHED_WATERMARK_USEC (20*PA_USEC_PER_MSEC) /* 20ms */
64 #define TSCHED_WATERMARK_INC_STEP_USEC (10*PA_USEC_PER_MSEC) /* 10ms */
65 #define TSCHED_WATERMARK_DEC_STEP_USEC (5*PA_USEC_PER_MSEC) /* 5ms */
66 #define TSCHED_WATERMARK_VERIFY_AFTER_USEC (20*PA_USEC_PER_SEC) /* 20s */
67 #define TSCHED_WATERMARK_INC_THRESHOLD_USEC (0*PA_USEC_PER_MSEC) /* 0ms */
68 #define TSCHED_WATERMARK_DEC_THRESHOLD_USEC (100*PA_USEC_PER_MSEC) /* 100ms */
69 #define TSCHED_WATERMARK_STEP_USEC (10*PA_USEC_PER_MSEC) /* 10ms */
71 #define TSCHED_MIN_SLEEP_USEC (10*PA_USEC_PER_MSEC) /* 10ms */
72 #define TSCHED_MIN_WAKEUP_USEC (4*PA_USEC_PER_MSEC) /* 4ms */
74 #define SMOOTHER_WINDOW_USEC (10*PA_USEC_PER_SEC) /* 10s */
75 #define SMOOTHER_ADJUST_USEC (1*PA_USEC_PER_SEC) /* 1s */
77 #define SMOOTHER_MIN_INTERVAL (2*PA_USEC_PER_MSEC) /* 2ms */
78 #define SMOOTHER_MAX_INTERVAL (200*PA_USEC_PER_MSEC) /* 200ms */
80 #define VOLUME_ACCURACY (PA_VOLUME_NORM/100)
88 pa_thread_mq thread_mq
;
91 snd_pcm_t
*pcm_handle
;
94 pa_alsa_fdlist
*mixer_fdl
;
95 pa_alsa_mixer_pdata
*mixer_pd
;
96 snd_mixer_t
*mixer_handle
;
97 pa_alsa_path_set
*mixer_path_set
;
98 pa_alsa_path
*mixer_path
;
100 pa_cvolume hardware_volume
;
109 tsched_watermark_ref
,
115 watermark_inc_threshold
,
116 watermark_dec_threshold
;
118 pa_usec_t watermark_dec_not_before
;
119 pa_usec_t min_latency_ref
;
121 char *device_name
; /* name of the PCM device */
122 char *control_device
; /* name of the control device */
124 pa_bool_t use_mmap
:1, use_tsched
:1, deferred_volume
:1, fixed_latency_range
:1;
128 pa_rtpoll_item
*alsa_rtpoll_item
;
130 pa_smoother
*smoother
;
132 pa_usec_t smoother_interval
;
133 pa_usec_t last_smoother_update
;
135 pa_reserve_wrapper
*reserve
;
136 pa_hook_slot
*reserve_slot
;
137 pa_reserve_monitor_wrapper
*monitor
;
138 pa_hook_slot
*monitor_slot
;
141 static void userdata_free(struct userdata
*u
);
143 static pa_hook_result_t
reserve_cb(pa_reserve_wrapper
*r
, void *forced
, struct userdata
*u
) {
147 if (pa_source_suspend(u
->source
, TRUE
, PA_SUSPEND_APPLICATION
) < 0)
148 return PA_HOOK_CANCEL
;
153 static void reserve_done(struct userdata
*u
) {
156 if (u
->reserve_slot
) {
157 pa_hook_slot_free(u
->reserve_slot
);
158 u
->reserve_slot
= NULL
;
162 pa_reserve_wrapper_unref(u
->reserve
);
167 static void reserve_update(struct userdata
*u
) {
168 const char *description
;
171 if (!u
->source
|| !u
->reserve
)
174 if ((description
= pa_proplist_gets(u
->source
->proplist
, PA_PROP_DEVICE_DESCRIPTION
)))
175 pa_reserve_wrapper_set_application_device_name(u
->reserve
, description
);
178 static int reserve_init(struct userdata
*u
, const char *dname
) {
187 if (pa_in_system_mode())
190 if (!(rname
= pa_alsa_get_reserve_name(dname
)))
193 /* We are resuming, try to lock the device */
194 u
->reserve
= pa_reserve_wrapper_get(u
->core
, rname
);
202 pa_assert(!u
->reserve_slot
);
203 u
->reserve_slot
= pa_hook_connect(pa_reserve_wrapper_hook(u
->reserve
), PA_HOOK_NORMAL
, (pa_hook_cb_t
) reserve_cb
, u
);
208 static pa_hook_result_t
monitor_cb(pa_reserve_monitor_wrapper
*w
, void* busy
, struct userdata
*u
) {
214 b
= PA_PTR_TO_UINT(busy
) && !u
->reserve
;
216 pa_source_suspend(u
->source
, b
, PA_SUSPEND_APPLICATION
);
220 static void monitor_done(struct userdata
*u
) {
223 if (u
->monitor_slot
) {
224 pa_hook_slot_free(u
->monitor_slot
);
225 u
->monitor_slot
= NULL
;
229 pa_reserve_monitor_wrapper_unref(u
->monitor
);
234 static int reserve_monitor_init(struct userdata
*u
, const char *dname
) {
240 if (pa_in_system_mode())
243 if (!(rname
= pa_alsa_get_reserve_name(dname
)))
246 /* We are resuming, try to lock the device */
247 u
->monitor
= pa_reserve_monitor_wrapper_get(u
->core
, rname
);
253 pa_assert(!u
->monitor_slot
);
254 u
->monitor_slot
= pa_hook_connect(pa_reserve_monitor_wrapper_hook(u
->monitor
), PA_HOOK_NORMAL
, (pa_hook_cb_t
) monitor_cb
, u
);
259 static void fix_min_sleep_wakeup(struct userdata
*u
) {
260 size_t max_use
, max_use_2
;
263 pa_assert(u
->use_tsched
);
265 max_use
= u
->hwbuf_size
- u
->hwbuf_unused
;
266 max_use_2
= pa_frame_align(max_use
/2, &u
->source
->sample_spec
);
268 u
->min_sleep
= pa_usec_to_bytes(TSCHED_MIN_SLEEP_USEC
, &u
->source
->sample_spec
);
269 u
->min_sleep
= PA_CLAMP(u
->min_sleep
, u
->frame_size
, max_use_2
);
271 u
->min_wakeup
= pa_usec_to_bytes(TSCHED_MIN_WAKEUP_USEC
, &u
->source
->sample_spec
);
272 u
->min_wakeup
= PA_CLAMP(u
->min_wakeup
, u
->frame_size
, max_use_2
);
275 static void fix_tsched_watermark(struct userdata
*u
) {
278 pa_assert(u
->use_tsched
);
280 max_use
= u
->hwbuf_size
- u
->hwbuf_unused
;
282 if (u
->tsched_watermark
> max_use
- u
->min_sleep
)
283 u
->tsched_watermark
= max_use
- u
->min_sleep
;
285 if (u
->tsched_watermark
< u
->min_wakeup
)
286 u
->tsched_watermark
= u
->min_wakeup
;
289 static void increase_watermark(struct userdata
*u
) {
290 size_t old_watermark
;
291 pa_usec_t old_min_latency
, new_min_latency
;
294 pa_assert(u
->use_tsched
);
296 /* First, just try to increase the watermark */
297 old_watermark
= u
->tsched_watermark
;
298 u
->tsched_watermark
= PA_MIN(u
->tsched_watermark
* 2, u
->tsched_watermark
+ u
->watermark_inc_step
);
299 fix_tsched_watermark(u
);
301 if (old_watermark
!= u
->tsched_watermark
) {
302 pa_log_info("Increasing wakeup watermark to %0.2f ms",
303 (double) pa_bytes_to_usec(u
->tsched_watermark
, &u
->source
->sample_spec
) / PA_USEC_PER_MSEC
);
307 /* Hmm, we cannot increase the watermark any further, hence let's
308 raise the latency unless doing so was disabled in
310 if (u
->fixed_latency_range
)
313 old_min_latency
= u
->source
->thread_info
.min_latency
;
314 new_min_latency
= PA_MIN(old_min_latency
* 2, old_min_latency
+ TSCHED_WATERMARK_INC_STEP_USEC
);
315 new_min_latency
= PA_MIN(new_min_latency
, u
->source
->thread_info
.max_latency
);
317 if (old_min_latency
!= new_min_latency
) {
318 pa_log_info("Increasing minimal latency to %0.2f ms",
319 (double) new_min_latency
/ PA_USEC_PER_MSEC
);
321 pa_source_set_latency_range_within_thread(u
->source
, new_min_latency
, u
->source
->thread_info
.max_latency
);
324 /* When we reach this we're officialy fucked! */
327 static void decrease_watermark(struct userdata
*u
) {
328 size_t old_watermark
;
332 pa_assert(u
->use_tsched
);
334 now
= pa_rtclock_now();
336 if (u
->watermark_dec_not_before
<= 0)
339 if (u
->watermark_dec_not_before
> now
)
342 old_watermark
= u
->tsched_watermark
;
344 if (u
->tsched_watermark
< u
->watermark_dec_step
)
345 u
->tsched_watermark
= u
->tsched_watermark
/ 2;
347 u
->tsched_watermark
= PA_MAX(u
->tsched_watermark
/ 2, u
->tsched_watermark
- u
->watermark_dec_step
);
349 fix_tsched_watermark(u
);
351 if (old_watermark
!= u
->tsched_watermark
)
352 pa_log_info("Decreasing wakeup watermark to %0.2f ms",
353 (double) pa_bytes_to_usec(u
->tsched_watermark
, &u
->source
->sample_spec
) / PA_USEC_PER_MSEC
);
355 /* We don't change the latency range*/
358 u
->watermark_dec_not_before
= now
+ TSCHED_WATERMARK_VERIFY_AFTER_USEC
;
361 static void hw_sleep_time(struct userdata
*u
, pa_usec_t
*sleep_usec
, pa_usec_t
*process_usec
) {
364 pa_assert(sleep_usec
);
365 pa_assert(process_usec
);
368 pa_assert(u
->use_tsched
);
370 usec
= pa_source_get_requested_latency_within_thread(u
->source
);
372 if (usec
== (pa_usec_t
) -1)
373 usec
= pa_bytes_to_usec(u
->hwbuf_size
, &u
->source
->sample_spec
);
375 wm
= pa_bytes_to_usec(u
->tsched_watermark
, &u
->source
->sample_spec
);
380 *sleep_usec
= usec
- wm
;
384 pa_log_debug("Buffer time: %lu ms; Sleep time: %lu ms; Process time: %lu ms",
385 (unsigned long) (usec
/ PA_USEC_PER_MSEC
),
386 (unsigned long) (*sleep_usec
/ PA_USEC_PER_MSEC
),
387 (unsigned long) (*process_usec
/ PA_USEC_PER_MSEC
));
391 static int try_recover(struct userdata
*u
, const char *call
, int err
) {
396 pa_log_debug("%s: %s", call
, pa_alsa_strerror(err
));
398 pa_assert(err
!= -EAGAIN
);
401 pa_log_debug("%s: Buffer overrun!", call
);
403 if (err
== -ESTRPIPE
)
404 pa_log_debug("%s: System suspended!", call
);
406 if ((err
= snd_pcm_recover(u
->pcm_handle
, err
, 1)) < 0) {
407 pa_log("%s: %s", call
, pa_alsa_strerror(err
));
415 static size_t check_left_to_record(struct userdata
*u
, size_t n_bytes
, pa_bool_t on_timeout
) {
416 size_t left_to_record
;
417 size_t rec_space
= u
->hwbuf_size
- u
->hwbuf_unused
;
418 pa_bool_t overrun
= FALSE
;
420 /* We use <= instead of < for this check here because an overrun
421 * only happens after the last sample was processed, not already when
422 * it is removed from the buffer. This is particularly important
423 * when block transfer is used. */
425 if (n_bytes
<= rec_space
)
426 left_to_record
= rec_space
- n_bytes
;
429 /* We got a dropout. What a mess! */
437 if (pa_log_ratelimit(PA_LOG_INFO
))
438 pa_log_info("Overrun!");
442 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
);
446 pa_bool_t reset_not_before
= TRUE
;
448 if (overrun
|| left_to_record
< u
->watermark_inc_threshold
)
449 increase_watermark(u
);
450 else if (left_to_record
> u
->watermark_dec_threshold
) {
451 reset_not_before
= FALSE
;
453 /* We decrease the watermark only if have actually
454 * been woken up by a timeout. If something else woke
455 * us up it's too easy to fulfill the deadlines... */
458 decrease_watermark(u
);
461 if (reset_not_before
)
462 u
->watermark_dec_not_before
= 0;
465 return left_to_record
;
468 static int mmap_read(struct userdata
*u
, pa_usec_t
*sleep_usec
, pa_bool_t polled
, pa_bool_t on_timeout
) {
469 pa_bool_t work_done
= FALSE
;
470 pa_usec_t max_sleep_usec
= 0, process_usec
= 0;
471 size_t left_to_record
;
475 pa_source_assert_ref(u
->source
);
478 hw_sleep_time(u
, &max_sleep_usec
, &process_usec
);
484 pa_bool_t after_avail
= TRUE
;
486 if (PA_UNLIKELY((n
= pa_alsa_safe_avail(u
->pcm_handle
, u
->hwbuf_size
, &u
->source
->sample_spec
)) < 0)) {
488 if ((r
= try_recover(u
, "snd_pcm_avail", (int) n
)) == 0)
494 n_bytes
= (size_t) n
* u
->frame_size
;
497 pa_log_debug("avail: %lu", (unsigned long) n_bytes
);
500 left_to_record
= check_left_to_record(u
, n_bytes
, on_timeout
);
505 pa_bytes_to_usec(left_to_record
, &u
->source
->sample_spec
) > process_usec
+max_sleep_usec
/2) {
507 pa_log_debug("Not reading, because too early.");
512 if (PA_UNLIKELY(n_bytes
<= 0)) {
516 char *dn
= pa_alsa_get_driver_name_by_pcm(u
->pcm_handle
);
517 pa_log(_("ALSA woke us up to read new data from the device, but there was actually nothing to read!\n"
518 "Most likely this is a bug in the ALSA driver '%s'. Please report this issue to the ALSA developers.\n"
519 "We were woken up with POLLIN set -- however a subsequent snd_pcm_avail() returned 0 or another value < min_avail."),
525 pa_log_debug("Not reading, because not necessary.");
533 pa_log_debug("Not filling up, because already too many iterations.");
542 pa_log_debug("Reading");
549 const snd_pcm_channel_area_t
*areas
;
550 snd_pcm_uframes_t offset
, frames
;
551 snd_pcm_sframes_t sframes
;
553 frames
= (snd_pcm_uframes_t
) (n_bytes
/ u
->frame_size
);
554 /* pa_log_debug("%lu frames to read", (unsigned long) frames); */
556 if (PA_UNLIKELY((err
= pa_alsa_safe_mmap_begin(u
->pcm_handle
, &areas
, &offset
, &frames
, u
->hwbuf_size
, &u
->source
->sample_spec
)) < 0)) {
558 if (!after_avail
&& err
== -EAGAIN
)
561 if ((r
= try_recover(u
, "snd_pcm_mmap_begin", err
)) == 0)
567 /* Make sure that if these memblocks need to be copied they will fit into one slot */
568 if (frames
> pa_mempool_block_size_max(u
->core
->mempool
)/u
->frame_size
)
569 frames
= pa_mempool_block_size_max(u
->core
->mempool
)/u
->frame_size
;
571 if (!after_avail
&& frames
== 0)
574 pa_assert(frames
> 0);
577 /* Check these are multiples of 8 bit */
578 pa_assert((areas
[0].first
& 7) == 0);
579 pa_assert((areas
[0].step
& 7)== 0);
581 /* We assume a single interleaved memory buffer */
582 pa_assert((areas
[0].first
>> 3) == 0);
583 pa_assert((areas
[0].step
>> 3) == u
->frame_size
);
585 p
= (uint8_t*) areas
[0].addr
+ (offset
* u
->frame_size
);
587 chunk
.memblock
= pa_memblock_new_fixed(u
->core
->mempool
, p
, frames
* u
->frame_size
, TRUE
);
588 chunk
.length
= pa_memblock_get_length(chunk
.memblock
);
591 pa_source_post(u
->source
, &chunk
);
592 pa_memblock_unref_fixed(chunk
.memblock
);
594 if (PA_UNLIKELY((sframes
= snd_pcm_mmap_commit(u
->pcm_handle
, offset
, frames
)) < 0)) {
596 if ((r
= try_recover(u
, "snd_pcm_mmap_commit", (int) sframes
)) == 0)
604 u
->read_count
+= frames
* u
->frame_size
;
607 pa_log_debug("Read %lu bytes (of possible %lu bytes)", (unsigned long) (frames
* u
->frame_size
), (unsigned long) n_bytes
);
610 if ((size_t) frames
* u
->frame_size
>= n_bytes
)
613 n_bytes
-= (size_t) frames
* u
->frame_size
;
618 *sleep_usec
= pa_bytes_to_usec(left_to_record
, &u
->source
->sample_spec
);
619 process_usec
= pa_bytes_to_usec(u
->tsched_watermark
, &u
->source
->sample_spec
);
621 if (*sleep_usec
> process_usec
)
622 *sleep_usec
-= process_usec
;
627 return work_done
? 1 : 0;
630 static int unix_read(struct userdata
*u
, pa_usec_t
*sleep_usec
, pa_bool_t polled
, pa_bool_t on_timeout
) {
631 int work_done
= FALSE
;
632 pa_usec_t max_sleep_usec
= 0, process_usec
= 0;
633 size_t left_to_record
;
637 pa_source_assert_ref(u
->source
);
640 hw_sleep_time(u
, &max_sleep_usec
, &process_usec
);
646 pa_bool_t after_avail
= TRUE
;
648 if (PA_UNLIKELY((n
= pa_alsa_safe_avail(u
->pcm_handle
, u
->hwbuf_size
, &u
->source
->sample_spec
)) < 0)) {
650 if ((r
= try_recover(u
, "snd_pcm_avail", (int) n
)) == 0)
656 n_bytes
= (size_t) n
* u
->frame_size
;
657 left_to_record
= check_left_to_record(u
, n_bytes
, on_timeout
);
662 pa_bytes_to_usec(left_to_record
, &u
->source
->sample_spec
) > process_usec
+max_sleep_usec
/2)
665 if (PA_UNLIKELY(n_bytes
<= 0)) {
669 char *dn
= pa_alsa_get_driver_name_by_pcm(u
->pcm_handle
);
670 pa_log(_("ALSA woke us up to read new data from the device, but there was actually nothing to read!\n"
671 "Most likely this is a bug in the ALSA driver '%s'. Please report this issue to the ALSA developers.\n"
672 "We were woken up with POLLIN set -- however a subsequent snd_pcm_avail() returned 0 or another value < min_avail."),
682 pa_log_debug("Not filling up, because already too many iterations.");
692 snd_pcm_sframes_t frames
;
695 chunk
.memblock
= pa_memblock_new(u
->core
->mempool
, (size_t) -1);
697 frames
= (snd_pcm_sframes_t
) (pa_memblock_get_length(chunk
.memblock
) / u
->frame_size
);
699 if (frames
> (snd_pcm_sframes_t
) (n_bytes
/u
->frame_size
))
700 frames
= (snd_pcm_sframes_t
) (n_bytes
/u
->frame_size
);
702 /* pa_log_debug("%lu frames to read", (unsigned long) n); */
704 p
= pa_memblock_acquire(chunk
.memblock
);
705 frames
= snd_pcm_readi(u
->pcm_handle
, (uint8_t*) p
, (snd_pcm_uframes_t
) frames
);
706 pa_memblock_release(chunk
.memblock
);
708 if (PA_UNLIKELY(frames
< 0)) {
709 pa_memblock_unref(chunk
.memblock
);
711 if (!after_avail
&& (int) frames
== -EAGAIN
)
714 if ((r
= try_recover(u
, "snd_pcm_readi", (int) frames
)) == 0)
720 if (!after_avail
&& frames
== 0) {
721 pa_memblock_unref(chunk
.memblock
);
725 pa_assert(frames
> 0);
729 chunk
.length
= (size_t) frames
* u
->frame_size
;
731 pa_source_post(u
->source
, &chunk
);
732 pa_memblock_unref(chunk
.memblock
);
736 u
->read_count
+= frames
* u
->frame_size
;
738 /* pa_log_debug("read %lu frames", (unsigned long) frames); */
740 if ((size_t) frames
* u
->frame_size
>= n_bytes
)
743 n_bytes
-= (size_t) frames
* u
->frame_size
;
748 *sleep_usec
= pa_bytes_to_usec(left_to_record
, &u
->source
->sample_spec
);
749 process_usec
= pa_bytes_to_usec(u
->tsched_watermark
, &u
->source
->sample_spec
);
751 if (*sleep_usec
> process_usec
)
752 *sleep_usec
-= process_usec
;
757 return work_done
? 1 : 0;
760 static void update_smoother(struct userdata
*u
) {
761 snd_pcm_sframes_t delay
= 0;
764 pa_usec_t now1
= 0, now2
;
765 snd_pcm_status_t
*status
;
767 snd_pcm_status_alloca(&status
);
770 pa_assert(u
->pcm_handle
);
772 /* Let's update the time smoother */
774 if (PA_UNLIKELY((err
= pa_alsa_safe_delay(u
->pcm_handle
, &delay
, u
->hwbuf_size
, &u
->source
->sample_spec
, TRUE
)) < 0)) {
775 pa_log_warn("Failed to get delay: %s", pa_alsa_strerror(err
));
779 if (PA_UNLIKELY((err
= snd_pcm_status(u
->pcm_handle
, status
)) < 0))
780 pa_log_warn("Failed to get timestamp: %s", pa_alsa_strerror(err
));
782 snd_htimestamp_t htstamp
= { 0, 0 };
783 snd_pcm_status_get_htstamp(status
, &htstamp
);
784 now1
= pa_timespec_load(&htstamp
);
787 /* Hmm, if the timestamp is 0, then it wasn't set and we take the current time */
789 now1
= pa_rtclock_now();
791 /* check if the time since the last update is bigger than the interval */
792 if (u
->last_smoother_update
> 0)
793 if (u
->last_smoother_update
+ u
->smoother_interval
> now1
)
796 position
= u
->read_count
+ ((uint64_t) delay
* (uint64_t) u
->frame_size
);
797 now2
= pa_bytes_to_usec(position
, &u
->source
->sample_spec
);
799 pa_smoother_put(u
->smoother
, now1
, now2
);
801 u
->last_smoother_update
= now1
;
802 /* exponentially increase the update interval up to the MAX limit */
803 u
->smoother_interval
= PA_MIN (u
->smoother_interval
* 2, SMOOTHER_MAX_INTERVAL
);
806 static pa_usec_t
source_get_latency(struct userdata
*u
) {
808 pa_usec_t now1
, now2
;
812 now1
= pa_rtclock_now();
813 now2
= pa_smoother_get(u
->smoother
, now1
);
815 delay
= (int64_t) now2
- (int64_t) pa_bytes_to_usec(u
->read_count
, &u
->source
->sample_spec
);
817 return delay
>= 0 ? (pa_usec_t
) delay
: 0;
820 static int build_pollfd(struct userdata
*u
) {
822 pa_assert(u
->pcm_handle
);
824 if (u
->alsa_rtpoll_item
)
825 pa_rtpoll_item_free(u
->alsa_rtpoll_item
);
827 if (!(u
->alsa_rtpoll_item
= pa_alsa_build_pollfd(u
->pcm_handle
, u
->rtpoll
)))
833 /* Called from IO context */
834 static int suspend(struct userdata
*u
) {
836 pa_assert(u
->pcm_handle
);
838 pa_smoother_pause(u
->smoother
, pa_rtclock_now());
841 snd_pcm_close(u
->pcm_handle
);
842 u
->pcm_handle
= NULL
;
844 if (u
->alsa_rtpoll_item
) {
845 pa_rtpoll_item_free(u
->alsa_rtpoll_item
);
846 u
->alsa_rtpoll_item
= NULL
;
849 pa_log_info("Device suspended...");
854 /* Called from IO context */
855 static int update_sw_params(struct userdata
*u
) {
856 snd_pcm_uframes_t avail_min
;
861 /* Use the full buffer if no one asked us for anything specific */
867 if ((latency
= pa_source_get_requested_latency_within_thread(u
->source
)) != (pa_usec_t
) -1) {
870 pa_log_debug("latency set to %0.2fms", (double) latency
/ PA_USEC_PER_MSEC
);
872 b
= pa_usec_to_bytes(latency
, &u
->source
->sample_spec
);
874 /* We need at least one sample in our buffer */
876 if (PA_UNLIKELY(b
< u
->frame_size
))
879 u
->hwbuf_unused
= PA_LIKELY(b
< u
->hwbuf_size
) ? (u
->hwbuf_size
- b
) : 0;
882 fix_min_sleep_wakeup(u
);
883 fix_tsched_watermark(u
);
886 pa_log_debug("hwbuf_unused=%lu", (unsigned long) u
->hwbuf_unused
);
891 pa_usec_t sleep_usec
, process_usec
;
893 hw_sleep_time(u
, &sleep_usec
, &process_usec
);
894 avail_min
+= pa_usec_to_bytes(sleep_usec
, &u
->source
->sample_spec
) / u
->frame_size
;
897 pa_log_debug("setting avail_min=%lu", (unsigned long) avail_min
);
899 if ((err
= pa_alsa_set_sw_params(u
->pcm_handle
, avail_min
, !u
->use_tsched
)) < 0) {
900 pa_log("Failed to set software parameters: %s", pa_alsa_strerror(err
));
907 /* Called from IO Context on unsuspend or from main thread when creating source */
908 static void reset_watermark(struct userdata
*u
, size_t tsched_watermark
, pa_sample_spec
*ss
,
911 u
->tsched_watermark
= pa_usec_to_bytes_round_up(pa_bytes_to_usec_round_up(tsched_watermark
, ss
),
912 &u
->source
->sample_spec
);
914 u
->watermark_inc_step
= pa_usec_to_bytes(TSCHED_WATERMARK_INC_STEP_USEC
, &u
->source
->sample_spec
);
915 u
->watermark_dec_step
= pa_usec_to_bytes(TSCHED_WATERMARK_DEC_STEP_USEC
, &u
->source
->sample_spec
);
917 u
->watermark_inc_threshold
= pa_usec_to_bytes_round_up(TSCHED_WATERMARK_INC_THRESHOLD_USEC
, &u
->source
->sample_spec
);
918 u
->watermark_dec_threshold
= pa_usec_to_bytes_round_up(TSCHED_WATERMARK_DEC_THRESHOLD_USEC
, &u
->source
->sample_spec
);
920 fix_min_sleep_wakeup(u
);
921 fix_tsched_watermark(u
);
924 pa_source_set_latency_range_within_thread(u
->source
,
926 pa_bytes_to_usec(u
->hwbuf_size
, ss
));
928 pa_source_set_latency_range(u
->source
,
930 pa_bytes_to_usec(u
->hwbuf_size
, ss
));
932 /* work-around assert in pa_source_set_latency_within_thead,
933 keep track of min_latency and reuse it when
934 this routine is called from IO context */
935 u
->min_latency_ref
= u
->source
->thread_info
.min_latency
;
938 pa_log_info("Time scheduling watermark is %0.2fms",
939 (double) pa_bytes_to_usec(u
->tsched_watermark
, ss
) / PA_USEC_PER_MSEC
);
942 /* Called from IO context */
943 static int unsuspend(struct userdata
*u
) {
947 snd_pcm_uframes_t period_size
, buffer_size
;
950 pa_assert(!u
->pcm_handle
);
952 pa_log_info("Trying resume...");
954 if ((err
= snd_pcm_open(&u
->pcm_handle
, u
->device_name
, SND_PCM_STREAM_CAPTURE
,
956 SND_PCM_NO_AUTO_RESAMPLE
|
957 SND_PCM_NO_AUTO_CHANNELS
|
958 SND_PCM_NO_AUTO_FORMAT
)) < 0) {
959 pa_log("Error opening PCM device %s: %s", u
->device_name
, pa_alsa_strerror(err
));
963 ss
= u
->source
->sample_spec
;
964 period_size
= u
->fragment_size
/ u
->frame_size
;
965 buffer_size
= u
->hwbuf_size
/ u
->frame_size
;
969 if ((err
= pa_alsa_set_hw_params(u
->pcm_handle
, &ss
, &period_size
, &buffer_size
, 0, &b
, &d
, TRUE
)) < 0) {
970 pa_log("Failed to set hardware parameters: %s", pa_alsa_strerror(err
));
974 if (b
!= u
->use_mmap
|| d
!= u
->use_tsched
) {
975 pa_log_warn("Resume failed, couldn't get original access mode.");
979 if (!pa_sample_spec_equal(&ss
, &u
->source
->sample_spec
)) {
980 pa_log_warn("Resume failed, couldn't restore original sample settings.");
984 if (period_size
*u
->frame_size
!= u
->fragment_size
||
985 buffer_size
*u
->frame_size
!= u
->hwbuf_size
) {
986 pa_log_warn("Resume failed, couldn't restore original fragment settings. (Old: %lu/%lu, New %lu/%lu)",
987 (unsigned long) u
->hwbuf_size
, (unsigned long) u
->fragment_size
,
988 (unsigned long) (buffer_size
*u
->frame_size
), (unsigned long) (period_size
*u
->frame_size
));
992 if (update_sw_params(u
) < 0)
995 if (build_pollfd(u
) < 0)
998 /* FIXME: We need to reload the volume somehow */
1001 pa_smoother_reset(u
->smoother
, pa_rtclock_now(), TRUE
);
1002 u
->smoother_interval
= SMOOTHER_MIN_INTERVAL
;
1003 u
->last_smoother_update
= 0;
1007 /* reset the watermark to the value defined when source was created */
1009 reset_watermark(u
, u
->tsched_watermark_ref
, &u
->source
->sample_spec
, TRUE
);
1011 pa_log_info("Resumed successfully...");
1016 if (u
->pcm_handle
) {
1017 snd_pcm_close(u
->pcm_handle
);
1018 u
->pcm_handle
= NULL
;
1024 /* Called from IO context */
1025 static int source_process_msg(pa_msgobject
*o
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
1026 struct userdata
*u
= PA_SOURCE(o
)->userdata
;
1030 case PA_SOURCE_MESSAGE_GET_LATENCY
: {
1034 r
= source_get_latency(u
);
1036 *((pa_usec_t
*) data
) = r
;
1041 case PA_SOURCE_MESSAGE_SET_STATE
:
1043 switch ((pa_source_state_t
) PA_PTR_TO_UINT(data
)) {
1045 case PA_SOURCE_SUSPENDED
: {
1048 pa_assert(PA_SOURCE_IS_OPENED(u
->source
->thread_info
.state
));
1050 if ((r
= suspend(u
)) < 0)
1056 case PA_SOURCE_IDLE
:
1057 case PA_SOURCE_RUNNING
: {
1060 if (u
->source
->thread_info
.state
== PA_SOURCE_INIT
) {
1061 if (build_pollfd(u
) < 0)
1065 if (u
->source
->thread_info
.state
== PA_SOURCE_SUSPENDED
) {
1066 if ((r
= unsuspend(u
)) < 0)
1073 case PA_SOURCE_UNLINKED
:
1074 case PA_SOURCE_INIT
:
1075 case PA_SOURCE_INVALID_STATE
:
1082 return pa_source_process_msg(o
, code
, data
, offset
, chunk
);
1085 /* Called from main context */
1086 static int source_set_state_cb(pa_source
*s
, pa_source_state_t new_state
) {
1087 pa_source_state_t old_state
;
1090 pa_source_assert_ref(s
);
1091 pa_assert_se(u
= s
->userdata
);
1093 old_state
= pa_source_get_state(u
->source
);
1095 if (PA_SOURCE_IS_OPENED(old_state
) && new_state
== PA_SOURCE_SUSPENDED
)
1097 else if (old_state
== PA_SOURCE_SUSPENDED
&& PA_SOURCE_IS_OPENED(new_state
))
1098 if (reserve_init(u
, u
->device_name
) < 0)
1099 return -PA_ERR_BUSY
;
1104 static int ctl_mixer_callback(snd_mixer_elem_t
*elem
, unsigned int mask
) {
1105 struct userdata
*u
= snd_mixer_elem_get_callback_private(elem
);
1108 pa_assert(u
->mixer_handle
);
1110 if (mask
== SND_CTL_EVENT_MASK_REMOVE
)
1113 if (!PA_SOURCE_IS_LINKED(u
->source
->state
))
1116 if (u
->source
->suspend_cause
& PA_SUSPEND_SESSION
)
1119 if (mask
& SND_CTL_EVENT_MASK_VALUE
) {
1120 pa_source_get_volume(u
->source
, TRUE
);
1121 pa_source_get_mute(u
->source
, TRUE
);
1127 static int io_mixer_callback(snd_mixer_elem_t
*elem
, unsigned int mask
) {
1128 struct userdata
*u
= snd_mixer_elem_get_callback_private(elem
);
1131 pa_assert(u
->mixer_handle
);
1133 if (mask
== SND_CTL_EVENT_MASK_REMOVE
)
1136 if (u
->source
->suspend_cause
& PA_SUSPEND_SESSION
)
1139 if (mask
& SND_CTL_EVENT_MASK_VALUE
)
1140 pa_source_update_volume_and_mute(u
->source
);
1145 static void source_get_volume_cb(pa_source
*s
) {
1146 struct userdata
*u
= s
->userdata
;
1148 char vol_str_pcnt
[PA_CVOLUME_SNPRINT_MAX
];
1151 pa_assert(u
->mixer_path
);
1152 pa_assert(u
->mixer_handle
);
1154 if (pa_alsa_path_get_volume(u
->mixer_path
, u
->mixer_handle
, &s
->channel_map
, &r
) < 0)
1157 /* Shift down by the base volume, so that 0dB becomes maximum volume */
1158 pa_sw_cvolume_multiply_scalar(&r
, &r
, s
->base_volume
);
1160 pa_log_debug("Read hardware volume: %s", pa_cvolume_snprint(vol_str_pcnt
, sizeof(vol_str_pcnt
), &r
));
1162 if (u
->mixer_path
->has_dB
) {
1163 char vol_str_db
[PA_SW_CVOLUME_SNPRINT_DB_MAX
];
1165 pa_log_debug(" in dB: %s", pa_sw_cvolume_snprint_dB(vol_str_db
, sizeof(vol_str_db
), &r
));
1168 if (pa_cvolume_equal(&u
->hardware_volume
, &r
))
1171 s
->real_volume
= u
->hardware_volume
= r
;
1173 /* Hmm, so the hardware volume changed, let's reset our software volume */
1174 if (u
->mixer_path
->has_dB
)
1175 pa_source_set_soft_volume(s
, NULL
);
1178 static void source_set_volume_cb(pa_source
*s
) {
1179 struct userdata
*u
= s
->userdata
;
1181 char vol_str_pcnt
[PA_CVOLUME_SNPRINT_MAX
];
1182 pa_bool_t deferred_volume
= !!(s
->flags
& PA_SOURCE_DEFERRED_VOLUME
);
1185 pa_assert(u
->mixer_path
);
1186 pa_assert(u
->mixer_handle
);
1188 /* Shift up by the base volume */
1189 pa_sw_cvolume_divide_scalar(&r
, &s
->real_volume
, s
->base_volume
);
1191 if (pa_alsa_path_set_volume(u
->mixer_path
, u
->mixer_handle
, &s
->channel_map
, &r
, deferred_volume
, !deferred_volume
) < 0)
1194 /* Shift down by the base volume, so that 0dB becomes maximum volume */
1195 pa_sw_cvolume_multiply_scalar(&r
, &r
, s
->base_volume
);
1197 u
->hardware_volume
= r
;
1199 if (u
->mixer_path
->has_dB
) {
1200 pa_cvolume new_soft_volume
;
1201 pa_bool_t accurate_enough
;
1202 char vol_str_db
[PA_SW_CVOLUME_SNPRINT_DB_MAX
];
1204 /* Match exactly what the user requested by software */
1205 pa_sw_cvolume_divide(&new_soft_volume
, &s
->real_volume
, &u
->hardware_volume
);
1207 /* If the adjustment to do in software is only minimal we
1208 * can skip it. That saves us CPU at the expense of a bit of
1211 (pa_cvolume_min(&new_soft_volume
) >= (PA_VOLUME_NORM
- VOLUME_ACCURACY
)) &&
1212 (pa_cvolume_max(&new_soft_volume
) <= (PA_VOLUME_NORM
+ VOLUME_ACCURACY
));
1214 pa_log_debug("Requested volume: %s", pa_cvolume_snprint(vol_str_pcnt
, sizeof(vol_str_pcnt
), &s
->real_volume
));
1215 pa_log_debug(" in dB: %s", pa_sw_cvolume_snprint_dB(vol_str_db
, sizeof(vol_str_db
), &s
->real_volume
));
1216 pa_log_debug("Got hardware volume: %s", pa_cvolume_snprint(vol_str_pcnt
, sizeof(vol_str_pcnt
), &u
->hardware_volume
));
1217 pa_log_debug(" in dB: %s", pa_sw_cvolume_snprint_dB(vol_str_db
, sizeof(vol_str_db
), &u
->hardware_volume
));
1218 pa_log_debug("Calculated software volume: %s (accurate-enough=%s)",
1219 pa_cvolume_snprint(vol_str_pcnt
, sizeof(vol_str_pcnt
), &new_soft_volume
),
1220 pa_yes_no(accurate_enough
));
1221 pa_log_debug(" in dB: %s", pa_sw_cvolume_snprint_dB(vol_str_db
, sizeof(vol_str_db
), &new_soft_volume
));
1223 if (!accurate_enough
)
1224 s
->soft_volume
= new_soft_volume
;
1227 pa_log_debug("Wrote hardware volume: %s", pa_cvolume_snprint(vol_str_pcnt
, sizeof(vol_str_pcnt
), &r
));
1229 /* We can't match exactly what the user requested, hence let's
1230 * at least tell the user about it */
1236 static void source_write_volume_cb(pa_source
*s
) {
1237 struct userdata
*u
= s
->userdata
;
1238 pa_cvolume hw_vol
= s
->thread_info
.current_hw_volume
;
1241 pa_assert(u
->mixer_path
);
1242 pa_assert(u
->mixer_handle
);
1243 pa_assert(s
->flags
& PA_SOURCE_DEFERRED_VOLUME
);
1245 /* Shift up by the base volume */
1246 pa_sw_cvolume_divide_scalar(&hw_vol
, &hw_vol
, s
->base_volume
);
1248 if (pa_alsa_path_set_volume(u
->mixer_path
, u
->mixer_handle
, &s
->channel_map
, &hw_vol
, TRUE
, TRUE
) < 0)
1249 pa_log_error("Writing HW volume failed");
1252 pa_bool_t accurate_enough
;
1254 /* Shift down by the base volume, so that 0dB becomes maximum volume */
1255 pa_sw_cvolume_multiply_scalar(&hw_vol
, &hw_vol
, s
->base_volume
);
1257 pa_sw_cvolume_divide(&tmp_vol
, &hw_vol
, &s
->thread_info
.current_hw_volume
);
1259 (pa_cvolume_min(&tmp_vol
) >= (PA_VOLUME_NORM
- VOLUME_ACCURACY
)) &&
1260 (pa_cvolume_max(&tmp_vol
) <= (PA_VOLUME_NORM
+ VOLUME_ACCURACY
));
1262 if (!accurate_enough
) {
1264 char db
[2][PA_SW_CVOLUME_SNPRINT_DB_MAX
];
1265 char pcnt
[2][PA_CVOLUME_SNPRINT_MAX
];
1268 pa_log_debug("Written HW volume did not match with the request: %s (request) != %s",
1269 pa_cvolume_snprint(vol
.pcnt
[0], sizeof(vol
.pcnt
[0]), &s
->thread_info
.current_hw_volume
),
1270 pa_cvolume_snprint(vol
.pcnt
[1], sizeof(vol
.pcnt
[1]), &hw_vol
));
1271 pa_log_debug(" in dB: %s (request) != %s",
1272 pa_sw_cvolume_snprint_dB(vol
.db
[0], sizeof(vol
.db
[0]), &s
->thread_info
.current_hw_volume
),
1273 pa_sw_cvolume_snprint_dB(vol
.db
[1], sizeof(vol
.db
[1]), &hw_vol
));
1278 static void source_get_mute_cb(pa_source
*s
) {
1279 struct userdata
*u
= s
->userdata
;
1283 pa_assert(u
->mixer_path
);
1284 pa_assert(u
->mixer_handle
);
1286 if (pa_alsa_path_get_mute(u
->mixer_path
, u
->mixer_handle
, &b
) < 0)
1292 static void source_set_mute_cb(pa_source
*s
) {
1293 struct userdata
*u
= s
->userdata
;
1296 pa_assert(u
->mixer_path
);
1297 pa_assert(u
->mixer_handle
);
1299 pa_alsa_path_set_mute(u
->mixer_path
, u
->mixer_handle
, s
->muted
);
1302 static void mixer_volume_init(struct userdata
*u
) {
1305 if (!u
->mixer_path
->has_volume
) {
1306 pa_source_set_write_volume_callback(u
->source
, NULL
);
1307 pa_source_set_get_volume_callback(u
->source
, NULL
);
1308 pa_source_set_set_volume_callback(u
->source
, NULL
);
1310 pa_log_info("Driver does not support hardware volume control, falling back to software volume control.");
1312 pa_source_set_get_volume_callback(u
->source
, source_get_volume_cb
);
1313 pa_source_set_set_volume_callback(u
->source
, source_set_volume_cb
);
1315 if (u
->mixer_path
->has_dB
&& u
->deferred_volume
) {
1316 pa_source_set_write_volume_callback(u
->source
, source_write_volume_cb
);
1317 pa_log_info("Successfully enabled deferred volume.");
1319 pa_source_set_write_volume_callback(u
->source
, NULL
);
1321 if (u
->mixer_path
->has_dB
) {
1322 pa_source_enable_decibel_volume(u
->source
, TRUE
);
1323 pa_log_info("Hardware volume ranges from %0.2f dB to %0.2f dB.", u
->mixer_path
->min_dB
, u
->mixer_path
->max_dB
);
1325 u
->source
->base_volume
= pa_sw_volume_from_dB(-u
->mixer_path
->max_dB
);
1326 u
->source
->n_volume_steps
= PA_VOLUME_NORM
+1;
1328 pa_log_info("Fixing base volume to %0.2f dB", pa_sw_volume_to_dB(u
->source
->base_volume
));
1330 pa_source_enable_decibel_volume(u
->source
, FALSE
);
1331 pa_log_info("Hardware volume ranges from %li to %li.", u
->mixer_path
->min_volume
, u
->mixer_path
->max_volume
);
1333 u
->source
->base_volume
= PA_VOLUME_NORM
;
1334 u
->source
->n_volume_steps
= u
->mixer_path
->max_volume
- u
->mixer_path
->min_volume
+ 1;
1337 pa_log_info("Using hardware volume control. Hardware dB scale %s.", u
->mixer_path
->has_dB
? "supported" : "not supported");
1340 if (!u
->mixer_path
->has_mute
) {
1341 pa_source_set_get_mute_callback(u
->source
, NULL
);
1342 pa_source_set_set_mute_callback(u
->source
, NULL
);
1343 pa_log_info("Driver does not support hardware mute control, falling back to software mute control.");
1345 pa_source_set_get_mute_callback(u
->source
, source_get_mute_cb
);
1346 pa_source_set_set_mute_callback(u
->source
, source_set_mute_cb
);
1347 pa_log_info("Using hardware mute control.");
1351 static int source_set_port_cb(pa_source
*s
, pa_device_port
*p
) {
1352 struct userdata
*u
= s
->userdata
;
1353 pa_alsa_port_data
*data
;
1357 pa_assert(u
->mixer_handle
);
1359 data
= PA_DEVICE_PORT_DATA(p
);
1361 pa_assert_se(u
->mixer_path
= data
->path
);
1362 pa_alsa_path_select(u
->mixer_path
, u
->mixer_handle
);
1364 mixer_volume_init(u
);
1367 pa_alsa_setting_select(data
->setting
, u
->mixer_handle
);
1377 static void source_update_requested_latency_cb(pa_source
*s
) {
1378 struct userdata
*u
= s
->userdata
;
1380 pa_assert(u
->use_tsched
); /* only when timer scheduling is used
1381 * we can dynamically adjust the
1387 update_sw_params(u
);
1390 static pa_bool_t
source_update_rate_cb(pa_source
*s
, uint32_t rate
)
1392 struct userdata
*u
= s
->userdata
;
1394 pa_bool_t supported
= FALSE
;
1398 for (i
= 0; u
->rates
[i
]; i
++) {
1399 if (u
->rates
[i
] == rate
) {
1406 pa_log_info("Sink does not support sample rate of %d Hz", rate
);
1410 if (!PA_SOURCE_IS_OPENED(s
->state
)) {
1411 pa_log_info("Updating rate for device %s, new rate is %d", u
->device_name
, rate
);
1412 u
->source
->sample_spec
.rate
= rate
;
1419 static void thread_func(void *userdata
) {
1420 struct userdata
*u
= userdata
;
1421 unsigned short revents
= 0;
1425 pa_log_debug("Thread starting up");
1427 if (u
->core
->realtime_scheduling
)
1428 pa_make_realtime(u
->core
->realtime_priority
);
1430 pa_thread_mq_install(&u
->thread_mq
);
1434 pa_usec_t rtpoll_sleep
= 0;
1437 pa_log_debug("Loop");
1440 /* Read some data and pass it to the sources */
1441 if (PA_SOURCE_IS_OPENED(u
->source
->thread_info
.state
)) {
1443 pa_usec_t sleep_usec
= 0;
1444 pa_bool_t on_timeout
= pa_rtpoll_timer_elapsed(u
->rtpoll
);
1447 pa_log_info("Starting capture.");
1448 snd_pcm_start(u
->pcm_handle
);
1450 pa_smoother_resume(u
->smoother
, pa_rtclock_now(), TRUE
);
1456 work_done
= mmap_read(u
, &sleep_usec
, revents
& POLLIN
, on_timeout
);
1458 work_done
= unix_read(u
, &sleep_usec
, revents
& POLLIN
, on_timeout
);
1463 /* pa_log_debug("work_done = %i", work_done); */
1468 if (u
->use_tsched
) {
1471 /* OK, the capture buffer is now empty, let's
1472 * calculate when to wake up next */
1474 /* pa_log_debug("Waking up in %0.2fms (sound card clock).", (double) sleep_usec / PA_USEC_PER_MSEC); */
1476 /* Convert from the sound card time domain to the
1477 * system time domain */
1478 cusec
= pa_smoother_translate(u
->smoother
, pa_rtclock_now(), sleep_usec
);
1480 /* pa_log_debug("Waking up in %0.2fms (system clock).", (double) cusec / PA_USEC_PER_MSEC); */
1482 /* We don't trust the conversion, so we wake up whatever comes first */
1483 rtpoll_sleep
= PA_MIN(sleep_usec
, cusec
);
1487 if (u
->source
->flags
& PA_SOURCE_DEFERRED_VOLUME
) {
1488 pa_usec_t volume_sleep
;
1489 pa_source_volume_change_apply(u
->source
, &volume_sleep
);
1490 if (volume_sleep
> 0) {
1491 if (rtpoll_sleep
> 0)
1492 rtpoll_sleep
= PA_MIN(volume_sleep
, rtpoll_sleep
);
1494 rtpoll_sleep
= volume_sleep
;
1498 if (rtpoll_sleep
> 0)
1499 pa_rtpoll_set_timer_relative(u
->rtpoll
, rtpoll_sleep
);
1501 pa_rtpoll_set_timer_disabled(u
->rtpoll
);
1503 /* Hmm, nothing to do. Let's sleep */
1504 if ((ret
= pa_rtpoll_run(u
->rtpoll
, TRUE
)) < 0)
1507 if (u
->source
->flags
& PA_SOURCE_DEFERRED_VOLUME
)
1508 pa_source_volume_change_apply(u
->source
, NULL
);
1513 /* Tell ALSA about this and process its response */
1514 if (PA_SOURCE_IS_OPENED(u
->source
->thread_info
.state
)) {
1515 struct pollfd
*pollfd
;
1519 pollfd
= pa_rtpoll_item_get_pollfd(u
->alsa_rtpoll_item
, &n
);
1521 if ((err
= snd_pcm_poll_descriptors_revents(u
->pcm_handle
, pollfd
, n
, &revents
)) < 0) {
1522 pa_log("snd_pcm_poll_descriptors_revents() failed: %s", pa_alsa_strerror(err
));
1526 if (revents
& ~POLLIN
) {
1527 if (pa_alsa_recover_from_poll(u
->pcm_handle
, revents
) < 0)
1532 } else if (revents
&& u
->use_tsched
&& pa_log_ratelimit(PA_LOG_DEBUG
))
1533 pa_log_debug("Wakeup from ALSA!");
1540 /* If this was no regular exit from the loop we have to continue
1541 * processing messages until we received PA_MESSAGE_SHUTDOWN */
1542 pa_asyncmsgq_post(u
->thread_mq
.outq
, PA_MSGOBJECT(u
->core
), PA_CORE_MESSAGE_UNLOAD_MODULE
, u
->module
, 0, NULL
, NULL
);
1543 pa_asyncmsgq_wait_for(u
->thread_mq
.inq
, PA_MESSAGE_SHUTDOWN
);
1546 pa_log_debug("Thread shutting down");
1549 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
) {
1555 pa_assert(device_name
);
1557 if ((n
= pa_modargs_get_value(ma
, "source_name", NULL
))) {
1558 pa_source_new_data_set_name(data
, n
);
1559 data
->namereg_fail
= TRUE
;
1563 if ((n
= pa_modargs_get_value(ma
, "name", NULL
)))
1564 data
->namereg_fail
= TRUE
;
1566 n
= device_id
? device_id
: device_name
;
1567 data
->namereg_fail
= FALSE
;
1571 t
= pa_sprintf_malloc("alsa_input.%s.%s", n
, mapping
->name
);
1573 t
= pa_sprintf_malloc("alsa_input.%s", n
);
1575 pa_source_new_data_set_name(data
, t
);
1579 static void find_mixer(struct userdata
*u
, pa_alsa_mapping
*mapping
, const char *element
, pa_bool_t ignore_dB
) {
1582 if (!mapping
&& !element
)
1585 if (!(u
->mixer_handle
= pa_alsa_open_mixer_for_pcm(u
->pcm_handle
, &u
->control_device
, &hctl
))) {
1586 pa_log_info("Failed to find a working mixer device.");
1592 if (!(u
->mixer_path
= pa_alsa_path_synthesize(element
, PA_ALSA_DIRECTION_INPUT
)))
1595 if (pa_alsa_path_probe(u
->mixer_path
, u
->mixer_handle
, hctl
, ignore_dB
) < 0)
1598 pa_log_debug("Probed mixer path %s:", u
->mixer_path
->name
);
1599 pa_alsa_path_dump(u
->mixer_path
);
1600 } else if (!(u
->mixer_path_set
= mapping
->input_path_set
))
1607 if (u
->mixer_path
) {
1608 pa_alsa_path_free(u
->mixer_path
);
1609 u
->mixer_path
= NULL
;
1612 if (u
->mixer_handle
) {
1613 snd_mixer_close(u
->mixer_handle
);
1614 u
->mixer_handle
= NULL
;
1618 static int setup_mixer(struct userdata
*u
, pa_bool_t ignore_dB
) {
1619 pa_bool_t need_mixer_callback
= FALSE
;
1623 if (!u
->mixer_handle
)
1626 if (u
->source
->active_port
) {
1627 pa_alsa_port_data
*data
;
1629 /* We have a list of supported paths, so let's activate the
1630 * one that has been chosen as active */
1632 data
= PA_DEVICE_PORT_DATA(u
->source
->active_port
);
1633 u
->mixer_path
= data
->path
;
1635 pa_alsa_path_select(data
->path
, u
->mixer_handle
);
1638 pa_alsa_setting_select(data
->setting
, u
->mixer_handle
);
1642 if (!u
->mixer_path
&& u
->mixer_path_set
)
1643 u
->mixer_path
= pa_hashmap_first(u
->mixer_path_set
->paths
);
1645 if (u
->mixer_path
) {
1646 /* Hmm, we have only a single path, then let's activate it */
1648 pa_alsa_path_select(u
->mixer_path
, u
->mixer_handle
);
1650 if (u
->mixer_path
->settings
)
1651 pa_alsa_setting_select(u
->mixer_path
->settings
, u
->mixer_handle
);
1656 mixer_volume_init(u
);
1658 /* Will we need to register callbacks? */
1659 if (u
->mixer_path_set
&& u
->mixer_path_set
->paths
) {
1663 PA_HASHMAP_FOREACH(p
, u
->mixer_path_set
->paths
, state
) {
1664 if (p
->has_volume
|| p
->has_mute
)
1665 need_mixer_callback
= TRUE
;
1668 else if (u
->mixer_path
)
1669 need_mixer_callback
= u
->mixer_path
->has_volume
|| u
->mixer_path
->has_mute
;
1671 if (need_mixer_callback
) {
1672 int (*mixer_callback
)(snd_mixer_elem_t
*, unsigned int);
1673 if (u
->source
->flags
& PA_SOURCE_DEFERRED_VOLUME
) {
1674 u
->mixer_pd
= pa_alsa_mixer_pdata_new();
1675 mixer_callback
= io_mixer_callback
;
1677 if (pa_alsa_set_mixer_rtpoll(u
->mixer_pd
, u
->mixer_handle
, u
->rtpoll
) < 0) {
1678 pa_log("Failed to initialize file descriptor monitoring");
1682 u
->mixer_fdl
= pa_alsa_fdlist_new();
1683 mixer_callback
= ctl_mixer_callback
;
1685 if (pa_alsa_fdlist_set_handle(u
->mixer_fdl
, u
->mixer_handle
, NULL
, u
->core
->mainloop
) < 0) {
1686 pa_log("Failed to initialize file descriptor monitoring");
1691 if (u
->mixer_path_set
)
1692 pa_alsa_path_set_set_callback(u
->mixer_path_set
, u
->mixer_handle
, mixer_callback
, u
);
1694 pa_alsa_path_set_callback(u
->mixer_path
, u
->mixer_handle
, mixer_callback
, u
);
1700 pa_source
*pa_alsa_source_new(pa_module
*m
, pa_modargs
*ma
, const char*driver
, pa_card
*card
, pa_alsa_mapping
*mapping
) {
1702 struct userdata
*u
= NULL
;
1703 const char *dev_id
= NULL
;
1705 uint32_t alternate_sample_rate
;
1707 uint32_t nfrags
, frag_size
, buffer_size
, tsched_size
, tsched_watermark
;
1708 snd_pcm_uframes_t period_frames
, buffer_frames
, tsched_frames
;
1710 pa_bool_t use_mmap
= TRUE
, b
, use_tsched
= TRUE
, d
, ignore_dB
= FALSE
, namereg_fail
= FALSE
, deferred_volume
= FALSE
, fixed_latency_range
= FALSE
;
1711 pa_source_new_data data
;
1712 pa_alsa_profile_set
*profile_set
= NULL
;
1717 ss
= m
->core
->default_sample_spec
;
1718 map
= m
->core
->default_channel_map
;
1719 if (pa_modargs_get_sample_spec_and_channel_map(ma
, &ss
, &map
, PA_CHANNEL_MAP_ALSA
) < 0) {
1720 pa_log("Failed to parse sample specification and channel map");
1724 alternate_sample_rate
= m
->core
->alternate_sample_rate
;
1725 if (pa_modargs_get_alternate_sample_rate(ma
, &alternate_sample_rate
) < 0) {
1726 pa_log("Failed to parse alternate sample rate");
1730 frame_size
= pa_frame_size(&ss
);
1732 nfrags
= m
->core
->default_n_fragments
;
1733 frag_size
= (uint32_t) pa_usec_to_bytes(m
->core
->default_fragment_size_msec
*PA_USEC_PER_MSEC
, &ss
);
1735 frag_size
= (uint32_t) frame_size
;
1736 tsched_size
= (uint32_t) pa_usec_to_bytes(DEFAULT_TSCHED_BUFFER_USEC
, &ss
);
1737 tsched_watermark
= (uint32_t) pa_usec_to_bytes(DEFAULT_TSCHED_WATERMARK_USEC
, &ss
);
1739 if (pa_modargs_get_value_u32(ma
, "fragments", &nfrags
) < 0 ||
1740 pa_modargs_get_value_u32(ma
, "fragment_size", &frag_size
) < 0 ||
1741 pa_modargs_get_value_u32(ma
, "tsched_buffer_size", &tsched_size
) < 0 ||
1742 pa_modargs_get_value_u32(ma
, "tsched_buffer_watermark", &tsched_watermark
) < 0) {
1743 pa_log("Failed to parse buffer metrics");
1747 buffer_size
= nfrags
* frag_size
;
1749 period_frames
= frag_size
/frame_size
;
1750 buffer_frames
= buffer_size
/frame_size
;
1751 tsched_frames
= tsched_size
/frame_size
;
1753 if (pa_modargs_get_value_boolean(ma
, "mmap", &use_mmap
) < 0) {
1754 pa_log("Failed to parse mmap argument.");
1758 if (pa_modargs_get_value_boolean(ma
, "tsched", &use_tsched
) < 0) {
1759 pa_log("Failed to parse tsched argument.");
1763 if (pa_modargs_get_value_boolean(ma
, "ignore_dB", &ignore_dB
) < 0) {
1764 pa_log("Failed to parse ignore_dB argument.");
1768 deferred_volume
= m
->core
->deferred_volume
;
1769 if (pa_modargs_get_value_boolean(ma
, "deferred_volume", &deferred_volume
) < 0) {
1770 pa_log("Failed to parse deferred_volume argument.");
1774 if (pa_modargs_get_value_boolean(ma
, "fixed_latency_range", &fixed_latency_range
) < 0) {
1775 pa_log("Failed to parse fixed_latency_range argument.");
1779 use_tsched
= pa_alsa_may_tsched(use_tsched
);
1781 u
= pa_xnew0(struct userdata
, 1);
1784 u
->use_mmap
= use_mmap
;
1785 u
->use_tsched
= use_tsched
;
1786 u
->deferred_volume
= deferred_volume
;
1787 u
->fixed_latency_range
= fixed_latency_range
;
1789 u
->rtpoll
= pa_rtpoll_new();
1790 pa_thread_mq_init(&u
->thread_mq
, m
->core
->mainloop
, u
->rtpoll
);
1792 u
->smoother
= pa_smoother_new(
1793 SMOOTHER_ADJUST_USEC
,
1794 SMOOTHER_WINDOW_USEC
,
1800 u
->smoother_interval
= SMOOTHER_MIN_INTERVAL
;
1802 dev_id
= pa_modargs_get_value(
1804 pa_modargs_get_value(ma
, "device", DEFAULT_DEVICE
));
1806 u
->paths_dir
= pa_xstrdup(pa_modargs_get_value(ma
, "paths_dir", NULL
));
1808 if (reserve_init(u
, dev_id
) < 0)
1811 if (reserve_monitor_init(u
, dev_id
) < 0)
1819 if (!(dev_id
= pa_modargs_get_value(ma
, "device_id", NULL
))) {
1820 pa_log("device_id= not set");
1824 if (!(u
->pcm_handle
= pa_alsa_open_by_device_id_mapping(
1828 SND_PCM_STREAM_CAPTURE
,
1829 &period_frames
, &buffer_frames
, tsched_frames
,
1833 } else if ((dev_id
= pa_modargs_get_value(ma
, "device_id", NULL
))) {
1835 if (!(profile_set
= pa_alsa_profile_set_new(NULL
, &map
)))
1838 if (!(u
->pcm_handle
= pa_alsa_open_by_device_id_auto(
1842 SND_PCM_STREAM_CAPTURE
,
1843 &period_frames
, &buffer_frames
, tsched_frames
,
1844 &b
, &d
, profile_set
, &mapping
)))
1849 if (!(u
->pcm_handle
= pa_alsa_open_by_device_string(
1850 pa_modargs_get_value(ma
, "device", DEFAULT_DEVICE
),
1853 SND_PCM_STREAM_CAPTURE
,
1854 &period_frames
, &buffer_frames
, tsched_frames
,
1859 pa_assert(u
->device_name
);
1860 pa_log_info("Successfully opened device %s.", u
->device_name
);
1862 if (pa_alsa_pcm_is_modem(u
->pcm_handle
)) {
1863 pa_log_notice("Device %s is modem, refusing further initialization.", u
->device_name
);
1868 pa_log_info("Selected mapping '%s' (%s).", mapping
->description
, mapping
->name
);
1870 if (use_mmap
&& !b
) {
1871 pa_log_info("Device doesn't support mmap(), falling back to UNIX read/write mode.");
1872 u
->use_mmap
= use_mmap
= FALSE
;
1875 if (use_tsched
&& (!b
|| !d
)) {
1876 pa_log_info("Cannot enable timer-based scheduling, falling back to sound IRQ scheduling.");
1877 u
->use_tsched
= use_tsched
= FALSE
;
1881 pa_log_info("Successfully enabled mmap() mode.");
1883 if (u
->use_tsched
) {
1884 pa_log_info("Successfully enabled timer-based scheduling mode.");
1885 if (u
->fixed_latency_range
)
1886 pa_log_info("Disabling latency range changes on overrun");
1889 u
->rates
= pa_alsa_get_supported_rates(u
->pcm_handle
);
1891 pa_log_error("Failed to find any supported sample rates.");
1895 /* ALSA might tweak the sample spec, so recalculate the frame size */
1896 frame_size
= pa_frame_size(&ss
);
1898 find_mixer(u
, mapping
, pa_modargs_get_value(ma
, "control", NULL
), ignore_dB
);
1900 pa_source_new_data_init(&data
);
1901 data
.driver
= driver
;
1904 set_source_name(&data
, ma
, dev_id
, u
->device_name
, mapping
);
1906 /* We need to give pa_modargs_get_value_boolean() a pointer to a local
1907 * variable instead of using &data.namereg_fail directly, because
1908 * data.namereg_fail is a bitfield and taking the address of a bitfield
1909 * variable is impossible. */
1910 namereg_fail
= data
.namereg_fail
;
1911 if (pa_modargs_get_value_boolean(ma
, "namereg_fail", &namereg_fail
) < 0) {
1912 pa_log("Failed to parse namereg_fail argument.");
1913 pa_source_new_data_done(&data
);
1916 data
.namereg_fail
= namereg_fail
;
1918 pa_source_new_data_set_sample_spec(&data
, &ss
);
1919 pa_source_new_data_set_channel_map(&data
, &map
);
1920 pa_source_new_data_set_alternate_sample_rate(&data
, alternate_sample_rate
);
1922 pa_alsa_init_proplist_pcm(m
->core
, data
.proplist
, u
->pcm_handle
);
1923 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_STRING
, u
->device_name
);
1924 pa_proplist_setf(data
.proplist
, PA_PROP_DEVICE_BUFFERING_BUFFER_SIZE
, "%lu", (unsigned long) (buffer_frames
* frame_size
));
1925 pa_proplist_setf(data
.proplist
, PA_PROP_DEVICE_BUFFERING_FRAGMENT_SIZE
, "%lu", (unsigned long) (period_frames
* frame_size
));
1926 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_ACCESS_MODE
, u
->use_tsched
? "mmap+timer" : (u
->use_mmap
? "mmap" : "serial"));
1929 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_PROFILE_NAME
, mapping
->name
);
1930 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_PROFILE_DESCRIPTION
, mapping
->description
);
1933 pa_alsa_init_description(data
.proplist
);
1935 if (u
->control_device
)
1936 pa_alsa_init_proplist_ctl(data
.proplist
, u
->control_device
);
1938 if (pa_modargs_get_proplist(ma
, "source_properties", data
.proplist
, PA_UPDATE_REPLACE
) < 0) {
1939 pa_log("Invalid properties");
1940 pa_source_new_data_done(&data
);
1944 if (u
->mixer_path_set
)
1945 pa_alsa_add_ports(&data
.ports
, u
->mixer_path_set
, card
);
1947 u
->source
= pa_source_new(m
->core
, &data
, PA_SOURCE_HARDWARE
|PA_SOURCE_LATENCY
|(u
->use_tsched
? PA_SOURCE_DYNAMIC_LATENCY
: 0));
1948 pa_source_new_data_done(&data
);
1951 pa_log("Failed to create source object");
1955 if (pa_modargs_get_value_u32(ma
, "deferred_volume_safety_margin",
1956 &u
->source
->thread_info
.volume_change_safety_margin
) < 0) {
1957 pa_log("Failed to parse deferred_volume_safety_margin parameter");
1961 if (pa_modargs_get_value_s32(ma
, "deferred_volume_extra_delay",
1962 &u
->source
->thread_info
.volume_change_extra_delay
) < 0) {
1963 pa_log("Failed to parse deferred_volume_extra_delay parameter");
1967 u
->source
->parent
.process_msg
= source_process_msg
;
1969 u
->source
->update_requested_latency
= source_update_requested_latency_cb
;
1970 u
->source
->set_state
= source_set_state_cb
;
1971 u
->source
->set_port
= source_set_port_cb
;
1972 if (u
->source
->alternate_sample_rate
)
1973 u
->source
->update_rate
= source_update_rate_cb
;
1974 u
->source
->userdata
= u
;
1976 pa_source_set_asyncmsgq(u
->source
, u
->thread_mq
.inq
);
1977 pa_source_set_rtpoll(u
->source
, u
->rtpoll
);
1979 u
->frame_size
= frame_size
;
1980 u
->fragment_size
= frag_size
= (size_t) (period_frames
* frame_size
);
1981 u
->hwbuf_size
= buffer_size
= (size_t) (buffer_frames
* frame_size
);
1982 pa_cvolume_mute(&u
->hardware_volume
, u
->source
->sample_spec
.channels
);
1984 pa_log_info("Using %0.1f fragments of size %lu bytes (%0.2fms), buffer size is %lu bytes (%0.2fms)",
1985 (double) u
->hwbuf_size
/ (double) u
->fragment_size
,
1986 (long unsigned) u
->fragment_size
,
1987 (double) pa_bytes_to_usec(u
->fragment_size
, &ss
) / PA_USEC_PER_MSEC
,
1988 (long unsigned) u
->hwbuf_size
,
1989 (double) pa_bytes_to_usec(u
->hwbuf_size
, &ss
) / PA_USEC_PER_MSEC
);
1991 if (u
->use_tsched
) {
1992 u
->tsched_watermark_ref
= tsched_watermark
;
1993 reset_watermark(u
, u
->tsched_watermark_ref
, &ss
, FALSE
);
1996 pa_source_set_fixed_latency(u
->source
, pa_bytes_to_usec(u
->hwbuf_size
, &ss
));
2000 if (update_sw_params(u
) < 0)
2003 if (setup_mixer(u
, ignore_dB
) < 0)
2006 pa_alsa_dump(PA_LOG_DEBUG
, u
->pcm_handle
);
2008 if (!(u
->thread
= pa_thread_new("alsa-source", thread_func
, u
))) {
2009 pa_log("Failed to create thread.");
2013 /* Get initial mixer settings */
2014 if (data
.volume_is_set
) {
2015 if (u
->source
->set_volume
)
2016 u
->source
->set_volume(u
->source
);
2018 if (u
->source
->get_volume
)
2019 u
->source
->get_volume(u
->source
);
2022 if (data
.muted_is_set
) {
2023 if (u
->source
->set_mute
)
2024 u
->source
->set_mute(u
->source
);
2026 if (u
->source
->get_mute
)
2027 u
->source
->get_mute(u
->source
);
2030 if ((data
.volume_is_set
|| data
.muted_is_set
) && u
->source
->write_volume
)
2031 u
->source
->write_volume(u
->source
);
2033 pa_source_put(u
->source
);
2036 pa_alsa_profile_set_free(profile_set
);
2046 pa_alsa_profile_set_free(profile_set
);
2051 static void userdata_free(struct userdata
*u
) {
2055 pa_source_unlink(u
->source
);
2058 pa_asyncmsgq_send(u
->thread_mq
.inq
, NULL
, PA_MESSAGE_SHUTDOWN
, NULL
, 0, NULL
);
2059 pa_thread_free(u
->thread
);
2062 pa_thread_mq_done(&u
->thread_mq
);
2065 pa_source_unref(u
->source
);
2068 pa_alsa_mixer_pdata_free(u
->mixer_pd
);
2070 if (u
->alsa_rtpoll_item
)
2071 pa_rtpoll_item_free(u
->alsa_rtpoll_item
);
2074 pa_rtpoll_free(u
->rtpoll
);
2076 if (u
->pcm_handle
) {
2077 snd_pcm_drop(u
->pcm_handle
);
2078 snd_pcm_close(u
->pcm_handle
);
2082 pa_alsa_fdlist_free(u
->mixer_fdl
);
2084 if (u
->mixer_path
&& !u
->mixer_path_set
)
2085 pa_alsa_path_free(u
->mixer_path
);
2087 if (u
->mixer_handle
)
2088 snd_mixer_close(u
->mixer_handle
);
2091 pa_smoother_free(u
->smoother
);
2099 pa_xfree(u
->device_name
);
2100 pa_xfree(u
->control_device
);
2101 pa_xfree(u
->paths_dir
);
2105 void pa_alsa_source_free(pa_source
*s
) {
2108 pa_source_assert_ref(s
);
2109 pa_assert_se(u
= s
->userdata
);