2 This file is part of PulseAudio.
4 Copyright 2010 Wim Taymans <wim.taymans@gmail.com>
6 Based on module-virtual-sink.c
7 module-virtual-source.c
10 Copyright 2010 Intel Corporation
11 Contributor: Pierre-Louis Bossart <pierre-louis.bossart@intel.com>
13 PulseAudio is free software; you can redistribute it and/or modify
14 it under the terms of the GNU Lesser General Public License as published
15 by the Free Software Foundation; either version 2.1 of the License,
16 or (at your option) any later version.
18 PulseAudio is distributed in the hope that it will be useful, but
19 WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 General Public License for more details.
23 You should have received a copy of the GNU Lesser General Public License
24 along with PulseAudio; if not, write to the Free Software
25 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
35 #include "echo-cancel.h"
37 #include <pulse/xmalloc.h>
38 #include <pulse/timeval.h>
39 #include <pulse/rtclock.h>
41 #include <pulsecore/i18n.h>
42 #include <pulsecore/atomic.h>
43 #include <pulsecore/macro.h>
44 #include <pulsecore/namereg.h>
45 #include <pulsecore/sink.h>
46 #include <pulsecore/module.h>
47 #include <pulsecore/core-rtclock.h>
48 #include <pulsecore/core-util.h>
49 #include <pulsecore/modargs.h>
50 #include <pulsecore/log.h>
51 #include <pulsecore/rtpoll.h>
52 #include <pulsecore/sample-util.h>
53 #include <pulsecore/ltdl-helper.h>
55 #include "module-echo-cancel-symdef.h"
57 PA_MODULE_AUTHOR("Wim Taymans");
58 PA_MODULE_DESCRIPTION("Echo Cancellation");
59 PA_MODULE_VERSION(PACKAGE_VERSION
);
60 PA_MODULE_LOAD_ONCE(FALSE
);
62 _("source_name=<name for the source> "
63 "source_properties=<properties for the source> "
64 "source_master=<name of source to filter> "
65 "sink_name=<name for the sink> "
66 "sink_properties=<properties for the sink> "
67 "sink_master=<name of sink to filter> "
68 "adjust_time=<how often to readjust rates in s> "
69 "adjust_threshold=<how much drift to readjust after in ms> "
70 "format=<sample format> "
72 "channels=<number of channels> "
73 "channel_map=<channel map> "
74 "aec_method=<implementation to use> "
75 "aec_args=<parameters for the AEC engine> "
76 "save_aec=<save AEC data in /tmp> "
77 "autoloaded=<set if this module is being loaded automatically> "
78 "use_volume_sharing=<yes or no> "
81 /* NOTE: Make sure the enum and ec_table are maintained in the correct order */
83 PA_ECHO_CANCELLER_INVALID
= -1,
84 PA_ECHO_CANCELLER_SPEEX
= 0,
85 PA_ECHO_CANCELLER_ADRIAN
,
86 } pa_echo_canceller_method_t
;
88 #define DEFAULT_ECHO_CANCELLER "speex"
90 static const pa_echo_canceller ec_table
[] = {
93 .init
= pa_speex_ec_init
,
94 .run
= pa_speex_ec_run
,
95 .done
= pa_speex_ec_done
,
98 /* Adrian Andre's NLMS implementation */
99 .init
= pa_adrian_ec_init
,
100 .run
= pa_adrian_ec_run
,
101 .done
= pa_adrian_ec_done
,
105 #define DEFAULT_RATE 32000
106 #define DEFAULT_CHANNELS 1
107 #define DEFAULT_ADJUST_TIME_USEC (1*PA_USEC_PER_SEC)
108 #define DEFAULT_ADJUST_TOLERANCE (5*PA_USEC_PER_MSEC)
109 #define DEFAULT_SAVE_AEC FALSE
110 #define DEFAULT_AUTOLOADED FALSE
112 #define MEMBLOCKQ_MAXLENGTH (16*1024*1024)
114 /* This module creates a new (virtual) source and sink.
116 * The data sent to the new sink is kept in a memblockq before being
117 * forwarded to the real sink_master.
119 * Data read from source_master is matched against the saved sink data and
120 * echo canceled data is then pushed onto the new source.
122 * Both source and sink masters have their own threads to push/pull data
123 * respectively. We however perform all our actions in the source IO thread.
124 * To do this we send all played samples to the source IO thread where they
125 * are then pushed into the memblockq.
127 * Alignment is performed in two steps:
129 * 1) when something happens that requires quick adjustment of the alignment of
130 * capture and playback samples, we perform a resync. This adjusts the
131 * position in the playback memblock to the requested sample. Quick
132 * adjustments include moving the playback samples before the capture
133 * samples (because else the echo canceler does not work) or when the
134 * playback pointer drifts too far away.
136 * 2) periodically check the difference between capture and playback. we use a
137 * low and high watermark for adjusting the alignment. playback should always
138 * be before capture and the difference should not be bigger than one frame
139 * size. We would ideally like to resample the sink_input but most driver
140 * don't give enough accuracy to be able to do that right now.
145 pa_usec_t sink_latency
;
147 int64_t send_counter
;
149 pa_usec_t source_now
;
150 pa_usec_t source_latency
;
152 int64_t recv_counter
;
161 pa_bool_t autoloaded
;
165 pa_echo_canceller
*ec
;
168 pa_bool_t need_realign
;
170 /* to wakeup the source I/O thread */
171 pa_asyncmsgq
*asyncmsgq
;
172 pa_rtpoll_item
*rtpoll_item_read
, *rtpoll_item_write
;
175 pa_bool_t source_auto_desc
;
176 pa_source_output
*source_output
;
177 pa_memblockq
*source_memblockq
; /* echo canceler needs fixed sized chunks */
181 pa_bool_t sink_auto_desc
;
182 pa_sink_input
*sink_input
;
183 pa_memblockq
*sink_memblockq
;
184 int64_t send_counter
; /* updated in sink IO thread */
185 int64_t recv_counter
;
188 pa_atomic_t request_resync
;
191 pa_time_event
*time_event
;
192 pa_usec_t adjust_time
;
193 int adjust_threshold
;
200 static void source_output_snapshot_within_thread(struct userdata
*u
, struct snapshot
*snapshot
);
202 static const char* const valid_modargs
[] = {
219 "use_volume_sharing",
224 SOURCE_OUTPUT_MESSAGE_POST
= PA_SOURCE_OUTPUT_MESSAGE_MAX
,
225 SOURCE_OUTPUT_MESSAGE_REWIND
,
226 SOURCE_OUTPUT_MESSAGE_LATENCY_SNAPSHOT
,
227 SOURCE_OUTPUT_MESSAGE_APPLY_DIFF_TIME
231 SINK_INPUT_MESSAGE_LATENCY_SNAPSHOT
234 static int64_t calc_diff(struct userdata
*u
, struct snapshot
*snapshot
) {
235 int64_t buffer
, diff_time
, buffer_latency
;
237 /* get the number of samples between capture and playback */
238 if (snapshot
->plen
> snapshot
->rlen
)
239 buffer
= snapshot
->plen
- snapshot
->rlen
;
243 buffer
+= snapshot
->source_delay
+ snapshot
->sink_delay
;
245 /* add the amount of samples not yet transferred to the source context */
246 if (snapshot
->recv_counter
<= snapshot
->send_counter
)
247 buffer
+= (int64_t) (snapshot
->send_counter
- snapshot
->recv_counter
);
249 buffer
+= PA_CLIP_SUB(buffer
, (int64_t) (snapshot
->recv_counter
- snapshot
->send_counter
));
251 /* convert to time */
252 buffer_latency
= pa_bytes_to_usec(buffer
, &u
->source_output
->sample_spec
);
254 /* capture and playback samples are perfectly aligned when diff_time is 0 */
255 diff_time
= (snapshot
->sink_now
+ snapshot
->sink_latency
- buffer_latency
) -
256 (snapshot
->source_now
- snapshot
->source_latency
);
258 pa_log_debug("diff %lld (%lld - %lld + %lld) %lld %lld %lld %lld", (long long) diff_time
,
259 (long long) snapshot
->sink_latency
,
260 (long long) buffer_latency
, (long long) snapshot
->source_latency
,
261 (long long) snapshot
->source_delay
, (long long) snapshot
->sink_delay
,
262 (long long) (snapshot
->send_counter
- snapshot
->recv_counter
),
263 (long long) (snapshot
->sink_now
- snapshot
->source_now
));
268 /* Called from main context */
269 static void time_callback(pa_mainloop_api
*a
, pa_time_event
*e
, const struct timeval
*t
, void *userdata
) {
270 struct userdata
*u
= userdata
;
271 uint32_t old_rate
, base_rate
, new_rate
;
274 struct snapshot latency_snapshot
;
278 pa_assert(u
->time_event
== e
);
279 pa_assert_ctl_context();
281 if (u
->active_mask
!= 3)
284 /* update our snapshots */
285 pa_asyncmsgq_send(u
->source_output
->source
->asyncmsgq
, PA_MSGOBJECT(u
->source_output
), SOURCE_OUTPUT_MESSAGE_LATENCY_SNAPSHOT
, &latency_snapshot
, 0, NULL
);
286 pa_asyncmsgq_send(u
->sink_input
->sink
->asyncmsgq
, PA_MSGOBJECT(u
->sink_input
), SINK_INPUT_MESSAGE_LATENCY_SNAPSHOT
, &latency_snapshot
, 0, NULL
);
288 /* calculate drift between capture and playback */
289 diff_time
= calc_diff(u
, &latency_snapshot
);
291 /*fs = pa_frame_size(&u->source_output->sample_spec);*/
292 old_rate
= u
->sink_input
->sample_spec
.rate
;
293 base_rate
= u
->source_output
->sample_spec
.rate
;
296 /* recording before playback, we need to adjust quickly. The echo
297 * canceler does not work in this case. */
298 pa_asyncmsgq_post(u
->asyncmsgq
, PA_MSGOBJECT(u
->source_output
), SOURCE_OUTPUT_MESSAGE_APPLY_DIFF_TIME
,
299 NULL
, diff_time
, NULL
, NULL
);
300 /*new_rate = base_rate - ((pa_usec_to_bytes(-diff_time, &u->source_output->sample_spec) / fs) * PA_USEC_PER_SEC) / u->adjust_time;*/
301 new_rate
= base_rate
;
304 if (diff_time
> u
->adjust_threshold
) {
305 /* diff too big, quickly adjust */
306 pa_asyncmsgq_post(u
->asyncmsgq
, PA_MSGOBJECT(u
->source_output
), SOURCE_OUTPUT_MESSAGE_APPLY_DIFF_TIME
,
307 NULL
, diff_time
, NULL
, NULL
);
310 /* recording behind playback, we need to slowly adjust the rate to match */
311 /*new_rate = base_rate + ((pa_usec_to_bytes(diff_time, &u->source_output->sample_spec) / fs) * PA_USEC_PER_SEC) / u->adjust_time;*/
313 /* assume equal samplerates for now */
314 new_rate
= base_rate
;
317 /* make sure we don't make too big adjustments because that sounds horrible */
318 if (new_rate
> base_rate
* 1.1 || new_rate
< base_rate
* 0.9)
319 new_rate
= base_rate
;
321 if (new_rate
!= old_rate
) {
322 pa_log_info("Old rate %lu Hz, new rate %lu Hz", (unsigned long) old_rate
, (unsigned long) new_rate
);
324 pa_sink_input_set_rate(u
->sink_input
, new_rate
);
327 pa_core_rttime_restart(u
->core
, u
->time_event
, pa_rtclock_now() + u
->adjust_time
);
330 /* Called from source I/O thread context */
331 static int source_process_msg_cb(pa_msgobject
*o
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
332 struct userdata
*u
= PA_SOURCE(o
)->userdata
;
336 case PA_SOURCE_MESSAGE_GET_LATENCY
:
338 /* The source is _put() before the source output is, so let's
339 * make sure we don't access it in that time. Also, the
340 * source output is first shut down, the source second. */
341 if (!PA_SOURCE_IS_LINKED(u
->source
->thread_info
.state
) ||
342 !PA_SOURCE_OUTPUT_IS_LINKED(u
->source_output
->thread_info
.state
)) {
343 *((pa_usec_t
*) data
) = 0;
347 *((pa_usec_t
*) data
) =
349 /* Get the latency of the master source */
350 pa_source_get_latency_within_thread(u
->source_output
->source
) +
351 /* Add the latency internal to our source output on top */
352 pa_bytes_to_usec(pa_memblockq_get_length(u
->source_output
->thread_info
.delay_memblockq
), &u
->source_output
->source
->sample_spec
) +
353 /* and the buffering we do on the source */
354 pa_bytes_to_usec(u
->blocksize
, &u
->source_output
->source
->sample_spec
);
360 return pa_source_process_msg(o
, code
, data
, offset
, chunk
);
363 /* Called from sink I/O thread context */
364 static int sink_process_msg_cb(pa_msgobject
*o
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
365 struct userdata
*u
= PA_SINK(o
)->userdata
;
369 case PA_SINK_MESSAGE_GET_LATENCY
:
371 /* The sink is _put() before the sink input is, so let's
372 * make sure we don't access it in that time. Also, the
373 * sink input is first shut down, the sink second. */
374 if (!PA_SINK_IS_LINKED(u
->sink
->thread_info
.state
) ||
375 !PA_SINK_INPUT_IS_LINKED(u
->sink_input
->thread_info
.state
)) {
376 *((pa_usec_t
*) data
) = 0;
380 *((pa_usec_t
*) data
) =
382 /* Get the latency of the master sink */
383 pa_sink_get_latency_within_thread(u
->sink_input
->sink
) +
385 /* Add the latency internal to our sink input on top */
386 pa_bytes_to_usec(pa_memblockq_get_length(u
->sink_input
->thread_info
.render_memblockq
), &u
->sink_input
->sink
->sample_spec
);
391 return pa_sink_process_msg(o
, code
, data
, offset
, chunk
);
395 /* Called from main context */
396 static int source_set_state_cb(pa_source
*s
, pa_source_state_t state
) {
399 pa_source_assert_ref(s
);
400 pa_assert_se(u
= s
->userdata
);
402 if (!PA_SOURCE_IS_LINKED(state
) ||
403 !PA_SOURCE_OUTPUT_IS_LINKED(pa_source_output_get_state(u
->source_output
)))
406 pa_log_debug("Source state %d %d", state
, u
->active_mask
);
408 if (state
== PA_SOURCE_RUNNING
) {
409 /* restart timer when both sink and source are active */
411 if (u
->active_mask
== 3 && u
->adjust_time
)
412 pa_core_rttime_restart(u
->core
, u
->time_event
, pa_rtclock_now() + u
->adjust_time
);
414 pa_atomic_store(&u
->request_resync
, 1);
415 pa_source_output_cork(u
->source_output
, FALSE
);
416 } else if (state
== PA_SOURCE_SUSPENDED
) {
417 u
->active_mask
&= ~1;
418 pa_source_output_cork(u
->source_output
, TRUE
);
423 /* Called from main context */
424 static int sink_set_state_cb(pa_sink
*s
, pa_sink_state_t state
) {
427 pa_sink_assert_ref(s
);
428 pa_assert_se(u
= s
->userdata
);
430 if (!PA_SINK_IS_LINKED(state
) ||
431 !PA_SINK_INPUT_IS_LINKED(pa_sink_input_get_state(u
->sink_input
)))
434 pa_log_debug("Sink state %d %d", state
, u
->active_mask
);
436 if (state
== PA_SINK_RUNNING
) {
437 /* restart timer when both sink and source are active */
439 if (u
->active_mask
== 3 && u
->adjust_time
)
440 pa_core_rttime_restart(u
->core
, u
->time_event
, pa_rtclock_now() + u
->adjust_time
);
442 pa_atomic_store(&u
->request_resync
, 1);
443 pa_sink_input_cork(u
->sink_input
, FALSE
);
444 } else if (state
== PA_SINK_SUSPENDED
) {
445 u
->active_mask
&= ~2;
446 pa_sink_input_cork(u
->sink_input
, TRUE
);
451 /* Called from I/O thread context */
452 static void source_update_requested_latency_cb(pa_source
*s
) {
455 pa_source_assert_ref(s
);
456 pa_assert_se(u
= s
->userdata
);
458 if (!PA_SOURCE_IS_LINKED(u
->source
->thread_info
.state
) ||
459 !PA_SOURCE_OUTPUT_IS_LINKED(u
->source_output
->thread_info
.state
))
462 pa_log_debug("Source update requested latency");
464 /* Just hand this one over to the master source */
465 pa_source_output_set_requested_latency_within_thread(
467 pa_source_get_requested_latency_within_thread(s
));
470 /* Called from I/O thread context */
471 static void sink_update_requested_latency_cb(pa_sink
*s
) {
474 pa_sink_assert_ref(s
);
475 pa_assert_se(u
= s
->userdata
);
477 if (!PA_SINK_IS_LINKED(u
->sink
->thread_info
.state
) ||
478 !PA_SINK_INPUT_IS_LINKED(u
->sink_input
->thread_info
.state
))
481 pa_log_debug("Sink update requested latency");
483 /* Just hand this one over to the master sink */
484 pa_sink_input_set_requested_latency_within_thread(
486 pa_sink_get_requested_latency_within_thread(s
));
489 /* Called from I/O thread context */
490 static void sink_request_rewind_cb(pa_sink
*s
) {
493 pa_sink_assert_ref(s
);
494 pa_assert_se(u
= s
->userdata
);
496 if (!PA_SINK_IS_LINKED(u
->sink
->thread_info
.state
) ||
497 !PA_SINK_INPUT_IS_LINKED(u
->sink_input
->thread_info
.state
))
500 pa_log_debug("Sink request rewind %lld", (long long) s
->thread_info
.rewind_nbytes
);
502 /* Just hand this one over to the master sink */
503 pa_sink_input_request_rewind(u
->sink_input
,
504 s
->thread_info
.rewind_nbytes
, TRUE
, FALSE
, FALSE
);
507 /* Called from main context */
508 static void source_set_volume_cb(pa_source
*s
) {
511 pa_source_assert_ref(s
);
512 pa_assert_se(u
= s
->userdata
);
514 if (!PA_SOURCE_IS_LINKED(pa_source_get_state(s
)) ||
515 !PA_SOURCE_OUTPUT_IS_LINKED(pa_source_output_get_state(u
->source_output
)))
518 pa_source_output_set_volume(u
->source_output
, &s
->real_volume
, s
->save_volume
, TRUE
);
521 /* Called from main context */
522 static void sink_set_volume_cb(pa_sink
*s
) {
525 pa_sink_assert_ref(s
);
526 pa_assert_se(u
= s
->userdata
);
528 if (!PA_SINK_IS_LINKED(pa_sink_get_state(s
)) ||
529 !PA_SINK_INPUT_IS_LINKED(pa_sink_input_get_state(u
->sink_input
)))
532 pa_sink_input_set_volume(u
->sink_input
, &s
->real_volume
, s
->save_volume
, TRUE
);
535 static void source_get_volume_cb(pa_source
*s
) {
539 pa_source_assert_ref(s
);
540 pa_assert_se(u
= s
->userdata
);
542 if (!PA_SOURCE_IS_LINKED(pa_source_get_state(s
)) ||
543 !PA_SOURCE_OUTPUT_IS_LINKED(pa_source_output_get_state(u
->source_output
)))
546 pa_source_output_get_volume(u
->source_output
, &v
, TRUE
);
548 if (pa_cvolume_equal(&s
->real_volume
, &v
))
553 pa_source_set_soft_volume(s
, NULL
);
556 /* Called from main context */
557 static void source_set_mute_cb(pa_source
*s
) {
560 pa_source_assert_ref(s
);
561 pa_assert_se(u
= s
->userdata
);
563 if (!PA_SOURCE_IS_LINKED(pa_source_get_state(s
)) ||
564 !PA_SOURCE_OUTPUT_IS_LINKED(pa_source_output_get_state(u
->source_output
)))
567 pa_source_output_set_mute(u
->source_output
, s
->muted
, s
->save_muted
);
570 /* Called from main context */
571 static void sink_set_mute_cb(pa_sink
*s
) {
574 pa_sink_assert_ref(s
);
575 pa_assert_se(u
= s
->userdata
);
577 if (!PA_SINK_IS_LINKED(pa_sink_get_state(s
)) ||
578 !PA_SINK_INPUT_IS_LINKED(pa_sink_input_get_state(u
->sink_input
)))
581 pa_sink_input_set_mute(u
->sink_input
, s
->muted
, s
->save_muted
);
584 /* Called from main context */
585 static void source_get_mute_cb(pa_source
*s
) {
588 pa_source_assert_ref(s
);
589 pa_assert_se(u
= s
->userdata
);
591 if (!PA_SOURCE_IS_LINKED(pa_source_get_state(s
)) ||
592 !PA_SOURCE_OUTPUT_IS_LINKED(pa_source_output_get_state(u
->source_output
)))
595 pa_source_output_get_mute(u
->source_output
);
598 /* must be called from the input thread context */
599 static void apply_diff_time(struct userdata
*u
, int64_t diff_time
) {
603 diff
= pa_usec_to_bytes(-diff_time
, &u
->source_output
->sample_spec
);
606 /* add some extra safety samples to compensate for jitter in the
608 diff
+= 10 * pa_frame_size (&u
->source_output
->sample_spec
);
610 pa_log("Playback after capture (%lld), drop sink %lld", (long long) diff_time
, (long long) diff
);
615 } else if (diff_time
> 0) {
616 diff
= pa_usec_to_bytes(diff_time
, &u
->source_output
->sample_spec
);
619 pa_log("playback too far ahead (%lld), drop source %lld", (long long) diff_time
, (long long) diff
);
621 u
->source_skip
= diff
;
627 /* must be called from the input thread */
628 static void do_resync(struct userdata
*u
) {
630 struct snapshot latency_snapshot
;
632 pa_log("Doing resync");
634 /* update our snapshot */
635 source_output_snapshot_within_thread(u
, &latency_snapshot
);
636 pa_asyncmsgq_send(u
->sink_input
->sink
->asyncmsgq
, PA_MSGOBJECT(u
->sink_input
), SINK_INPUT_MESSAGE_LATENCY_SNAPSHOT
, &latency_snapshot
, 0, NULL
);
638 /* calculate drift between capture and playback */
639 diff_time
= calc_diff(u
, &latency_snapshot
);
641 /* and adjust for the drift */
642 apply_diff_time(u
, diff_time
);
645 /* Called from input thread context */
646 static void source_output_push_cb(pa_source_output
*o
, const pa_memchunk
*chunk
) {
650 pa_source_output_assert_ref(o
);
651 pa_source_output_assert_io_context(o
);
652 pa_assert_se(u
= o
->userdata
);
654 if (!PA_SOURCE_OUTPUT_IS_LINKED(pa_source_output_get_state(u
->source_output
))) {
655 pa_log("push when no link?");
659 /* handle queued messages, do any message sending of our own */
660 while (pa_asyncmsgq_process_one(u
->asyncmsgq
) > 0)
663 if (pa_atomic_cmpxchg (&u
->request_resync
, 1, 0)) {
667 pa_memblockq_push_align(u
->source_memblockq
, chunk
);
669 rlen
= pa_memblockq_get_length(u
->source_memblockq
);
670 plen
= pa_memblockq_get_length(u
->sink_memblockq
);
672 while (rlen
>= u
->blocksize
) {
673 pa_memchunk rchunk
, pchunk
;
675 /* take fixed block from recorded samples */
676 pa_memblockq_peek_fixed_size(u
->source_memblockq
, u
->blocksize
, &rchunk
);
678 if (plen
> u
->blocksize
&& u
->source_skip
== 0) {
679 uint8_t *rdata
, *pdata
, *cdata
;
686 if (u
->sink_skip
> plen
)
689 to_skip
= u
->sink_skip
;
691 pa_memblockq_drop(u
->sink_memblockq
, to_skip
);
694 u
->sink_skip
-= to_skip
;
697 if (plen
> u
->blocksize
&& u
->sink_skip
== 0) {
698 /* take fixed block from played samples */
699 pa_memblockq_peek_fixed_size(u
->sink_memblockq
, u
->blocksize
, &pchunk
);
701 rdata
= pa_memblock_acquire(rchunk
.memblock
);
702 rdata
+= rchunk
.index
;
703 pdata
= pa_memblock_acquire(pchunk
.memblock
);
704 pdata
+= pchunk
.index
;
707 cchunk
.length
= u
->blocksize
;
708 cchunk
.memblock
= pa_memblock_new(u
->source
->core
->mempool
, cchunk
.length
);
709 cdata
= pa_memblock_acquire(cchunk
.memblock
);
712 if (u
->captured_file
)
713 unused
= fwrite(rdata
, 1, u
->blocksize
, u
->captured_file
);
715 unused
= fwrite(pdata
, 1, u
->blocksize
, u
->played_file
);
718 /* perform echo cancellation */
719 u
->ec
->run(u
->ec
, rdata
, pdata
, cdata
);
722 if (u
->canceled_file
)
723 unused
= fwrite(cdata
, 1, u
->blocksize
, u
->canceled_file
);
726 pa_memblock_release(cchunk
.memblock
);
727 pa_memblock_release(pchunk
.memblock
);
728 pa_memblock_release(rchunk
.memblock
);
730 /* drop consumed sink samples */
731 pa_memblockq_drop(u
->sink_memblockq
, u
->blocksize
);
732 pa_memblock_unref(pchunk
.memblock
);
734 pa_memblock_unref(rchunk
.memblock
);
735 /* the filtered samples now become the samples from our
739 plen
-= u
->blocksize
;
743 /* forward the (echo-canceled) data to the virtual source */
744 pa_source_post(u
->source
, &rchunk
);
745 pa_memblock_unref(rchunk
.memblock
);
747 pa_memblockq_drop(u
->source_memblockq
, u
->blocksize
);
748 rlen
-= u
->blocksize
;
750 if (u
->source_skip
) {
751 if (u
->source_skip
> u
->blocksize
) {
752 u
->source_skip
-= u
->blocksize
;
755 u
->sink_skip
+= (u
->blocksize
- u
->source_skip
);
762 /* Called from I/O thread context */
763 static int sink_input_pop_cb(pa_sink_input
*i
, size_t nbytes
, pa_memchunk
*chunk
) {
766 pa_sink_input_assert_ref(i
);
768 pa_assert_se(u
= i
->userdata
);
770 if (u
->sink
->thread_info
.rewind_requested
)
771 pa_sink_process_rewind(u
->sink
, 0);
773 pa_sink_render_full(u
->sink
, nbytes
, chunk
);
775 if (i
->thread_info
.underrun_for
> 0) {
776 pa_log_debug("Handling end of underrun.");
777 pa_atomic_store(&u
->request_resync
, 1);
780 /* let source thread handle the chunk. pass the sample count as well so that
781 * the source IO thread can update the right variables. */
782 pa_asyncmsgq_post(u
->asyncmsgq
, PA_MSGOBJECT(u
->source_output
), SOURCE_OUTPUT_MESSAGE_POST
,
783 NULL
, 0, chunk
, NULL
);
784 u
->send_counter
+= chunk
->length
;
789 /* Called from input thread context */
790 static void source_output_process_rewind_cb(pa_source_output
*o
, size_t nbytes
) {
793 pa_source_output_assert_ref(o
);
794 pa_source_output_assert_io_context(o
);
795 pa_assert_se(u
= o
->userdata
);
797 pa_source_process_rewind(u
->source
, nbytes
);
799 /* go back on read side, we need to use older sink data for this */
800 pa_memblockq_rewind(u
->sink_memblockq
, nbytes
);
802 /* manipulate write index */
803 pa_memblockq_seek(u
->source_memblockq
, -nbytes
, PA_SEEK_RELATIVE
, TRUE
);
805 pa_log_debug("Source rewind (%lld) %lld", (long long) nbytes
,
806 (long long) pa_memblockq_get_length (u
->source_memblockq
));
809 /* Called from I/O thread context */
810 static void sink_input_process_rewind_cb(pa_sink_input
*i
, size_t nbytes
) {
813 pa_sink_input_assert_ref(i
);
814 pa_assert_se(u
= i
->userdata
);
816 pa_log_debug("Sink process rewind %lld", (long long) nbytes
);
818 pa_sink_process_rewind(u
->sink
, nbytes
);
820 pa_asyncmsgq_post(u
->asyncmsgq
, PA_MSGOBJECT(u
->source_output
), SOURCE_OUTPUT_MESSAGE_REWIND
, NULL
, (int64_t) nbytes
, NULL
, NULL
);
821 u
->send_counter
-= nbytes
;
824 static void source_output_snapshot_within_thread(struct userdata
*u
, struct snapshot
*snapshot
) {
825 size_t delay
, rlen
, plen
;
826 pa_usec_t now
, latency
;
828 now
= pa_rtclock_now();
829 latency
= pa_source_get_latency_within_thread(u
->source_output
->source
);
830 delay
= pa_memblockq_get_length(u
->source_output
->thread_info
.delay_memblockq
);
832 delay
= (u
->source_output
->thread_info
.resampler
? pa_resampler_request(u
->source_output
->thread_info
.resampler
, delay
) : delay
);
833 rlen
= pa_memblockq_get_length(u
->source_memblockq
);
834 plen
= pa_memblockq_get_length(u
->sink_memblockq
);
836 snapshot
->source_now
= now
;
837 snapshot
->source_latency
= latency
;
838 snapshot
->source_delay
= delay
;
839 snapshot
->recv_counter
= u
->recv_counter
;
840 snapshot
->rlen
= rlen
+ u
->sink_skip
;
841 snapshot
->plen
= plen
+ u
->source_skip
;
845 /* Called from output thread context */
846 static int source_output_process_msg_cb(pa_msgobject
*obj
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
847 struct userdata
*u
= PA_SOURCE_OUTPUT(obj
)->userdata
;
851 case SOURCE_OUTPUT_MESSAGE_POST
:
853 pa_source_output_assert_io_context(u
->source_output
);
855 if (PA_SOURCE_IS_OPENED(u
->source_output
->source
->thread_info
.state
))
856 pa_memblockq_push_align(u
->sink_memblockq
, chunk
);
858 pa_memblockq_flush_write(u
->sink_memblockq
, TRUE
);
860 u
->recv_counter
+= (int64_t) chunk
->length
;
864 case SOURCE_OUTPUT_MESSAGE_REWIND
:
865 pa_source_output_assert_io_context(u
->source_output
);
867 /* manipulate write index, never go past what we have */
868 if (PA_SOURCE_IS_OPENED(u
->source_output
->source
->thread_info
.state
))
869 pa_memblockq_seek(u
->sink_memblockq
, -offset
, PA_SEEK_RELATIVE
, TRUE
);
871 pa_memblockq_flush_write(u
->sink_memblockq
, TRUE
);
873 pa_log_debug("Sink rewind (%lld)", (long long) offset
);
875 u
->recv_counter
-= offset
;
879 case SOURCE_OUTPUT_MESSAGE_LATENCY_SNAPSHOT
: {
880 struct snapshot
*snapshot
= (struct snapshot
*) data
;
882 source_output_snapshot_within_thread(u
, snapshot
);
886 case SOURCE_OUTPUT_MESSAGE_APPLY_DIFF_TIME
:
887 apply_diff_time(u
, offset
);
892 return pa_source_output_process_msg(obj
, code
, data
, offset
, chunk
);
895 static int sink_input_process_msg_cb(pa_msgobject
*obj
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
896 struct userdata
*u
= PA_SINK_INPUT(obj
)->userdata
;
900 case SINK_INPUT_MESSAGE_LATENCY_SNAPSHOT
: {
902 pa_usec_t now
, latency
;
903 struct snapshot
*snapshot
= (struct snapshot
*) data
;
905 pa_sink_input_assert_io_context(u
->sink_input
);
907 now
= pa_rtclock_now();
908 latency
= pa_sink_get_latency_within_thread(u
->sink_input
->sink
);
909 delay
= pa_memblockq_get_length(u
->sink_input
->thread_info
.render_memblockq
);
911 delay
= (u
->sink_input
->thread_info
.resampler
? pa_resampler_request(u
->sink_input
->thread_info
.resampler
, delay
) : delay
);
913 snapshot
->sink_now
= now
;
914 snapshot
->sink_latency
= latency
;
915 snapshot
->sink_delay
= delay
;
916 snapshot
->send_counter
= u
->send_counter
;
921 return pa_sink_input_process_msg(obj
, code
, data
, offset
, chunk
);
924 /* Called from I/O thread context */
925 static void sink_input_update_max_rewind_cb(pa_sink_input
*i
, size_t nbytes
) {
928 pa_sink_input_assert_ref(i
);
929 pa_assert_se(u
= i
->userdata
);
931 pa_log_debug("Sink input update max rewind %lld", (long long) nbytes
);
933 pa_memblockq_set_maxrewind(u
->sink_memblockq
, nbytes
);
934 pa_sink_set_max_rewind_within_thread(u
->sink
, nbytes
);
937 /* Called from I/O thread context */
938 static void source_output_update_max_rewind_cb(pa_source_output
*o
, size_t nbytes
) {
941 pa_source_output_assert_ref(o
);
942 pa_assert_se(u
= o
->userdata
);
944 pa_log_debug("Source output update max rewind %lld", (long long) nbytes
);
946 pa_source_set_max_rewind_within_thread(u
->source
, nbytes
);
949 /* Called from I/O thread context */
950 static void sink_input_update_max_request_cb(pa_sink_input
*i
, size_t nbytes
) {
953 pa_sink_input_assert_ref(i
);
954 pa_assert_se(u
= i
->userdata
);
956 pa_log_debug("Sink input update max request %lld", (long long) nbytes
);
958 pa_sink_set_max_request_within_thread(u
->sink
, nbytes
);
961 /* Called from I/O thread context */
962 static void sink_input_update_sink_requested_latency_cb(pa_sink_input
*i
) {
966 pa_sink_input_assert_ref(i
);
967 pa_assert_se(u
= i
->userdata
);
969 latency
= pa_sink_get_requested_latency_within_thread(i
->sink
);
971 pa_log_debug("Sink input update requested latency %lld", (long long) latency
);
974 /* Called from I/O thread context */
975 static void source_output_update_source_requested_latency_cb(pa_source_output
*o
) {
979 pa_source_output_assert_ref(o
);
980 pa_assert_se(u
= o
->userdata
);
982 latency
= pa_source_get_requested_latency_within_thread(o
->source
);
984 pa_log_debug("source output update requested latency %lld", (long long) latency
);
987 /* Called from I/O thread context */
988 static void sink_input_update_sink_latency_range_cb(pa_sink_input
*i
) {
991 pa_sink_input_assert_ref(i
);
992 pa_assert_se(u
= i
->userdata
);
994 pa_log_debug("Sink input update latency range %lld %lld",
995 (long long) i
->sink
->thread_info
.min_latency
,
996 (long long) i
->sink
->thread_info
.max_latency
);
998 pa_sink_set_latency_range_within_thread(u
->sink
, i
->sink
->thread_info
.min_latency
, i
->sink
->thread_info
.max_latency
);
1001 /* Called from I/O thread context */
1002 static void source_output_update_source_latency_range_cb(pa_source_output
*o
) {
1005 pa_source_output_assert_ref(o
);
1006 pa_assert_se(u
= o
->userdata
);
1008 pa_log_debug("Source output update latency range %lld %lld",
1009 (long long) o
->source
->thread_info
.min_latency
,
1010 (long long) o
->source
->thread_info
.max_latency
);
1012 pa_source_set_latency_range_within_thread(u
->source
, o
->source
->thread_info
.min_latency
, o
->source
->thread_info
.max_latency
);
1015 /* Called from I/O thread context */
1016 static void sink_input_update_sink_fixed_latency_cb(pa_sink_input
*i
) {
1019 pa_sink_input_assert_ref(i
);
1020 pa_assert_se(u
= i
->userdata
);
1022 pa_log_debug("Sink input update fixed latency %lld",
1023 (long long) i
->sink
->thread_info
.fixed_latency
);
1025 pa_sink_set_fixed_latency_within_thread(u
->sink
, i
->sink
->thread_info
.fixed_latency
);
1028 /* Called from I/O thread context */
1029 static void source_output_update_source_fixed_latency_cb(pa_source_output
*o
) {
1032 pa_source_output_assert_ref(o
);
1033 pa_assert_se(u
= o
->userdata
);
1035 pa_log_debug("Source output update fixed latency %lld",
1036 (long long) o
->source
->thread_info
.fixed_latency
);
1038 pa_source_set_fixed_latency_within_thread(u
->source
, o
->source
->thread_info
.fixed_latency
);
1041 /* Called from output thread context */
1042 static void source_output_attach_cb(pa_source_output
*o
) {
1045 pa_source_output_assert_ref(o
);
1046 pa_source_output_assert_io_context(o
);
1047 pa_assert_se(u
= o
->userdata
);
1049 pa_source_set_rtpoll(u
->source
, o
->source
->thread_info
.rtpoll
);
1050 pa_source_set_latency_range_within_thread(u
->source
, o
->source
->thread_info
.min_latency
, o
->source
->thread_info
.max_latency
);
1051 pa_source_set_fixed_latency_within_thread(u
->source
, o
->source
->thread_info
.fixed_latency
);
1052 pa_source_set_max_rewind_within_thread(u
->source
, pa_source_output_get_max_rewind(o
));
1054 pa_log_debug("Source output %d attach", o
->index
);
1056 pa_source_attach_within_thread(u
->source
);
1058 u
->rtpoll_item_read
= pa_rtpoll_item_new_asyncmsgq_read(
1059 o
->source
->thread_info
.rtpoll
,
1064 /* Called from I/O thread context */
1065 static void sink_input_attach_cb(pa_sink_input
*i
) {
1068 pa_sink_input_assert_ref(i
);
1069 pa_assert_se(u
= i
->userdata
);
1071 pa_sink_set_rtpoll(u
->sink
, i
->sink
->thread_info
.rtpoll
);
1072 pa_sink_set_latency_range_within_thread(u
->sink
, i
->sink
->thread_info
.min_latency
, i
->sink
->thread_info
.max_latency
);
1074 /* (8.1) IF YOU NEED A FIXED BLOCK SIZE ADD THE LATENCY FOR ONE
1075 * BLOCK MINUS ONE SAMPLE HERE. SEE (7) */
1076 pa_sink_set_fixed_latency_within_thread(u
->sink
, i
->sink
->thread_info
.fixed_latency
);
1078 /* (8.2) IF YOU NEED A FIXED BLOCK SIZE ROUND
1079 * pa_sink_input_get_max_request(i) UP TO MULTIPLES OF IT
1081 pa_sink_set_max_request_within_thread(u
->sink
, pa_sink_input_get_max_request(i
));
1082 pa_sink_set_max_rewind_within_thread(u
->sink
, pa_sink_input_get_max_rewind(i
));
1084 pa_log_debug("Sink input %d attach", i
->index
);
1086 u
->rtpoll_item_write
= pa_rtpoll_item_new_asyncmsgq_write(
1087 i
->sink
->thread_info
.rtpoll
,
1091 pa_sink_attach_within_thread(u
->sink
);
1095 /* Called from output thread context */
1096 static void source_output_detach_cb(pa_source_output
*o
) {
1099 pa_source_output_assert_ref(o
);
1100 pa_source_output_assert_io_context(o
);
1101 pa_assert_se(u
= o
->userdata
);
1103 pa_source_detach_within_thread(u
->source
);
1104 pa_source_set_rtpoll(u
->source
, NULL
);
1106 pa_log_debug("Source output %d detach", o
->index
);
1108 if (u
->rtpoll_item_read
) {
1109 pa_rtpoll_item_free(u
->rtpoll_item_read
);
1110 u
->rtpoll_item_read
= NULL
;
1114 /* Called from I/O thread context */
1115 static void sink_input_detach_cb(pa_sink_input
*i
) {
1118 pa_sink_input_assert_ref(i
);
1119 pa_assert_se(u
= i
->userdata
);
1121 pa_sink_detach_within_thread(u
->sink
);
1123 pa_sink_set_rtpoll(u
->sink
, NULL
);
1125 pa_log_debug("Sink input %d detach", i
->index
);
1127 if (u
->rtpoll_item_write
) {
1128 pa_rtpoll_item_free(u
->rtpoll_item_write
);
1129 u
->rtpoll_item_write
= NULL
;
1133 /* Called from output thread context */
1134 static void source_output_state_change_cb(pa_source_output
*o
, pa_source_output_state_t state
) {
1137 pa_source_output_assert_ref(o
);
1138 pa_source_output_assert_io_context(o
);
1139 pa_assert_se(u
= o
->userdata
);
1141 pa_log_debug("Source output %d state %d", o
->index
, state
);
1144 /* Called from IO thread context */
1145 static void sink_input_state_change_cb(pa_sink_input
*i
, pa_sink_input_state_t state
) {
1148 pa_sink_input_assert_ref(i
);
1149 pa_assert_se(u
= i
->userdata
);
1151 pa_log_debug("Sink input %d state %d", i
->index
, state
);
1153 /* If we are added for the first time, ask for a rewinding so that
1154 * we are heard right-away. */
1155 if (PA_SINK_INPUT_IS_LINKED(state
) &&
1156 i
->thread_info
.state
== PA_SINK_INPUT_INIT
) {
1157 pa_log_debug("Requesting rewind due to state change.");
1158 pa_sink_input_request_rewind(i
, 0, FALSE
, TRUE
, TRUE
);
1162 /* Called from main thread */
1163 static void source_output_kill_cb(pa_source_output
*o
) {
1166 pa_source_output_assert_ref(o
);
1167 pa_assert_ctl_context();
1168 pa_assert_se(u
= o
->userdata
);
1172 /* The order here matters! We first kill the source output, followed
1173 * by the source. That means the source callbacks must be protected
1174 * against an unconnected source output! */
1175 pa_source_output_unlink(u
->source_output
);
1176 pa_source_unlink(u
->source
);
1178 pa_source_output_unref(u
->source_output
);
1179 u
->source_output
= NULL
;
1181 pa_source_unref(u
->source
);
1184 pa_log_debug("Source output kill %d", o
->index
);
1186 pa_module_unload_request(u
->module
, TRUE
);
1189 /* Called from main context */
1190 static void sink_input_kill_cb(pa_sink_input
*i
) {
1193 pa_sink_input_assert_ref(i
);
1194 pa_assert_se(u
= i
->userdata
);
1198 /* The order here matters! We first kill the sink input, followed
1199 * by the sink. That means the sink callbacks must be protected
1200 * against an unconnected sink input! */
1201 pa_sink_input_unlink(u
->sink_input
);
1202 pa_sink_unlink(u
->sink
);
1204 pa_sink_input_unref(u
->sink_input
);
1205 u
->sink_input
= NULL
;
1207 pa_sink_unref(u
->sink
);
1210 pa_log_debug("Sink input kill %d", i
->index
);
1212 pa_module_unload_request(u
->module
, TRUE
);
1215 /* Called from main thread */
1216 static pa_bool_t
source_output_may_move_to_cb(pa_source_output
*o
, pa_source
*dest
) {
1219 pa_source_output_assert_ref(o
);
1220 pa_assert_ctl_context();
1221 pa_assert_se(u
= o
->userdata
);
1226 return (u
->source
!= dest
) && (u
->sink
!= dest
->monitor_of
);
1229 /* Called from main context */
1230 static pa_bool_t
sink_input_may_move_to_cb(pa_sink_input
*i
, pa_sink
*dest
) {
1233 pa_sink_input_assert_ref(i
);
1234 pa_assert_se(u
= i
->userdata
);
1239 return u
->sink
!= dest
;
1242 /* Called from main thread */
1243 static void source_output_moving_cb(pa_source_output
*o
, pa_source
*dest
) {
1246 pa_source_output_assert_ref(o
);
1247 pa_assert_ctl_context();
1248 pa_assert_se(u
= o
->userdata
);
1251 pa_source_set_asyncmsgq(u
->source
, dest
->asyncmsgq
);
1252 pa_source_update_flags(u
->source
, PA_SOURCE_LATENCY
|PA_SOURCE_DYNAMIC_LATENCY
, dest
->flags
);
1254 pa_source_set_asyncmsgq(u
->source
, NULL
);
1256 if (u
->source_auto_desc
&& dest
) {
1260 pl
= pa_proplist_new();
1261 z
= pa_proplist_gets(dest
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
1262 pa_proplist_setf(pl
, PA_PROP_DEVICE_DESCRIPTION
, "Echo-Cancel Source %s on %s",
1263 pa_proplist_gets(u
->source
->proplist
, "device.echo-cancel.name"), z
? z
: dest
->name
);
1265 pa_source_update_proplist(u
->source
, PA_UPDATE_REPLACE
, pl
);
1266 pa_proplist_free(pl
);
1270 /* Called from main context */
1271 static void sink_input_moving_cb(pa_sink_input
*i
, pa_sink
*dest
) {
1274 pa_sink_input_assert_ref(i
);
1275 pa_assert_se(u
= i
->userdata
);
1278 pa_sink_set_asyncmsgq(u
->sink
, dest
->asyncmsgq
);
1279 pa_sink_update_flags(u
->sink
, PA_SINK_LATENCY
|PA_SINK_DYNAMIC_LATENCY
, dest
->flags
);
1281 pa_sink_set_asyncmsgq(u
->sink
, NULL
);
1283 if (u
->sink_auto_desc
&& dest
) {
1287 pl
= pa_proplist_new();
1288 z
= pa_proplist_gets(dest
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
1289 pa_proplist_setf(pl
, PA_PROP_DEVICE_DESCRIPTION
, "Echo-Cancel Sink %s on %s",
1290 pa_proplist_gets(u
->sink
->proplist
, "device.echo-cancel.name"), z
? z
: dest
->name
);
1292 pa_sink_update_proplist(u
->sink
, PA_UPDATE_REPLACE
, pl
);
1293 pa_proplist_free(pl
);
1297 /* Called from main context */
1298 static void sink_input_volume_changed_cb(pa_sink_input
*i
) {
1301 pa_sink_input_assert_ref(i
);
1302 pa_assert_se(u
= i
->userdata
);
1304 pa_sink_volume_changed(u
->sink
, &i
->volume
);
1307 /* Called from main context */
1308 static void sink_input_mute_changed_cb(pa_sink_input
*i
) {
1311 pa_sink_input_assert_ref(i
);
1312 pa_assert_se(u
= i
->userdata
);
1314 pa_sink_mute_changed(u
->sink
, i
->muted
);
1317 static pa_echo_canceller_method_t
get_ec_method_from_string(const char *method
) {
1318 if (pa_streq(method
, "speex"))
1319 return PA_ECHO_CANCELLER_SPEEX
;
1320 else if (pa_streq(method
, "adrian"))
1321 return PA_ECHO_CANCELLER_ADRIAN
;
1323 return PA_ECHO_CANCELLER_INVALID
;
1326 /* Common initialisation bits between module-echo-cancel and the standalone test program */
1327 static int init_common(pa_modargs
*ma
, struct userdata
*u
, pa_sample_spec
*source_ss
, pa_channel_map
*source_map
) {
1328 pa_echo_canceller_method_t ec_method
;
1330 if (pa_modargs_get_sample_spec_and_channel_map(ma
, source_ss
, source_map
, PA_CHANNEL_MAP_DEFAULT
) < 0) {
1331 pa_log("Invalid sample format specification or channel map");
1335 u
->ec
= pa_xnew0(pa_echo_canceller
, 1);
1337 pa_log("Failed to alloc echo canceller");
1341 if ((ec_method
= get_ec_method_from_string(pa_modargs_get_value(ma
, "aec_method", DEFAULT_ECHO_CANCELLER
))) < 0) {
1342 pa_log("Invalid echo canceller implementation");
1346 u
->ec
->init
= ec_table
[ec_method
].init
;
1347 u
->ec
->run
= ec_table
[ec_method
].run
;
1348 u
->ec
->done
= ec_table
[ec_method
].done
;
1357 int pa__init(pa_module
*m
) {
1359 pa_sample_spec source_ss
, sink_ss
;
1360 pa_channel_map source_map
, sink_map
;
1362 pa_source
*source_master
=NULL
;
1363 pa_sink
*sink_master
=NULL
;
1364 pa_source_output_new_data source_output_data
;
1365 pa_sink_input_new_data sink_input_data
;
1366 pa_source_new_data source_data
;
1367 pa_sink_new_data sink_data
;
1368 pa_memchunk silence
;
1370 pa_bool_t use_volume_sharing
= TRUE
;
1374 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
1375 pa_log("Failed to parse module arguments.");
1379 if (!(source_master
= pa_namereg_get(m
->core
, pa_modargs_get_value(ma
, "source_master", NULL
), PA_NAMEREG_SOURCE
))) {
1380 pa_log("Master source not found");
1383 pa_assert(source_master
);
1385 if (!(sink_master
= pa_namereg_get(m
->core
, pa_modargs_get_value(ma
, "sink_master", NULL
), PA_NAMEREG_SINK
))) {
1386 pa_log("Master sink not found");
1389 pa_assert(sink_master
);
1391 if (source_master
->monitor_of
== sink_master
) {
1392 pa_log("Can't cancel echo between a sink and its monitor");
1396 source_ss
= source_master
->sample_spec
;
1397 source_ss
.rate
= DEFAULT_RATE
;
1398 source_ss
.channels
= DEFAULT_CHANNELS
;
1399 pa_channel_map_init_auto(&source_map
, source_ss
.channels
, PA_CHANNEL_MAP_DEFAULT
);
1401 sink_ss
= sink_master
->sample_spec
;
1402 sink_map
= sink_master
->channel_map
;
1404 if (pa_modargs_get_value_boolean(ma
, "use_volume_sharing", &use_volume_sharing
) < 0) {
1405 pa_log("use_volume_sharing= expects a boolean argument");
1409 u
= pa_xnew0(struct userdata
, 1);
1411 pa_log("Failed to alloc userdata");
1419 temp
= DEFAULT_ADJUST_TIME_USEC
/ PA_USEC_PER_SEC
;
1420 if (pa_modargs_get_value_u32(ma
, "adjust_time", &temp
) < 0) {
1421 pa_log("Failed to parse adjust_time value");
1425 if (temp
!= DEFAULT_ADJUST_TIME_USEC
/ PA_USEC_PER_SEC
)
1426 u
->adjust_time
= temp
* PA_USEC_PER_SEC
;
1428 u
->adjust_time
= DEFAULT_ADJUST_TIME_USEC
;
1430 temp
= DEFAULT_ADJUST_TOLERANCE
/ PA_USEC_PER_MSEC
;
1431 if (pa_modargs_get_value_u32(ma
, "adjust_threshold", &temp
) < 0) {
1432 pa_log("Failed to parse adjust_threshold value");
1436 if (temp
!= DEFAULT_ADJUST_TOLERANCE
/ PA_USEC_PER_MSEC
)
1437 u
->adjust_threshold
= temp
* PA_USEC_PER_MSEC
;
1439 u
->adjust_threshold
= DEFAULT_ADJUST_TOLERANCE
;
1441 u
->save_aec
= DEFAULT_SAVE_AEC
;
1442 if (pa_modargs_get_value_boolean(ma
, "save_aec", &u
->save_aec
) < 0) {
1443 pa_log("Failed to parse save_aec value");
1447 u
->autoloaded
= DEFAULT_AUTOLOADED
;
1448 if (pa_modargs_get_value_boolean(ma
, "autoloaded", &u
->autoloaded
) < 0) {
1449 pa_log("Failed to parse autoloaded value");
1453 if (init_common(ma
, u
, &source_ss
, &source_map
))
1456 u
->asyncmsgq
= pa_asyncmsgq_new(0);
1457 u
->need_realign
= TRUE
;
1460 if (!u
->ec
->init(u
->core
, u
->ec
, &source_ss
, &source_map
, &sink_ss
, &sink_map
, &u
->blocksize
, pa_modargs_get_value(ma
, "aec_args", NULL
))) {
1461 pa_log("Failed to init AEC engine");
1467 pa_source_new_data_init(&source_data
);
1468 source_data
.driver
= __FILE__
;
1469 source_data
.module
= m
;
1470 if (!(source_data
.name
= pa_xstrdup(pa_modargs_get_value(ma
, "source_name", NULL
))))
1471 source_data
.name
= pa_sprintf_malloc("%s.echo-cancel", source_master
->name
);
1472 pa_source_new_data_set_sample_spec(&source_data
, &source_ss
);
1473 pa_source_new_data_set_channel_map(&source_data
, &source_map
);
1474 pa_proplist_sets(source_data
.proplist
, PA_PROP_DEVICE_MASTER_DEVICE
, source_master
->name
);
1475 pa_proplist_sets(source_data
.proplist
, PA_PROP_DEVICE_CLASS
, "filter");
1477 pa_proplist_sets(source_data
.proplist
, PA_PROP_DEVICE_INTENDED_ROLES
, "phone");
1478 pa_proplist_sets(source_data
.proplist
, "device.echo-cancel.name", source_data
.name
);
1480 if (pa_modargs_get_proplist(ma
, "source_properties", source_data
.proplist
, PA_UPDATE_REPLACE
) < 0) {
1481 pa_log("Invalid properties");
1482 pa_source_new_data_done(&source_data
);
1486 if ((u
->source_auto_desc
= !pa_proplist_contains(source_data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
))) {
1489 z
= pa_proplist_gets(source_master
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
1490 pa_proplist_setf(source_data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
, "Echo-Cancel Source %s on %s", source_data
.name
, z
? z
: source_master
->name
);
1493 u
->source
= pa_source_new(m
->core
, &source_data
, (source_master
->flags
& (PA_SOURCE_LATENCY
| PA_SOURCE_DYNAMIC_LATENCY
))
1494 | (use_volume_sharing
? PA_SOURCE_SHARE_VOLUME_WITH_MASTER
: 0));
1495 pa_source_new_data_done(&source_data
);
1498 pa_log("Failed to create source.");
1502 u
->source
->parent
.process_msg
= source_process_msg_cb
;
1503 u
->source
->set_state
= source_set_state_cb
;
1504 u
->source
->update_requested_latency
= source_update_requested_latency_cb
;
1505 pa_source_set_get_mute_callback(u
->source
, source_get_mute_cb
);
1506 pa_source_set_set_mute_callback(u
->source
, source_set_mute_cb
);
1507 if (!use_volume_sharing
) {
1508 pa_source_set_get_volume_callback(u
->source
, source_get_volume_cb
);
1509 pa_source_set_set_volume_callback(u
->source
, source_set_volume_cb
);
1510 pa_source_enable_decibel_volume(u
->source
, TRUE
);
1512 u
->source
->userdata
= u
;
1514 pa_source_set_asyncmsgq(u
->source
, source_master
->asyncmsgq
);
1517 pa_sink_new_data_init(&sink_data
);
1518 sink_data
.driver
= __FILE__
;
1519 sink_data
.module
= m
;
1520 if (!(sink_data
.name
= pa_xstrdup(pa_modargs_get_value(ma
, "sink_name", NULL
))))
1521 sink_data
.name
= pa_sprintf_malloc("%s.echo-cancel", sink_master
->name
);
1522 pa_sink_new_data_set_sample_spec(&sink_data
, &sink_ss
);
1523 pa_sink_new_data_set_channel_map(&sink_data
, &sink_map
);
1524 pa_proplist_sets(sink_data
.proplist
, PA_PROP_DEVICE_MASTER_DEVICE
, sink_master
->name
);
1525 pa_proplist_sets(sink_data
.proplist
, PA_PROP_DEVICE_CLASS
, "filter");
1527 pa_proplist_sets(sink_data
.proplist
, PA_PROP_DEVICE_INTENDED_ROLES
, "phone");
1528 pa_proplist_sets(sink_data
.proplist
, "device.echo-cancel.name", sink_data
.name
);
1530 if (pa_modargs_get_proplist(ma
, "sink_properties", sink_data
.proplist
, PA_UPDATE_REPLACE
) < 0) {
1531 pa_log("Invalid properties");
1532 pa_sink_new_data_done(&sink_data
);
1536 if ((u
->sink_auto_desc
= !pa_proplist_contains(sink_data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
))) {
1539 z
= pa_proplist_gets(sink_master
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
1540 pa_proplist_setf(sink_data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
, "Echo-Cancel Sink %s on %s", sink_data
.name
, z
? z
: sink_master
->name
);
1543 u
->sink
= pa_sink_new(m
->core
, &sink_data
, (sink_master
->flags
& (PA_SINK_LATENCY
| PA_SINK_DYNAMIC_LATENCY
))
1544 | (use_volume_sharing
? PA_SINK_SHARE_VOLUME_WITH_MASTER
: 0));
1545 pa_sink_new_data_done(&sink_data
);
1548 pa_log("Failed to create sink.");
1552 u
->sink
->parent
.process_msg
= sink_process_msg_cb
;
1553 u
->sink
->set_state
= sink_set_state_cb
;
1554 u
->sink
->update_requested_latency
= sink_update_requested_latency_cb
;
1555 u
->sink
->request_rewind
= sink_request_rewind_cb
;
1556 pa_sink_set_set_mute_callback(u
->sink
, sink_set_mute_cb
);
1557 if (!use_volume_sharing
) {
1558 pa_sink_set_set_volume_callback(u
->sink
, sink_set_volume_cb
);
1559 pa_sink_enable_decibel_volume(u
->sink
, TRUE
);
1561 u
->sink
->userdata
= u
;
1563 pa_sink_set_asyncmsgq(u
->sink
, sink_master
->asyncmsgq
);
1565 /* Create source output */
1566 pa_source_output_new_data_init(&source_output_data
);
1567 source_output_data
.driver
= __FILE__
;
1568 source_output_data
.module
= m
;
1569 pa_source_output_new_data_set_source(&source_output_data
, source_master
, FALSE
);
1570 source_output_data
.destination_source
= u
->source
;
1572 source_output_data.flags = PA_SOURCE_OUTPUT_DONT_INHIBIT_AUTO_SUSPEND; */
1574 pa_proplist_sets(source_output_data
.proplist
, PA_PROP_MEDIA_NAME
, "Echo-Cancel Source Stream");
1575 pa_proplist_sets(source_output_data
.proplist
, PA_PROP_MEDIA_ROLE
, "filter");
1576 pa_source_output_new_data_set_sample_spec(&source_output_data
, &source_ss
);
1577 pa_source_output_new_data_set_channel_map(&source_output_data
, &source_map
);
1579 pa_source_output_new(&u
->source_output
, m
->core
, &source_output_data
);
1580 pa_source_output_new_data_done(&source_output_data
);
1582 if (!u
->source_output
)
1585 u
->source_output
->parent
.process_msg
= source_output_process_msg_cb
;
1586 u
->source_output
->push
= source_output_push_cb
;
1587 u
->source_output
->process_rewind
= source_output_process_rewind_cb
;
1588 u
->source_output
->update_max_rewind
= source_output_update_max_rewind_cb
;
1589 u
->source_output
->update_source_requested_latency
= source_output_update_source_requested_latency_cb
;
1590 u
->source_output
->update_source_latency_range
= source_output_update_source_latency_range_cb
;
1591 u
->source_output
->update_source_fixed_latency
= source_output_update_source_fixed_latency_cb
;
1592 u
->source_output
->kill
= source_output_kill_cb
;
1593 u
->source_output
->attach
= source_output_attach_cb
;
1594 u
->source_output
->detach
= source_output_detach_cb
;
1595 u
->source_output
->state_change
= source_output_state_change_cb
;
1596 u
->source_output
->may_move_to
= source_output_may_move_to_cb
;
1597 u
->source_output
->moving
= source_output_moving_cb
;
1598 u
->source_output
->userdata
= u
;
1600 u
->source
->output_from_master
= u
->source_output
;
1602 /* Create sink input */
1603 pa_sink_input_new_data_init(&sink_input_data
);
1604 sink_input_data
.driver
= __FILE__
;
1605 sink_input_data
.module
= m
;
1606 pa_sink_input_new_data_set_sink(&sink_input_data
, sink_master
, FALSE
);
1607 sink_input_data
.origin_sink
= u
->sink
;
1608 pa_proplist_sets(sink_input_data
.proplist
, PA_PROP_MEDIA_NAME
, "Echo-Cancel Sink Stream");
1609 pa_proplist_sets(sink_input_data
.proplist
, PA_PROP_MEDIA_ROLE
, "filter");
1610 pa_sink_input_new_data_set_sample_spec(&sink_input_data
, &sink_ss
);
1611 pa_sink_input_new_data_set_channel_map(&sink_input_data
, &sink_map
);
1612 sink_input_data
.flags
= PA_SINK_INPUT_VARIABLE_RATE
;
1614 pa_sink_input_new(&u
->sink_input
, m
->core
, &sink_input_data
);
1615 pa_sink_input_new_data_done(&sink_input_data
);
1620 u
->sink_input
->parent
.process_msg
= sink_input_process_msg_cb
;
1621 u
->sink_input
->pop
= sink_input_pop_cb
;
1622 u
->sink_input
->process_rewind
= sink_input_process_rewind_cb
;
1623 u
->sink_input
->update_max_rewind
= sink_input_update_max_rewind_cb
;
1624 u
->sink_input
->update_max_request
= sink_input_update_max_request_cb
;
1625 u
->sink_input
->update_sink_requested_latency
= sink_input_update_sink_requested_latency_cb
;
1626 u
->sink_input
->update_sink_latency_range
= sink_input_update_sink_latency_range_cb
;
1627 u
->sink_input
->update_sink_fixed_latency
= sink_input_update_sink_fixed_latency_cb
;
1628 u
->sink_input
->kill
= sink_input_kill_cb
;
1629 u
->sink_input
->attach
= sink_input_attach_cb
;
1630 u
->sink_input
->detach
= sink_input_detach_cb
;
1631 u
->sink_input
->state_change
= sink_input_state_change_cb
;
1632 u
->sink_input
->may_move_to
= sink_input_may_move_to_cb
;
1633 u
->sink_input
->moving
= sink_input_moving_cb
;
1634 if (!use_volume_sharing
)
1635 u
->sink_input
->volume_changed
= sink_input_volume_changed_cb
;
1636 u
->sink_input
->mute_changed
= sink_input_mute_changed_cb
;
1637 u
->sink_input
->userdata
= u
;
1639 u
->sink
->input_to_master
= u
->sink_input
;
1641 pa_sink_input_get_silence(u
->sink_input
, &silence
);
1643 u
->source_memblockq
= pa_memblockq_new("module-echo-cancel source_memblockq", 0, MEMBLOCKQ_MAXLENGTH
, 0,
1644 &source_ss
, 1, 1, 0, &silence
);
1645 u
->sink_memblockq
= pa_memblockq_new("module-echo-cancel sink_memblockq", 0, MEMBLOCKQ_MAXLENGTH
, 0,
1646 &sink_ss
, 1, 1, 0, &silence
);
1648 pa_memblock_unref(silence
.memblock
);
1650 if (!u
->source_memblockq
|| !u
->sink_memblockq
) {
1651 pa_log("Failed to create memblockq.");
1655 /* our source and sink are not suspended when we create them */
1658 if (u
->adjust_time
> 0)
1659 u
->time_event
= pa_core_rttime_new(m
->core
, pa_rtclock_now() + u
->adjust_time
, time_callback
, u
);
1662 pa_log("Creating AEC files in /tmp");
1663 u
->captured_file
= fopen("/tmp/aec_rec.sw", "wb");
1664 if (u
->captured_file
== NULL
)
1665 perror ("fopen failed");
1666 u
->played_file
= fopen("/tmp/aec_play.sw", "wb");
1667 if (u
->played_file
== NULL
)
1668 perror ("fopen failed");
1669 u
->canceled_file
= fopen("/tmp/aec_out.sw", "wb");
1670 if (u
->canceled_file
== NULL
)
1671 perror ("fopen failed");
1674 pa_sink_put(u
->sink
);
1675 pa_source_put(u
->source
);
1677 pa_sink_input_put(u
->sink_input
);
1678 pa_source_output_put(u
->source_output
);
1680 pa_modargs_free(ma
);
1686 pa_modargs_free(ma
);
1693 int pa__get_n_used(pa_module
*m
) {
1697 pa_assert_se(u
= m
->userdata
);
1699 return pa_sink_linked_by(u
->sink
) + pa_source_linked_by(u
->source
);
1702 void pa__done(pa_module
*m
) {
1707 if (!(u
= m
->userdata
))
1712 /* See comments in source_output_kill_cb() above regarding
1713 * destruction order! */
1716 u
->core
->mainloop
->time_free(u
->time_event
);
1718 if (u
->source_output
)
1719 pa_source_output_unlink(u
->source_output
);
1721 pa_sink_input_unlink(u
->sink_input
);
1724 pa_source_unlink(u
->source
);
1726 pa_sink_unlink(u
->sink
);
1728 if (u
->source_output
)
1729 pa_source_output_unref(u
->source_output
);
1731 pa_sink_input_unref(u
->sink_input
);
1734 pa_source_unref(u
->source
);
1736 pa_sink_unref(u
->sink
);
1738 if (u
->source_memblockq
)
1739 pa_memblockq_free(u
->source_memblockq
);
1740 if (u
->sink_memblockq
)
1741 pa_memblockq_free(u
->sink_memblockq
);
1751 pa_asyncmsgq_unref(u
->asyncmsgq
);
1756 #ifdef ECHO_CANCEL_TEST
1758 * Stand-alone test program for running in the canceller on pre-recorded files.
1760 int main(int argc
, char* argv
[]) {
1762 pa_sample_spec source_ss
, sink_ss
;
1763 pa_channel_map source_map
, sink_map
;
1764 pa_modargs
*ma
= NULL
;
1765 uint8_t *rdata
= NULL
, *pdata
= NULL
, *cdata
= NULL
;
1766 int ret
= 0, unused
;
1768 pa_memzero(&u
, sizeof(u
));
1770 if (argc
< 4 || argc
> 6) {
1774 u
.ec
= pa_xnew0(pa_echo_canceller
, 1);
1776 pa_log("Failed to alloc echo canceller");
1780 u
.captured_file
= fopen(argv
[2], "r");
1781 if (u
.captured_file
== NULL
) {
1782 perror ("fopen failed");
1785 u
.played_file
= fopen(argv
[1], "r");
1786 if (u
.played_file
== NULL
) {
1787 perror ("fopen failed");
1790 u
.canceled_file
= fopen(argv
[3], "wb");
1791 if (u
.canceled_file
== NULL
) {
1792 perror ("fopen failed");
1796 u
.core
= pa_xnew0(pa_core
, 1);
1797 u
.core
->cpu_info
.cpu_type
= PA_CPU_X86
;
1798 u
.core
->cpu_info
.flags
.x86
|= PA_CPU_X86_SSE
;
1800 if (!(ma
= pa_modargs_new(argc
> 4 ? argv
[4] : NULL
, valid_modargs
))) {
1801 pa_log("Failed to parse module arguments.");
1805 source_ss
.format
= PA_SAMPLE_S16LE
;
1806 source_ss
.rate
= DEFAULT_RATE
;
1807 source_ss
.channels
= DEFAULT_CHANNELS
;
1808 pa_channel_map_init_auto(&source_map
, source_ss
.channels
, PA_CHANNEL_MAP_DEFAULT
);
1810 init_common(ma
, &u
, &source_ss
, &source_map
);
1812 if (!u
.ec
->init(u
.core
, u
.ec
, &source_ss
, &source_map
, &sink_ss
, &sink_map
, &u
.blocksize
,
1813 (argc
> 4) ? argv
[5] : NULL
)) {
1814 pa_log("Failed to init AEC engine");
1818 rdata
= pa_xmalloc(u
.blocksize
);
1819 pdata
= pa_xmalloc(u
.blocksize
);
1820 cdata
= pa_xmalloc(u
.blocksize
);
1822 while (fread(rdata
, u
.blocksize
, 1, u
.captured_file
) > 0) {
1823 if (fread(pdata
, u
.blocksize
, 1, u
.played_file
) == 0) {
1824 perror("played file ended before captured file");
1828 u
.ec
->run(u
.ec
, rdata
, pdata
, cdata
);
1830 unused
= fwrite(cdata
, u
.blocksize
, 1, u
.canceled_file
);
1835 fclose(u
.captured_file
);
1836 fclose(u
.played_file
);
1837 fclose(u
.canceled_file
);
1848 pa_modargs_free(ma
);
1853 pa_log("Usage: %s play_file rec_file out_file [module args] [aec_args]",argv
[0]);
1859 #endif /* ECHO_CANCEL_TEST */