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
;
215 if ((size_t) n
*u
->frame_size
< u
->hwbuf_size
)
216 left_to_record
= u
->hwbuf_size
- ((size_t) n
*u
->frame_size
);
220 if (left_to_record
> 0) {
221 /* 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); */
223 pa_log_info("Overrun!");
226 size_t old_watermark
= u
->tsched_watermark
;
228 u
->tsched_watermark
*= 2;
229 fix_tsched_watermark(u
);
231 if (old_watermark
!= u
->tsched_watermark
)
232 pa_log_notice("Increasing wakeup watermark to %0.2f ms",
233 (double) pa_bytes_to_usec(u
->tsched_watermark
, &u
->source
->sample_spec
) / PA_USEC_PER_MSEC
);
237 return left_to_record
;
240 static int mmap_read(struct userdata
*u
, pa_usec_t
*sleep_usec
) {
242 pa_usec_t max_sleep_usec
= 0, process_usec
= 0;
243 size_t left_to_record
;
246 pa_source_assert_ref(u
->source
);
249 hw_sleep_time(u
, &max_sleep_usec
, &process_usec
);
255 snd_pcm_hwsync(u
->pcm_handle
);
257 if (PA_UNLIKELY((n
= snd_pcm_avail_update(u
->pcm_handle
)) < 0)) {
259 if ((r
= try_recover(u
, "snd_pcm_avail_update", (int) n
)) == 0)
265 left_to_record
= check_left_to_record(u
, n
);
268 if (pa_bytes_to_usec(left_to_record
, &u
->source
->sample_spec
) > process_usec
+max_sleep_usec
/2)
271 if (PA_UNLIKELY(n
<= 0))
276 const snd_pcm_channel_area_t
*areas
;
277 snd_pcm_uframes_t offset
, frames
= (snd_pcm_uframes_t
) n
;
280 snd_pcm_sframes_t sframes
;
282 /* pa_log_debug("%lu frames to read", (unsigned long) frames); */
284 if (PA_UNLIKELY((err
= snd_pcm_mmap_begin(u
->pcm_handle
, &areas
, &offset
, &frames
)) < 0)) {
286 if ((r
= try_recover(u
, "snd_pcm_mmap_begin", err
)) == 0)
292 /* Make sure that if these memblocks need to be copied they will fit into one slot */
293 if (frames
> pa_mempool_block_size_max(u
->source
->core
->mempool
)/u
->frame_size
)
294 frames
= pa_mempool_block_size_max(u
->source
->core
->mempool
)/u
->frame_size
;
296 /* Check these are multiples of 8 bit */
297 pa_assert((areas
[0].first
& 7) == 0);
298 pa_assert((areas
[0].step
& 7)== 0);
300 /* We assume a single interleaved memory buffer */
301 pa_assert((areas
[0].first
>> 3) == 0);
302 pa_assert((areas
[0].step
>> 3) == u
->frame_size
);
304 p
= (uint8_t*) areas
[0].addr
+ (offset
* u
->frame_size
);
306 chunk
.memblock
= pa_memblock_new_fixed(u
->core
->mempool
, p
, frames
* u
->frame_size
, TRUE
);
307 chunk
.length
= pa_memblock_get_length(chunk
.memblock
);
310 pa_source_post(u
->source
, &chunk
);
311 pa_memblock_unref_fixed(chunk
.memblock
);
313 if (PA_UNLIKELY((sframes
= snd_pcm_mmap_commit(u
->pcm_handle
, offset
, frames
)) < 0)) {
315 if ((r
= try_recover(u
, "snd_pcm_mmap_commit", (int) sframes
)) == 0)
323 u
->frame_index
+= (int64_t) frames
;
325 /* pa_log_debug("read %lu frames", (unsigned long) frames); */
327 if (frames
>= (snd_pcm_uframes_t
) n
)
330 n
-= (snd_pcm_sframes_t
) frames
;
334 *sleep_usec
= pa_bytes_to_usec(left_to_record
, &u
->source
->sample_spec
) - process_usec
;
338 static int unix_read(struct userdata
*u
, pa_usec_t
*sleep_usec
) {
340 pa_usec_t max_sleep_usec
= 0, process_usec
= 0;
341 size_t left_to_record
;
344 pa_source_assert_ref(u
->source
);
347 hw_sleep_time(u
, &max_sleep_usec
, &process_usec
);
353 snd_pcm_hwsync(u
->pcm_handle
);
355 if (PA_UNLIKELY((n
= snd_pcm_avail_update(u
->pcm_handle
)) < 0)) {
357 if ((r
= try_recover(u
, "snd_pcm_avail_update", (int) n
)) == 0)
363 left_to_record
= check_left_to_record(u
, n
);
366 if (pa_bytes_to_usec(left_to_record
, &u
->source
->sample_spec
) > process_usec
+max_sleep_usec
/2)
369 if (PA_UNLIKELY(n
<= 0))
374 snd_pcm_sframes_t frames
;
377 chunk
.memblock
= pa_memblock_new(u
->core
->mempool
, (size_t) -1);
379 frames
= (snd_pcm_sframes_t
) (pa_memblock_get_length(chunk
.memblock
) / u
->frame_size
);
384 /* pa_log_debug("%lu frames to read", (unsigned long) n); */
386 p
= pa_memblock_acquire(chunk
.memblock
);
387 frames
= snd_pcm_readi(u
->pcm_handle
, (uint8_t*) p
, (snd_pcm_uframes_t
) frames
);
388 pa_memblock_release(chunk
.memblock
);
390 pa_assert(frames
!= 0);
392 if (PA_UNLIKELY(frames
< 0)) {
393 pa_memblock_unref(chunk
.memblock
);
395 if ((r
= try_recover(u
, "snd_pcm_readi", (int) (frames
))) == 0)
402 chunk
.length
= (size_t) frames
* u
->frame_size
;
404 pa_source_post(u
->source
, &chunk
);
405 pa_memblock_unref(chunk
.memblock
);
409 u
->frame_index
+= frames
;
411 /* pa_log_debug("read %lu frames", (unsigned long) frames); */
420 *sleep_usec
= pa_bytes_to_usec(left_to_record
, &u
->source
->sample_spec
) - process_usec
;
424 static void update_smoother(struct userdata
*u
) {
425 snd_pcm_sframes_t delay
= 0;
428 pa_usec_t now1
, now2
;
431 pa_assert(u
->pcm_handle
);
433 /* Let's update the time smoother */
435 snd_pcm_hwsync(u
->pcm_handle
);
436 snd_pcm_avail_update(u
->pcm_handle
);
438 if (PA_UNLIKELY((err
= snd_pcm_delay(u
->pcm_handle
, &delay
)) < 0)) {
439 pa_log_warn("Failed to get delay: %s", snd_strerror(err
));
443 frames
= u
->frame_index
+ delay
;
445 now1
= pa_rtclock_usec();
446 now2
= pa_bytes_to_usec((uint64_t) frames
* u
->frame_size
, &u
->source
->sample_spec
);
448 pa_smoother_put(u
->smoother
, now1
, now2
);
451 static pa_usec_t
source_get_latency(struct userdata
*u
) {
454 pa_usec_t now1
, now2
;
458 now1
= pa_rtclock_usec();
459 now2
= pa_smoother_get(u
->smoother
, now1
);
461 delay
= (int64_t) now2
- (int64_t) pa_bytes_to_usec((uint64_t) u
->frame_index
* u
->frame_size
, &u
->source
->sample_spec
);
464 r
= (pa_usec_t
) delay
;
469 static int build_pollfd(struct userdata
*u
) {
471 pa_assert(u
->pcm_handle
);
473 if (u
->alsa_rtpoll_item
)
474 pa_rtpoll_item_free(u
->alsa_rtpoll_item
);
476 if (!(u
->alsa_rtpoll_item
= pa_alsa_build_pollfd(u
->pcm_handle
, u
->rtpoll
)))
482 static int suspend(struct userdata
*u
) {
484 pa_assert(u
->pcm_handle
);
486 pa_smoother_pause(u
->smoother
, pa_rtclock_usec());
489 snd_pcm_close(u
->pcm_handle
);
490 u
->pcm_handle
= NULL
;
492 if (u
->alsa_rtpoll_item
) {
493 pa_rtpoll_item_free(u
->alsa_rtpoll_item
);
494 u
->alsa_rtpoll_item
= NULL
;
497 pa_log_info("Device suspended...");
502 static int update_sw_params(struct userdata
*u
) {
503 snd_pcm_uframes_t avail_min
;
508 /* Use the full buffer if noone asked us for anything specific */
509 u
->hwbuf_unused_frames
= 0;
514 if ((latency
= pa_source_get_requested_latency_within_thread(u
->source
)) != (pa_usec_t
) -1) {
517 pa_log_debug("latency set to %0.2f", (double) latency
/ PA_USEC_PER_MSEC
);
519 b
= pa_usec_to_bytes(latency
, &u
->source
->sample_spec
);
521 /* We need at least one sample in our buffer */
523 if (PA_UNLIKELY(b
< u
->frame_size
))
526 u
->hwbuf_unused_frames
= (snd_pcm_sframes_t
)
527 (PA_LIKELY(b
< u
->hwbuf_size
) ?
528 ((u
->hwbuf_size
- b
) / u
->frame_size
) : 0);
530 fix_tsched_watermark(u
);
534 pa_log_debug("hwbuf_unused_frames=%lu", (unsigned long) u
->hwbuf_unused_frames
);
539 pa_usec_t sleep_usec
, process_usec
;
541 hw_sleep_time(u
, &sleep_usec
, &process_usec
);
542 avail_min
+= pa_usec_to_bytes(sleep_usec
, &u
->source
->sample_spec
);
545 pa_log_debug("setting avail_min=%lu", (unsigned long) avail_min
);
547 if ((err
= pa_alsa_set_sw_params(u
->pcm_handle
, avail_min
)) < 0) {
548 pa_log("Failed to set software parameters: %s", snd_strerror(err
));
555 static int unsuspend(struct userdata
*u
) {
560 snd_pcm_uframes_t period_size
;
563 pa_assert(!u
->pcm_handle
);
565 pa_log_info("Trying resume...");
567 snd_config_update_free_global();
569 if ((err
= snd_pcm_open(&u
->pcm_handle
, u
->device_name
, SND_PCM_STREAM_CAPTURE
,
570 /*SND_PCM_NONBLOCK|*/
571 SND_PCM_NO_AUTO_RESAMPLE
|
572 SND_PCM_NO_AUTO_CHANNELS
|
573 SND_PCM_NO_AUTO_FORMAT
)) < 0) {
574 pa_log("Error opening PCM device %s: %s", u
->device_name
, snd_strerror(err
));
578 ss
= u
->source
->sample_spec
;
579 nfrags
= u
->nfragments
;
580 period_size
= u
->fragment_size
/ u
->frame_size
;
584 if ((err
= pa_alsa_set_hw_params(u
->pcm_handle
, &ss
, &nfrags
, &period_size
, u
->hwbuf_size
/ u
->frame_size
, &b
, &d
, TRUE
)) < 0) {
585 pa_log("Failed to set hardware parameters: %s", snd_strerror(err
));
589 if (b
!= u
->use_mmap
|| d
!= u
->use_tsched
) {
590 pa_log_warn("Resume failed, couldn't get original access mode.");
594 if (!pa_sample_spec_equal(&ss
, &u
->source
->sample_spec
)) {
595 pa_log_warn("Resume failed, couldn't restore original sample settings.");
599 if (nfrags
!= u
->nfragments
|| period_size
*u
->frame_size
!= u
->fragment_size
) {
600 pa_log_warn("Resume failed, couldn't restore original fragment settings. (Old: %lu*%lu, New %lu*%lu)",
601 (unsigned long) u
->nfragments
, (unsigned long) u
->fragment_size
,
602 (unsigned long) nfrags
, period_size
* u
->frame_size
);
606 if (update_sw_params(u
) < 0)
609 if (build_pollfd(u
) < 0)
612 /* FIXME: We need to reload the volume somehow */
614 snd_pcm_start(u
->pcm_handle
);
615 pa_smoother_resume(u
->smoother
, pa_rtclock_usec());
617 pa_log_info("Resumed successfully...");
623 snd_pcm_close(u
->pcm_handle
);
624 u
->pcm_handle
= NULL
;
630 static int source_process_msg(pa_msgobject
*o
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
631 struct userdata
*u
= PA_SOURCE(o
)->userdata
;
635 case PA_SOURCE_MESSAGE_GET_LATENCY
: {
639 r
= source_get_latency(u
);
641 *((pa_usec_t
*) data
) = r
;
646 case PA_SOURCE_MESSAGE_SET_STATE
:
648 switch ((pa_source_state_t
) PA_PTR_TO_UINT(data
)) {
650 case PA_SOURCE_SUSPENDED
:
651 pa_assert(PA_SOURCE_IS_OPENED(u
->source
->thread_info
.state
));
659 case PA_SOURCE_RUNNING
:
661 if (u
->source
->thread_info
.state
== PA_SOURCE_INIT
) {
662 if (build_pollfd(u
) < 0)
665 snd_pcm_start(u
->pcm_handle
);
668 if (u
->source
->thread_info
.state
== PA_SOURCE_SUSPENDED
) {
669 if (unsuspend(u
) < 0)
675 case PA_SOURCE_UNLINKED
:
683 return pa_source_process_msg(o
, code
, data
, offset
, chunk
);
686 static int mixer_callback(snd_mixer_elem_t
*elem
, unsigned int mask
) {
687 struct userdata
*u
= snd_mixer_elem_get_callback_private(elem
);
690 pa_assert(u
->mixer_handle
);
692 if (mask
== SND_CTL_EVENT_MASK_REMOVE
)
695 if (mask
& SND_CTL_EVENT_MASK_VALUE
) {
696 pa_source_get_volume(u
->source
, TRUE
);
697 pa_source_get_mute(u
->source
, TRUE
);
703 static pa_volume_t
from_alsa_volume(struct userdata
*u
, long alsa_vol
) {
705 return (pa_volume_t
) round(((double) (alsa_vol
- u
->hw_volume_min
) * PA_VOLUME_NORM
) /
706 (double) (u
->hw_volume_max
- u
->hw_volume_min
));
709 static long to_alsa_volume(struct userdata
*u
, pa_volume_t vol
) {
712 alsa_vol
= (long) round(((double) vol
* (double) (u
->hw_volume_max
- u
->hw_volume_min
))
713 / PA_VOLUME_NORM
) + u
->hw_volume_min
;
715 return PA_CLAMP_UNLIKELY(alsa_vol
, u
->hw_volume_min
, u
->hw_volume_max
);
718 static int source_get_volume_cb(pa_source
*s
) {
719 struct userdata
*u
= s
->userdata
;
723 char t
[PA_CVOLUME_SNPRINT_MAX
];
726 pa_assert(u
->mixer_elem
);
728 if (u
->mixer_seperate_channels
) {
730 r
.channels
= s
->sample_spec
.channels
;
732 for (i
= 0; i
< s
->sample_spec
.channels
; i
++) {
735 if (u
->hw_dB_supported
) {
737 if ((err
= snd_mixer_selem_get_capture_dB(u
->mixer_elem
, u
->mixer_map
[i
], &alsa_vol
)) < 0)
740 #ifdef HAVE_VALGRIND_MEMCHECK_H
741 VALGRIND_MAKE_MEM_DEFINED(&alsa_vol
, sizeof(alsa_vol
));
744 r
.values
[i
] = pa_sw_volume_from_dB((double) alsa_vol
/ 100.0);
747 if ((err
= snd_mixer_selem_get_capture_volume(u
->mixer_elem
, u
->mixer_map
[i
], &alsa_vol
)) < 0)
750 r
.values
[i
] = from_alsa_volume(u
, alsa_vol
);
757 if (u
->hw_dB_supported
) {
759 if ((err
= snd_mixer_selem_get_capture_dB(u
->mixer_elem
, SND_MIXER_SCHN_MONO
, &alsa_vol
)) < 0)
762 #ifdef HAVE_VALGRIND_MEMCHECK_H
763 VALGRIND_MAKE_MEM_DEFINED(&alsa_vol
, sizeof(alsa_vol
));
766 pa_cvolume_set(&r
, s
->sample_spec
.channels
, pa_sw_volume_from_dB((double) alsa_vol
/ 100.0));
770 if ((err
= snd_mixer_selem_get_capture_volume(u
->mixer_elem
, SND_MIXER_SCHN_MONO
, &alsa_vol
)) < 0)
773 pa_cvolume_set(&r
, s
->sample_spec
.channels
, from_alsa_volume(u
, alsa_vol
));
777 pa_log_debug("Read hardware volume: %s", pa_cvolume_snprint(t
, sizeof(t
), &r
));
779 if (!pa_cvolume_equal(&u
->hardware_volume
, &r
)) {
781 u
->hardware_volume
= s
->volume
= r
;
783 if (u
->hw_dB_supported
) {
786 /* Hmm, so the hardware volume changed, let's reset our software volume */
788 pa_cvolume_reset(&reset
, s
->sample_spec
.channels
);
789 pa_source_set_soft_volume(s
, &reset
);
796 pa_log_error("Unable to read volume: %s", snd_strerror(err
));
801 static int source_set_volume_cb(pa_source
*s
) {
802 struct userdata
*u
= s
->userdata
;
808 pa_assert(u
->mixer_elem
);
810 if (u
->mixer_seperate_channels
) {
812 r
.channels
= s
->sample_spec
.channels
;
814 for (i
= 0; i
< s
->sample_spec
.channels
; i
++) {
818 vol
= s
->volume
.values
[i
];
820 if (u
->hw_dB_supported
) {
822 alsa_vol
= (long) (pa_sw_volume_to_dB(vol
) * 100);
823 alsa_vol
= PA_CLAMP_UNLIKELY(alsa_vol
, u
->hw_dB_min
, u
->hw_dB_max
);
825 if ((err
= snd_mixer_selem_set_capture_dB(u
->mixer_elem
, u
->mixer_map
[i
], alsa_vol
, 1)) < 0)
828 if ((err
= snd_mixer_selem_get_capture_dB(u
->mixer_elem
, u
->mixer_map
[i
], &alsa_vol
)) < 0)
831 r
.values
[i
] = pa_sw_volume_from_dB((double) alsa_vol
/ 100.0);
834 alsa_vol
= to_alsa_volume(u
, vol
);
836 if ((err
= snd_mixer_selem_set_capture_volume(u
->mixer_elem
, u
->mixer_map
[i
], alsa_vol
)) < 0)
839 if ((err
= snd_mixer_selem_get_capture_volume(u
->mixer_elem
, u
->mixer_map
[i
], &alsa_vol
)) < 0)
842 r
.values
[i
] = from_alsa_volume(u
, alsa_vol
);
850 vol
= pa_cvolume_max(&s
->volume
);
852 if (u
->hw_dB_supported
) {
853 alsa_vol
= (long) (pa_sw_volume_to_dB(vol
) * 100);
854 alsa_vol
= PA_CLAMP_UNLIKELY(alsa_vol
, u
->hw_dB_min
, u
->hw_dB_max
);
856 if ((err
= snd_mixer_selem_set_capture_dB_all(u
->mixer_elem
, alsa_vol
, 1)) < 0)
859 if ((err
= snd_mixer_selem_get_capture_dB(u
->mixer_elem
, SND_MIXER_SCHN_MONO
, &alsa_vol
)) < 0)
862 pa_cvolume_set(&r
, s
->volume
.channels
, pa_sw_volume_from_dB((double) alsa_vol
/ 100.0));
865 alsa_vol
= to_alsa_volume(u
, vol
);
867 if ((err
= snd_mixer_selem_set_capture_volume_all(u
->mixer_elem
, alsa_vol
)) < 0)
870 if ((err
= snd_mixer_selem_get_capture_volume(u
->mixer_elem
, SND_MIXER_SCHN_MONO
, &alsa_vol
)) < 0)
873 pa_cvolume_set(&r
, s
->sample_spec
.channels
, from_alsa_volume(u
, alsa_vol
));
877 u
->hardware_volume
= r
;
879 if (u
->hw_dB_supported
) {
880 char t
[PA_CVOLUME_SNPRINT_MAX
];
882 /* Match exactly what the user requested by software */
884 pa_alsa_volume_divide(&r
, &s
->volume
);
885 pa_source_set_soft_volume(s
, &r
);
887 pa_log_debug("Requested volume: %s", pa_cvolume_snprint(t
, sizeof(t
), &s
->volume
));
888 pa_log_debug("Got hardware volume: %s", pa_cvolume_snprint(t
, sizeof(t
), &u
->hardware_volume
));
889 pa_log_debug("Calculated software volume: %s", pa_cvolume_snprint(t
, sizeof(t
), &r
));
893 /* We can't match exactly what the user requested, hence let's
894 * at least tell the user about it */
901 pa_log_error("Unable to set volume: %s", snd_strerror(err
));
906 static int source_get_mute_cb(pa_source
*s
) {
907 struct userdata
*u
= s
->userdata
;
911 pa_assert(u
->mixer_elem
);
913 if ((err
= snd_mixer_selem_get_capture_switch(u
->mixer_elem
, 0, &sw
)) < 0) {
914 pa_log_error("Unable to get switch: %s", snd_strerror(err
));
923 static int source_set_mute_cb(pa_source
*s
) {
924 struct userdata
*u
= s
->userdata
;
928 pa_assert(u
->mixer_elem
);
930 if ((err
= snd_mixer_selem_set_capture_switch_all(u
->mixer_elem
, !s
->muted
)) < 0) {
931 pa_log_error("Unable to set switch: %s", snd_strerror(err
));
938 static void source_update_requested_latency_cb(pa_source
*s
) {
939 struct userdata
*u
= s
->userdata
;
948 static void thread_func(void *userdata
) {
949 struct userdata
*u
= userdata
;
953 pa_log_debug("Thread starting up");
955 if (u
->core
->realtime_scheduling
)
956 pa_make_realtime(u
->core
->realtime_priority
);
958 pa_thread_mq_install(&u
->thread_mq
);
959 pa_rtpoll_install(u
->rtpoll
);
964 /* pa_log_debug("loop"); */
966 /* Read some data and pass it to the sources */
967 if (PA_SOURCE_IS_OPENED(u
->source
->thread_info
.state
)) {
969 pa_usec_t sleep_usec
= 0;
972 work_done
= mmap_read(u
, &sleep_usec
);
974 work_done
= unix_read(u
, &sleep_usec
);
979 /* pa_log_debug("work_done = %i", work_done); */
987 /* OK, the capture buffer is now empty, let's
988 * calculate when to wake up next */
990 /* pa_log_debug("Waking up in %0.2fms (sound card clock).", (double) sleep_usec / PA_USEC_PER_MSEC); */
992 /* Convert from the sound card time domain to the
993 * system time domain */
994 cusec
= pa_smoother_translate(u
->smoother
, pa_rtclock_usec(), sleep_usec
);
996 /* pa_log_debug("Waking up in %0.2fms (system clock).", (double) cusec / PA_USEC_PER_MSEC); */
998 /* We don't trust the conversion, so we wake up whatever comes first */
999 pa_rtpoll_set_timer_relative(u
->rtpoll
, PA_MIN(sleep_usec
, cusec
));
1001 } else if (u
->use_tsched
)
1003 /* OK, we're in an invalid state, let's disable our timers */
1004 pa_rtpoll_set_timer_disabled(u
->rtpoll
);
1006 /* Hmm, nothing to do. Let's sleep */
1007 if ((ret
= pa_rtpoll_run(u
->rtpoll
, TRUE
)) < 0)
1013 /* Tell ALSA about this and process its response */
1014 if (PA_SOURCE_IS_OPENED(u
->source
->thread_info
.state
)) {
1015 struct pollfd
*pollfd
;
1016 unsigned short revents
= 0;
1020 pollfd
= pa_rtpoll_item_get_pollfd(u
->alsa_rtpoll_item
, &n
);
1022 if ((err
= snd_pcm_poll_descriptors_revents(u
->pcm_handle
, pollfd
, n
, &revents
)) < 0) {
1023 pa_log("snd_pcm_poll_descriptors_revents() failed: %s", snd_strerror(err
));
1027 if (revents
& (POLLERR
|POLLNVAL
|POLLHUP
|POLLPRI
)) {
1028 if (pa_alsa_recover_from_poll(u
->pcm_handle
, revents
) < 0)
1031 snd_pcm_start(u
->pcm_handle
);
1034 if (revents
&& u
->use_tsched
)
1035 pa_log_debug("Wakeup from ALSA!%s%s", (revents
& POLLIN
) ? " INPUT" : "", (revents
& POLLOUT
) ? " OUTPUT" : "");
1040 /* If this was no regular exit from the loop we have to continue
1041 * processing messages until we received PA_MESSAGE_SHUTDOWN */
1042 pa_asyncmsgq_post(u
->thread_mq
.outq
, PA_MSGOBJECT(u
->core
), PA_CORE_MESSAGE_UNLOAD_MODULE
, u
->module
, 0, NULL
, NULL
);
1043 pa_asyncmsgq_wait_for(u
->thread_mq
.inq
, PA_MESSAGE_SHUTDOWN
);
1046 pa_log_debug("Thread shutting down");
1049 int pa__init(pa_module
*m
) {
1051 pa_modargs
*ma
= NULL
;
1052 struct userdata
*u
= NULL
;
1056 uint32_t nfrags
, hwbuf_size
, frag_size
, tsched_size
, tsched_watermark
;
1057 snd_pcm_uframes_t period_frames
, tsched_frames
;
1059 snd_pcm_info_t
*pcm_info
= NULL
;
1062 char *name_buf
= NULL
;
1063 pa_bool_t namereg_fail
;
1064 pa_bool_t use_mmap
= TRUE
, b
, use_tsched
= TRUE
, d
;
1065 pa_source_new_data data
;
1067 snd_pcm_info_alloca(&pcm_info
);
1071 pa_alsa_redirect_errors_inc();
1073 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
1074 pa_log("Failed to parse module arguments");
1078 ss
= m
->core
->default_sample_spec
;
1079 if (pa_modargs_get_sample_spec_and_channel_map(ma
, &ss
, &map
, PA_CHANNEL_MAP_ALSA
) < 0) {
1080 pa_log("Failed to parse sample specification");
1084 frame_size
= pa_frame_size(&ss
);
1086 nfrags
= m
->core
->default_n_fragments
;
1087 frag_size
= (uint32_t) pa_usec_to_bytes(m
->core
->default_fragment_size_msec
*PA_USEC_PER_MSEC
, &ss
);
1089 frag_size
= (uint32_t) frame_size
;
1090 tsched_size
= (uint32_t) pa_usec_to_bytes(DEFAULT_TSCHED_BUFFER_USEC
, &ss
);
1091 tsched_watermark
= (uint32_t) pa_usec_to_bytes(DEFAULT_TSCHED_WATERMARK_USEC
, &ss
);
1093 if (pa_modargs_get_value_u32(ma
, "fragments", &nfrags
) < 0 ||
1094 pa_modargs_get_value_u32(ma
, "fragment_size", &frag_size
) < 0 ||
1095 pa_modargs_get_value_u32(ma
, "tsched_buffer_size", &tsched_size
) < 0 ||
1096 pa_modargs_get_value_u32(ma
, "tsched_buffer_watermark", &tsched_watermark
) < 0) {
1097 pa_log("Failed to parse buffer metrics");
1101 hwbuf_size
= frag_size
* nfrags
;
1102 period_frames
= frag_size
/frame_size
;
1103 tsched_frames
= tsched_size
/frame_size
;
1105 if (pa_modargs_get_value_boolean(ma
, "mmap", &use_mmap
) < 0) {
1106 pa_log("Failed to parse mmap argument.");
1110 if (pa_modargs_get_value_boolean(ma
, "tsched", &use_tsched
) < 0) {
1111 pa_log("Failed to parse timer_scheduling argument.");
1115 if (use_tsched
&& !pa_rtclock_hrtimer()) {
1116 pa_log_notice("Disabling timer-based scheduling because high-resolution timers are not available from the kernel.");
1120 u
= pa_xnew0(struct userdata
, 1);
1124 u
->use_mmap
= use_mmap
;
1125 u
->use_tsched
= use_tsched
;
1126 u
->rtpoll
= pa_rtpoll_new();
1127 pa_thread_mq_init(&u
->thread_mq
, m
->core
->mainloop
, u
->rtpoll
);
1128 u
->alsa_rtpoll_item
= NULL
;
1130 u
->smoother
= pa_smoother_new(DEFAULT_TSCHED_WATERMARK_USEC
, DEFAULT_TSCHED_WATERMARK_USEC
, TRUE
, 5);
1131 pa_smoother_set_time_offset(u
->smoother
, pa_rtclock_usec());
1133 snd_config_update_free_global();
1138 if ((dev_id
= pa_modargs_get_value(ma
, "device_id", NULL
))) {
1140 if (!(u
->pcm_handle
= pa_alsa_open_by_device_id(
1144 SND_PCM_STREAM_CAPTURE
,
1145 &nfrags
, &period_frames
, tsched_frames
,
1151 if (!(u
->pcm_handle
= pa_alsa_open_by_device_string(
1152 pa_modargs_get_value(ma
, "device", DEFAULT_DEVICE
),
1155 SND_PCM_STREAM_CAPTURE
,
1156 &nfrags
, &period_frames
, tsched_frames
,
1161 pa_assert(u
->device_name
);
1162 pa_log_info("Successfully opened device %s.", u
->device_name
);
1164 if (use_mmap
&& !b
) {
1165 pa_log_info("Device doesn't support mmap(), falling back to UNIX read/write mode.");
1166 u
->use_mmap
= use_mmap
= FALSE
;
1169 if (use_tsched
&& (!b
|| !d
)) {
1170 pa_log_info("Cannot enabled timer-based scheduling, falling back to sound IRQ scheduling.");
1171 u
->use_tsched
= use_tsched
= FALSE
;
1175 pa_log_info("Successfully enabled mmap() mode.");
1178 pa_log_info("Successfully enabled timer-based scheduling mode.");
1180 if ((err
= snd_pcm_info(u
->pcm_handle
, pcm_info
)) < 0) {
1181 pa_log("Error fetching PCM info: %s", snd_strerror(err
));
1185 /* ALSA might tweak the sample spec, so recalculate the frame size */
1186 frame_size
= pa_frame_size(&ss
);
1188 if ((err
= snd_mixer_open(&u
->mixer_handle
, 0)) < 0)
1189 pa_log("Error opening mixer: %s", snd_strerror(err
));
1191 pa_bool_t found
= FALSE
;
1193 if (pa_alsa_prepare_mixer(u
->mixer_handle
, u
->device_name
) >= 0)
1196 snd_pcm_info_t
* info
;
1198 snd_pcm_info_alloca(&info
);
1200 if (snd_pcm_info(u
->pcm_handle
, info
) >= 0) {
1204 if ((card
= snd_pcm_info_get_card(info
)) >= 0) {
1206 md
= pa_sprintf_malloc("hw:%i", card
);
1208 if (strcmp(u
->device_name
, md
))
1209 if (pa_alsa_prepare_mixer(u
->mixer_handle
, md
) >= 0)
1217 if (!(u
->mixer_elem
= pa_alsa_find_elem(u
->mixer_handle
, "Capture", "Mic")))
1221 snd_mixer_close(u
->mixer_handle
);
1222 u
->mixer_handle
= NULL
;
1226 if ((name
= pa_modargs_get_value(ma
, "source_name", NULL
)))
1227 namereg_fail
= TRUE
;
1229 name
= name_buf
= pa_sprintf_malloc("alsa_input.%s", u
->device_name
);
1230 namereg_fail
= FALSE
;
1233 pa_source_new_data_init(&data
);
1234 data
.driver
= __FILE__
;
1236 pa_source_new_data_set_name(&data
, name
);
1237 data
.namereg_fail
= namereg_fail
;
1238 pa_source_new_data_set_sample_spec(&data
, &ss
);
1239 pa_source_new_data_set_channel_map(&data
, &map
);
1241 pa_alsa_init_proplist(data
.proplist
, pcm_info
);
1242 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_STRING
, u
->device_name
);
1243 pa_proplist_setf(data
.proplist
, PA_PROP_DEVICE_BUFFERING_BUFFER_SIZE
, "%lu", (unsigned long) (period_frames
* frame_size
* nfrags
));
1244 pa_proplist_setf(data
.proplist
, PA_PROP_DEVICE_BUFFERING_FRAGMENT_SIZE
, "%lu", (unsigned long) (period_frames
* frame_size
));
1245 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_ACCESS_MODE
, u
->use_tsched
? "mmap+timer" : (u
->use_mmap
? "mmap" : "serial"));
1247 u
->source
= pa_source_new(m
->core
, &data
, PA_SOURCE_HARDWARE
|PA_SOURCE_LATENCY
);
1248 pa_source_new_data_done(&data
);
1252 pa_log("Failed to create source object");
1256 u
->source
->parent
.process_msg
= source_process_msg
;
1257 u
->source
->update_requested_latency
= source_update_requested_latency_cb
;
1258 u
->source
->userdata
= u
;
1260 pa_source_set_asyncmsgq(u
->source
, u
->thread_mq
.inq
);
1261 pa_source_set_rtpoll(u
->source
, u
->rtpoll
);
1263 u
->frame_size
= frame_size
;
1264 u
->fragment_size
= frag_size
= (uint32_t) (period_frames
* frame_size
);
1265 u
->nfragments
= nfrags
;
1266 u
->hwbuf_size
= u
->fragment_size
* nfrags
;
1267 u
->hwbuf_unused_frames
= 0;
1268 u
->tsched_watermark
= tsched_watermark
;
1270 u
->hw_dB_supported
= FALSE
;
1271 u
->hw_dB_min
= u
->hw_dB_max
= 0;
1272 u
->hw_volume_min
= u
->hw_volume_max
= 0;
1273 u
->mixer_seperate_channels
= FALSE
;
1274 pa_cvolume_mute(&u
->hardware_volume
, u
->source
->sample_spec
.channels
);
1277 fix_tsched_watermark(u
);
1279 pa_source_set_latency_range(u
->source
,
1280 !use_tsched
? pa_bytes_to_usec(u
->hwbuf_size
, &ss
) : (pa_usec_t
) -1,
1281 pa_bytes_to_usec(u
->hwbuf_size
, &ss
));
1283 pa_log_info("Using %u fragments of size %lu bytes, buffer time is %0.2fms",
1284 nfrags
, (long unsigned) u
->fragment_size
,
1285 (double) pa_bytes_to_usec(u
->hwbuf_size
, &ss
) / PA_USEC_PER_MSEC
);
1288 pa_log_info("Time scheduling watermark is %0.2fms",
1289 (double) pa_bytes_to_usec(u
->tsched_watermark
, &ss
) / PA_USEC_PER_MSEC
);
1291 if (update_sw_params(u
) < 0)
1294 if (u
->mixer_handle
) {
1295 pa_assert(u
->mixer_elem
);
1297 if (snd_mixer_selem_has_capture_volume(u
->mixer_elem
)) {
1298 pa_bool_t suitable
= TRUE
;
1300 if (snd_mixer_selem_get_capture_volume_range(u
->mixer_elem
, &u
->hw_volume_min
, &u
->hw_volume_max
) < 0) {
1301 pa_log_info("Failed to get volume range. Falling back to software volume control.");
1304 pa_log_info("Volume ranges from %li to %li.", u
->hw_volume_min
, u
->hw_volume_max
);
1305 pa_assert(u
->hw_volume_min
< u
->hw_volume_max
);
1308 if (snd_mixer_selem_get_capture_dB_range(u
->mixer_elem
, &u
->hw_dB_min
, &u
->hw_dB_max
) < 0)
1309 pa_log_info("Mixer doesn't support dB information.");
1311 #ifdef HAVE_VALGRIND_MEMCHECK_H
1312 VALGRIND_MAKE_MEM_DEFINED(&u
->hw_dB_min
, sizeof(u
->hw_dB_min
));
1313 VALGRIND_MAKE_MEM_DEFINED(&u
->hw_dB_max
, sizeof(u
->hw_dB_max
));
1316 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);
1317 pa_assert(u
->hw_dB_min
< u
->hw_dB_max
);
1318 u
->hw_dB_supported
= TRUE
;
1322 !u
->hw_dB_supported
&&
1323 u
->hw_volume_max
- u
->hw_volume_min
< 3) {
1325 pa_log_info("Device has less than 4 volume levels. Falling back to software volume control.");
1331 u
->mixer_seperate_channels
= pa_alsa_calc_mixer_map(u
->mixer_elem
, &map
, u
->mixer_map
, FALSE
) >= 0;
1333 u
->source
->get_volume
= source_get_volume_cb
;
1334 u
->source
->set_volume
= source_set_volume_cb
;
1335 u
->source
->flags
|= PA_SOURCE_HW_VOLUME_CTRL
| (u
->hw_dB_supported
? PA_SOURCE_DECIBEL_VOLUME
: 0);
1336 pa_log_info("Using hardware volume control. Hardware dB scale %s.", u
->hw_dB_supported
? "supported" : "not supported");
1338 pa_log_info("Using software volume control.");
1341 if (snd_mixer_selem_has_capture_switch(u
->mixer_elem
)) {
1342 u
->source
->get_mute
= source_get_mute_cb
;
1343 u
->source
->set_mute
= source_set_mute_cb
;
1344 u
->source
->flags
|= PA_SOURCE_HW_MUTE_CTRL
;
1346 pa_log_info("Using software mute control.");
1348 u
->mixer_fdl
= pa_alsa_fdlist_new();
1350 if (pa_alsa_fdlist_set_mixer(u
->mixer_fdl
, u
->mixer_handle
, m
->core
->mainloop
) < 0) {
1351 pa_log("Failed to initialize file descriptor monitoring");
1355 snd_mixer_elem_set_callback(u
->mixer_elem
, mixer_callback
);
1356 snd_mixer_elem_set_callback_private(u
->mixer_elem
, u
);
1358 u
->mixer_fdl
= NULL
;
1360 pa_alsa_dump(u
->pcm_handle
);
1362 if (!(u
->thread
= pa_thread_new(thread_func
, u
))) {
1363 pa_log("Failed to create thread.");
1366 /* Get initial mixer settings */
1367 if (data
.volume_is_set
) {
1368 if (u
->source
->set_volume
)
1369 u
->source
->set_volume(u
->source
);
1371 if (u
->source
->get_volume
)
1372 u
->source
->get_volume(u
->source
);
1375 if (data
.muted_is_set
) {
1376 if (u
->source
->set_mute
)
1377 u
->source
->set_mute(u
->source
);
1379 if (u
->source
->get_mute
)
1380 u
->source
->get_mute(u
->source
);
1383 pa_source_put(u
->source
);
1385 pa_modargs_free(ma
);
1392 pa_modargs_free(ma
);
1399 void pa__done(pa_module
*m
) {
1404 if (!(u
= m
->userdata
)) {
1405 pa_alsa_redirect_errors_dec();
1410 pa_source_unlink(u
->source
);
1413 pa_asyncmsgq_send(u
->thread_mq
.inq
, NULL
, PA_MESSAGE_SHUTDOWN
, NULL
, 0, NULL
);
1414 pa_thread_free(u
->thread
);
1417 pa_thread_mq_done(&u
->thread_mq
);
1420 pa_source_unref(u
->source
);
1422 if (u
->alsa_rtpoll_item
)
1423 pa_rtpoll_item_free(u
->alsa_rtpoll_item
);
1426 pa_rtpoll_free(u
->rtpoll
);
1429 pa_alsa_fdlist_free(u
->mixer_fdl
);
1431 if (u
->mixer_handle
)
1432 snd_mixer_close(u
->mixer_handle
);
1434 if (u
->pcm_handle
) {
1435 snd_pcm_drop(u
->pcm_handle
);
1436 snd_pcm_close(u
->pcm_handle
);
1440 pa_smoother_free(u
->smoother
);
1442 pa_xfree(u
->device_name
);
1445 snd_config_update_free_global();
1446 pa_alsa_redirect_errors_dec();