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
) {
149 pa_module_set_used(u
->module
, pa_sink_used_by(u
->sink
));
151 if (!u
->memchunk
.length
)
152 if (pa_sink_render(u
->sink
, 8192, &u
->memchunk
) < 0)
155 assert(u
->memchunk
.memblock
);
156 assert(u
->memchunk
.length
);
158 p
= pa_memblock_acquire(u
->memchunk
.memblock
);
160 if ((r
= pa_iochannel_write(u
->io
, (uint8_t*) p
+ u
->memchunk
.index
, u
->memchunk
.length
)) < 0) {
161 pa_memblock_release(u
->memchunk
.memblock
);
162 pa_log("write() failed: %s", pa_cstrerror(errno
));
165 pa_memblock_release(u
->memchunk
.memblock
);
167 u
->memchunk
.index
+= r
;
168 u
->memchunk
.length
-= r
;
170 if (u
->memchunk
.length
<= 0) {
171 pa_memblock_unref(u
->memchunk
.memblock
);
172 u
->memchunk
.memblock
= NULL
;
179 static int handle_response(struct userdata
*u
) {
184 assert(u
->read_length
== sizeof(int32_t));
186 /* Process auth data */
187 if (!*(int32_t*) u
->read_data
) {
188 pa_log("Authentication failed: %s", pa_cstrerror(errno
));
192 /* Request latency data */
193 assert(!u
->write_data
);
194 *(int32_t*) (u
->write_data
= pa_xmalloc(u
->write_length
= sizeof(int32_t))) = ESD_PROTO_LATENCY
;
197 u
->state
= STATE_LATENCY
;
199 /* Space for next response */
200 assert(u
->read_length
>= sizeof(int32_t));
202 u
->read_length
= sizeof(int32_t);
206 case STATE_LATENCY
: {
208 assert(u
->read_length
== sizeof(int32_t));
210 /* Process latency info */
211 u
->latency
= (pa_usec_t
) ((double) (*(int32_t*) u
->read_data
) * 1000000 / 44100);
212 if (u
->latency
> 10000000) {
213 pa_log_warn("Invalid latency information received from server");
218 assert(!u
->write_data
);
219 p
= u
->write_data
= pa_xmalloc0(u
->write_length
= sizeof(int32_t)*3+ESD_NAME_MAX
);
220 *(p
++) = ESD_PROTO_STREAM_PLAY
;
223 pa_strlcpy((char*) p
, "PulseAudio Tunnel", ESD_NAME_MAX
);
226 u
->state
= STATE_RUNNING
;
228 /* Don't read any further */
229 pa_xfree(u
->read_data
);
231 u
->read_index
= u
->read_length
= 0;
243 static int do_read(struct userdata
*u
) {
246 if (!pa_iochannel_is_readable(u
->io
))
249 if (u
->state
== STATE_AUTH
|| u
->state
== STATE_LATENCY
) {
255 assert(u
->read_index
< u
->read_length
);
257 if ((r
= pa_iochannel_read(u
->io
, (uint8_t*) u
->read_data
+ u
->read_index
, u
->read_length
- u
->read_index
)) <= 0) {
258 pa_log("read() failed: %s", r
< 0 ? pa_cstrerror(errno
) : "EOF");
264 assert(u
->read_index
<= u
->read_length
);
266 if (u
->read_index
== u
->read_length
)
267 return handle_response(u
);
273 static void do_work(struct userdata
*u
) {
276 u
->core
->mainloop
->defer_enable(u
->defer_event
, 0);
278 if (do_read(u
) < 0 || do_write(u
) < 0)
282 static void notify_cb(pa_sink
*s
) {
283 struct userdata
*u
= s
->userdata
;
286 if (pa_iochannel_is_writable(u
->io
))
287 u
->core
->mainloop
->defer_enable(u
->defer_event
, 1);
290 static pa_usec_t
get_latency_cb(pa_sink
*s
) {
291 struct userdata
*u
= s
->userdata
;
296 (u
->memchunk
.memblock
? pa_bytes_to_usec(u
->memchunk
.length
, &s
->sample_spec
) : 0);
299 static void defer_callback(PA_GCC_UNUSED pa_mainloop_api
*m
, PA_GCC_UNUSED pa_defer_event
*e
, void *userdata
) {
300 struct userdata
*u
= userdata
;
305 static void io_callback(PA_GCC_UNUSED pa_iochannel
*io
, void*userdata
) {
306 struct userdata
*u
= userdata
;
311 static void on_connection(PA_GCC_UNUSED pa_socket_client
*c
, pa_iochannel
*io
, void *userdata
) {
312 struct userdata
*u
= userdata
;
314 pa_socket_client_unref(u
->client
);
318 pa_log("connection failed: %s", pa_cstrerror(errno
));
324 pa_iochannel_set_callback(u
->io
, io_callback
, u
);
327 int pa__init(pa_core
*c
, pa_module
*m
) {
328 struct userdata
*u
= NULL
;
331 pa_modargs
*ma
= NULL
;
336 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
337 pa_log("failed to parse module arguments");
341 ss
= c
->default_sample_spec
;
342 if (pa_modargs_get_sample_spec(ma
, &ss
) < 0) {
343 pa_log("invalid sample format specification");
347 if ((ss
.format
!= PA_SAMPLE_U8
&& ss
.format
!= PA_SAMPLE_S16NE
) ||
349 pa_log("esound sample type support is limited to mono/stereo and U8 or S16NE sample data");
353 u
= pa_xmalloc0(sizeof(struct userdata
));
358 (ss
.format
== PA_SAMPLE_U8
? ESD_BITS8
: ESD_BITS16
) |
359 (ss
.channels
== 2 ? ESD_STEREO
: ESD_MONO
);
364 u
->read_data
= u
->write_data
= NULL
;
365 u
->read_index
= u
->write_index
= u
->read_length
= u
->write_length
= 0;
366 u
->state
= STATE_AUTH
;
369 if (!(u
->sink
= pa_sink_new(c
, __FILE__
, pa_modargs_get_value(ma
, "sink_name", DEFAULT_SINK_NAME
), 0, &ss
, NULL
))) {
370 pa_log("failed to create sink.");
374 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
))) {
375 pa_log("failed to connect to server.");
378 pa_socket_client_set_callback(u
->client
, on_connection
, u
);
380 /* Prepare the initial request */
381 u
->write_data
= pa_xmalloc(u
->write_length
= ESD_KEY_LEN
+ sizeof(int32_t));
382 if (pa_authkey_load_auto(pa_modargs_get_value(ma
, "cookie", ".esd_auth"), u
->write_data
, ESD_KEY_LEN
) < 0) {
383 pa_log("failed to load cookie");
386 *(int32_t*) ((uint8_t*) u
->write_data
+ ESD_KEY_LEN
) = ESD_ENDIAN_KEY
;
388 /* Reserve space for the response */
389 u
->read_data
= pa_xmalloc(u
->read_length
= sizeof(int32_t));
391 u
->sink
->notify
= notify_cb
;
392 u
->sink
->get_latency
= get_latency_cb
;
393 u
->sink
->userdata
= u
;
394 pa_sink_set_owner(u
->sink
, m
);
395 pa_sink_set_description(u
->sink
, t
= pa_sprintf_malloc("Esound sink '%s'", p
));
398 u
->memchunk
.memblock
= NULL
;
399 u
->memchunk
.length
= 0;
401 u
->defer_event
= c
->mainloop
->defer_new(c
->mainloop
, defer_callback
, u
);
402 c
->mainloop
->defer_enable(u
->defer_event
, 0);
418 void pa__done(pa_core
*c
, pa_module
*m
) {
422 if (!(u
= m
->userdata
))
428 if (u
->memchunk
.memblock
)
429 pa_memblock_unref(u
->memchunk
.memblock
);
432 pa_socket_client_unref(u
->client
);
434 pa_xfree(u
->read_data
);
435 pa_xfree(u
->write_data
);