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 #ifdef HAVE_NETINET_IN_H
36 #include <netinet/in.h>
39 #ifdef HAVE_NETINET_TCP_H
40 #include <netinet/tcp.h>
43 #ifdef HAVE_SYS_IOCTL_H
44 #include <sys/ioctl.h>
47 #ifdef HAVE_LINUX_SOCKIOS_H
48 #include <linux/sockios.h>
51 #include <pulse/rtclock.h>
52 #include <pulse/timeval.h>
53 #include <pulse/xmalloc.h>
55 #include <pulsecore/socket.h>
56 #include <pulsecore/core-error.h>
57 #include <pulsecore/iochannel.h>
58 #include <pulsecore/sink.h>
59 #include <pulsecore/module.h>
60 #include <pulsecore/core-rtclock.h>
61 #include <pulsecore/core-util.h>
62 #include <pulsecore/modargs.h>
63 #include <pulsecore/log.h>
64 #include <pulsecore/socket-client.h>
65 #include <pulsecore/esound.h>
66 #include <pulsecore/authkey.h>
67 #include <pulsecore/thread-mq.h>
68 #include <pulsecore/thread.h>
69 #include <pulsecore/time-smoother.h>
70 #include <pulsecore/socket-util.h>
71 #include <pulsecore/rtpoll.h>
72 #include <pulsecore/poll.h>
74 #include "module-esound-sink-symdef.h"
76 PA_MODULE_AUTHOR("Lennart Poettering");
77 PA_MODULE_DESCRIPTION("ESOUND Sink");
78 PA_MODULE_VERSION(PACKAGE_VERSION
);
79 PA_MODULE_LOAD_ONCE(FALSE
);
81 "sink_name=<name for the sink> "
82 "sink_properties=<properties for the sink> "
83 "server=<address> cookie=<filename> "
84 "format=<sample format> "
86 "channels=<number of channels>");
88 #define DEFAULT_SINK_NAME "esound_out"
95 pa_thread_mq thread_mq
;
97 pa_rtpoll_item
*rtpoll_item
;
100 pa_memchunk memchunk
;
103 size_t write_length
, write_index
;
106 size_t read_length
, read_index
;
121 pa_smoother
*smoother
;
127 pa_socket_client
*client
;
132 static const char* const valid_modargs
[] = {
144 SINK_MESSAGE_PASS_SOCKET
= PA_SINK_MESSAGE_MAX
147 static int sink_process_msg(pa_msgobject
*o
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
148 struct userdata
*u
= PA_SINK(o
)->userdata
;
152 case PA_SINK_MESSAGE_SET_STATE
:
154 switch ((pa_sink_state_t
) PA_PTR_TO_UINT(data
)) {
156 case PA_SINK_SUSPENDED
:
157 pa_assert(PA_SINK_IS_OPENED(u
->sink
->thread_info
.state
));
159 pa_smoother_pause(u
->smoother
, pa_rtclock_now());
163 case PA_SINK_RUNNING
:
165 if (u
->sink
->thread_info
.state
== PA_SINK_SUSPENDED
)
166 pa_smoother_resume(u
->smoother
, pa_rtclock_now(), TRUE
);
170 case PA_SINK_UNLINKED
:
172 case PA_SINK_INVALID_STATE
:
178 case PA_SINK_MESSAGE_GET_LATENCY
: {
181 r
= pa_smoother_get(u
->smoother
, pa_rtclock_now());
182 w
= pa_bytes_to_usec((uint64_t) u
->offset
+ u
->memchunk
.length
, &u
->sink
->sample_spec
);
184 *((pa_usec_t
*) data
) = w
> r
? w
- r
: 0;
188 case SINK_MESSAGE_PASS_SOCKET
: {
189 struct pollfd
*pollfd
;
191 pa_assert(!u
->rtpoll_item
);
193 u
->rtpoll_item
= pa_rtpoll_item_new(u
->rtpoll
, PA_RTPOLL_NEVER
, 1);
194 pollfd
= pa_rtpoll_item_get_pollfd(u
->rtpoll_item
, NULL
);
196 pollfd
->events
= pollfd
->revents
= 0;
202 return pa_sink_process_msg(o
, code
, data
, offset
, chunk
);
205 static void thread_func(void *userdata
) {
206 struct userdata
*u
= userdata
;
211 pa_log_debug("Thread starting up");
213 pa_thread_mq_install(&u
->thread_mq
);
215 pa_smoother_set_time_offset(u
->smoother
, pa_rtclock_now());
220 if (PA_SINK_IS_OPENED(u
->sink
->thread_info
.state
))
221 if (u
->sink
->thread_info
.rewind_requested
)
222 pa_sink_process_rewind(u
->sink
, 0);
224 if (u
->rtpoll_item
) {
225 struct pollfd
*pollfd
;
226 pollfd
= pa_rtpoll_item_get_pollfd(u
->rtpoll_item
, NULL
);
228 /* Render some data and write it to the fifo */
229 if (PA_SINK_IS_OPENED(u
->sink
->thread_info
.state
) && pollfd
->revents
) {
237 if (u
->memchunk
.length
<= 0)
238 pa_sink_render(u
->sink
, u
->block_size
, &u
->memchunk
);
240 pa_assert(u
->memchunk
.length
> 0);
242 p
= pa_memblock_acquire(u
->memchunk
.memblock
);
243 l
= pa_write(u
->fd
, (uint8_t*) p
+ u
->memchunk
.index
, u
->memchunk
.length
, &write_type
);
244 pa_memblock_release(u
->memchunk
.memblock
);
252 else if (errno
== EAGAIN
) {
254 /* OK, we filled all socket buffers up
259 pa_log("Failed to write data to FIFO: %s", pa_cstrerror(errno
));
266 u
->memchunk
.index
+= (size_t) l
;
267 u
->memchunk
.length
-= (size_t) l
;
269 if (u
->memchunk
.length
<= 0) {
270 pa_memblock_unref(u
->memchunk
.memblock
);
271 pa_memchunk_reset(&u
->memchunk
);
276 if (u
->memchunk
.length
> 0)
278 /* OK, we wrote less that we asked for,
279 * hence we can assume that the socket
280 * buffers are full now */
287 /* At this spot we know that the socket buffers are
288 * fully filled up. This is the best time to estimate
289 * the playback position of the server */
296 if (ioctl(u
->fd
, SIOCOUTQ
, &l
) >= 0 && l
> 0)
301 usec
= pa_bytes_to_usec((uint64_t) n
, &u
->sink
->sample_spec
);
303 if (usec
> u
->latency
)
308 pa_smoother_put(u
->smoother
, pa_rtclock_now(), usec
);
311 /* Hmm, nothing to do. Let's sleep */
312 pollfd
->events
= (short) (PA_SINK_IS_OPENED(u
->sink
->thread_info
.state
) ? POLLOUT
: 0);
315 if ((ret
= pa_rtpoll_run(u
->rtpoll
, TRUE
)) < 0)
321 if (u
->rtpoll_item
) {
322 struct pollfd
* pollfd
;
324 pollfd
= pa_rtpoll_item_get_pollfd(u
->rtpoll_item
, NULL
);
326 if (pollfd
->revents
& ~POLLOUT
) {
327 pa_log("FIFO shutdown.");
334 /* If this was no regular exit from the loop we have to continue
335 * processing messages until we received PA_MESSAGE_SHUTDOWN */
336 pa_asyncmsgq_post(u
->thread_mq
.outq
, PA_MSGOBJECT(u
->core
), PA_CORE_MESSAGE_UNLOAD_MODULE
, u
->module
, 0, NULL
, NULL
);
337 pa_asyncmsgq_wait_for(u
->thread_mq
.inq
, PA_MESSAGE_SHUTDOWN
);
340 pa_log_debug("Thread shutting down");
343 static int do_write(struct userdata
*u
) {
347 if (!pa_iochannel_is_writable(u
->io
))
351 pa_assert(u
->write_index
< u
->write_length
);
353 if ((r
= pa_iochannel_write(u
->io
, (uint8_t*) u
->write_data
+ u
->write_index
, u
->write_length
- u
->write_index
)) <= 0) {
354 pa_log("write() failed: %s", pa_cstrerror(errno
));
358 u
->write_index
+= (size_t) r
;
359 pa_assert(u
->write_index
<= u
->write_length
);
361 if (u
->write_index
== u
->write_length
) {
362 pa_xfree(u
->write_data
);
363 u
->write_data
= NULL
;
364 u
->write_index
= u
->write_length
= 0;
368 if (!u
->write_data
&& u
->state
== STATE_PREPARE
) {
370 socklen_t sl
= sizeof(int);
372 /* OK, we're done with sending all control data we need to, so
373 * let's hand the socket over to the IO thread now */
375 pa_assert(u
->fd
< 0);
376 u
->fd
= pa_iochannel_get_send_fd(u
->io
);
378 pa_iochannel_set_noclose(u
->io
, TRUE
);
379 pa_iochannel_free(u
->io
);
382 pa_make_tcp_socket_low_delay(u
->fd
);
384 if (getsockopt(u
->fd
, SOL_SOCKET
, SO_SNDBUF
, &so_sndbuf
, &sl
) < 0)
385 pa_log_warn("getsockopt(SO_SNDBUF) failed: %s", pa_cstrerror(errno
));
387 pa_log_debug("SO_SNDBUF is %zu.", (size_t) so_sndbuf
);
388 pa_sink_set_max_request(u
->sink
, PA_MAX((size_t) so_sndbuf
, u
->block_size
));
391 pa_log_debug("Connection authenticated, handing fd to IO thread...");
393 pa_asyncmsgq_post(u
->thread_mq
.inq
, PA_MSGOBJECT(u
->sink
), SINK_MESSAGE_PASS_SOCKET
, NULL
, 0, NULL
, NULL
);
394 u
->state
= STATE_RUNNING
;
400 static int handle_response(struct userdata
*u
) {
406 pa_assert(u
->read_length
== sizeof(int32_t));
408 /* Process auth data */
409 if (!*(int32_t*) u
->read_data
) {
410 pa_log("Authentication failed: %s", pa_cstrerror(errno
));
414 /* Request latency data */
415 pa_assert(!u
->write_data
);
416 *(int32_t*) (u
->write_data
= pa_xmalloc(u
->write_length
= sizeof(int32_t))) = ESD_PROTO_LATENCY
;
419 u
->state
= STATE_LATENCY
;
421 /* Space for next response */
422 pa_assert(u
->read_length
>= sizeof(int32_t));
424 u
->read_length
= sizeof(int32_t);
428 case STATE_LATENCY
: {
430 pa_assert(u
->read_length
== sizeof(int32_t));
432 /* Process latency info */
433 u
->latency
= (pa_usec_t
) ((double) (*(int32_t*) u
->read_data
) * 1000000 / 44100);
434 if (u
->latency
> 10000000) {
435 pa_log_warn("Invalid latency information received from server");
440 pa_assert(!u
->write_data
);
441 p
= u
->write_data
= pa_xmalloc0(u
->write_length
= sizeof(int32_t)*3+ESD_NAME_MAX
);
442 *(p
++) = ESD_PROTO_STREAM_PLAY
;
445 pa_strlcpy((char*) p
, "PulseAudio Tunnel", ESD_NAME_MAX
);
448 u
->state
= STATE_PREPARE
;
450 /* Don't read any further */
451 pa_xfree(u
->read_data
);
453 u
->read_index
= u
->read_length
= 0;
459 pa_assert_not_reached();
465 static int do_read(struct userdata
*u
) {
468 if (!pa_iochannel_is_readable(u
->io
))
471 if (u
->state
== STATE_AUTH
|| u
->state
== STATE_LATENCY
) {
477 pa_assert(u
->read_index
< u
->read_length
);
479 if ((r
= pa_iochannel_read(u
->io
, (uint8_t*) u
->read_data
+ u
->read_index
, u
->read_length
- u
->read_index
)) <= 0) {
480 pa_log("read() failed: %s", r
< 0 ? pa_cstrerror(errno
) : "EOF");
484 u
->read_index
+= (size_t) r
;
485 pa_assert(u
->read_index
<= u
->read_length
);
487 if (u
->read_index
== u
->read_length
)
488 return handle_response(u
);
494 static void io_callback(pa_iochannel
*io
, void*userdata
) {
495 struct userdata
*u
= userdata
;
498 if (do_read(u
) < 0 || do_write(u
) < 0) {
501 pa_iochannel_free(u
->io
);
505 pa_module_unload_request(u
->module
, TRUE
);
509 static void on_connection(pa_socket_client
*c
, pa_iochannel
*io
, void *userdata
) {
510 struct userdata
*u
= userdata
;
512 pa_socket_client_unref(u
->client
);
516 pa_log("Connection failed: %s", pa_cstrerror(errno
));
517 pa_module_unload_request(u
->module
, TRUE
);
523 pa_iochannel_set_callback(u
->io
, io_callback
, u
);
525 pa_log_debug("Connection established, authenticating ...");
528 int pa__init(pa_module
*m
) {
529 struct userdata
*u
= NULL
;
531 pa_modargs
*ma
= NULL
;
532 const char *espeaker
;
534 pa_sink_new_data data
;
538 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
539 pa_log("failed to parse module arguments");
543 ss
= m
->core
->default_sample_spec
;
544 if (pa_modargs_get_sample_spec(ma
, &ss
) < 0) {
545 pa_log("invalid sample format specification");
549 if ((ss
.format
!= PA_SAMPLE_U8
&& ss
.format
!= PA_SAMPLE_S16NE
) ||
551 pa_log("esound sample type support is limited to mono/stereo and U8 or S16NE sample data");
555 u
= pa_xnew0(struct userdata
, 1);
560 u
->smoother
= pa_smoother_new(
568 pa_memchunk_reset(&u
->memchunk
);
571 u
->rtpoll
= pa_rtpoll_new();
572 pa_thread_mq_init(&u
->thread_mq
, m
->core
->mainloop
, u
->rtpoll
);
573 u
->rtpoll_item
= NULL
;
576 (ss
.format
== PA_SAMPLE_U8
? ESD_BITS8
: ESD_BITS16
) |
577 (ss
.channels
== 2 ? ESD_STEREO
: ESD_MONO
);
578 u
->rate
= (int32_t) ss
.rate
;
579 u
->block_size
= pa_usec_to_bytes(PA_USEC_PER_SEC
/20, &ss
);
581 u
->read_data
= u
->write_data
= NULL
;
582 u
->read_index
= u
->write_index
= u
->read_length
= u
->write_length
= 0;
584 u
->state
= STATE_AUTH
;
587 if (!(espeaker
= getenv("ESPEAKER")))
588 espeaker
= ESD_UNIX_SOCKET_NAME
;
590 espeaker
= pa_modargs_get_value(ma
, "server", espeaker
);
592 pa_sink_new_data_init(&data
);
593 data
.driver
= __FILE__
;
595 pa_sink_new_data_set_name(&data
, pa_modargs_get_value(ma
, "sink_name", DEFAULT_SINK_NAME
));
596 pa_sink_new_data_set_sample_spec(&data
, &ss
);
597 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_STRING
, espeaker
);
598 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_API
, "esd");
599 pa_proplist_setf(data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
, "EsounD Output on %s", espeaker
);
601 if (pa_modargs_get_proplist(ma
, "sink_properties", data
.proplist
, PA_UPDATE_REPLACE
) < 0) {
602 pa_log("Invalid properties");
603 pa_sink_new_data_done(&data
);
607 u
->sink
= pa_sink_new(m
->core
, &data
, PA_SINK_LATENCY
|PA_SINK_NETWORK
);
608 pa_sink_new_data_done(&data
);
611 pa_log("Failed to create sink.");
615 u
->sink
->parent
.process_msg
= sink_process_msg
;
616 u
->sink
->userdata
= u
;
618 pa_sink_set_asyncmsgq(u
->sink
, u
->thread_mq
.inq
);
619 pa_sink_set_rtpoll(u
->sink
, u
->rtpoll
);
621 if (!(u
->client
= pa_socket_client_new_string(u
->core
->mainloop
, TRUE
, espeaker
, ESD_DEFAULT_PORT
))) {
622 pa_log("Failed to connect to server.");
626 pa_socket_client_set_callback(u
->client
, on_connection
, u
);
628 /* Prepare the initial request */
629 u
->write_data
= pa_xmalloc(u
->write_length
= ESD_KEY_LEN
+ sizeof(int32_t));
630 if (pa_authkey_load_auto(pa_modargs_get_value(ma
, "cookie", ".esd_auth"), u
->write_data
, ESD_KEY_LEN
) < 0) {
631 pa_log("Failed to load cookie");
635 key
= ESD_ENDIAN_KEY
;
636 memcpy((uint8_t*) u
->write_data
+ ESD_KEY_LEN
, &key
, sizeof(key
));
638 /* Reserve space for the response */
639 u
->read_data
= pa_xmalloc(u
->read_length
= sizeof(int32_t));
641 if (!(u
->thread
= pa_thread_new("esound-sink", thread_func
, u
))) {
642 pa_log("Failed to create thread.");
646 pa_sink_put(u
->sink
);
661 int pa__get_n_used(pa_module
*m
) {
665 pa_assert_se(u
= m
->userdata
);
667 return pa_sink_linked_by(u
->sink
);
670 void pa__done(pa_module
*m
) {
674 if (!(u
= m
->userdata
))
678 pa_sink_unlink(u
->sink
);
681 pa_asyncmsgq_send(u
->thread_mq
.inq
, NULL
, PA_MESSAGE_SHUTDOWN
, NULL
, 0, NULL
);
682 pa_thread_free(u
->thread
);
685 pa_thread_mq_done(&u
->thread_mq
);
688 pa_sink_unref(u
->sink
);
691 pa_iochannel_free(u
->io
);
694 pa_rtpoll_item_free(u
->rtpoll_item
);
697 pa_rtpoll_free(u
->rtpoll
);
699 if (u
->memchunk
.memblock
)
700 pa_memblock_unref(u
->memchunk
.memblock
);
703 pa_socket_client_unref(u
->client
);
705 pa_xfree(u
->read_data
);
706 pa_xfree(u
->write_data
);
709 pa_smoother_free(u
->smoother
);