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_DECLARE_CLASS(connection
);
73 #define CONNECTION(o) (connection_cast(o))
74 static PA_DEFINE_CHECK_TYPE(connection
, pa_msgobject
);
76 struct pa_simple_protocol
{
80 pa_idxset
*connections
;
84 SINK_INPUT_MESSAGE_POST_DATA
= PA_SINK_INPUT_MESSAGE_MAX
, /* data from main loop to sink input */
85 SINK_INPUT_MESSAGE_DISABLE_PREBUF
/* disabled prebuf, get playback started. */
89 CONNECTION_MESSAGE_REQUEST_DATA
, /* data requested from sink input from the main loop */
90 CONNECTION_MESSAGE_POST_DATA
, /* data from source output to main loop */
91 CONNECTION_MESSAGE_UNLINK_CONNECTION
/* Please drop a aconnection now */
94 #define PLAYBACK_BUFFER_SECONDS (.5)
95 #define PLAYBACK_BUFFER_FRAGMENTS (10)
96 #define RECORD_BUFFER_SECONDS (5)
97 #define DEFAULT_SINK_LATENCY (300*PA_USEC_PER_MSEC)
98 #define DEFAULT_SOURCE_LATENCY (300*PA_USEC_PER_MSEC)
100 static void connection_unlink(connection
*c
) {
107 pa_simple_options_unref(c
->options
);
112 pa_sink_input_unlink(c
->sink_input
);
113 pa_sink_input_unref(c
->sink_input
);
114 c
->sink_input
= NULL
;
117 if (c
->source_output
) {
118 pa_source_output_unlink(c
->source_output
);
119 pa_source_output_unref(c
->source_output
);
120 c
->source_output
= NULL
;
124 pa_client_free(c
->client
);
129 pa_iochannel_free(c
->io
);
133 pa_idxset_remove_by_data(c
->protocol
->connections
, c
, NULL
);
138 static void connection_free(pa_object
*o
) {
139 connection
*c
= CONNECTION(o
);
142 if (c
->playback
.current_memblock
)
143 pa_memblock_unref(c
->playback
.current_memblock
);
145 if (c
->input_memblockq
)
146 pa_memblockq_free(c
->input_memblockq
);
147 if (c
->output_memblockq
)
148 pa_memblockq_free(c
->output_memblockq
);
153 static int do_read(connection
*c
) {
160 connection_assert_ref(c
);
162 if (!c
->sink_input
|| (l
= (size_t) pa_atomic_load(&c
->playback
.missing
)) <= 0)
165 if (c
->playback
.current_memblock
) {
167 space
= pa_memblock_get_length(c
->playback
.current_memblock
) - c
->playback
.memblock_index
;
170 pa_memblock_unref(c
->playback
.current_memblock
);
171 c
->playback
.current_memblock
= NULL
;
175 if (!c
->playback
.current_memblock
) {
176 pa_assert_se(c
->playback
.current_memblock
= pa_memblock_new(c
->protocol
->core
->mempool
, (size_t) -1));
177 c
->playback
.memblock_index
= 0;
179 space
= pa_memblock_get_length(c
->playback
.current_memblock
);
185 p
= pa_memblock_acquire(c
->playback
.current_memblock
);
186 r
= pa_iochannel_read(c
->io
, (uint8_t*) p
+ c
->playback
.memblock_index
, l
);
187 pa_memblock_release(c
->playback
.current_memblock
);
191 if (r
< 0 && (errno
== EINTR
|| errno
== EAGAIN
))
194 pa_log_debug("read(): %s", r
== 0 ? "EOF" : pa_cstrerror(errno
));
198 chunk
.memblock
= c
->playback
.current_memblock
;
199 chunk
.index
= c
->playback
.memblock_index
;
200 chunk
.length
= (size_t) r
;
202 c
->playback
.memblock_index
+= (size_t) r
;
204 pa_asyncmsgq_post(c
->sink_input
->sink
->asyncmsgq
, PA_MSGOBJECT(c
->sink_input
), SINK_INPUT_MESSAGE_POST_DATA
, NULL
, 0, &chunk
, NULL
);
205 pa_atomic_sub(&c
->playback
.missing
, (int) r
);
210 static int do_write(connection
*c
) {
215 connection_assert_ref(c
);
217 if (!c
->source_output
)
220 if (pa_memblockq_peek(c
->output_memblockq
, &chunk
) < 0) {
221 /* pa_log("peek failed"); */
225 pa_assert(chunk
.memblock
);
226 pa_assert(chunk
.length
);
228 p
= pa_memblock_acquire(chunk
.memblock
);
229 r
= pa_iochannel_write(c
->io
, (uint8_t*) p
+chunk
.index
, chunk
.length
);
230 pa_memblock_release(chunk
.memblock
);
232 pa_memblock_unref(chunk
.memblock
);
236 if (errno
== EINTR
|| errno
== EAGAIN
)
239 pa_log("write(): %s", pa_cstrerror(errno
));
243 pa_memblockq_drop(c
->output_memblockq
, (size_t) r
);
248 static void do_work(connection
*c
) {
249 connection_assert_ref(c
);
254 if (pa_iochannel_is_readable(c
->io
))
258 if (!c
->sink_input
&& pa_iochannel_is_hungup(c
->io
))
261 if (pa_iochannel_is_writable(c
->io
))
271 /* If there is a sink input, we first drain what we already have read before shutting down the connection */
274 pa_iochannel_free(c
->io
);
277 pa_asyncmsgq_post(c
->sink_input
->sink
->asyncmsgq
, PA_MSGOBJECT(c
->sink_input
), SINK_INPUT_MESSAGE_DISABLE_PREBUF
, NULL
, 0, NULL
, NULL
);
279 connection_unlink(c
);
282 static int connection_process_msg(pa_msgobject
*o
, int code
, void*userdata
, int64_t offset
, pa_memchunk
*chunk
) {
283 connection
*c
= CONNECTION(o
);
284 connection_assert_ref(c
);
290 case CONNECTION_MESSAGE_REQUEST_DATA
:
294 case CONNECTION_MESSAGE_POST_DATA
:
295 /* pa_log("got data %u", chunk->length); */
296 pa_memblockq_push_align(c
->output_memblockq
, chunk
);
300 case CONNECTION_MESSAGE_UNLINK_CONNECTION
:
301 connection_unlink(c
);
308 /*** sink_input callbacks ***/
310 /* Called from thread context */
311 static int sink_input_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
) {
312 pa_sink_input
*i
= PA_SINK_INPUT(o
);
315 pa_sink_input_assert_ref(i
);
316 c
= CONNECTION(i
->userdata
);
317 connection_assert_ref(c
);
321 case SINK_INPUT_MESSAGE_POST_DATA
: {
324 /* New data from the main loop */
325 pa_memblockq_push_align(c
->input_memblockq
, chunk
);
327 if (pa_memblockq_is_readable(c
->input_memblockq
) && c
->playback
.underrun
) {
328 pa_log_debug("Requesting rewind due to end of underrun.");
329 pa_sink_input_request_rewind(c
->sink_input
, 0, FALSE
, TRUE
, FALSE
);
332 /* pa_log("got data, %u", pa_memblockq_get_length(c->input_memblockq)); */
337 case SINK_INPUT_MESSAGE_DISABLE_PREBUF
:
338 pa_memblockq_prebuf_disable(c
->input_memblockq
);
341 case PA_SINK_INPUT_MESSAGE_GET_LATENCY
: {
342 pa_usec_t
*r
= userdata
;
344 *r
= pa_bytes_to_usec(pa_memblockq_get_length(c
->input_memblockq
), &c
->sink_input
->sample_spec
);
346 /* Fall through, the default handler will add in the extra
347 * latency added by the resampler */
351 return pa_sink_input_process_msg(o
, code
, userdata
, offset
, chunk
);
355 /* Called from thread context */
356 static int sink_input_pop_cb(pa_sink_input
*i
, size_t length
, pa_memchunk
*chunk
) {
359 pa_sink_input_assert_ref(i
);
360 c
= CONNECTION(i
->userdata
);
361 connection_assert_ref(c
);
364 if (pa_memblockq_peek(c
->input_memblockq
, chunk
) < 0) {
366 c
->playback
.underrun
= TRUE
;
368 if (c
->dead
&& pa_sink_input_safe_to_remove(i
))
369 pa_asyncmsgq_post(pa_thread_mq_get()->outq
, PA_MSGOBJECT(c
), CONNECTION_MESSAGE_UNLINK_CONNECTION
, NULL
, 0, NULL
, NULL
);
375 chunk
->length
= PA_MIN(length
, chunk
->length
);
377 c
->playback
.underrun
= FALSE
;
379 pa_memblockq_drop(c
->input_memblockq
, chunk
->length
);
380 m
= pa_memblockq_pop_missing(c
->input_memblockq
);
383 if (pa_atomic_add(&c
->playback
.missing
, (int) m
) <= 0)
384 pa_asyncmsgq_post(pa_thread_mq_get()->outq
, PA_MSGOBJECT(c
), CONNECTION_MESSAGE_REQUEST_DATA
, NULL
, 0, NULL
, NULL
);
390 /* Called from thread context */
391 static void sink_input_process_rewind_cb(pa_sink_input
*i
, size_t nbytes
) {
394 pa_sink_input_assert_ref(i
);
395 c
= CONNECTION(i
->userdata
);
396 connection_assert_ref(c
);
398 /* If we are in an underrun, then we don't rewind */
399 if (i
->thread_info
.underrun_for
> 0)
402 pa_memblockq_rewind(c
->input_memblockq
, nbytes
);
405 /* Called from thread context */
406 static void sink_input_update_max_rewind_cb(pa_sink_input
*i
, size_t nbytes
) {
409 pa_sink_input_assert_ref(i
);
410 c
= CONNECTION(i
->userdata
);
411 connection_assert_ref(c
);
413 pa_memblockq_set_maxrewind(c
->input_memblockq
, nbytes
);
416 /* Called from main context */
417 static void sink_input_kill_cb(pa_sink_input
*i
) {
418 pa_sink_input_assert_ref(i
);
420 connection_unlink(CONNECTION(i
->userdata
));
423 /*** source_output callbacks ***/
425 /* Called from thread context */
426 static void source_output_push_cb(pa_source_output
*o
, const pa_memchunk
*chunk
) {
429 pa_source_output_assert_ref(o
);
430 c
= CONNECTION(o
->userdata
);
434 pa_asyncmsgq_post(pa_thread_mq_get()->outq
, PA_MSGOBJECT(c
), CONNECTION_MESSAGE_POST_DATA
, NULL
, 0, chunk
, NULL
);
437 /* Called from main context */
438 static void source_output_kill_cb(pa_source_output
*o
) {
439 pa_source_output_assert_ref(o
);
441 connection_unlink(CONNECTION(o
->userdata
));
444 /* Called from main context */
445 static pa_usec_t
source_output_get_latency_cb(pa_source_output
*o
) {
448 pa_source_output_assert_ref(o
);
449 c
= CONNECTION(o
->userdata
);
452 return pa_bytes_to_usec(pa_memblockq_get_length(c
->output_memblockq
), &c
->source_output
->sample_spec
);
455 /*** client callbacks ***/
457 static void client_kill_cb(pa_client
*client
) {
461 c
= CONNECTION(client
->userdata
);
464 connection_unlink(c
);
467 /*** pa_iochannel callbacks ***/
469 static void io_callback(pa_iochannel
*io
, void *userdata
) {
470 connection
*c
= CONNECTION(userdata
);
472 connection_assert_ref(c
);
478 /*** socket_server callbacks ***/
480 void pa_simple_protocol_connect(pa_simple_protocol
*p
, pa_iochannel
*io
, pa_simple_options
*o
) {
481 connection
*c
= NULL
;
483 pa_client_new_data client_data
;
489 if (pa_idxset_size(p
->connections
)+1 > MAX_CONNECTIONS
) {
490 pa_log("Warning! Too many connections (%u), dropping incoming connection.", MAX_CONNECTIONS
);
491 pa_iochannel_free(io
);
495 c
= pa_msgobject_new(connection
);
496 c
->parent
.parent
.free
= connection_free
;
497 c
->parent
.process_msg
= connection_process_msg
;
499 pa_iochannel_set_callback(c
->io
, io_callback
, c
);
501 c
->sink_input
= NULL
;
502 c
->source_output
= NULL
;
503 c
->input_memblockq
= c
->output_memblockq
= NULL
;
505 c
->options
= pa_simple_options_ref(o
);
506 c
->playback
.current_memblock
= NULL
;
507 c
->playback
.memblock_index
= 0;
509 c
->playback
.underrun
= TRUE
;
510 pa_atomic_store(&c
->playback
.missing
, 0);
512 pa_client_new_data_init(&client_data
);
513 client_data
.module
= o
->module
;
514 client_data
.driver
= __FILE__
;
515 pa_iochannel_socket_peer_to_string(io
, pname
, sizeof(pname
));
516 pa_proplist_setf(client_data
.proplist
, PA_PROP_APPLICATION_NAME
, "Simple client (%s)", pname
);
517 pa_proplist_sets(client_data
.proplist
, "simple-protocol.peer", pname
);
518 c
->client
= pa_client_new(p
->core
, &client_data
);
519 pa_client_new_data_done(&client_data
);
524 c
->client
->kill
= client_kill_cb
;
525 c
->client
->userdata
= c
;
528 pa_sink_input_new_data data
;
532 if (!(sink
= pa_namereg_get(c
->protocol
->core
, o
->default_sink
, PA_NAMEREG_SINK
))) {
533 pa_log("Failed to get sink.");
537 pa_sink_input_new_data_init(&data
);
538 data
.driver
= __FILE__
;
539 data
.module
= o
->module
;
540 data
.client
= c
->client
;
542 pa_proplist_update(data
.proplist
, PA_UPDATE_MERGE
, c
->client
->proplist
);
543 pa_sink_input_new_data_set_sample_spec(&data
, &o
->sample_spec
);
545 pa_sink_input_new(&c
->sink_input
, p
->core
, &data
, 0);
546 pa_sink_input_new_data_done(&data
);
548 if (!c
->sink_input
) {
549 pa_log("Failed to create sink input.");
553 c
->sink_input
->parent
.process_msg
= sink_input_process_msg
;
554 c
->sink_input
->pop
= sink_input_pop_cb
;
555 c
->sink_input
->process_rewind
= sink_input_process_rewind_cb
;
556 c
->sink_input
->update_max_rewind
= sink_input_update_max_rewind_cb
;
557 c
->sink_input
->kill
= sink_input_kill_cb
;
558 c
->sink_input
->userdata
= c
;
560 pa_sink_input_set_requested_latency(c
->sink_input
, DEFAULT_SINK_LATENCY
);
562 l
= (size_t) ((double) pa_bytes_per_second(&o
->sample_spec
)*PLAYBACK_BUFFER_SECONDS
);
563 c
->input_memblockq
= pa_memblockq_new(
567 pa_frame_size(&o
->sample_spec
),
569 l
/PLAYBACK_BUFFER_FRAGMENTS
,
572 pa_iochannel_socket_set_rcvbuf(io
, l
);
574 pa_atomic_store(&c
->playback
.missing
, (int) pa_memblockq_missing(c
->input_memblockq
));
576 pa_sink_input_put(c
->sink_input
);
580 pa_source_output_new_data data
;
584 if (!(source
= pa_namereg_get(c
->protocol
->core
, o
->default_source
, PA_NAMEREG_SOURCE
))) {
585 pa_log("Failed to get source.");
589 pa_source_output_new_data_init(&data
);
590 data
.driver
= __FILE__
;
591 data
.module
= o
->module
;
592 data
.client
= c
->client
;
593 data
.source
= source
;
594 pa_proplist_update(data
.proplist
, PA_UPDATE_MERGE
, c
->client
->proplist
);
595 pa_source_output_new_data_set_sample_spec(&data
, &o
->sample_spec
);
597 pa_source_output_new(&c
->source_output
, p
->core
, &data
, 0);
598 pa_source_output_new_data_done(&data
);
600 if (!c
->source_output
) {
601 pa_log("Failed to create source output.");
604 c
->source_output
->push
= source_output_push_cb
;
605 c
->source_output
->kill
= source_output_kill_cb
;
606 c
->source_output
->get_latency
= source_output_get_latency_cb
;
607 c
->source_output
->userdata
= c
;
609 pa_source_output_set_requested_latency(c
->source_output
, DEFAULT_SOURCE_LATENCY
);
611 l
= (size_t) (pa_bytes_per_second(&o
->sample_spec
)*RECORD_BUFFER_SECONDS
);
612 c
->output_memblockq
= pa_memblockq_new(
616 pa_frame_size(&o
->sample_spec
),
621 pa_iochannel_socket_set_sndbuf(io
, l
);
623 pa_source_output_put(c
->source_output
);
626 pa_idxset_put(p
->connections
, c
, NULL
);
632 connection_unlink(c
);
635 void pa_simple_protocol_disconnect(pa_simple_protocol
*p
, pa_module
*m
) {
642 while ((c
= pa_idxset_iterate(p
->connections
, &state
, NULL
)))
643 if (c
->options
->module
== m
)
644 connection_unlink(c
);
647 static pa_simple_protocol
* simple_protocol_new(pa_core
*c
) {
648 pa_simple_protocol
*p
;
652 p
= pa_xnew(pa_simple_protocol
, 1);
655 p
->connections
= pa_idxset_new(NULL
, NULL
);
657 pa_assert_se(pa_shared_set(c
, "simple-protocol", p
) >= 0);
662 pa_simple_protocol
* pa_simple_protocol_get(pa_core
*c
) {
663 pa_simple_protocol
*p
;
665 if ((p
= pa_shared_get(c
, "simple-protocol")))
666 return pa_simple_protocol_ref(p
);
668 return simple_protocol_new(c
);
671 pa_simple_protocol
* pa_simple_protocol_ref(pa_simple_protocol
*p
) {
673 pa_assert(PA_REFCNT_VALUE(p
) >= 1);
680 void pa_simple_protocol_unref(pa_simple_protocol
*p
) {
683 pa_assert(PA_REFCNT_VALUE(p
) >= 1);
685 if (PA_REFCNT_DEC(p
) > 0)
688 while ((c
= pa_idxset_first(p
->connections
, NULL
)))
689 connection_unlink(c
);
691 pa_idxset_free(p
->connections
, NULL
, NULL
);
693 pa_assert_se(pa_shared_remove(p
->core
, "simple-protocol") >= 0);
698 pa_simple_options
* pa_simple_options_new(void) {
699 pa_simple_options
*o
;
701 o
= pa_xnew0(pa_simple_options
, 1);
710 pa_simple_options
* pa_simple_options_ref(pa_simple_options
*o
) {
712 pa_assert(PA_REFCNT_VALUE(o
) >= 1);
719 void pa_simple_options_unref(pa_simple_options
*o
) {
721 pa_assert(PA_REFCNT_VALUE(o
) >= 1);
723 if (PA_REFCNT_DEC(o
) > 0)
726 pa_xfree(o
->default_sink
);
727 pa_xfree(o
->default_source
);
732 int pa_simple_options_parse(pa_simple_options
*o
, pa_core
*c
, pa_modargs
*ma
) {
736 pa_assert(PA_REFCNT_VALUE(o
) >= 1);
739 o
->sample_spec
= c
->default_sample_spec
;
740 if (pa_modargs_get_sample_spec_and_channel_map(ma
, &o
->sample_spec
, &o
->channel_map
, PA_CHANNEL_MAP_DEFAULT
) < 0) {
741 pa_log("Failed to parse sample type specification.");
745 pa_xfree(o
->default_source
);
746 o
->default_source
= pa_xstrdup(pa_modargs_get_value(ma
, "source", NULL
));
748 pa_xfree(o
->default_sink
);
749 o
->default_sink
= pa_xstrdup(pa_modargs_get_value(ma
, "sink", NULL
));
752 if (pa_modargs_get_value_boolean(ma
, "record", &enabled
) < 0) {
753 pa_log("record= expects a boolean argument.");
758 enabled
= o
->playback
;
759 if (pa_modargs_get_value_boolean(ma
, "playback", &enabled
) < 0) {
760 pa_log("playback= expects a boolean argument.");
763 o
->playback
= enabled
;
765 if (!o
->playback
&& !o
->record
) {
766 pa_log("neither playback nor recording enabled for protocol.");