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 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 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>
39 #include "subscribe.h"
41 #include "sink-input.h"
42 #include "pdispatch.h"
44 #include "pstream-util.h"
46 #include "socket-client.h"
47 #include "socket-util.h"
49 PA_MODULE_AUTHOR("Lennart Poettering")
50 PA_MODULE_VERSION(PACKAGE_VERSION
)
53 PA_MODULE_DESCRIPTION("Tunnel module for sinks")
54 PA_MODULE_USAGE("server=<filename> sink=<remote sink name> cookie=<filename> format=<sample format> channels=<number of channels> rate=<sample rate> sink_name=<name for the local sink>")
56 PA_MODULE_DESCRIPTION("Tunnel module for sources")
57 PA_MODULE_USAGE("server=<filename> source=<remote source name> cookie=<filename> format=<sample format> channels=<number of channels> rate=<sample rate> source_name=<name for the local source>")
60 #define DEFAULT_SINK_NAME "tunnel"
61 #define DEFAULT_SOURCE_NAME "tunnel"
63 #define DEFAULT_TLENGTH (44100*2*2/10) //(10240*8)
64 #define DEFAULT_MAXLENGTH ((DEFAULT_TLENGTH*3)/2)
65 #define DEFAULT_MINREQ 512
66 #define DEFAULT_PREBUF (DEFAULT_TLENGTH-DEFAULT_MINREQ)
67 #define DEFAULT_FRAGSIZE 1024
69 #define DEFAULT_TIMEOUT 5
71 #define LATENCY_INTERVAL 10
73 static const char* const valid_modargs
[] = {
89 static void command_stream_killed(struct pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, struct pa_tagstruct
*t
, void *userdata
);
92 static void command_request(struct pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, struct pa_tagstruct
*t
, void *userdata
);
95 static const struct pa_pdispatch_command command_table
[PA_COMMAND_MAX
] = {
97 [PA_COMMAND_REQUEST
] = { command_request
},
99 [PA_COMMAND_PLAYBACK_STREAM_KILLED
] = { command_stream_killed
},
100 [PA_COMMAND_RECORD_STREAM_KILLED
] = { command_stream_killed
},
104 struct pa_socket_client
*client
;
105 struct pa_pstream
*pstream
;
106 struct pa_pdispatch
*pdispatch
;
111 struct pa_sink
*sink
;
112 uint32_t requested_bytes
;
115 struct pa_source
*source
;
118 struct pa_module
*module
;
119 struct pa_core
*core
;
121 uint8_t auth_cookie
[PA_NATIVE_COOKIE_LENGTH
];
124 uint32_t device_index
;
127 pa_usec_t host_latency
;
129 struct pa_time_event
*time_event
;
133 static void close_stuff(struct userdata
*u
) {
135 pa_pstream_close(u
->pstream
);
136 pa_pstream_unref(u
->pstream
);
141 pa_pdispatch_unref(u
->pdispatch
);
146 pa_socket_client_unref(u
->client
);
152 pa_sink_disconnect(u
->sink
);
153 pa_sink_unref(u
->sink
);
158 pa_source_disconnect(u
->source
);
159 pa_source_unref(u
->source
);
165 u
->core
->mainloop
->time_free(u
->time_event
);
166 u
->time_event
= NULL
;
170 static void die(struct userdata
*u
) {
173 pa_module_unload_request(u
->module
);
176 static void command_stream_killed(struct pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, struct pa_tagstruct
*t
, void *userdata
) {
177 struct userdata
*u
= userdata
;
178 assert(pd
&& t
&& u
&& u
->pdispatch
== pd
);
180 pa_log(__FILE__
": stream killed\n");
185 static void send_prebuf_request(struct userdata
*u
) {
186 struct pa_tagstruct
*t
;
188 t
= pa_tagstruct_new(NULL
, 0);
189 pa_tagstruct_putu32(t
, PA_COMMAND_PREBUF_PLAYBACK_STREAM
);
190 pa_tagstruct_putu32(t
, u
->ctag
++);
191 pa_tagstruct_putu32(t
, u
->channel
);
192 pa_pstream_send_tagstruct(u
->pstream
, t
);
195 static void send_bytes(struct userdata
*u
) {
201 while (u
->requested_bytes
> 0) {
202 struct pa_memchunk chunk
;
203 if (pa_sink_render(u
->sink
, u
->requested_bytes
, &chunk
) < 0) {
206 if (u
->requested_bytes
>= DEFAULT_TLENGTH
-DEFAULT_PREBUF
)
207 send_prebuf_request(u
);
212 pa_pstream_send_memblock(u
->pstream
, u
->channel
, 0, &chunk
);
213 pa_memblock_unref(chunk
.memblock
);
215 if (chunk
.length
> u
->requested_bytes
)
216 u
->requested_bytes
= 0;
218 u
->requested_bytes
-= chunk
.length
;
222 static void command_request(struct pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, struct pa_tagstruct
*t
, void *userdata
) {
223 struct userdata
*u
= userdata
;
224 uint32_t bytes
, channel
;
225 assert(pd
&& command
== PA_COMMAND_REQUEST
&& t
&& u
&& u
->pdispatch
== pd
);
227 if (pa_tagstruct_getu32(t
, &channel
) < 0 ||
228 pa_tagstruct_getu32(t
, &bytes
) < 0 ||
229 !pa_tagstruct_eof(t
)) {
230 pa_log(__FILE__
": invalid protocol reply\n");
235 if (channel
!= u
->channel
) {
236 pa_log(__FILE__
": recieved data for invalid channel\n");
241 u
->requested_bytes
+= bytes
;
247 static void stream_get_latency_callback(struct pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, struct pa_tagstruct
*t
, void *userdata
) {
248 struct userdata
*u
= userdata
;
249 pa_usec_t buffer_usec
, sink_usec
, source_usec
, transport_usec
;
251 uint32_t queue_length
;
252 struct timeval local
, remote
, now
;
253 assert(pd
&& u
&& t
);
255 if (command
!= PA_COMMAND_REPLY
) {
256 if (command
== PA_COMMAND_ERROR
)
257 pa_log(__FILE__
": failed to get latency.\n");
259 pa_log(__FILE__
": protocol error.\n");
264 if (pa_tagstruct_get_usec(t
, &buffer_usec
) < 0 ||
265 pa_tagstruct_get_usec(t
, &sink_usec
) < 0 ||
266 pa_tagstruct_get_usec(t
, &source_usec
) < 0 ||
267 pa_tagstruct_get_boolean(t
, &playing
) < 0 ||
268 pa_tagstruct_getu32(t
, &queue_length
) < 0 ||
269 pa_tagstruct_get_timeval(t
, &local
) < 0 ||
270 pa_tagstruct_get_timeval(t
, &remote
) < 0 ||
271 !pa_tagstruct_eof(t
)) {
272 pa_log(__FILE__
": invalid reply.\n");
277 gettimeofday(&now
, NULL
);
279 if (pa_timeval_cmp(&local
, &remote
) < 0 && pa_timeval_cmp(&remote
, &now
)) {
280 /* local and remote seem to have synchronized clocks */
282 transport_usec
= pa_timeval_diff(&remote
, &local
);
284 transport_usec
= pa_timeval_diff(&now
, &remote
);
287 transport_usec
= pa_timeval_diff(&now
, &local
)/2;
290 u
->host_latency
= sink_usec
+ transport_usec
;
292 u
->host_latency
= source_usec
+ transport_usec
;
293 if (u
->host_latency
> sink_usec
)
294 u
->host_latency
-= sink_usec
;
299 /* pa_log(__FILE__": estimated host latency: %0.0f usec\n", (double) u->host_latency); */
302 static void request_latency(struct userdata
*u
) {
303 struct pa_tagstruct
*t
;
308 t
= pa_tagstruct_new(NULL
, 0);
310 pa_tagstruct_putu32(t
, PA_COMMAND_GET_PLAYBACK_LATENCY
);
312 pa_tagstruct_putu32(t
, PA_COMMAND_GET_RECORD_LATENCY
);
314 pa_tagstruct_putu32(t
, tag
= u
->ctag
++);
315 pa_tagstruct_putu32(t
, u
->channel
);
317 gettimeofday(&now
, NULL
);
318 pa_tagstruct_put_timeval(t
, &now
);
320 pa_pstream_send_tagstruct(u
->pstream
, t
);
321 pa_pdispatch_register_reply(u
->pdispatch
, tag
, DEFAULT_TIMEOUT
, stream_get_latency_callback
, u
);
324 static void create_stream_callback(struct pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, struct pa_tagstruct
*t
, void *userdata
) {
325 struct userdata
*u
= userdata
;
326 assert(pd
&& u
&& u
->pdispatch
== pd
);
328 if (command
!= PA_COMMAND_REPLY
) {
329 if (command
== PA_COMMAND_ERROR
)
330 pa_log(__FILE__
": failed to create stream.\n");
332 pa_log(__FILE__
": protocol error.\n");
337 if (pa_tagstruct_getu32(t
, &u
->channel
) < 0 ||
338 pa_tagstruct_getu32(t
, &u
->device_index
) < 0 ||
340 pa_tagstruct_getu32(t
, &u
->requested_bytes
) < 0 ||
342 !pa_tagstruct_eof(t
)) {
343 pa_log(__FILE__
": invalid reply.\n");
354 static void setup_complete_callback(struct pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, struct pa_tagstruct
*t
, void *userdata
) {
355 struct userdata
*u
= userdata
;
356 struct pa_tagstruct
*reply
;
357 char name
[256], un
[128], hn
[128];
358 assert(pd
&& u
&& u
->pdispatch
== pd
);
360 if (command
!= PA_COMMAND_REPLY
|| !pa_tagstruct_eof(t
)) {
361 if (command
== PA_COMMAND_ERROR
)
362 pa_log(__FILE__
": failed to authenticate\n");
364 pa_log(__FILE__
": protocol error.\n");
369 snprintf(name
, sizeof(name
), "Tunnel from host '%s', user '%s', sink '%s'",
370 pa_get_host_name(hn
, sizeof(hn
)),
371 pa_get_user_name(un
, sizeof(un
)),
374 snprintf(name
, sizeof(name
), "Tunnel from host '%s', user '%s', source '%s'",
375 pa_get_host_name(hn
, sizeof(hn
)),
376 pa_get_user_name(un
, sizeof(un
)),
380 reply
= pa_tagstruct_new(NULL
, 0);
381 pa_tagstruct_putu32(reply
, PA_COMMAND_SET_CLIENT_NAME
);
382 pa_tagstruct_putu32(reply
, tag
= u
->ctag
++);
383 pa_tagstruct_puts(reply
, name
);
384 pa_pstream_send_tagstruct(u
->pstream
, reply
);
385 /* We ignore the server's reply here */
387 reply
= pa_tagstruct_new(NULL
, 0);
389 pa_tagstruct_putu32(reply
, PA_COMMAND_CREATE_PLAYBACK_STREAM
);
390 pa_tagstruct_putu32(reply
, tag
= u
->ctag
++);
391 pa_tagstruct_puts(reply
, name
);
392 pa_tagstruct_put_sample_spec(reply
, &u
->sink
->sample_spec
);
393 pa_tagstruct_putu32(reply
, PA_INVALID_INDEX
);
394 pa_tagstruct_puts(reply
, u
->sink_name
);
395 pa_tagstruct_putu32(reply
, DEFAULT_MAXLENGTH
);
396 pa_tagstruct_put_boolean(reply
, 0);
397 pa_tagstruct_putu32(reply
, DEFAULT_TLENGTH
);
398 pa_tagstruct_putu32(reply
, DEFAULT_PREBUF
);
399 pa_tagstruct_putu32(reply
, DEFAULT_MINREQ
);
400 pa_tagstruct_putu32(reply
, PA_VOLUME_NORM
);
402 pa_tagstruct_putu32(reply
, PA_COMMAND_CREATE_RECORD_STREAM
);
403 pa_tagstruct_putu32(reply
, tag
= u
->ctag
++);
404 pa_tagstruct_puts(reply
, name
);
405 pa_tagstruct_put_sample_spec(reply
, &u
->source
->sample_spec
);
406 pa_tagstruct_putu32(reply
, PA_INVALID_INDEX
);
407 pa_tagstruct_puts(reply
, u
->source_name
);
408 pa_tagstruct_putu32(reply
, DEFAULT_MAXLENGTH
);
409 pa_tagstruct_put_boolean(reply
, 0);
410 pa_tagstruct_putu32(reply
, DEFAULT_FRAGSIZE
);
413 pa_pstream_send_tagstruct(u
->pstream
, reply
);
414 pa_pdispatch_register_reply(u
->pdispatch
, tag
, DEFAULT_TIMEOUT
, create_stream_callback
, u
);
417 static void pstream_die_callback(struct pa_pstream
*p
, void *userdata
) {
418 struct userdata
*u
= userdata
;
421 pa_log(__FILE__
": stream died.\n");
426 static void pstream_packet_callback(struct pa_pstream
*p
, struct pa_packet
*packet
, void *userdata
) {
427 struct userdata
*u
= userdata
;
428 assert(p
&& packet
&& u
);
430 if (pa_pdispatch_run(u
->pdispatch
, packet
, u
) < 0) {
431 pa_log(__FILE__
": invalid packet\n");
437 static void pstream_memblock_callback(struct pa_pstream
*p
, uint32_t channel
, uint32_t delta
, const struct pa_memchunk
*chunk
, void *userdata
) {
438 struct userdata
*u
= userdata
;
439 assert(p
&& chunk
&& u
);
441 if (channel
!= u
->channel
) {
442 pa_log(__FILE__
": recieved memory block on bad channel.\n");
447 pa_source_post(u
->source
, chunk
);
451 static void on_connection(struct pa_socket_client
*sc
, struct pa_iochannel
*io
, void *userdata
) {
452 struct userdata
*u
= userdata
;
453 struct pa_tagstruct
*t
;
455 assert(sc
&& u
&& u
->client
== sc
);
457 pa_socket_client_unref(u
->client
);
461 pa_log(__FILE__
": connection failed.\n");
462 pa_module_unload_request(u
->module
);
466 u
->pstream
= pa_pstream_new(u
->core
->mainloop
, io
, u
->core
->memblock_stat
);
467 u
->pdispatch
= pa_pdispatch_new(u
->core
->mainloop
, command_table
, PA_COMMAND_MAX
);
469 pa_pstream_set_die_callback(u
->pstream
, pstream_die_callback
, u
);
470 pa_pstream_set_recieve_packet_callback(u
->pstream
, pstream_packet_callback
, u
);
472 pa_pstream_set_recieve_memblock_callback(u
->pstream
, pstream_memblock_callback
, u
);
475 t
= pa_tagstruct_new(NULL
, 0);
476 pa_tagstruct_putu32(t
, PA_COMMAND_AUTH
);
477 pa_tagstruct_putu32(t
, tag
= u
->ctag
++);
478 pa_tagstruct_put_arbitrary(t
, u
->auth_cookie
, sizeof(u
->auth_cookie
));
479 pa_pstream_send_tagstruct(u
->pstream
, t
);
480 pa_pdispatch_register_reply(u
->pdispatch
, tag
, DEFAULT_TIMEOUT
, setup_complete_callback
, u
);
485 static void sink_notify(struct pa_sink
*sink
) {
487 assert(sink
&& sink
->userdata
);
493 static pa_usec_t
sink_get_latency(struct pa_sink
*sink
) {
497 assert(sink
&& sink
->userdata
);
502 if (l
> u
->requested_bytes
) {
503 l
-= u
->requested_bytes
;
504 usec
+= pa_bytes_to_usec(l
, &u
->sink
->sample_spec
);
507 usec
+= u
->host_latency
;
512 static pa_usec_t
source_get_latency(struct pa_source
*source
) {
514 assert(source
&& source
->userdata
);
515 u
= source
->userdata
;
517 return u
->host_latency
;
521 static void timeout_callback(struct pa_mainloop_api
*m
, struct pa_time_event
*e
, const struct timeval
*tv
, void *userdata
) {
522 struct userdata
*u
= userdata
;
528 gettimeofday(&ntv
, NULL
);
529 ntv
.tv_sec
+= LATENCY_INTERVAL
;
530 m
->time_restart(e
, &ntv
);
533 int pa__init(struct pa_core
*c
, struct pa_module
*m
) {
534 struct pa_modargs
*ma
= NULL
;
535 struct userdata
*u
= NULL
;
536 struct pa_sample_spec ss
;
540 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
541 pa_log(__FILE__
": failed to parse module arguments\n");
545 u
= pa_xmalloc(sizeof(struct userdata
));
552 u
->server_name
= NULL
;
554 u
->sink_name
= pa_xstrdup(pa_modargs_get_value(ma
, "sink", NULL
));;
556 u
->requested_bytes
= 0;
558 u
->source_name
= pa_xstrdup(pa_modargs_get_value(ma
, "source", NULL
));;
562 u
->device_index
= u
->channel
= PA_INVALID_INDEX
;
565 if (pa_authkey_load_from_home(pa_modargs_get_value(ma
, "cookie", PA_NATIVE_COOKIE_FILE
), u
->auth_cookie
, sizeof(u
->auth_cookie
)) < 0) {
566 pa_log(__FILE__
": failed to load cookie.\n");
570 if (!(u
->server_name
= pa_xstrdup(pa_modargs_get_value(ma
, "server", NULL
)))) {
571 pa_log(__FILE__
": no server specified.\n");
575 ss
= c
->default_sample_spec
;
576 if (pa_modargs_get_sample_spec(ma
, &ss
) < 0) {
577 pa_log(__FILE__
": invalid sample format specification\n");
581 if (u
->server_name
[0] == '/')
582 u
->client
= pa_socket_client_new_unix(c
->mainloop
, u
->server_name
);
587 if (!(sa
= pa_resolve_server(u
->server_name
, &len
, PA_NATIVE_DEFAULT_PORT
))) {
588 pa_log(__FILE__
": failed to resolve server '%s'\n", u
->server_name
);
592 u
->client
= pa_socket_client_new_sockaddr(c
->mainloop
, sa
, len
);
599 pa_socket_client_set_callback(u
->client
, on_connection
, u
);
602 if (!(u
->sink
= pa_sink_new(c
, pa_modargs_get_value(ma
, "sink_name", DEFAULT_SINK_NAME
), 0, &ss
))) {
603 pa_log(__FILE__
": failed to create sink.\n");
607 u
->sink
->notify
= sink_notify
;
608 u
->sink
->get_latency
= sink_get_latency
;
609 u
->sink
->userdata
= u
;
610 u
->sink
->description
= pa_sprintf_malloc("Tunnel to '%s%s%s'", u
->sink_name
? u
->sink_name
: "", u
->sink_name
? "@" : "", u
->server_name
);
612 pa_sink_set_owner(u
->sink
, m
);
614 if (!(u
->source
= pa_source_new(c
, pa_modargs_get_value(ma
, "source_name", DEFAULT_SOURCE_NAME
), 0, &ss
))) {
615 pa_log(__FILE__
": failed to create source.\n");
619 u
->source
->get_latency
= source_get_latency
;
620 u
->source
->userdata
= u
;
621 u
->source
->description
= pa_sprintf_malloc("Tunnel to '%s%s%s'", u
->source_name
? u
->source_name
: "", u
->source_name
? "@" : "", u
->server_name
);
623 pa_source_set_owner(u
->source
, m
);
626 gettimeofday(&ntv
, NULL
);
627 ntv
.tv_sec
+= LATENCY_INTERVAL
;
628 u
->time_event
= c
->mainloop
->time_new(c
->mainloop
, &ntv
, timeout_callback
, u
);
642 void pa__done(struct pa_core
*c
, struct pa_module
*m
) {
646 if (!(u
= m
->userdata
))
652 pa_xfree(u
->sink_name
);
654 pa_xfree(u
->source_name
);
656 pa_xfree(u
->server_name
);