]> code.delx.au - pulseaudio/blob - src/polypcore/protocol-esound.c
delx.au / code / pulseaudio / blob
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
add utf8 validity checking to esound protocol
[pulseaudio] / src / polypcore / protocol-esound.c
1 /* $Id$ */
2
3 /***
4 This file is part of polypaudio.
5
6 polypaudio 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.
10
11 polypaudio 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.
15
16 You should have received a copy of the GNU Lesser General Public License
17 along with polypaudio; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
19 USA.
20 ***/
21
22 #ifdef HAVE_CONFIG_H
23 #include <config.h>
24 #endif
25
26 #include <errno.h>
27 #include <string.h>
28 #include <stdio.h>
29 #include <assert.h>
30 #include <stdlib.h>
31 #include <limits.h>
32
33 #include <polyp/sample.h>
34 #include <polypcore/esound.h>
35 #include <polypcore/memblock.h>
36 #include <polypcore/client.h>
37 #include <polypcore/sink-input.h>
38 #include <polypcore/sink.h>
39 #include <polypcore/source-output.h>
40 #include <polypcore/source.h>
41 #include <polypcore/core-scache.h>
42 #include <polypcore/sample-util.h>
43 #include <polypcore/authkey.h>
44 #include <polypcore/namereg.h>
45 #include <polypcore/xmalloc.h>
46 #include <polypcore/log.h>
47 #include <polypcore/util.h>
48
49 #include "endianmacros.h"
50
51 #include "protocol-esound.h"
52
53 /* Don't accept more connection than this */
54 #define MAX_CONNECTIONS 10
55
56 /* Kick a client if it doesn't authenticate within this time */
57 #define AUTH_TIMEOUT 5
58
59 #define DEFAULT_COOKIE_FILE ".esd_auth"
60
61 #define PLAYBACK_BUFFER_SECONDS (.25)
62 #define PLAYBACK_BUFFER_FRAGMENTS (10)
63 #define RECORD_BUFFER_SECONDS (5)
64 #define RECORD_BUFFER_FRAGMENTS (100)
65
66 #define MAX_CACHE_SAMPLE_SIZE (1024000)
67
68 #define SCACHE_PREFIX "esound."
69
70 /* This is heavily based on esound's code */
71
72 struct connection {
73 uint32_t index;
74 int dead;
75 pa_protocol_esound *protocol;
76 pa_iochannel *io;
77 pa_client *client;
78 int authorized, swap_byte_order;
79 void *write_data;
80 size_t write_data_alloc, write_data_index, write_data_length;
81 void *read_data;
82 size_t read_data_alloc, read_data_length;
83 esd_proto_t request;
84 esd_client_state_t state;
85 pa_sink_input *sink_input;
86 pa_source_output *source_output;
87 pa_memblockq *input_memblockq, *output_memblockq;
88 pa_defer_event *defer_event;
89
90 struct {
91 pa_memblock *current_memblock;
92 size_t memblock_index, fragment_size;
93 } playback;
94
95 struct {
96 pa_memchunk memchunk;
97 char *name;
98 pa_sample_spec sample_spec;
99 } scache;
100
101 pa_time_event *auth_timeout_event;
102 };
103
104 struct pa_protocol_esound {
105 int public;
106 pa_module *module;
107 pa_core *core;
108 pa_socket_server *server;
109 pa_idxset *connections;
110 char *sink_name, *source_name;
111 unsigned n_player;
112 uint8_t esd_key[ESD_KEY_LEN];
113 };
114
115 typedef struct proto_handler {
116 size_t data_length;
117 int (*proc)(struct connection *c, esd_proto_t request, const void *data, size_t length);
118 const char *description;
119 } esd_proto_handler_info_t;
120
121 static void sink_input_drop_cb(pa_sink_input *i, const pa_memchunk *chunk, size_t length);
122 static int sink_input_peek_cb(pa_sink_input *i, pa_memchunk *chunk);
123 static void sink_input_kill_cb(pa_sink_input *i);
124 static pa_usec_t sink_input_get_latency_cb(pa_sink_input *i);
125 static pa_usec_t source_output_get_latency_cb(pa_source_output *o);
126
127 static void source_output_push_cb(pa_source_output *o, const pa_memchunk *chunk);
128 static void source_output_kill_cb(pa_source_output *o);
129
130 static int esd_proto_connect(struct connection *c, esd_proto_t request, const void *data, size_t length);
131 static int esd_proto_stream_play(struct connection *c, esd_proto_t request, const void *data, size_t length);
132 static int esd_proto_stream_record(struct connection *c, esd_proto_t request, const void *data, size_t length);
133 static int esd_proto_get_latency(struct connection *c, esd_proto_t request, const void *data, size_t length);
134 static int esd_proto_server_info(struct connection *c, esd_proto_t request, const void *data, size_t length);
135 static int esd_proto_all_info(struct connection *c, esd_proto_t request, const void *data, size_t length);
136 static int esd_proto_stream_pan(struct connection *c, esd_proto_t request, const void *data, size_t length);
137 static int esd_proto_sample_cache(struct connection *c, esd_proto_t request, const void *data, size_t length);
138 static int esd_proto_sample_free_or_play(struct connection *c, esd_proto_t request, const void *data, size_t length);
139 static int esd_proto_sample_get_id(struct connection *c, esd_proto_t request, const void *data, size_t length);
140 static int esd_proto_standby_or_resume(struct connection *c, esd_proto_t request, const void *data, size_t length);
141
142 /* the big map of protocol handler info */
143 static struct proto_handler proto_map[ESD_PROTO_MAX] = {
144 { ESD_KEY_LEN + sizeof(int), esd_proto_connect, "connect" },
145 { ESD_KEY_LEN + sizeof(int), NULL, "lock" },
146 { ESD_KEY_LEN + sizeof(int), NULL, "unlock" },
147
148 { ESD_NAME_MAX + 2 * sizeof(int), esd_proto_stream_play, "stream play" },
149 { ESD_NAME_MAX + 2 * sizeof(int), esd_proto_stream_record, "stream rec" },
150 { ESD_NAME_MAX + 2 * sizeof(int), esd_proto_stream_record, "stream mon" },
151
152 { ESD_NAME_MAX + 3 * sizeof(int), esd_proto_sample_cache, "sample cache" }, /* 6 */
153 { sizeof(int), esd_proto_sample_free_or_play, "sample free" },
154 { sizeof(int), esd_proto_sample_free_or_play, "sample play" }, /* 8 */
155 { sizeof(int), NULL, "sample loop" },
156 { sizeof(int), NULL, "sample stop" },
157 { -1, NULL, "TODO: sample kill" },
158
159 { ESD_KEY_LEN + sizeof(int), esd_proto_standby_or_resume, "standby" }, /* NOOP! */
160 { ESD_KEY_LEN + sizeof(int), esd_proto_standby_or_resume, "resume" }, /* NOOP! */ /* 13 */
161
162 { ESD_NAME_MAX, esd_proto_sample_get_id, "sample getid" }, /* 14 */
163 { ESD_NAME_MAX + 2 * sizeof(int), NULL, "stream filter" },
164
165 { sizeof(int), esd_proto_server_info, "server info" },
166 { sizeof(int), esd_proto_all_info, "all info" },
167 { -1, NULL, "TODO: subscribe" },
168 { -1, NULL, "TODO: unsubscribe" },
169
170 { 3 * sizeof(int), esd_proto_stream_pan, "stream pan"},
171 { 3 * sizeof(int), NULL, "sample pan" },
172
173 { sizeof(int), NULL, "standby mode" },
174 { 0, esd_proto_get_latency, "get latency" }
175 };
176
177
178 static void connection_free(struct connection *c) {
179 assert(c);
180 pa_idxset_remove_by_data(c->protocol->connections, c, NULL);
181
182 if (c->state == ESD_STREAMING_DATA)
183 c->protocol->n_player--;
184
185 pa_client_free(c->client);
186
187 if (c->sink_input) {
188 pa_sink_input_disconnect(c->sink_input);
189 pa_sink_input_unref(c->sink_input);
190 }
191
192 if (c->source_output) {
193 pa_source_output_disconnect(c->source_output);
194 pa_source_output_unref(c->source_output);
195 }
196
197 if (c->input_memblockq)
198 pa_memblockq_free(c->input_memblockq);
199 if (c->output_memblockq)
200 pa_memblockq_free(c->output_memblockq);
201
202 if (c->playback.current_memblock)
203 pa_memblock_unref(c->playback.current_memblock);
204
205 pa_xfree(c->read_data);
206 pa_xfree(c->write_data);
207
208 if (c->io)
209 pa_iochannel_free(c->io);
210
211 if (c->defer_event)
212 c->protocol->core->mainloop->defer_free(c->defer_event);
213
214 if (c->scache.memchunk.memblock)
215 pa_memblock_unref(c->scache.memchunk.memblock);
216 pa_xfree(c->scache.name);
217
218 if (c->auth_timeout_event)
219 c->protocol->core->mainloop->time_free(c->auth_timeout_event);
220
221 pa_xfree(c);
222 }
223
224 static void connection_write_prepare(struct connection *c, size_t length) {
225 size_t t;
226 assert(c);
227
228 t = c->write_data_length+length;
229
230 if (c->write_data_alloc < t)
231 c->write_data = pa_xrealloc(c->write_data, c->write_data_alloc = t);
232
233 assert(c->write_data);
234 }
235
236 static void connection_write(struct connection *c, const void *data, size_t length) {
237 size_t i;
238 assert(c);
239
240 assert(c->protocol && c->protocol->core && c->protocol->core->mainloop && c->protocol->core->mainloop->defer_enable);
241 c->protocol->core->mainloop->defer_enable(c->defer_event, 1);
242
243 connection_write_prepare(c, length);
244
245 assert(c->write_data);
246
247 i = c->write_data_length;
248 c->write_data_length += length;
249
250 memcpy((char*)c->write_data + i, data, length);
251 }
252
253 static void format_esd2native(int format, int swap_bytes, pa_sample_spec *ss) {
254 assert(ss);
255
256 ss->channels = ((format & ESD_MASK_CHAN) == ESD_STEREO) ? 2 : 1;
257 if ((format & ESD_MASK_BITS) == ESD_BITS16)
258 ss->format = swap_bytes ? PA_SAMPLE_S16RE : PA_SAMPLE_S16NE;
259 else
260 ss->format = PA_SAMPLE_U8;
261 }
262
263 static int format_native2esd(pa_sample_spec *ss) {
264 int format = 0;
265
266 format = (ss->format == PA_SAMPLE_U8) ? ESD_BITS8 : ESD_BITS16;
267 format |= (ss->channels >= 2) ? ESD_STEREO : ESD_MONO;
268
269 return format;
270 }
271
272 #define CHECK_VALIDITY(expression, string) do { \
273 if (!(expression)) { \
274 pa_log_warn(__FILE__ ": " string); \
275 return -1; \
276 } \
277 } while(0);
278
279 /*** esound commands ***/
280
281 static int esd_proto_connect(struct connection *c, PA_GCC_UNUSED esd_proto_t request, const void *data, size_t length) {
282 uint32_t ekey;
283 int ok;
284
285 assert(length == (ESD_KEY_LEN + sizeof(uint32_t)));
286
287 if (!c->authorized) {
288 if (memcmp(data, c->protocol->esd_key, ESD_KEY_LEN) != 0) {
289 pa_log(__FILE__": kicked client with invalid authorization key.");
290 return -1;
291 }
292
293 c->authorized = 1;
294 if (c->auth_timeout_event) {
295 c->protocol->core->mainloop->time_free(c->auth_timeout_event);
296 c->auth_timeout_event = NULL;
297 }
298 }
299
300 data = (const char*)data + ESD_KEY_LEN;
301
302 memcpy(&ekey, data, sizeof(uint32_t));
303 if (ekey == ESD_ENDIAN_KEY)
304 c->swap_byte_order = 0;
305 else if (ekey == ESD_SWAP_ENDIAN_KEY)
306 c->swap_byte_order = 1;
307 else {
308 pa_log(__FILE__": client sent invalid endian key");
309 return -1;
310 }
311
312 ok = 1;
313 connection_write(c, &ok, sizeof(int));
314 return 0;
315 }
316
317 static int esd_proto_stream_play(struct connection *c, PA_GCC_UNUSED esd_proto_t request, const void *data, size_t length) {
318 char name[ESD_NAME_MAX];
319 int32_t format, rate;
320 pa_sink *sink;
321 pa_sample_spec ss;
322 size_t l;
323
324 assert(c && length == (sizeof(int32_t)*2+ESD_NAME_MAX));
325
326 memcpy(&format, data, sizeof(int32_t));
327 format = MAYBE_INT32_SWAP(c->swap_byte_order, format);
328 data = (const char*)data + sizeof(int32_t);
329
330 memcpy(&rate, data, sizeof(int32_t));
331 rate = MAYBE_INT32_SWAP(c->swap_byte_order, rate);
332 data = (const char*)data + sizeof(int32_t);
333
334 ss.rate = rate;
335 format_esd2native(format, c->swap_byte_order, &ss);
336
337 CHECK_VALIDITY(pa_sample_spec_valid(&ss), "Invalid sample specification");
338 sink = pa_namereg_get(c->protocol->core, c->protocol->sink_name, PA_NAMEREG_SINK, 1);
339 CHECK_VALIDITY(sink, "No such sink");
340
341 strncpy(name, data, sizeof(name));
342 name[sizeof(name)-1] = 0;
343
344 CHECK_VALIDITY(pa_utf8_valid(name), "Invalid UTF8 in stream name");
345
346 pa_client_set_name(c->client, name);
347
348 assert(!c->sink_input && !c->input_memblockq);
349
350 c->sink_input = pa_sink_input_new(sink, __FILE__, name, &ss, NULL, NULL, 0, -1);
351
352 CHECK_VALIDITY(c->sink_input, "Failed to create sink input.");
353
354 l = (size_t) (pa_bytes_per_second(&ss)*PLAYBACK_BUFFER_SECONDS);
355 c->input_memblockq = pa_memblockq_new(
356 0,
357 l,
358 0,
359 pa_frame_size(&ss),
360 (size_t) -1,
361 l/PLAYBACK_BUFFER_FRAGMENTS,
362 NULL,
363 c->protocol->core->memblock_stat);
364 pa_iochannel_socket_set_rcvbuf(c->io, l/PLAYBACK_BUFFER_FRAGMENTS*2);
365 c->playback.fragment_size = l/10;
366
367 c->sink_input->owner = c->protocol->module;
368 c->sink_input->client = c->client;
369 c->sink_input->peek = sink_input_peek_cb;
370 c->sink_input->drop = sink_input_drop_cb;
371 c->sink_input->kill = sink_input_kill_cb;
372 c->sink_input->get_latency = sink_input_get_latency_cb;
373 c->sink_input->userdata = c;
374
375 c->state = ESD_STREAMING_DATA;
376
377 c->protocol->n_player++;
378
379 return 0;
380 }
381
382 static int esd_proto_stream_record(struct connection *c, esd_proto_t request, const void *data, size_t length) {
383 char name[ESD_NAME_MAX];
384 int32_t format, rate;
385 pa_source *source;
386 pa_sample_spec ss;
387 size_t l;
388
389 assert(c && length == (sizeof(int32_t)*2+ESD_NAME_MAX));
390
391 memcpy(&format, data, sizeof(int32_t));
392 format = MAYBE_INT32_SWAP(c->swap_byte_order, format);
393 data = (const char*)data + sizeof(int32_t);
394
395 memcpy(&rate, data, sizeof(int32_t));
396 rate = MAYBE_INT32_SWAP(c->swap_byte_order, rate);
397 data = (const char*)data + sizeof(int32_t);
398
399 ss.rate = rate;
400 format_esd2native(format, c->swap_byte_order, &ss);
401
402 CHECK_VALIDITY(pa_sample_spec_valid(&ss), "Invalid sample specification.");
403
404 if (request == ESD_PROTO_STREAM_MON) {
405 pa_sink* sink;
406
407 if (!(sink = pa_namereg_get(c->protocol->core, c->protocol->sink_name, PA_NAMEREG_SINK, 1))) {
408 pa_log(__FILE__": no such sink.");
409 return -1;
410 }
411
412 if (!(source = sink->monitor_source)) {
413 pa_log(__FILE__": no such monitor source.");
414 return -1;
415 }
416 } else {
417 assert(request == ESD_PROTO_STREAM_REC);
418
419 if (!(source = pa_namereg_get(c->protocol->core, c->protocol->source_name, PA_NAMEREG_SOURCE, 1))) {
420 pa_log(__FILE__": no such source.");
421 return -1;
422 }
423 }
424
425 strncpy(name, data, sizeof(name));
426 name[sizeof(name)-1] = 0;
427
428 CHECK_VALIDITY(pa_utf8_valid(name), "Invalid UTF8 in stream name.");
429
430 pa_client_set_name(c->client, name);
431
432 assert(!c->output_memblockq && !c->source_output);
433
434 if (!(c->source_output = pa_source_output_new(source, __FILE__, name, &ss, NULL, -1))) {
435 pa_log(__FILE__": failed to create source output");
436 return -1;
437 }
438
439 l = (size_t) (pa_bytes_per_second(&ss)*RECORD_BUFFER_SECONDS);
440 c->output_memblockq = pa_memblockq_new(
441 0,
442 l,
443 0,
444 pa_frame_size(&ss),
445 1,
446 0,
447 NULL,
448 c->protocol->core->memblock_stat);
449 pa_iochannel_socket_set_sndbuf(c->io, l/RECORD_BUFFER_FRAGMENTS*2);
450
451 c->source_output->owner = c->protocol->module;
452 c->source_output->client = c->client;
453 c->source_output->push = source_output_push_cb;
454 c->source_output->kill = source_output_kill_cb;
455 c->source_output->get_latency = source_output_get_latency_cb;
456 c->source_output->userdata = c;
457
458 c->state = ESD_STREAMING_DATA;
459
460 c->protocol->n_player++;
461
462 return 0;
463 }
464
465 static int esd_proto_get_latency(struct connection *c, PA_GCC_UNUSED esd_proto_t request, const void *data, size_t length) {
466 pa_sink *sink;
467 int32_t latency;
468
469 assert(c && !data && length == 0);
470
471 if (!(sink = pa_namereg_get(c->protocol->core, c->protocol->sink_name, PA_NAMEREG_SINK, 1)))
472 latency = 0;
473 else {
474 double usec = pa_sink_get_latency(sink);
475 latency = (int) ((usec*44100)/1000000);
476 }
477
478 latency = MAYBE_INT32_SWAP(c->swap_byte_order, latency);
479 connection_write(c, &latency, sizeof(int32_t));
480 return 0;
481 }
482
483 static int esd_proto_server_info(struct connection *c, PA_GCC_UNUSED esd_proto_t request, const void *data, size_t length) {
484 int32_t rate = 44100, format = ESD_STEREO|ESD_BITS16;
485 int32_t response;
486 pa_sink *sink;
487
488 assert(c && data && length == sizeof(int32_t));
489
490 if ((sink = pa_namereg_get(c->protocol->core, c->protocol->sink_name, PA_NAMEREG_SINK, 1))) {
491 rate = sink->sample_spec.rate;
492 format = format_native2esd(&sink->sample_spec);
493 }
494
495 connection_write_prepare(c, sizeof(int32_t) * 3);
496
497 response = 0;
498 connection_write(c, &response, sizeof(int32_t));
499 rate = MAYBE_INT32_SWAP(c->swap_byte_order, rate);
500 connection_write(c, &rate, sizeof(int32_t));
501 format = MAYBE_INT32_SWAP(c->swap_byte_order, format);
502 connection_write(c, &format, sizeof(int32_t));
503
504 return 0;
505 }
506
507 static int esd_proto_all_info(struct connection *c, esd_proto_t request, const void *data, size_t length) {
508 uint8_t *response;
509 size_t t, k, s;
510 struct connection *conn;
511 uint32_t idx = PA_IDXSET_INVALID;
512 unsigned nsamples;
513 char terminator[sizeof(int32_t)*6+ESD_NAME_MAX];
514
515 assert(c && data && length == sizeof(int32_t));
516
517 if (esd_proto_server_info(c, request, data, length) < 0)
518 return -1;
519
520 k = sizeof(int32_t)*5+ESD_NAME_MAX;
521 s = sizeof(int32_t)*6+ESD_NAME_MAX;
522 nsamples = c->protocol->core->scache ? pa_idxset_size(c->protocol->core->scache) : 0;
523 t = s*(nsamples+1) + k*(c->protocol->n_player+1);
524
525 connection_write_prepare(c, t);
526
527 memset(terminator, 0, sizeof(terminator));
528
529 for (conn = pa_idxset_first(c->protocol->connections, &idx); conn; conn = pa_idxset_next(c->protocol->connections, &idx)) {
530 int32_t id, format = ESD_BITS16 | ESD_STEREO, rate = 44100, lvolume = ESD_VOLUME_BASE, rvolume = ESD_VOLUME_BASE;
531 char name[ESD_NAME_MAX];
532
533 if (conn->state != ESD_STREAMING_DATA)
534 continue;
535
536 assert(t >= k*2+s);
537
538 if (conn->sink_input) {
539 pa_cvolume volume = *pa_sink_input_get_volume(conn->sink_input);
540 rate = conn->sink_input->sample_spec.rate;
541 lvolume = (volume.values[0]*ESD_VOLUME_BASE)/PA_VOLUME_NORM;
542 rvolume = (volume.values[1]*ESD_VOLUME_BASE)/PA_VOLUME_NORM;
543 format = format_native2esd(&conn->sink_input->sample_spec);
544 }
545
546 /* id */
547 id = MAYBE_INT32_SWAP(c->swap_byte_order, (int32_t) (conn->index+1));
548 connection_write(c, &id, sizeof(int32_t));
549
550 /* name */
551 assert(conn->client);
552 strncpy(name, conn->client->name, ESD_NAME_MAX);
553 connection_write(c, name, ESD_NAME_MAX);
554
555 /* rate */
556 rate = MAYBE_INT32_SWAP(c->swap_byte_order, rate);
557 connection_write(c, &rate, sizeof(int32_t));
558
559 /* left */
560 lvolume = MAYBE_INT32_SWAP(c->swap_byte_order, lvolume);
561 connection_write(c, &lvolume, sizeof(int32_t));
562
563 /*right*/
564 rvolume = MAYBE_INT32_SWAP(c->swap_byte_order, rvolume);
565 connection_write(c, &rvolume, sizeof(int32_t));
566
567 /*format*/
568 format = MAYBE_INT32_SWAP(c->swap_byte_order, format);
569 connection_write(c, &format, sizeof(int32_t));
570
571 t -= k;
572 }
573
574 assert(t == s*(nsamples+1)+k);
575 response += k;
576 t -= k;
577
578 connection_write(c, terminator, k);
579
580 if (nsamples) {
581 pa_scache_entry *ce;
582
583 idx = PA_IDXSET_INVALID;
584 for (ce = pa_idxset_first(c->protocol->core->scache, &idx); ce; ce = pa_idxset_next(c->protocol->core->scache, &idx)) {
585 int32_t id, rate, lvolume, rvolume, format, len;
586 char name[ESD_NAME_MAX];
587
588 assert(t >= s*2);
589
590 /* id */
591 id = MAYBE_INT32_SWAP(c->swap_byte_order, (int) (ce->index+1));
592 connection_write(c, &id, sizeof(int32_t));
593
594 /* name */
595 if (strncmp(ce->name, SCACHE_PREFIX, sizeof(SCACHE_PREFIX)-1) == 0)
596 strncpy(name, ce->name+sizeof(SCACHE_PREFIX)-1, ESD_NAME_MAX);
597 else
598 snprintf(name, ESD_NAME_MAX, "native.%s", ce->name);
599 connection_write(c, name, ESD_NAME_MAX);
600
601 /* rate */
602 rate = MAYBE_UINT32_SWAP(c->swap_byte_order, ce->sample_spec.rate);
603 connection_write(c, &rate, sizeof(int32_t));
604
605 /* left */
606 lvolume = MAYBE_UINT32_SWAP(c->swap_byte_order, (ce->volume.values[0]*ESD_VOLUME_BASE)/PA_VOLUME_NORM);
607 connection_write(c, &lvolume, sizeof(int32_t));
608
609 /*right*/
610 rvolume = MAYBE_UINT32_SWAP(c->swap_byte_order, (ce->volume.values[0]*ESD_VOLUME_BASE)/PA_VOLUME_NORM);
611 connection_write(c, &rvolume, sizeof(int32_t));
612
613 /*format*/
614 format = MAYBE_INT32_SWAP(c->swap_byte_order, format_native2esd(&ce->sample_spec));
615 connection_write(c, &format, sizeof(int32_t));
616
617 /*length*/
618 len = MAYBE_INT32_SWAP(c->swap_byte_order, (int) ce->memchunk.length);
619 connection_write(c, &len, sizeof(int32_t));
620
621 t -= s;
622 }
623 }
624
625 assert(t == s);
626
627 connection_write(c, terminator, s);
628
629 return 0;
630 }
631
632 static int esd_proto_stream_pan(struct connection *c, PA_GCC_UNUSED esd_proto_t request, const void *data, size_t length) {
633 int32_t ok;
634 uint32_t idx, lvolume, rvolume;
635 struct connection *conn;
636
637 assert(c && data && length == sizeof(int32_t)*3);
638
639 memcpy(&idx, data, sizeof(uint32_t));
640 idx = MAYBE_UINT32_SWAP(c->swap_byte_order, idx) - 1;
641 data = (const char*)data + sizeof(uint32_t);
642
643 memcpy(&lvolume, data, sizeof(uint32_t));
644 lvolume = MAYBE_UINT32_SWAP(c->swap_byte_order, lvolume);
645 data = (const char*)data + sizeof(uint32_t);
646
647 memcpy(&rvolume, data, sizeof(uint32_t));
648 rvolume = MAYBE_UINT32_SWAP(c->swap_byte_order, rvolume);
649 data = (const char*)data + sizeof(uint32_t);
650
651 if ((conn = pa_idxset_get_by_index(c->protocol->connections, idx)) && conn->sink_input) {
652 pa_cvolume volume;
653 volume.values[0] = (lvolume*PA_VOLUME_NORM)/ESD_VOLUME_BASE;
654 volume.values[1] = (rvolume*PA_VOLUME_NORM)/ESD_VOLUME_BASE;
655 volume.channels = 2;
656 pa_sink_input_set_volume(conn->sink_input, &volume);
657 ok = 1;
658 } else
659 ok = 0;
660
661 connection_write(c, &ok, sizeof(int32_t));
662
663 return 0;
664 }
665
666 static int esd_proto_sample_cache(struct connection *c, PA_GCC_UNUSED esd_proto_t request, const void *data, size_t length) {
667 pa_sample_spec ss;
668 int32_t format, rate, sc_length;
669 uint32_t idx;
670 char name[ESD_NAME_MAX+sizeof(SCACHE_PREFIX)-1];
671
672 assert(c && data && length == (ESD_NAME_MAX+3*sizeof(int32_t)));
673
674 memcpy(&format, data, sizeof(int32_t));
675 format = MAYBE_INT32_SWAP(c->swap_byte_order, format);
676 data = (const char*)data + sizeof(int32_t);
677
678 memcpy(&rate, data, sizeof(int32_t));
679 rate = MAYBE_INT32_SWAP(c->swap_byte_order, rate);
680 data = (const char*)data + sizeof(int32_t);
681
682 ss.rate = rate;
683 format_esd2native(format, c->swap_byte_order, &ss);
684
685 CHECK_VALIDITY(pa_sample_spec_valid(&ss), "Invalid sample specification.");
686
687 memcpy(&sc_length, data, sizeof(int32_t));
688 sc_length = MAYBE_INT32_SWAP(c->swap_byte_order, sc_length);
689 data = (const char*)data + sizeof(int32_t);
690
691 CHECK_VALIDITY(sc_length <= MAX_CACHE_SAMPLE_SIZE, "Sample too large.");
692
693 strcpy(name, SCACHE_PREFIX);
694 strncpy(name+sizeof(SCACHE_PREFIX)-1, data, ESD_NAME_MAX);
695 name[sizeof(name)-1] = 0;
696
697 CHECK_VALIDITY(pa_utf8_valid(name), "Invalid UTF8 in sample name.");
698
699 assert(!c->scache.memchunk.memblock);
700 c->scache.memchunk.memblock = pa_memblock_new(sc_length, c->protocol->core->memblock_stat);
701 c->scache.memchunk.index = 0;
702 c->scache.memchunk.length = sc_length;
703 c->scache.sample_spec = ss;
704 assert(!c->scache.name);
705 c->scache.name = pa_xstrdup(name);
706
707 c->state = ESD_CACHING_SAMPLE;
708
709 pa_scache_add_item(c->protocol->core, c->scache.name, NULL, NULL, NULL, &idx);
710
711 idx += 1;
712 connection_write(c, &idx, sizeof(uint32_t));
713
714 return 0;
715 }
716
717 static int esd_proto_sample_get_id(struct connection *c, PA_GCC_UNUSED esd_proto_t request, const void *data, size_t length) {
718 int32_t ok;
719 uint32_t idx;
720 char name[ESD_NAME_MAX+sizeof(SCACHE_PREFIX)-1];
721
722 assert(c && data && length == ESD_NAME_MAX);
723
724 strcpy(name, SCACHE_PREFIX);
725 strncpy(name+sizeof(SCACHE_PREFIX)-1, data, ESD_NAME_MAX);
726 name[sizeof(name)-1] = 0;
727
728 CHECK_VALIDITY(pa_utf8_valid(name), "Invalid UTF8 in sample name.");
729
730 ok = -1;
731 if ((idx = pa_scache_get_id_by_name(c->protocol->core, name)) != PA_IDXSET_INVALID)
732 ok = idx + 1;
733
734 connection_write(c, &ok, sizeof(int32_t));
735
736 return 0;
737 }
738
739 static int esd_proto_sample_free_or_play(struct connection *c, esd_proto_t request, const void *data, size_t length) {
740 int32_t ok;
741 const char *name;
742 uint32_t idx;
743
744 assert(c && data && length == sizeof(int32_t));
745
746 memcpy(&idx, data, sizeof(uint32_t));
747 idx = MAYBE_UINT32_SWAP(c->swap_byte_order, idx) - 1;
748
749 ok = 0;
750
751 if ((name = pa_scache_get_name_by_id(c->protocol->core, idx))) {
752 if (request == ESD_PROTO_SAMPLE_PLAY) {
753 pa_sink *sink;
754
755 if ((sink = pa_namereg_get(c->protocol->core, c->protocol->sink_name, PA_NAMEREG_SINK, 1)))
756 if (pa_scache_play_item(c->protocol->core, name, sink, PA_VOLUME_NORM) >= 0)
757 ok = idx + 1;
758 } else {
759 assert(request == ESD_PROTO_SAMPLE_FREE);
760
761 if (pa_scache_remove_item(c->protocol->core, name) >= 0)
762 ok = idx + 1;
763 }
764 }
765
766 connection_write(c, &ok, sizeof(int32_t));
767
768 return 0;
769 }
770
771 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) {
772 int32_t ok;
773
774 connection_write_prepare(c, sizeof(int32_t) * 2);
775
776 ok = 1;
777 connection_write(c, &ok, sizeof(int32_t));
778 connection_write(c, &ok, sizeof(int32_t));
779
780 return 0;
781 }
782
783 /*** client callbacks ***/
784
785 static void client_kill_cb(pa_client *c) {
786 assert(c && c->userdata);
787 connection_free(c->userdata);
788 }
789
790 /*** pa_iochannel callbacks ***/
791
792 static int do_read(struct connection *c) {
793 assert(c && c->io);
794
795 /* pa_log("READ"); */
796
797 if (c->state == ESD_NEXT_REQUEST) {
798 ssize_t r;
799 assert(c->read_data_length < sizeof(c->request));
800
801 if ((r = pa_iochannel_read(c->io, ((uint8_t*) &c->request) + c->read_data_length, sizeof(c->request) - c->read_data_length)) <= 0) {
802 pa_log_debug(__FILE__": read() failed: %s", r < 0 ? strerror(errno) : "EOF");
803 return -1;
804 }
805
806 if ((c->read_data_length+= r) >= sizeof(c->request)) {
807 struct proto_handler *handler;
808
809 c->request = MAYBE_INT32_SWAP(c->swap_byte_order, c->request);
810
811 if (c->request < ESD_PROTO_CONNECT || c->request > ESD_PROTO_MAX) {
812 pa_log(__FILE__": recieved invalid request.");
813 return -1;
814 }
815
816 handler = proto_map+c->request;
817
818 /* pa_log(__FILE__": executing request #%u", c->request); */
819
820 if (!handler->proc) {
821 pa_log(__FILE__": recieved unimplemented request #%u.", c->request);
822 return -1;
823 }
824
825 if (handler->data_length == 0) {
826 c->read_data_length = 0;
827
828 if (handler->proc(c, c->request, NULL, 0) < 0)
829 return -1;
830
831 } else {
832 if (c->read_data_alloc < handler->data_length)
833 c->read_data = pa_xrealloc(c->read_data, c->read_data_alloc = handler->data_length);
834 assert(c->read_data);
835
836 c->state = ESD_NEEDS_REQDATA;
837 c->read_data_length = 0;
838 }
839 }
840
841 } else if (c->state == ESD_NEEDS_REQDATA) {
842 ssize_t r;
843 struct proto_handler *handler = proto_map+c->request;
844
845 assert(handler->proc);
846
847 assert(c->read_data && c->read_data_length < handler->data_length);
848
849 if ((r = pa_iochannel_read(c->io, (uint8_t*) c->read_data + c->read_data_length, handler->data_length - c->read_data_length)) <= 0) {
850 pa_log_debug(__FILE__": read() failed: %s", r < 0 ? strerror(errno) : "EOF");
851 return -1;
852 }
853
854 if ((c->read_data_length += r) >= handler->data_length) {
855 size_t l = c->read_data_length;
856 assert(handler->proc);
857
858 c->state = ESD_NEXT_REQUEST;
859 c->read_data_length = 0;
860
861 if (handler->proc(c, c->request, c->read_data, l) < 0)
862 return -1;
863 }
864 } else if (c->state == ESD_CACHING_SAMPLE) {
865 ssize_t r;
866
867 assert(c->scache.memchunk.memblock && c->scache.name && c->scache.memchunk.index < c->scache.memchunk.length);
868
869 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) {
870 pa_log_debug(__FILE__": read() failed: %s", r < 0 ? strerror(errno) : "EOF");
871 return -1;
872 }
873
874 c->scache.memchunk.index += r;
875 assert(c->scache.memchunk.index <= c->scache.memchunk.length);
876
877 if (c->scache.memchunk.index == c->scache.memchunk.length) {
878 uint32_t idx;
879
880 c->scache.memchunk.index = 0;
881 pa_scache_add_item(c->protocol->core, c->scache.name, &c->scache.sample_spec, NULL, &c->scache.memchunk, &idx);
882
883 pa_memblock_unref(c->scache.memchunk.memblock);
884 c->scache.memchunk.memblock = NULL;
885 c->scache.memchunk.index = c->scache.memchunk.length = 0;
886
887 pa_xfree(c->scache.name);
888 c->scache.name = NULL;
889
890 c->state = ESD_NEXT_REQUEST;
891
892 idx += 1;
893 connection_write(c, &idx, sizeof(uint32_t));
894 }
895
896 } else if (c->state == ESD_STREAMING_DATA && c->sink_input) {
897 pa_memchunk chunk;
898 ssize_t r;
899 size_t l;
900
901 assert(c->input_memblockq);
902
903 /* pa_log("STREAMING_DATA"); */
904
905 if (!(l = pa_memblockq_missing(c->input_memblockq)))
906 return 0;
907
908 if (l > c->playback.fragment_size)
909 l = c->playback.fragment_size;
910
911 if (c->playback.current_memblock)
912 if (c->playback.current_memblock->length - c->playback.memblock_index < l) {
913 pa_memblock_unref(c->playback.current_memblock);
914 c->playback.current_memblock = NULL;
915 c->playback.memblock_index = 0;
916 }
917
918 if (!c->playback.current_memblock) {
919 c->playback.current_memblock = pa_memblock_new(c->playback.fragment_size*2, c->protocol->core->memblock_stat);
920 assert(c->playback.current_memblock && c->playback.current_memblock->length >= l);
921 c->playback.memblock_index = 0;
922 }
923
924 if ((r = pa_iochannel_read(c->io, (uint8_t*) c->playback.current_memblock->data+c->playback.memblock_index, l)) <= 0) {
925 pa_log_debug(__FILE__": read() failed: %s", r < 0 ? strerror(errno) : "EOF");
926 return -1;
927 }
928
929 chunk.memblock = c->playback.current_memblock;
930 chunk.index = c->playback.memblock_index;
931 chunk.length = r;
932 assert(chunk.memblock);
933
934 c->playback.memblock_index += r;
935
936 assert(c->input_memblockq);
937 pa_memblockq_push_align(c->input_memblockq, &chunk);
938 assert(c->sink_input);
939 pa_sink_notify(c->sink_input->sink);
940 }
941
942 return 0;
943 }
944
945 static int do_write(struct connection *c) {
946 assert(c && c->io);
947
948 /* pa_log("WRITE"); */
949
950 if (c->write_data_length) {
951 ssize_t r;
952
953 assert(c->write_data_index < c->write_data_length);
954 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) {
955 pa_log(__FILE__": write() failed: %s", strerror(errno));
956 return -1;
957 }
958
959 if ((c->write_data_index +=r) >= c->write_data_length)
960 c->write_data_length = c->write_data_index = 0;
961
962 } else if (c->state == ESD_STREAMING_DATA && c->source_output) {
963 pa_memchunk chunk;
964 ssize_t r;
965
966 assert(c->output_memblockq);
967 if (pa_memblockq_peek(c->output_memblockq, &chunk) < 0)
968 return 0;
969
970 assert(chunk.memblock && chunk.length);
971
972 if ((r = pa_iochannel_write(c->io, (uint8_t*) chunk.memblock->data+chunk.index, chunk.length)) < 0) {
973 pa_memblock_unref(chunk.memblock);
974 pa_log(__FILE__": write(): %s", strerror(errno));
975 return -1;
976 }
977
978 pa_memblockq_drop(c->output_memblockq, &chunk, r);
979 pa_memblock_unref(chunk.memblock);
980
981 pa_source_notify(c->source_output->source);
982 }
983
984 return 0;
985 }
986
987 static void do_work(struct connection *c) {
988 assert(c);
989
990 assert(c->protocol && c->protocol->core && c->protocol->core->mainloop && c->protocol->core->mainloop->defer_enable);
991 c->protocol->core->mainloop->defer_enable(c->defer_event, 0);
992
993 if (c->dead)
994 return;
995
996 if (pa_iochannel_is_readable(c->io)) {
997 if (do_read(c) < 0)
998 goto fail;
999 }
1000
1001 if (c->state == ESD_STREAMING_DATA && c->source_output && pa_iochannel_is_hungup(c->io))
1002 /* In case we are in capture mode we will never call read()
1003 * on the socket, hence we need to detect the hangup manually
1004 * here, instead of simply waiting for read() to return 0. */
1005 goto fail;
1006
1007 if (pa_iochannel_is_writable(c->io))
1008 if (do_write(c) < 0)
1009 goto fail;
1010
1011 return;
1012
1013 fail:
1014
1015 if (c->state == ESD_STREAMING_DATA && c->sink_input) {
1016 c->dead = 1;
1017
1018 pa_iochannel_free(c->io);
1019 c->io = NULL;
1020
1021 pa_memblockq_prebuf_disable(c->input_memblockq);
1022 pa_sink_notify(c->sink_input->sink);
1023 } else
1024 connection_free(c);
1025 }
1026
1027 static void io_callback(pa_iochannel*io, void *userdata) {
1028 struct connection *c = userdata;
1029 assert(io && c && c->io == io);
1030
1031 do_work(c);
1032 }
1033
1034 /*** defer callback ***/
1035
1036 static void defer_callback(pa_mainloop_api*a, pa_defer_event *e, void *userdata) {
1037 struct connection *c = userdata;
1038 assert(a && c && c->defer_event == e);
1039
1040 /* pa_log("DEFER"); */
1041
1042 do_work(c);
1043 }
1044
1045 /*** sink_input callbacks ***/
1046
1047 static int sink_input_peek_cb(pa_sink_input *i, pa_memchunk *chunk) {
1048 struct connection*c;
1049 assert(i && i->userdata && chunk);
1050 c = i->userdata;
1051
1052 if (pa_memblockq_peek(c->input_memblockq, chunk) < 0) {
1053
1054 if (c->dead)
1055 connection_free(c);
1056
1057 return -1;
1058 }
1059
1060 return 0;
1061 }
1062
1063 static void sink_input_drop_cb(pa_sink_input *i, const pa_memchunk *chunk, size_t length) {
1064 struct connection*c = i->userdata;
1065 assert(i && c && length);
1066
1067 /* pa_log("DROP"); */
1068
1069 pa_memblockq_drop(c->input_memblockq, chunk, length);
1070
1071 /* do something */
1072 assert(c->protocol && c->protocol->core && c->protocol->core->mainloop && c->protocol->core->mainloop->defer_enable);
1073
1074 if (!c->dead)
1075 c->protocol->core->mainloop->defer_enable(c->defer_event, 1);
1076
1077 /* assert(pa_memblockq_get_length(c->input_memblockq) > 2048); */
1078 }
1079
1080 static void sink_input_kill_cb(pa_sink_input *i) {
1081 assert(i && i->userdata);
1082 connection_free((struct connection *) i->userdata);
1083 }
1084
1085 static pa_usec_t sink_input_get_latency_cb(pa_sink_input *i) {
1086 struct connection*c = i->userdata;
1087 assert(i && c);
1088 return pa_bytes_to_usec(pa_memblockq_get_length(c->input_memblockq), &c->sink_input->sample_spec);
1089 }
1090
1091 /*** source_output callbacks ***/
1092
1093 static void source_output_push_cb(pa_source_output *o, const pa_memchunk *chunk) {
1094 struct connection *c = o->userdata;
1095 assert(o && c && chunk);
1096
1097 pa_memblockq_push(c->output_memblockq, chunk);
1098
1099 /* do something */
1100 assert(c->protocol && c->protocol->core && c->protocol->core->mainloop && c->protocol->core->mainloop->defer_enable);
1101
1102 if (!c->dead)
1103 c->protocol->core->mainloop->defer_enable(c->defer_event, 1);
1104 }
1105
1106 static void source_output_kill_cb(pa_source_output *o) {
1107 assert(o && o->userdata);
1108 connection_free((struct connection *) o->userdata);
1109 }
1110
1111 static pa_usec_t source_output_get_latency_cb(pa_source_output *o) {
1112 struct connection*c = o->userdata;
1113 assert(o && c);
1114 return pa_bytes_to_usec(pa_memblockq_get_length(c->output_memblockq), &c->source_output->sample_spec);
1115 }
1116
1117 /*** socket server callback ***/
1118
1119 static void auth_timeout(pa_mainloop_api*m, pa_time_event *e, const struct timeval *tv, void *userdata) {
1120 struct connection *c = userdata;
1121 assert(m && tv && c && c->auth_timeout_event == e);
1122
1123 if (!c->authorized)
1124 connection_free(c);
1125 }
1126
1127 static void on_connection(pa_socket_server*s, pa_iochannel *io, void *userdata) {
1128 struct connection *c;
1129 pa_protocol_esound *p = userdata;
1130 char cname[256];
1131 assert(s && io && p);
1132
1133 if (pa_idxset_size(p->connections)+1 > MAX_CONNECTIONS) {
1134 pa_log(__FILE__": Warning! Too many connections (%u), dropping incoming connection.", MAX_CONNECTIONS);
1135 pa_iochannel_free(io);
1136 return;
1137 }
1138
1139 c = pa_xnew(struct connection, 1);
1140 c->protocol = p;
1141 c->io = io;
1142 pa_iochannel_set_callback(c->io, io_callback, c);
1143
1144 pa_iochannel_socket_peer_to_string(io, cname, sizeof(cname));
1145 assert(p->core);
1146 c->client = pa_client_new(p->core, __FILE__, cname);
1147 assert(c->client);
1148 c->client->owner = p->module;
1149 c->client->kill = client_kill_cb;
1150 c->client->userdata = c;
1151
1152 c->authorized = p->public;
1153 c->swap_byte_order = 0;
1154 c->dead = 0;
1155
1156 c->read_data_length = 0;
1157 c->read_data = pa_xmalloc(c->read_data_alloc = proto_map[ESD_PROTO_CONNECT].data_length);
1158
1159 c->write_data_length = c->write_data_index = c->write_data_alloc = 0;
1160 c->write_data = NULL;
1161
1162 c->state = ESD_NEEDS_REQDATA;
1163 c->request = ESD_PROTO_CONNECT;
1164
1165 c->sink_input = NULL;
1166 c->input_memblockq = NULL;
1167
1168 c->source_output = NULL;
1169 c->output_memblockq = NULL;
1170
1171 c->playback.current_memblock = NULL;
1172 c->playback.memblock_index = 0;
1173 c->playback.fragment_size = 0;
1174
1175 c->scache.memchunk.length = c->scache.memchunk.index = 0;
1176 c->scache.memchunk.memblock = NULL;
1177 c->scache.name = NULL;
1178
1179 if (!c->authorized) {
1180 struct timeval tv;
1181 pa_gettimeofday(&tv);
1182 tv.tv_sec += AUTH_TIMEOUT;
1183 c->auth_timeout_event = p->core->mainloop->time_new(p->core->mainloop, &tv, auth_timeout, c);
1184 } else
1185 c->auth_timeout_event = NULL;
1186
1187 c->defer_event = p->core->mainloop->defer_new(p->core->mainloop, defer_callback, c);
1188 assert(c->defer_event);
1189 p->core->mainloop->defer_enable(c->defer_event, 0);
1190
1191 pa_idxset_put(p->connections, c, &c->index);
1192 }
1193
1194 /*** entry points ***/
1195
1196 pa_protocol_esound* pa_protocol_esound_new(pa_core*core, pa_socket_server *server, pa_module *m, pa_modargs *ma) {
1197 pa_protocol_esound *p;
1198 int public = 0;
1199 assert(core && server && ma);
1200
1201 p = pa_xnew(pa_protocol_esound, 1);
1202
1203 if (pa_modargs_get_value_boolean(ma, "auth-anonymous", &public) < 0) {
1204 pa_log(__FILE__": auth-anonymous= expects a boolean argument.");
1205 return NULL;
1206 }
1207
1208 if (pa_authkey_load_auto(pa_modargs_get_value(ma, "cookie", DEFAULT_COOKIE_FILE), p->esd_key, sizeof(p->esd_key)) < 0) {
1209 pa_xfree(p);
1210 return NULL;
1211 }
1212
1213 p->module = m;
1214 p->public = public;
1215 p->server = server;
1216 pa_socket_server_set_callback(p->server, on_connection, p);
1217 p->core = core;
1218 p->connections = pa_idxset_new(NULL, NULL);
1219 assert(p->connections);
1220
1221 p->sink_name = pa_xstrdup(pa_modargs_get_value(ma, "sink", NULL));
1222 p->source_name = pa_xstrdup(pa_modargs_get_value(ma, "source", NULL));
1223 p->n_player = 0;
1224
1225 return p;
1226 }
1227
1228 void pa_protocol_esound_free(pa_protocol_esound *p) {
1229 struct connection *c;
1230 assert(p);
1231
1232 while ((c = pa_idxset_first(p->connections, NULL)))
1233 connection_free(c);
1234
1235 pa_idxset_free(p->connections, NULL, NULL);
1236 pa_socket_server_unref(p->server);
1237 pa_xfree(p);
1238 }