2 This file is part of PulseAudio.
4 Copyright 2004-2008 Lennart Poettering
5 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
7 PulseAudio is free software; you can redistribute it and/or modify
8 it under the terms of the GNU Lesser General Public License as published
9 by the Free Software Foundation; either version 2 of the License,
10 or (at your option) any later version.
12 PulseAudio is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 General Public License for more details.
17 You should have received a copy of the GNU Lesser General Public License
18 along with PulseAudio; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
29 #include <asoundlib.h>
31 #ifdef HAVE_VALGRIND_MEMCHECK_H
32 #include <valgrind/memcheck.h>
35 #include <pulse/xmalloc.h>
36 #include <pulse/util.h>
37 #include <pulse/timeval.h>
39 #include <pulsecore/core-error.h>
40 #include <pulsecore/core.h>
41 #include <pulsecore/module.h>
42 #include <pulsecore/memchunk.h>
43 #include <pulsecore/sink.h>
44 #include <pulsecore/modargs.h>
45 #include <pulsecore/core-util.h>
46 #include <pulsecore/sample-util.h>
47 #include <pulsecore/log.h>
48 #include <pulsecore/macro.h>
49 #include <pulsecore/thread.h>
50 #include <pulsecore/core-error.h>
51 #include <pulsecore/thread-mq.h>
52 #include <pulsecore/rtpoll.h>
53 #include <pulsecore/time-smoother.h>
54 #include <pulsecore/rtclock.h>
56 #include "alsa-util.h"
57 #include "alsa-source.h"
59 #define DEFAULT_DEVICE "default"
60 #define DEFAULT_TSCHED_BUFFER_USEC (2*PA_USEC_PER_SEC) /* 2s */
61 #define DEFAULT_TSCHED_WATERMARK_USEC (20*PA_USEC_PER_MSEC) /* 20ms */
62 #define TSCHED_MIN_SLEEP_USEC (3*PA_USEC_PER_MSEC) /* 3ms */
63 #define TSCHED_MIN_WAKEUP_USEC (3*PA_USEC_PER_MSEC) /* 3ms */
71 pa_thread_mq thread_mq
;
74 snd_pcm_t
*pcm_handle
;
76 pa_alsa_fdlist
*mixer_fdl
;
77 snd_mixer_t
*mixer_handle
;
78 snd_mixer_elem_t
*mixer_elem
;
79 long hw_volume_max
, hw_volume_min
;
80 long hw_dB_max
, hw_dB_min
;
81 pa_bool_t hw_dB_supported
;
82 pa_bool_t mixer_seperate_channels
;
84 pa_cvolume hardware_volume
;
86 size_t frame_size
, fragment_size
, hwbuf_size
, tsched_watermark
;
91 pa_bool_t use_mmap
, use_tsched
;
93 pa_rtpoll_item
*alsa_rtpoll_item
;
95 snd_mixer_selem_channel_id_t mixer_map
[SND_MIXER_SCHN_LAST
];
97 pa_smoother
*smoother
;
100 snd_pcm_sframes_t hwbuf_unused_frames
;
103 static void userdata_free(struct userdata
*u
);
105 static void fix_tsched_watermark(struct userdata
*u
) {
107 size_t min_sleep
, min_wakeup
;
110 max_use
= u
->hwbuf_size
- (size_t) u
->hwbuf_unused_frames
* u
->frame_size
;
112 min_sleep
= pa_usec_to_bytes(TSCHED_MIN_SLEEP_USEC
, &u
->source
->sample_spec
);
113 min_wakeup
= pa_usec_to_bytes(TSCHED_MIN_WAKEUP_USEC
, &u
->source
->sample_spec
);
115 if (min_sleep
> max_use
/2)
116 min_sleep
= pa_frame_align(max_use
/2, &u
->source
->sample_spec
);
117 if (min_sleep
< u
->frame_size
)
118 min_sleep
= u
->frame_size
;
120 if (min_wakeup
> max_use
/2)
121 min_wakeup
= pa_frame_align(max_use
/2, &u
->source
->sample_spec
);
122 if (min_wakeup
< u
->frame_size
)
123 min_wakeup
= u
->frame_size
;
125 if (u
->tsched_watermark
> max_use
-min_sleep
)
126 u
->tsched_watermark
= max_use
-min_sleep
;
128 if (u
->tsched_watermark
< min_wakeup
)
129 u
->tsched_watermark
= min_wakeup
;
132 static pa_usec_t
hw_sleep_time(struct userdata
*u
, pa_usec_t
*sleep_usec
, pa_usec_t
*process_usec
) {
137 usec
= pa_source_get_requested_latency_within_thread(u
->source
);
139 if (usec
== (pa_usec_t
) -1)
140 usec
= pa_bytes_to_usec(u
->hwbuf_size
, &u
->source
->sample_spec
);
142 /* pa_log_debug("hw buffer time: %u ms", (unsigned) (usec / PA_USEC_PER_MSEC)); */
144 wm
= pa_bytes_to_usec(u
->tsched_watermark
, &u
->source
->sample_spec
);
147 *sleep_usec
= usec
- wm
;
150 *process_usec
= *sleep_usec
= usec
/= 2;
152 /* pa_log_debug("after watermark: %u ms", (unsigned) (*sleep_usec / PA_USEC_PER_MSEC)); */
157 static int try_recover(struct userdata
*u
, const char *call
, int err
) {
162 pa_log_debug("%s: %s", call
, snd_strerror(err
));
164 pa_assert(err
!= -EAGAIN
);
167 pa_log_debug("%s: Buffer overrun!", call
);
169 if ((err
= snd_pcm_recover(u
->pcm_handle
, err
, 1)) == 0) {
170 snd_pcm_start(u
->pcm_handle
);
174 pa_log("%s: %s", call
, snd_strerror(err
));
178 static size_t check_left_to_record(struct userdata
*u
, snd_pcm_sframes_t n
) {
179 size_t left_to_record
;
180 size_t rec_space
= u
->hwbuf_size
- (size_t) u
->hwbuf_unused_frames
*u
->frame_size
;
182 if ((size_t) n
*u
->frame_size
< rec_space
)
183 left_to_record
= rec_space
- ((size_t) n
*u
->frame_size
);
187 if (left_to_record
> 0) {
188 /* pa_log_debug("%0.2f ms left to record", (double) pa_bytes_to_usec(left_to_record, &u->source->sample_spec) / PA_USEC_PER_MSEC); */
190 if (pa_log_ratelimit())
191 pa_log_info("Overrun!");
194 size_t old_watermark
= u
->tsched_watermark
;
196 u
->tsched_watermark
*= 2;
197 fix_tsched_watermark(u
);
199 if (old_watermark
!= u
->tsched_watermark
)
200 pa_log_notice("Increasing wakeup watermark to %0.2f ms",
201 (double) pa_bytes_to_usec(u
->tsched_watermark
, &u
->source
->sample_spec
) / PA_USEC_PER_MSEC
);
205 return left_to_record
;
208 static int mmap_read(struct userdata
*u
, pa_usec_t
*sleep_usec
, pa_bool_t polled
) {
210 pa_usec_t max_sleep_usec
= 0, process_usec
= 0;
211 size_t left_to_record
;
214 pa_source_assert_ref(u
->source
);
217 hw_sleep_time(u
, &max_sleep_usec
, &process_usec
);
223 snd_pcm_hwsync(u
->pcm_handle
);
225 if (PA_UNLIKELY((n
= pa_alsa_safe_avail_update(u
->pcm_handle
, u
->hwbuf_size
, &u
->source
->sample_spec
)) < 0)) {
227 if ((r
= try_recover(u
, "snd_pcm_avail_update", (int) n
)) == 0)
233 left_to_record
= check_left_to_record(u
, n
);
237 pa_bytes_to_usec(left_to_record
, &u
->source
->sample_spec
) > process_usec
+max_sleep_usec
/2)
240 if (PA_UNLIKELY(n
<= 0)) {
242 if (polled
&& pa_log_ratelimit())
243 pa_log("ALSA woke us up to read new data from the device, but there was actually nothing to read! "
244 "Most likely this is an ALSA driver bug. Please report this issue to the ALSA developers. "
245 "We were woken up with POLLIN set -- however a subsequent snd_pcm_avail_update() returned 0.");
254 const snd_pcm_channel_area_t
*areas
;
255 snd_pcm_uframes_t offset
, frames
= (snd_pcm_uframes_t
) n
;
258 snd_pcm_sframes_t sframes
;
260 /* pa_log_debug("%lu frames to read", (unsigned long) frames); */
262 if (PA_UNLIKELY((err
= pa_alsa_safe_mmap_begin(u
->pcm_handle
, &areas
, &offset
, &frames
, u
->hwbuf_size
, &u
->source
->sample_spec
)) < 0)) {
264 if ((r
= try_recover(u
, "snd_pcm_mmap_begin", err
)) == 0)
270 /* Make sure that if these memblocks need to be copied they will fit into one slot */
271 if (frames
> pa_mempool_block_size_max(u
->source
->core
->mempool
)/u
->frame_size
)
272 frames
= pa_mempool_block_size_max(u
->source
->core
->mempool
)/u
->frame_size
;
274 /* Check these are multiples of 8 bit */
275 pa_assert((areas
[0].first
& 7) == 0);
276 pa_assert((areas
[0].step
& 7)== 0);
278 /* We assume a single interleaved memory buffer */
279 pa_assert((areas
[0].first
>> 3) == 0);
280 pa_assert((areas
[0].step
>> 3) == u
->frame_size
);
282 p
= (uint8_t*) areas
[0].addr
+ (offset
* u
->frame_size
);
284 chunk
.memblock
= pa_memblock_new_fixed(u
->core
->mempool
, p
, frames
* u
->frame_size
, TRUE
);
285 chunk
.length
= pa_memblock_get_length(chunk
.memblock
);
288 pa_source_post(u
->source
, &chunk
);
289 pa_memblock_unref_fixed(chunk
.memblock
);
291 if (PA_UNLIKELY((sframes
= snd_pcm_mmap_commit(u
->pcm_handle
, offset
, frames
)) < 0)) {
293 if ((r
= try_recover(u
, "snd_pcm_mmap_commit", (int) sframes
)) == 0)
301 u
->frame_index
+= (int64_t) frames
;
303 /* pa_log_debug("read %lu frames", (unsigned long) frames); */
305 if (frames
>= (snd_pcm_uframes_t
) n
)
308 n
-= (snd_pcm_sframes_t
) frames
;
312 *sleep_usec
= pa_bytes_to_usec(left_to_record
, &u
->source
->sample_spec
) - process_usec
;
316 static int unix_read(struct userdata
*u
, pa_usec_t
*sleep_usec
, pa_bool_t polled
) {
318 pa_usec_t max_sleep_usec
= 0, process_usec
= 0;
319 size_t left_to_record
;
322 pa_source_assert_ref(u
->source
);
325 hw_sleep_time(u
, &max_sleep_usec
, &process_usec
);
331 snd_pcm_hwsync(u
->pcm_handle
);
333 if (PA_UNLIKELY((n
= pa_alsa_safe_avail_update(u
->pcm_handle
, u
->hwbuf_size
, &u
->source
->sample_spec
)) < 0)) {
335 if ((r
= try_recover(u
, "snd_pcm_avail_update", (int) n
)) == 0)
341 left_to_record
= check_left_to_record(u
, n
);
345 pa_bytes_to_usec(left_to_record
, &u
->source
->sample_spec
) > process_usec
+max_sleep_usec
/2)
348 if (PA_UNLIKELY(n
<= 0)) {
350 if (polled
&& pa_log_ratelimit())
351 pa_log("ALSA woke us up to read new data from the device, but there was actually nothing to read! "
352 "Most likely this is an ALSA driver bug. Please report this issue to the ALSA developers. "
353 "We were woken up with POLLIN set -- however a subsequent snd_pcm_avail_update() returned 0.");
362 snd_pcm_sframes_t frames
;
365 chunk
.memblock
= pa_memblock_new(u
->core
->mempool
, (size_t) -1);
367 frames
= (snd_pcm_sframes_t
) (pa_memblock_get_length(chunk
.memblock
) / u
->frame_size
);
372 /* pa_log_debug("%lu frames to read", (unsigned long) n); */
374 p
= pa_memblock_acquire(chunk
.memblock
);
375 frames
= snd_pcm_readi(u
->pcm_handle
, (uint8_t*) p
, (snd_pcm_uframes_t
) frames
);
376 pa_memblock_release(chunk
.memblock
);
378 pa_assert(frames
!= 0);
380 if (PA_UNLIKELY(frames
< 0)) {
381 pa_memblock_unref(chunk
.memblock
);
383 if ((r
= try_recover(u
, "snd_pcm_readi", (int) (frames
))) == 0)
390 chunk
.length
= (size_t) frames
* u
->frame_size
;
392 pa_source_post(u
->source
, &chunk
);
393 pa_memblock_unref(chunk
.memblock
);
397 u
->frame_index
+= frames
;
399 /* pa_log_debug("read %lu frames", (unsigned long) frames); */
408 *sleep_usec
= pa_bytes_to_usec(left_to_record
, &u
->source
->sample_spec
) - process_usec
;
412 static void update_smoother(struct userdata
*u
) {
413 snd_pcm_sframes_t delay
= 0;
416 pa_usec_t now1
, now2
;
419 pa_assert(u
->pcm_handle
);
421 /* Let's update the time smoother */
423 snd_pcm_hwsync(u
->pcm_handle
);
424 snd_pcm_avail_update(u
->pcm_handle
);
426 if (PA_UNLIKELY((err
= snd_pcm_delay(u
->pcm_handle
, &delay
)) < 0)) {
427 pa_log_warn("Failed to get delay: %s", snd_strerror(err
));
431 frames
= u
->frame_index
+ delay
;
433 now1
= pa_rtclock_usec();
434 now2
= pa_bytes_to_usec((uint64_t) frames
* u
->frame_size
, &u
->source
->sample_spec
);
436 pa_smoother_put(u
->smoother
, now1
, now2
);
439 static pa_usec_t
source_get_latency(struct userdata
*u
) {
442 pa_usec_t now1
, now2
;
446 now1
= pa_rtclock_usec();
447 now2
= pa_smoother_get(u
->smoother
, now1
);
449 delay
= (int64_t) now2
- (int64_t) pa_bytes_to_usec((uint64_t) u
->frame_index
* u
->frame_size
, &u
->source
->sample_spec
);
452 r
= (pa_usec_t
) delay
;
457 static int build_pollfd(struct userdata
*u
) {
459 pa_assert(u
->pcm_handle
);
461 if (u
->alsa_rtpoll_item
)
462 pa_rtpoll_item_free(u
->alsa_rtpoll_item
);
464 if (!(u
->alsa_rtpoll_item
= pa_alsa_build_pollfd(u
->pcm_handle
, u
->rtpoll
)))
470 static int suspend(struct userdata
*u
) {
472 pa_assert(u
->pcm_handle
);
474 pa_smoother_pause(u
->smoother
, pa_rtclock_usec());
477 snd_pcm_close(u
->pcm_handle
);
478 u
->pcm_handle
= NULL
;
480 if (u
->alsa_rtpoll_item
) {
481 pa_rtpoll_item_free(u
->alsa_rtpoll_item
);
482 u
->alsa_rtpoll_item
= NULL
;
485 pa_log_info("Device suspended...");
490 static int update_sw_params(struct userdata
*u
) {
491 snd_pcm_uframes_t avail_min
;
496 /* Use the full buffer if noone asked us for anything specific */
497 u
->hwbuf_unused_frames
= 0;
502 if ((latency
= pa_source_get_requested_latency_within_thread(u
->source
)) != (pa_usec_t
) -1) {
505 pa_log_debug("latency set to %0.2fms", (double) latency
/ PA_USEC_PER_MSEC
);
507 b
= pa_usec_to_bytes(latency
, &u
->source
->sample_spec
);
509 /* We need at least one sample in our buffer */
511 if (PA_UNLIKELY(b
< u
->frame_size
))
514 u
->hwbuf_unused_frames
= (snd_pcm_sframes_t
)
515 (PA_LIKELY(b
< u
->hwbuf_size
) ?
516 ((u
->hwbuf_size
- b
) / u
->frame_size
) : 0);
519 fix_tsched_watermark(u
);
522 pa_log_debug("hwbuf_unused_frames=%lu", (unsigned long) u
->hwbuf_unused_frames
);
527 pa_usec_t sleep_usec
, process_usec
;
529 hw_sleep_time(u
, &sleep_usec
, &process_usec
);
530 avail_min
+= pa_usec_to_bytes(sleep_usec
, &u
->source
->sample_spec
) / u
->frame_size
;
533 pa_log_debug("setting avail_min=%lu", (unsigned long) avail_min
);
535 if ((err
= pa_alsa_set_sw_params(u
->pcm_handle
, avail_min
)) < 0) {
536 pa_log("Failed to set software parameters: %s", snd_strerror(err
));
543 static int unsuspend(struct userdata
*u
) {
548 snd_pcm_uframes_t period_size
;
551 pa_assert(!u
->pcm_handle
);
553 pa_log_info("Trying resume...");
555 snd_config_update_free_global();
557 if ((err
= snd_pcm_open(&u
->pcm_handle
, u
->device_name
, SND_PCM_STREAM_CAPTURE
,
558 /*SND_PCM_NONBLOCK|*/
559 SND_PCM_NO_AUTO_RESAMPLE
|
560 SND_PCM_NO_AUTO_CHANNELS
|
561 SND_PCM_NO_AUTO_FORMAT
)) < 0) {
562 pa_log("Error opening PCM device %s: %s", u
->device_name
, snd_strerror(err
));
566 ss
= u
->source
->sample_spec
;
567 nfrags
= u
->nfragments
;
568 period_size
= u
->fragment_size
/ u
->frame_size
;
572 if ((err
= pa_alsa_set_hw_params(u
->pcm_handle
, &ss
, &nfrags
, &period_size
, u
->hwbuf_size
/ u
->frame_size
, &b
, &d
, TRUE
)) < 0) {
573 pa_log("Failed to set hardware parameters: %s", snd_strerror(err
));
577 if (b
!= u
->use_mmap
|| d
!= u
->use_tsched
) {
578 pa_log_warn("Resume failed, couldn't get original access mode.");
582 if (!pa_sample_spec_equal(&ss
, &u
->source
->sample_spec
)) {
583 pa_log_warn("Resume failed, couldn't restore original sample settings.");
587 if (nfrags
!= u
->nfragments
|| period_size
*u
->frame_size
!= u
->fragment_size
) {
588 pa_log_warn("Resume failed, couldn't restore original fragment settings. (Old: %lu*%lu, New %lu*%lu)",
589 (unsigned long) u
->nfragments
, (unsigned long) u
->fragment_size
,
590 (unsigned long) nfrags
, period_size
* u
->frame_size
);
594 if (update_sw_params(u
) < 0)
597 if (build_pollfd(u
) < 0)
600 /* FIXME: We need to reload the volume somehow */
602 snd_pcm_start(u
->pcm_handle
);
603 pa_smoother_resume(u
->smoother
, pa_rtclock_usec());
605 pa_log_info("Resumed successfully...");
611 snd_pcm_close(u
->pcm_handle
);
612 u
->pcm_handle
= NULL
;
618 static int source_process_msg(pa_msgobject
*o
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
619 struct userdata
*u
= PA_SOURCE(o
)->userdata
;
623 case PA_SOURCE_MESSAGE_GET_LATENCY
: {
627 r
= source_get_latency(u
);
629 *((pa_usec_t
*) data
) = r
;
634 case PA_SOURCE_MESSAGE_SET_STATE
:
636 switch ((pa_source_state_t
) PA_PTR_TO_UINT(data
)) {
638 case PA_SOURCE_SUSPENDED
:
639 pa_assert(PA_SOURCE_IS_OPENED(u
->source
->thread_info
.state
));
647 case PA_SOURCE_RUNNING
:
649 if (u
->source
->thread_info
.state
== PA_SOURCE_INIT
) {
650 if (build_pollfd(u
) < 0)
653 snd_pcm_start(u
->pcm_handle
);
656 if (u
->source
->thread_info
.state
== PA_SOURCE_SUSPENDED
) {
657 if (unsuspend(u
) < 0)
663 case PA_SOURCE_UNLINKED
:
665 case PA_SOURCE_INVALID_STATE
:
672 return pa_source_process_msg(o
, code
, data
, offset
, chunk
);
675 static int mixer_callback(snd_mixer_elem_t
*elem
, unsigned int mask
) {
676 struct userdata
*u
= snd_mixer_elem_get_callback_private(elem
);
679 pa_assert(u
->mixer_handle
);
681 if (mask
== SND_CTL_EVENT_MASK_REMOVE
)
684 if (mask
& SND_CTL_EVENT_MASK_VALUE
) {
685 pa_source_get_volume(u
->source
, TRUE
);
686 pa_source_get_mute(u
->source
, TRUE
);
692 static pa_volume_t
from_alsa_volume(struct userdata
*u
, long alsa_vol
) {
694 return (pa_volume_t
) round(((double) (alsa_vol
- u
->hw_volume_min
) * PA_VOLUME_NORM
) /
695 (double) (u
->hw_volume_max
- u
->hw_volume_min
));
698 static long to_alsa_volume(struct userdata
*u
, pa_volume_t vol
) {
701 alsa_vol
= (long) round(((double) vol
* (double) (u
->hw_volume_max
- u
->hw_volume_min
))
702 / PA_VOLUME_NORM
) + u
->hw_volume_min
;
704 return PA_CLAMP_UNLIKELY(alsa_vol
, u
->hw_volume_min
, u
->hw_volume_max
);
707 static void source_get_volume_cb(pa_source
*s
) {
708 struct userdata
*u
= s
->userdata
;
712 char t
[PA_CVOLUME_SNPRINT_MAX
];
715 pa_assert(u
->mixer_elem
);
717 if (u
->mixer_seperate_channels
) {
719 r
.channels
= s
->sample_spec
.channels
;
721 for (i
= 0; i
< s
->sample_spec
.channels
; i
++) {
724 if (u
->hw_dB_supported
) {
726 if ((err
= snd_mixer_selem_get_capture_dB(u
->mixer_elem
, u
->mixer_map
[i
], &alsa_vol
)) < 0)
729 #ifdef HAVE_VALGRIND_MEMCHECK_H
730 VALGRIND_MAKE_MEM_DEFINED(&alsa_vol
, sizeof(alsa_vol
));
733 r
.values
[i
] = pa_sw_volume_from_dB((double) (alsa_vol
- u
->hw_dB_max
) / 100.0);
736 if ((err
= snd_mixer_selem_get_capture_volume(u
->mixer_elem
, u
->mixer_map
[i
], &alsa_vol
)) < 0)
739 r
.values
[i
] = from_alsa_volume(u
, alsa_vol
);
746 if (u
->hw_dB_supported
) {
748 if ((err
= snd_mixer_selem_get_capture_dB(u
->mixer_elem
, SND_MIXER_SCHN_MONO
, &alsa_vol
)) < 0)
751 #ifdef HAVE_VALGRIND_MEMCHECK_H
752 VALGRIND_MAKE_MEM_DEFINED(&alsa_vol
, sizeof(alsa_vol
));
755 pa_cvolume_set(&r
, s
->sample_spec
.channels
, pa_sw_volume_from_dB((double) (alsa_vol
- u
->hw_dB_max
) / 100.0));
759 if ((err
= snd_mixer_selem_get_capture_volume(u
->mixer_elem
, SND_MIXER_SCHN_MONO
, &alsa_vol
)) < 0)
762 pa_cvolume_set(&r
, s
->sample_spec
.channels
, from_alsa_volume(u
, alsa_vol
));
766 pa_log_debug("Read hardware volume: %s", pa_cvolume_snprint(t
, sizeof(t
), &r
));
768 if (!pa_cvolume_equal(&u
->hardware_volume
, &r
)) {
770 s
->virtual_volume
= u
->hardware_volume
= r
;
772 if (u
->hw_dB_supported
) {
775 /* Hmm, so the hardware volume changed, let's reset our software volume */
776 pa_cvolume_reset(&reset
, s
->sample_spec
.channels
);
777 pa_source_set_soft_volume(s
, &reset
);
784 pa_log_error("Unable to read volume: %s", snd_strerror(err
));
787 static void source_set_volume_cb(pa_source
*s
) {
788 struct userdata
*u
= s
->userdata
;
794 pa_assert(u
->mixer_elem
);
796 if (u
->mixer_seperate_channels
) {
798 r
.channels
= s
->sample_spec
.channels
;
800 for (i
= 0; i
< s
->sample_spec
.channels
; i
++) {
804 vol
= s
->virtual_volume
.values
[i
];
806 if (u
->hw_dB_supported
) {
808 alsa_vol
= (long) (pa_sw_volume_to_dB(vol
) * 100);
809 alsa_vol
+= u
->hw_dB_max
;
810 alsa_vol
= PA_CLAMP_UNLIKELY(alsa_vol
, u
->hw_dB_min
, u
->hw_dB_max
);
812 if ((err
= snd_mixer_selem_set_capture_dB(u
->mixer_elem
, u
->mixer_map
[i
], alsa_vol
, 1)) < 0)
815 if ((err
= snd_mixer_selem_get_capture_dB(u
->mixer_elem
, u
->mixer_map
[i
], &alsa_vol
)) < 0)
818 #ifdef HAVE_VALGRIND_MEMCHECK_H
819 VALGRIND_MAKE_MEM_DEFINED(&alsa_vol
, sizeof(alsa_vol
));
822 r
.values
[i
] = pa_sw_volume_from_dB((double) (alsa_vol
- u
->hw_dB_max
) / 100.0);
825 alsa_vol
= to_alsa_volume(u
, vol
);
827 if ((err
= snd_mixer_selem_set_capture_volume(u
->mixer_elem
, u
->mixer_map
[i
], alsa_vol
)) < 0)
830 if ((err
= snd_mixer_selem_get_capture_volume(u
->mixer_elem
, u
->mixer_map
[i
], &alsa_vol
)) < 0)
833 r
.values
[i
] = from_alsa_volume(u
, alsa_vol
);
841 vol
= pa_cvolume_max(&s
->virtual_volume
);
843 if (u
->hw_dB_supported
) {
844 alsa_vol
= (long) (pa_sw_volume_to_dB(vol
) * 100);
845 alsa_vol
+= u
->hw_dB_max
;
846 alsa_vol
= PA_CLAMP_UNLIKELY(alsa_vol
, u
->hw_dB_min
, u
->hw_dB_max
);
848 if ((err
= snd_mixer_selem_set_capture_dB_all(u
->mixer_elem
, alsa_vol
, 1)) < 0)
851 if ((err
= snd_mixer_selem_get_capture_dB(u
->mixer_elem
, SND_MIXER_SCHN_MONO
, &alsa_vol
)) < 0)
854 #ifdef HAVE_VALGRIND_MEMCHECK_H
855 VALGRIND_MAKE_MEM_DEFINED(&alsa_vol
, sizeof(alsa_vol
));
858 pa_cvolume_set(&r
, s
->sample_spec
.channels
, pa_sw_volume_from_dB((double) (alsa_vol
- u
->hw_dB_max
) / 100.0));
861 alsa_vol
= to_alsa_volume(u
, vol
);
863 if ((err
= snd_mixer_selem_set_capture_volume_all(u
->mixer_elem
, alsa_vol
)) < 0)
866 if ((err
= snd_mixer_selem_get_capture_volume(u
->mixer_elem
, SND_MIXER_SCHN_MONO
, &alsa_vol
)) < 0)
869 pa_cvolume_set(&r
, s
->sample_spec
.channels
, from_alsa_volume(u
, alsa_vol
));
873 u
->hardware_volume
= r
;
875 if (u
->hw_dB_supported
) {
876 char t
[PA_CVOLUME_SNPRINT_MAX
];
878 /* Match exactly what the user requested by software */
880 pa_sw_cvolume_divide(&s
->soft_volume
, &s
->virtual_volume
, &u
->hardware_volume
);
882 pa_log_debug("Requested volume: %s", pa_cvolume_snprint(t
, sizeof(t
), &s
->virtual_volume
));
883 pa_log_debug("Got hardware volume: %s", pa_cvolume_snprint(t
, sizeof(t
), &u
->hardware_volume
));
884 pa_log_debug("Calculated software volume: %s", pa_cvolume_snprint(t
, sizeof(t
), &s
->soft_volume
));
888 /* We can't match exactly what the user requested, hence let's
889 * at least tell the user about it */
891 s
->virtual_volume
= r
;
896 pa_log_error("Unable to set volume: %s", snd_strerror(err
));
899 static void source_get_mute_cb(pa_source
*s
) {
900 struct userdata
*u
= s
->userdata
;
904 pa_assert(u
->mixer_elem
);
906 if ((err
= snd_mixer_selem_get_capture_switch(u
->mixer_elem
, 0, &sw
)) < 0) {
907 pa_log_error("Unable to get switch: %s", snd_strerror(err
));
914 static void source_set_mute_cb(pa_source
*s
) {
915 struct userdata
*u
= s
->userdata
;
919 pa_assert(u
->mixer_elem
);
921 if ((err
= snd_mixer_selem_set_capture_switch_all(u
->mixer_elem
, !s
->muted
)) < 0) {
922 pa_log_error("Unable to set switch: %s", snd_strerror(err
));
927 static void source_update_requested_latency_cb(pa_source
*s
) {
928 struct userdata
*u
= s
->userdata
;
937 static void thread_func(void *userdata
) {
938 struct userdata
*u
= userdata
;
939 unsigned short revents
= 0;
943 pa_log_debug("Thread starting up");
945 if (u
->core
->realtime_scheduling
)
946 pa_make_realtime(u
->core
->realtime_priority
);
948 pa_thread_mq_install(&u
->thread_mq
);
949 pa_rtpoll_install(u
->rtpoll
);
954 /* pa_log_debug("loop"); */
956 /* Read some data and pass it to the sources */
957 if (PA_SOURCE_IS_OPENED(u
->source
->thread_info
.state
)) {
959 pa_usec_t sleep_usec
= 0;
962 work_done
= mmap_read(u
, &sleep_usec
, revents
& POLLIN
);
964 work_done
= unix_read(u
, &sleep_usec
, revents
& POLLIN
);
969 /* pa_log_debug("work_done = %i", work_done); */
977 /* OK, the capture buffer is now empty, let's
978 * calculate when to wake up next */
980 /* pa_log_debug("Waking up in %0.2fms (sound card clock).", (double) sleep_usec / PA_USEC_PER_MSEC); */
982 /* Convert from the sound card time domain to the
983 * system time domain */
984 cusec
= pa_smoother_translate(u
->smoother
, pa_rtclock_usec(), sleep_usec
);
986 /* pa_log_debug("Waking up in %0.2fms (system clock).", (double) cusec / PA_USEC_PER_MSEC); */
988 /* We don't trust the conversion, so we wake up whatever comes first */
989 pa_rtpoll_set_timer_relative(u
->rtpoll
, PA_MIN(sleep_usec
, cusec
));
991 } else if (u
->use_tsched
)
993 /* OK, we're in an invalid state, let's disable our timers */
994 pa_rtpoll_set_timer_disabled(u
->rtpoll
);
996 /* Hmm, nothing to do. Let's sleep */
997 if ((ret
= pa_rtpoll_run(u
->rtpoll
, TRUE
)) < 0)
1003 /* Tell ALSA about this and process its response */
1004 if (PA_SOURCE_IS_OPENED(u
->source
->thread_info
.state
)) {
1005 struct pollfd
*pollfd
;
1009 pollfd
= pa_rtpoll_item_get_pollfd(u
->alsa_rtpoll_item
, &n
);
1011 if ((err
= snd_pcm_poll_descriptors_revents(u
->pcm_handle
, pollfd
, n
, &revents
)) < 0) {
1012 pa_log("snd_pcm_poll_descriptors_revents() failed: %s", snd_strerror(err
));
1016 if (revents
& (POLLOUT
|POLLERR
|POLLNVAL
|POLLHUP
|POLLPRI
)) {
1017 if (pa_alsa_recover_from_poll(u
->pcm_handle
, revents
) < 0)
1020 snd_pcm_start(u
->pcm_handle
);
1023 if (revents
&& u
->use_tsched
&& pa_log_ratelimit())
1024 pa_log_debug("Wakeup from ALSA!%s%s", (revents
& POLLIN
) ? " INPUT" : "", (revents
& POLLOUT
) ? " OUTPUT" : "");
1030 /* If this was no regular exit from the loop we have to continue
1031 * processing messages until we received PA_MESSAGE_SHUTDOWN */
1032 pa_asyncmsgq_post(u
->thread_mq
.outq
, PA_MSGOBJECT(u
->core
), PA_CORE_MESSAGE_UNLOAD_MODULE
, u
->module
, 0, NULL
, NULL
);
1033 pa_asyncmsgq_wait_for(u
->thread_mq
.inq
, PA_MESSAGE_SHUTDOWN
);
1036 pa_log_debug("Thread shutting down");
1039 static void set_source_name(pa_source_new_data
*data
, pa_modargs
*ma
, const char *device_id
, const char *device_name
) {
1045 pa_assert(device_name
);
1047 if ((n
= pa_modargs_get_value(ma
, "source_name", NULL
))) {
1048 pa_source_new_data_set_name(data
, n
);
1049 data
->namereg_fail
= TRUE
;
1053 if ((n
= pa_modargs_get_value(ma
, "name", NULL
)))
1054 data
->namereg_fail
= TRUE
;
1056 n
= device_id
? device_id
: device_name
;
1057 data
->namereg_fail
= FALSE
;
1060 t
= pa_sprintf_malloc("alsa_input.%s", n
);
1061 pa_source_new_data_set_name(data
, t
);
1065 static int setup_mixer(struct userdata
*u
, pa_bool_t ignore_dB
) {
1068 if (!u
->mixer_handle
)
1071 pa_assert(u
->mixer_elem
);
1073 if (snd_mixer_selem_has_capture_volume(u
->mixer_elem
)) {
1074 pa_bool_t suitable
= FALSE
;
1076 if (snd_mixer_selem_get_capture_volume_range(u
->mixer_elem
, &u
->hw_volume_min
, &u
->hw_volume_max
) < 0)
1077 pa_log_info("Failed to get volume range. Falling back to software volume control.");
1078 else if (u
->hw_volume_min
>= u
->hw_volume_max
)
1079 pa_log_warn("Your kernel driver is broken: it reports a volume range from %li to %li which makes no sense.", u
->hw_volume_min
, u
->hw_volume_max
);
1081 pa_log_info("Volume ranges from %li to %li.", u
->hw_volume_min
, u
->hw_volume_max
);
1086 if (ignore_dB
|| snd_mixer_selem_get_capture_dB_range(u
->mixer_elem
, &u
->hw_dB_min
, &u
->hw_dB_max
) < 0)
1087 pa_log_info("Mixer doesn't support dB information or data is ignored.");
1089 #ifdef HAVE_VALGRIND_MEMCHECK_H
1090 VALGRIND_MAKE_MEM_DEFINED(&u
->hw_dB_min
, sizeof(u
->hw_dB_min
));
1091 VALGRIND_MAKE_MEM_DEFINED(&u
->hw_dB_max
, sizeof(u
->hw_dB_max
));
1094 if (u
->hw_dB_min
>= u
->hw_dB_max
)
1095 pa_log_warn("Your kernel driver is broken: it reports a volume range from %0.2f dB to %0.2f dB which makes no sense.", (double) u
->hw_dB_min
/100.0, (double) u
->hw_dB_max
/100.0);
1097 pa_log_info("Volume ranges from %0.2f dB to %0.2f dB.", (double) u
->hw_dB_min
/100.0, (double) u
->hw_dB_max
/100.0);
1098 u
->hw_dB_supported
= TRUE
;
1100 if (u
->hw_dB_max
> 0) {
1101 u
->source
->base_volume
= pa_sw_volume_from_dB(- (double) u
->hw_dB_max
/100.0);
1102 pa_log_info("Fixing base volume to %0.2f dB", pa_sw_volume_to_dB(u
->source
->base_volume
));
1104 pa_log_info("No particular base volume set, fixing to 0 dB");
1108 if (!u
->hw_dB_supported
&&
1109 u
->hw_volume_max
- u
->hw_volume_min
< 3) {
1111 pa_log_info("Device has less than 4 volume levels. Falling back to software volume control.");
1117 u
->mixer_seperate_channels
= pa_alsa_calc_mixer_map(u
->mixer_elem
, &u
->source
->channel_map
, u
->mixer_map
, FALSE
) >= 0;
1119 u
->source
->get_volume
= source_get_volume_cb
;
1120 u
->source
->set_volume
= source_set_volume_cb
;
1121 u
->source
->flags
|= PA_SOURCE_HW_VOLUME_CTRL
| (u
->hw_dB_supported
? PA_SOURCE_DECIBEL_VOLUME
: 0);
1122 pa_log_info("Using hardware volume control. Hardware dB scale %s.", u
->hw_dB_supported
? "supported" : "not supported");
1124 if (!u
->hw_dB_supported
)
1125 u
->source
->n_volume_steps
= u
->hw_volume_max
- u
->hw_volume_min
+ 1;
1127 pa_log_info("Using software volume control.");
1130 if (snd_mixer_selem_has_capture_switch(u
->mixer_elem
)) {
1131 u
->source
->get_mute
= source_get_mute_cb
;
1132 u
->source
->set_mute
= source_set_mute_cb
;
1133 u
->source
->flags
|= PA_SOURCE_HW_MUTE_CTRL
;
1135 pa_log_info("Using software mute control.");
1137 u
->mixer_fdl
= pa_alsa_fdlist_new();
1139 if (pa_alsa_fdlist_set_mixer(u
->mixer_fdl
, u
->mixer_handle
, u
->core
->mainloop
) < 0) {
1140 pa_log("Failed to initialize file descriptor monitoring");
1144 snd_mixer_elem_set_callback(u
->mixer_elem
, mixer_callback
);
1145 snd_mixer_elem_set_callback_private(u
->mixer_elem
, u
);
1150 pa_source
*pa_alsa_source_new(pa_module
*m
, pa_modargs
*ma
, const char*driver
, pa_card
*card
, const pa_alsa_profile_info
*profile
) {
1152 struct userdata
*u
= NULL
;
1153 const char *dev_id
= NULL
;
1156 uint32_t nfrags
, hwbuf_size
, frag_size
, tsched_size
, tsched_watermark
;
1157 snd_pcm_uframes_t period_frames
, tsched_frames
;
1159 pa_bool_t use_mmap
= TRUE
, b
, use_tsched
= TRUE
, d
, ignore_dB
= FALSE
;
1160 pa_source_new_data data
;
1165 ss
= m
->core
->default_sample_spec
;
1166 if (pa_modargs_get_sample_spec_and_channel_map(ma
, &ss
, &map
, PA_CHANNEL_MAP_ALSA
) < 0) {
1167 pa_log("Failed to parse sample specification");
1171 frame_size
= pa_frame_size(&ss
);
1173 nfrags
= m
->core
->default_n_fragments
;
1174 frag_size
= (uint32_t) pa_usec_to_bytes(m
->core
->default_fragment_size_msec
*PA_USEC_PER_MSEC
, &ss
);
1176 frag_size
= (uint32_t) frame_size
;
1177 tsched_size
= (uint32_t) pa_usec_to_bytes(DEFAULT_TSCHED_BUFFER_USEC
, &ss
);
1178 tsched_watermark
= (uint32_t) pa_usec_to_bytes(DEFAULT_TSCHED_WATERMARK_USEC
, &ss
);
1180 if (pa_modargs_get_value_u32(ma
, "fragments", &nfrags
) < 0 ||
1181 pa_modargs_get_value_u32(ma
, "fragment_size", &frag_size
) < 0 ||
1182 pa_modargs_get_value_u32(ma
, "tsched_buffer_size", &tsched_size
) < 0 ||
1183 pa_modargs_get_value_u32(ma
, "tsched_buffer_watermark", &tsched_watermark
) < 0) {
1184 pa_log("Failed to parse buffer metrics");
1188 hwbuf_size
= frag_size
* nfrags
;
1189 period_frames
= frag_size
/frame_size
;
1190 tsched_frames
= tsched_size
/frame_size
;
1192 if (pa_modargs_get_value_boolean(ma
, "mmap", &use_mmap
) < 0) {
1193 pa_log("Failed to parse mmap argument.");
1197 if (pa_modargs_get_value_boolean(ma
, "tsched", &use_tsched
) < 0) {
1198 pa_log("Failed to parse timer_scheduling argument.");
1202 if (pa_modargs_get_value_boolean(ma
, "ignore_dB", &ignore_dB
) < 0) {
1203 pa_log("Failed to parse ignore_dB argument.");
1207 if (use_tsched
&& !pa_rtclock_hrtimer()) {
1208 pa_log_notice("Disabling timer-based scheduling because high-resolution timers are not available from the kernel.");
1212 u
= pa_xnew0(struct userdata
, 1);
1215 u
->use_mmap
= use_mmap
;
1216 u
->use_tsched
= use_tsched
;
1217 u
->rtpoll
= pa_rtpoll_new();
1218 pa_thread_mq_init(&u
->thread_mq
, m
->core
->mainloop
, u
->rtpoll
);
1219 u
->alsa_rtpoll_item
= NULL
;
1221 u
->smoother
= pa_smoother_new(DEFAULT_TSCHED_WATERMARK_USEC
, DEFAULT_TSCHED_WATERMARK_USEC
, TRUE
, 5);
1222 pa_smoother_set_time_offset(u
->smoother
, pa_rtclock_usec());
1229 if (!(dev_id
= pa_modargs_get_value(ma
, "device_id", NULL
))) {
1230 pa_log("device_id= not set");
1234 if (!(u
->pcm_handle
= pa_alsa_open_by_device_id_profile(
1238 SND_PCM_STREAM_CAPTURE
,
1239 &nfrags
, &period_frames
, tsched_frames
,
1243 } else if ((dev_id
= pa_modargs_get_value(ma
, "device_id", NULL
))) {
1245 if (!(u
->pcm_handle
= pa_alsa_open_by_device_id_auto(
1249 SND_PCM_STREAM_CAPTURE
,
1250 &nfrags
, &period_frames
, tsched_frames
,
1256 if (!(u
->pcm_handle
= pa_alsa_open_by_device_string(
1257 pa_modargs_get_value(ma
, "device", DEFAULT_DEVICE
),
1260 SND_PCM_STREAM_CAPTURE
,
1261 &nfrags
, &period_frames
, tsched_frames
,
1266 pa_assert(u
->device_name
);
1267 pa_log_info("Successfully opened device %s.", u
->device_name
);
1270 pa_log_info("Selected configuration '%s' (%s).", profile
->description
, profile
->name
);
1272 if (use_mmap
&& !b
) {
1273 pa_log_info("Device doesn't support mmap(), falling back to UNIX read/write mode.");
1274 u
->use_mmap
= use_mmap
= FALSE
;
1277 if (use_tsched
&& (!b
|| !d
)) {
1278 pa_log_info("Cannot enable timer-based scheduling, falling back to sound IRQ scheduling.");
1279 u
->use_tsched
= use_tsched
= FALSE
;
1283 pa_log_info("Successfully enabled mmap() mode.");
1286 pa_log_info("Successfully enabled timer-based scheduling mode.");
1288 /* ALSA might tweak the sample spec, so recalculate the frame size */
1289 frame_size
= pa_frame_size(&ss
);
1291 pa_alsa_find_mixer_and_elem(u
->pcm_handle
, &u
->mixer_handle
, &u
->mixer_elem
);
1293 pa_source_new_data_init(&data
);
1294 data
.driver
= driver
;
1297 set_source_name(&data
, ma
, dev_id
, u
->device_name
);
1298 pa_source_new_data_set_sample_spec(&data
, &ss
);
1299 pa_source_new_data_set_channel_map(&data
, &map
);
1301 pa_alsa_init_proplist_pcm(m
->core
, data
.proplist
, u
->pcm_handle
);
1302 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_STRING
, u
->device_name
);
1303 pa_proplist_setf(data
.proplist
, PA_PROP_DEVICE_BUFFERING_BUFFER_SIZE
, "%lu", (unsigned long) (period_frames
* frame_size
* nfrags
));
1304 pa_proplist_setf(data
.proplist
, PA_PROP_DEVICE_BUFFERING_FRAGMENT_SIZE
, "%lu", (unsigned long) (period_frames
* frame_size
));
1305 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_ACCESS_MODE
, u
->use_tsched
? "mmap+timer" : (u
->use_mmap
? "mmap" : "serial"));
1308 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_PROFILE_NAME
, profile
->name
);
1309 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_PROFILE_DESCRIPTION
, profile
->description
);
1312 u
->source
= pa_source_new(m
->core
, &data
, PA_SOURCE_HARDWARE
|PA_SOURCE_LATENCY
);
1313 pa_source_new_data_done(&data
);
1316 pa_log("Failed to create source object");
1320 u
->source
->parent
.process_msg
= source_process_msg
;
1321 u
->source
->update_requested_latency
= source_update_requested_latency_cb
;
1322 u
->source
->userdata
= u
;
1324 pa_source_set_asyncmsgq(u
->source
, u
->thread_mq
.inq
);
1325 pa_source_set_rtpoll(u
->source
, u
->rtpoll
);
1327 u
->frame_size
= frame_size
;
1328 u
->fragment_size
= frag_size
= (uint32_t) (period_frames
* frame_size
);
1329 u
->nfragments
= nfrags
;
1330 u
->hwbuf_size
= u
->fragment_size
* nfrags
;
1331 u
->hwbuf_unused_frames
= 0;
1332 u
->tsched_watermark
= tsched_watermark
;
1334 u
->hw_dB_supported
= FALSE
;
1335 u
->hw_dB_min
= u
->hw_dB_max
= 0;
1336 u
->hw_volume_min
= u
->hw_volume_max
= 0;
1337 u
->mixer_seperate_channels
= FALSE
;
1338 pa_cvolume_mute(&u
->hardware_volume
, u
->source
->sample_spec
.channels
);
1341 fix_tsched_watermark(u
);
1343 pa_source_set_latency_range(u
->source
,
1344 !use_tsched
? pa_bytes_to_usec(u
->hwbuf_size
, &ss
) : (pa_usec_t
) -1,
1345 pa_bytes_to_usec(u
->hwbuf_size
, &ss
));
1347 pa_log_info("Using %u fragments of size %lu bytes, buffer time is %0.2fms",
1348 nfrags
, (long unsigned) u
->fragment_size
,
1349 (double) pa_bytes_to_usec(u
->hwbuf_size
, &ss
) / PA_USEC_PER_MSEC
);
1352 pa_log_info("Time scheduling watermark is %0.2fms",
1353 (double) pa_bytes_to_usec(u
->tsched_watermark
, &ss
) / PA_USEC_PER_MSEC
);
1355 if (update_sw_params(u
) < 0)
1358 if (setup_mixer(u
, ignore_dB
) < 0)
1361 pa_alsa_dump(u
->pcm_handle
);
1363 if (!(u
->thread
= pa_thread_new(thread_func
, u
))) {
1364 pa_log("Failed to create thread.");
1367 /* Get initial mixer settings */
1368 if (data
.volume_is_set
) {
1369 if (u
->source
->set_volume
)
1370 u
->source
->set_volume(u
->source
);
1372 if (u
->source
->get_volume
)
1373 u
->source
->get_volume(u
->source
);
1376 if (data
.muted_is_set
) {
1377 if (u
->source
->set_mute
)
1378 u
->source
->set_mute(u
->source
);
1380 if (u
->source
->get_mute
)
1381 u
->source
->get_mute(u
->source
);
1384 pa_source_put(u
->source
);
1395 static void userdata_free(struct userdata
*u
) {
1399 pa_source_unlink(u
->source
);
1402 pa_asyncmsgq_send(u
->thread_mq
.inq
, NULL
, PA_MESSAGE_SHUTDOWN
, NULL
, 0, NULL
);
1403 pa_thread_free(u
->thread
);
1406 pa_thread_mq_done(&u
->thread_mq
);
1409 pa_source_unref(u
->source
);
1411 if (u
->alsa_rtpoll_item
)
1412 pa_rtpoll_item_free(u
->alsa_rtpoll_item
);
1415 pa_rtpoll_free(u
->rtpoll
);
1418 pa_alsa_fdlist_free(u
->mixer_fdl
);
1420 if (u
->mixer_handle
)
1421 snd_mixer_close(u
->mixer_handle
);
1423 if (u
->pcm_handle
) {
1424 snd_pcm_drop(u
->pcm_handle
);
1425 snd_pcm_close(u
->pcm_handle
);
1429 pa_smoother_free(u
->smoother
);
1431 pa_xfree(u
->device_name
);
1435 void pa_alsa_source_free(pa_source
*s
) {
1438 pa_source_assert_ref(s
);
1439 pa_assert_se(u
= s
->userdata
);