2 This file is part of PulseAudio.
4 Copyright 2004-2006 Lennart Poettering
6 PulseAudio 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.1 of the License,
9 or (at your option) any later version.
11 PulseAudio 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 PulseAudio; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
35 #include <sys/socket.h>
36 #include <netinet/in.h>
37 #include <netinet/tcp.h>
38 #include <sys/ioctl.h>
40 #ifdef HAVE_LINUX_SOCKIOS_H
41 #include <linux/sockios.h>
44 #include <pulse/rtclock.h>
45 #include <pulse/timeval.h>
46 #include <pulse/xmalloc.h>
48 #include <pulsecore/core-error.h>
49 #include <pulsecore/iochannel.h>
50 #include <pulsecore/sink.h>
51 #include <pulsecore/module.h>
52 #include <pulsecore/core-rtclock.h>
53 #include <pulsecore/core-util.h>
54 #include <pulsecore/modargs.h>
55 #include <pulsecore/log.h>
56 #include <pulsecore/socket-client.h>
57 #include <pulsecore/esound.h>
58 #include <pulsecore/authkey.h>
59 #include <pulsecore/thread-mq.h>
60 #include <pulsecore/thread.h>
61 #include <pulsecore/time-smoother.h>
62 #include <pulsecore/socket-util.h>
64 #include "module-esound-sink-symdef.h"
66 PA_MODULE_AUTHOR("Lennart Poettering");
67 PA_MODULE_DESCRIPTION("ESOUND Sink");
68 PA_MODULE_VERSION(PACKAGE_VERSION
);
69 PA_MODULE_LOAD_ONCE(FALSE
);
71 "sink_name=<name for the sink> "
72 "sink_properties=<properties for the sink> "
73 "server=<address> cookie=<filename> "
74 "format=<sample format> "
76 "channels=<number of channels>");
78 #define DEFAULT_SINK_NAME "esound_out"
85 pa_thread_mq thread_mq
;
87 pa_rtpoll_item
*rtpoll_item
;
93 size_t write_length
, write_index
;
96 size_t read_length
, read_index
;
111 pa_smoother
*smoother
;
117 pa_socket_client
*client
;
122 static const char* const valid_modargs
[] = {
134 SINK_MESSAGE_PASS_SOCKET
= PA_SINK_MESSAGE_MAX
137 static int sink_process_msg(pa_msgobject
*o
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
138 struct userdata
*u
= PA_SINK(o
)->userdata
;
142 case PA_SINK_MESSAGE_SET_STATE
:
144 switch ((pa_sink_state_t
) PA_PTR_TO_UINT(data
)) {
146 case PA_SINK_SUSPENDED
:
147 pa_assert(PA_SINK_IS_OPENED(u
->sink
->thread_info
.state
));
149 pa_smoother_pause(u
->smoother
, pa_rtclock_now());
153 case PA_SINK_RUNNING
:
155 if (u
->sink
->thread_info
.state
== PA_SINK_SUSPENDED
)
156 pa_smoother_resume(u
->smoother
, pa_rtclock_now(), TRUE
);
160 case PA_SINK_UNLINKED
:
162 case PA_SINK_INVALID_STATE
:
168 case PA_SINK_MESSAGE_GET_LATENCY
: {
171 r
= pa_smoother_get(u
->smoother
, pa_rtclock_now());
172 w
= pa_bytes_to_usec((uint64_t) u
->offset
+ u
->memchunk
.length
, &u
->sink
->sample_spec
);
174 *((pa_usec_t
*) data
) = w
> r
? w
- r
: 0;
178 case SINK_MESSAGE_PASS_SOCKET
: {
179 struct pollfd
*pollfd
;
181 pa_assert(!u
->rtpoll_item
);
183 u
->rtpoll_item
= pa_rtpoll_item_new(u
->rtpoll
, PA_RTPOLL_NEVER
, 1);
184 pollfd
= pa_rtpoll_item_get_pollfd(u
->rtpoll_item
, NULL
);
186 pollfd
->events
= pollfd
->revents
= 0;
192 return pa_sink_process_msg(o
, code
, data
, offset
, chunk
);
195 static void thread_func(void *userdata
) {
196 struct userdata
*u
= userdata
;
201 pa_log_debug("Thread starting up");
203 pa_thread_mq_install(&u
->thread_mq
);
204 pa_rtpoll_install(u
->rtpoll
);
206 pa_smoother_set_time_offset(u
->smoother
, pa_rtclock_now());
211 if (PA_SINK_IS_OPENED(u
->sink
->thread_info
.state
))
212 if (u
->sink
->thread_info
.rewind_requested
)
213 pa_sink_process_rewind(u
->sink
, 0);
215 if (u
->rtpoll_item
) {
216 struct pollfd
*pollfd
;
217 pollfd
= pa_rtpoll_item_get_pollfd(u
->rtpoll_item
, NULL
);
219 /* Render some data and write it to the fifo */
220 if (PA_SINK_IS_OPENED(u
->sink
->thread_info
.state
) && pollfd
->revents
) {
228 if (u
->memchunk
.length
<= 0)
229 pa_sink_render(u
->sink
, u
->block_size
, &u
->memchunk
);
231 pa_assert(u
->memchunk
.length
> 0);
233 p
= pa_memblock_acquire(u
->memchunk
.memblock
);
234 l
= pa_write(u
->fd
, (uint8_t*) p
+ u
->memchunk
.index
, u
->memchunk
.length
, &write_type
);
235 pa_memblock_release(u
->memchunk
.memblock
);
243 else if (errno
== EAGAIN
) {
245 /* OK, we filled all socket buffers up
250 pa_log("Failed to write data to FIFO: %s", pa_cstrerror(errno
));
257 u
->memchunk
.index
+= (size_t) l
;
258 u
->memchunk
.length
-= (size_t) l
;
260 if (u
->memchunk
.length
<= 0) {
261 pa_memblock_unref(u
->memchunk
.memblock
);
262 pa_memchunk_reset(&u
->memchunk
);
267 if (u
->memchunk
.length
> 0)
269 /* OK, we wrote less that we asked for,
270 * hence we can assume that the socket
271 * buffers are full now */
278 /* At this spot we know that the socket buffers are
279 * fully filled up. This is the best time to estimate
280 * the playback position of the server */
287 if (ioctl(u
->fd
, SIOCOUTQ
, &l
) >= 0 && l
> 0)
292 usec
= pa_bytes_to_usec((uint64_t) n
, &u
->sink
->sample_spec
);
294 if (usec
> u
->latency
)
299 pa_smoother_put(u
->smoother
, pa_rtclock_now(), usec
);
302 /* Hmm, nothing to do. Let's sleep */
303 pollfd
->events
= (short) (PA_SINK_IS_OPENED(u
->sink
->thread_info
.state
) ? POLLOUT
: 0);
306 if ((ret
= pa_rtpoll_run(u
->rtpoll
, TRUE
)) < 0)
312 if (u
->rtpoll_item
) {
313 struct pollfd
* pollfd
;
315 pollfd
= pa_rtpoll_item_get_pollfd(u
->rtpoll_item
, NULL
);
317 if (pollfd
->revents
& ~POLLOUT
) {
318 pa_log("FIFO shutdown.");
325 /* If this was no regular exit from the loop we have to continue
326 * processing messages until we received PA_MESSAGE_SHUTDOWN */
327 pa_asyncmsgq_post(u
->thread_mq
.outq
, PA_MSGOBJECT(u
->core
), PA_CORE_MESSAGE_UNLOAD_MODULE
, u
->module
, 0, NULL
, NULL
);
328 pa_asyncmsgq_wait_for(u
->thread_mq
.inq
, PA_MESSAGE_SHUTDOWN
);
331 pa_log_debug("Thread shutting down");
334 static int do_write(struct userdata
*u
) {
338 if (!pa_iochannel_is_writable(u
->io
))
342 pa_assert(u
->write_index
< u
->write_length
);
344 if ((r
= pa_iochannel_write(u
->io
, (uint8_t*) u
->write_data
+ u
->write_index
, u
->write_length
- u
->write_index
)) <= 0) {
345 pa_log("write() failed: %s", pa_cstrerror(errno
));
349 u
->write_index
+= (size_t) r
;
350 pa_assert(u
->write_index
<= u
->write_length
);
352 if (u
->write_index
== u
->write_length
) {
353 pa_xfree(u
->write_data
);
354 u
->write_data
= NULL
;
355 u
->write_index
= u
->write_length
= 0;
359 if (!u
->write_data
&& u
->state
== STATE_PREPARE
) {
361 socklen_t sl
= sizeof(int);
363 /* OK, we're done with sending all control data we need to, so
364 * let's hand the socket over to the IO thread now */
366 pa_assert(u
->fd
< 0);
367 u
->fd
= pa_iochannel_get_send_fd(u
->io
);
369 pa_iochannel_set_noclose(u
->io
, TRUE
);
370 pa_iochannel_free(u
->io
);
373 pa_make_tcp_socket_low_delay(u
->fd
);
375 if (getsockopt(u
->fd
, SOL_SOCKET
, SO_SNDBUF
, &so_sndbuf
, &sl
) < 0)
376 pa_log_warn("getsockopt(SO_SNDBUF) failed: %s", pa_cstrerror(errno
));
378 pa_log_debug("SO_SNDBUF is %zu.", (size_t) so_sndbuf
);
379 pa_sink_set_max_request(u
->sink
, PA_MAX((size_t) so_sndbuf
, u
->block_size
));
382 pa_log_debug("Connection authenticated, handing fd to IO thread...");
384 pa_asyncmsgq_post(u
->thread_mq
.inq
, PA_MSGOBJECT(u
->sink
), SINK_MESSAGE_PASS_SOCKET
, NULL
, 0, NULL
, NULL
);
385 u
->state
= STATE_RUNNING
;
391 static int handle_response(struct userdata
*u
) {
397 pa_assert(u
->read_length
== sizeof(int32_t));
399 /* Process auth data */
400 if (!*(int32_t*) u
->read_data
) {
401 pa_log("Authentication failed: %s", pa_cstrerror(errno
));
405 /* Request latency data */
406 pa_assert(!u
->write_data
);
407 *(int32_t*) (u
->write_data
= pa_xmalloc(u
->write_length
= sizeof(int32_t))) = ESD_PROTO_LATENCY
;
410 u
->state
= STATE_LATENCY
;
412 /* Space for next response */
413 pa_assert(u
->read_length
>= sizeof(int32_t));
415 u
->read_length
= sizeof(int32_t);
419 case STATE_LATENCY
: {
421 pa_assert(u
->read_length
== sizeof(int32_t));
423 /* Process latency info */
424 u
->latency
= (pa_usec_t
) ((double) (*(int32_t*) u
->read_data
) * 1000000 / 44100);
425 if (u
->latency
> 10000000) {
426 pa_log_warn("Invalid latency information received from server");
431 pa_assert(!u
->write_data
);
432 p
= u
->write_data
= pa_xmalloc0(u
->write_length
= sizeof(int32_t)*3+ESD_NAME_MAX
);
433 *(p
++) = ESD_PROTO_STREAM_PLAY
;
436 pa_strlcpy((char*) p
, "PulseAudio Tunnel", ESD_NAME_MAX
);
439 u
->state
= STATE_PREPARE
;
441 /* Don't read any further */
442 pa_xfree(u
->read_data
);
444 u
->read_index
= u
->read_length
= 0;
450 pa_assert_not_reached();
456 static int do_read(struct userdata
*u
) {
459 if (!pa_iochannel_is_readable(u
->io
))
462 if (u
->state
== STATE_AUTH
|| u
->state
== STATE_LATENCY
) {
468 pa_assert(u
->read_index
< u
->read_length
);
470 if ((r
= pa_iochannel_read(u
->io
, (uint8_t*) u
->read_data
+ u
->read_index
, u
->read_length
- u
->read_index
)) <= 0) {
471 pa_log("read() failed: %s", r
< 0 ? pa_cstrerror(errno
) : "EOF");
475 u
->read_index
+= (size_t) r
;
476 pa_assert(u
->read_index
<= u
->read_length
);
478 if (u
->read_index
== u
->read_length
)
479 return handle_response(u
);
485 static void io_callback(pa_iochannel
*io
, void*userdata
) {
486 struct userdata
*u
= userdata
;
489 if (do_read(u
) < 0 || do_write(u
) < 0) {
492 pa_iochannel_free(u
->io
);
496 pa_module_unload_request(u
->module
, TRUE
);
500 static void on_connection(pa_socket_client
*c
, pa_iochannel
*io
, void *userdata
) {
501 struct userdata
*u
= userdata
;
503 pa_socket_client_unref(u
->client
);
507 pa_log("Connection failed: %s", pa_cstrerror(errno
));
508 pa_module_unload_request(u
->module
, TRUE
);
514 pa_iochannel_set_callback(u
->io
, io_callback
, u
);
516 pa_log_debug("Connection established, authenticating ...");
519 int pa__init(pa_module
*m
) {
520 struct userdata
*u
= NULL
;
522 pa_modargs
*ma
= NULL
;
523 const char *espeaker
;
525 pa_sink_new_data data
;
529 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
530 pa_log("failed to parse module arguments");
534 ss
= m
->core
->default_sample_spec
;
535 if (pa_modargs_get_sample_spec(ma
, &ss
) < 0) {
536 pa_log("invalid sample format specification");
540 if ((ss
.format
!= PA_SAMPLE_U8
&& ss
.format
!= PA_SAMPLE_S16NE
) ||
542 pa_log("esound sample type support is limited to mono/stereo and U8 or S16NE sample data");
546 u
= pa_xnew0(struct userdata
, 1);
551 u
->smoother
= pa_smoother_new(
559 pa_memchunk_reset(&u
->memchunk
);
562 u
->rtpoll
= pa_rtpoll_new();
563 pa_thread_mq_init(&u
->thread_mq
, m
->core
->mainloop
, u
->rtpoll
);
564 u
->rtpoll_item
= NULL
;
567 (ss
.format
== PA_SAMPLE_U8
? ESD_BITS8
: ESD_BITS16
) |
568 (ss
.channels
== 2 ? ESD_STEREO
: ESD_MONO
);
569 u
->rate
= (int32_t) ss
.rate
;
570 u
->block_size
= pa_usec_to_bytes(PA_USEC_PER_SEC
/20, &ss
);
572 u
->read_data
= u
->write_data
= NULL
;
573 u
->read_index
= u
->write_index
= u
->read_length
= u
->write_length
= 0;
575 u
->state
= STATE_AUTH
;
578 if (!(espeaker
= getenv("ESPEAKER")))
579 espeaker
= ESD_UNIX_SOCKET_NAME
;
581 espeaker
= pa_modargs_get_value(ma
, "server", espeaker
);
583 pa_sink_new_data_init(&data
);
584 data
.driver
= __FILE__
;
586 pa_sink_new_data_set_name(&data
, pa_modargs_get_value(ma
, "sink_name", DEFAULT_SINK_NAME
));
587 pa_sink_new_data_set_sample_spec(&data
, &ss
);
588 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_STRING
, espeaker
);
589 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_API
, "esd");
590 pa_proplist_setf(data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
, "EsounD Output on %s", espeaker
);
592 if (pa_modargs_get_proplist(ma
, "sink_properties", data
.proplist
, PA_UPDATE_REPLACE
) < 0) {
593 pa_log("Invalid properties");
594 pa_sink_new_data_done(&data
);
598 u
->sink
= pa_sink_new(m
->core
, &data
, PA_SINK_LATENCY
|PA_SINK_NETWORK
);
599 pa_sink_new_data_done(&data
);
602 pa_log("Failed to create sink.");
606 u
->sink
->parent
.process_msg
= sink_process_msg
;
607 u
->sink
->userdata
= u
;
609 pa_sink_set_asyncmsgq(u
->sink
, u
->thread_mq
.inq
);
610 pa_sink_set_rtpoll(u
->sink
, u
->rtpoll
);
612 if (!(u
->client
= pa_socket_client_new_string(u
->core
->mainloop
, espeaker
, ESD_DEFAULT_PORT
))) {
613 pa_log("Failed to connect to server.");
617 pa_socket_client_set_callback(u
->client
, on_connection
, u
);
619 /* Prepare the initial request */
620 u
->write_data
= pa_xmalloc(u
->write_length
= ESD_KEY_LEN
+ sizeof(int32_t));
621 if (pa_authkey_load_auto(pa_modargs_get_value(ma
, "cookie", ".esd_auth"), u
->write_data
, ESD_KEY_LEN
) < 0) {
622 pa_log("Failed to load cookie");
626 key
= ESD_ENDIAN_KEY
;
627 memcpy((uint8_t*) u
->write_data
+ ESD_KEY_LEN
, &key
, sizeof(key
));
629 /* Reserve space for the response */
630 u
->read_data
= pa_xmalloc(u
->read_length
= sizeof(int32_t));
632 if (!(u
->thread
= pa_thread_new(thread_func
, u
))) {
633 pa_log("Failed to create thread.");
637 pa_sink_put(u
->sink
);
652 int pa__get_n_used(pa_module
*m
) {
656 pa_assert_se(u
= m
->userdata
);
658 return pa_sink_linked_by(u
->sink
);
661 void pa__done(pa_module
*m
) {
665 if (!(u
= m
->userdata
))
669 pa_sink_unlink(u
->sink
);
672 pa_asyncmsgq_send(u
->thread_mq
.inq
, NULL
, PA_MESSAGE_SHUTDOWN
, NULL
, 0, NULL
);
673 pa_thread_free(u
->thread
);
676 pa_thread_mq_done(&u
->thread_mq
);
679 pa_sink_unref(u
->sink
);
682 pa_iochannel_free(u
->io
);
685 pa_rtpoll_item_free(u
->rtpoll_item
);
688 pa_rtpoll_free(u
->rtpoll
);
690 if (u
->memchunk
.memblock
)
691 pa_memblock_unref(u
->memchunk
.memblock
);
694 pa_socket_client_unref(u
->client
);
696 pa_xfree(u
->read_data
);
697 pa_xfree(u
->write_data
);
700 pa_smoother_free(u
->smoother
);