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/xmalloc.h>
45 #include <pulse/timeval.h>
47 #include <pulsecore/core-error.h>
48 #include <pulsecore/iochannel.h>
49 #include <pulsecore/sink.h>
50 #include <pulsecore/module.h>
51 #include <pulsecore/core-util.h>
52 #include <pulsecore/modargs.h>
53 #include <pulsecore/log.h>
54 #include <pulsecore/socket-client.h>
55 #include <pulsecore/esound.h>
56 #include <pulsecore/authkey.h>
57 #include <pulsecore/thread-mq.h>
58 #include <pulsecore/thread.h>
59 #include <pulsecore/time-smoother.h>
60 #include <pulsecore/rtclock.h>
61 #include <pulsecore/socket-util.h>
63 #include "module-esound-sink-symdef.h"
65 PA_MODULE_AUTHOR("Lennart Poettering");
66 PA_MODULE_DESCRIPTION("ESOUND Sink");
67 PA_MODULE_VERSION(PACKAGE_VERSION
);
68 PA_MODULE_LOAD_ONCE(FALSE
);
70 "sink_name=<name for the sink> "
71 "sink_properties=<properties for the sink> "
72 "server=<address> cookie=<filename> "
73 "format=<sample format> "
75 "channels=<number of channels>");
77 #define DEFAULT_SINK_NAME "esound_out"
84 pa_thread_mq thread_mq
;
86 pa_rtpoll_item
*rtpoll_item
;
92 size_t write_length
, write_index
;
95 size_t read_length
, read_index
;
110 pa_smoother
*smoother
;
116 pa_socket_client
*client
;
121 static const char* const valid_modargs
[] = {
133 SINK_MESSAGE_PASS_SOCKET
= PA_SINK_MESSAGE_MAX
136 static int sink_process_msg(pa_msgobject
*o
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
137 struct userdata
*u
= PA_SINK(o
)->userdata
;
141 case PA_SINK_MESSAGE_SET_STATE
:
143 switch ((pa_sink_state_t
) PA_PTR_TO_UINT(data
)) {
145 case PA_SINK_SUSPENDED
:
146 pa_assert(PA_SINK_IS_OPENED(u
->sink
->thread_info
.state
));
148 pa_smoother_pause(u
->smoother
, pa_rtclock_usec());
152 case PA_SINK_RUNNING
:
154 if (u
->sink
->thread_info
.state
== PA_SINK_SUSPENDED
)
155 pa_smoother_resume(u
->smoother
, pa_rtclock_usec(), TRUE
);
159 case PA_SINK_UNLINKED
:
161 case PA_SINK_INVALID_STATE
:
167 case PA_SINK_MESSAGE_GET_LATENCY
: {
170 r
= pa_smoother_get(u
->smoother
, pa_rtclock_usec());
171 w
= pa_bytes_to_usec((uint64_t) u
->offset
+ u
->memchunk
.length
, &u
->sink
->sample_spec
);
173 *((pa_usec_t
*) data
) = w
> r
? w
- r
: 0;
177 case SINK_MESSAGE_PASS_SOCKET
: {
178 struct pollfd
*pollfd
;
180 pa_assert(!u
->rtpoll_item
);
182 u
->rtpoll_item
= pa_rtpoll_item_new(u
->rtpoll
, PA_RTPOLL_NEVER
, 1);
183 pollfd
= pa_rtpoll_item_get_pollfd(u
->rtpoll_item
, NULL
);
185 pollfd
->events
= pollfd
->revents
= 0;
191 return pa_sink_process_msg(o
, code
, data
, offset
, chunk
);
194 static void thread_func(void *userdata
) {
195 struct userdata
*u
= userdata
;
200 pa_log_debug("Thread starting up");
202 pa_thread_mq_install(&u
->thread_mq
);
204 pa_smoother_set_time_offset(u
->smoother
, pa_rtclock_usec());
209 if (PA_SINK_IS_OPENED(u
->sink
->thread_info
.state
))
210 if (u
->sink
->thread_info
.rewind_requested
)
211 pa_sink_process_rewind(u
->sink
, 0);
213 if (u
->rtpoll_item
) {
214 struct pollfd
*pollfd
;
215 pollfd
= pa_rtpoll_item_get_pollfd(u
->rtpoll_item
, NULL
);
217 /* Render some data and write it to the fifo */
218 if (PA_SINK_IS_OPENED(u
->sink
->thread_info
.state
) && pollfd
->revents
) {
226 if (u
->memchunk
.length
<= 0)
227 pa_sink_render(u
->sink
, u
->block_size
, &u
->memchunk
);
229 pa_assert(u
->memchunk
.length
> 0);
231 p
= pa_memblock_acquire(u
->memchunk
.memblock
);
232 l
= pa_write(u
->fd
, (uint8_t*) p
+ u
->memchunk
.index
, u
->memchunk
.length
, &write_type
);
233 pa_memblock_release(u
->memchunk
.memblock
);
241 else if (errno
== EAGAIN
) {
243 /* OK, we filled all socket buffers up
248 pa_log("Failed to write data to FIFO: %s", pa_cstrerror(errno
));
255 u
->memchunk
.index
+= (size_t) l
;
256 u
->memchunk
.length
-= (size_t) l
;
258 if (u
->memchunk
.length
<= 0) {
259 pa_memblock_unref(u
->memchunk
.memblock
);
260 pa_memchunk_reset(&u
->memchunk
);
265 if (u
->memchunk
.length
> 0)
267 /* OK, we wrote less that we asked for,
268 * hence we can assume that the socket
269 * buffers are full now */
276 /* At this spot we know that the socket buffers are
277 * fully filled up. This is the best time to estimate
278 * the playback position of the server */
285 if (ioctl(u
->fd
, SIOCOUTQ
, &l
) >= 0 && l
> 0)
290 usec
= pa_bytes_to_usec((uint64_t) n
, &u
->sink
->sample_spec
);
292 if (usec
> u
->latency
)
297 pa_smoother_put(u
->smoother
, pa_rtclock_usec(), usec
);
300 /* Hmm, nothing to do. Let's sleep */
301 pollfd
->events
= (short) (PA_SINK_IS_OPENED(u
->sink
->thread_info
.state
) ? POLLOUT
: 0);
304 if ((ret
= pa_rtpoll_run(u
->rtpoll
, TRUE
)) < 0)
310 if (u
->rtpoll_item
) {
311 struct pollfd
* pollfd
;
313 pollfd
= pa_rtpoll_item_get_pollfd(u
->rtpoll_item
, NULL
);
315 if (pollfd
->revents
& ~POLLOUT
) {
316 pa_log("FIFO shutdown.");
323 /* If this was no regular exit from the loop we have to continue
324 * processing messages until we received PA_MESSAGE_SHUTDOWN */
325 pa_asyncmsgq_post(u
->thread_mq
.outq
, PA_MSGOBJECT(u
->core
), PA_CORE_MESSAGE_UNLOAD_MODULE
, u
->module
, 0, NULL
, NULL
);
326 pa_asyncmsgq_wait_for(u
->thread_mq
.inq
, PA_MESSAGE_SHUTDOWN
);
329 pa_log_debug("Thread shutting down");
332 static int do_write(struct userdata
*u
) {
336 if (!pa_iochannel_is_writable(u
->io
))
340 pa_assert(u
->write_index
< u
->write_length
);
342 if ((r
= pa_iochannel_write(u
->io
, (uint8_t*) u
->write_data
+ u
->write_index
, u
->write_length
- u
->write_index
)) <= 0) {
343 pa_log("write() failed: %s", pa_cstrerror(errno
));
347 u
->write_index
+= (size_t) r
;
348 pa_assert(u
->write_index
<= u
->write_length
);
350 if (u
->write_index
== u
->write_length
) {
351 pa_xfree(u
->write_data
);
352 u
->write_data
= NULL
;
353 u
->write_index
= u
->write_length
= 0;
357 if (!u
->write_data
&& u
->state
== STATE_PREPARE
) {
359 socklen_t sl
= sizeof(int);
361 /* OK, we're done with sending all control data we need to, so
362 * let's hand the socket over to the IO thread now */
364 pa_assert(u
->fd
< 0);
365 u
->fd
= pa_iochannel_get_send_fd(u
->io
);
367 pa_iochannel_set_noclose(u
->io
, TRUE
);
368 pa_iochannel_free(u
->io
);
371 pa_make_tcp_socket_low_delay(u
->fd
);
373 if (getsockopt(u
->fd
, SOL_SOCKET
, SO_SNDBUF
, &so_sndbuf
, &sl
) < 0)
374 pa_log_warn("getsockopt(SO_SNDBUF) failed: %s", pa_cstrerror(errno
));
376 pa_log_debug("SO_SNDBUF is %zu.", (size_t) so_sndbuf
);
377 pa_sink_set_max_request(u
->sink
, PA_MAX((size_t) so_sndbuf
, u
->block_size
));
380 pa_log_debug("Connection authenticated, handing fd to IO thread...");
382 pa_asyncmsgq_post(u
->thread_mq
.inq
, PA_MSGOBJECT(u
->sink
), SINK_MESSAGE_PASS_SOCKET
, NULL
, 0, NULL
, NULL
);
383 u
->state
= STATE_RUNNING
;
389 static int handle_response(struct userdata
*u
) {
395 pa_assert(u
->read_length
== sizeof(int32_t));
397 /* Process auth data */
398 if (!*(int32_t*) u
->read_data
) {
399 pa_log("Authentication failed: %s", pa_cstrerror(errno
));
403 /* Request latency data */
404 pa_assert(!u
->write_data
);
405 *(int32_t*) (u
->write_data
= pa_xmalloc(u
->write_length
= sizeof(int32_t))) = ESD_PROTO_LATENCY
;
408 u
->state
= STATE_LATENCY
;
410 /* Space for next response */
411 pa_assert(u
->read_length
>= sizeof(int32_t));
413 u
->read_length
= sizeof(int32_t);
417 case STATE_LATENCY
: {
419 pa_assert(u
->read_length
== sizeof(int32_t));
421 /* Process latency info */
422 u
->latency
= (pa_usec_t
) ((double) (*(int32_t*) u
->read_data
) * 1000000 / 44100);
423 if (u
->latency
> 10000000) {
424 pa_log_warn("Invalid latency information received from server");
429 pa_assert(!u
->write_data
);
430 p
= u
->write_data
= pa_xmalloc0(u
->write_length
= sizeof(int32_t)*3+ESD_NAME_MAX
);
431 *(p
++) = ESD_PROTO_STREAM_PLAY
;
434 pa_strlcpy((char*) p
, "PulseAudio Tunnel", ESD_NAME_MAX
);
437 u
->state
= STATE_PREPARE
;
439 /* Don't read any further */
440 pa_xfree(u
->read_data
);
442 u
->read_index
= u
->read_length
= 0;
448 pa_assert_not_reached();
454 static int do_read(struct userdata
*u
) {
457 if (!pa_iochannel_is_readable(u
->io
))
460 if (u
->state
== STATE_AUTH
|| u
->state
== STATE_LATENCY
) {
466 pa_assert(u
->read_index
< u
->read_length
);
468 if ((r
= pa_iochannel_read(u
->io
, (uint8_t*) u
->read_data
+ u
->read_index
, u
->read_length
- u
->read_index
)) <= 0) {
469 pa_log("read() failed: %s", r
< 0 ? pa_cstrerror(errno
) : "EOF");
473 u
->read_index
+= (size_t) r
;
474 pa_assert(u
->read_index
<= u
->read_length
);
476 if (u
->read_index
== u
->read_length
)
477 return handle_response(u
);
483 static void io_callback(pa_iochannel
*io
, void*userdata
) {
484 struct userdata
*u
= userdata
;
487 if (do_read(u
) < 0 || do_write(u
) < 0) {
490 pa_iochannel_free(u
->io
);
494 pa_module_unload_request(u
->module
, TRUE
);
498 static void on_connection(pa_socket_client
*c
, pa_iochannel
*io
, void *userdata
) {
499 struct userdata
*u
= userdata
;
501 pa_socket_client_unref(u
->client
);
505 pa_log("Connection failed: %s", pa_cstrerror(errno
));
506 pa_module_unload_request(u
->module
, TRUE
);
512 pa_iochannel_set_callback(u
->io
, io_callback
, u
);
514 pa_log_debug("Connection established, authenticating ...");
517 int pa__init(pa_module
*m
) {
518 struct userdata
*u
= NULL
;
520 pa_modargs
*ma
= NULL
;
521 const char *espeaker
;
523 pa_sink_new_data data
;
527 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
528 pa_log("failed to parse module arguments");
532 ss
= m
->core
->default_sample_spec
;
533 if (pa_modargs_get_sample_spec(ma
, &ss
) < 0) {
534 pa_log("invalid sample format specification");
538 if ((ss
.format
!= PA_SAMPLE_U8
&& ss
.format
!= PA_SAMPLE_S16NE
) ||
540 pa_log("esound sample type support is limited to mono/stereo and U8 or S16NE sample data");
544 u
= pa_xnew0(struct userdata
, 1);
549 u
->smoother
= pa_smoother_new(
557 pa_memchunk_reset(&u
->memchunk
);
560 u
->rtpoll
= pa_rtpoll_new();
561 pa_thread_mq_init(&u
->thread_mq
, m
->core
->mainloop
, u
->rtpoll
);
562 u
->rtpoll_item
= NULL
;
565 (ss
.format
== PA_SAMPLE_U8
? ESD_BITS8
: ESD_BITS16
) |
566 (ss
.channels
== 2 ? ESD_STEREO
: ESD_MONO
);
567 u
->rate
= (int32_t) ss
.rate
;
568 u
->block_size
= pa_usec_to_bytes(PA_USEC_PER_SEC
/20, &ss
);
570 u
->read_data
= u
->write_data
= NULL
;
571 u
->read_index
= u
->write_index
= u
->read_length
= u
->write_length
= 0;
573 u
->state
= STATE_AUTH
;
576 if (!(espeaker
= getenv("ESPEAKER")))
577 espeaker
= ESD_UNIX_SOCKET_NAME
;
579 espeaker
= pa_modargs_get_value(ma
, "server", espeaker
);
581 pa_sink_new_data_init(&data
);
582 data
.driver
= __FILE__
;
584 pa_sink_new_data_set_name(&data
, pa_modargs_get_value(ma
, "sink_name", DEFAULT_SINK_NAME
));
585 pa_sink_new_data_set_sample_spec(&data
, &ss
);
586 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_STRING
, espeaker
);
587 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_API
, "esd");
588 pa_proplist_setf(data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
, "EsounD Output on %s", espeaker
);
590 if (pa_modargs_get_proplist(ma
, "sink_properties", data
.proplist
, PA_UPDATE_REPLACE
) < 0) {
591 pa_log("Invalid properties");
592 pa_sink_new_data_done(&data
);
596 u
->sink
= pa_sink_new(m
->core
, &data
, PA_SINK_LATENCY
|PA_SINK_NETWORK
);
597 pa_sink_new_data_done(&data
);
600 pa_log("Failed to create sink.");
604 u
->sink
->parent
.process_msg
= sink_process_msg
;
605 u
->sink
->userdata
= u
;
607 pa_sink_set_asyncmsgq(u
->sink
, u
->thread_mq
.inq
);
608 pa_sink_set_rtpoll(u
->sink
, u
->rtpoll
);
610 if (!(u
->client
= pa_socket_client_new_string(u
->core
->mainloop
, espeaker
, ESD_DEFAULT_PORT
))) {
611 pa_log("Failed to connect to server.");
615 pa_socket_client_set_callback(u
->client
, on_connection
, u
);
617 /* Prepare the initial request */
618 u
->write_data
= pa_xmalloc(u
->write_length
= ESD_KEY_LEN
+ sizeof(int32_t));
619 if (pa_authkey_load_auto(pa_modargs_get_value(ma
, "cookie", ".esd_auth"), u
->write_data
, ESD_KEY_LEN
) < 0) {
620 pa_log("Failed to load cookie");
624 key
= ESD_ENDIAN_KEY
;
625 memcpy((uint8_t*) u
->write_data
+ ESD_KEY_LEN
, &key
, sizeof(key
));
627 /* Reserve space for the response */
628 u
->read_data
= pa_xmalloc(u
->read_length
= sizeof(int32_t));
630 if (!(u
->thread
= pa_thread_new(thread_func
, u
))) {
631 pa_log("Failed to create thread.");
635 pa_sink_put(u
->sink
);
650 int pa__get_n_used(pa_module
*m
) {
654 pa_assert_se(u
= m
->userdata
);
656 return pa_sink_linked_by(u
->sink
);
659 void pa__done(pa_module
*m
) {
663 if (!(u
= m
->userdata
))
667 pa_sink_unlink(u
->sink
);
670 pa_asyncmsgq_send(u
->thread_mq
.inq
, NULL
, PA_MESSAGE_SHUTDOWN
, NULL
, 0, NULL
);
671 pa_thread_free(u
->thread
);
674 pa_thread_mq_done(&u
->thread_mq
);
677 pa_sink_unref(u
->sink
);
680 pa_iochannel_free(u
->io
);
683 pa_rtpoll_item_free(u
->rtpoll_item
);
686 pa_rtpoll_free(u
->rtpoll
);
688 if (u
->memchunk
.memblock
)
689 pa_memblock_unref(u
->memchunk
.memblock
);
692 pa_socket_client_unref(u
->client
);
694 pa_xfree(u
->read_data
);
695 pa_xfree(u
->write_data
);
698 pa_smoother_free(u
->smoother
);