4 This file is part of polypaudio.
6 polypaudio is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as published
8 by the Free Software Foundation; either version 2 of the License,
9 or (at your option) any later version.
11 polypaudio is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License
17 along with polypaudio; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
30 #include <sys/types.h>
38 #include "subscribe.h"
40 #include "sink-input.h"
41 #include "pdispatch.h"
43 #include "pstream-util.h"
45 #include "socket-client.h"
46 #include "socket-util.h"
47 #include "authkey-prop.h"
50 #include "module-tunnel-sink-symdef.h"
51 PA_MODULE_DESCRIPTION("Tunnel module for sinks")
52 PA_MODULE_USAGE("server=<address> sink=<remote sink name> cookie=<filename> format=<sample format> channels=<number of channels> rate=<sample rate> sink_name=<name for the local sink>")
54 #include "module-tunnel-source-symdef.h"
55 PA_MODULE_DESCRIPTION("Tunnel module for sources")
56 PA_MODULE_USAGE("server=<address> source=<remote source name> cookie=<filename> format=<sample format> channels=<number of channels> rate=<sample rate> source_name=<name for the local source>")
59 PA_MODULE_AUTHOR("Lennart Poettering")
60 PA_MODULE_VERSION(PACKAGE_VERSION
)
62 #define DEFAULT_SINK_NAME "tunnel"
63 #define DEFAULT_SOURCE_NAME "tunnel"
65 #define DEFAULT_TLENGTH (44100*2*2/10) //(10240*8)
66 #define DEFAULT_MAXLENGTH ((DEFAULT_TLENGTH*3)/2)
67 #define DEFAULT_MINREQ 512
68 #define DEFAULT_PREBUF (DEFAULT_TLENGTH-DEFAULT_MINREQ)
69 #define DEFAULT_FRAGSIZE 1024
71 #define DEFAULT_TIMEOUT 5
73 #define LATENCY_INTERVAL 10
75 static const char* const valid_modargs
[] = {
91 static void command_stream_killed(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
);
94 static void command_request(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
);
97 static const pa_pdispatch_callback command_table
[PA_COMMAND_MAX
] = {
99 [PA_COMMAND_REQUEST
] = command_request
,
101 [PA_COMMAND_PLAYBACK_STREAM_KILLED
] = command_stream_killed
,
102 [PA_COMMAND_RECORD_STREAM_KILLED
] = command_stream_killed
106 pa_socket_client
*client
;
108 pa_pdispatch
*pdispatch
;
114 uint32_t requested_bytes
;
123 uint8_t auth_cookie
[PA_NATIVE_COOKIE_LENGTH
];
126 uint32_t device_index
;
129 pa_usec_t host_latency
;
131 pa_time_event
*time_event
;
133 int auth_cookie_in_property
;
136 static void close_stuff(struct userdata
*u
) {
140 pa_pstream_close(u
->pstream
);
141 pa_pstream_unref(u
->pstream
);
146 pa_pdispatch_unref(u
->pdispatch
);
151 pa_socket_client_unref(u
->client
);
157 pa_sink_disconnect(u
->sink
);
158 pa_sink_unref(u
->sink
);
163 pa_source_disconnect(u
->source
);
164 pa_source_unref(u
->source
);
170 u
->core
->mainloop
->time_free(u
->time_event
);
171 u
->time_event
= NULL
;
175 static void die(struct userdata
*u
) {
178 pa_module_unload_request(u
->module
);
181 static void command_stream_killed(pa_pdispatch
*pd
, PA_GCC_UNUSED
uint32_t command
, PA_GCC_UNUSED
uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
182 struct userdata
*u
= userdata
;
183 assert(pd
&& t
&& u
&& u
->pdispatch
== pd
);
185 pa_log(__FILE__
": stream killed\n");
190 static void send_prebuf_request(struct userdata
*u
) {
193 t
= pa_tagstruct_new(NULL
, 0);
194 pa_tagstruct_putu32(t
, PA_COMMAND_PREBUF_PLAYBACK_STREAM
);
195 pa_tagstruct_putu32(t
, u
->ctag
++);
196 pa_tagstruct_putu32(t
, u
->channel
);
197 pa_pstream_send_tagstruct(u
->pstream
, t
);
200 static void send_bytes(struct userdata
*u
) {
206 while (u
->requested_bytes
> 0) {
208 if (pa_sink_render(u
->sink
, u
->requested_bytes
, &chunk
) < 0) {
211 if (u
->requested_bytes
>= DEFAULT_TLENGTH
-DEFAULT_PREBUF
)
212 send_prebuf_request(u
);
217 pa_pstream_send_memblock(u
->pstream
, u
->channel
, 0, &chunk
);
218 pa_memblock_unref(chunk
.memblock
);
220 if (chunk
.length
> u
->requested_bytes
)
221 u
->requested_bytes
= 0;
223 u
->requested_bytes
-= chunk
.length
;
227 static void command_request(pa_pdispatch
*pd
, uint32_t command
, PA_GCC_UNUSED
uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
228 struct userdata
*u
= userdata
;
229 uint32_t bytes
, channel
;
230 assert(pd
&& command
== PA_COMMAND_REQUEST
&& t
&& u
&& u
->pdispatch
== pd
);
232 if (pa_tagstruct_getu32(t
, &channel
) < 0 ||
233 pa_tagstruct_getu32(t
, &bytes
) < 0 ||
234 !pa_tagstruct_eof(t
)) {
235 pa_log(__FILE__
": invalid protocol reply\n");
240 if (channel
!= u
->channel
) {
241 pa_log(__FILE__
": recieved data for invalid channel\n");
246 u
->requested_bytes
+= bytes
;
252 static void stream_get_latency_callback(pa_pdispatch
*pd
, uint32_t command
, PA_GCC_UNUSED
uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
253 struct userdata
*u
= userdata
;
254 pa_usec_t buffer_usec
, sink_usec
, source_usec
, transport_usec
;
256 uint32_t queue_length
;
258 struct timeval local
, remote
, now
;
261 if (command
!= PA_COMMAND_REPLY
) {
262 if (command
== PA_COMMAND_ERROR
)
263 pa_log(__FILE__
": failed to get latency.\n");
265 pa_log(__FILE__
": protocol error.\n");
270 if (pa_tagstruct_get_usec(t
, &buffer_usec
) < 0 ||
271 pa_tagstruct_get_usec(t
, &sink_usec
) < 0 ||
272 pa_tagstruct_get_usec(t
, &source_usec
) < 0 ||
273 pa_tagstruct_get_boolean(t
, &playing
) < 0 ||
274 pa_tagstruct_getu32(t
, &queue_length
) < 0 ||
275 pa_tagstruct_get_timeval(t
, &local
) < 0 ||
276 pa_tagstruct_get_timeval(t
, &remote
) < 0 ||
277 pa_tagstruct_getu64(t
, &counter
) < 0 ||
278 !pa_tagstruct_eof(t
)) {
279 pa_log(__FILE__
": invalid reply.\n");
284 pa_gettimeofday(&now
);
286 if (pa_timeval_cmp(&local
, &remote
) < 0 && pa_timeval_cmp(&remote
, &now
)) {
287 /* local and remote seem to have synchronized clocks */
289 transport_usec
= pa_timeval_diff(&remote
, &local
);
291 transport_usec
= pa_timeval_diff(&now
, &remote
);
294 transport_usec
= pa_timeval_diff(&now
, &local
)/2;
297 u
->host_latency
= sink_usec
+ transport_usec
;
299 u
->host_latency
= source_usec
+ transport_usec
;
300 if (u
->host_latency
> sink_usec
)
301 u
->host_latency
-= sink_usec
;
306 /* pa_log(__FILE__": estimated host latency: %0.0f usec\n", (double) u->host_latency); */
309 static void request_latency(struct userdata
*u
) {
315 t
= pa_tagstruct_new(NULL
, 0);
317 pa_tagstruct_putu32(t
, PA_COMMAND_GET_PLAYBACK_LATENCY
);
319 pa_tagstruct_putu32(t
, PA_COMMAND_GET_RECORD_LATENCY
);
321 pa_tagstruct_putu32(t
, tag
= u
->ctag
++);
322 pa_tagstruct_putu32(t
, u
->channel
);
324 pa_gettimeofday(&now
);
325 pa_tagstruct_put_timeval(t
, &now
);
326 pa_tagstruct_putu64(t
, 0);
328 pa_pstream_send_tagstruct(u
->pstream
, t
);
329 pa_pdispatch_register_reply(u
->pdispatch
, tag
, DEFAULT_TIMEOUT
, stream_get_latency_callback
, u
);
332 static void create_stream_callback(pa_pdispatch
*pd
, uint32_t command
, PA_GCC_UNUSED
uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
333 struct userdata
*u
= userdata
;
334 assert(pd
&& u
&& u
->pdispatch
== pd
);
336 if (command
!= PA_COMMAND_REPLY
) {
337 if (command
== PA_COMMAND_ERROR
)
338 pa_log(__FILE__
": failed to create stream.\n");
340 pa_log(__FILE__
": protocol error.\n");
345 if (pa_tagstruct_getu32(t
, &u
->channel
) < 0 ||
346 pa_tagstruct_getu32(t
, &u
->device_index
) < 0 ||
348 pa_tagstruct_getu32(t
, &u
->requested_bytes
) < 0 ||
350 !pa_tagstruct_eof(t
)) {
351 pa_log(__FILE__
": invalid reply.\n");
362 static void setup_complete_callback(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
363 struct userdata
*u
= userdata
;
365 char name
[256], un
[128], hn
[128];
366 assert(pd
&& u
&& u
->pdispatch
== pd
);
368 if (command
!= PA_COMMAND_REPLY
|| !pa_tagstruct_eof(t
)) {
369 if (command
== PA_COMMAND_ERROR
)
370 pa_log(__FILE__
": failed to authenticate\n");
372 pa_log(__FILE__
": protocol error.\n");
377 snprintf(name
, sizeof(name
), "Tunnel from host '%s', user '%s', sink '%s'",
378 pa_get_host_name(hn
, sizeof(hn
)),
379 pa_get_user_name(un
, sizeof(un
)),
382 snprintf(name
, sizeof(name
), "Tunnel from host '%s', user '%s', source '%s'",
383 pa_get_host_name(hn
, sizeof(hn
)),
384 pa_get_user_name(un
, sizeof(un
)),
388 reply
= pa_tagstruct_new(NULL
, 0);
389 pa_tagstruct_putu32(reply
, PA_COMMAND_SET_CLIENT_NAME
);
390 pa_tagstruct_putu32(reply
, tag
= u
->ctag
++);
391 pa_tagstruct_puts(reply
, name
);
392 pa_pstream_send_tagstruct(u
->pstream
, reply
);
393 /* We ignore the server's reply here */
395 reply
= pa_tagstruct_new(NULL
, 0);
397 pa_tagstruct_putu32(reply
, PA_COMMAND_CREATE_PLAYBACK_STREAM
);
398 pa_tagstruct_putu32(reply
, tag
= u
->ctag
++);
399 pa_tagstruct_puts(reply
, name
);
400 pa_tagstruct_put_sample_spec(reply
, &u
->sink
->sample_spec
);
401 pa_tagstruct_putu32(reply
, PA_INVALID_INDEX
);
402 pa_tagstruct_puts(reply
, u
->sink_name
);
403 pa_tagstruct_putu32(reply
, DEFAULT_MAXLENGTH
);
404 pa_tagstruct_put_boolean(reply
, 0);
405 pa_tagstruct_putu32(reply
, DEFAULT_TLENGTH
);
406 pa_tagstruct_putu32(reply
, DEFAULT_PREBUF
);
407 pa_tagstruct_putu32(reply
, DEFAULT_MINREQ
);
408 pa_tagstruct_putu32(reply
, PA_VOLUME_NORM
);
410 pa_tagstruct_putu32(reply
, PA_COMMAND_CREATE_RECORD_STREAM
);
411 pa_tagstruct_putu32(reply
, tag
= u
->ctag
++);
412 pa_tagstruct_puts(reply
, name
);
413 pa_tagstruct_put_sample_spec(reply
, &u
->source
->sample_spec
);
414 pa_tagstruct_putu32(reply
, PA_INVALID_INDEX
);
415 pa_tagstruct_puts(reply
, u
->source_name
);
416 pa_tagstruct_putu32(reply
, DEFAULT_MAXLENGTH
);
417 pa_tagstruct_put_boolean(reply
, 0);
418 pa_tagstruct_putu32(reply
, DEFAULT_FRAGSIZE
);
421 pa_pstream_send_tagstruct(u
->pstream
, reply
);
422 pa_pdispatch_register_reply(u
->pdispatch
, tag
, DEFAULT_TIMEOUT
, create_stream_callback
, u
);
425 static void pstream_die_callback(pa_pstream
*p
, void *userdata
) {
426 struct userdata
*u
= userdata
;
429 pa_log(__FILE__
": stream died.\n");
434 static void pstream_packet_callback(pa_pstream
*p
, pa_packet
*packet
, void *userdata
) {
435 struct userdata
*u
= userdata
;
436 assert(p
&& packet
&& u
);
438 if (pa_pdispatch_run(u
->pdispatch
, packet
, u
) < 0) {
439 pa_log(__FILE__
": invalid packet\n");
445 static void pstream_memblock_callback(pa_pstream
*p
, uint32_t channel
, uint32_t delta
, const pa_memchunk
*chunk
, void *userdata
) {
446 struct userdata
*u
= userdata
;
447 assert(p
&& chunk
&& u
);
449 if (channel
!= u
->channel
) {
450 pa_log(__FILE__
": recieved memory block on bad channel.\n");
455 pa_source_post(u
->source
, chunk
);
459 static void on_connection(pa_socket_client
*sc
, pa_iochannel
*io
, void *userdata
) {
460 struct userdata
*u
= userdata
;
463 assert(sc
&& u
&& u
->client
== sc
);
465 pa_socket_client_unref(u
->client
);
469 pa_log(__FILE__
": connection failed.\n");
470 pa_module_unload_request(u
->module
);
474 u
->pstream
= pa_pstream_new(u
->core
->mainloop
, io
, u
->core
->memblock_stat
);
475 u
->pdispatch
= pa_pdispatch_new(u
->core
->mainloop
, command_table
, PA_COMMAND_MAX
);
477 pa_pstream_set_die_callback(u
->pstream
, pstream_die_callback
, u
);
478 pa_pstream_set_recieve_packet_callback(u
->pstream
, pstream_packet_callback
, u
);
480 pa_pstream_set_recieve_memblock_callback(u
->pstream
, pstream_memblock_callback
, u
);
483 t
= pa_tagstruct_new(NULL
, 0);
484 pa_tagstruct_putu32(t
, PA_COMMAND_AUTH
);
485 pa_tagstruct_putu32(t
, tag
= u
->ctag
++);
486 pa_tagstruct_put_arbitrary(t
, u
->auth_cookie
, sizeof(u
->auth_cookie
));
487 pa_pstream_send_tagstruct(u
->pstream
, t
);
488 pa_pdispatch_register_reply(u
->pdispatch
, tag
, DEFAULT_TIMEOUT
, setup_complete_callback
, u
);
493 static void sink_notify(pa_sink
*sink
) {
495 assert(sink
&& sink
->userdata
);
501 static pa_usec_t
sink_get_latency(pa_sink
*sink
) {
505 assert(sink
&& sink
->userdata
);
510 if (l
> u
->requested_bytes
) {
511 l
-= u
->requested_bytes
;
512 usec
+= pa_bytes_to_usec(l
, &u
->sink
->sample_spec
);
515 usec
+= u
->host_latency
;
520 static pa_usec_t
source_get_latency(pa_source
*source
) {
522 assert(source
&& source
->userdata
);
523 u
= source
->userdata
;
525 return u
->host_latency
;
529 static void timeout_callback(pa_mainloop_api
*m
, pa_time_event
*e
, PA_GCC_UNUSED
const struct timeval
*tv
, void *userdata
) {
530 struct userdata
*u
= userdata
;
536 pa_gettimeofday(&ntv
);
537 ntv
.tv_sec
+= LATENCY_INTERVAL
;
538 m
->time_restart(e
, &ntv
);
541 static int load_key(struct userdata
*u
, const char*fn
) {
544 u
->auth_cookie_in_property
= 0;
546 if (!fn
&& pa_authkey_prop_get(u
->core
, PA_NATIVE_COOKIE_PROPERTY_NAME
, u
->auth_cookie
, sizeof(u
->auth_cookie
)) >= 0) {
547 pa_log_debug(__FILE__
": using already loaded auth cookie.\n");
548 pa_authkey_prop_ref(u
->core
, PA_NATIVE_COOKIE_PROPERTY_NAME
);
549 u
->auth_cookie_in_property
= 1;
554 fn
= PA_NATIVE_COOKIE_FILE
;
556 if (pa_authkey_load_auto(fn
, u
->auth_cookie
, sizeof(u
->auth_cookie
)) < 0)
559 pa_log_debug(__FILE__
": loading cookie from disk.\n");
561 if (pa_authkey_prop_put(u
->core
, PA_NATIVE_COOKIE_PROPERTY_NAME
, u
->auth_cookie
, sizeof(u
->auth_cookie
)) >= 0)
562 u
->auth_cookie_in_property
= 1;
567 int pa__init(pa_core
*c
, pa_module
*m
) {
568 pa_modargs
*ma
= NULL
;
569 struct userdata
*u
= NULL
;
574 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
575 pa_log(__FILE__
": failed to parse module arguments\n");
579 u
= pa_xmalloc(sizeof(struct userdata
));
586 u
->server_name
= NULL
;
588 u
->sink_name
= pa_xstrdup(pa_modargs_get_value(ma
, "sink", NULL
));;
590 u
->requested_bytes
= 0;
592 u
->source_name
= pa_xstrdup(pa_modargs_get_value(ma
, "source", NULL
));;
596 u
->device_index
= u
->channel
= PA_INVALID_INDEX
;
598 u
->auth_cookie_in_property
= 0;
599 u
->time_event
= NULL
;
601 if (load_key(u
, pa_modargs_get_value(ma
, "cookie", NULL
)) < 0)
604 if (!(u
->server_name
= pa_xstrdup(pa_modargs_get_value(ma
, "server", NULL
)))) {
605 pa_log(__FILE__
": no server specified.\n");
609 ss
= c
->default_sample_spec
;
610 if (pa_modargs_get_sample_spec(ma
, &ss
) < 0) {
611 pa_log(__FILE__
": invalid sample format specification\n");
615 if (!(u
->client
= pa_socket_client_new_string(c
->mainloop
, u
->server_name
, PA_NATIVE_DEFAULT_PORT
))) {
616 pa_log(__FILE__
": failed to connect to server '%s'\n", u
->server_name
);
623 pa_socket_client_set_callback(u
->client
, on_connection
, u
);
626 if (!(u
->sink
= pa_sink_new(c
, __FILE__
, pa_modargs_get_value(ma
, "sink_name", DEFAULT_SINK_NAME
), 0, &ss
, NULL
))) {
627 pa_log(__FILE__
": failed to create sink.\n");
631 u
->sink
->notify
= sink_notify
;
632 u
->sink
->get_latency
= sink_get_latency
;
633 u
->sink
->userdata
= u
;
634 u
->sink
->description
= pa_sprintf_malloc("Tunnel to '%s%s%s'", u
->sink_name
? u
->sink_name
: "", u
->sink_name
? "@" : "", u
->server_name
);
636 pa_sink_set_owner(u
->sink
, m
);
638 if (!(u
->source
= pa_source_new(c
, __FILE__
, pa_modargs_get_value(ma
, "source_name", DEFAULT_SOURCE_NAME
), 0, &ss
, NULL
))) {
639 pa_log(__FILE__
": failed to create source.\n");
643 u
->source
->get_latency
= source_get_latency
;
644 u
->source
->userdata
= u
;
645 u
->source
->description
= pa_sprintf_malloc("Tunnel to '%s%s%s'", u
->source_name
? u
->source_name
: "", u
->source_name
? "@" : "", u
->server_name
);
647 pa_source_set_owner(u
->source
, m
);
650 pa_gettimeofday(&ntv
);
651 ntv
.tv_sec
+= LATENCY_INTERVAL
;
652 u
->time_event
= c
->mainloop
->time_new(c
->mainloop
, &ntv
, timeout_callback
, u
);
666 void pa__done(pa_core
*c
, pa_module
*m
) {
670 if (!(u
= m
->userdata
))
675 if (u
->auth_cookie_in_property
)
676 pa_authkey_prop_unref(c
, PA_NATIVE_COOKIE_PROPERTY_NAME
);
679 pa_xfree(u
->sink_name
);
681 pa_xfree(u
->source_name
);
683 pa_xfree(u
->server_name
);