2 This file is part of PulseAudio.
4 Copyright 2004-2006 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
30 #include <sys/types.h>
34 #include <pulse/rtclock.h>
35 #include <pulse/timeval.h>
36 #include <pulse/util.h>
37 #include <pulse/version.h>
38 #include <pulse/xmalloc.h>
40 #include <pulsecore/module.h>
41 #include <pulsecore/core-util.h>
42 #include <pulsecore/modargs.h>
43 #include <pulsecore/log.h>
44 #include <pulsecore/core-subscribe.h>
45 #include <pulsecore/sink-input.h>
46 #include <pulsecore/pdispatch.h>
47 #include <pulsecore/pstream.h>
48 #include <pulsecore/pstream-util.h>
49 #include <pulsecore/socket-client.h>
50 #include <pulsecore/socket-util.h>
51 #include <pulsecore/time-smoother.h>
52 #include <pulsecore/thread.h>
53 #include <pulsecore/thread-mq.h>
54 #include <pulsecore/core-rtclock.h>
55 #include <pulsecore/core-error.h>
56 #include <pulsecore/proplist-util.h>
57 #include <pulsecore/auth-cookie.h>
60 #include "module-tunnel-sink-symdef.h"
62 #include "module-tunnel-source-symdef.h"
66 PA_MODULE_DESCRIPTION("Tunnel module for sinks");
68 "sink_name=<name for the local sink> "
69 "sink_properties=<properties for the local sink> "
71 "sink=<remote sink name> "
73 "format=<sample format> "
74 "channels=<number of channels> "
76 "channel_map=<channel map>");
78 PA_MODULE_DESCRIPTION("Tunnel module for sources");
80 "source_name=<name for the local source> "
81 "source_properties=<properties for the local source> "
83 "source=<remote source name> "
85 "format=<sample format> "
86 "channels=<number of channels> "
88 "channel_map=<channel map>");
91 PA_MODULE_AUTHOR("Lennart Poettering");
92 PA_MODULE_VERSION(PACKAGE_VERSION
);
93 PA_MODULE_LOAD_ONCE(FALSE
);
95 static const char* const valid_modargs
[] = {
114 #define DEFAULT_TIMEOUT 5
116 #define LATENCY_INTERVAL (10*PA_USEC_PER_SEC)
118 #define MIN_NETWORK_LATENCY_USEC (8*PA_USEC_PER_MSEC)
123 SINK_MESSAGE_REQUEST
= PA_SINK_MESSAGE_MAX
,
124 SINK_MESSAGE_REMOTE_SUSPEND
,
125 SINK_MESSAGE_UPDATE_LATENCY
,
129 #define DEFAULT_TLENGTH_MSEC 150
130 #define DEFAULT_MINREQ_MSEC 25
135 SOURCE_MESSAGE_POST
= PA_SOURCE_MESSAGE_MAX
,
136 SOURCE_MESSAGE_REMOTE_SUSPEND
,
137 SOURCE_MESSAGE_UPDATE_LATENCY
140 #define DEFAULT_FRAGSIZE_MSEC 25
145 static void command_request(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
);
146 static void command_started(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
);
148 static void command_subscribe_event(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
);
149 static void command_stream_killed(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
);
150 static void command_overflow_or_underflow(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
);
151 static void command_suspended(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
);
152 static void command_moved(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
);
153 static void command_stream_or_client_event(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
);
154 static void command_stream_buffer_attr_changed(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
);
156 static const pa_pdispatch_cb_t command_table
[PA_COMMAND_MAX
] = {
158 [PA_COMMAND_REQUEST
] = command_request
,
159 [PA_COMMAND_STARTED
] = command_started
,
161 [PA_COMMAND_SUBSCRIBE_EVENT
] = command_subscribe_event
,
162 [PA_COMMAND_OVERFLOW
] = command_overflow_or_underflow
,
163 [PA_COMMAND_UNDERFLOW
] = command_overflow_or_underflow
,
164 [PA_COMMAND_PLAYBACK_STREAM_KILLED
] = command_stream_killed
,
165 [PA_COMMAND_RECORD_STREAM_KILLED
] = command_stream_killed
,
166 [PA_COMMAND_PLAYBACK_STREAM_SUSPENDED
] = command_suspended
,
167 [PA_COMMAND_RECORD_STREAM_SUSPENDED
] = command_suspended
,
168 [PA_COMMAND_PLAYBACK_STREAM_MOVED
] = command_moved
,
169 [PA_COMMAND_RECORD_STREAM_MOVED
] = command_moved
,
170 [PA_COMMAND_PLAYBACK_STREAM_EVENT
] = command_stream_or_client_event
,
171 [PA_COMMAND_RECORD_STREAM_EVENT
] = command_stream_or_client_event
,
172 [PA_COMMAND_CLIENT_EVENT
] = command_stream_or_client_event
,
173 [PA_COMMAND_PLAYBACK_BUFFER_ATTR_CHANGED
] = command_stream_buffer_attr_changed
,
174 [PA_COMMAND_RECORD_BUFFER_ATTR_CHANGED
] = command_stream_buffer_attr_changed
181 pa_thread_mq thread_mq
;
185 pa_socket_client
*client
;
187 pa_pdispatch
*pdispatch
;
193 size_t requested_bytes
;
199 pa_auth_cookie
*auth_cookie
;
203 uint32_t device_index
;
206 int64_t counter
, counter_delta
;
208 pa_bool_t remote_corked
:1;
209 pa_bool_t remote_suspended
:1;
211 pa_usec_t transport_usec
; /* maintained in the main thread */
212 pa_usec_t thread_transport_usec
; /* maintained in the IO thread */
214 uint32_t ignore_latency_before
;
216 pa_time_event
*time_event
;
218 pa_smoother
*smoother
;
220 char *device_description
;
234 static void request_latency(struct userdata
*u
);
236 /* Called from main context */
237 static void command_stream_or_client_event(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
238 pa_log_debug("Got stream or client event.");
241 /* Called from main context */
242 static void command_stream_killed(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
243 struct userdata
*u
= userdata
;
248 pa_assert(u
->pdispatch
== pd
);
250 pa_log_warn("Stream killed");
251 pa_module_unload_request(u
->module
, TRUE
);
254 /* Called from main context */
255 static void command_overflow_or_underflow(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
256 struct userdata
*u
= userdata
;
261 pa_assert(u
->pdispatch
== pd
);
263 pa_log_info("Server signalled buffer overrun/underrun.");
267 /* Called from main context */
268 static void command_suspended(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
269 struct userdata
*u
= userdata
;
276 pa_assert(u
->pdispatch
== pd
);
278 if (pa_tagstruct_getu32(t
, &channel
) < 0 ||
279 pa_tagstruct_get_boolean(t
, &suspended
) < 0 ||
280 !pa_tagstruct_eof(t
)) {
282 pa_log("Invalid packet.");
283 pa_module_unload_request(u
->module
, TRUE
);
287 pa_log_debug("Server reports device suspend.");
290 pa_asyncmsgq_send(u
->sink
->asyncmsgq
, PA_MSGOBJECT(u
->sink
), SINK_MESSAGE_REMOTE_SUSPEND
, PA_UINT32_TO_PTR(!!suspended
), 0, NULL
);
292 pa_asyncmsgq_send(u
->source
->asyncmsgq
, PA_MSGOBJECT(u
->source
), SOURCE_MESSAGE_REMOTE_SUSPEND
, PA_UINT32_TO_PTR(!!suspended
), 0, NULL
);
298 /* Called from main context */
299 static void command_moved(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
300 struct userdata
*u
= userdata
;
301 uint32_t channel
, di
;
308 pa_assert(u
->pdispatch
== pd
);
310 if (pa_tagstruct_getu32(t
, &channel
) < 0 ||
311 pa_tagstruct_getu32(t
, &di
) < 0 ||
312 pa_tagstruct_gets(t
, &dn
) < 0 ||
313 pa_tagstruct_get_boolean(t
, &suspended
) < 0) {
315 pa_log_error("Invalid packet.");
316 pa_module_unload_request(u
->module
, TRUE
);
320 pa_log_debug("Server reports a stream move.");
323 pa_asyncmsgq_send(u
->sink
->asyncmsgq
, PA_MSGOBJECT(u
->sink
), SINK_MESSAGE_REMOTE_SUSPEND
, PA_UINT32_TO_PTR(!!suspended
), 0, NULL
);
325 pa_asyncmsgq_send(u
->source
->asyncmsgq
, PA_MSGOBJECT(u
->source
), SOURCE_MESSAGE_REMOTE_SUSPEND
, PA_UINT32_TO_PTR(!!suspended
), 0, NULL
);
331 static void command_stream_buffer_attr_changed(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
332 struct userdata
*u
= userdata
;
333 uint32_t channel
, maxlength
, tlength
, fragsize
, prebuf
, minreq
;
339 pa_assert(u
->pdispatch
== pd
);
341 if (pa_tagstruct_getu32(t
, &channel
) < 0 ||
342 pa_tagstruct_getu32(t
, &maxlength
) < 0) {
344 pa_log_error("Invalid packet.");
345 pa_module_unload_request(u
->module
, TRUE
);
349 if (command
== PA_COMMAND_RECORD_BUFFER_ATTR_CHANGED
) {
350 if (pa_tagstruct_getu32(t
, &fragsize
) < 0 ||
351 pa_tagstruct_get_usec(t
, &usec
) < 0) {
353 pa_log_error("Invalid packet.");
354 pa_module_unload_request(u
->module
, TRUE
);
358 if (pa_tagstruct_getu32(t
, &tlength
) < 0 ||
359 pa_tagstruct_getu32(t
, &prebuf
) < 0 ||
360 pa_tagstruct_getu32(t
, &minreq
) < 0 ||
361 pa_tagstruct_get_usec(t
, &usec
) < 0) {
363 pa_log_error("Invalid packet.");
364 pa_module_unload_request(u
->module
, TRUE
);
370 pa_log_debug("Server reports buffer attrs changed. tlength now at %lu, before %lu.", (unsigned long) tlength
, (unsigned long) u
->tlength
);
378 /* Called from main context */
379 static void command_started(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
380 struct userdata
*u
= userdata
;
385 pa_assert(u
->pdispatch
== pd
);
387 pa_log_debug("Server reports playback started.");
393 /* Called from IO thread context */
394 static void check_smoother_status(struct userdata
*u
, pa_bool_t past
) {
399 x
= pa_rtclock_now();
401 /* Correct by the time the requested issued needs to travel to the
402 * other side. This is a valid thread-safe access, because the
403 * main thread is waiting for us */
406 x
-= u
->thread_transport_usec
;
408 x
+= u
->thread_transport_usec
;
410 if (u
->remote_suspended
|| u
->remote_corked
)
411 pa_smoother_pause(u
->smoother
, x
);
413 pa_smoother_resume(u
->smoother
, x
, TRUE
);
416 /* Called from IO thread context */
417 static void stream_cork_within_thread(struct userdata
*u
, pa_bool_t cork
) {
420 if (u
->remote_corked
== cork
)
423 u
->remote_corked
= cork
;
424 check_smoother_status(u
, FALSE
);
427 /* Called from main context */
428 static void stream_cork(struct userdata
*u
, pa_bool_t cork
) {
435 t
= pa_tagstruct_new(NULL
, 0);
437 pa_tagstruct_putu32(t
, PA_COMMAND_CORK_PLAYBACK_STREAM
);
439 pa_tagstruct_putu32(t
, PA_COMMAND_CORK_RECORD_STREAM
);
441 pa_tagstruct_putu32(t
, u
->ctag
++);
442 pa_tagstruct_putu32(t
, u
->channel
);
443 pa_tagstruct_put_boolean(t
, !!cork
);
444 pa_pstream_send_tagstruct(u
->pstream
, t
);
449 /* Called from IO thread context */
450 static void stream_suspend_within_thread(struct userdata
*u
, pa_bool_t suspend
) {
453 if (u
->remote_suspended
== suspend
)
456 u
->remote_suspended
= suspend
;
457 check_smoother_status(u
, TRUE
);
462 /* Called from IO thread context */
463 static void send_data(struct userdata
*u
) {
466 while (u
->requested_bytes
> 0) {
467 pa_memchunk memchunk
;
469 pa_sink_render(u
->sink
, u
->requested_bytes
, &memchunk
);
470 pa_asyncmsgq_post(u
->thread_mq
.outq
, PA_MSGOBJECT(u
->sink
), SINK_MESSAGE_POST
, NULL
, 0, &memchunk
, NULL
);
471 pa_memblock_unref(memchunk
.memblock
);
473 u
->requested_bytes
-= memchunk
.length
;
475 u
->counter
+= (int64_t) memchunk
.length
;
479 /* This function is called from IO context -- except when it is not. */
480 static int sink_process_msg(pa_msgobject
*o
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
481 struct userdata
*u
= PA_SINK(o
)->userdata
;
485 case PA_SINK_MESSAGE_SET_STATE
: {
488 /* First, change the state, because otherwide pa_sink_render() would fail */
489 if ((r
= pa_sink_process_msg(o
, code
, data
, offset
, chunk
)) >= 0) {
491 stream_cork_within_thread(u
, u
->sink
->state
== PA_SINK_SUSPENDED
);
493 if (PA_SINK_IS_OPENED(u
->sink
->state
))
500 case PA_SINK_MESSAGE_GET_LATENCY
: {
501 pa_usec_t yl
, yr
, *usec
= data
;
503 yl
= pa_bytes_to_usec((uint64_t) u
->counter
, &u
->sink
->sample_spec
);
504 yr
= pa_smoother_get(u
->smoother
, pa_rtclock_now());
506 *usec
= yl
> yr
? yl
- yr
: 0;
510 case SINK_MESSAGE_REQUEST
:
512 pa_assert(offset
> 0);
513 u
->requested_bytes
+= (size_t) offset
;
515 if (PA_SINK_IS_OPENED(u
->sink
->thread_info
.state
))
521 case SINK_MESSAGE_REMOTE_SUSPEND
:
523 stream_suspend_within_thread(u
, !!PA_PTR_TO_UINT(data
));
527 case SINK_MESSAGE_UPDATE_LATENCY
: {
530 y
= pa_bytes_to_usec((uint64_t) u
->counter
, &u
->sink
->sample_spec
);
532 if (y
> (pa_usec_t
) offset
)
533 y
-= (pa_usec_t
) offset
;
537 pa_smoother_put(u
->smoother
, pa_rtclock_now(), y
);
539 /* We can access this freely here, since the main thread is waiting for us */
540 u
->thread_transport_usec
= u
->transport_usec
;
545 case SINK_MESSAGE_POST
:
547 /* OK, This might be a bit confusing. This message is
548 * delivered to us from the main context -- NOT from the
549 * IO thread context where the rest of the messages are
550 * dispatched. Yeah, ugly, but I am a lazy bastard. */
552 pa_pstream_send_memblock(u
->pstream
, u
->channel
, 0, PA_SEEK_RELATIVE
, chunk
);
554 u
->counter_delta
+= (int64_t) chunk
->length
;
559 return pa_sink_process_msg(o
, code
, data
, offset
, chunk
);
562 /* Called from main context */
563 static int sink_set_state(pa_sink
*s
, pa_sink_state_t state
) {
565 pa_sink_assert_ref(s
);
568 switch ((pa_sink_state_t
) state
) {
570 case PA_SINK_SUSPENDED
:
571 pa_assert(PA_SINK_IS_OPENED(s
->state
));
572 stream_cork(u
, TRUE
);
576 case PA_SINK_RUNNING
:
577 if (s
->state
== PA_SINK_SUSPENDED
)
578 stream_cork(u
, FALSE
);
581 case PA_SINK_UNLINKED
:
583 case PA_SINK_INVALID_STATE
:
592 /* This function is called from IO context -- except when it is not. */
593 static int source_process_msg(pa_msgobject
*o
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
594 struct userdata
*u
= PA_SOURCE(o
)->userdata
;
598 case PA_SOURCE_MESSAGE_SET_STATE
: {
601 if ((r
= pa_source_process_msg(o
, code
, data
, offset
, chunk
)) >= 0)
602 stream_cork_within_thread(u
, u
->source
->state
== PA_SOURCE_SUSPENDED
);
607 case PA_SOURCE_MESSAGE_GET_LATENCY
: {
608 pa_usec_t yr
, yl
, *usec
= data
;
610 yl
= pa_bytes_to_usec((uint64_t) u
->counter
, &PA_SOURCE(o
)->sample_spec
);
611 yr
= pa_smoother_get(u
->smoother
, pa_rtclock_now());
613 *usec
= yr
> yl
? yr
- yl
: 0;
617 case SOURCE_MESSAGE_POST
:
619 if (PA_SOURCE_IS_OPENED(u
->source
->thread_info
.state
))
620 pa_source_post(u
->source
, chunk
);
622 u
->counter
+= (int64_t) chunk
->length
;
626 case SOURCE_MESSAGE_REMOTE_SUSPEND
:
628 stream_suspend_within_thread(u
, !!PA_PTR_TO_UINT(data
));
631 case SOURCE_MESSAGE_UPDATE_LATENCY
: {
634 y
= pa_bytes_to_usec((uint64_t) u
->counter
, &u
->source
->sample_spec
);
635 y
+= (pa_usec_t
) offset
;
637 pa_smoother_put(u
->smoother
, pa_rtclock_now(), y
);
639 /* We can access this freely here, since the main thread is waiting for us */
640 u
->thread_transport_usec
= u
->transport_usec
;
646 return pa_source_process_msg(o
, code
, data
, offset
, chunk
);
649 /* Called from main context */
650 static int source_set_state(pa_source
*s
, pa_source_state_t state
) {
652 pa_source_assert_ref(s
);
655 switch ((pa_source_state_t
) state
) {
657 case PA_SOURCE_SUSPENDED
:
658 pa_assert(PA_SOURCE_IS_OPENED(s
->state
));
659 stream_cork(u
, TRUE
);
663 case PA_SOURCE_RUNNING
:
664 if (s
->state
== PA_SOURCE_SUSPENDED
)
665 stream_cork(u
, FALSE
);
668 case PA_SOURCE_UNLINKED
:
670 case PA_SINK_INVALID_STATE
:
679 static void thread_func(void *userdata
) {
680 struct userdata
*u
= userdata
;
684 pa_log_debug("Thread starting up");
686 pa_thread_mq_install(&u
->thread_mq
);
687 pa_rtpoll_install(u
->rtpoll
);
693 if (PA_SINK_IS_OPENED(u
->sink
->thread_info
.state
))
694 if (PA_UNLIKELY(u
->sink
->thread_info
.rewind_requested
))
695 pa_sink_process_rewind(u
->sink
, 0);
698 if ((ret
= pa_rtpoll_run(u
->rtpoll
, TRUE
)) < 0)
706 /* If this was no regular exit from the loop we have to continue
707 * processing messages until we received PA_MESSAGE_SHUTDOWN */
708 pa_asyncmsgq_post(u
->thread_mq
.outq
, PA_MSGOBJECT(u
->core
), PA_CORE_MESSAGE_UNLOAD_MODULE
, u
->module
, 0, NULL
, NULL
);
709 pa_asyncmsgq_wait_for(u
->thread_mq
.inq
, PA_MESSAGE_SHUTDOWN
);
712 pa_log_debug("Thread shutting down");
716 /* Called from main context */
717 static void command_request(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
718 struct userdata
*u
= userdata
;
719 uint32_t bytes
, channel
;
722 pa_assert(command
== PA_COMMAND_REQUEST
);
725 pa_assert(u
->pdispatch
== pd
);
727 if (pa_tagstruct_getu32(t
, &channel
) < 0 ||
728 pa_tagstruct_getu32(t
, &bytes
) < 0) {
729 pa_log("Invalid protocol reply");
733 if (channel
!= u
->channel
) {
734 pa_log("Received data for invalid channel");
738 pa_asyncmsgq_post(u
->sink
->asyncmsgq
, PA_MSGOBJECT(u
->sink
), SINK_MESSAGE_REQUEST
, NULL
, bytes
, NULL
, NULL
);
742 pa_module_unload_request(u
->module
, TRUE
);
747 /* Called from main context */
748 static void stream_get_latency_callback(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
749 struct userdata
*u
= userdata
;
750 pa_usec_t sink_usec
, source_usec
;
752 int64_t write_index
, read_index
;
753 struct timeval local
, remote
, now
;
760 if (command
!= PA_COMMAND_REPLY
) {
761 if (command
== PA_COMMAND_ERROR
)
762 pa_log("Failed to get latency.");
764 pa_log("Protocol error.");
768 if (pa_tagstruct_get_usec(t
, &sink_usec
) < 0 ||
769 pa_tagstruct_get_usec(t
, &source_usec
) < 0 ||
770 pa_tagstruct_get_boolean(t
, &playing
) < 0 ||
771 pa_tagstruct_get_timeval(t
, &local
) < 0 ||
772 pa_tagstruct_get_timeval(t
, &remote
) < 0 ||
773 pa_tagstruct_gets64(t
, &write_index
) < 0 ||
774 pa_tagstruct_gets64(t
, &read_index
) < 0) {
775 pa_log("Invalid reply.");
780 if (u
->version
>= 13) {
781 uint64_t underrun_for
= 0, playing_for
= 0;
783 if (pa_tagstruct_getu64(t
, &underrun_for
) < 0 ||
784 pa_tagstruct_getu64(t
, &playing_for
) < 0) {
785 pa_log("Invalid reply.");
791 if (!pa_tagstruct_eof(t
)) {
792 pa_log("Invalid reply.");
796 if (tag
< u
->ignore_latency_before
) {
800 pa_gettimeofday(&now
);
802 /* Calculate transport usec */
803 if (pa_timeval_cmp(&local
, &remote
) < 0 && pa_timeval_cmp(&remote
, &now
)) {
804 /* local and remote seem to have synchronized clocks */
806 u
->transport_usec
= pa_timeval_diff(&remote
, &local
);
808 u
->transport_usec
= pa_timeval_diff(&now
, &remote
);
811 u
->transport_usec
= pa_timeval_diff(&now
, &local
)/2;
813 /* First, take the device's delay */
815 delay
= (int64_t) sink_usec
;
816 ss
= &u
->sink
->sample_spec
;
818 delay
= (int64_t) source_usec
;
819 ss
= &u
->source
->sample_spec
;
822 /* Add the length of our server-side buffer */
823 if (write_index
>= read_index
)
824 delay
+= (int64_t) pa_bytes_to_usec((uint64_t) (write_index
-read_index
), ss
);
826 delay
-= (int64_t) pa_bytes_to_usec((uint64_t) (read_index
-write_index
), ss
);
828 /* Our measurements are already out of date, hence correct by the *
829 * transport latency */
831 delay
-= (int64_t) u
->transport_usec
;
833 delay
+= (int64_t) u
->transport_usec
;
836 /* Now correct by what we have have read/written since we requested the update */
838 delay
+= (int64_t) pa_bytes_to_usec((uint64_t) u
->counter_delta
, ss
);
840 delay
-= (int64_t) pa_bytes_to_usec((uint64_t) u
->counter_delta
, ss
);
844 pa_asyncmsgq_send(u
->sink
->asyncmsgq
, PA_MSGOBJECT(u
->sink
), SINK_MESSAGE_UPDATE_LATENCY
, 0, delay
, NULL
);
846 pa_asyncmsgq_send(u
->source
->asyncmsgq
, PA_MSGOBJECT(u
->source
), SOURCE_MESSAGE_UPDATE_LATENCY
, 0, delay
, NULL
);
853 pa_module_unload_request(u
->module
, TRUE
);
856 /* Called from main context */
857 static void request_latency(struct userdata
*u
) {
863 t
= pa_tagstruct_new(NULL
, 0);
865 pa_tagstruct_putu32(t
, PA_COMMAND_GET_PLAYBACK_LATENCY
);
867 pa_tagstruct_putu32(t
, PA_COMMAND_GET_RECORD_LATENCY
);
869 pa_tagstruct_putu32(t
, tag
= u
->ctag
++);
870 pa_tagstruct_putu32(t
, u
->channel
);
872 pa_tagstruct_put_timeval(t
, pa_gettimeofday(&now
));
874 pa_pstream_send_tagstruct(u
->pstream
, t
);
875 pa_pdispatch_register_reply(u
->pdispatch
, tag
, DEFAULT_TIMEOUT
, stream_get_latency_callback
, u
, NULL
);
877 u
->ignore_latency_before
= tag
;
878 u
->counter_delta
= 0;
881 /* Called from main context */
882 static void timeout_callback(pa_mainloop_api
*m
, pa_time_event
*e
, const struct timeval
*t
, void *userdata
) {
883 struct userdata
*u
= userdata
;
891 pa_core_rttime_restart(u
->core
, e
, pa_rtclock_now() + LATENCY_INTERVAL
);
894 /* Called from main context */
895 static void update_description(struct userdata
*u
) {
897 char un
[128], hn
[128];
902 if (!u
->server_fqdn
|| !u
->user_name
|| !u
->device_description
)
905 d
= pa_sprintf_malloc("%s on %s@%s", u
->device_description
, u
->user_name
, u
->server_fqdn
);
908 pa_sink_set_description(u
->sink
, d
);
909 pa_proplist_sets(u
->sink
->proplist
, "tunnel.remote.user", u
->user_name
);
910 pa_proplist_sets(u
->sink
->proplist
, "tunnel.remote.fqdn", u
->server_fqdn
);
911 pa_proplist_sets(u
->sink
->proplist
, "tunnel.remote.description", u
->device_description
);
913 pa_source_set_description(u
->source
, d
);
914 pa_proplist_sets(u
->source
->proplist
, "tunnel.remote.user", u
->user_name
);
915 pa_proplist_sets(u
->source
->proplist
, "tunnel.remote.fqdn", u
->server_fqdn
);
916 pa_proplist_sets(u
->source
->proplist
, "tunnel.remote.description", u
->device_description
);
921 d
= pa_sprintf_malloc("%s for %s@%s", u
->device_description
,
922 pa_get_user_name(un
, sizeof(un
)),
923 pa_get_host_name(hn
, sizeof(hn
)));
925 t
= pa_tagstruct_new(NULL
, 0);
927 pa_tagstruct_putu32(t
, PA_COMMAND_SET_PLAYBACK_STREAM_NAME
);
929 pa_tagstruct_putu32(t
, PA_COMMAND_SET_RECORD_STREAM_NAME
);
931 pa_tagstruct_putu32(t
, u
->ctag
++);
932 pa_tagstruct_putu32(t
, u
->channel
);
933 pa_tagstruct_puts(t
, d
);
934 pa_pstream_send_tagstruct(u
->pstream
, t
);
939 /* Called from main context */
940 static void server_info_cb(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
941 struct userdata
*u
= userdata
;
944 const char *server_name
, *server_version
, *user_name
, *host_name
, *default_sink_name
, *default_source_name
;
950 if (command
!= PA_COMMAND_REPLY
) {
951 if (command
== PA_COMMAND_ERROR
)
952 pa_log("Failed to get info.");
954 pa_log("Protocol error.");
958 if (pa_tagstruct_gets(t
, &server_name
) < 0 ||
959 pa_tagstruct_gets(t
, &server_version
) < 0 ||
960 pa_tagstruct_gets(t
, &user_name
) < 0 ||
961 pa_tagstruct_gets(t
, &host_name
) < 0 ||
962 pa_tagstruct_get_sample_spec(t
, &ss
) < 0 ||
963 pa_tagstruct_gets(t
, &default_sink_name
) < 0 ||
964 pa_tagstruct_gets(t
, &default_source_name
) < 0 ||
965 pa_tagstruct_getu32(t
, &cookie
) < 0 ||
967 pa_tagstruct_get_channel_map(t
, &cm
) < 0)) {
969 pa_log("Parse failure");
973 if (!pa_tagstruct_eof(t
)) {
974 pa_log("Packet too long");
978 pa_xfree(u
->server_fqdn
);
979 u
->server_fqdn
= pa_xstrdup(host_name
);
981 pa_xfree(u
->user_name
);
982 u
->user_name
= pa_xstrdup(user_name
);
984 update_description(u
);
989 pa_module_unload_request(u
->module
, TRUE
);
994 /* Called from main context */
995 static void sink_info_cb(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
996 struct userdata
*u
= userdata
;
997 uint32_t idx
, owner_module
, monitor_source
, flags
;
998 const char *name
, *description
, *monitor_source_name
, *driver
;
1009 pl
= pa_proplist_new();
1011 if (command
!= PA_COMMAND_REPLY
) {
1012 if (command
== PA_COMMAND_ERROR
)
1013 pa_log("Failed to get info.");
1015 pa_log("Protocol error.");
1019 if (pa_tagstruct_getu32(t
, &idx
) < 0 ||
1020 pa_tagstruct_gets(t
, &name
) < 0 ||
1021 pa_tagstruct_gets(t
, &description
) < 0 ||
1022 pa_tagstruct_get_sample_spec(t
, &ss
) < 0 ||
1023 pa_tagstruct_get_channel_map(t
, &cm
) < 0 ||
1024 pa_tagstruct_getu32(t
, &owner_module
) < 0 ||
1025 pa_tagstruct_get_cvolume(t
, &volume
) < 0 ||
1026 pa_tagstruct_get_boolean(t
, &mute
) < 0 ||
1027 pa_tagstruct_getu32(t
, &monitor_source
) < 0 ||
1028 pa_tagstruct_gets(t
, &monitor_source_name
) < 0 ||
1029 pa_tagstruct_get_usec(t
, &latency
) < 0 ||
1030 pa_tagstruct_gets(t
, &driver
) < 0 ||
1031 pa_tagstruct_getu32(t
, &flags
) < 0) {
1033 pa_log("Parse failure");
1037 if (u
->version
>= 13) {
1038 pa_usec_t configured_latency
;
1040 if (pa_tagstruct_get_proplist(t
, pl
) < 0 ||
1041 pa_tagstruct_get_usec(t
, &configured_latency
) < 0) {
1043 pa_log("Parse failure");
1048 if (u
->version
>= 15) {
1049 pa_volume_t base_volume
;
1050 uint32_t state
, n_volume_steps
, card
;
1052 if (pa_tagstruct_get_volume(t
, &base_volume
) < 0 ||
1053 pa_tagstruct_getu32(t
, &state
) < 0 ||
1054 pa_tagstruct_getu32(t
, &n_volume_steps
) < 0 ||
1055 pa_tagstruct_getu32(t
, &card
) < 0) {
1057 pa_log("Parse failure");
1062 if (!pa_tagstruct_eof(t
)) {
1063 pa_log("Packet too long");
1067 pa_proplist_free(pl
);
1069 if (!u
->sink_name
|| strcmp(name
, u
->sink_name
))
1072 pa_xfree(u
->device_description
);
1073 u
->device_description
= pa_xstrdup(description
);
1075 update_description(u
);
1080 pa_module_unload_request(u
->module
, TRUE
);
1081 pa_proplist_free(pl
);
1084 /* Called from main context */
1085 static void sink_input_info_cb(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
1086 struct userdata
*u
= userdata
;
1087 uint32_t idx
, owner_module
, client
, sink
;
1088 pa_usec_t buffer_usec
, sink_usec
;
1089 const char *name
, *driver
, *resample_method
;
1091 pa_sample_spec sample_spec
;
1092 pa_channel_map channel_map
;
1099 pl
= pa_proplist_new();
1101 if (command
!= PA_COMMAND_REPLY
) {
1102 if (command
== PA_COMMAND_ERROR
)
1103 pa_log("Failed to get info.");
1105 pa_log("Protocol error.");
1109 if (pa_tagstruct_getu32(t
, &idx
) < 0 ||
1110 pa_tagstruct_gets(t
, &name
) < 0 ||
1111 pa_tagstruct_getu32(t
, &owner_module
) < 0 ||
1112 pa_tagstruct_getu32(t
, &client
) < 0 ||
1113 pa_tagstruct_getu32(t
, &sink
) < 0 ||
1114 pa_tagstruct_get_sample_spec(t
, &sample_spec
) < 0 ||
1115 pa_tagstruct_get_channel_map(t
, &channel_map
) < 0 ||
1116 pa_tagstruct_get_cvolume(t
, &volume
) < 0 ||
1117 pa_tagstruct_get_usec(t
, &buffer_usec
) < 0 ||
1118 pa_tagstruct_get_usec(t
, &sink_usec
) < 0 ||
1119 pa_tagstruct_gets(t
, &resample_method
) < 0 ||
1120 pa_tagstruct_gets(t
, &driver
) < 0) {
1122 pa_log("Parse failure");
1126 if (u
->version
>= 11) {
1127 if (pa_tagstruct_get_boolean(t
, &mute
) < 0) {
1129 pa_log("Parse failure");
1134 if (u
->version
>= 13) {
1135 if (pa_tagstruct_get_proplist(t
, pl
) < 0) {
1137 pa_log("Parse failure");
1142 if (!pa_tagstruct_eof(t
)) {
1143 pa_log("Packet too long");
1147 pa_proplist_free(pl
);
1149 if (idx
!= u
->device_index
)
1154 if ((u
->version
< 11 || !!mute
== !!u
->sink
->muted
) &&
1155 pa_cvolume_equal(&volume
, &u
->sink
->virtual_volume
))
1158 pa_sink_volume_changed(u
->sink
, &volume
, FALSE
);
1160 if (u
->version
>= 11)
1161 pa_sink_mute_changed(u
->sink
, mute
, FALSE
);
1166 pa_module_unload_request(u
->module
, TRUE
);
1167 pa_proplist_free(pl
);
1172 /* Called from main context */
1173 static void source_info_cb(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
1174 struct userdata
*u
= userdata
;
1175 uint32_t idx
, owner_module
, monitor_of_sink
, flags
;
1176 const char *name
, *description
, *monitor_of_sink_name
, *driver
;
1181 pa_usec_t latency
, configured_latency
;
1187 pl
= pa_proplist_new();
1189 if (command
!= PA_COMMAND_REPLY
) {
1190 if (command
== PA_COMMAND_ERROR
)
1191 pa_log("Failed to get info.");
1193 pa_log("Protocol error.");
1197 if (pa_tagstruct_getu32(t
, &idx
) < 0 ||
1198 pa_tagstruct_gets(t
, &name
) < 0 ||
1199 pa_tagstruct_gets(t
, &description
) < 0 ||
1200 pa_tagstruct_get_sample_spec(t
, &ss
) < 0 ||
1201 pa_tagstruct_get_channel_map(t
, &cm
) < 0 ||
1202 pa_tagstruct_getu32(t
, &owner_module
) < 0 ||
1203 pa_tagstruct_get_cvolume(t
, &volume
) < 0 ||
1204 pa_tagstruct_get_boolean(t
, &mute
) < 0 ||
1205 pa_tagstruct_getu32(t
, &monitor_of_sink
) < 0 ||
1206 pa_tagstruct_gets(t
, &monitor_of_sink_name
) < 0 ||
1207 pa_tagstruct_get_usec(t
, &latency
) < 0 ||
1208 pa_tagstruct_gets(t
, &driver
) < 0 ||
1209 pa_tagstruct_getu32(t
, &flags
) < 0) {
1211 pa_log("Parse failure");
1215 if (u
->version
>= 13) {
1216 if (pa_tagstruct_get_proplist(t
, pl
) < 0 ||
1217 pa_tagstruct_get_usec(t
, &configured_latency
) < 0) {
1219 pa_log("Parse failure");
1224 if (u
->version
>= 15) {
1225 pa_volume_t base_volume
;
1226 uint32_t state
, n_volume_steps
, card
;
1228 if (pa_tagstruct_get_volume(t
, &base_volume
) < 0 ||
1229 pa_tagstruct_getu32(t
, &state
) < 0 ||
1230 pa_tagstruct_getu32(t
, &n_volume_steps
) < 0 ||
1231 pa_tagstruct_getu32(t
, &card
) < 0) {
1233 pa_log("Parse failure");
1238 if (!pa_tagstruct_eof(t
)) {
1239 pa_log("Packet too long");
1243 pa_proplist_free(pl
);
1245 if (!u
->source_name
|| strcmp(name
, u
->source_name
))
1248 pa_xfree(u
->device_description
);
1249 u
->device_description
= pa_xstrdup(description
);
1251 update_description(u
);
1256 pa_module_unload_request(u
->module
, TRUE
);
1257 pa_proplist_free(pl
);
1262 /* Called from main context */
1263 static void request_info(struct userdata
*u
) {
1268 t
= pa_tagstruct_new(NULL
, 0);
1269 pa_tagstruct_putu32(t
, PA_COMMAND_GET_SERVER_INFO
);
1270 pa_tagstruct_putu32(t
, tag
= u
->ctag
++);
1271 pa_pstream_send_tagstruct(u
->pstream
, t
);
1272 pa_pdispatch_register_reply(u
->pdispatch
, tag
, DEFAULT_TIMEOUT
, server_info_cb
, u
, NULL
);
1275 t
= pa_tagstruct_new(NULL
, 0);
1276 pa_tagstruct_putu32(t
, PA_COMMAND_GET_SINK_INPUT_INFO
);
1277 pa_tagstruct_putu32(t
, tag
= u
->ctag
++);
1278 pa_tagstruct_putu32(t
, u
->device_index
);
1279 pa_pstream_send_tagstruct(u
->pstream
, t
);
1280 pa_pdispatch_register_reply(u
->pdispatch
, tag
, DEFAULT_TIMEOUT
, sink_input_info_cb
, u
, NULL
);
1283 t
= pa_tagstruct_new(NULL
, 0);
1284 pa_tagstruct_putu32(t
, PA_COMMAND_GET_SINK_INFO
);
1285 pa_tagstruct_putu32(t
, tag
= u
->ctag
++);
1286 pa_tagstruct_putu32(t
, PA_INVALID_INDEX
);
1287 pa_tagstruct_puts(t
, u
->sink_name
);
1288 pa_pstream_send_tagstruct(u
->pstream
, t
);
1289 pa_pdispatch_register_reply(u
->pdispatch
, tag
, DEFAULT_TIMEOUT
, sink_info_cb
, u
, NULL
);
1292 if (u
->source_name
) {
1293 t
= pa_tagstruct_new(NULL
, 0);
1294 pa_tagstruct_putu32(t
, PA_COMMAND_GET_SOURCE_INFO
);
1295 pa_tagstruct_putu32(t
, tag
= u
->ctag
++);
1296 pa_tagstruct_putu32(t
, PA_INVALID_INDEX
);
1297 pa_tagstruct_puts(t
, u
->source_name
);
1298 pa_pstream_send_tagstruct(u
->pstream
, t
);
1299 pa_pdispatch_register_reply(u
->pdispatch
, tag
, DEFAULT_TIMEOUT
, source_info_cb
, u
, NULL
);
1304 /* Called from main context */
1305 static void command_subscribe_event(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
1306 struct userdata
*u
= userdata
;
1307 pa_subscription_event_type_t e
;
1313 pa_assert(command
== PA_COMMAND_SUBSCRIBE_EVENT
);
1315 if (pa_tagstruct_getu32(t
, &e
) < 0 ||
1316 pa_tagstruct_getu32(t
, &idx
) < 0) {
1317 pa_log("Invalid protocol reply");
1318 pa_module_unload_request(u
->module
, TRUE
);
1322 if (e
!= (PA_SUBSCRIPTION_EVENT_SERVER
|PA_SUBSCRIPTION_EVENT_CHANGE
) &&
1324 e
!= (PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
) &&
1325 e
!= (PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
)
1327 e
!= (PA_SUBSCRIPTION_EVENT_SOURCE
|PA_SUBSCRIPTION_EVENT_CHANGE
)
1335 /* Called from main context */
1336 static void start_subscribe(struct userdata
*u
) {
1341 t
= pa_tagstruct_new(NULL
, 0);
1342 pa_tagstruct_putu32(t
, PA_COMMAND_SUBSCRIBE
);
1343 pa_tagstruct_putu32(t
, tag
= u
->ctag
++);
1344 pa_tagstruct_putu32(t
, PA_SUBSCRIPTION_MASK_SERVER
|
1346 PA_SUBSCRIPTION_MASK_SINK_INPUT
|PA_SUBSCRIPTION_MASK_SINK
1348 PA_SUBSCRIPTION_MASK_SOURCE
1352 pa_pstream_send_tagstruct(u
->pstream
, t
);
1355 /* Called from main context */
1356 static void create_stream_callback(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
1357 struct userdata
*u
= userdata
;
1364 pa_assert(u
->pdispatch
== pd
);
1366 if (command
!= PA_COMMAND_REPLY
) {
1367 if (command
== PA_COMMAND_ERROR
)
1368 pa_log("Failed to create stream.");
1370 pa_log("Protocol error.");
1374 if (pa_tagstruct_getu32(t
, &u
->channel
) < 0 ||
1375 pa_tagstruct_getu32(t
, &u
->device_index
) < 0
1377 || pa_tagstruct_getu32(t
, &bytes
) < 0
1382 if (u
->version
>= 9) {
1384 if (pa_tagstruct_getu32(t
, &u
->maxlength
) < 0 ||
1385 pa_tagstruct_getu32(t
, &u
->tlength
) < 0 ||
1386 pa_tagstruct_getu32(t
, &u
->prebuf
) < 0 ||
1387 pa_tagstruct_getu32(t
, &u
->minreq
) < 0)
1390 if (pa_tagstruct_getu32(t
, &u
->maxlength
) < 0 ||
1391 pa_tagstruct_getu32(t
, &u
->fragsize
) < 0)
1396 if (u
->version
>= 12) {
1399 uint32_t device_index
;
1401 pa_bool_t suspended
;
1403 if (pa_tagstruct_get_sample_spec(t
, &ss
) < 0 ||
1404 pa_tagstruct_get_channel_map(t
, &cm
) < 0 ||
1405 pa_tagstruct_getu32(t
, &device_index
) < 0 ||
1406 pa_tagstruct_gets(t
, &dn
) < 0 ||
1407 pa_tagstruct_get_boolean(t
, &suspended
) < 0)
1411 pa_xfree(u
->sink_name
);
1412 u
->sink_name
= pa_xstrdup(dn
);
1414 pa_xfree(u
->source_name
);
1415 u
->source_name
= pa_xstrdup(dn
);
1419 if (u
->version
>= 13) {
1422 if (pa_tagstruct_get_usec(t
, &usec
) < 0)
1425 /* #ifdef TUNNEL_SINK */
1426 /* pa_sink_set_latency_range(u->sink, usec + MIN_NETWORK_LATENCY_USEC, 0); */
1428 /* pa_source_set_latency_range(u->source, usec + MIN_NETWORK_LATENCY_USEC, 0); */
1432 if (!pa_tagstruct_eof(t
))
1438 pa_assert(!u
->time_event
);
1439 u
->time_event
= pa_core_rttime_new(u
->core
, pa_rtclock_now() + LATENCY_INTERVAL
, timeout_callback
, u
);
1443 pa_log_debug("Stream created.");
1446 pa_asyncmsgq_post(u
->sink
->asyncmsgq
, PA_MSGOBJECT(u
->sink
), SINK_MESSAGE_REQUEST
, NULL
, bytes
, NULL
, NULL
);
1452 pa_log("Invalid reply. (Create stream)");
1455 pa_module_unload_request(u
->module
, TRUE
);
1459 /* Called from main context */
1460 static void setup_complete_callback(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
1461 struct userdata
*u
= userdata
;
1462 pa_tagstruct
*reply
;
1463 char name
[256], un
[128], hn
[128];
1470 pa_assert(u
->pdispatch
== pd
);
1472 if (command
!= PA_COMMAND_REPLY
||
1473 pa_tagstruct_getu32(t
, &u
->version
) < 0 ||
1474 !pa_tagstruct_eof(t
)) {
1476 if (command
== PA_COMMAND_ERROR
)
1477 pa_log("Failed to authenticate");
1479 pa_log("Protocol error.");
1484 /* Minimum supported protocol version */
1485 if (u
->version
< 8) {
1486 pa_log("Incompatible protocol version");
1490 /* Starting with protocol version 13 the MSB of the version tag
1491 reflects if shm is enabled for this connection or not. We don't
1492 support SHM here at all, so we just ignore this. */
1494 if (u
->version
>= 13)
1495 u
->version
&= 0x7FFFFFFFU
;
1497 pa_log_debug("Protocol version: remote %u, local %u", u
->version
, PA_PROTOCOL_VERSION
);
1500 pa_proplist_setf(u
->sink
->proplist
, "tunnel.remote_version", "%u", u
->version
);
1501 pa_sink_update_proplist(u
->sink
, 0, NULL
);
1503 pa_snprintf(name
, sizeof(name
), "%s for %s@%s",
1505 pa_get_user_name(un
, sizeof(un
)),
1506 pa_get_host_name(hn
, sizeof(hn
)));
1508 pa_proplist_setf(u
->source
->proplist
, "tunnel.remote_version", "%u", u
->version
);
1509 pa_source_update_proplist(u
->source
, 0, NULL
);
1511 pa_snprintf(name
, sizeof(name
), "%s for %s@%s",
1513 pa_get_user_name(un
, sizeof(un
)),
1514 pa_get_host_name(hn
, sizeof(hn
)));
1517 reply
= pa_tagstruct_new(NULL
, 0);
1518 pa_tagstruct_putu32(reply
, PA_COMMAND_SET_CLIENT_NAME
);
1519 pa_tagstruct_putu32(reply
, tag
= u
->ctag
++);
1521 if (u
->version
>= 13) {
1523 pl
= pa_proplist_new();
1524 pa_proplist_sets(pl
, PA_PROP_APPLICATION_ID
, "org.PulseAudio.PulseAudio");
1525 pa_proplist_sets(pl
, PA_PROP_APPLICATION_VERSION
, PACKAGE_VERSION
);
1526 pa_init_proplist(pl
);
1527 pa_tagstruct_put_proplist(reply
, pl
);
1528 pa_proplist_free(pl
);
1530 pa_tagstruct_puts(reply
, "PulseAudio");
1532 pa_pstream_send_tagstruct(u
->pstream
, reply
);
1533 /* We ignore the server's reply here */
1535 reply
= pa_tagstruct_new(NULL
, 0);
1537 if (u
->version
< 13)
1538 /* Only for older PA versions we need to fill in the maxlength */
1539 u
->maxlength
= 4*1024*1024;
1542 u
->tlength
= (uint32_t) pa_usec_to_bytes(PA_USEC_PER_MSEC
* DEFAULT_TLENGTH_MSEC
, &u
->sink
->sample_spec
);
1543 u
->minreq
= (uint32_t) pa_usec_to_bytes(PA_USEC_PER_MSEC
* DEFAULT_MINREQ_MSEC
, &u
->sink
->sample_spec
);
1544 u
->prebuf
= u
->tlength
;
1546 u
->fragsize
= (uint32_t) pa_usec_to_bytes(PA_USEC_PER_MSEC
* DEFAULT_FRAGSIZE_MSEC
, &u
->source
->sample_spec
);
1550 pa_tagstruct_putu32(reply
, PA_COMMAND_CREATE_PLAYBACK_STREAM
);
1551 pa_tagstruct_putu32(reply
, tag
= u
->ctag
++);
1553 if (u
->version
< 13)
1554 pa_tagstruct_puts(reply
, name
);
1556 pa_tagstruct_put_sample_spec(reply
, &u
->sink
->sample_spec
);
1557 pa_tagstruct_put_channel_map(reply
, &u
->sink
->channel_map
);
1558 pa_tagstruct_putu32(reply
, PA_INVALID_INDEX
);
1559 pa_tagstruct_puts(reply
, u
->sink_name
);
1560 pa_tagstruct_putu32(reply
, u
->maxlength
);
1561 pa_tagstruct_put_boolean(reply
, !PA_SINK_IS_OPENED(pa_sink_get_state(u
->sink
)));
1562 pa_tagstruct_putu32(reply
, u
->tlength
);
1563 pa_tagstruct_putu32(reply
, u
->prebuf
);
1564 pa_tagstruct_putu32(reply
, u
->minreq
);
1565 pa_tagstruct_putu32(reply
, 0);
1566 pa_cvolume_reset(&volume
, u
->sink
->sample_spec
.channels
);
1567 pa_tagstruct_put_cvolume(reply
, &volume
);
1569 pa_tagstruct_putu32(reply
, PA_COMMAND_CREATE_RECORD_STREAM
);
1570 pa_tagstruct_putu32(reply
, tag
= u
->ctag
++);
1572 if (u
->version
< 13)
1573 pa_tagstruct_puts(reply
, name
);
1575 pa_tagstruct_put_sample_spec(reply
, &u
->source
->sample_spec
);
1576 pa_tagstruct_put_channel_map(reply
, &u
->source
->channel_map
);
1577 pa_tagstruct_putu32(reply
, PA_INVALID_INDEX
);
1578 pa_tagstruct_puts(reply
, u
->source_name
);
1579 pa_tagstruct_putu32(reply
, u
->maxlength
);
1580 pa_tagstruct_put_boolean(reply
, !PA_SOURCE_IS_OPENED(pa_source_get_state(u
->source
)));
1581 pa_tagstruct_putu32(reply
, u
->fragsize
);
1584 if (u
->version
>= 12) {
1585 pa_tagstruct_put_boolean(reply
, FALSE
); /* no_remap */
1586 pa_tagstruct_put_boolean(reply
, FALSE
); /* no_remix */
1587 pa_tagstruct_put_boolean(reply
, FALSE
); /* fix_format */
1588 pa_tagstruct_put_boolean(reply
, FALSE
); /* fix_rate */
1589 pa_tagstruct_put_boolean(reply
, FALSE
); /* fix_channels */
1590 pa_tagstruct_put_boolean(reply
, TRUE
); /* no_move */
1591 pa_tagstruct_put_boolean(reply
, FALSE
); /* variable_rate */
1594 if (u
->version
>= 13) {
1597 pa_tagstruct_put_boolean(reply
, FALSE
); /* start muted/peak detect*/
1598 pa_tagstruct_put_boolean(reply
, TRUE
); /* adjust_latency */
1600 pl
= pa_proplist_new();
1601 pa_proplist_sets(pl
, PA_PROP_MEDIA_NAME
, name
);
1602 pa_proplist_sets(pl
, PA_PROP_MEDIA_ROLE
, "abstract");
1603 pa_tagstruct_put_proplist(reply
, pl
);
1604 pa_proplist_free(pl
);
1607 pa_tagstruct_putu32(reply
, PA_INVALID_INDEX
); /* direct on input */
1611 if (u
->version
>= 14) {
1613 pa_tagstruct_put_boolean(reply
, FALSE
); /* volume_set */
1615 pa_tagstruct_put_boolean(reply
, TRUE
); /* early rquests */
1618 if (u
->version
>= 15) {
1620 pa_tagstruct_put_boolean(reply
, FALSE
); /* muted_set */
1622 pa_tagstruct_put_boolean(reply
, FALSE
); /* don't inhibit auto suspend */
1623 pa_tagstruct_put_boolean(reply
, FALSE
); /* fail on suspend */
1626 pa_pstream_send_tagstruct(u
->pstream
, reply
);
1627 pa_pdispatch_register_reply(u
->pdispatch
, tag
, DEFAULT_TIMEOUT
, create_stream_callback
, u
, NULL
);
1629 pa_log_debug("Connection authenticated, creating stream ...");
1634 pa_module_unload_request(u
->module
, TRUE
);
1637 /* Called from main context */
1638 static void pstream_die_callback(pa_pstream
*p
, void *userdata
) {
1639 struct userdata
*u
= userdata
;
1644 pa_log_warn("Stream died.");
1645 pa_module_unload_request(u
->module
, TRUE
);
1648 /* Called from main context */
1649 static void pstream_packet_callback(pa_pstream
*p
, pa_packet
*packet
, const pa_creds
*creds
, void *userdata
) {
1650 struct userdata
*u
= userdata
;
1656 if (pa_pdispatch_run(u
->pdispatch
, packet
, creds
, u
) < 0) {
1657 pa_log("Invalid packet");
1658 pa_module_unload_request(u
->module
, TRUE
);
1664 /* Called from main context */
1665 static void pstream_memblock_callback(pa_pstream
*p
, uint32_t channel
, int64_t offset
, pa_seek_mode_t seek
, const pa_memchunk
*chunk
, void *userdata
) {
1666 struct userdata
*u
= userdata
;
1672 if (channel
!= u
->channel
) {
1673 pa_log("Received memory block on bad channel.");
1674 pa_module_unload_request(u
->module
, TRUE
);
1678 pa_asyncmsgq_send(u
->source
->asyncmsgq
, PA_MSGOBJECT(u
->source
), SOURCE_MESSAGE_POST
, PA_UINT_TO_PTR(seek
), offset
, chunk
);
1680 u
->counter_delta
+= (int64_t) chunk
->length
;
1684 /* Called from main context */
1685 static void on_connection(pa_socket_client
*sc
, pa_iochannel
*io
, void *userdata
) {
1686 struct userdata
*u
= userdata
;
1692 pa_assert(u
->client
== sc
);
1694 pa_socket_client_unref(u
->client
);
1698 pa_log("Connection failed: %s", pa_cstrerror(errno
));
1699 pa_module_unload_request(u
->module
, TRUE
);
1703 u
->pstream
= pa_pstream_new(u
->core
->mainloop
, io
, u
->core
->mempool
);
1704 u
->pdispatch
= pa_pdispatch_new(u
->core
->mainloop
, TRUE
, command_table
, PA_COMMAND_MAX
);
1706 pa_pstream_set_die_callback(u
->pstream
, pstream_die_callback
, u
);
1707 pa_pstream_set_recieve_packet_callback(u
->pstream
, pstream_packet_callback
, u
);
1709 pa_pstream_set_recieve_memblock_callback(u
->pstream
, pstream_memblock_callback
, u
);
1712 t
= pa_tagstruct_new(NULL
, 0);
1713 pa_tagstruct_putu32(t
, PA_COMMAND_AUTH
);
1714 pa_tagstruct_putu32(t
, tag
= u
->ctag
++);
1715 pa_tagstruct_putu32(t
, PA_PROTOCOL_VERSION
);
1717 pa_tagstruct_put_arbitrary(t
, pa_auth_cookie_read(u
->auth_cookie
, PA_NATIVE_COOKIE_LENGTH
), PA_NATIVE_COOKIE_LENGTH
);
1723 if (pa_iochannel_creds_supported(io
))
1724 pa_iochannel_creds_enable(io
);
1726 ucred
.uid
= getuid();
1727 ucred
.gid
= getgid();
1729 pa_pstream_send_tagstruct_with_creds(u
->pstream
, t
, &ucred
);
1732 pa_pstream_send_tagstruct(u
->pstream
, t
);
1735 pa_pdispatch_register_reply(u
->pdispatch
, tag
, DEFAULT_TIMEOUT
, setup_complete_callback
, u
, NULL
);
1737 pa_log_debug("Connection established, authenticating ...");
1742 /* Called from main context */
1743 static void sink_set_volume(pa_sink
*sink
) {
1752 t
= pa_tagstruct_new(NULL
, 0);
1753 pa_tagstruct_putu32(t
, PA_COMMAND_SET_SINK_INPUT_VOLUME
);
1754 pa_tagstruct_putu32(t
, tag
= u
->ctag
++);
1755 pa_tagstruct_putu32(t
, u
->device_index
);
1756 pa_tagstruct_put_cvolume(t
, &sink
->virtual_volume
);
1757 pa_pstream_send_tagstruct(u
->pstream
, t
);
1760 /* Called from main context */
1761 static void sink_set_mute(pa_sink
*sink
) {
1770 if (u
->version
< 11)
1773 t
= pa_tagstruct_new(NULL
, 0);
1774 pa_tagstruct_putu32(t
, PA_COMMAND_SET_SINK_INPUT_MUTE
);
1775 pa_tagstruct_putu32(t
, tag
= u
->ctag
++);
1776 pa_tagstruct_putu32(t
, u
->device_index
);
1777 pa_tagstruct_put_boolean(t
, !!sink
->muted
);
1778 pa_pstream_send_tagstruct(u
->pstream
, t
);
1783 int pa__init(pa_module
*m
) {
1784 pa_modargs
*ma
= NULL
;
1785 struct userdata
*u
= NULL
;
1790 pa_sink_new_data data
;
1792 pa_source_new_data data
;
1797 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
1798 pa_log("Failed to parse module arguments");
1802 m
->userdata
= u
= pa_xnew0(struct userdata
, 1);
1806 u
->pdispatch
= NULL
;
1808 u
->server_name
= NULL
;
1810 u
->sink_name
= pa_xstrdup(pa_modargs_get_value(ma
, "sink", NULL
));;
1812 u
->requested_bytes
= 0;
1814 u
->source_name
= pa_xstrdup(pa_modargs_get_value(ma
, "source", NULL
));;
1817 u
->smoother
= pa_smoother_new(
1826 u
->device_index
= u
->channel
= PA_INVALID_INDEX
;
1827 u
->time_event
= NULL
;
1828 u
->ignore_latency_before
= 0;
1829 u
->transport_usec
= u
->thread_transport_usec
= 0;
1830 u
->remote_suspended
= u
->remote_corked
= FALSE
;
1831 u
->counter
= u
->counter_delta
= 0;
1833 u
->rtpoll
= pa_rtpoll_new();
1834 pa_thread_mq_init(&u
->thread_mq
, m
->core
->mainloop
, u
->rtpoll
);
1836 if (!(u
->auth_cookie
= pa_auth_cookie_get(u
->core
, pa_modargs_get_value(ma
, "cookie", PA_NATIVE_COOKIE_FILE
), PA_NATIVE_COOKIE_LENGTH
)))
1839 if (!(u
->server_name
= pa_xstrdup(pa_modargs_get_value(ma
, "server", NULL
)))) {
1840 pa_log("No server specified.");
1844 ss
= m
->core
->default_sample_spec
;
1845 map
= m
->core
->default_channel_map
;
1846 if (pa_modargs_get_sample_spec_and_channel_map(ma
, &ss
, &map
, PA_CHANNEL_MAP_DEFAULT
) < 0) {
1847 pa_log("Invalid sample format specification");
1851 if (!(u
->client
= pa_socket_client_new_string(m
->core
->mainloop
, TRUE
, u
->server_name
, PA_NATIVE_DEFAULT_PORT
))) {
1852 pa_log("Failed to connect to server '%s'", u
->server_name
);
1856 pa_socket_client_set_callback(u
->client
, on_connection
, u
);
1860 if (!(dn
= pa_xstrdup(pa_modargs_get_value(ma
, "sink_name", NULL
))))
1861 dn
= pa_sprintf_malloc("tunnel.%s", u
->server_name
);
1863 pa_sink_new_data_init(&data
);
1864 data
.driver
= __FILE__
;
1866 data
.namereg_fail
= TRUE
;
1867 pa_sink_new_data_set_name(&data
, dn
);
1868 pa_sink_new_data_set_sample_spec(&data
, &ss
);
1869 pa_sink_new_data_set_channel_map(&data
, &map
);
1870 pa_proplist_setf(data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
, "%s%s%s", pa_strempty(u
->sink_name
), u
->sink_name
? " on " : "", u
->server_name
);
1871 pa_proplist_sets(data
.proplist
, "tunnel.remote.server", u
->server_name
);
1873 pa_proplist_sets(data
.proplist
, "tunnel.remote.sink", u
->sink_name
);
1875 if (pa_modargs_get_proplist(ma
, "sink_properties", data
.proplist
, PA_UPDATE_REPLACE
) < 0) {
1876 pa_log("Invalid properties");
1877 pa_sink_new_data_done(&data
);
1881 u
->sink
= pa_sink_new(m
->core
, &data
, PA_SINK_NETWORK
|PA_SINK_LATENCY
|PA_SINK_HW_VOLUME_CTRL
|PA_SINK_HW_MUTE_CTRL
);
1882 pa_sink_new_data_done(&data
);
1885 pa_log("Failed to create sink.");
1889 u
->sink
->parent
.process_msg
= sink_process_msg
;
1890 u
->sink
->userdata
= u
;
1891 u
->sink
->set_state
= sink_set_state
;
1892 u
->sink
->set_volume
= sink_set_volume
;
1893 u
->sink
->set_mute
= sink_set_mute
;
1895 u
->sink
->refresh_volume
= u
->sink
->refresh_muted
= FALSE
;
1897 /* pa_sink_set_latency_range(u->sink, MIN_NETWORK_LATENCY_USEC, 0); */
1899 pa_sink_set_asyncmsgq(u
->sink
, u
->thread_mq
.inq
);
1900 pa_sink_set_rtpoll(u
->sink
, u
->rtpoll
);
1904 if (!(dn
= pa_xstrdup(pa_modargs_get_value(ma
, "source_name", NULL
))))
1905 dn
= pa_sprintf_malloc("tunnel.%s", u
->server_name
);
1907 pa_source_new_data_init(&data
);
1908 data
.driver
= __FILE__
;
1910 data
.namereg_fail
= TRUE
;
1911 pa_source_new_data_set_name(&data
, dn
);
1912 pa_source_new_data_set_sample_spec(&data
, &ss
);
1913 pa_source_new_data_set_channel_map(&data
, &map
);
1914 pa_proplist_setf(data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
, "%s%s%s", pa_strempty(u
->source_name
), u
->source_name
? " on " : "", u
->server_name
);
1915 pa_proplist_sets(data
.proplist
, "tunnel.remote.server", u
->server_name
);
1917 pa_proplist_sets(data
.proplist
, "tunnel.remote.source", u
->source_name
);
1919 if (pa_modargs_get_proplist(ma
, "source_properties", data
.proplist
, PA_UPDATE_REPLACE
) < 0) {
1920 pa_log("Invalid properties");
1921 pa_source_new_data_done(&data
);
1925 u
->source
= pa_source_new(m
->core
, &data
, PA_SOURCE_NETWORK
|PA_SOURCE_LATENCY
);
1926 pa_source_new_data_done(&data
);
1929 pa_log("Failed to create source.");
1933 u
->source
->parent
.process_msg
= source_process_msg
;
1934 u
->source
->set_state
= source_set_state
;
1935 u
->source
->userdata
= u
;
1937 /* pa_source_set_latency_range(u->source, MIN_NETWORK_LATENCY_USEC, 0); */
1939 pa_source_set_asyncmsgq(u
->source
, u
->thread_mq
.inq
);
1940 pa_source_set_rtpoll(u
->source
, u
->rtpoll
);
1945 u
->time_event
= NULL
;
1947 u
->maxlength
= (uint32_t) -1;
1949 u
->tlength
= u
->minreq
= u
->prebuf
= (uint32_t) -1;
1951 u
->fragsize
= (uint32_t) -1;
1954 if (!(u
->thread
= pa_thread_new(thread_func
, u
))) {
1955 pa_log("Failed to create thread.");
1960 pa_sink_put(u
->sink
);
1962 pa_source_put(u
->source
);
1965 pa_modargs_free(ma
);
1973 pa_modargs_free(ma
);
1980 void pa__done(pa_module
*m
) {
1985 if (!(u
= m
->userdata
))
1990 pa_sink_unlink(u
->sink
);
1993 pa_source_unlink(u
->source
);
1997 pa_asyncmsgq_send(u
->thread_mq
.inq
, NULL
, PA_MESSAGE_SHUTDOWN
, NULL
, 0, NULL
);
1998 pa_thread_free(u
->thread
);
2001 pa_thread_mq_done(&u
->thread_mq
);
2005 pa_sink_unref(u
->sink
);
2008 pa_source_unref(u
->source
);
2012 pa_rtpoll_free(u
->rtpoll
);
2015 pa_pstream_unlink(u
->pstream
);
2016 pa_pstream_unref(u
->pstream
);
2020 pa_pdispatch_unref(u
->pdispatch
);
2023 pa_socket_client_unref(u
->client
);
2026 pa_auth_cookie_unref(u
->auth_cookie
);
2029 pa_smoother_free(u
->smoother
);
2032 u
->core
->mainloop
->time_free(u
->time_event
);
2035 pa_xfree(u
->sink_name
);
2037 pa_xfree(u
->source_name
);
2039 pa_xfree(u
->server_name
);
2041 pa_xfree(u
->device_description
);
2042 pa_xfree(u
->server_fqdn
);
2043 pa_xfree(u
->user_name
);