2 This file is part of PulseAudio.
4 Copyright 2004-2008 Lennart Poettering
5 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
7 PulseAudio is free software; you can redistribute it and/or modify
8 it under the terms of the GNU Lesser General Public License as published
9 by the Free Software Foundation; either version 2.1 of the License,
10 or (at your option) any later version.
12 PulseAudio is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 General Public License for more details.
17 You should have received a copy of the GNU Lesser General Public License
18 along with PulseAudio; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
29 #include <asoundlib.h>
31 #ifdef HAVE_VALGRIND_MEMCHECK_H
32 #include <valgrind/memcheck.h>
35 #include <pulse/rtclock.h>
36 #include <pulse/timeval.h>
37 #include <pulse/volume.h>
38 #include <pulse/xmalloc.h>
39 #include <pulse/internal.h>
41 #include <pulsecore/core.h>
42 #include <pulsecore/i18n.h>
43 #include <pulsecore/module.h>
44 #include <pulsecore/memchunk.h>
45 #include <pulsecore/sink.h>
46 #include <pulsecore/modargs.h>
47 #include <pulsecore/core-rtclock.h>
48 #include <pulsecore/core-util.h>
49 #include <pulsecore/sample-util.h>
50 #include <pulsecore/log.h>
51 #include <pulsecore/macro.h>
52 #include <pulsecore/thread.h>
53 #include <pulsecore/thread-mq.h>
54 #include <pulsecore/rtpoll.h>
55 #include <pulsecore/time-smoother.h>
57 #include <modules/reserve-wrap.h>
59 #include "alsa-util.h"
60 #include "alsa-sink.h"
62 /* #define DEBUG_TIMING */
64 #define DEFAULT_DEVICE "default"
66 #define DEFAULT_TSCHED_BUFFER_USEC (2*PA_USEC_PER_SEC) /* 2s -- Overall buffer size */
67 #define DEFAULT_TSCHED_WATERMARK_USEC (20*PA_USEC_PER_MSEC) /* 20ms -- Fill up when only this much is left in the buffer */
69 #define TSCHED_WATERMARK_INC_STEP_USEC (10*PA_USEC_PER_MSEC) /* 10ms -- On underrun, increase watermark by this */
70 #define TSCHED_WATERMARK_DEC_STEP_USEC (5*PA_USEC_PER_MSEC) /* 5ms -- When everything's great, decrease watermark by this */
71 #define TSCHED_WATERMARK_VERIFY_AFTER_USEC (20*PA_USEC_PER_SEC) /* 20s -- How long after a drop out recheck if things are good now */
72 #define TSCHED_WATERMARK_INC_THRESHOLD_USEC (0*PA_USEC_PER_MSEC) /* 0ms -- If the buffer level ever below this threshold, increase the watermark */
73 #define TSCHED_WATERMARK_DEC_THRESHOLD_USEC (100*PA_USEC_PER_MSEC) /* 100ms -- If the buffer level didn't drop below this threshold in the verification time, decrease the watermark */
75 /* Note that TSCHED_WATERMARK_INC_THRESHOLD_USEC == 0 means that we
76 * will increase the watermark only if we hit a real underrun. */
78 #define TSCHED_MIN_SLEEP_USEC (10*PA_USEC_PER_MSEC) /* 10ms -- Sleep at least 10ms on each iteration */
79 #define TSCHED_MIN_WAKEUP_USEC (4*PA_USEC_PER_MSEC) /* 4ms -- Wakeup at least this long before the buffer runs empty*/
81 #define SMOOTHER_WINDOW_USEC (10*PA_USEC_PER_SEC) /* 10s -- smoother windows size */
82 #define SMOOTHER_ADJUST_USEC (1*PA_USEC_PER_SEC) /* 1s -- smoother adjust time */
84 #define SMOOTHER_MIN_INTERVAL (2*PA_USEC_PER_MSEC) /* 2ms -- min smoother update interval */
85 #define SMOOTHER_MAX_INTERVAL (200*PA_USEC_PER_MSEC) /* 200ms -- max smoother update interval */
87 #define VOLUME_ACCURACY (PA_VOLUME_NORM/100) /* don't require volume adjustments to be perfectly correct. don't necessarily extend granularity in software unless the differences get greater than this level */
89 #define DEFAULT_REWIND_SAFEGUARD_BYTES (256U) /* 1.33ms @48kHz, we'll never rewind less than this */
90 #define DEFAULT_REWIND_SAFEGUARD_USEC (1330) /* 1.33ms, depending on channels/rate/sample we may rewind more than 256 above */
98 pa_thread_mq thread_mq
;
101 snd_pcm_t
*pcm_handle
;
104 pa_alsa_fdlist
*mixer_fdl
;
105 pa_alsa_mixer_pdata
*mixer_pd
;
106 snd_mixer_t
*mixer_handle
;
107 pa_alsa_path_set
*mixer_path_set
;
108 pa_alsa_path
*mixer_path
;
110 pa_cvolume hardware_volume
;
119 tsched_watermark_ref
,
125 watermark_inc_threshold
,
126 watermark_dec_threshold
,
129 pa_usec_t watermark_dec_not_before
;
130 pa_usec_t min_latency_ref
;
132 pa_memchunk memchunk
;
134 char *device_name
; /* name of the PCM device */
135 char *control_device
; /* name of the control device */
137 pa_bool_t use_mmap
:1, use_tsched
:1, deferred_volume
:1, fixed_latency_range
:1;
139 pa_bool_t first
, after_rewind
;
141 pa_rtpoll_item
*alsa_rtpoll_item
;
143 pa_smoother
*smoother
;
144 uint64_t write_count
;
145 uint64_t since_start
;
146 pa_usec_t smoother_interval
;
147 pa_usec_t last_smoother_update
;
151 pa_reserve_wrapper
*reserve
;
152 pa_hook_slot
*reserve_slot
;
153 pa_reserve_monitor_wrapper
*monitor
;
154 pa_hook_slot
*monitor_slot
;
157 static void userdata_free(struct userdata
*u
);
159 /* FIXME: Is there a better way to do this than device names? */
160 static pa_bool_t
is_iec958(struct userdata
*u
) {
161 return (strncmp("iec958", u
->device_name
, 6) == 0);
164 static pa_bool_t
is_hdmi(struct userdata
*u
) {
165 return (strncmp("hdmi", u
->device_name
, 4) == 0);
168 static pa_hook_result_t
reserve_cb(pa_reserve_wrapper
*r
, void *forced
, struct userdata
*u
) {
172 if (pa_sink_suspend(u
->sink
, TRUE
, PA_SUSPEND_APPLICATION
) < 0)
173 return PA_HOOK_CANCEL
;
178 static void reserve_done(struct userdata
*u
) {
181 if (u
->reserve_slot
) {
182 pa_hook_slot_free(u
->reserve_slot
);
183 u
->reserve_slot
= NULL
;
187 pa_reserve_wrapper_unref(u
->reserve
);
192 static void reserve_update(struct userdata
*u
) {
193 const char *description
;
196 if (!u
->sink
|| !u
->reserve
)
199 if ((description
= pa_proplist_gets(u
->sink
->proplist
, PA_PROP_DEVICE_DESCRIPTION
)))
200 pa_reserve_wrapper_set_application_device_name(u
->reserve
, description
);
203 static int reserve_init(struct userdata
*u
, const char *dname
) {
212 if (pa_in_system_mode())
215 if (!(rname
= pa_alsa_get_reserve_name(dname
)))
218 /* We are resuming, try to lock the device */
219 u
->reserve
= pa_reserve_wrapper_get(u
->core
, rname
);
227 pa_assert(!u
->reserve_slot
);
228 u
->reserve_slot
= pa_hook_connect(pa_reserve_wrapper_hook(u
->reserve
), PA_HOOK_NORMAL
, (pa_hook_cb_t
) reserve_cb
, u
);
233 static pa_hook_result_t
monitor_cb(pa_reserve_monitor_wrapper
*w
, void* busy
, struct userdata
*u
) {
239 b
= PA_PTR_TO_UINT(busy
) && !u
->reserve
;
241 pa_sink_suspend(u
->sink
, b
, PA_SUSPEND_APPLICATION
);
245 static void monitor_done(struct userdata
*u
) {
248 if (u
->monitor_slot
) {
249 pa_hook_slot_free(u
->monitor_slot
);
250 u
->monitor_slot
= NULL
;
254 pa_reserve_monitor_wrapper_unref(u
->monitor
);
259 static int reserve_monitor_init(struct userdata
*u
, const char *dname
) {
265 if (pa_in_system_mode())
268 if (!(rname
= pa_alsa_get_reserve_name(dname
)))
271 /* We are resuming, try to lock the device */
272 u
->monitor
= pa_reserve_monitor_wrapper_get(u
->core
, rname
);
278 pa_assert(!u
->monitor_slot
);
279 u
->monitor_slot
= pa_hook_connect(pa_reserve_monitor_wrapper_hook(u
->monitor
), PA_HOOK_NORMAL
, (pa_hook_cb_t
) monitor_cb
, u
);
284 static void fix_min_sleep_wakeup(struct userdata
*u
) {
285 size_t max_use
, max_use_2
;
288 pa_assert(u
->use_tsched
);
290 max_use
= u
->hwbuf_size
- u
->hwbuf_unused
;
291 max_use_2
= pa_frame_align(max_use
/2, &u
->sink
->sample_spec
);
293 u
->min_sleep
= pa_usec_to_bytes(TSCHED_MIN_SLEEP_USEC
, &u
->sink
->sample_spec
);
294 u
->min_sleep
= PA_CLAMP(u
->min_sleep
, u
->frame_size
, max_use_2
);
296 u
->min_wakeup
= pa_usec_to_bytes(TSCHED_MIN_WAKEUP_USEC
, &u
->sink
->sample_spec
);
297 u
->min_wakeup
= PA_CLAMP(u
->min_wakeup
, u
->frame_size
, max_use_2
);
300 static void fix_tsched_watermark(struct userdata
*u
) {
303 pa_assert(u
->use_tsched
);
305 max_use
= u
->hwbuf_size
- u
->hwbuf_unused
;
307 if (u
->tsched_watermark
> max_use
- u
->min_sleep
)
308 u
->tsched_watermark
= max_use
- u
->min_sleep
;
310 if (u
->tsched_watermark
< u
->min_wakeup
)
311 u
->tsched_watermark
= u
->min_wakeup
;
314 static void increase_watermark(struct userdata
*u
) {
315 size_t old_watermark
;
316 pa_usec_t old_min_latency
, new_min_latency
;
319 pa_assert(u
->use_tsched
);
321 /* First, just try to increase the watermark */
322 old_watermark
= u
->tsched_watermark
;
323 u
->tsched_watermark
= PA_MIN(u
->tsched_watermark
* 2, u
->tsched_watermark
+ u
->watermark_inc_step
);
324 fix_tsched_watermark(u
);
326 if (old_watermark
!= u
->tsched_watermark
) {
327 pa_log_info("Increasing wakeup watermark to %0.2f ms",
328 (double) pa_bytes_to_usec(u
->tsched_watermark
, &u
->sink
->sample_spec
) / PA_USEC_PER_MSEC
);
332 /* Hmm, we cannot increase the watermark any further, hence let's
333 raise the latency, unless doing so was disabled in
335 if (u
->fixed_latency_range
)
338 old_min_latency
= u
->sink
->thread_info
.min_latency
;
339 new_min_latency
= PA_MIN(old_min_latency
* 2, old_min_latency
+ TSCHED_WATERMARK_INC_STEP_USEC
);
340 new_min_latency
= PA_MIN(new_min_latency
, u
->sink
->thread_info
.max_latency
);
342 if (old_min_latency
!= new_min_latency
) {
343 pa_log_info("Increasing minimal latency to %0.2f ms",
344 (double) new_min_latency
/ PA_USEC_PER_MSEC
);
346 pa_sink_set_latency_range_within_thread(u
->sink
, new_min_latency
, u
->sink
->thread_info
.max_latency
);
349 /* When we reach this we're officialy fucked! */
352 static void decrease_watermark(struct userdata
*u
) {
353 size_t old_watermark
;
357 pa_assert(u
->use_tsched
);
359 now
= pa_rtclock_now();
361 if (u
->watermark_dec_not_before
<= 0)
364 if (u
->watermark_dec_not_before
> now
)
367 old_watermark
= u
->tsched_watermark
;
369 if (u
->tsched_watermark
< u
->watermark_dec_step
)
370 u
->tsched_watermark
= u
->tsched_watermark
/ 2;
372 u
->tsched_watermark
= PA_MAX(u
->tsched_watermark
/ 2, u
->tsched_watermark
- u
->watermark_dec_step
);
374 fix_tsched_watermark(u
);
376 if (old_watermark
!= u
->tsched_watermark
)
377 pa_log_info("Decreasing wakeup watermark to %0.2f ms",
378 (double) pa_bytes_to_usec(u
->tsched_watermark
, &u
->sink
->sample_spec
) / PA_USEC_PER_MSEC
);
380 /* We don't change the latency range*/
383 u
->watermark_dec_not_before
= now
+ TSCHED_WATERMARK_VERIFY_AFTER_USEC
;
386 static void hw_sleep_time(struct userdata
*u
, pa_usec_t
*sleep_usec
, pa_usec_t
*process_usec
) {
389 pa_assert(sleep_usec
);
390 pa_assert(process_usec
);
393 pa_assert(u
->use_tsched
);
395 usec
= pa_sink_get_requested_latency_within_thread(u
->sink
);
397 if (usec
== (pa_usec_t
) -1)
398 usec
= pa_bytes_to_usec(u
->hwbuf_size
, &u
->sink
->sample_spec
);
400 wm
= pa_bytes_to_usec(u
->tsched_watermark
, &u
->sink
->sample_spec
);
405 *sleep_usec
= usec
- wm
;
409 pa_log_debug("Buffer time: %lu ms; Sleep time: %lu ms; Process time: %lu ms",
410 (unsigned long) (usec
/ PA_USEC_PER_MSEC
),
411 (unsigned long) (*sleep_usec
/ PA_USEC_PER_MSEC
),
412 (unsigned long) (*process_usec
/ PA_USEC_PER_MSEC
));
416 static int try_recover(struct userdata
*u
, const char *call
, int err
) {
421 pa_log_debug("%s: %s", call
, pa_alsa_strerror(err
));
423 pa_assert(err
!= -EAGAIN
);
426 pa_log_debug("%s: Buffer underrun!", call
);
428 if (err
== -ESTRPIPE
)
429 pa_log_debug("%s: System suspended!", call
);
431 if ((err
= snd_pcm_recover(u
->pcm_handle
, err
, 1)) < 0) {
432 pa_log("%s: %s", call
, pa_alsa_strerror(err
));
441 static size_t check_left_to_play(struct userdata
*u
, size_t n_bytes
, pa_bool_t on_timeout
) {
443 pa_bool_t underrun
= FALSE
;
445 /* We use <= instead of < for this check here because an underrun
446 * only happens after the last sample was processed, not already when
447 * it is removed from the buffer. This is particularly important
448 * when block transfer is used. */
450 if (n_bytes
<= u
->hwbuf_size
)
451 left_to_play
= u
->hwbuf_size
- n_bytes
;
454 /* We got a dropout. What a mess! */
462 if (!u
->first
&& !u
->after_rewind
)
463 if (pa_log_ratelimit(PA_LOG_INFO
))
464 pa_log_info("Underrun!");
468 pa_log_debug("%0.2f ms left to play; inc threshold = %0.2f ms; dec threshold = %0.2f ms",
469 (double) pa_bytes_to_usec(left_to_play
, &u
->sink
->sample_spec
) / PA_USEC_PER_MSEC
,
470 (double) pa_bytes_to_usec(u
->watermark_inc_threshold
, &u
->sink
->sample_spec
) / PA_USEC_PER_MSEC
,
471 (double) pa_bytes_to_usec(u
->watermark_dec_threshold
, &u
->sink
->sample_spec
) / PA_USEC_PER_MSEC
);
475 pa_bool_t reset_not_before
= TRUE
;
477 if (!u
->first
&& !u
->after_rewind
) {
478 if (underrun
|| left_to_play
< u
->watermark_inc_threshold
)
479 increase_watermark(u
);
480 else if (left_to_play
> u
->watermark_dec_threshold
) {
481 reset_not_before
= FALSE
;
483 /* We decrease the watermark only if have actually
484 * been woken up by a timeout. If something else woke
485 * us up it's too easy to fulfill the deadlines... */
488 decrease_watermark(u
);
492 if (reset_not_before
)
493 u
->watermark_dec_not_before
= 0;
499 static int mmap_write(struct userdata
*u
, pa_usec_t
*sleep_usec
, pa_bool_t polled
, pa_bool_t on_timeout
) {
500 pa_bool_t work_done
= FALSE
;
501 pa_usec_t max_sleep_usec
= 0, process_usec
= 0;
506 pa_sink_assert_ref(u
->sink
);
509 hw_sleep_time(u
, &max_sleep_usec
, &process_usec
);
515 pa_bool_t after_avail
= TRUE
;
517 /* First we determine how many samples are missing to fill the
518 * buffer up to 100% */
520 if (PA_UNLIKELY((n
= pa_alsa_safe_avail(u
->pcm_handle
, u
->hwbuf_size
, &u
->sink
->sample_spec
)) < 0)) {
522 if ((r
= try_recover(u
, "snd_pcm_avail", (int) n
)) == 0)
528 n_bytes
= (size_t) n
* u
->frame_size
;
531 pa_log_debug("avail: %lu", (unsigned long) n_bytes
);
534 left_to_play
= check_left_to_play(u
, n_bytes
, on_timeout
);
539 /* We won't fill up the playback buffer before at least
540 * half the sleep time is over because otherwise we might
541 * ask for more data from the clients then they expect. We
542 * need to guarantee that clients only have to keep around
543 * a single hw buffer length. */
546 pa_bytes_to_usec(left_to_play
, &u
->sink
->sample_spec
) > process_usec
+max_sleep_usec
/2) {
548 pa_log_debug("Not filling up, because too early.");
553 if (PA_UNLIKELY(n_bytes
<= u
->hwbuf_unused
)) {
557 char *dn
= pa_alsa_get_driver_name_by_pcm(u
->pcm_handle
);
558 pa_log(_("ALSA woke us up to write new data to the device, but there was actually nothing to write!\n"
559 "Most likely this is a bug in the ALSA driver '%s'. Please report this issue to the ALSA developers.\n"
560 "We were woken up with POLLOUT set -- however a subsequent snd_pcm_avail() returned 0 or another value < min_avail."),
566 pa_log_debug("Not filling up, because not necessary.");
574 pa_log_debug("Not filling up, because already too many iterations.");
580 n_bytes
-= u
->hwbuf_unused
;
584 pa_log_debug("Filling up");
591 const snd_pcm_channel_area_t
*areas
;
592 snd_pcm_uframes_t offset
, frames
;
593 snd_pcm_sframes_t sframes
;
595 frames
= (snd_pcm_uframes_t
) (n_bytes
/ u
->frame_size
);
596 /* pa_log_debug("%lu frames to write", (unsigned long) frames); */
598 if (PA_UNLIKELY((err
= pa_alsa_safe_mmap_begin(u
->pcm_handle
, &areas
, &offset
, &frames
, u
->hwbuf_size
, &u
->sink
->sample_spec
)) < 0)) {
600 if (!after_avail
&& err
== -EAGAIN
)
603 if ((r
= try_recover(u
, "snd_pcm_mmap_begin", err
)) == 0)
609 /* Make sure that if these memblocks need to be copied they will fit into one slot */
610 if (frames
> pa_mempool_block_size_max(u
->core
->mempool
)/u
->frame_size
)
611 frames
= pa_mempool_block_size_max(u
->core
->mempool
)/u
->frame_size
;
613 if (!after_avail
&& frames
== 0)
616 pa_assert(frames
> 0);
619 /* Check these are multiples of 8 bit */
620 pa_assert((areas
[0].first
& 7) == 0);
621 pa_assert((areas
[0].step
& 7)== 0);
623 /* We assume a single interleaved memory buffer */
624 pa_assert((areas
[0].first
>> 3) == 0);
625 pa_assert((areas
[0].step
>> 3) == u
->frame_size
);
627 p
= (uint8_t*) areas
[0].addr
+ (offset
* u
->frame_size
);
629 chunk
.memblock
= pa_memblock_new_fixed(u
->core
->mempool
, p
, frames
* u
->frame_size
, TRUE
);
630 chunk
.length
= pa_memblock_get_length(chunk
.memblock
);
633 pa_sink_render_into_full(u
->sink
, &chunk
);
634 pa_memblock_unref_fixed(chunk
.memblock
);
636 if (PA_UNLIKELY((sframes
= snd_pcm_mmap_commit(u
->pcm_handle
, offset
, frames
)) < 0)) {
638 if (!after_avail
&& (int) sframes
== -EAGAIN
)
641 if ((r
= try_recover(u
, "snd_pcm_mmap_commit", (int) sframes
)) == 0)
649 u
->write_count
+= frames
* u
->frame_size
;
650 u
->since_start
+= frames
* u
->frame_size
;
653 pa_log_debug("Wrote %lu bytes (of possible %lu bytes)", (unsigned long) (frames
* u
->frame_size
), (unsigned long) n_bytes
);
656 if ((size_t) frames
* u
->frame_size
>= n_bytes
)
659 n_bytes
-= (size_t) frames
* u
->frame_size
;
664 *sleep_usec
= pa_bytes_to_usec(left_to_play
, &u
->sink
->sample_spec
);
665 process_usec
= pa_bytes_to_usec(u
->tsched_watermark
, &u
->sink
->sample_spec
);
667 if (*sleep_usec
> process_usec
)
668 *sleep_usec
-= process_usec
;
674 return work_done
? 1 : 0;
677 static int unix_write(struct userdata
*u
, pa_usec_t
*sleep_usec
, pa_bool_t polled
, pa_bool_t on_timeout
) {
678 pa_bool_t work_done
= FALSE
;
679 pa_usec_t max_sleep_usec
= 0, process_usec
= 0;
684 pa_sink_assert_ref(u
->sink
);
687 hw_sleep_time(u
, &max_sleep_usec
, &process_usec
);
693 pa_bool_t after_avail
= TRUE
;
695 if (PA_UNLIKELY((n
= pa_alsa_safe_avail(u
->pcm_handle
, u
->hwbuf_size
, &u
->sink
->sample_spec
)) < 0)) {
697 if ((r
= try_recover(u
, "snd_pcm_avail", (int) n
)) == 0)
703 n_bytes
= (size_t) n
* u
->frame_size
;
704 left_to_play
= check_left_to_play(u
, n_bytes
, on_timeout
);
709 /* We won't fill up the playback buffer before at least
710 * half the sleep time is over because otherwise we might
711 * ask for more data from the clients then they expect. We
712 * need to guarantee that clients only have to keep around
713 * a single hw buffer length. */
716 pa_bytes_to_usec(left_to_play
, &u
->sink
->sample_spec
) > process_usec
+max_sleep_usec
/2)
719 if (PA_UNLIKELY(n_bytes
<= u
->hwbuf_unused
)) {
723 char *dn
= pa_alsa_get_driver_name_by_pcm(u
->pcm_handle
);
724 pa_log(_("ALSA woke us up to write new data to the device, but there was actually nothing to write!\n"
725 "Most likely this is a bug in the ALSA driver '%s'. Please report this issue to the ALSA developers.\n"
726 "We were woken up with POLLOUT set -- however a subsequent snd_pcm_avail() returned 0 or another value < min_avail."),
736 pa_log_debug("Not filling up, because already too many iterations.");
742 n_bytes
-= u
->hwbuf_unused
;
746 snd_pcm_sframes_t frames
;
749 /* pa_log_debug("%lu frames to write", (unsigned long) frames); */
751 if (u
->memchunk
.length
<= 0)
752 pa_sink_render(u
->sink
, n_bytes
, &u
->memchunk
);
754 pa_assert(u
->memchunk
.length
> 0);
756 frames
= (snd_pcm_sframes_t
) (u
->memchunk
.length
/ u
->frame_size
);
758 if (frames
> (snd_pcm_sframes_t
) (n_bytes
/u
->frame_size
))
759 frames
= (snd_pcm_sframes_t
) (n_bytes
/u
->frame_size
);
761 p
= pa_memblock_acquire(u
->memchunk
.memblock
);
762 frames
= snd_pcm_writei(u
->pcm_handle
, (const uint8_t*) p
+ u
->memchunk
.index
, (snd_pcm_uframes_t
) frames
);
763 pa_memblock_release(u
->memchunk
.memblock
);
765 if (PA_UNLIKELY(frames
< 0)) {
767 if (!after_avail
&& (int) frames
== -EAGAIN
)
770 if ((r
= try_recover(u
, "snd_pcm_writei", (int) frames
)) == 0)
776 if (!after_avail
&& frames
== 0)
779 pa_assert(frames
> 0);
782 u
->memchunk
.index
+= (size_t) frames
* u
->frame_size
;
783 u
->memchunk
.length
-= (size_t) frames
* u
->frame_size
;
785 if (u
->memchunk
.length
<= 0) {
786 pa_memblock_unref(u
->memchunk
.memblock
);
787 pa_memchunk_reset(&u
->memchunk
);
792 u
->write_count
+= frames
* u
->frame_size
;
793 u
->since_start
+= frames
* u
->frame_size
;
795 /* pa_log_debug("wrote %lu frames", (unsigned long) frames); */
797 if ((size_t) frames
* u
->frame_size
>= n_bytes
)
800 n_bytes
-= (size_t) frames
* u
->frame_size
;
805 *sleep_usec
= pa_bytes_to_usec(left_to_play
, &u
->sink
->sample_spec
);
806 process_usec
= pa_bytes_to_usec(u
->tsched_watermark
, &u
->sink
->sample_spec
);
808 if (*sleep_usec
> process_usec
)
809 *sleep_usec
-= process_usec
;
815 return work_done
? 1 : 0;
818 static void update_smoother(struct userdata
*u
) {
819 snd_pcm_sframes_t delay
= 0;
822 pa_usec_t now1
= 0, now2
;
823 snd_pcm_status_t
*status
;
825 snd_pcm_status_alloca(&status
);
828 pa_assert(u
->pcm_handle
);
830 /* Let's update the time smoother */
832 if (PA_UNLIKELY((err
= pa_alsa_safe_delay(u
->pcm_handle
, &delay
, u
->hwbuf_size
, &u
->sink
->sample_spec
, FALSE
)) < 0)) {
833 pa_log_warn("Failed to query DSP status data: %s", pa_alsa_strerror(err
));
837 if (PA_UNLIKELY((err
= snd_pcm_status(u
->pcm_handle
, status
)) < 0))
838 pa_log_warn("Failed to get timestamp: %s", pa_alsa_strerror(err
));
840 snd_htimestamp_t htstamp
= { 0, 0 };
841 snd_pcm_status_get_htstamp(status
, &htstamp
);
842 now1
= pa_timespec_load(&htstamp
);
845 /* Hmm, if the timestamp is 0, then it wasn't set and we take the current time */
847 now1
= pa_rtclock_now();
849 /* check if the time since the last update is bigger than the interval */
850 if (u
->last_smoother_update
> 0)
851 if (u
->last_smoother_update
+ u
->smoother_interval
> now1
)
854 position
= (int64_t) u
->write_count
- ((int64_t) delay
* (int64_t) u
->frame_size
);
856 if (PA_UNLIKELY(position
< 0))
859 now2
= pa_bytes_to_usec((uint64_t) position
, &u
->sink
->sample_spec
);
861 pa_smoother_put(u
->smoother
, now1
, now2
);
863 u
->last_smoother_update
= now1
;
864 /* exponentially increase the update interval up to the MAX limit */
865 u
->smoother_interval
= PA_MIN (u
->smoother_interval
* 2, SMOOTHER_MAX_INTERVAL
);
868 static pa_usec_t
sink_get_latency(struct userdata
*u
) {
871 pa_usec_t now1
, now2
;
875 now1
= pa_rtclock_now();
876 now2
= pa_smoother_get(u
->smoother
, now1
);
878 delay
= (int64_t) pa_bytes_to_usec(u
->write_count
, &u
->sink
->sample_spec
) - (int64_t) now2
;
880 r
= delay
>= 0 ? (pa_usec_t
) delay
: 0;
882 if (u
->memchunk
.memblock
)
883 r
+= pa_bytes_to_usec(u
->memchunk
.length
, &u
->sink
->sample_spec
);
888 static int build_pollfd(struct userdata
*u
) {
890 pa_assert(u
->pcm_handle
);
892 if (u
->alsa_rtpoll_item
)
893 pa_rtpoll_item_free(u
->alsa_rtpoll_item
);
895 if (!(u
->alsa_rtpoll_item
= pa_alsa_build_pollfd(u
->pcm_handle
, u
->rtpoll
)))
901 /* Called from IO context */
902 static int suspend(struct userdata
*u
) {
904 pa_assert(u
->pcm_handle
);
906 pa_smoother_pause(u
->smoother
, pa_rtclock_now());
908 /* Let's suspend -- we don't call snd_pcm_drain() here since that might
909 * take awfully long with our long buffer sizes today. */
910 snd_pcm_close(u
->pcm_handle
);
911 u
->pcm_handle
= NULL
;
913 if (u
->alsa_rtpoll_item
) {
914 pa_rtpoll_item_free(u
->alsa_rtpoll_item
);
915 u
->alsa_rtpoll_item
= NULL
;
918 /* We reset max_rewind/max_request here to make sure that while we
919 * are suspended the old max_request/max_rewind values set before
920 * the suspend can influence the per-stream buffer of newly
921 * created streams, without their requirements having any
922 * influence on them. */
923 pa_sink_set_max_rewind_within_thread(u
->sink
, 0);
924 pa_sink_set_max_request_within_thread(u
->sink
, 0);
926 pa_log_info("Device suspended...");
931 /* Called from IO context */
932 static int update_sw_params(struct userdata
*u
) {
933 snd_pcm_uframes_t avail_min
;
938 /* Use the full buffer if no one asked us for anything specific */
944 if ((latency
= pa_sink_get_requested_latency_within_thread(u
->sink
)) != (pa_usec_t
) -1) {
947 pa_log_debug("Latency set to %0.2fms", (double) latency
/ PA_USEC_PER_MSEC
);
949 b
= pa_usec_to_bytes(latency
, &u
->sink
->sample_spec
);
951 /* We need at least one sample in our buffer */
953 if (PA_UNLIKELY(b
< u
->frame_size
))
956 u
->hwbuf_unused
= PA_LIKELY(b
< u
->hwbuf_size
) ? (u
->hwbuf_size
- b
) : 0;
959 fix_min_sleep_wakeup(u
);
960 fix_tsched_watermark(u
);
963 pa_log_debug("hwbuf_unused=%lu", (unsigned long) u
->hwbuf_unused
);
965 /* We need at last one frame in the used part of the buffer */
966 avail_min
= (snd_pcm_uframes_t
) u
->hwbuf_unused
/ u
->frame_size
+ 1;
969 pa_usec_t sleep_usec
, process_usec
;
971 hw_sleep_time(u
, &sleep_usec
, &process_usec
);
972 avail_min
+= pa_usec_to_bytes(sleep_usec
, &u
->sink
->sample_spec
) / u
->frame_size
;
975 pa_log_debug("setting avail_min=%lu", (unsigned long) avail_min
);
977 if ((err
= pa_alsa_set_sw_params(u
->pcm_handle
, avail_min
, !u
->use_tsched
)) < 0) {
978 pa_log("Failed to set software parameters: %s", pa_alsa_strerror(err
));
982 pa_sink_set_max_request_within_thread(u
->sink
, u
->hwbuf_size
- u
->hwbuf_unused
);
983 if (pa_alsa_pcm_is_hw(u
->pcm_handle
))
984 pa_sink_set_max_rewind_within_thread(u
->sink
, u
->hwbuf_size
);
986 pa_log_info("Disabling rewind_within_thread for device %s", u
->device_name
);
987 pa_sink_set_max_rewind_within_thread(u
->sink
, 0);
993 /* Called from IO Context on unsuspend or from main thread when creating sink */
994 static void reset_watermark(struct userdata
*u
, size_t tsched_watermark
, pa_sample_spec
*ss
,
997 u
->tsched_watermark
= pa_usec_to_bytes_round_up(pa_bytes_to_usec_round_up(tsched_watermark
, ss
),
998 &u
->sink
->sample_spec
);
1000 u
->watermark_inc_step
= pa_usec_to_bytes(TSCHED_WATERMARK_INC_STEP_USEC
, &u
->sink
->sample_spec
);
1001 u
->watermark_dec_step
= pa_usec_to_bytes(TSCHED_WATERMARK_DEC_STEP_USEC
, &u
->sink
->sample_spec
);
1003 u
->watermark_inc_threshold
= pa_usec_to_bytes_round_up(TSCHED_WATERMARK_INC_THRESHOLD_USEC
, &u
->sink
->sample_spec
);
1004 u
->watermark_dec_threshold
= pa_usec_to_bytes_round_up(TSCHED_WATERMARK_DEC_THRESHOLD_USEC
, &u
->sink
->sample_spec
);
1006 fix_min_sleep_wakeup(u
);
1007 fix_tsched_watermark(u
);
1010 pa_sink_set_latency_range_within_thread(u
->sink
,
1012 pa_bytes_to_usec(u
->hwbuf_size
, ss
));
1014 pa_sink_set_latency_range(u
->sink
,
1016 pa_bytes_to_usec(u
->hwbuf_size
, ss
));
1018 /* work-around assert in pa_sink_set_latency_within_thead,
1019 keep track of min_latency and reuse it when
1020 this routine is called from IO context */
1021 u
->min_latency_ref
= u
->sink
->thread_info
.min_latency
;
1024 pa_log_info("Time scheduling watermark is %0.2fms",
1025 (double) pa_bytes_to_usec(u
->tsched_watermark
, ss
) / PA_USEC_PER_MSEC
);
1028 /* Called from IO context */
1029 static int unsuspend(struct userdata
*u
) {
1033 snd_pcm_uframes_t period_size
, buffer_size
;
1034 char *device_name
= NULL
;
1037 pa_assert(!u
->pcm_handle
);
1039 pa_log_info("Trying resume...");
1041 if ((is_iec958(u
) || is_hdmi(u
)) && pa_sink_is_passthrough(u
->sink
)) {
1042 /* Need to open device in NONAUDIO mode */
1043 int len
= strlen(u
->device_name
) + 8;
1045 device_name
= pa_xmalloc(len
);
1046 pa_snprintf(device_name
, len
, "%s,AES0=6", u
->device_name
);
1049 if ((err
= snd_pcm_open(&u
->pcm_handle
, device_name
? device_name
: u
->device_name
, SND_PCM_STREAM_PLAYBACK
,
1051 SND_PCM_NO_AUTO_RESAMPLE
|
1052 SND_PCM_NO_AUTO_CHANNELS
|
1053 SND_PCM_NO_AUTO_FORMAT
)) < 0) {
1054 pa_log("Error opening PCM device %s: %s", u
->device_name
, pa_alsa_strerror(err
));
1058 ss
= u
->sink
->sample_spec
;
1059 period_size
= u
->fragment_size
/ u
->frame_size
;
1060 buffer_size
= u
->hwbuf_size
/ u
->frame_size
;
1064 if ((err
= pa_alsa_set_hw_params(u
->pcm_handle
, &ss
, &period_size
, &buffer_size
, 0, &b
, &d
, TRUE
)) < 0) {
1065 pa_log("Failed to set hardware parameters: %s", pa_alsa_strerror(err
));
1069 if (b
!= u
->use_mmap
|| d
!= u
->use_tsched
) {
1070 pa_log_warn("Resume failed, couldn't get original access mode.");
1074 if (!pa_sample_spec_equal(&ss
, &u
->sink
->sample_spec
)) {
1075 pa_log_warn("Resume failed, couldn't restore original sample settings.");
1079 if (period_size
*u
->frame_size
!= u
->fragment_size
||
1080 buffer_size
*u
->frame_size
!= u
->hwbuf_size
) {
1081 pa_log_warn("Resume failed, couldn't restore original fragment settings. (Old: %lu/%lu, New %lu/%lu)",
1082 (unsigned long) u
->hwbuf_size
, (unsigned long) u
->fragment_size
,
1083 (unsigned long) (buffer_size
*u
->frame_size
), (unsigned long) (period_size
*u
->frame_size
));
1087 if (update_sw_params(u
) < 0)
1090 if (build_pollfd(u
) < 0)
1094 pa_smoother_reset(u
->smoother
, pa_rtclock_now(), TRUE
);
1095 u
->smoother_interval
= SMOOTHER_MIN_INTERVAL
;
1096 u
->last_smoother_update
= 0;
1101 /* reset the watermark to the value defined when sink was created */
1103 reset_watermark(u
, u
->tsched_watermark_ref
, &u
->sink
->sample_spec
, TRUE
);
1105 pa_log_info("Resumed successfully...");
1107 pa_xfree(device_name
);
1111 if (u
->pcm_handle
) {
1112 snd_pcm_close(u
->pcm_handle
);
1113 u
->pcm_handle
= NULL
;
1116 pa_xfree(device_name
);
1121 /* Called from IO context */
1122 static int sink_process_msg(pa_msgobject
*o
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
1123 struct userdata
*u
= PA_SINK(o
)->userdata
;
1127 case PA_SINK_MESSAGE_GET_LATENCY
: {
1131 r
= sink_get_latency(u
);
1133 *((pa_usec_t
*) data
) = r
;
1138 case PA_SINK_MESSAGE_SET_STATE
:
1140 switch ((pa_sink_state_t
) PA_PTR_TO_UINT(data
)) {
1142 case PA_SINK_SUSPENDED
: {
1145 pa_assert(PA_SINK_IS_OPENED(u
->sink
->thread_info
.state
));
1147 if ((r
= suspend(u
)) < 0)
1154 case PA_SINK_RUNNING
: {
1157 if (u
->sink
->thread_info
.state
== PA_SINK_INIT
) {
1158 if (build_pollfd(u
) < 0)
1162 if (u
->sink
->thread_info
.state
== PA_SINK_SUSPENDED
) {
1163 if ((r
= unsuspend(u
)) < 0)
1170 case PA_SINK_UNLINKED
:
1172 case PA_SINK_INVALID_STATE
:
1179 return pa_sink_process_msg(o
, code
, data
, offset
, chunk
);
1182 /* Called from main context */
1183 static int sink_set_state_cb(pa_sink
*s
, pa_sink_state_t new_state
) {
1184 pa_sink_state_t old_state
;
1187 pa_sink_assert_ref(s
);
1188 pa_assert_se(u
= s
->userdata
);
1190 old_state
= pa_sink_get_state(u
->sink
);
1192 if (PA_SINK_IS_OPENED(old_state
) && new_state
== PA_SINK_SUSPENDED
)
1194 else if (old_state
== PA_SINK_SUSPENDED
&& PA_SINK_IS_OPENED(new_state
))
1195 if (reserve_init(u
, u
->device_name
) < 0)
1196 return -PA_ERR_BUSY
;
1201 static int ctl_mixer_callback(snd_mixer_elem_t
*elem
, unsigned int mask
) {
1202 struct userdata
*u
= snd_mixer_elem_get_callback_private(elem
);
1205 pa_assert(u
->mixer_handle
);
1207 if (mask
== SND_CTL_EVENT_MASK_REMOVE
)
1210 if (!PA_SINK_IS_LINKED(u
->sink
->state
))
1213 if (u
->sink
->suspend_cause
& PA_SUSPEND_SESSION
)
1216 if (mask
& SND_CTL_EVENT_MASK_VALUE
) {
1217 pa_sink_get_volume(u
->sink
, TRUE
);
1218 pa_sink_get_mute(u
->sink
, TRUE
);
1224 static int io_mixer_callback(snd_mixer_elem_t
*elem
, unsigned int mask
) {
1225 struct userdata
*u
= snd_mixer_elem_get_callback_private(elem
);
1228 pa_assert(u
->mixer_handle
);
1230 if (mask
== SND_CTL_EVENT_MASK_REMOVE
)
1233 if (u
->sink
->suspend_cause
& PA_SUSPEND_SESSION
)
1236 if (mask
& SND_CTL_EVENT_MASK_VALUE
)
1237 pa_sink_update_volume_and_mute(u
->sink
);
1242 static void sink_get_volume_cb(pa_sink
*s
) {
1243 struct userdata
*u
= s
->userdata
;
1245 char vol_str_pcnt
[PA_CVOLUME_SNPRINT_MAX
];
1248 pa_assert(u
->mixer_path
);
1249 pa_assert(u
->mixer_handle
);
1251 if (pa_alsa_path_get_volume(u
->mixer_path
, u
->mixer_handle
, &s
->channel_map
, &r
) < 0)
1254 /* Shift down by the base volume, so that 0dB becomes maximum volume */
1255 pa_sw_cvolume_multiply_scalar(&r
, &r
, s
->base_volume
);
1257 pa_log_debug("Read hardware volume: %s", pa_cvolume_snprint(vol_str_pcnt
, sizeof(vol_str_pcnt
), &r
));
1259 if (u
->mixer_path
->has_dB
) {
1260 char vol_str_db
[PA_SW_CVOLUME_SNPRINT_DB_MAX
];
1262 pa_log_debug(" in dB: %s", pa_sw_cvolume_snprint_dB(vol_str_db
, sizeof(vol_str_db
), &r
));
1265 if (pa_cvolume_equal(&u
->hardware_volume
, &r
))
1268 s
->real_volume
= u
->hardware_volume
= r
;
1270 /* Hmm, so the hardware volume changed, let's reset our software volume */
1271 if (u
->mixer_path
->has_dB
)
1272 pa_sink_set_soft_volume(s
, NULL
);
1275 static void sink_set_volume_cb(pa_sink
*s
) {
1276 struct userdata
*u
= s
->userdata
;
1278 char vol_str_pcnt
[PA_CVOLUME_SNPRINT_MAX
];
1279 pa_bool_t deferred_volume
= !!(s
->flags
& PA_SINK_DEFERRED_VOLUME
);
1282 pa_assert(u
->mixer_path
);
1283 pa_assert(u
->mixer_handle
);
1285 /* Shift up by the base volume */
1286 pa_sw_cvolume_divide_scalar(&r
, &s
->real_volume
, s
->base_volume
);
1288 if (pa_alsa_path_set_volume(u
->mixer_path
, u
->mixer_handle
, &s
->channel_map
, &r
, deferred_volume
, !deferred_volume
) < 0)
1291 /* Shift down by the base volume, so that 0dB becomes maximum volume */
1292 pa_sw_cvolume_multiply_scalar(&r
, &r
, s
->base_volume
);
1294 u
->hardware_volume
= r
;
1296 if (u
->mixer_path
->has_dB
) {
1297 pa_cvolume new_soft_volume
;
1298 pa_bool_t accurate_enough
;
1299 char vol_str_db
[PA_SW_CVOLUME_SNPRINT_DB_MAX
];
1301 /* Match exactly what the user requested by software */
1302 pa_sw_cvolume_divide(&new_soft_volume
, &s
->real_volume
, &u
->hardware_volume
);
1304 /* If the adjustment to do in software is only minimal we
1305 * can skip it. That saves us CPU at the expense of a bit of
1308 (pa_cvolume_min(&new_soft_volume
) >= (PA_VOLUME_NORM
- VOLUME_ACCURACY
)) &&
1309 (pa_cvolume_max(&new_soft_volume
) <= (PA_VOLUME_NORM
+ VOLUME_ACCURACY
));
1311 pa_log_debug("Requested volume: %s", pa_cvolume_snprint(vol_str_pcnt
, sizeof(vol_str_pcnt
), &s
->real_volume
));
1312 pa_log_debug(" in dB: %s", pa_sw_cvolume_snprint_dB(vol_str_db
, sizeof(vol_str_db
), &s
->real_volume
));
1313 pa_log_debug("Got hardware volume: %s", pa_cvolume_snprint(vol_str_pcnt
, sizeof(vol_str_pcnt
), &u
->hardware_volume
));
1314 pa_log_debug(" in dB: %s", pa_sw_cvolume_snprint_dB(vol_str_db
, sizeof(vol_str_db
), &u
->hardware_volume
));
1315 pa_log_debug("Calculated software volume: %s (accurate-enough=%s)",
1316 pa_cvolume_snprint(vol_str_pcnt
, sizeof(vol_str_pcnt
), &new_soft_volume
),
1317 pa_yes_no(accurate_enough
));
1318 pa_log_debug(" in dB: %s", pa_sw_cvolume_snprint_dB(vol_str_db
, sizeof(vol_str_db
), &new_soft_volume
));
1320 if (!accurate_enough
)
1321 s
->soft_volume
= new_soft_volume
;
1324 pa_log_debug("Wrote hardware volume: %s", pa_cvolume_snprint(vol_str_pcnt
, sizeof(vol_str_pcnt
), &r
));
1326 /* We can't match exactly what the user requested, hence let's
1327 * at least tell the user about it */
1333 static void sink_write_volume_cb(pa_sink
*s
) {
1334 struct userdata
*u
= s
->userdata
;
1335 pa_cvolume hw_vol
= s
->thread_info
.current_hw_volume
;
1338 pa_assert(u
->mixer_path
);
1339 pa_assert(u
->mixer_handle
);
1340 pa_assert(s
->flags
& PA_SINK_DEFERRED_VOLUME
);
1342 /* Shift up by the base volume */
1343 pa_sw_cvolume_divide_scalar(&hw_vol
, &hw_vol
, s
->base_volume
);
1345 if (pa_alsa_path_set_volume(u
->mixer_path
, u
->mixer_handle
, &s
->channel_map
, &hw_vol
, TRUE
, TRUE
) < 0)
1346 pa_log_error("Writing HW volume failed");
1349 pa_bool_t accurate_enough
;
1351 /* Shift down by the base volume, so that 0dB becomes maximum volume */
1352 pa_sw_cvolume_multiply_scalar(&hw_vol
, &hw_vol
, s
->base_volume
);
1354 pa_sw_cvolume_divide(&tmp_vol
, &hw_vol
, &s
->thread_info
.current_hw_volume
);
1356 (pa_cvolume_min(&tmp_vol
) >= (PA_VOLUME_NORM
- VOLUME_ACCURACY
)) &&
1357 (pa_cvolume_max(&tmp_vol
) <= (PA_VOLUME_NORM
+ VOLUME_ACCURACY
));
1359 if (!accurate_enough
) {
1361 char db
[2][PA_SW_CVOLUME_SNPRINT_DB_MAX
];
1362 char pcnt
[2][PA_CVOLUME_SNPRINT_MAX
];
1365 pa_log_debug("Written HW volume did not match with the request: %s (request) != %s",
1366 pa_cvolume_snprint(vol
.pcnt
[0], sizeof(vol
.pcnt
[0]), &s
->thread_info
.current_hw_volume
),
1367 pa_cvolume_snprint(vol
.pcnt
[1], sizeof(vol
.pcnt
[1]), &hw_vol
));
1368 pa_log_debug(" in dB: %s (request) != %s",
1369 pa_sw_cvolume_snprint_dB(vol
.db
[0], sizeof(vol
.db
[0]), &s
->thread_info
.current_hw_volume
),
1370 pa_sw_cvolume_snprint_dB(vol
.db
[1], sizeof(vol
.db
[1]), &hw_vol
));
1375 static void sink_get_mute_cb(pa_sink
*s
) {
1376 struct userdata
*u
= s
->userdata
;
1380 pa_assert(u
->mixer_path
);
1381 pa_assert(u
->mixer_handle
);
1383 if (pa_alsa_path_get_mute(u
->mixer_path
, u
->mixer_handle
, &b
) < 0)
1389 static void sink_set_mute_cb(pa_sink
*s
) {
1390 struct userdata
*u
= s
->userdata
;
1393 pa_assert(u
->mixer_path
);
1394 pa_assert(u
->mixer_handle
);
1396 pa_alsa_path_set_mute(u
->mixer_path
, u
->mixer_handle
, s
->muted
);
1399 static void mixer_volume_init(struct userdata
*u
) {
1402 if (!u
->mixer_path
->has_volume
) {
1403 pa_sink_set_write_volume_callback(u
->sink
, NULL
);
1404 pa_sink_set_get_volume_callback(u
->sink
, NULL
);
1405 pa_sink_set_set_volume_callback(u
->sink
, NULL
);
1407 pa_log_info("Driver does not support hardware volume control, falling back to software volume control.");
1409 pa_sink_set_get_volume_callback(u
->sink
, sink_get_volume_cb
);
1410 pa_sink_set_set_volume_callback(u
->sink
, sink_set_volume_cb
);
1412 if (u
->mixer_path
->has_dB
&& u
->deferred_volume
) {
1413 pa_sink_set_write_volume_callback(u
->sink
, sink_write_volume_cb
);
1414 pa_log_info("Successfully enabled deferred volume.");
1416 pa_sink_set_write_volume_callback(u
->sink
, NULL
);
1418 if (u
->mixer_path
->has_dB
) {
1419 pa_sink_enable_decibel_volume(u
->sink
, TRUE
);
1420 pa_log_info("Hardware volume ranges from %0.2f dB to %0.2f dB.", u
->mixer_path
->min_dB
, u
->mixer_path
->max_dB
);
1422 u
->sink
->base_volume
= pa_sw_volume_from_dB(-u
->mixer_path
->max_dB
);
1423 u
->sink
->n_volume_steps
= PA_VOLUME_NORM
+1;
1425 pa_log_info("Fixing base volume to %0.2f dB", pa_sw_volume_to_dB(u
->sink
->base_volume
));
1427 pa_sink_enable_decibel_volume(u
->sink
, FALSE
);
1428 pa_log_info("Hardware volume ranges from %li to %li.", u
->mixer_path
->min_volume
, u
->mixer_path
->max_volume
);
1430 u
->sink
->base_volume
= PA_VOLUME_NORM
;
1431 u
->sink
->n_volume_steps
= u
->mixer_path
->max_volume
- u
->mixer_path
->min_volume
+ 1;
1434 pa_log_info("Using hardware volume control. Hardware dB scale %s.", u
->mixer_path
->has_dB
? "supported" : "not supported");
1437 if (!u
->mixer_path
->has_mute
) {
1438 pa_sink_set_get_mute_callback(u
->sink
, NULL
);
1439 pa_sink_set_set_mute_callback(u
->sink
, NULL
);
1440 pa_log_info("Driver does not support hardware mute control, falling back to software mute control.");
1442 pa_sink_set_get_mute_callback(u
->sink
, sink_get_mute_cb
);
1443 pa_sink_set_set_mute_callback(u
->sink
, sink_set_mute_cb
);
1444 pa_log_info("Using hardware mute control.");
1448 static int sink_set_port_cb(pa_sink
*s
, pa_device_port
*p
) {
1449 struct userdata
*u
= s
->userdata
;
1450 pa_alsa_port_data
*data
;
1454 pa_assert(u
->mixer_handle
);
1456 data
= PA_DEVICE_PORT_DATA(p
);
1458 pa_assert_se(u
->mixer_path
= data
->path
);
1459 pa_alsa_path_select(u
->mixer_path
, u
->mixer_handle
);
1461 mixer_volume_init(u
);
1464 pa_alsa_setting_select(data
->setting
, u
->mixer_handle
);
1474 static void sink_update_requested_latency_cb(pa_sink
*s
) {
1475 struct userdata
*u
= s
->userdata
;
1478 pa_assert(u
->use_tsched
); /* only when timer scheduling is used
1479 * we can dynamically adjust the
1485 before
= u
->hwbuf_unused
;
1486 update_sw_params(u
);
1488 /* Let's check whether we now use only a smaller part of the
1489 buffer then before. If so, we need to make sure that subsequent
1490 rewinds are relative to the new maximum fill level and not to the
1491 current fill level. Thus, let's do a full rewind once, to clear
1494 if (u
->hwbuf_unused
> before
) {
1495 pa_log_debug("Requesting rewind due to latency change.");
1496 pa_sink_request_rewind(s
, (size_t) -1);
1500 static pa_idxset
* sink_get_formats(pa_sink
*s
) {
1501 struct userdata
*u
= s
->userdata
;
1502 pa_idxset
*ret
= pa_idxset_new(NULL
, NULL
);
1508 PA_IDXSET_FOREACH(f
, u
->formats
, idx
) {
1509 pa_idxset_put(ret
, pa_format_info_copy(f
), NULL
);
1515 static pa_bool_t
sink_set_formats(pa_sink
*s
, pa_idxset
*formats
) {
1516 struct userdata
*u
= s
->userdata
;
1517 pa_format_info
*f
, *g
;
1522 /* FIXME: also validate sample rates against what the device supports */
1523 PA_IDXSET_FOREACH(f
, formats
, idx
) {
1524 if (is_iec958(u
) && f
->encoding
== PA_ENCODING_EAC3_IEC61937
)
1525 /* EAC3 cannot be sent over over S/PDIF */
1529 pa_idxset_free(u
->formats
, (pa_free2_cb_t
) pa_format_info_free2
, NULL
);
1530 u
->formats
= pa_idxset_new(NULL
, NULL
);
1532 /* Note: the logic below won't apply if we're using software encoding.
1533 * This is fine for now since we don't support that via the passthrough
1534 * framework, but this must be changed if we do. */
1536 /* Count how many sample rates we support */
1537 for (idx
= 0, n
= 0; u
->rates
[idx
]; idx
++)
1540 /* First insert non-PCM formats since we prefer those. */
1541 PA_IDXSET_FOREACH(f
, formats
, idx
) {
1542 if (!pa_format_info_is_pcm(f
)) {
1543 g
= pa_format_info_copy(f
);
1544 pa_format_info_set_prop_int_array(g
, PA_PROP_FORMAT_RATE
, (int *) u
->rates
, n
);
1545 pa_idxset_put(u
->formats
, g
, NULL
);
1549 /* Now add any PCM formats */
1550 PA_IDXSET_FOREACH(f
, formats
, idx
) {
1551 if (pa_format_info_is_pcm(f
)) {
1552 /* We don't set rates here since we'll just tack on a resampler for
1553 * unsupported rates */
1554 pa_idxset_put(u
->formats
, pa_format_info_copy(f
), NULL
);
1561 static pa_bool_t
sink_update_rate_cb(pa_sink
*s
, uint32_t rate
)
1563 struct userdata
*u
= s
->userdata
;
1565 pa_bool_t supported
= FALSE
;
1569 for (i
= 0; u
->rates
[i
]; i
++) {
1570 if (u
->rates
[i
] == rate
) {
1577 pa_log_info("Sink does not support sample rate of %d Hz", rate
);
1581 if (!PA_SINK_IS_OPENED(s
->state
)) {
1582 pa_log_info("Updating rate for device %s, new rate is %d",u
->device_name
, rate
);
1583 u
->sink
->sample_spec
.rate
= rate
;
1590 static int process_rewind(struct userdata
*u
) {
1591 snd_pcm_sframes_t unused
;
1592 size_t rewind_nbytes
, unused_nbytes
, limit_nbytes
;
1595 /* Figure out how much we shall rewind and reset the counter */
1596 rewind_nbytes
= u
->sink
->thread_info
.rewind_nbytes
;
1598 pa_log_debug("Requested to rewind %lu bytes.", (unsigned long) rewind_nbytes
);
1600 if (PA_UNLIKELY((unused
= pa_alsa_safe_avail(u
->pcm_handle
, u
->hwbuf_size
, &u
->sink
->sample_spec
)) < 0)) {
1601 pa_log("snd_pcm_avail() failed: %s", pa_alsa_strerror((int) unused
));
1605 unused_nbytes
= (size_t) unused
* u
->frame_size
;
1607 /* make sure rewind doesn't go too far, can cause issues with DMAs */
1608 unused_nbytes
+= u
->rewind_safeguard
;
1610 if (u
->hwbuf_size
> unused_nbytes
)
1611 limit_nbytes
= u
->hwbuf_size
- unused_nbytes
;
1615 if (rewind_nbytes
> limit_nbytes
)
1616 rewind_nbytes
= limit_nbytes
;
1618 if (rewind_nbytes
> 0) {
1619 snd_pcm_sframes_t in_frames
, out_frames
;
1621 pa_log_debug("Limited to %lu bytes.", (unsigned long) rewind_nbytes
);
1623 in_frames
= (snd_pcm_sframes_t
) (rewind_nbytes
/ u
->frame_size
);
1624 pa_log_debug("before: %lu", (unsigned long) in_frames
);
1625 if ((out_frames
= snd_pcm_rewind(u
->pcm_handle
, (snd_pcm_uframes_t
) in_frames
)) < 0) {
1626 pa_log("snd_pcm_rewind() failed: %s", pa_alsa_strerror((int) out_frames
));
1627 if (try_recover(u
, "process_rewind", out_frames
) < 0)
1632 pa_log_debug("after: %lu", (unsigned long) out_frames
);
1634 rewind_nbytes
= (size_t) out_frames
* u
->frame_size
;
1636 if (rewind_nbytes
<= 0)
1637 pa_log_info("Tried rewind, but was apparently not possible.");
1639 u
->write_count
-= rewind_nbytes
;
1640 pa_log_debug("Rewound %lu bytes.", (unsigned long) rewind_nbytes
);
1641 pa_sink_process_rewind(u
->sink
, rewind_nbytes
);
1643 u
->after_rewind
= TRUE
;
1647 pa_log_debug("Mhmm, actually there is nothing to rewind.");
1649 pa_sink_process_rewind(u
->sink
, 0);
1653 static void thread_func(void *userdata
) {
1654 struct userdata
*u
= userdata
;
1655 unsigned short revents
= 0;
1659 pa_log_debug("Thread starting up");
1661 if (u
->core
->realtime_scheduling
)
1662 pa_make_realtime(u
->core
->realtime_priority
);
1664 pa_thread_mq_install(&u
->thread_mq
);
1668 pa_usec_t rtpoll_sleep
= 0;
1671 pa_log_debug("Loop");
1674 /* Render some data and write it to the dsp */
1675 if (PA_SINK_IS_OPENED(u
->sink
->thread_info
.state
)) {
1677 pa_usec_t sleep_usec
= 0;
1678 pa_bool_t on_timeout
= pa_rtpoll_timer_elapsed(u
->rtpoll
);
1680 if (PA_UNLIKELY(u
->sink
->thread_info
.rewind_requested
))
1681 if (process_rewind(u
) < 0)
1685 work_done
= mmap_write(u
, &sleep_usec
, revents
& POLLOUT
, on_timeout
);
1687 work_done
= unix_write(u
, &sleep_usec
, revents
& POLLOUT
, on_timeout
);
1692 /* pa_log_debug("work_done = %i", work_done); */
1697 pa_log_info("Starting playback.");
1698 snd_pcm_start(u
->pcm_handle
);
1700 pa_smoother_resume(u
->smoother
, pa_rtclock_now(), TRUE
);
1708 if (u
->use_tsched
) {
1711 if (u
->since_start
<= u
->hwbuf_size
) {
1713 /* USB devices on ALSA seem to hit a buffer
1714 * underrun during the first iterations much
1715 * quicker then we calculate here, probably due to
1716 * the transport latency. To accommodate for that
1717 * we artificially decrease the sleep time until
1718 * we have filled the buffer at least once
1721 if (pa_log_ratelimit(PA_LOG_DEBUG
))
1722 pa_log_debug("Cutting sleep time for the initial iterations by half.");
1726 /* OK, the playback buffer is now full, let's
1727 * calculate when to wake up next */
1729 pa_log_debug("Waking up in %0.2fms (sound card clock).", (double) sleep_usec
/ PA_USEC_PER_MSEC
);
1732 /* Convert from the sound card time domain to the
1733 * system time domain */
1734 cusec
= pa_smoother_translate(u
->smoother
, pa_rtclock_now(), sleep_usec
);
1737 pa_log_debug("Waking up in %0.2fms (system clock).", (double) cusec
/ PA_USEC_PER_MSEC
);
1740 /* We don't trust the conversion, so we wake up whatever comes first */
1741 rtpoll_sleep
= PA_MIN(sleep_usec
, cusec
);
1744 u
->after_rewind
= FALSE
;
1748 if (u
->sink
->flags
& PA_SINK_DEFERRED_VOLUME
) {
1749 pa_usec_t volume_sleep
;
1750 pa_sink_volume_change_apply(u
->sink
, &volume_sleep
);
1751 if (volume_sleep
> 0) {
1752 if (rtpoll_sleep
> 0)
1753 rtpoll_sleep
= PA_MIN(volume_sleep
, rtpoll_sleep
);
1755 rtpoll_sleep
= volume_sleep
;
1759 if (rtpoll_sleep
> 0)
1760 pa_rtpoll_set_timer_relative(u
->rtpoll
, rtpoll_sleep
);
1762 pa_rtpoll_set_timer_disabled(u
->rtpoll
);
1764 /* Hmm, nothing to do. Let's sleep */
1765 if ((ret
= pa_rtpoll_run(u
->rtpoll
, TRUE
)) < 0)
1768 if (u
->sink
->flags
& PA_SINK_DEFERRED_VOLUME
)
1769 pa_sink_volume_change_apply(u
->sink
, NULL
);
1774 /* Tell ALSA about this and process its response */
1775 if (PA_SINK_IS_OPENED(u
->sink
->thread_info
.state
)) {
1776 struct pollfd
*pollfd
;
1780 pollfd
= pa_rtpoll_item_get_pollfd(u
->alsa_rtpoll_item
, &n
);
1782 if ((err
= snd_pcm_poll_descriptors_revents(u
->pcm_handle
, pollfd
, n
, &revents
)) < 0) {
1783 pa_log("snd_pcm_poll_descriptors_revents() failed: %s", pa_alsa_strerror(err
));
1787 if (revents
& ~POLLOUT
) {
1788 if (pa_alsa_recover_from_poll(u
->pcm_handle
, revents
) < 0)
1794 } else if (revents
&& u
->use_tsched
&& pa_log_ratelimit(PA_LOG_DEBUG
))
1795 pa_log_debug("Wakeup from ALSA!");
1802 /* If this was no regular exit from the loop we have to continue
1803 * processing messages until we received PA_MESSAGE_SHUTDOWN */
1804 pa_asyncmsgq_post(u
->thread_mq
.outq
, PA_MSGOBJECT(u
->core
), PA_CORE_MESSAGE_UNLOAD_MODULE
, u
->module
, 0, NULL
, NULL
);
1805 pa_asyncmsgq_wait_for(u
->thread_mq
.inq
, PA_MESSAGE_SHUTDOWN
);
1808 pa_log_debug("Thread shutting down");
1811 static void set_sink_name(pa_sink_new_data
*data
, pa_modargs
*ma
, const char *device_id
, const char *device_name
, pa_alsa_mapping
*mapping
) {
1817 pa_assert(device_name
);
1819 if ((n
= pa_modargs_get_value(ma
, "sink_name", NULL
))) {
1820 pa_sink_new_data_set_name(data
, n
);
1821 data
->namereg_fail
= TRUE
;
1825 if ((n
= pa_modargs_get_value(ma
, "name", NULL
)))
1826 data
->namereg_fail
= TRUE
;
1828 n
= device_id
? device_id
: device_name
;
1829 data
->namereg_fail
= FALSE
;
1833 t
= pa_sprintf_malloc("alsa_output.%s.%s", n
, mapping
->name
);
1835 t
= pa_sprintf_malloc("alsa_output.%s", n
);
1837 pa_sink_new_data_set_name(data
, t
);
1841 static void find_mixer(struct userdata
*u
, pa_alsa_mapping
*mapping
, const char *element
, pa_bool_t ignore_dB
) {
1844 if (!mapping
&& !element
)
1847 if (!(u
->mixer_handle
= pa_alsa_open_mixer_for_pcm(u
->pcm_handle
, &u
->control_device
, &hctl
))) {
1848 pa_log_info("Failed to find a working mixer device.");
1854 if (!(u
->mixer_path
= pa_alsa_path_synthesize(element
, PA_ALSA_DIRECTION_OUTPUT
)))
1857 if (pa_alsa_path_probe(u
->mixer_path
, u
->mixer_handle
, hctl
, ignore_dB
) < 0)
1860 pa_log_debug("Probed mixer path %s:", u
->mixer_path
->name
);
1861 pa_alsa_path_dump(u
->mixer_path
);
1862 } else if (!(u
->mixer_path_set
= mapping
->output_path_set
))
1869 if (u
->mixer_path
) {
1870 pa_alsa_path_free(u
->mixer_path
);
1871 u
->mixer_path
= NULL
;
1874 if (u
->mixer_handle
) {
1875 snd_mixer_close(u
->mixer_handle
);
1876 u
->mixer_handle
= NULL
;
1881 static int setup_mixer(struct userdata
*u
, pa_bool_t ignore_dB
) {
1882 pa_bool_t need_mixer_callback
= FALSE
;
1886 if (!u
->mixer_handle
)
1889 if (u
->sink
->active_port
) {
1890 pa_alsa_port_data
*data
;
1892 /* We have a list of supported paths, so let's activate the
1893 * one that has been chosen as active */
1895 data
= PA_DEVICE_PORT_DATA(u
->sink
->active_port
);
1896 u
->mixer_path
= data
->path
;
1898 pa_alsa_path_select(data
->path
, u
->mixer_handle
);
1901 pa_alsa_setting_select(data
->setting
, u
->mixer_handle
);
1905 if (!u
->mixer_path
&& u
->mixer_path_set
)
1906 u
->mixer_path
= pa_hashmap_first(u
->mixer_path_set
->paths
);
1908 if (u
->mixer_path
) {
1909 /* Hmm, we have only a single path, then let's activate it */
1911 pa_alsa_path_select(u
->mixer_path
, u
->mixer_handle
);
1913 if (u
->mixer_path
->settings
)
1914 pa_alsa_setting_select(u
->mixer_path
->settings
, u
->mixer_handle
);
1919 mixer_volume_init(u
);
1921 /* Will we need to register callbacks? */
1922 if (u
->mixer_path_set
&& u
->mixer_path_set
->paths
) {
1926 PA_HASHMAP_FOREACH(p
, u
->mixer_path_set
->paths
, state
) {
1927 if (p
->has_volume
|| p
->has_mute
)
1928 need_mixer_callback
= TRUE
;
1931 else if (u
->mixer_path
)
1932 need_mixer_callback
= u
->mixer_path
->has_volume
|| u
->mixer_path
->has_mute
;
1934 if (need_mixer_callback
) {
1935 int (*mixer_callback
)(snd_mixer_elem_t
*, unsigned int);
1936 if (u
->sink
->flags
& PA_SINK_DEFERRED_VOLUME
) {
1937 u
->mixer_pd
= pa_alsa_mixer_pdata_new();
1938 mixer_callback
= io_mixer_callback
;
1940 if (pa_alsa_set_mixer_rtpoll(u
->mixer_pd
, u
->mixer_handle
, u
->rtpoll
) < 0) {
1941 pa_log("Failed to initialize file descriptor monitoring");
1945 u
->mixer_fdl
= pa_alsa_fdlist_new();
1946 mixer_callback
= ctl_mixer_callback
;
1948 if (pa_alsa_fdlist_set_handle(u
->mixer_fdl
, u
->mixer_handle
, NULL
, u
->core
->mainloop
) < 0) {
1949 pa_log("Failed to initialize file descriptor monitoring");
1954 if (u
->mixer_path_set
)
1955 pa_alsa_path_set_set_callback(u
->mixer_path_set
, u
->mixer_handle
, mixer_callback
, u
);
1957 pa_alsa_path_set_callback(u
->mixer_path
, u
->mixer_handle
, mixer_callback
, u
);
1963 pa_sink
*pa_alsa_sink_new(pa_module
*m
, pa_modargs
*ma
, const char*driver
, pa_card
*card
, pa_alsa_mapping
*mapping
) {
1965 struct userdata
*u
= NULL
;
1966 const char *dev_id
= NULL
;
1968 uint32_t alternate_sample_rate
;
1970 uint32_t nfrags
, frag_size
, buffer_size
, tsched_size
, tsched_watermark
, rewind_safeguard
;
1971 snd_pcm_uframes_t period_frames
, buffer_frames
, tsched_frames
;
1973 pa_bool_t use_mmap
= TRUE
, b
, use_tsched
= TRUE
, d
, ignore_dB
= FALSE
, namereg_fail
= FALSE
, deferred_volume
= FALSE
, set_formats
= FALSE
, fixed_latency_range
= FALSE
;
1974 pa_sink_new_data data
;
1975 pa_alsa_profile_set
*profile_set
= NULL
;
1980 ss
= m
->core
->default_sample_spec
;
1981 map
= m
->core
->default_channel_map
;
1982 if (pa_modargs_get_sample_spec_and_channel_map(ma
, &ss
, &map
, PA_CHANNEL_MAP_ALSA
) < 0) {
1983 pa_log("Failed to parse sample specification and channel map");
1987 alternate_sample_rate
= m
->core
->alternate_sample_rate
;
1988 if (pa_modargs_get_alternate_sample_rate(ma
, &alternate_sample_rate
) < 0) {
1989 pa_log("Failed to parse alternate sample rate");
1993 frame_size
= pa_frame_size(&ss
);
1995 nfrags
= m
->core
->default_n_fragments
;
1996 frag_size
= (uint32_t) pa_usec_to_bytes(m
->core
->default_fragment_size_msec
*PA_USEC_PER_MSEC
, &ss
);
1998 frag_size
= (uint32_t) frame_size
;
1999 tsched_size
= (uint32_t) pa_usec_to_bytes(DEFAULT_TSCHED_BUFFER_USEC
, &ss
);
2000 tsched_watermark
= (uint32_t) pa_usec_to_bytes(DEFAULT_TSCHED_WATERMARK_USEC
, &ss
);
2002 if (pa_modargs_get_value_u32(ma
, "fragments", &nfrags
) < 0 ||
2003 pa_modargs_get_value_u32(ma
, "fragment_size", &frag_size
) < 0 ||
2004 pa_modargs_get_value_u32(ma
, "tsched_buffer_size", &tsched_size
) < 0 ||
2005 pa_modargs_get_value_u32(ma
, "tsched_buffer_watermark", &tsched_watermark
) < 0) {
2006 pa_log("Failed to parse buffer metrics");
2010 buffer_size
= nfrags
* frag_size
;
2012 period_frames
= frag_size
/frame_size
;
2013 buffer_frames
= buffer_size
/frame_size
;
2014 tsched_frames
= tsched_size
/frame_size
;
2016 if (pa_modargs_get_value_boolean(ma
, "mmap", &use_mmap
) < 0) {
2017 pa_log("Failed to parse mmap argument.");
2021 if (pa_modargs_get_value_boolean(ma
, "tsched", &use_tsched
) < 0) {
2022 pa_log("Failed to parse tsched argument.");
2026 if (pa_modargs_get_value_boolean(ma
, "ignore_dB", &ignore_dB
) < 0) {
2027 pa_log("Failed to parse ignore_dB argument.");
2031 rewind_safeguard
= PA_MAX(DEFAULT_REWIND_SAFEGUARD_BYTES
, pa_usec_to_bytes(DEFAULT_REWIND_SAFEGUARD_USEC
, &ss
));
2032 if (pa_modargs_get_value_u32(ma
, "rewind_safeguard", &rewind_safeguard
) < 0) {
2033 pa_log("Failed to parse rewind_safeguard argument");
2037 deferred_volume
= m
->core
->deferred_volume
;
2038 if (pa_modargs_get_value_boolean(ma
, "deferred_volume", &deferred_volume
) < 0) {
2039 pa_log("Failed to parse deferred_volume argument.");
2043 if (pa_modargs_get_value_boolean(ma
, "fixed_latency_range", &fixed_latency_range
) < 0) {
2044 pa_log("Failed to parse fixed_latency_range argument.");
2048 use_tsched
= pa_alsa_may_tsched(use_tsched
);
2050 u
= pa_xnew0(struct userdata
, 1);
2053 u
->use_mmap
= use_mmap
;
2054 u
->use_tsched
= use_tsched
;
2055 u
->deferred_volume
= deferred_volume
;
2056 u
->fixed_latency_range
= fixed_latency_range
;
2058 u
->rewind_safeguard
= rewind_safeguard
;
2059 u
->rtpoll
= pa_rtpoll_new();
2060 pa_thread_mq_init(&u
->thread_mq
, m
->core
->mainloop
, u
->rtpoll
);
2062 u
->smoother
= pa_smoother_new(
2063 SMOOTHER_ADJUST_USEC
,
2064 SMOOTHER_WINDOW_USEC
,
2070 u
->smoother_interval
= SMOOTHER_MIN_INTERVAL
;
2072 dev_id
= pa_modargs_get_value(
2074 pa_modargs_get_value(ma
, "device", DEFAULT_DEVICE
));
2076 u
->paths_dir
= pa_xstrdup(pa_modargs_get_value(ma
, "paths_dir", NULL
));
2078 if (reserve_init(u
, dev_id
) < 0)
2081 if (reserve_monitor_init(u
, dev_id
) < 0)
2089 if (!(dev_id
= pa_modargs_get_value(ma
, "device_id", NULL
))) {
2090 pa_log("device_id= not set");
2094 if (!(u
->pcm_handle
= pa_alsa_open_by_device_id_mapping(
2098 SND_PCM_STREAM_PLAYBACK
,
2099 &period_frames
, &buffer_frames
, tsched_frames
,
2103 } else if ((dev_id
= pa_modargs_get_value(ma
, "device_id", NULL
))) {
2105 if (!(profile_set
= pa_alsa_profile_set_new(NULL
, &map
)))
2108 if (!(u
->pcm_handle
= pa_alsa_open_by_device_id_auto(
2112 SND_PCM_STREAM_PLAYBACK
,
2113 &period_frames
, &buffer_frames
, tsched_frames
,
2114 &b
, &d
, profile_set
, &mapping
)))
2119 if (!(u
->pcm_handle
= pa_alsa_open_by_device_string(
2120 pa_modargs_get_value(ma
, "device", DEFAULT_DEVICE
),
2123 SND_PCM_STREAM_PLAYBACK
,
2124 &period_frames
, &buffer_frames
, tsched_frames
,
2129 pa_assert(u
->device_name
);
2130 pa_log_info("Successfully opened device %s.", u
->device_name
);
2132 if (pa_alsa_pcm_is_modem(u
->pcm_handle
)) {
2133 pa_log_notice("Device %s is modem, refusing further initialization.", u
->device_name
);
2138 pa_log_info("Selected mapping '%s' (%s).", mapping
->description
, mapping
->name
);
2140 if (use_mmap
&& !b
) {
2141 pa_log_info("Device doesn't support mmap(), falling back to UNIX read/write mode.");
2142 u
->use_mmap
= use_mmap
= FALSE
;
2145 if (use_tsched
&& (!b
|| !d
)) {
2146 pa_log_info("Cannot enable timer-based scheduling, falling back to sound IRQ scheduling.");
2147 u
->use_tsched
= use_tsched
= FALSE
;
2151 pa_log_info("Successfully enabled mmap() mode.");
2153 if (u
->use_tsched
) {
2154 pa_log_info("Successfully enabled timer-based scheduling mode.");
2156 if (u
->fixed_latency_range
)
2157 pa_log_info("Disabling latency range changes on underrun");
2160 if (is_iec958(u
) || is_hdmi(u
))
2163 u
->rates
= pa_alsa_get_supported_rates(u
->pcm_handle
);
2165 pa_log_error("Failed to find any supported sample rates.");
2169 /* ALSA might tweak the sample spec, so recalculate the frame size */
2170 frame_size
= pa_frame_size(&ss
);
2172 find_mixer(u
, mapping
, pa_modargs_get_value(ma
, "control", NULL
), ignore_dB
);
2174 pa_sink_new_data_init(&data
);
2175 data
.driver
= driver
;
2178 set_sink_name(&data
, ma
, dev_id
, u
->device_name
, mapping
);
2180 /* We need to give pa_modargs_get_value_boolean() a pointer to a local
2181 * variable instead of using &data.namereg_fail directly, because
2182 * data.namereg_fail is a bitfield and taking the address of a bitfield
2183 * variable is impossible. */
2184 namereg_fail
= data
.namereg_fail
;
2185 if (pa_modargs_get_value_boolean(ma
, "namereg_fail", &namereg_fail
) < 0) {
2186 pa_log("Failed to parse namereg_fail argument.");
2187 pa_sink_new_data_done(&data
);
2190 data
.namereg_fail
= namereg_fail
;
2192 pa_sink_new_data_set_sample_spec(&data
, &ss
);
2193 pa_sink_new_data_set_channel_map(&data
, &map
);
2194 pa_sink_new_data_set_alternate_sample_rate(&data
, alternate_sample_rate
);
2196 pa_alsa_init_proplist_pcm(m
->core
, data
.proplist
, u
->pcm_handle
);
2197 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_STRING
, u
->device_name
);
2198 pa_proplist_setf(data
.proplist
, PA_PROP_DEVICE_BUFFERING_BUFFER_SIZE
, "%lu", (unsigned long) (buffer_frames
* frame_size
));
2199 pa_proplist_setf(data
.proplist
, PA_PROP_DEVICE_BUFFERING_FRAGMENT_SIZE
, "%lu", (unsigned long) (period_frames
* frame_size
));
2200 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_ACCESS_MODE
, u
->use_tsched
? "mmap+timer" : (u
->use_mmap
? "mmap" : "serial"));
2203 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_PROFILE_NAME
, mapping
->name
);
2204 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_PROFILE_DESCRIPTION
, mapping
->description
);
2207 pa_alsa_init_description(data
.proplist
);
2209 if (u
->control_device
)
2210 pa_alsa_init_proplist_ctl(data
.proplist
, u
->control_device
);
2212 if (pa_modargs_get_proplist(ma
, "sink_properties", data
.proplist
, PA_UPDATE_REPLACE
) < 0) {
2213 pa_log("Invalid properties");
2214 pa_sink_new_data_done(&data
);
2218 if (u
->mixer_path_set
)
2219 pa_alsa_add_ports(&data
.ports
, u
->mixer_path_set
, card
);
2221 u
->sink
= pa_sink_new(m
->core
, &data
, PA_SINK_HARDWARE
| PA_SINK_LATENCY
| (u
->use_tsched
? PA_SINK_DYNAMIC_LATENCY
: 0) |
2222 (set_formats
? PA_SINK_SET_FORMATS
: 0));
2223 pa_sink_new_data_done(&data
);
2226 pa_log("Failed to create sink object");
2230 if (pa_modargs_get_value_u32(ma
, "deferred_volume_safety_margin",
2231 &u
->sink
->thread_info
.volume_change_safety_margin
) < 0) {
2232 pa_log("Failed to parse deferred_volume_safety_margin parameter");
2236 if (pa_modargs_get_value_s32(ma
, "deferred_volume_extra_delay",
2237 &u
->sink
->thread_info
.volume_change_extra_delay
) < 0) {
2238 pa_log("Failed to parse deferred_volume_extra_delay parameter");
2242 u
->sink
->parent
.process_msg
= sink_process_msg
;
2244 u
->sink
->update_requested_latency
= sink_update_requested_latency_cb
;
2245 u
->sink
->set_state
= sink_set_state_cb
;
2246 u
->sink
->set_port
= sink_set_port_cb
;
2247 if (u
->sink
->alternate_sample_rate
)
2248 u
->sink
->update_rate
= sink_update_rate_cb
;
2249 u
->sink
->userdata
= u
;
2251 pa_sink_set_asyncmsgq(u
->sink
, u
->thread_mq
.inq
);
2252 pa_sink_set_rtpoll(u
->sink
, u
->rtpoll
);
2254 u
->frame_size
= frame_size
;
2255 u
->fragment_size
= frag_size
= (size_t) (period_frames
* frame_size
);
2256 u
->hwbuf_size
= buffer_size
= (size_t) (buffer_frames
* frame_size
);
2257 pa_cvolume_mute(&u
->hardware_volume
, u
->sink
->sample_spec
.channels
);
2259 pa_log_info("Using %0.1f fragments of size %lu bytes (%0.2fms), buffer size is %lu bytes (%0.2fms)",
2260 (double) u
->hwbuf_size
/ (double) u
->fragment_size
,
2261 (long unsigned) u
->fragment_size
,
2262 (double) pa_bytes_to_usec(u
->fragment_size
, &ss
) / PA_USEC_PER_MSEC
,
2263 (long unsigned) u
->hwbuf_size
,
2264 (double) pa_bytes_to_usec(u
->hwbuf_size
, &ss
) / PA_USEC_PER_MSEC
);
2266 pa_sink_set_max_request(u
->sink
, u
->hwbuf_size
);
2267 if (pa_alsa_pcm_is_hw(u
->pcm_handle
))
2268 pa_sink_set_max_rewind(u
->sink
, u
->hwbuf_size
);
2270 pa_log_info("Disabling rewind for device %s", u
->device_name
);
2271 pa_sink_set_max_rewind(u
->sink
, 0);
2274 if (u
->use_tsched
) {
2275 u
->tsched_watermark_ref
= tsched_watermark
;
2276 reset_watermark(u
, u
->tsched_watermark_ref
, &ss
, FALSE
);
2278 pa_sink_set_fixed_latency(u
->sink
, pa_bytes_to_usec(u
->hwbuf_size
, &ss
));
2282 if (update_sw_params(u
) < 0)
2285 if (setup_mixer(u
, ignore_dB
) < 0)
2288 pa_alsa_dump(PA_LOG_DEBUG
, u
->pcm_handle
);
2290 if (!(u
->thread
= pa_thread_new("alsa-sink", thread_func
, u
))) {
2291 pa_log("Failed to create thread.");
2295 /* Get initial mixer settings */
2296 if (data
.volume_is_set
) {
2297 if (u
->sink
->set_volume
)
2298 u
->sink
->set_volume(u
->sink
);
2300 if (u
->sink
->get_volume
)
2301 u
->sink
->get_volume(u
->sink
);
2304 if (data
.muted_is_set
) {
2305 if (u
->sink
->set_mute
)
2306 u
->sink
->set_mute(u
->sink
);
2308 if (u
->sink
->get_mute
)
2309 u
->sink
->get_mute(u
->sink
);
2312 if ((data
.volume_is_set
|| data
.muted_is_set
) && u
->sink
->write_volume
)
2313 u
->sink
->write_volume(u
->sink
);
2316 /* For S/PDIF and HDMI, allow getting/setting custom formats */
2317 pa_format_info
*format
;
2319 /* To start with, we only support PCM formats. Other formats may be added
2320 * with pa_sink_set_formats().*/
2321 format
= pa_format_info_new();
2322 format
->encoding
= PA_ENCODING_PCM
;
2323 u
->formats
= pa_idxset_new(NULL
, NULL
);
2324 pa_idxset_put(u
->formats
, format
, NULL
);
2326 u
->sink
->get_formats
= sink_get_formats
;
2327 u
->sink
->set_formats
= sink_set_formats
;
2330 pa_sink_put(u
->sink
);
2333 pa_alsa_profile_set_free(profile_set
);
2343 pa_alsa_profile_set_free(profile_set
);
2348 static void userdata_free(struct userdata
*u
) {
2352 pa_sink_unlink(u
->sink
);
2355 pa_asyncmsgq_send(u
->thread_mq
.inq
, NULL
, PA_MESSAGE_SHUTDOWN
, NULL
, 0, NULL
);
2356 pa_thread_free(u
->thread
);
2359 pa_thread_mq_done(&u
->thread_mq
);
2362 pa_sink_unref(u
->sink
);
2364 if (u
->memchunk
.memblock
)
2365 pa_memblock_unref(u
->memchunk
.memblock
);
2368 pa_alsa_mixer_pdata_free(u
->mixer_pd
);
2370 if (u
->alsa_rtpoll_item
)
2371 pa_rtpoll_item_free(u
->alsa_rtpoll_item
);
2374 pa_rtpoll_free(u
->rtpoll
);
2376 if (u
->pcm_handle
) {
2377 snd_pcm_drop(u
->pcm_handle
);
2378 snd_pcm_close(u
->pcm_handle
);
2382 pa_alsa_fdlist_free(u
->mixer_fdl
);
2384 if (u
->mixer_path
&& !u
->mixer_path_set
)
2385 pa_alsa_path_free(u
->mixer_path
);
2387 if (u
->mixer_handle
)
2388 snd_mixer_close(u
->mixer_handle
);
2391 pa_smoother_free(u
->smoother
);
2394 pa_idxset_free(u
->formats
, (pa_free2_cb_t
) pa_format_info_free2
, NULL
);
2402 pa_xfree(u
->device_name
);
2403 pa_xfree(u
->control_device
);
2404 pa_xfree(u
->paths_dir
);
2408 void pa_alsa_sink_free(pa_sink
*s
) {
2411 pa_sink_assert_ref(s
);
2412 pa_assert_se(u
= s
->userdata
);