4 This file is part of PulseAudio.
6 Copyright 2004-2006 Lennart Poettering
8 PulseAudio is free software; you can redistribute it and/or modify
9 it under the terms of the GNU Lesser General Public License as published
10 by the Free Software Foundation; either version 2 of the License,
11 or (at your option) any later version.
13 PulseAudio is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public License
19 along with PulseAudio; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
38 #include <pulse/xmalloc.h>
40 #include <pulsecore/core-error.h>
41 #include <pulsecore/iochannel.h>
42 #include <pulsecore/sink.h>
43 #include <pulsecore/module.h>
44 #include <pulsecore/core-util.h>
45 #include <pulsecore/modargs.h>
46 #include <pulsecore/log.h>
47 #include <pulsecore/socket-client.h>
48 #include <pulsecore/esound.h>
49 #include <pulsecore/authkey.h>
51 #include "module-esound-sink-symdef.h"
53 PA_MODULE_AUTHOR("Lennart Poettering")
54 PA_MODULE_DESCRIPTION("ESOUND Sink")
55 PA_MODULE_VERSION(PACKAGE_VERSION
)
56 PA_MODULE_USAGE("sink_name=<name for the sink> server=<address> cookie=<filename> format=<sample format> channels=<number of channels> rate=<sample rate>")
58 #define DEFAULT_SINK_NAME "esound_output"
65 pa_socket_client
*client
;
67 pa_defer_event
*defer_event
;
73 size_t write_length
, write_index
;
76 size_t read_length
, read_index
;
78 enum { STATE_AUTH
, STATE_LATENCY
, STATE_RUNNING
, STATE_DEAD
} state
;
86 static const char* const valid_modargs
[] = {
96 static void cancel(struct userdata
*u
) {
99 u
->state
= STATE_DEAD
;
102 pa_iochannel_free(u
->io
);
106 if (u
->defer_event
) {
107 u
->core
->mainloop
->defer_free(u
->defer_event
);
108 u
->defer_event
= NULL
;
112 pa_sink_disconnect(u
->sink
);
113 pa_sink_unref(u
->sink
);
118 pa_module_unload_request(u
->module
);
123 static int do_write(struct userdata
*u
) {
127 if (!pa_iochannel_is_writable(u
->io
))
131 assert(u
->write_index
< u
->write_length
);
133 if ((r
= pa_iochannel_write(u
->io
, (uint8_t*) u
->write_data
+ u
->write_index
, u
->write_length
- u
->write_index
)) <= 0) {
134 pa_log("write() failed: %s", pa_cstrerror(errno
));
139 assert(u
->write_index
<= u
->write_length
);
141 if (u
->write_index
== u
->write_length
) {
143 u
->write_data
= NULL
;
144 u
->write_index
= u
->write_length
= 0;
146 } else if (u
->state
== STATE_RUNNING
) {
147 pa_module_set_used(u
->module
, pa_sink_used_by(u
->sink
));
149 if (!u
->memchunk
.length
)
150 if (pa_sink_render(u
->sink
, 8192, &u
->memchunk
) < 0)
153 assert(u
->memchunk
.memblock
&& u
->memchunk
.length
);
155 if ((r
= pa_iochannel_write(u
->io
, (uint8_t*) u
->memchunk
.memblock
->data
+ u
->memchunk
.index
, u
->memchunk
.length
)) < 0) {
156 pa_log("write() failed: %s", pa_cstrerror(errno
));
160 u
->memchunk
.index
+= r
;
161 u
->memchunk
.length
-= r
;
163 if (u
->memchunk
.length
<= 0) {
164 pa_memblock_unref(u
->memchunk
.memblock
);
165 u
->memchunk
.memblock
= NULL
;
172 static int handle_response(struct userdata
*u
) {
177 assert(u
->read_length
== sizeof(int32_t));
179 /* Process auth data */
180 if (!*(int32_t*) u
->read_data
) {
181 pa_log("Authentication failed: %s", pa_cstrerror(errno
));
185 /* Request latency data */
186 assert(!u
->write_data
);
187 *(int32_t*) (u
->write_data
= pa_xmalloc(u
->write_length
= sizeof(int32_t))) = ESD_PROTO_LATENCY
;
190 u
->state
= STATE_LATENCY
;
192 /* Space for next response */
193 assert(u
->read_length
>= sizeof(int32_t));
195 u
->read_length
= sizeof(int32_t);
199 case STATE_LATENCY
: {
201 assert(u
->read_length
== sizeof(int32_t));
203 /* Process latency info */
204 u
->latency
= (pa_usec_t
) ((double) (*(int32_t*) u
->read_data
) * 1000000 / 44100);
205 if (u
->latency
> 10000000) {
206 pa_log("WARNING! Invalid latency information received from server");
211 assert(!u
->write_data
);
212 p
= u
->write_data
= pa_xmalloc0(u
->write_length
= sizeof(int32_t)*3+ESD_NAME_MAX
);
213 *(p
++) = ESD_PROTO_STREAM_PLAY
;
216 pa_strlcpy((char*) p
, "PulseAudio Tunnel", ESD_NAME_MAX
);
219 u
->state
= STATE_RUNNING
;
221 /* Don't read any further */
222 pa_xfree(u
->read_data
);
224 u
->read_index
= u
->read_length
= 0;
236 static int do_read(struct userdata
*u
) {
239 if (!pa_iochannel_is_readable(u
->io
))
242 if (u
->state
== STATE_AUTH
|| u
->state
== STATE_LATENCY
) {
248 assert(u
->read_index
< u
->read_length
);
250 if ((r
= pa_iochannel_read(u
->io
, (uint8_t*) u
->read_data
+ u
->read_index
, u
->read_length
- u
->read_index
)) <= 0) {
251 pa_log("read() failed: %s", r
< 0 ? pa_cstrerror(errno
) : "EOF");
257 assert(u
->read_index
<= u
->read_length
);
259 if (u
->read_index
== u
->read_length
)
260 return handle_response(u
);
266 static void do_work(struct userdata
*u
) {
269 u
->core
->mainloop
->defer_enable(u
->defer_event
, 0);
271 if (do_read(u
) < 0 || do_write(u
) < 0)
275 static void notify_cb(pa_sink
*s
) {
276 struct userdata
*u
= s
->userdata
;
279 if (pa_iochannel_is_writable(u
->io
))
280 u
->core
->mainloop
->defer_enable(u
->defer_event
, 1);
283 static pa_usec_t
get_latency_cb(pa_sink
*s
) {
284 struct userdata
*u
= s
->userdata
;
289 (u
->memchunk
.memblock
? pa_bytes_to_usec(u
->memchunk
.length
, &s
->sample_spec
) : 0);
292 static void defer_callback(PA_GCC_UNUSED pa_mainloop_api
*m
, PA_GCC_UNUSED pa_defer_event
*e
, void *userdata
) {
293 struct userdata
*u
= userdata
;
298 static void io_callback(PA_GCC_UNUSED pa_iochannel
*io
, void*userdata
) {
299 struct userdata
*u
= userdata
;
304 static void on_connection(PA_GCC_UNUSED pa_socket_client
*c
, pa_iochannel
*io
, void *userdata
) {
305 struct userdata
*u
= userdata
;
307 pa_socket_client_unref(u
->client
);
311 pa_log("connection failed: %s", pa_cstrerror(errno
));
317 pa_iochannel_set_callback(u
->io
, io_callback
, u
);
320 int pa__init(pa_core
*c
, pa_module
*m
) {
321 struct userdata
*u
= NULL
;
324 pa_modargs
*ma
= NULL
;
329 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
330 pa_log("failed to parse module arguments");
334 ss
= c
->default_sample_spec
;
335 if (pa_modargs_get_sample_spec(ma
, &ss
) < 0) {
336 pa_log("invalid sample format specification");
340 if ((ss
.format
!= PA_SAMPLE_U8
&& ss
.format
!= PA_SAMPLE_S16NE
) ||
342 pa_log("esound sample type support is limited to mono/stereo and U8 or S16NE sample data");
346 u
= pa_xmalloc0(sizeof(struct userdata
));
351 (ss
.format
== PA_SAMPLE_U8
? ESD_BITS8
: ESD_BITS16
) |
352 (ss
.channels
== 2 ? ESD_STEREO
: ESD_MONO
);
357 u
->read_data
= u
->write_data
= NULL
;
358 u
->read_index
= u
->write_index
= u
->read_length
= u
->write_length
= 0;
359 u
->state
= STATE_AUTH
;
362 if (!(u
->sink
= pa_sink_new(c
, __FILE__
, pa_modargs_get_value(ma
, "sink_name", DEFAULT_SINK_NAME
), 0, &ss
, NULL
))) {
363 pa_log("failed to create sink.");
367 if (!(u
->client
= pa_socket_client_new_string(u
->core
->mainloop
, p
= pa_modargs_get_value(ma
, "server", ESD_UNIX_SOCKET_NAME
), ESD_DEFAULT_PORT
))) {
368 pa_log("failed to connect to server.");
371 pa_socket_client_set_callback(u
->client
, on_connection
, u
);
373 /* Prepare the initial request */
374 u
->write_data
= pa_xmalloc(u
->write_length
= ESD_KEY_LEN
+ sizeof(int32_t));
375 if (pa_authkey_load_auto(pa_modargs_get_value(ma
, "cookie", ".esd_auth"), u
->write_data
, ESD_KEY_LEN
) < 0) {
376 pa_log("failed to load cookie");
379 *(int32_t*) ((uint8_t*) u
->write_data
+ ESD_KEY_LEN
) = ESD_ENDIAN_KEY
;
381 /* Reserve space for the response */
382 u
->read_data
= pa_xmalloc(u
->read_length
= sizeof(int32_t));
384 u
->sink
->notify
= notify_cb
;
385 u
->sink
->get_latency
= get_latency_cb
;
386 u
->sink
->userdata
= u
;
387 pa_sink_set_owner(u
->sink
, m
);
388 pa_sink_set_description(u
->sink
, t
= pa_sprintf_malloc("Esound sink '%s'", p
));
391 u
->memchunk
.memblock
= NULL
;
392 u
->memchunk
.length
= 0;
394 u
->defer_event
= c
->mainloop
->defer_new(c
->mainloop
, defer_callback
, u
);
395 c
->mainloop
->defer_enable(u
->defer_event
, 0);
411 void pa__done(pa_core
*c
, pa_module
*m
) {
415 if (!(u
= m
->userdata
))
421 if (u
->memchunk
.memblock
)
422 pa_memblock_unref(u
->memchunk
.memblock
);
425 pa_socket_client_unref(u
->client
);
427 pa_xfree(u
->read_data
);
428 pa_xfree(u
->write_data
);