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
32 #include <pulse/xmalloc.h>
33 #include <pulse/timeval.h>
35 #include <pulsecore/sink-input.h>
36 #include <pulsecore/source-output.h>
37 #include <pulsecore/client.h>
38 #include <pulsecore/sample-util.h>
39 #include <pulsecore/namereg.h>
40 #include <pulsecore/log.h>
41 #include <pulsecore/core-error.h>
42 #include <pulsecore/atomic.h>
43 #include <pulsecore/thread-mq.h>
44 #include <pulsecore/core-util.h>
45 #include <pulsecore/shared.h>
47 #include "protocol-simple.h"
49 /* Don't allow more than this many concurrent connections */
50 #define MAX_CONNECTIONS 10
52 typedef struct connection {
54 pa_simple_protocol *protocol;
55 pa_simple_options *options;
57 pa_sink_input *sink_input;
58 pa_source_output *source_output;
60 pa_memblockq *input_memblockq, *output_memblockq;
65 pa_memblock *current_memblock;
66 size_t memblock_index;
72 PA_DEFINE_PRIVATE_CLASS(connection, pa_msgobject);
73 #define CONNECTION(o) (connection_cast(o))
75 struct pa_simple_protocol {
79 pa_idxset *connections;
83 SINK_INPUT_MESSAGE_POST_DATA = PA_SINK_INPUT_MESSAGE_MAX, /* data from main loop to sink input */
84 SINK_INPUT_MESSAGE_DISABLE_PREBUF /* disabled prebuf, get playback started. */
88 CONNECTION_MESSAGE_REQUEST_DATA, /* data requested from sink input from the main loop */
89 CONNECTION_MESSAGE_POST_DATA, /* data from source output to main loop */
90 CONNECTION_MESSAGE_UNLINK_CONNECTION /* Please drop a aconnection now */
93 #define PLAYBACK_BUFFER_SECONDS (.5)
94 #define PLAYBACK_BUFFER_FRAGMENTS (10)
95 #define RECORD_BUFFER_SECONDS (5)
96 #define DEFAULT_SINK_LATENCY (300*PA_USEC_PER_MSEC)
97 #define DEFAULT_SOURCE_LATENCY (300*PA_USEC_PER_MSEC)
99 static void connection_unlink(connection *c) {
106 pa_simple_options_unref(c->options);
111 pa_sink_input_unlink(c->sink_input);
112 pa_sink_input_unref(c->sink_input);
113 c->sink_input = NULL;
116 if (c->source_output) {
117 pa_source_output_unlink(c->source_output);
118 pa_source_output_unref(c->source_output);
119 c->source_output = NULL;
123 pa_client_free(c->client);
128 pa_iochannel_free(c->io);
132 pa_idxset_remove_by_data(c->protocol->connections, c, NULL);
137 static void connection_free(pa_object *o) {
138 connection *c = CONNECTION(o);
141 if (c->playback.current_memblock)
142 pa_memblock_unref(c->playback.current_memblock);
144 if (c->input_memblockq)
145 pa_memblockq_free(c->input_memblockq);
146 if (c->output_memblockq)
147 pa_memblockq_free(c->output_memblockq);
152 static int do_read(connection *c) {
159 connection_assert_ref(c);
161 if (!c->sink_input || (l = (size_t) pa_atomic_load(&c->playback.missing)) <= 0)
164 if (c->playback.current_memblock) {
166 space = pa_memblock_get_length(c->playback.current_memblock) - c->playback.memblock_index;
169 pa_memblock_unref(c->playback.current_memblock);
170 c->playback.current_memblock = NULL;
174 if (!c->playback.current_memblock) {
175 pa_assert_se(c->playback.current_memblock = pa_memblock_new(c->protocol->core->mempool, (size_t) -1));
176 c->playback.memblock_index = 0;
178 space = pa_memblock_get_length(c->playback.current_memblock);
184 p = pa_memblock_acquire(c->playback.current_memblock);
185 r = pa_iochannel_read(c->io, (uint8_t*) p + c->playback.memblock_index, l);
186 pa_memblock_release(c->playback.current_memblock);
190 if (r < 0 && (errno == EINTR || errno == EAGAIN))
193 pa_log_debug("read(): %s", r == 0 ? "EOF" : pa_cstrerror(errno));
197 chunk.memblock = c->playback.current_memblock;
198 chunk.index = c->playback.memblock_index;
199 chunk.length = (size_t) r;
201 c->playback.memblock_index += (size_t) r;
203 pa_asyncmsgq_post(c->sink_input->sink->asyncmsgq, PA_MSGOBJECT(c->sink_input), SINK_INPUT_MESSAGE_POST_DATA, NULL, 0, &chunk, NULL);
204 pa_atomic_sub(&c->playback.missing, (int) r);
209 static int do_write(connection *c) {
214 connection_assert_ref(c);
216 if (!c->source_output)
219 if (pa_memblockq_peek(c->output_memblockq, &chunk) < 0) {
220 /* pa_log("peek failed"); */
224 pa_assert(chunk.memblock);
225 pa_assert(chunk.length);
227 p = pa_memblock_acquire(chunk.memblock);
228 r = pa_iochannel_write(c->io, (uint8_t*) p+chunk.index, chunk.length);
229 pa_memblock_release(chunk.memblock);
231 pa_memblock_unref(chunk.memblock);
235 if (errno == EINTR || errno == EAGAIN)
238 pa_log("write(): %s", pa_cstrerror(errno));
242 pa_memblockq_drop(c->output_memblockq, (size_t) r);
247 static void do_work(connection *c) {
248 connection_assert_ref(c);
253 if (pa_iochannel_is_readable(c->io))
257 if (!c->sink_input && pa_iochannel_is_hungup(c->io))
260 if (pa_iochannel_is_writable(c->io))
270 /* If there is a sink input, we first drain what we already have read before shutting down the connection */
273 pa_iochannel_free(c->io);
276 pa_asyncmsgq_post(c->sink_input->sink->asyncmsgq, PA_MSGOBJECT(c->sink_input), SINK_INPUT_MESSAGE_DISABLE_PREBUF, NULL, 0, NULL, NULL);
278 connection_unlink(c);
281 static int connection_process_msg(pa_msgobject *o, int code, void*userdata, int64_t offset, pa_memchunk *chunk) {
282 connection *c = CONNECTION(o);
283 connection_assert_ref(c);
289 case CONNECTION_MESSAGE_REQUEST_DATA:
293 case CONNECTION_MESSAGE_POST_DATA:
294 /* pa_log("got data %u", chunk->length); */
295 pa_memblockq_push_align(c->output_memblockq, chunk);
299 case CONNECTION_MESSAGE_UNLINK_CONNECTION:
300 connection_unlink(c);
307 /*** sink_input callbacks ***/
309 /* Called from thread context */
310 static int sink_input_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
311 pa_sink_input *i = PA_SINK_INPUT(o);
314 pa_sink_input_assert_ref(i);
315 c = CONNECTION(i->userdata);
316 connection_assert_ref(c);
320 case SINK_INPUT_MESSAGE_POST_DATA: {
323 /* New data from the main loop */
324 pa_memblockq_push_align(c->input_memblockq, chunk);
326 if (pa_memblockq_is_readable(c->input_memblockq) && c->playback.underrun) {
327 pa_log_debug("Requesting rewind due to end of underrun.");
328 pa_sink_input_request_rewind(c->sink_input, 0, FALSE, TRUE, FALSE);
331 /* pa_log("got data, %u", pa_memblockq_get_length(c->input_memblockq)); */
336 case SINK_INPUT_MESSAGE_DISABLE_PREBUF:
337 pa_memblockq_prebuf_disable(c->input_memblockq);
340 case PA_SINK_INPUT_MESSAGE_GET_LATENCY: {
341 pa_usec_t *r = userdata;
343 *r = pa_bytes_to_usec(pa_memblockq_get_length(c->input_memblockq), &c->sink_input->sample_spec);
345 /* Fall through, the default handler will add in the extra
346 * latency added by the resampler */
350 return pa_sink_input_process_msg(o, code, userdata, offset, chunk);
354 /* Called from thread context */
355 static int sink_input_pop_cb(pa_sink_input *i, size_t length, pa_memchunk *chunk) {
358 pa_sink_input_assert_ref(i);
359 c = CONNECTION(i->userdata);
360 connection_assert_ref(c);
363 if (pa_memblockq_peek(c->input_memblockq, chunk) < 0) {
365 c->playback.underrun = TRUE;
367 if (c->dead && pa_sink_input_safe_to_remove(i))
368 pa_asyncmsgq_post(pa_thread_mq_get()->outq, PA_MSGOBJECT(c), CONNECTION_MESSAGE_UNLINK_CONNECTION, NULL, 0, NULL, NULL);
374 chunk->length = PA_MIN(length, chunk->length);
376 c->playback.underrun = FALSE;
378 pa_memblockq_drop(c->input_memblockq, chunk->length);
379 m = pa_memblockq_pop_missing(c->input_memblockq);
382 if (pa_atomic_add(&c->playback.missing, (int) m) <= 0)
383 pa_asyncmsgq_post(pa_thread_mq_get()->outq, PA_MSGOBJECT(c), CONNECTION_MESSAGE_REQUEST_DATA, NULL, 0, NULL, NULL);
389 /* Called from thread context */
390 static void sink_input_process_rewind_cb(pa_sink_input *i, size_t nbytes) {
393 pa_sink_input_assert_ref(i);
394 c = CONNECTION(i->userdata);
395 connection_assert_ref(c);
397 /* If we are in an underrun, then we don't rewind */
398 if (i->thread_info.underrun_for > 0)
401 pa_memblockq_rewind(c->input_memblockq, nbytes);
404 /* Called from thread context */
405 static void sink_input_update_max_rewind_cb(pa_sink_input *i, size_t nbytes) {
408 pa_sink_input_assert_ref(i);
409 c = CONNECTION(i->userdata);
410 connection_assert_ref(c);
412 pa_memblockq_set_maxrewind(c->input_memblockq, nbytes);
415 /* Called from main context */
416 static void sink_input_kill_cb(pa_sink_input *i) {
417 pa_sink_input_assert_ref(i);
419 connection_unlink(CONNECTION(i->userdata));
422 /*** source_output callbacks ***/
424 /* Called from thread context */
425 static void source_output_push_cb(pa_source_output *o, const pa_memchunk *chunk) {
428 pa_source_output_assert_ref(o);
429 c = CONNECTION(o->userdata);
433 pa_asyncmsgq_post(pa_thread_mq_get()->outq, PA_MSGOBJECT(c), CONNECTION_MESSAGE_POST_DATA, NULL, 0, chunk, NULL);
436 /* Called from main context */
437 static void source_output_kill_cb(pa_source_output *o) {
438 pa_source_output_assert_ref(o);
440 connection_unlink(CONNECTION(o->userdata));
443 /* Called from main context */
444 static pa_usec_t source_output_get_latency_cb(pa_source_output *o) {
447 pa_source_output_assert_ref(o);
448 c = CONNECTION(o->userdata);
451 return pa_bytes_to_usec(pa_memblockq_get_length(c->output_memblockq), &c->source_output->sample_spec);
454 /*** client callbacks ***/
456 static void client_kill_cb(pa_client *client) {
460 c = CONNECTION(client->userdata);
463 connection_unlink(c);
466 /*** pa_iochannel callbacks ***/
468 static void io_callback(pa_iochannel*io, void *userdata) {
469 connection *c = CONNECTION(userdata);
471 connection_assert_ref(c);
477 /*** socket_server callbacks ***/
479 void pa_simple_protocol_connect(pa_simple_protocol *p, pa_iochannel *io, pa_simple_options *o) {
480 connection *c = NULL;
482 pa_client_new_data client_data;
488 if (pa_idxset_size(p->connections)+1 > MAX_CONNECTIONS) {
489 pa_log("Warning! Too many connections (%u), dropping incoming connection.", MAX_CONNECTIONS);
490 pa_iochannel_free(io);
494 c = pa_msgobject_new(connection);
495 c->parent.parent.free = connection_free;
496 c->parent.process_msg = connection_process_msg;
498 pa_iochannel_set_callback(c->io, io_callback, c);
500 c->sink_input = NULL;
501 c->source_output = NULL;
502 c->input_memblockq = c->output_memblockq = NULL;
504 c->options = pa_simple_options_ref(o);
505 c->playback.current_memblock = NULL;
506 c->playback.memblock_index = 0;
508 c->playback.underrun = TRUE;
509 pa_atomic_store(&c->playback.missing, 0);
511 pa_client_new_data_init(&client_data);
512 client_data.module = o->module;
513 client_data.driver = __FILE__;
514 pa_iochannel_socket_peer_to_string(io, pname, sizeof(pname));
515 pa_proplist_setf(client_data.proplist, PA_PROP_APPLICATION_NAME, "Simple client (%s)", pname);
516 pa_proplist_sets(client_data.proplist, "simple-protocol.peer", pname);
517 c->client = pa_client_new(p->core, &client_data);
518 pa_client_new_data_done(&client_data);
523 c->client->kill = client_kill_cb;
524 c->client->userdata = c;
527 pa_sink_input_new_data data;
531 if (!(sink = pa_namereg_get(c->protocol->core, o->default_sink, PA_NAMEREG_SINK))) {
532 pa_log("Failed to get sink.");
536 pa_sink_input_new_data_init(&data);
537 data.driver = __FILE__;
538 data.module = o->module;
539 data.client = c->client;
541 pa_proplist_update(data.proplist, PA_UPDATE_MERGE, c->client->proplist);
542 pa_sink_input_new_data_set_sample_spec(&data, &o->sample_spec);
544 pa_sink_input_new(&c->sink_input, p->core, &data, 0);
545 pa_sink_input_new_data_done(&data);
547 if (!c->sink_input) {
548 pa_log("Failed to create sink input.");
552 c->sink_input->parent.process_msg = sink_input_process_msg;
553 c->sink_input->pop = sink_input_pop_cb;
554 c->sink_input->process_rewind = sink_input_process_rewind_cb;
555 c->sink_input->update_max_rewind = sink_input_update_max_rewind_cb;
556 c->sink_input->kill = sink_input_kill_cb;
557 c->sink_input->userdata = c;
559 pa_sink_input_set_requested_latency(c->sink_input, DEFAULT_SINK_LATENCY);
561 l = (size_t) ((double) pa_bytes_per_second(&o->sample_spec)*PLAYBACK_BUFFER_SECONDS);
562 c->input_memblockq = pa_memblockq_new(
566 pa_frame_size(&o->sample_spec),
568 l/PLAYBACK_BUFFER_FRAGMENTS,
571 pa_iochannel_socket_set_rcvbuf(io, l);
573 pa_atomic_store(&c->playback.missing, (int) pa_memblockq_missing(c->input_memblockq));
575 pa_sink_input_put(c->sink_input);
579 pa_source_output_new_data data;
583 if (!(source = pa_namereg_get(c->protocol->core, o->default_source, PA_NAMEREG_SOURCE))) {
584 pa_log("Failed to get source.");
588 pa_source_output_new_data_init(&data);
589 data.driver = __FILE__;
590 data.module = o->module;
591 data.client = c->client;
592 data.source = source;
593 pa_proplist_update(data.proplist, PA_UPDATE_MERGE, c->client->proplist);
594 pa_source_output_new_data_set_sample_spec(&data, &o->sample_spec);
596 pa_source_output_new(&c->source_output, p->core, &data, 0);
597 pa_source_output_new_data_done(&data);
599 if (!c->source_output) {
600 pa_log("Failed to create source output.");
603 c->source_output->push = source_output_push_cb;
604 c->source_output->kill = source_output_kill_cb;
605 c->source_output->get_latency = source_output_get_latency_cb;
606 c->source_output->userdata = c;
608 pa_source_output_set_requested_latency(c->source_output, DEFAULT_SOURCE_LATENCY);
610 l = (size_t) (pa_bytes_per_second(&o->sample_spec)*RECORD_BUFFER_SECONDS);
611 c->output_memblockq = pa_memblockq_new(
615 pa_frame_size(&o->sample_spec),
620 pa_iochannel_socket_set_sndbuf(io, l);
622 pa_source_output_put(c->source_output);
625 pa_idxset_put(p->connections, c, NULL);
631 connection_unlink(c);
634 void pa_simple_protocol_disconnect(pa_simple_protocol *p, pa_module *m) {
641 while ((c = pa_idxset_iterate(p->connections, &state, NULL)))
642 if (c->options->module == m)
643 connection_unlink(c);
646 static pa_simple_protocol* simple_protocol_new(pa_core *c) {
647 pa_simple_protocol *p;
651 p = pa_xnew(pa_simple_protocol, 1);
654 p->connections = pa_idxset_new(NULL, NULL);
656 pa_assert_se(pa_shared_set(c, "simple-protocol", p) >= 0);
661 pa_simple_protocol* pa_simple_protocol_get(pa_core *c) {
662 pa_simple_protocol *p;
664 if ((p = pa_shared_get(c, "simple-protocol")))
665 return pa_simple_protocol_ref(p);
667 return simple_protocol_new(c);
670 pa_simple_protocol* pa_simple_protocol_ref(pa_simple_protocol *p) {
672 pa_assert(PA_REFCNT_VALUE(p) >= 1);
679 void pa_simple_protocol_unref(pa_simple_protocol *p) {
682 pa_assert(PA_REFCNT_VALUE(p) >= 1);
684 if (PA_REFCNT_DEC(p) > 0)
687 while ((c = pa_idxset_first(p->connections, NULL)))
688 connection_unlink(c);
690 pa_idxset_free(p->connections, NULL, NULL);
692 pa_assert_se(pa_shared_remove(p->core, "simple-protocol") >= 0);
697 pa_simple_options* pa_simple_options_new(void) {
698 pa_simple_options *o;
700 o = pa_xnew0(pa_simple_options, 1);
709 pa_simple_options* pa_simple_options_ref(pa_simple_options *o) {
711 pa_assert(PA_REFCNT_VALUE(o) >= 1);
718 void pa_simple_options_unref(pa_simple_options *o) {
720 pa_assert(PA_REFCNT_VALUE(o) >= 1);
722 if (PA_REFCNT_DEC(o) > 0)
725 pa_xfree(o->default_sink);
726 pa_xfree(o->default_source);
731 int pa_simple_options_parse(pa_simple_options *o, pa_core *c, pa_modargs *ma) {
735 pa_assert(PA_REFCNT_VALUE(o) >= 1);
738 o->sample_spec = c->default_sample_spec;
739 if (pa_modargs_get_sample_spec_and_channel_map(ma, &o->sample_spec, &o->channel_map, PA_CHANNEL_MAP_DEFAULT) < 0) {
740 pa_log("Failed to parse sample type specification.");
744 pa_xfree(o->default_source);
745 o->default_source = pa_xstrdup(pa_modargs_get_value(ma, "source", NULL));
747 pa_xfree(o->default_sink);
748 o->default_sink = pa_xstrdup(pa_modargs_get_value(ma, "sink", NULL));
751 if (pa_modargs_get_value_boolean(ma, "record", &enabled) < 0) {
752 pa_log("record= expects a boolean argument.");
757 enabled = o->playback;
758 if (pa_modargs_get_value_boolean(ma, "playback", &enabled) < 0) {
759 pa_log("playback= expects a boolean argument.");
762 o->playback = enabled;
764 if (!o->playback && !o->record) {
765 pa_log("neither playback nor recording enabled for protocol.");