4 This file is part of PulseAudio.
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 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
33 #include <pulse/sample.h>
34 #include <pulse/timeval.h>
35 #include <pulse/utf8.h>
36 #include <pulse/xmalloc.h>
38 #include <pulsecore/esound.h>
39 #include <pulsecore/memblock.h>
40 #include <pulsecore/client.h>
41 #include <pulsecore/sink-input.h>
42 #include <pulsecore/sink.h>
43 #include <pulsecore/source-output.h>
44 #include <pulsecore/source.h>
45 #include <pulsecore/core-scache.h>
46 #include <pulsecore/sample-util.h>
47 #include <pulsecore/authkey.h>
48 #include <pulsecore/namereg.h>
49 #include <pulsecore/log.h>
50 #include <pulsecore/core-util.h>
51 #include <pulsecore/core-error.h>
52 #include <pulsecore/ipacl.h>
54 #include "endianmacros.h"
56 #include "protocol-esound.h"
58 /* Don't accept more connection than this */
59 #define MAX_CONNECTIONS 64
61 /* Kick a client if it doesn't authenticate within this time */
62 #define AUTH_TIMEOUT 5
64 #define DEFAULT_COOKIE_FILE ".esd_auth"
66 #define PLAYBACK_BUFFER_SECONDS (.25)
67 #define PLAYBACK_BUFFER_FRAGMENTS (10)
68 #define RECORD_BUFFER_SECONDS (5)
69 #define RECORD_BUFFER_FRAGMENTS (100)
71 #define MAX_CACHE_SAMPLE_SIZE (1024000)
73 #define SCACHE_PREFIX "esound."
75 /* This is heavily based on esound's code */
80 pa_protocol_esound *protocol;
83 int authorized, swap_byte_order;
85 size_t write_data_alloc, write_data_index, write_data_length;
87 size_t read_data_alloc, read_data_length;
89 esd_client_state_t state;
90 pa_sink_input *sink_input;
91 pa_source_output *source_output;
92 pa_memblockq *input_memblockq, *output_memblockq;
93 pa_defer_event *defer_event;
98 pa_memblock *current_memblock;
99 size_t memblock_index, fragment_size;
103 pa_memchunk memchunk;
105 pa_sample_spec sample_spec;
108 pa_time_event *auth_timeout_event;
111 struct pa_protocol_esound {
115 pa_socket_server *server;
116 pa_idxset *connections;
117 char *sink_name, *source_name;
119 uint8_t esd_key[ESD_KEY_LEN];
120 pa_ip_acl *auth_ip_acl;
123 typedef struct proto_handler {
125 int (*proc)(struct connection *c, esd_proto_t request, const void *data, size_t length);
126 const char *description;
127 } esd_proto_handler_info_t;
129 static void sink_input_drop_cb(pa_sink_input *i, const pa_memchunk *chunk, size_t length);
130 static int sink_input_peek_cb(pa_sink_input *i, pa_memchunk *chunk);
131 static void sink_input_kill_cb(pa_sink_input *i);
132 static pa_usec_t sink_input_get_latency_cb(pa_sink_input *i);
133 static pa_usec_t source_output_get_latency_cb(pa_source_output *o);
135 static void source_output_push_cb(pa_source_output *o, const pa_memchunk *chunk);
136 static void source_output_kill_cb(pa_source_output *o);
138 static int esd_proto_connect(struct connection *c, esd_proto_t request, const void *data, size_t length);
139 static int esd_proto_stream_play(struct connection *c, esd_proto_t request, const void *data, size_t length);
140 static int esd_proto_stream_record(struct connection *c, esd_proto_t request, const void *data, size_t length);
141 static int esd_proto_get_latency(struct connection *c, esd_proto_t request, const void *data, size_t length);
142 static int esd_proto_server_info(struct connection *c, esd_proto_t request, const void *data, size_t length);
143 static int esd_proto_all_info(struct connection *c, esd_proto_t request, const void *data, size_t length);
144 static int esd_proto_stream_pan(struct connection *c, esd_proto_t request, const void *data, size_t length);
145 static int esd_proto_sample_cache(struct connection *c, esd_proto_t request, const void *data, size_t length);
146 static int esd_proto_sample_free_or_play(struct connection *c, esd_proto_t request, const void *data, size_t length);
147 static int esd_proto_sample_get_id(struct connection *c, esd_proto_t request, const void *data, size_t length);
148 static int esd_proto_standby_or_resume(struct connection *c, esd_proto_t request, const void *data, size_t length);
150 /* the big map of protocol handler info */
151 static struct proto_handler proto_map[ESD_PROTO_MAX] = {
152 { ESD_KEY_LEN + sizeof(int), esd_proto_connect, "connect" },
153 { ESD_KEY_LEN + sizeof(int), NULL, "lock" },
154 { ESD_KEY_LEN + sizeof(int), NULL, "unlock" },
156 { ESD_NAME_MAX + 2 * sizeof(int), esd_proto_stream_play, "stream play" },
157 { ESD_NAME_MAX + 2 * sizeof(int), esd_proto_stream_record, "stream rec" },
158 { ESD_NAME_MAX + 2 * sizeof(int), esd_proto_stream_record, "stream mon" },
160 { ESD_NAME_MAX + 3 * sizeof(int), esd_proto_sample_cache, "sample cache" }, /* 6 */
161 { sizeof(int), esd_proto_sample_free_or_play, "sample free" },
162 { sizeof(int), esd_proto_sample_free_or_play, "sample play" }, /* 8 */
163 { sizeof(int), NULL, "sample loop" },
164 { sizeof(int), NULL, "sample stop" },
165 { -1, NULL, "TODO: sample kill" },
167 { ESD_KEY_LEN + sizeof(int), esd_proto_standby_or_resume, "standby" }, /* NOOP! */
168 { ESD_KEY_LEN + sizeof(int), esd_proto_standby_or_resume, "resume" }, /* NOOP! */ /* 13 */
170 { ESD_NAME_MAX, esd_proto_sample_get_id, "sample getid" }, /* 14 */
171 { ESD_NAME_MAX + 2 * sizeof(int), NULL, "stream filter" },
173 { sizeof(int), esd_proto_server_info, "server info" },
174 { sizeof(int), esd_proto_all_info, "all info" },
175 { -1, NULL, "TODO: subscribe" },
176 { -1, NULL, "TODO: unsubscribe" },
178 { 3 * sizeof(int), esd_proto_stream_pan, "stream pan"},
179 { 3 * sizeof(int), NULL, "sample pan" },
181 { sizeof(int), NULL, "standby mode" },
182 { 0, esd_proto_get_latency, "get latency" }
185 static void connection_free(struct connection *c) {
187 pa_idxset_remove_by_data(c->protocol->connections, c, NULL);
189 if (c->state == ESD_STREAMING_DATA)
190 c->protocol->n_player--;
192 pa_client_free(c->client);
195 pa_sink_input_disconnect(c->sink_input);
196 pa_sink_input_unref(c->sink_input);
199 if (c->source_output) {
200 pa_source_output_disconnect(c->source_output);
201 pa_source_output_unref(c->source_output);
204 if (c->input_memblockq)
205 pa_memblockq_free(c->input_memblockq);
206 if (c->output_memblockq)
207 pa_memblockq_free(c->output_memblockq);
209 if (c->playback.current_memblock)
210 pa_memblock_unref(c->playback.current_memblock);
212 pa_xfree(c->read_data);
213 pa_xfree(c->write_data);
216 pa_iochannel_free(c->io);
219 c->protocol->core->mainloop->defer_free(c->defer_event);
221 if (c->scache.memchunk.memblock)
222 pa_memblock_unref(c->scache.memchunk.memblock);
223 pa_xfree(c->scache.name);
225 if (c->auth_timeout_event)
226 c->protocol->core->mainloop->time_free(c->auth_timeout_event);
228 pa_xfree(c->original_name);
232 static void connection_write_prepare(struct connection *c, size_t length) {
236 t = c->write_data_length+length;
238 if (c->write_data_alloc < t)
239 c->write_data = pa_xrealloc(c->write_data, c->write_data_alloc = t);
241 assert(c->write_data);
244 static void connection_write(struct connection *c, const void *data, size_t length) {
248 assert(c->protocol && c->protocol->core && c->protocol->core->mainloop && c->protocol->core->mainloop->defer_enable);
249 c->protocol->core->mainloop->defer_enable(c->defer_event, 1);
251 connection_write_prepare(c, length);
253 assert(c->write_data);
255 i = c->write_data_length;
256 c->write_data_length += length;
258 memcpy((char*)c->write_data + i, data, length);
261 static void format_esd2native(int format, int swap_bytes, pa_sample_spec *ss) {
264 ss->channels = ((format & ESD_MASK_CHAN) == ESD_STEREO) ? 2 : 1;
265 if ((format & ESD_MASK_BITS) == ESD_BITS16)
266 ss->format = swap_bytes ? PA_SAMPLE_S16RE : PA_SAMPLE_S16NE;
268 ss->format = PA_SAMPLE_U8;
271 static int format_native2esd(pa_sample_spec *ss) {
274 format = (ss->format == PA_SAMPLE_U8) ? ESD_BITS8 : ESD_BITS16;
275 format |= (ss->channels >= 2) ? ESD_STEREO : ESD_MONO;
280 #define CHECK_VALIDITY(expression, string) do { \
281 if (!(expression)) { \
282 pa_log_warn(__FILE__ ": " string); \
287 /*** esound commands ***/
289 static int esd_proto_connect(struct connection *c, PA_GCC_UNUSED esd_proto_t request, const void *data, size_t length) {
293 assert(length == (ESD_KEY_LEN + sizeof(uint32_t)));
295 if (!c->authorized) {
296 if (memcmp(data, c->protocol->esd_key, ESD_KEY_LEN) != 0) {
297 pa_log("kicked client with invalid authorization key.");
302 if (c->auth_timeout_event) {
303 c->protocol->core->mainloop->time_free(c->auth_timeout_event);
304 c->auth_timeout_event = NULL;
308 data = (const char*)data + ESD_KEY_LEN;
310 memcpy(&ekey, data, sizeof(uint32_t));
311 if (ekey == ESD_ENDIAN_KEY)
312 c->swap_byte_order = 0;
313 else if (ekey == ESD_SWAP_ENDIAN_KEY)
314 c->swap_byte_order = 1;
316 pa_log("client sent invalid endian key");
321 connection_write(c, &ok, sizeof(int));
325 static int esd_proto_stream_play(struct connection *c, PA_GCC_UNUSED esd_proto_t request, const void *data, size_t length) {
326 char name[ESD_NAME_MAX], *utf8_name;
327 int32_t format, rate;
330 pa_sink *sink = NULL;
331 pa_sink_input_new_data sdata;
333 assert(c && length == (sizeof(int32_t)*2+ESD_NAME_MAX));
335 memcpy(&format, data, sizeof(int32_t));
336 format = MAYBE_INT32_SWAP(c->swap_byte_order, format);
337 data = (const char*)data + sizeof(int32_t);
339 memcpy(&rate, data, sizeof(int32_t));
340 rate = MAYBE_INT32_SWAP(c->swap_byte_order, rate);
341 data = (const char*)data + sizeof(int32_t);
344 format_esd2native(format, c->swap_byte_order, &ss);
346 CHECK_VALIDITY(pa_sample_spec_valid(&ss), "Invalid sample specification");
348 if (c->protocol->sink_name) {
349 sink = pa_namereg_get(c->protocol->core, c->protocol->sink_name, PA_NAMEREG_SINK, 1);
350 CHECK_VALIDITY(sink, "No such sink");
353 strncpy(name, data, sizeof(name));
354 name[sizeof(name)-1] = 0;
356 utf8_name = pa_utf8_filter(name);
357 pa_client_set_name(c->client, utf8_name);
360 c->original_name = pa_xstrdup(name);
362 assert(!c->sink_input && !c->input_memblockq);
364 pa_sink_input_new_data_init(&sdata);
366 sdata.driver = __FILE__;
367 sdata.name = c->client->name;
368 pa_sink_input_new_data_set_sample_spec(&sdata, &ss);
369 sdata.module = c->protocol->module;
370 sdata.client = c->client;
372 c->sink_input = pa_sink_input_new(c->protocol->core, &sdata, 0);
373 CHECK_VALIDITY(c->sink_input, "Failed to create sink input.");
375 l = (size_t) (pa_bytes_per_second(&ss)*PLAYBACK_BUFFER_SECONDS);
376 c->input_memblockq = pa_memblockq_new(
382 l/PLAYBACK_BUFFER_FRAGMENTS,
384 pa_iochannel_socket_set_rcvbuf(c->io, l/PLAYBACK_BUFFER_FRAGMENTS*2);
385 c->playback.fragment_size = l/10;
387 c->sink_input->peek = sink_input_peek_cb;
388 c->sink_input->drop = sink_input_drop_cb;
389 c->sink_input->kill = sink_input_kill_cb;
390 c->sink_input->get_latency = sink_input_get_latency_cb;
391 c->sink_input->userdata = c;
393 c->state = ESD_STREAMING_DATA;
395 c->protocol->n_player++;
400 static int esd_proto_stream_record(struct connection *c, esd_proto_t request, const void *data, size_t length) {
401 char name[ESD_NAME_MAX], *utf8_name;
402 int32_t format, rate;
403 pa_source *source = NULL;
406 pa_source_output_new_data sdata;
408 assert(c && length == (sizeof(int32_t)*2+ESD_NAME_MAX));
410 memcpy(&format, data, sizeof(int32_t));
411 format = MAYBE_INT32_SWAP(c->swap_byte_order, format);
412 data = (const char*)data + sizeof(int32_t);
414 memcpy(&rate, data, sizeof(int32_t));
415 rate = MAYBE_INT32_SWAP(c->swap_byte_order, rate);
416 data = (const char*)data + sizeof(int32_t);
419 format_esd2native(format, c->swap_byte_order, &ss);
421 CHECK_VALIDITY(pa_sample_spec_valid(&ss), "Invalid sample specification.");
423 if (request == ESD_PROTO_STREAM_MON) {
426 if (!(sink = pa_namereg_get(c->protocol->core, c->protocol->sink_name, PA_NAMEREG_SINK, 1))) {
427 pa_log("no such sink.");
431 if (!(source = sink->monitor_source)) {
432 pa_log("no such monitor source.");
436 assert(request == ESD_PROTO_STREAM_REC);
438 if (c->protocol->source_name) {
439 if (!(source = pa_namereg_get(c->protocol->core, c->protocol->source_name, PA_NAMEREG_SOURCE, 1))) {
440 pa_log("no such source.");
446 strncpy(name, data, sizeof(name));
447 name[sizeof(name)-1] = 0;
449 utf8_name = pa_utf8_filter(name);
450 pa_client_set_name(c->client, utf8_name);
453 c->original_name = pa_xstrdup(name);
455 assert(!c->output_memblockq && !c->source_output);
457 pa_source_output_new_data_init(&sdata);
458 sdata.source = source;
459 sdata.driver = __FILE__;
460 sdata.name = c->client->name;
461 pa_source_output_new_data_set_sample_spec(&sdata, &ss);
462 sdata.module = c->protocol->module;
463 sdata.client = c->client;
465 c->source_output = pa_source_output_new(c->protocol->core, &sdata, 9);
466 CHECK_VALIDITY(c->sink_input, "Failed to create source_output.");
468 l = (size_t) (pa_bytes_per_second(&ss)*RECORD_BUFFER_SECONDS);
469 c->output_memblockq = pa_memblockq_new(
477 pa_iochannel_socket_set_sndbuf(c->io, l/RECORD_BUFFER_FRAGMENTS*2);
479 c->source_output->push = source_output_push_cb;
480 c->source_output->kill = source_output_kill_cb;
481 c->source_output->get_latency = source_output_get_latency_cb;
482 c->source_output->userdata = c;
484 c->state = ESD_STREAMING_DATA;
486 c->protocol->n_player++;
491 static int esd_proto_get_latency(struct connection *c, PA_GCC_UNUSED esd_proto_t request, const void *data, size_t length) {
495 assert(c && !data && length == 0);
497 if (!(sink = pa_namereg_get(c->protocol->core, c->protocol->sink_name, PA_NAMEREG_SINK, 1)))
500 double usec = pa_sink_get_latency(sink);
501 latency = (int) ((usec*44100)/1000000);
504 latency = MAYBE_INT32_SWAP(c->swap_byte_order, latency);
505 connection_write(c, &latency, sizeof(int32_t));
509 static int esd_proto_server_info(struct connection *c, PA_GCC_UNUSED esd_proto_t request, const void *data, size_t length) {
510 int32_t rate = 44100, format = ESD_STEREO|ESD_BITS16;
514 assert(c && data && length == sizeof(int32_t));
516 if ((sink = pa_namereg_get(c->protocol->core, c->protocol->sink_name, PA_NAMEREG_SINK, 1))) {
517 rate = sink->sample_spec.rate;
518 format = format_native2esd(&sink->sample_spec);
521 connection_write_prepare(c, sizeof(int32_t) * 3);
524 connection_write(c, &response, sizeof(int32_t));
525 rate = MAYBE_INT32_SWAP(c->swap_byte_order, rate);
526 connection_write(c, &rate, sizeof(int32_t));
527 format = MAYBE_INT32_SWAP(c->swap_byte_order, format);
528 connection_write(c, &format, sizeof(int32_t));
533 static int esd_proto_all_info(struct connection *c, esd_proto_t request, const void *data, size_t length) {
535 struct connection *conn;
536 uint32_t idx = PA_IDXSET_INVALID;
538 char terminator[sizeof(int32_t)*6+ESD_NAME_MAX];
540 assert(c && data && length == sizeof(int32_t));
542 if (esd_proto_server_info(c, request, data, length) < 0)
545 k = sizeof(int32_t)*5+ESD_NAME_MAX;
546 s = sizeof(int32_t)*6+ESD_NAME_MAX;
547 nsamples = c->protocol->core->scache ? pa_idxset_size(c->protocol->core->scache) : 0;
548 t = s*(nsamples+1) + k*(c->protocol->n_player+1);
550 connection_write_prepare(c, t);
552 memset(terminator, 0, sizeof(terminator));
554 for (conn = pa_idxset_first(c->protocol->connections, &idx); conn; conn = pa_idxset_next(c->protocol->connections, &idx)) {
555 int32_t id, format = ESD_BITS16 | ESD_STEREO, rate = 44100, lvolume = ESD_VOLUME_BASE, rvolume = ESD_VOLUME_BASE;
556 char name[ESD_NAME_MAX];
558 if (conn->state != ESD_STREAMING_DATA)
563 if (conn->sink_input) {
564 pa_cvolume volume = *pa_sink_input_get_volume(conn->sink_input);
565 rate = conn->sink_input->sample_spec.rate;
566 lvolume = (volume.values[0]*ESD_VOLUME_BASE)/PA_VOLUME_NORM;
567 rvolume = (volume.values[1]*ESD_VOLUME_BASE)/PA_VOLUME_NORM;
568 format = format_native2esd(&conn->sink_input->sample_spec);
572 id = MAYBE_INT32_SWAP(c->swap_byte_order, (int32_t) (conn->index+1));
573 connection_write(c, &id, sizeof(int32_t));
576 memset(name, 0, ESD_NAME_MAX); /* don't leak old data */
577 if (conn->original_name)
578 strncpy(name, conn->original_name, ESD_NAME_MAX);
579 else if (conn->client && conn->client->name)
580 strncpy(name, conn->client->name, ESD_NAME_MAX);
581 connection_write(c, name, ESD_NAME_MAX);
584 rate = MAYBE_INT32_SWAP(c->swap_byte_order, rate);
585 connection_write(c, &rate, sizeof(int32_t));
588 lvolume = MAYBE_INT32_SWAP(c->swap_byte_order, lvolume);
589 connection_write(c, &lvolume, sizeof(int32_t));
592 rvolume = MAYBE_INT32_SWAP(c->swap_byte_order, rvolume);
593 connection_write(c, &rvolume, sizeof(int32_t));
596 format = MAYBE_INT32_SWAP(c->swap_byte_order, format);
597 connection_write(c, &format, sizeof(int32_t));
602 assert(t == s*(nsamples+1)+k);
605 connection_write(c, terminator, k);
610 idx = PA_IDXSET_INVALID;
611 for (ce = pa_idxset_first(c->protocol->core->scache, &idx); ce; ce = pa_idxset_next(c->protocol->core->scache, &idx)) {
612 int32_t id, rate, lvolume, rvolume, format, len;
613 char name[ESD_NAME_MAX];
618 id = MAYBE_INT32_SWAP(c->swap_byte_order, (int) (ce->index+1));
619 connection_write(c, &id, sizeof(int32_t));
622 memset(name, 0, ESD_NAME_MAX); /* don't leak old data */
623 if (strncmp(ce->name, SCACHE_PREFIX, sizeof(SCACHE_PREFIX)-1) == 0)
624 strncpy(name, ce->name+sizeof(SCACHE_PREFIX)-1, ESD_NAME_MAX);
626 snprintf(name, ESD_NAME_MAX, "native.%s", ce->name);
627 connection_write(c, name, ESD_NAME_MAX);
630 rate = MAYBE_UINT32_SWAP(c->swap_byte_order, ce->sample_spec.rate);
631 connection_write(c, &rate, sizeof(int32_t));
634 lvolume = MAYBE_UINT32_SWAP(c->swap_byte_order, (ce->volume.values[0]*ESD_VOLUME_BASE)/PA_VOLUME_NORM);
635 connection_write(c, &lvolume, sizeof(int32_t));
638 rvolume = MAYBE_UINT32_SWAP(c->swap_byte_order, (ce->volume.values[0]*ESD_VOLUME_BASE)/PA_VOLUME_NORM);
639 connection_write(c, &rvolume, sizeof(int32_t));
642 format = MAYBE_INT32_SWAP(c->swap_byte_order, format_native2esd(&ce->sample_spec));
643 connection_write(c, &format, sizeof(int32_t));
646 len = MAYBE_INT32_SWAP(c->swap_byte_order, (int) ce->memchunk.length);
647 connection_write(c, &len, sizeof(int32_t));
655 connection_write(c, terminator, s);
660 static int esd_proto_stream_pan(struct connection *c, PA_GCC_UNUSED esd_proto_t request, const void *data, size_t length) {
662 uint32_t idx, lvolume, rvolume;
663 struct connection *conn;
665 assert(c && data && length == sizeof(int32_t)*3);
667 memcpy(&idx, data, sizeof(uint32_t));
668 idx = MAYBE_UINT32_SWAP(c->swap_byte_order, idx) - 1;
669 data = (const char*)data + sizeof(uint32_t);
671 memcpy(&lvolume, data, sizeof(uint32_t));
672 lvolume = MAYBE_UINT32_SWAP(c->swap_byte_order, lvolume);
673 data = (const char*)data + sizeof(uint32_t);
675 memcpy(&rvolume, data, sizeof(uint32_t));
676 rvolume = MAYBE_UINT32_SWAP(c->swap_byte_order, rvolume);
677 data = (const char*)data + sizeof(uint32_t);
679 if ((conn = pa_idxset_get_by_index(c->protocol->connections, idx)) && conn->sink_input) {
681 volume.values[0] = (lvolume*PA_VOLUME_NORM)/ESD_VOLUME_BASE;
682 volume.values[1] = (rvolume*PA_VOLUME_NORM)/ESD_VOLUME_BASE;
684 pa_sink_input_set_volume(conn->sink_input, &volume);
689 connection_write(c, &ok, sizeof(int32_t));
694 static int esd_proto_sample_cache(struct connection *c, PA_GCC_UNUSED esd_proto_t request, const void *data, size_t length) {
696 int32_t format, rate, sc_length;
698 char name[ESD_NAME_MAX+sizeof(SCACHE_PREFIX)-1];
700 assert(c && data && length == (ESD_NAME_MAX+3*sizeof(int32_t)));
702 memcpy(&format, data, sizeof(int32_t));
703 format = MAYBE_INT32_SWAP(c->swap_byte_order, format);
704 data = (const char*)data + sizeof(int32_t);
706 memcpy(&rate, data, sizeof(int32_t));
707 rate = MAYBE_INT32_SWAP(c->swap_byte_order, rate);
708 data = (const char*)data + sizeof(int32_t);
711 format_esd2native(format, c->swap_byte_order, &ss);
713 CHECK_VALIDITY(pa_sample_spec_valid(&ss), "Invalid sample specification.");
715 memcpy(&sc_length, data, sizeof(int32_t));
716 sc_length = MAYBE_INT32_SWAP(c->swap_byte_order, sc_length);
717 data = (const char*)data + sizeof(int32_t);
719 CHECK_VALIDITY(sc_length <= MAX_CACHE_SAMPLE_SIZE, "Sample too large.");
721 strcpy(name, SCACHE_PREFIX);
722 strncpy(name+sizeof(SCACHE_PREFIX)-1, data, ESD_NAME_MAX);
723 name[sizeof(name)-1] = 0;
725 CHECK_VALIDITY(pa_utf8_valid(name), "Invalid UTF8 in sample name.");
727 assert(!c->scache.memchunk.memblock);
728 c->scache.memchunk.memblock = pa_memblock_new(c->protocol->core->mempool, sc_length);
729 c->scache.memchunk.index = 0;
730 c->scache.memchunk.length = sc_length;
731 c->scache.sample_spec = ss;
732 assert(!c->scache.name);
733 c->scache.name = pa_xstrdup(name);
735 c->state = ESD_CACHING_SAMPLE;
737 pa_scache_add_item(c->protocol->core, c->scache.name, NULL, NULL, NULL, &idx);
740 connection_write(c, &idx, sizeof(uint32_t));
745 static int esd_proto_sample_get_id(struct connection *c, PA_GCC_UNUSED esd_proto_t request, const void *data, size_t length) {
748 char name[ESD_NAME_MAX+sizeof(SCACHE_PREFIX)-1];
750 assert(c && data && length == ESD_NAME_MAX);
752 strcpy(name, SCACHE_PREFIX);
753 strncpy(name+sizeof(SCACHE_PREFIX)-1, data, ESD_NAME_MAX);
754 name[sizeof(name)-1] = 0;
756 CHECK_VALIDITY(pa_utf8_valid(name), "Invalid UTF8 in sample name.");
759 if ((idx = pa_scache_get_id_by_name(c->protocol->core, name)) != PA_IDXSET_INVALID)
762 connection_write(c, &ok, sizeof(int32_t));
767 static int esd_proto_sample_free_or_play(struct connection *c, esd_proto_t request, const void *data, size_t length) {
772 assert(c && data && length == sizeof(int32_t));
774 memcpy(&idx, data, sizeof(uint32_t));
775 idx = MAYBE_UINT32_SWAP(c->swap_byte_order, idx) - 1;
779 if ((name = pa_scache_get_name_by_id(c->protocol->core, idx))) {
780 if (request == ESD_PROTO_SAMPLE_PLAY) {
783 if ((sink = pa_namereg_get(c->protocol->core, c->protocol->sink_name, PA_NAMEREG_SINK, 1)))
784 if (pa_scache_play_item(c->protocol->core, name, sink, PA_VOLUME_NORM) >= 0)
787 assert(request == ESD_PROTO_SAMPLE_FREE);
789 if (pa_scache_remove_item(c->protocol->core, name) >= 0)
794 connection_write(c, &ok, sizeof(int32_t));
799 static int esd_proto_standby_or_resume(struct connection *c, PA_GCC_UNUSED esd_proto_t request, PA_GCC_UNUSED const void *data, PA_GCC_UNUSED size_t length) {
802 connection_write_prepare(c, sizeof(int32_t) * 2);
805 connection_write(c, &ok, sizeof(int32_t));
806 connection_write(c, &ok, sizeof(int32_t));
811 /*** client callbacks ***/
813 static void client_kill_cb(pa_client *c) {
814 assert(c && c->userdata);
815 connection_free(c->userdata);
818 /*** pa_iochannel callbacks ***/
820 static int do_read(struct connection *c) {
823 /* pa_log("READ"); */
825 if (c->state == ESD_NEXT_REQUEST) {
827 assert(c->read_data_length < sizeof(c->request));
829 if ((r = pa_iochannel_read(c->io, ((uint8_t*) &c->request) + c->read_data_length, sizeof(c->request) - c->read_data_length)) <= 0) {
830 pa_log_debug("read(): %s", r < 0 ? pa_cstrerror(errno) : "EOF");
834 if ((c->read_data_length+= r) >= sizeof(c->request)) {
835 struct proto_handler *handler;
837 c->request = MAYBE_INT32_SWAP(c->swap_byte_order, c->request);
839 if (c->request < ESD_PROTO_CONNECT || c->request > ESD_PROTO_MAX) {
840 pa_log("recieved invalid request.");
844 handler = proto_map+c->request;
846 /* pa_log("executing request #%u", c->request); */
848 if (!handler->proc) {
849 pa_log("recieved unimplemented request #%u.", c->request);
853 if (handler->data_length == 0) {
854 c->read_data_length = 0;
856 if (handler->proc(c, c->request, NULL, 0) < 0)
860 if (c->read_data_alloc < handler->data_length)
861 c->read_data = pa_xrealloc(c->read_data, c->read_data_alloc = handler->data_length);
862 assert(c->read_data);
864 c->state = ESD_NEEDS_REQDATA;
865 c->read_data_length = 0;
869 } else if (c->state == ESD_NEEDS_REQDATA) {
871 struct proto_handler *handler = proto_map+c->request;
873 assert(handler->proc);
875 assert(c->read_data && c->read_data_length < handler->data_length);
877 if ((r = pa_iochannel_read(c->io, (uint8_t*) c->read_data + c->read_data_length, handler->data_length - c->read_data_length)) <= 0) {
878 pa_log_debug("read(): %s", r < 0 ? pa_cstrerror(errno) : "EOF");
882 if ((c->read_data_length += r) >= handler->data_length) {
883 size_t l = c->read_data_length;
884 assert(handler->proc);
886 c->state = ESD_NEXT_REQUEST;
887 c->read_data_length = 0;
889 if (handler->proc(c, c->request, c->read_data, l) < 0)
892 } else if (c->state == ESD_CACHING_SAMPLE) {
895 assert(c->scache.memchunk.memblock && c->scache.name && c->scache.memchunk.index < c->scache.memchunk.length);
897 if ((r = pa_iochannel_read(c->io, (uint8_t*) c->scache.memchunk.memblock->data+c->scache.memchunk.index, c->scache.memchunk.length-c->scache.memchunk.index)) <= 0) {
898 pa_log_debug("read(): %s", r < 0 ? pa_cstrerror(errno) : "EOF");
902 c->scache.memchunk.index += r;
903 assert(c->scache.memchunk.index <= c->scache.memchunk.length);
905 if (c->scache.memchunk.index == c->scache.memchunk.length) {
908 c->scache.memchunk.index = 0;
909 pa_scache_add_item(c->protocol->core, c->scache.name, &c->scache.sample_spec, NULL, &c->scache.memchunk, &idx);
911 pa_memblock_unref(c->scache.memchunk.memblock);
912 c->scache.memchunk.memblock = NULL;
913 c->scache.memchunk.index = c->scache.memchunk.length = 0;
915 pa_xfree(c->scache.name);
916 c->scache.name = NULL;
918 c->state = ESD_NEXT_REQUEST;
921 connection_write(c, &idx, sizeof(uint32_t));
924 } else if (c->state == ESD_STREAMING_DATA && c->sink_input) {
929 assert(c->input_memblockq);
931 /* pa_log("STREAMING_DATA"); */
933 if (!(l = pa_memblockq_missing(c->input_memblockq)))
936 if (l > c->playback.fragment_size)
937 l = c->playback.fragment_size;
939 if (c->playback.current_memblock)
940 if (c->playback.current_memblock->length - c->playback.memblock_index < l) {
941 pa_memblock_unref(c->playback.current_memblock);
942 c->playback.current_memblock = NULL;
943 c->playback.memblock_index = 0;
946 if (!c->playback.current_memblock) {
947 c->playback.current_memblock = pa_memblock_new(c->protocol->core->mempool, c->playback.fragment_size*2);
948 assert(c->playback.current_memblock && c->playback.current_memblock->length >= l);
949 c->playback.memblock_index = 0;
952 if ((r = pa_iochannel_read(c->io, (uint8_t*) c->playback.current_memblock->data+c->playback.memblock_index, l)) <= 0) {
953 pa_log_debug("read(): %s", r < 0 ? pa_cstrerror(errno) : "EOF");
957 chunk.memblock = c->playback.current_memblock;
958 chunk.index = c->playback.memblock_index;
960 assert(chunk.memblock);
962 c->playback.memblock_index += r;
964 assert(c->input_memblockq);
965 pa_memblockq_push_align(c->input_memblockq, &chunk);
966 assert(c->sink_input);
967 pa_sink_notify(c->sink_input->sink);
973 static int do_write(struct connection *c) {
976 /* pa_log("WRITE"); */
978 if (c->write_data_length) {
981 assert(c->write_data_index < c->write_data_length);
982 if ((r = pa_iochannel_write(c->io, (uint8_t*) c->write_data+c->write_data_index, c->write_data_length-c->write_data_index)) < 0) {
983 pa_log("write(): %s", pa_cstrerror(errno));
987 if ((c->write_data_index +=r) >= c->write_data_length)
988 c->write_data_length = c->write_data_index = 0;
990 } else if (c->state == ESD_STREAMING_DATA && c->source_output) {
994 assert(c->output_memblockq);
995 if (pa_memblockq_peek(c->output_memblockq, &chunk) < 0)
998 assert(chunk.memblock && chunk.length);
1000 if ((r = pa_iochannel_write(c->io, (uint8_t*) chunk.memblock->data+chunk.index, chunk.length)) < 0) {
1001 pa_memblock_unref(chunk.memblock);
1002 pa_log("write(): %s", pa_cstrerror(errno));
1006 pa_memblockq_drop(c->output_memblockq, &chunk, r);
1007 pa_memblock_unref(chunk.memblock);
1009 pa_source_notify(c->source_output->source);
1015 static void do_work(struct connection *c) {
1018 assert(c->protocol && c->protocol->core && c->protocol->core->mainloop && c->protocol->core->mainloop->defer_enable);
1019 c->protocol->core->mainloop->defer_enable(c->defer_event, 0);
1024 if (pa_iochannel_is_readable(c->io)) {
1029 if (c->state == ESD_STREAMING_DATA && c->source_output && pa_iochannel_is_hungup(c->io))
1030 /* In case we are in capture mode we will never call read()
1031 * on the socket, hence we need to detect the hangup manually
1032 * here, instead of simply waiting for read() to return 0. */
1035 if (pa_iochannel_is_writable(c->io))
1036 if (do_write(c) < 0)
1043 if (c->state == ESD_STREAMING_DATA && c->sink_input) {
1046 pa_iochannel_free(c->io);
1049 pa_memblockq_prebuf_disable(c->input_memblockq);
1050 pa_sink_notify(c->sink_input->sink);
1055 static void io_callback(pa_iochannel*io, void *userdata) {
1056 struct connection *c = userdata;
1057 assert(io && c && c->io == io);
1062 /*** defer callback ***/
1064 static void defer_callback(pa_mainloop_api*a, pa_defer_event *e, void *userdata) {
1065 struct connection *c = userdata;
1066 assert(a && c && c->defer_event == e);
1068 /* pa_log("DEFER"); */
1073 /*** sink_input callbacks ***/
1075 static int sink_input_peek_cb(pa_sink_input *i, pa_memchunk *chunk) {
1076 struct connection*c;
1077 assert(i && i->userdata && chunk);
1080 if (pa_memblockq_peek(c->input_memblockq, chunk) < 0) {
1091 static void sink_input_drop_cb(pa_sink_input *i, const pa_memchunk *chunk, size_t length) {
1092 struct connection*c = i->userdata;
1093 assert(i && c && length);
1095 /* pa_log("DROP"); */
1097 pa_memblockq_drop(c->input_memblockq, chunk, length);
1100 assert(c->protocol && c->protocol->core && c->protocol->core->mainloop && c->protocol->core->mainloop->defer_enable);
1103 c->protocol->core->mainloop->defer_enable(c->defer_event, 1);
1105 /* assert(pa_memblockq_get_length(c->input_memblockq) > 2048); */
1108 static void sink_input_kill_cb(pa_sink_input *i) {
1109 assert(i && i->userdata);
1110 connection_free((struct connection *) i->userdata);
1113 static pa_usec_t sink_input_get_latency_cb(pa_sink_input *i) {
1114 struct connection*c = i->userdata;
1116 return pa_bytes_to_usec(pa_memblockq_get_length(c->input_memblockq), &c->sink_input->sample_spec);
1119 /*** source_output callbacks ***/
1121 static void source_output_push_cb(pa_source_output *o, const pa_memchunk *chunk) {
1122 struct connection *c = o->userdata;
1123 assert(o && c && chunk);
1125 pa_memblockq_push(c->output_memblockq, chunk);
1128 assert(c->protocol && c->protocol->core && c->protocol->core->mainloop && c->protocol->core->mainloop->defer_enable);
1131 c->protocol->core->mainloop->defer_enable(c->defer_event, 1);
1134 static void source_output_kill_cb(pa_source_output *o) {
1135 assert(o && o->userdata);
1136 connection_free((struct connection *) o->userdata);
1139 static pa_usec_t source_output_get_latency_cb(pa_source_output *o) {
1140 struct connection*c = o->userdata;
1142 return pa_bytes_to_usec(pa_memblockq_get_length(c->output_memblockq), &c->source_output->sample_spec);
1145 /*** socket server callback ***/
1147 static void auth_timeout(pa_mainloop_api*m, pa_time_event *e, const struct timeval *tv, void *userdata) {
1148 struct connection *c = userdata;
1149 assert(m && tv && c && c->auth_timeout_event == e);
1155 static void on_connection(pa_socket_server*s, pa_iochannel *io, void *userdata) {
1156 struct connection *c;
1157 pa_protocol_esound *p = userdata;
1158 char cname[256], pname[128];
1159 assert(s && io && p);
1161 if (pa_idxset_size(p->connections)+1 > MAX_CONNECTIONS) {
1162 pa_log("Warning! Too many connections (%u), dropping incoming connection.", MAX_CONNECTIONS);
1163 pa_iochannel_free(io);
1167 c = pa_xnew(struct connection, 1);
1170 pa_iochannel_set_callback(c->io, io_callback, c);
1172 pa_iochannel_socket_peer_to_string(io, pname, sizeof(pname));
1173 snprintf(cname, sizeof(cname), "EsounD client (%s)", pname);
1175 c->client = pa_client_new(p->core, __FILE__, cname);
1177 c->client->owner = p->module;
1178 c->client->kill = client_kill_cb;
1179 c->client->userdata = c;
1181 c->authorized = !!p->public;
1182 c->swap_byte_order = 0;
1185 c->read_data_length = 0;
1186 c->read_data = pa_xmalloc(c->read_data_alloc = proto_map[ESD_PROTO_CONNECT].data_length);
1188 c->write_data_length = c->write_data_index = c->write_data_alloc = 0;
1189 c->write_data = NULL;
1191 c->state = ESD_NEEDS_REQDATA;
1192 c->request = ESD_PROTO_CONNECT;
1194 c->sink_input = NULL;
1195 c->input_memblockq = NULL;
1197 c->source_output = NULL;
1198 c->output_memblockq = NULL;
1200 c->playback.current_memblock = NULL;
1201 c->playback.memblock_index = 0;
1202 c->playback.fragment_size = 0;
1204 c->scache.memchunk.length = c->scache.memchunk.index = 0;
1205 c->scache.memchunk.memblock = NULL;
1206 c->scache.name = NULL;
1208 c->original_name = NULL;
1210 if (!c->authorized && p->auth_ip_acl && pa_ip_acl_check(p->auth_ip_acl, pa_iochannel_get_recv_fd(io)) > 0) {
1211 pa_log_info("Client authenticated by IP ACL.");
1215 if (!c->authorized) {
1217 pa_gettimeofday(&tv);
1218 tv.tv_sec += AUTH_TIMEOUT;
1219 c->auth_timeout_event = p->core->mainloop->time_new(p->core->mainloop, &tv, auth_timeout, c);
1221 c->auth_timeout_event = NULL;
1223 c->defer_event = p->core->mainloop->defer_new(p->core->mainloop, defer_callback, c);
1224 assert(c->defer_event);
1225 p->core->mainloop->defer_enable(c->defer_event, 0);
1227 pa_idxset_put(p->connections, c, &c->index);
1230 /*** entry points ***/
1232 pa_protocol_esound* pa_protocol_esound_new(pa_core*core, pa_socket_server *server, pa_module *m, pa_modargs *ma) {
1233 pa_protocol_esound *p;
1242 p = pa_xnew(pa_protocol_esound, 1);
1244 if (pa_modargs_get_value_boolean(ma, "auth-anonymous", &public) < 0) {
1245 pa_log("auth-anonymous= expects a boolean argument.");
1249 if (pa_authkey_load_auto(pa_modargs_get_value(ma, "cookie", DEFAULT_COOKIE_FILE), p->esd_key, sizeof(p->esd_key)) < 0)
1252 if ((acl = pa_modargs_get_value(ma, "auth-ip-acl", NULL))) {
1254 if (!(p->auth_ip_acl = pa_ip_acl_new(acl))) {
1255 pa_log("Failed to parse IP ACL '%s'", acl);
1259 p->auth_ip_acl = NULL;
1264 pa_socket_server_set_callback(p->server, on_connection, p);
1266 p->connections = pa_idxset_new(NULL, NULL);
1267 assert(p->connections);
1269 p->sink_name = pa_xstrdup(pa_modargs_get_value(ma, "sink", NULL));
1270 p->source_name = pa_xstrdup(pa_modargs_get_value(ma, "source", NULL));
1280 void pa_protocol_esound_free(pa_protocol_esound *p) {
1281 struct connection *c;
1284 while ((c = pa_idxset_first(p->connections, NULL)))
1287 pa_idxset_free(p->connections, NULL, NULL);
1288 pa_socket_server_unref(p->server);
1291 pa_ip_acl_free(p->auth_ip_acl);