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 "module-alsa-source-symdef.h"
59 PA_MODULE_AUTHOR("Lennart Poettering");
60 PA_MODULE_DESCRIPTION("ALSA Source");
61 PA_MODULE_VERSION(PACKAGE_VERSION
);
62 PA_MODULE_LOAD_ONCE(FALSE
);
64 "source_name=<name for the source> "
65 "device=<ALSA device> "
66 "device_id=<ALSA card index> "
67 "format=<sample format> "
69 "channels=<number of channels> "
70 "channel_map=<channel map> "
71 "fragments=<number of fragments> "
72 "fragment_size=<fragment size> "
73 "mmap=<enable memory mapping?> "
74 "tsched=<enable system timer based scheduling mode?> "
75 "tsched_buffer_size=<buffer size when using timer based scheduling> "
76 "tsched_buffer_watermark=<upper fill watermark>");
78 static const char* const valid_modargs
[] = {
91 "tsched_buffer_watermark",
95 #define DEFAULT_DEVICE "default"
96 #define DEFAULT_TSCHED_BUFFER_USEC (2*PA_USEC_PER_SEC) /* 2s */
97 #define DEFAULT_TSCHED_WATERMARK_USEC (20*PA_USEC_PER_MSEC) /* 20ms */
98 #define TSCHED_MIN_SLEEP_USEC (3*PA_USEC_PER_MSEC) /* 3ms */
99 #define TSCHED_MIN_WAKEUP_USEC (3*PA_USEC_PER_MSEC) /* 3ms */
107 pa_thread_mq thread_mq
;
110 snd_pcm_t
*pcm_handle
;
112 pa_alsa_fdlist
*mixer_fdl
;
113 snd_mixer_t
*mixer_handle
;
114 snd_mixer_elem_t
*mixer_elem
;
115 long hw_volume_max
, hw_volume_min
;
116 long hw_dB_max
, hw_dB_min
;
117 pa_bool_t hw_dB_supported
;
118 pa_bool_t mixer_seperate_channels
;
120 pa_cvolume hardware_volume
;
122 size_t frame_size
, fragment_size
, hwbuf_size
, tsched_watermark
;
127 pa_bool_t use_mmap
, use_tsched
;
129 pa_rtpoll_item
*alsa_rtpoll_item
;
131 snd_mixer_selem_channel_id_t mixer_map
[SND_MIXER_SCHN_LAST
];
133 pa_smoother
*smoother
;
136 snd_pcm_sframes_t hwbuf_unused_frames
;
139 static void fix_tsched_watermark(struct userdata
*u
) {
141 size_t min_sleep
, min_wakeup
;
144 max_use
= u
->hwbuf_size
- (size_t) u
->hwbuf_unused_frames
* u
->frame_size
;
146 min_sleep
= pa_usec_to_bytes(TSCHED_MIN_SLEEP_USEC
, &u
->source
->sample_spec
);
147 min_wakeup
= pa_usec_to_bytes(TSCHED_MIN_WAKEUP_USEC
, &u
->source
->sample_spec
);
149 if (min_sleep
> max_use
/2)
150 min_sleep
= pa_frame_align(max_use
/2, &u
->source
->sample_spec
);
151 if (min_sleep
< u
->frame_size
)
152 min_sleep
= u
->frame_size
;
154 if (min_wakeup
> max_use
/2)
155 min_wakeup
= pa_frame_align(max_use
/2, &u
->source
->sample_spec
);
156 if (min_wakeup
< u
->frame_size
)
157 min_wakeup
= u
->frame_size
;
159 if (u
->tsched_watermark
> max_use
-min_sleep
)
160 u
->tsched_watermark
= max_use
-min_sleep
;
162 if (u
->tsched_watermark
< min_wakeup
)
163 u
->tsched_watermark
= min_wakeup
;
166 static pa_usec_t
hw_sleep_time(struct userdata
*u
, pa_usec_t
*sleep_usec
, pa_usec_t
*process_usec
) {
171 usec
= pa_source_get_requested_latency_within_thread(u
->source
);
173 if (usec
== (pa_usec_t
) -1)
174 usec
= pa_bytes_to_usec(u
->hwbuf_size
, &u
->source
->sample_spec
);
176 /* pa_log_debug("hw buffer time: %u ms", (unsigned) (usec / PA_USEC_PER_MSEC)); */
178 wm
= pa_bytes_to_usec(u
->tsched_watermark
, &u
->source
->sample_spec
);
181 *sleep_usec
= usec
- wm
;
184 *process_usec
= *sleep_usec
= usec
/= 2;
186 /* pa_log_debug("after watermark: %u ms", (unsigned) (*sleep_usec / PA_USEC_PER_MSEC)); */
191 static int try_recover(struct userdata
*u
, const char *call
, int err
) {
196 pa_log_debug("%s: %s", call
, snd_strerror(err
));
198 pa_assert(err
!= -EAGAIN
);
201 pa_log_debug("%s: Buffer overrun!", call
);
203 if ((err
= snd_pcm_recover(u
->pcm_handle
, err
, 1)) == 0) {
204 snd_pcm_start(u
->pcm_handle
);
208 pa_log("%s: %s", call
, snd_strerror(err
));
212 static size_t check_left_to_record(struct userdata
*u
, snd_pcm_sframes_t n
) {
213 size_t left_to_record
;
214 size_t rec_space
= u
->hwbuf_size
- (size_t) u
->hwbuf_unused_frames
*u
->frame_size
;
216 if ((size_t) n
*u
->frame_size
< rec_space
)
217 left_to_record
= rec_space
- ((size_t) n
*u
->frame_size
);
221 if (left_to_record
> 0) {
222 /* 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); */
224 pa_log_info("Overrun!");
227 size_t old_watermark
= u
->tsched_watermark
;
229 u
->tsched_watermark
*= 2;
230 fix_tsched_watermark(u
);
232 if (old_watermark
!= u
->tsched_watermark
)
233 pa_log_notice("Increasing wakeup watermark to %0.2f ms",
234 (double) pa_bytes_to_usec(u
->tsched_watermark
, &u
->source
->sample_spec
) / PA_USEC_PER_MSEC
);
238 return left_to_record
;
241 static int mmap_read(struct userdata
*u
, pa_usec_t
*sleep_usec
, pa_bool_t polled
) {
243 pa_usec_t max_sleep_usec
= 0, process_usec
= 0;
244 size_t left_to_record
;
247 pa_source_assert_ref(u
->source
);
250 hw_sleep_time(u
, &max_sleep_usec
, &process_usec
);
256 snd_pcm_hwsync(u
->pcm_handle
);
258 if (PA_UNLIKELY((n
= pa_alsa_safe_avail_update(u
->pcm_handle
, u
->hwbuf_size
, &u
->source
->sample_spec
)) < 0)) {
260 if ((r
= try_recover(u
, "snd_pcm_avail_update", (int) n
)) == 0)
266 left_to_record
= check_left_to_record(u
, n
);
270 pa_bytes_to_usec(left_to_record
, &u
->source
->sample_spec
) > process_usec
+max_sleep_usec
/2)
273 if (PA_UNLIKELY(n
<= 0)) {
276 pa_log("ALSA woke us up to read new data from the device, but there was actually nothing to read! "
277 "Most likely this is an ALSA driver bug. Please report this issue to the PulseAudio device.");
286 const snd_pcm_channel_area_t
*areas
;
287 snd_pcm_uframes_t offset
, frames
= (snd_pcm_uframes_t
) n
;
290 snd_pcm_sframes_t sframes
;
292 /* pa_log_debug("%lu frames to read", (unsigned long) frames); */
294 if (PA_UNLIKELY((err
= pa_alsa_safe_mmap_begin(u
->pcm_handle
, &areas
, &offset
, &frames
, u
->hwbuf_size
, &u
->source
->sample_spec
)) < 0)) {
296 if ((r
= try_recover(u
, "snd_pcm_mmap_begin", err
)) == 0)
302 /* Make sure that if these memblocks need to be copied they will fit into one slot */
303 if (frames
> pa_mempool_block_size_max(u
->source
->core
->mempool
)/u
->frame_size
)
304 frames
= pa_mempool_block_size_max(u
->source
->core
->mempool
)/u
->frame_size
;
306 /* Check these are multiples of 8 bit */
307 pa_assert((areas
[0].first
& 7) == 0);
308 pa_assert((areas
[0].step
& 7)== 0);
310 /* We assume a single interleaved memory buffer */
311 pa_assert((areas
[0].first
>> 3) == 0);
312 pa_assert((areas
[0].step
>> 3) == u
->frame_size
);
314 p
= (uint8_t*) areas
[0].addr
+ (offset
* u
->frame_size
);
316 chunk
.memblock
= pa_memblock_new_fixed(u
->core
->mempool
, p
, frames
* u
->frame_size
, TRUE
);
317 chunk
.length
= pa_memblock_get_length(chunk
.memblock
);
320 pa_source_post(u
->source
, &chunk
);
321 pa_memblock_unref_fixed(chunk
.memblock
);
323 if (PA_UNLIKELY((sframes
= snd_pcm_mmap_commit(u
->pcm_handle
, offset
, frames
)) < 0)) {
325 if ((r
= try_recover(u
, "snd_pcm_mmap_commit", (int) sframes
)) == 0)
333 u
->frame_index
+= (int64_t) frames
;
335 /* pa_log_debug("read %lu frames", (unsigned long) frames); */
337 if (frames
>= (snd_pcm_uframes_t
) n
)
340 n
-= (snd_pcm_sframes_t
) frames
;
344 *sleep_usec
= pa_bytes_to_usec(left_to_record
, &u
->source
->sample_spec
) - process_usec
;
348 static int unix_read(struct userdata
*u
, pa_usec_t
*sleep_usec
, pa_bool_t polled
) {
350 pa_usec_t max_sleep_usec
= 0, process_usec
= 0;
351 size_t left_to_record
;
354 pa_source_assert_ref(u
->source
);
357 hw_sleep_time(u
, &max_sleep_usec
, &process_usec
);
363 snd_pcm_hwsync(u
->pcm_handle
);
365 if (PA_UNLIKELY((n
= pa_alsa_safe_avail_update(u
->pcm_handle
, u
->hwbuf_size
, &u
->source
->sample_spec
)) < 0)) {
367 if ((r
= try_recover(u
, "snd_pcm_avail_update", (int) n
)) == 0)
373 left_to_record
= check_left_to_record(u
, n
);
377 pa_bytes_to_usec(left_to_record
, &u
->source
->sample_spec
) > process_usec
+max_sleep_usec
/2)
380 if (PA_UNLIKELY(n
<= 0)) {
383 pa_log("ALSA woke us up to read new data from the device, but there was actually nothing to read! "
384 "Most likely this is an ALSA driver bug. Please report this issue to the PulseAudio developers.");
393 snd_pcm_sframes_t frames
;
396 chunk
.memblock
= pa_memblock_new(u
->core
->mempool
, (size_t) -1);
398 frames
= (snd_pcm_sframes_t
) (pa_memblock_get_length(chunk
.memblock
) / u
->frame_size
);
403 /* pa_log_debug("%lu frames to read", (unsigned long) n); */
405 p
= pa_memblock_acquire(chunk
.memblock
);
406 frames
= snd_pcm_readi(u
->pcm_handle
, (uint8_t*) p
, (snd_pcm_uframes_t
) frames
);
407 pa_memblock_release(chunk
.memblock
);
409 pa_assert(frames
!= 0);
411 if (PA_UNLIKELY(frames
< 0)) {
412 pa_memblock_unref(chunk
.memblock
);
414 if ((r
= try_recover(u
, "snd_pcm_readi", (int) (frames
))) == 0)
421 chunk
.length
= (size_t) frames
* u
->frame_size
;
423 pa_source_post(u
->source
, &chunk
);
424 pa_memblock_unref(chunk
.memblock
);
428 u
->frame_index
+= frames
;
430 /* pa_log_debug("read %lu frames", (unsigned long) frames); */
439 *sleep_usec
= pa_bytes_to_usec(left_to_record
, &u
->source
->sample_spec
) - process_usec
;
443 static void update_smoother(struct userdata
*u
) {
444 snd_pcm_sframes_t delay
= 0;
447 pa_usec_t now1
, now2
;
450 pa_assert(u
->pcm_handle
);
452 /* Let's update the time smoother */
454 snd_pcm_hwsync(u
->pcm_handle
);
455 snd_pcm_avail_update(u
->pcm_handle
);
457 if (PA_UNLIKELY((err
= snd_pcm_delay(u
->pcm_handle
, &delay
)) < 0)) {
458 pa_log_warn("Failed to get delay: %s", snd_strerror(err
));
462 frames
= u
->frame_index
+ delay
;
464 now1
= pa_rtclock_usec();
465 now2
= pa_bytes_to_usec((uint64_t) frames
* u
->frame_size
, &u
->source
->sample_spec
);
467 pa_smoother_put(u
->smoother
, now1
, now2
);
470 static pa_usec_t
source_get_latency(struct userdata
*u
) {
473 pa_usec_t now1
, now2
;
477 now1
= pa_rtclock_usec();
478 now2
= pa_smoother_get(u
->smoother
, now1
);
480 delay
= (int64_t) now2
- (int64_t) pa_bytes_to_usec((uint64_t) u
->frame_index
* u
->frame_size
, &u
->source
->sample_spec
);
483 r
= (pa_usec_t
) delay
;
488 static int build_pollfd(struct userdata
*u
) {
490 pa_assert(u
->pcm_handle
);
492 if (u
->alsa_rtpoll_item
)
493 pa_rtpoll_item_free(u
->alsa_rtpoll_item
);
495 if (!(u
->alsa_rtpoll_item
= pa_alsa_build_pollfd(u
->pcm_handle
, u
->rtpoll
)))
501 static int suspend(struct userdata
*u
) {
503 pa_assert(u
->pcm_handle
);
505 pa_smoother_pause(u
->smoother
, pa_rtclock_usec());
508 snd_pcm_close(u
->pcm_handle
);
509 u
->pcm_handle
= NULL
;
511 if (u
->alsa_rtpoll_item
) {
512 pa_rtpoll_item_free(u
->alsa_rtpoll_item
);
513 u
->alsa_rtpoll_item
= NULL
;
516 pa_log_info("Device suspended...");
521 static int update_sw_params(struct userdata
*u
) {
522 snd_pcm_uframes_t avail_min
;
527 /* Use the full buffer if noone asked us for anything specific */
528 u
->hwbuf_unused_frames
= 0;
533 if ((latency
= pa_source_get_requested_latency_within_thread(u
->source
)) != (pa_usec_t
) -1) {
536 pa_log_debug("latency set to %0.2fms", (double) latency
/ PA_USEC_PER_MSEC
);
538 b
= pa_usec_to_bytes(latency
, &u
->source
->sample_spec
);
540 /* We need at least one sample in our buffer */
542 if (PA_UNLIKELY(b
< u
->frame_size
))
545 u
->hwbuf_unused_frames
= (snd_pcm_sframes_t
)
546 (PA_LIKELY(b
< u
->hwbuf_size
) ?
547 ((u
->hwbuf_size
- b
) / u
->frame_size
) : 0);
549 fix_tsched_watermark(u
);
553 pa_log_debug("hwbuf_unused_frames=%lu", (unsigned long) u
->hwbuf_unused_frames
);
558 pa_usec_t sleep_usec
, process_usec
;
560 hw_sleep_time(u
, &sleep_usec
, &process_usec
);
561 avail_min
+= pa_usec_to_bytes(sleep_usec
, &u
->source
->sample_spec
);
564 pa_log_debug("setting avail_min=%lu", (unsigned long) avail_min
);
566 if ((err
= pa_alsa_set_sw_params(u
->pcm_handle
, avail_min
)) < 0) {
567 pa_log("Failed to set software parameters: %s", snd_strerror(err
));
574 static int unsuspend(struct userdata
*u
) {
579 snd_pcm_uframes_t period_size
;
582 pa_assert(!u
->pcm_handle
);
584 pa_log_info("Trying resume...");
586 snd_config_update_free_global();
588 if ((err
= snd_pcm_open(&u
->pcm_handle
, u
->device_name
, SND_PCM_STREAM_CAPTURE
,
589 /*SND_PCM_NONBLOCK|*/
590 SND_PCM_NO_AUTO_RESAMPLE
|
591 SND_PCM_NO_AUTO_CHANNELS
|
592 SND_PCM_NO_AUTO_FORMAT
)) < 0) {
593 pa_log("Error opening PCM device %s: %s", u
->device_name
, snd_strerror(err
));
597 ss
= u
->source
->sample_spec
;
598 nfrags
= u
->nfragments
;
599 period_size
= u
->fragment_size
/ u
->frame_size
;
603 if ((err
= pa_alsa_set_hw_params(u
->pcm_handle
, &ss
, &nfrags
, &period_size
, u
->hwbuf_size
/ u
->frame_size
, &b
, &d
, TRUE
)) < 0) {
604 pa_log("Failed to set hardware parameters: %s", snd_strerror(err
));
608 if (b
!= u
->use_mmap
|| d
!= u
->use_tsched
) {
609 pa_log_warn("Resume failed, couldn't get original access mode.");
613 if (!pa_sample_spec_equal(&ss
, &u
->source
->sample_spec
)) {
614 pa_log_warn("Resume failed, couldn't restore original sample settings.");
618 if (nfrags
!= u
->nfragments
|| period_size
*u
->frame_size
!= u
->fragment_size
) {
619 pa_log_warn("Resume failed, couldn't restore original fragment settings. (Old: %lu*%lu, New %lu*%lu)",
620 (unsigned long) u
->nfragments
, (unsigned long) u
->fragment_size
,
621 (unsigned long) nfrags
, period_size
* u
->frame_size
);
625 if (update_sw_params(u
) < 0)
628 if (build_pollfd(u
) < 0)
631 /* FIXME: We need to reload the volume somehow */
633 snd_pcm_start(u
->pcm_handle
);
634 pa_smoother_resume(u
->smoother
, pa_rtclock_usec());
636 pa_log_info("Resumed successfully...");
642 snd_pcm_close(u
->pcm_handle
);
643 u
->pcm_handle
= NULL
;
649 static int source_process_msg(pa_msgobject
*o
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
650 struct userdata
*u
= PA_SOURCE(o
)->userdata
;
654 case PA_SOURCE_MESSAGE_GET_LATENCY
: {
658 r
= source_get_latency(u
);
660 *((pa_usec_t
*) data
) = r
;
665 case PA_SOURCE_MESSAGE_SET_STATE
:
667 switch ((pa_source_state_t
) PA_PTR_TO_UINT(data
)) {
669 case PA_SOURCE_SUSPENDED
:
670 pa_assert(PA_SOURCE_IS_OPENED(u
->source
->thread_info
.state
));
678 case PA_SOURCE_RUNNING
:
680 if (u
->source
->thread_info
.state
== PA_SOURCE_INIT
) {
681 if (build_pollfd(u
) < 0)
684 snd_pcm_start(u
->pcm_handle
);
687 if (u
->source
->thread_info
.state
== PA_SOURCE_SUSPENDED
) {
688 if (unsuspend(u
) < 0)
694 case PA_SOURCE_UNLINKED
:
702 return pa_source_process_msg(o
, code
, data
, offset
, chunk
);
705 static int mixer_callback(snd_mixer_elem_t
*elem
, unsigned int mask
) {
706 struct userdata
*u
= snd_mixer_elem_get_callback_private(elem
);
709 pa_assert(u
->mixer_handle
);
711 if (mask
== SND_CTL_EVENT_MASK_REMOVE
)
714 if (mask
& SND_CTL_EVENT_MASK_VALUE
) {
715 pa_source_get_volume(u
->source
, TRUE
);
716 pa_source_get_mute(u
->source
, TRUE
);
722 static pa_volume_t
from_alsa_volume(struct userdata
*u
, long alsa_vol
) {
724 return (pa_volume_t
) round(((double) (alsa_vol
- u
->hw_volume_min
) * PA_VOLUME_NORM
) /
725 (double) (u
->hw_volume_max
- u
->hw_volume_min
));
728 static long to_alsa_volume(struct userdata
*u
, pa_volume_t vol
) {
731 alsa_vol
= (long) round(((double) vol
* (double) (u
->hw_volume_max
- u
->hw_volume_min
))
732 / PA_VOLUME_NORM
) + u
->hw_volume_min
;
734 return PA_CLAMP_UNLIKELY(alsa_vol
, u
->hw_volume_min
, u
->hw_volume_max
);
737 static int source_get_volume_cb(pa_source
*s
) {
738 struct userdata
*u
= s
->userdata
;
742 char t
[PA_CVOLUME_SNPRINT_MAX
];
745 pa_assert(u
->mixer_elem
);
747 if (u
->mixer_seperate_channels
) {
749 r
.channels
= s
->sample_spec
.channels
;
751 for (i
= 0; i
< s
->sample_spec
.channels
; i
++) {
754 if (u
->hw_dB_supported
) {
756 if ((err
= snd_mixer_selem_get_capture_dB(u
->mixer_elem
, u
->mixer_map
[i
], &alsa_vol
)) < 0)
759 #ifdef HAVE_VALGRIND_MEMCHECK_H
760 VALGRIND_MAKE_MEM_DEFINED(&alsa_vol
, sizeof(alsa_vol
));
763 r
.values
[i
] = pa_sw_volume_from_dB((double) (alsa_vol
- u
->hw_dB_max
) / 100.0);
766 if ((err
= snd_mixer_selem_get_capture_volume(u
->mixer_elem
, u
->mixer_map
[i
], &alsa_vol
)) < 0)
769 r
.values
[i
] = from_alsa_volume(u
, alsa_vol
);
776 if (u
->hw_dB_supported
) {
778 if ((err
= snd_mixer_selem_get_capture_dB(u
->mixer_elem
, SND_MIXER_SCHN_MONO
, &alsa_vol
)) < 0)
781 #ifdef HAVE_VALGRIND_MEMCHECK_H
782 VALGRIND_MAKE_MEM_DEFINED(&alsa_vol
, sizeof(alsa_vol
));
785 pa_cvolume_set(&r
, s
->sample_spec
.channels
, pa_sw_volume_from_dB((double) (alsa_vol
- u
->hw_dB_max
) / 100.0));
789 if ((err
= snd_mixer_selem_get_capture_volume(u
->mixer_elem
, SND_MIXER_SCHN_MONO
, &alsa_vol
)) < 0)
792 pa_cvolume_set(&r
, s
->sample_spec
.channels
, from_alsa_volume(u
, alsa_vol
));
796 pa_log_debug("Read hardware volume: %s", pa_cvolume_snprint(t
, sizeof(t
), &r
));
798 if (!pa_cvolume_equal(&u
->hardware_volume
, &r
)) {
800 u
->hardware_volume
= s
->volume
= r
;
802 if (u
->hw_dB_supported
) {
805 /* Hmm, so the hardware volume changed, let's reset our software volume */
807 pa_cvolume_reset(&reset
, s
->sample_spec
.channels
);
808 pa_source_set_soft_volume(s
, &reset
);
815 pa_log_error("Unable to read volume: %s", snd_strerror(err
));
820 static int source_set_volume_cb(pa_source
*s
) {
821 struct userdata
*u
= s
->userdata
;
827 pa_assert(u
->mixer_elem
);
829 if (u
->mixer_seperate_channels
) {
831 r
.channels
= s
->sample_spec
.channels
;
833 for (i
= 0; i
< s
->sample_spec
.channels
; i
++) {
837 vol
= s
->volume
.values
[i
];
839 if (u
->hw_dB_supported
) {
841 alsa_vol
= (long) (pa_sw_volume_to_dB(vol
) * 100);
842 alsa_vol
+= u
->hw_dB_max
;
843 alsa_vol
= PA_CLAMP_UNLIKELY(alsa_vol
, u
->hw_dB_min
, u
->hw_dB_max
);
845 if ((err
= snd_mixer_selem_set_capture_dB(u
->mixer_elem
, u
->mixer_map
[i
], alsa_vol
, 1)) < 0)
848 if ((err
= snd_mixer_selem_get_capture_dB(u
->mixer_elem
, u
->mixer_map
[i
], &alsa_vol
)) < 0)
851 r
.values
[i
] = pa_sw_volume_from_dB((double) (alsa_vol
- u
->hw_dB_max
) / 100.0);
854 alsa_vol
= to_alsa_volume(u
, vol
);
856 if ((err
= snd_mixer_selem_set_capture_volume(u
->mixer_elem
, u
->mixer_map
[i
], alsa_vol
)) < 0)
859 if ((err
= snd_mixer_selem_get_capture_volume(u
->mixer_elem
, u
->mixer_map
[i
], &alsa_vol
)) < 0)
862 r
.values
[i
] = from_alsa_volume(u
, alsa_vol
);
870 vol
= pa_cvolume_max(&s
->volume
);
872 if (u
->hw_dB_supported
) {
873 alsa_vol
= (long) (pa_sw_volume_to_dB(vol
) * 100);
874 alsa_vol
+= u
->hw_dB_max
;
875 alsa_vol
= PA_CLAMP_UNLIKELY(alsa_vol
, u
->hw_dB_min
, u
->hw_dB_max
);
877 if ((err
= snd_mixer_selem_set_capture_dB_all(u
->mixer_elem
, alsa_vol
, 1)) < 0)
880 if ((err
= snd_mixer_selem_get_capture_dB(u
->mixer_elem
, SND_MIXER_SCHN_MONO
, &alsa_vol
)) < 0)
883 pa_cvolume_set(&r
, s
->volume
.channels
, pa_sw_volume_from_dB((double) (alsa_vol
- u
->hw_dB_max
) / 100.0));
886 alsa_vol
= to_alsa_volume(u
, vol
);
888 if ((err
= snd_mixer_selem_set_capture_volume_all(u
->mixer_elem
, alsa_vol
)) < 0)
891 if ((err
= snd_mixer_selem_get_capture_volume(u
->mixer_elem
, SND_MIXER_SCHN_MONO
, &alsa_vol
)) < 0)
894 pa_cvolume_set(&r
, s
->sample_spec
.channels
, from_alsa_volume(u
, alsa_vol
));
898 u
->hardware_volume
= r
;
900 if (u
->hw_dB_supported
) {
901 char t
[PA_CVOLUME_SNPRINT_MAX
];
903 /* Match exactly what the user requested by software */
905 pa_sw_cvolume_divide(&r
, &s
->volume
, &r
);
906 pa_source_set_soft_volume(s
, &r
);
908 pa_log_debug("Requested volume: %s", pa_cvolume_snprint(t
, sizeof(t
), &s
->volume
));
909 pa_log_debug("Got hardware volume: %s", pa_cvolume_snprint(t
, sizeof(t
), &u
->hardware_volume
));
910 pa_log_debug("Calculated software volume: %s", pa_cvolume_snprint(t
, sizeof(t
), &r
));
914 /* We can't match exactly what the user requested, hence let's
915 * at least tell the user about it */
922 pa_log_error("Unable to set volume: %s", snd_strerror(err
));
927 static int source_get_mute_cb(pa_source
*s
) {
928 struct userdata
*u
= s
->userdata
;
932 pa_assert(u
->mixer_elem
);
934 if ((err
= snd_mixer_selem_get_capture_switch(u
->mixer_elem
, 0, &sw
)) < 0) {
935 pa_log_error("Unable to get switch: %s", snd_strerror(err
));
944 static int source_set_mute_cb(pa_source
*s
) {
945 struct userdata
*u
= s
->userdata
;
949 pa_assert(u
->mixer_elem
);
951 if ((err
= snd_mixer_selem_set_capture_switch_all(u
->mixer_elem
, !s
->muted
)) < 0) {
952 pa_log_error("Unable to set switch: %s", snd_strerror(err
));
959 static void source_update_requested_latency_cb(pa_source
*s
) {
960 struct userdata
*u
= s
->userdata
;
969 static void thread_func(void *userdata
) {
970 struct userdata
*u
= userdata
;
971 unsigned short revents
= 0;
975 pa_log_debug("Thread starting up");
977 if (u
->core
->realtime_scheduling
)
978 pa_make_realtime(u
->core
->realtime_priority
);
980 pa_thread_mq_install(&u
->thread_mq
);
981 pa_rtpoll_install(u
->rtpoll
);
986 /* pa_log_debug("loop"); */
988 /* Read some data and pass it to the sources */
989 if (PA_SOURCE_IS_OPENED(u
->source
->thread_info
.state
)) {
991 pa_usec_t sleep_usec
= 0;
994 work_done
= mmap_read(u
, &sleep_usec
, revents
& POLLIN
);
996 work_done
= unix_read(u
, &sleep_usec
, revents
& POLLIN
);
1001 /* pa_log_debug("work_done = %i", work_done); */
1006 if (u
->use_tsched
) {
1009 /* OK, the capture buffer is now empty, let's
1010 * calculate when to wake up next */
1012 /* pa_log_debug("Waking up in %0.2fms (sound card clock).", (double) sleep_usec / PA_USEC_PER_MSEC); */
1014 /* Convert from the sound card time domain to the
1015 * system time domain */
1016 cusec
= pa_smoother_translate(u
->smoother
, pa_rtclock_usec(), sleep_usec
);
1018 /* pa_log_debug("Waking up in %0.2fms (system clock).", (double) cusec / PA_USEC_PER_MSEC); */
1020 /* We don't trust the conversion, so we wake up whatever comes first */
1021 pa_rtpoll_set_timer_relative(u
->rtpoll
, PA_MIN(sleep_usec
, cusec
));
1023 } else if (u
->use_tsched
)
1025 /* OK, we're in an invalid state, let's disable our timers */
1026 pa_rtpoll_set_timer_disabled(u
->rtpoll
);
1028 /* Hmm, nothing to do. Let's sleep */
1029 if ((ret
= pa_rtpoll_run(u
->rtpoll
, TRUE
)) < 0)
1035 /* Tell ALSA about this and process its response */
1036 if (PA_SOURCE_IS_OPENED(u
->source
->thread_info
.state
)) {
1037 struct pollfd
*pollfd
;
1041 pollfd
= pa_rtpoll_item_get_pollfd(u
->alsa_rtpoll_item
, &n
);
1043 if ((err
= snd_pcm_poll_descriptors_revents(u
->pcm_handle
, pollfd
, n
, &revents
)) < 0) {
1044 pa_log("snd_pcm_poll_descriptors_revents() failed: %s", snd_strerror(err
));
1048 if (revents
& (POLLOUT
|POLLERR
|POLLNVAL
|POLLHUP
|POLLPRI
)) {
1049 if (pa_alsa_recover_from_poll(u
->pcm_handle
, revents
) < 0)
1052 snd_pcm_start(u
->pcm_handle
);
1055 if (revents
&& u
->use_tsched
)
1056 pa_log_debug("Wakeup from ALSA!%s%s", (revents
& POLLIN
) ? " INPUT" : "", (revents
& POLLOUT
) ? " OUTPUT" : "");
1062 /* If this was no regular exit from the loop we have to continue
1063 * processing messages until we received PA_MESSAGE_SHUTDOWN */
1064 pa_asyncmsgq_post(u
->thread_mq
.outq
, PA_MSGOBJECT(u
->core
), PA_CORE_MESSAGE_UNLOAD_MODULE
, u
->module
, 0, NULL
, NULL
);
1065 pa_asyncmsgq_wait_for(u
->thread_mq
.inq
, PA_MESSAGE_SHUTDOWN
);
1068 pa_log_debug("Thread shutting down");
1071 int pa__init(pa_module
*m
) {
1073 pa_modargs
*ma
= NULL
;
1074 struct userdata
*u
= NULL
;
1078 uint32_t nfrags
, hwbuf_size
, frag_size
, tsched_size
, tsched_watermark
;
1079 snd_pcm_uframes_t period_frames
, tsched_frames
;
1081 snd_pcm_info_t
*pcm_info
= NULL
;
1084 char *name_buf
= NULL
;
1085 pa_bool_t namereg_fail
;
1086 pa_bool_t use_mmap
= TRUE
, b
, use_tsched
= TRUE
, d
;
1087 pa_source_new_data data
;
1089 snd_pcm_info_alloca(&pcm_info
);
1093 pa_alsa_redirect_errors_inc();
1095 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
1096 pa_log("Failed to parse module arguments");
1100 ss
= m
->core
->default_sample_spec
;
1101 if (pa_modargs_get_sample_spec_and_channel_map(ma
, &ss
, &map
, PA_CHANNEL_MAP_ALSA
) < 0) {
1102 pa_log("Failed to parse sample specification");
1106 frame_size
= pa_frame_size(&ss
);
1108 nfrags
= m
->core
->default_n_fragments
;
1109 frag_size
= (uint32_t) pa_usec_to_bytes(m
->core
->default_fragment_size_msec
*PA_USEC_PER_MSEC
, &ss
);
1111 frag_size
= (uint32_t) frame_size
;
1112 tsched_size
= (uint32_t) pa_usec_to_bytes(DEFAULT_TSCHED_BUFFER_USEC
, &ss
);
1113 tsched_watermark
= (uint32_t) pa_usec_to_bytes(DEFAULT_TSCHED_WATERMARK_USEC
, &ss
);
1115 if (pa_modargs_get_value_u32(ma
, "fragments", &nfrags
) < 0 ||
1116 pa_modargs_get_value_u32(ma
, "fragment_size", &frag_size
) < 0 ||
1117 pa_modargs_get_value_u32(ma
, "tsched_buffer_size", &tsched_size
) < 0 ||
1118 pa_modargs_get_value_u32(ma
, "tsched_buffer_watermark", &tsched_watermark
) < 0) {
1119 pa_log("Failed to parse buffer metrics");
1123 hwbuf_size
= frag_size
* nfrags
;
1124 period_frames
= frag_size
/frame_size
;
1125 tsched_frames
= tsched_size
/frame_size
;
1127 if (pa_modargs_get_value_boolean(ma
, "mmap", &use_mmap
) < 0) {
1128 pa_log("Failed to parse mmap argument.");
1132 if (pa_modargs_get_value_boolean(ma
, "tsched", &use_tsched
) < 0) {
1133 pa_log("Failed to parse timer_scheduling argument.");
1137 if (use_tsched
&& !pa_rtclock_hrtimer()) {
1138 pa_log_notice("Disabling timer-based scheduling because high-resolution timers are not available from the kernel.");
1142 u
= pa_xnew0(struct userdata
, 1);
1146 u
->use_mmap
= use_mmap
;
1147 u
->use_tsched
= use_tsched
;
1148 u
->rtpoll
= pa_rtpoll_new();
1149 pa_thread_mq_init(&u
->thread_mq
, m
->core
->mainloop
, u
->rtpoll
);
1150 u
->alsa_rtpoll_item
= NULL
;
1152 u
->smoother
= pa_smoother_new(DEFAULT_TSCHED_WATERMARK_USEC
, DEFAULT_TSCHED_WATERMARK_USEC
, TRUE
, 5);
1153 pa_smoother_set_time_offset(u
->smoother
, pa_rtclock_usec());
1155 snd_config_update_free_global();
1160 if ((dev_id
= pa_modargs_get_value(ma
, "device_id", NULL
))) {
1162 if (!(u
->pcm_handle
= pa_alsa_open_by_device_id(
1166 SND_PCM_STREAM_CAPTURE
,
1167 &nfrags
, &period_frames
, tsched_frames
,
1173 if (!(u
->pcm_handle
= pa_alsa_open_by_device_string(
1174 pa_modargs_get_value(ma
, "device", DEFAULT_DEVICE
),
1177 SND_PCM_STREAM_CAPTURE
,
1178 &nfrags
, &period_frames
, tsched_frames
,
1183 pa_assert(u
->device_name
);
1184 pa_log_info("Successfully opened device %s.", u
->device_name
);
1186 if (use_mmap
&& !b
) {
1187 pa_log_info("Device doesn't support mmap(), falling back to UNIX read/write mode.");
1188 u
->use_mmap
= use_mmap
= FALSE
;
1191 if (use_tsched
&& (!b
|| !d
)) {
1192 pa_log_info("Cannot enabled timer-based scheduling, falling back to sound IRQ scheduling.");
1193 u
->use_tsched
= use_tsched
= FALSE
;
1197 pa_log_info("Successfully enabled mmap() mode.");
1200 pa_log_info("Successfully enabled timer-based scheduling mode.");
1202 if ((err
= snd_pcm_info(u
->pcm_handle
, pcm_info
)) < 0) {
1203 pa_log("Error fetching PCM info: %s", snd_strerror(err
));
1207 /* ALSA might tweak the sample spec, so recalculate the frame size */
1208 frame_size
= pa_frame_size(&ss
);
1210 if ((err
= snd_mixer_open(&u
->mixer_handle
, 0)) < 0)
1211 pa_log("Error opening mixer: %s", snd_strerror(err
));
1213 pa_bool_t found
= FALSE
;
1215 if (pa_alsa_prepare_mixer(u
->mixer_handle
, u
->device_name
) >= 0)
1218 snd_pcm_info_t
* info
;
1220 snd_pcm_info_alloca(&info
);
1222 if (snd_pcm_info(u
->pcm_handle
, info
) >= 0) {
1226 if ((card
= snd_pcm_info_get_card(info
)) >= 0) {
1228 md
= pa_sprintf_malloc("hw:%i", card
);
1230 if (strcmp(u
->device_name
, md
))
1231 if (pa_alsa_prepare_mixer(u
->mixer_handle
, md
) >= 0)
1239 if (!(u
->mixer_elem
= pa_alsa_find_elem(u
->mixer_handle
, "Capture", "Mic")))
1243 snd_mixer_close(u
->mixer_handle
);
1244 u
->mixer_handle
= NULL
;
1248 if ((name
= pa_modargs_get_value(ma
, "source_name", NULL
)))
1249 namereg_fail
= TRUE
;
1251 name
= name_buf
= pa_sprintf_malloc("alsa_input.%s", u
->device_name
);
1252 namereg_fail
= FALSE
;
1255 pa_source_new_data_init(&data
);
1256 data
.driver
= __FILE__
;
1258 pa_source_new_data_set_name(&data
, name
);
1259 data
.namereg_fail
= namereg_fail
;
1260 pa_source_new_data_set_sample_spec(&data
, &ss
);
1261 pa_source_new_data_set_channel_map(&data
, &map
);
1263 pa_alsa_init_proplist(data
.proplist
, pcm_info
);
1264 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_STRING
, u
->device_name
);
1265 pa_proplist_setf(data
.proplist
, PA_PROP_DEVICE_BUFFERING_BUFFER_SIZE
, "%lu", (unsigned long) (period_frames
* frame_size
* nfrags
));
1266 pa_proplist_setf(data
.proplist
, PA_PROP_DEVICE_BUFFERING_FRAGMENT_SIZE
, "%lu", (unsigned long) (period_frames
* frame_size
));
1267 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_ACCESS_MODE
, u
->use_tsched
? "mmap+timer" : (u
->use_mmap
? "mmap" : "serial"));
1269 u
->source
= pa_source_new(m
->core
, &data
, PA_SOURCE_HARDWARE
|PA_SOURCE_LATENCY
);
1270 pa_source_new_data_done(&data
);
1274 pa_log("Failed to create source object");
1278 u
->source
->parent
.process_msg
= source_process_msg
;
1279 u
->source
->update_requested_latency
= source_update_requested_latency_cb
;
1280 u
->source
->userdata
= u
;
1282 pa_source_set_asyncmsgq(u
->source
, u
->thread_mq
.inq
);
1283 pa_source_set_rtpoll(u
->source
, u
->rtpoll
);
1285 u
->frame_size
= frame_size
;
1286 u
->fragment_size
= frag_size
= (uint32_t) (period_frames
* frame_size
);
1287 u
->nfragments
= nfrags
;
1288 u
->hwbuf_size
= u
->fragment_size
* nfrags
;
1289 u
->hwbuf_unused_frames
= 0;
1290 u
->tsched_watermark
= tsched_watermark
;
1292 u
->hw_dB_supported
= FALSE
;
1293 u
->hw_dB_min
= u
->hw_dB_max
= 0;
1294 u
->hw_volume_min
= u
->hw_volume_max
= 0;
1295 u
->mixer_seperate_channels
= FALSE
;
1296 pa_cvolume_mute(&u
->hardware_volume
, u
->source
->sample_spec
.channels
);
1299 fix_tsched_watermark(u
);
1301 pa_source_set_latency_range(u
->source
,
1302 !use_tsched
? pa_bytes_to_usec(u
->hwbuf_size
, &ss
) : (pa_usec_t
) -1,
1303 pa_bytes_to_usec(u
->hwbuf_size
, &ss
));
1305 pa_log_info("Using %u fragments of size %lu bytes, buffer time is %0.2fms",
1306 nfrags
, (long unsigned) u
->fragment_size
,
1307 (double) pa_bytes_to_usec(u
->hwbuf_size
, &ss
) / PA_USEC_PER_MSEC
);
1310 pa_log_info("Time scheduling watermark is %0.2fms",
1311 (double) pa_bytes_to_usec(u
->tsched_watermark
, &ss
) / PA_USEC_PER_MSEC
);
1313 if (update_sw_params(u
) < 0)
1316 if (u
->mixer_handle
) {
1317 pa_assert(u
->mixer_elem
);
1319 if (snd_mixer_selem_has_capture_volume(u
->mixer_elem
)) {
1320 pa_bool_t suitable
= FALSE
;
1322 if (snd_mixer_selem_get_capture_volume_range(u
->mixer_elem
, &u
->hw_volume_min
, &u
->hw_volume_max
) < 0)
1323 pa_log_info("Failed to get volume range. Falling back to software volume control.");
1324 else if (u
->hw_volume_min
>= u
->hw_volume_max
)
1325 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
);
1327 pa_log_info("Volume ranges from %li to %li.", u
->hw_volume_min
, u
->hw_volume_max
);
1331 if (snd_mixer_selem_get_capture_dB_range(u
->mixer_elem
, &u
->hw_dB_min
, &u
->hw_dB_max
) < 0)
1332 pa_log_info("Mixer doesn't support dB information.");
1334 #ifdef HAVE_VALGRIND_MEMCHECK_H
1335 VALGRIND_MAKE_MEM_DEFINED(&u
->hw_dB_min
, sizeof(u
->hw_dB_min
));
1336 VALGRIND_MAKE_MEM_DEFINED(&u
->hw_dB_max
, sizeof(u
->hw_dB_max
));
1339 if (u
->hw_dB_min
>= u
->hw_dB_max
)
1340 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);
1342 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);
1343 u
->hw_dB_supported
= TRUE
;
1348 !u
->hw_dB_supported
&&
1349 u
->hw_volume_max
- u
->hw_volume_min
< 3) {
1351 pa_log_info("Device has less than 4 volume levels. Falling back to software volume control.");
1356 u
->mixer_seperate_channels
= pa_alsa_calc_mixer_map(u
->mixer_elem
, &map
, u
->mixer_map
, FALSE
) >= 0;
1358 u
->source
->get_volume
= source_get_volume_cb
;
1359 u
->source
->set_volume
= source_set_volume_cb
;
1360 u
->source
->flags
|= PA_SOURCE_HW_VOLUME_CTRL
| (u
->hw_dB_supported
? PA_SOURCE_DECIBEL_VOLUME
: 0);
1361 pa_log_info("Using hardware volume control. Hardware dB scale %s.", u
->hw_dB_supported
? "supported" : "not supported");
1363 pa_log_info("Using software volume control.");
1366 if (snd_mixer_selem_has_capture_switch(u
->mixer_elem
)) {
1367 u
->source
->get_mute
= source_get_mute_cb
;
1368 u
->source
->set_mute
= source_set_mute_cb
;
1369 u
->source
->flags
|= PA_SOURCE_HW_MUTE_CTRL
;
1371 pa_log_info("Using software mute control.");
1373 u
->mixer_fdl
= pa_alsa_fdlist_new();
1375 if (pa_alsa_fdlist_set_mixer(u
->mixer_fdl
, u
->mixer_handle
, m
->core
->mainloop
) < 0) {
1376 pa_log("Failed to initialize file descriptor monitoring");
1380 snd_mixer_elem_set_callback(u
->mixer_elem
, mixer_callback
);
1381 snd_mixer_elem_set_callback_private(u
->mixer_elem
, u
);
1383 u
->mixer_fdl
= NULL
;
1385 pa_alsa_dump(u
->pcm_handle
);
1387 if (!(u
->thread
= pa_thread_new(thread_func
, u
))) {
1388 pa_log("Failed to create thread.");
1391 /* Get initial mixer settings */
1392 if (data
.volume_is_set
) {
1393 if (u
->source
->set_volume
)
1394 u
->source
->set_volume(u
->source
);
1396 if (u
->source
->get_volume
)
1397 u
->source
->get_volume(u
->source
);
1400 if (data
.muted_is_set
) {
1401 if (u
->source
->set_mute
)
1402 u
->source
->set_mute(u
->source
);
1404 if (u
->source
->get_mute
)
1405 u
->source
->get_mute(u
->source
);
1408 pa_source_put(u
->source
);
1410 pa_modargs_free(ma
);
1417 pa_modargs_free(ma
);
1424 void pa__done(pa_module
*m
) {
1429 if (!(u
= m
->userdata
)) {
1430 pa_alsa_redirect_errors_dec();
1435 pa_source_unlink(u
->source
);
1438 pa_asyncmsgq_send(u
->thread_mq
.inq
, NULL
, PA_MESSAGE_SHUTDOWN
, NULL
, 0, NULL
);
1439 pa_thread_free(u
->thread
);
1442 pa_thread_mq_done(&u
->thread_mq
);
1445 pa_source_unref(u
->source
);
1447 if (u
->alsa_rtpoll_item
)
1448 pa_rtpoll_item_free(u
->alsa_rtpoll_item
);
1451 pa_rtpoll_free(u
->rtpoll
);
1454 pa_alsa_fdlist_free(u
->mixer_fdl
);
1456 if (u
->mixer_handle
)
1457 snd_mixer_close(u
->mixer_handle
);
1459 if (u
->pcm_handle
) {
1460 snd_pcm_drop(u
->pcm_handle
);
1461 snd_pcm_close(u
->pcm_handle
);
1465 pa_smoother_free(u
->smoother
);
1467 pa_xfree(u
->device_name
);
1470 snd_config_update_free_global();
1471 pa_alsa_redirect_errors_dec();