2 This file is part of PulseAudio.
4 Copyright 2004-2006 Lennart Poettering
5 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
7 PulseAudio is free software; you can redistribute it and/or modify
8 it under the terms of the GNU Lesser General Public License as published
9 by the Free Software Foundation; either version 2 of the License,
10 or (at your option) any later version.
12 PulseAudio is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 General Public License for more details.
17 You should have received a copy of the GNU Lesser General Public License
18 along with PulseAudio; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
31 #include <pulse/def.h>
32 #include <pulse/timeval.h>
33 #include <pulse/xmalloc.h>
35 #include <pulsecore/pstream-util.h>
36 #include <pulsecore/log.h>
37 #include <pulsecore/hashmap.h>
38 #include <pulsecore/macro.h>
39 #include <pulsecore/rtclock.h>
43 #define LATENCY_IPOL_INTERVAL_USEC (333*PA_USEC_PER_MSEC)
45 #define SMOOTHER_ADJUST_TIME (1000*PA_USEC_PER_MSEC)
46 #define SMOOTHER_HISTORY_TIME (5000*PA_USEC_PER_MSEC)
47 #define SMOOTHER_MIN_HISTORY (4)
49 pa_stream *pa_stream_new(pa_context *c, const char *name, const pa_sample_spec *ss, const pa_channel_map *map) {
50 return pa_stream_new_with_proplist(c, name, ss, map, NULL);
53 static void reset_callbacks(pa_stream *s) {
54 s->read_callback = NULL;
55 s->read_userdata = NULL;
56 s->write_callback = NULL;
57 s->write_userdata = NULL;
58 s->state_callback = NULL;
59 s->state_userdata = NULL;
60 s->overflow_callback = NULL;
61 s->overflow_userdata = NULL;
62 s->underflow_callback = NULL;
63 s->underflow_userdata = NULL;
64 s->latency_update_callback = NULL;
65 s->latency_update_userdata = NULL;
66 s->moved_callback = NULL;
67 s->moved_userdata = NULL;
68 s->suspended_callback = NULL;
69 s->suspended_userdata = NULL;
70 s->started_callback = NULL;
71 s->started_userdata = NULL;
74 pa_stream *pa_stream_new_with_proplist(
77 const pa_sample_spec *ss,
78 const pa_channel_map *map,
86 pa_assert(PA_REFCNT_VALUE(c) >= 1);
88 PA_CHECK_VALIDITY_RETURN_NULL(c, ss && pa_sample_spec_valid(ss), PA_ERR_INVALID);
89 PA_CHECK_VALIDITY_RETURN_NULL(c, c->version >= 12 || (ss->format != PA_SAMPLE_S32LE || ss->format != PA_SAMPLE_S32NE), PA_ERR_NOTSUPPORTED);
90 PA_CHECK_VALIDITY_RETURN_NULL(c, !map || (pa_channel_map_valid(map) && map->channels == ss->channels), PA_ERR_INVALID);
91 PA_CHECK_VALIDITY_RETURN_NULL(c, name || (p && pa_proplist_contains(p, PA_PROP_MEDIA_NAME)), PA_ERR_INVALID);
94 PA_CHECK_VALIDITY_RETURN_NULL(c, map = pa_channel_map_init_auto(&tmap, ss->channels, PA_CHANNEL_MAP_DEFAULT), PA_ERR_INVALID);
96 s = pa_xnew(pa_stream, 1);
99 s->mainloop = c->mainloop;
101 s->direction = PA_STREAM_NODIRECTION;
102 s->state = PA_STREAM_UNCONNECTED;
105 s->sample_spec = *ss;
106 s->channel_map = *map;
108 s->direct_on_input = PA_INVALID_INDEX;
110 s->proplist = p ? pa_proplist_copy(p) : pa_proplist_new();
112 pa_proplist_sets(s->proplist, PA_PROP_MEDIA_NAME, name);
115 s->channel_valid = FALSE;
116 s->syncid = c->csyncid++;
117 s->stream_index = PA_INVALID_INDEX;
119 s->requested_bytes = 0;
120 memset(&s->buffer_attr, 0, sizeof(s->buffer_attr));
122 /* We initialize der target length here, so that if the user
123 * passes no explicit buffering metrics the default is similar to
124 * what older PA versions provided. */
126 s->buffer_attr.maxlength = (uint32_t) -1;
127 s->buffer_attr.tlength = pa_usec_to_bytes(250*PA_USEC_PER_MSEC, ss); /* 250ms of buffering */
128 s->buffer_attr.minreq = (uint32_t) -1;
129 s->buffer_attr.prebuf = (uint32_t) -1;
130 s->buffer_attr.fragsize = (uint32_t) -1;
132 s->device_index = PA_INVALID_INDEX;
133 s->device_name = NULL;
134 s->suspended = FALSE;
136 pa_memchunk_reset(&s->peek_memchunk);
139 s->record_memblockq = NULL;
143 memset(&s->timing_info, 0, sizeof(s->timing_info));
144 s->timing_info_valid = FALSE;
146 s->previous_time = 0;
148 s->read_index_not_before = 0;
149 s->write_index_not_before = 0;
150 for (i = 0; i < PA_MAX_WRITE_INDEX_CORRECTIONS; i++)
151 s->write_index_corrections[i].valid = 0;
152 s->current_write_index_correction = 0;
154 s->auto_timing_update_event = NULL;
155 s->auto_timing_update_requested = FALSE;
161 /* Refcounting is strictly one-way: from the "bigger" to the "smaller" object. */
162 PA_LLIST_PREPEND(pa_stream, c->streams, s);
168 static void stream_unlink(pa_stream *s) {
175 /* Detach from context */
177 /* Unref all operatio object that point to us */
178 for (o = s->context->operations; o; o = n) {
182 pa_operation_cancel(o);
185 /* Drop all outstanding replies for this stream */
186 if (s->context->pdispatch)
187 pa_pdispatch_unregister_reply(s->context->pdispatch, s);
189 if (s->channel_valid) {
190 pa_dynarray_put((s->direction == PA_STREAM_PLAYBACK) ? s->context->playback_streams : s->context->record_streams, s->channel, NULL);
192 s->channel_valid = FALSE;
195 PA_LLIST_REMOVE(pa_stream, s->context->streams, s);
200 if (s->auto_timing_update_event) {
201 pa_assert(s->mainloop);
202 s->mainloop->time_free(s->auto_timing_update_event);
208 static void stream_free(pa_stream *s) {
213 if (s->peek_memchunk.memblock) {
215 pa_memblock_release(s->peek_memchunk.memblock);
216 pa_memblock_unref(s->peek_memchunk.memblock);
219 if (s->record_memblockq)
220 pa_memblockq_free(s->record_memblockq);
223 pa_proplist_free(s->proplist);
226 pa_smoother_free(s->smoother);
228 pa_xfree(s->device_name);
232 void pa_stream_unref(pa_stream *s) {
234 pa_assert(PA_REFCNT_VALUE(s) >= 1);
236 if (PA_REFCNT_DEC(s) <= 0)
240 pa_stream* pa_stream_ref(pa_stream *s) {
242 pa_assert(PA_REFCNT_VALUE(s) >= 1);
248 pa_stream_state_t pa_stream_get_state(pa_stream *s) {
250 pa_assert(PA_REFCNT_VALUE(s) >= 1);
255 pa_context* pa_stream_get_context(pa_stream *s) {
257 pa_assert(PA_REFCNT_VALUE(s) >= 1);
262 uint32_t pa_stream_get_index(pa_stream *s) {
264 pa_assert(PA_REFCNT_VALUE(s) >= 1);
266 PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE, PA_INVALID_INDEX);
268 return s->stream_index;
271 void pa_stream_set_state(pa_stream *s, pa_stream_state_t st) {
273 pa_assert(PA_REFCNT_VALUE(s) >= 1);
282 if (s->state_callback)
283 s->state_callback(s, s->state_userdata);
285 if ((st == PA_STREAM_FAILED || st == PA_STREAM_TERMINATED))
291 static void request_auto_timing_update(pa_stream *s, pa_bool_t force) {
293 pa_assert(PA_REFCNT_VALUE(s) >= 1);
295 if (!(s->flags & PA_STREAM_AUTO_TIMING_UPDATE))
298 if (s->state == PA_STREAM_READY &&
299 (force || !s->auto_timing_update_requested)) {
302 /* pa_log("automatically requesting new timing data"); */
304 if ((o = pa_stream_update_timing_info(s, NULL, NULL))) {
305 pa_operation_unref(o);
306 s->auto_timing_update_requested = TRUE;
310 if (s->auto_timing_update_event) {
312 pa_gettimeofday(&next);
313 pa_timeval_add(&next, LATENCY_IPOL_INTERVAL_USEC);
314 s->mainloop->time_restart(s->auto_timing_update_event, &next);
318 void pa_command_stream_killed(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
319 pa_context *c = userdata;
324 pa_assert(command == PA_COMMAND_PLAYBACK_STREAM_KILLED || command == PA_COMMAND_RECORD_STREAM_KILLED);
327 pa_assert(PA_REFCNT_VALUE(c) >= 1);
331 if (pa_tagstruct_getu32(t, &channel) < 0 ||
332 !pa_tagstruct_eof(t)) {
333 pa_context_fail(c, PA_ERR_PROTOCOL);
337 if (!(s = pa_dynarray_get(command == PA_COMMAND_PLAYBACK_STREAM_KILLED ? c->playback_streams : c->record_streams, channel)))
340 if (s->state != PA_STREAM_READY)
343 pa_context_set_error(c, PA_ERR_KILLED);
344 pa_stream_set_state(s, PA_STREAM_FAILED);
350 static void check_smoother_status(pa_stream *s, pa_bool_t aposteriori, pa_bool_t force_start, pa_bool_t force_stop) {
354 pa_assert(!force_start || !force_stop);
359 x = pa_rtclock_usec();
361 if (s->timing_info_valid) {
363 x -= s->timing_info.transport_usec;
365 x += s->timing_info.transport_usec;
367 if (s->direction == PA_STREAM_PLAYBACK)
368 /* it takes a while until the pause/resume is actually
370 x += s->timing_info.sink_usec;
372 /* Data froma while back will be dropped */
373 x -= s->timing_info.source_usec;
376 if (s->suspended || s->corked || force_stop)
377 pa_smoother_pause(s->smoother, x);
378 else if (force_start || s->buffer_attr.prebuf == 0)
379 pa_smoother_resume(s->smoother, x);
381 /* Please note that we have no idea if playback actually started
382 * if prebuf is non-zero! */
385 void pa_command_stream_moved(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
386 pa_context *c = userdata;
393 uint32_t maxlength = 0, fragsize = 0, minreq = 0, tlength = 0, prebuf = 0;
396 pa_assert(command == PA_COMMAND_PLAYBACK_STREAM_MOVED || command == PA_COMMAND_RECORD_STREAM_MOVED);
399 pa_assert(PA_REFCNT_VALUE(c) >= 1);
403 if (c->version < 12) {
404 pa_context_fail(c, PA_ERR_PROTOCOL);
408 if (pa_tagstruct_getu32(t, &channel) < 0 ||
409 pa_tagstruct_getu32(t, &di) < 0 ||
410 pa_tagstruct_gets(t, &dn) < 0 ||
411 pa_tagstruct_get_boolean(t, &suspended) < 0) {
412 pa_context_fail(c, PA_ERR_PROTOCOL);
416 if (c->version >= 13) {
418 if (command == PA_COMMAND_RECORD_STREAM_MOVED) {
419 if (pa_tagstruct_getu32(t, &maxlength) < 0 ||
420 pa_tagstruct_getu32(t, &fragsize) < 0 ||
421 pa_tagstruct_get_usec(t, &usec) < 0) {
422 pa_context_fail(c, PA_ERR_PROTOCOL);
426 if (pa_tagstruct_getu32(t, &maxlength) < 0 ||
427 pa_tagstruct_getu32(t, &tlength) < 0 ||
428 pa_tagstruct_getu32(t, &prebuf) < 0 ||
429 pa_tagstruct_getu32(t, &minreq) < 0 ||
430 pa_tagstruct_get_usec(t, &usec) < 0) {
431 pa_context_fail(c, PA_ERR_PROTOCOL);
437 if (!pa_tagstruct_eof(t)) {
438 pa_context_fail(c, PA_ERR_PROTOCOL);
442 if (!dn || di == PA_INVALID_INDEX) {
443 pa_context_fail(c, PA_ERR_PROTOCOL);
447 if (!(s = pa_dynarray_get(command == PA_COMMAND_PLAYBACK_STREAM_MOVED ? c->playback_streams : c->record_streams, channel)))
450 if (s->state != PA_STREAM_READY)
453 if (c->version >= 13) {
454 if (s->direction == PA_STREAM_RECORD)
455 s->timing_info.configured_source_usec = usec;
457 s->timing_info.configured_sink_usec = usec;
459 s->buffer_attr.maxlength = maxlength;
460 s->buffer_attr.fragsize = fragsize;
461 s->buffer_attr.tlength = tlength;
462 s->buffer_attr.prebuf = prebuf;
463 s->buffer_attr.minreq = minreq;
466 pa_xfree(s->device_name);
467 s->device_name = pa_xstrdup(dn);
468 s->device_index = di;
470 s->suspended = suspended;
472 check_smoother_status(s, TRUE, FALSE, FALSE);
473 request_auto_timing_update(s, TRUE);
475 if (s->moved_callback)
476 s->moved_callback(s, s->moved_userdata);
482 void pa_command_stream_suspended(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
483 pa_context *c = userdata;
489 pa_assert(command == PA_COMMAND_PLAYBACK_STREAM_SUSPENDED || command == PA_COMMAND_RECORD_STREAM_SUSPENDED);
492 pa_assert(PA_REFCNT_VALUE(c) >= 1);
496 if (c->version < 12) {
497 pa_context_fail(c, PA_ERR_PROTOCOL);
501 if (pa_tagstruct_getu32(t, &channel) < 0 ||
502 pa_tagstruct_get_boolean(t, &suspended) < 0 ||
503 !pa_tagstruct_eof(t)) {
504 pa_context_fail(c, PA_ERR_PROTOCOL);
508 if (!(s = pa_dynarray_get(command == PA_COMMAND_PLAYBACK_STREAM_SUSPENDED ? c->playback_streams : c->record_streams, channel)))
511 if (s->state != PA_STREAM_READY)
514 s->suspended = suspended;
516 check_smoother_status(s, TRUE, FALSE, FALSE);
517 request_auto_timing_update(s, TRUE);
519 if (s->suspended_callback)
520 s->suspended_callback(s, s->suspended_userdata);
526 void pa_command_stream_started(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
527 pa_context *c = userdata;
532 pa_assert(command == PA_COMMAND_STARTED);
535 pa_assert(PA_REFCNT_VALUE(c) >= 1);
539 if (c->version < 13) {
540 pa_context_fail(c, PA_ERR_PROTOCOL);
544 if (pa_tagstruct_getu32(t, &channel) < 0 ||
545 !pa_tagstruct_eof(t)) {
546 pa_context_fail(c, PA_ERR_PROTOCOL);
550 if (!(s = pa_dynarray_get(c->playback_streams, channel)))
553 if (s->state != PA_STREAM_READY)
556 check_smoother_status(s, TRUE, TRUE, FALSE);
557 request_auto_timing_update(s, TRUE);
559 if (s->started_callback)
560 s->started_callback(s, s->suspended_userdata);
566 void pa_command_request(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
568 pa_context *c = userdata;
569 uint32_t bytes, channel;
572 pa_assert(command == PA_COMMAND_REQUEST);
575 pa_assert(PA_REFCNT_VALUE(c) >= 1);
579 if (pa_tagstruct_getu32(t, &channel) < 0 ||
580 pa_tagstruct_getu32(t, &bytes) < 0 ||
581 !pa_tagstruct_eof(t)) {
582 pa_context_fail(c, PA_ERR_PROTOCOL);
586 if (!(s = pa_dynarray_get(c->playback_streams, channel)))
589 if (s->state != PA_STREAM_READY)
592 s->requested_bytes += bytes;
594 if (s->requested_bytes > 0 && s->write_callback)
595 s->write_callback(s, s->requested_bytes, s->write_userdata);
601 void pa_command_overflow_or_underflow(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
603 pa_context *c = userdata;
607 pa_assert(command == PA_COMMAND_OVERFLOW || command == PA_COMMAND_UNDERFLOW);
610 pa_assert(PA_REFCNT_VALUE(c) >= 1);
614 if (pa_tagstruct_getu32(t, &channel) < 0 ||
615 !pa_tagstruct_eof(t)) {
616 pa_context_fail(c, PA_ERR_PROTOCOL);
620 if (!(s = pa_dynarray_get(c->playback_streams, channel)))
623 if (s->state != PA_STREAM_READY)
626 if (s->buffer_attr.prebuf > 0)
627 check_smoother_status(s, TRUE, FALSE, TRUE);
629 request_auto_timing_update(s, TRUE);
631 if (command == PA_COMMAND_OVERFLOW) {
632 if (s->overflow_callback)
633 s->overflow_callback(s, s->overflow_userdata);
634 } else if (command == PA_COMMAND_UNDERFLOW) {
635 if (s->underflow_callback)
636 s->underflow_callback(s, s->underflow_userdata);
643 static void invalidate_indexes(pa_stream *s, pa_bool_t r, pa_bool_t w) {
645 pa_assert(PA_REFCNT_VALUE(s) >= 1);
647 /* pa_log("invalidate r:%u w:%u tag:%u", r, w, s->context->ctag); */
649 if (s->state != PA_STREAM_READY)
653 s->write_index_not_before = s->context->ctag;
655 if (s->timing_info_valid)
656 s->timing_info.write_index_corrupt = TRUE;
658 /* pa_log("write_index invalidated"); */
662 s->read_index_not_before = s->context->ctag;
664 if (s->timing_info_valid)
665 s->timing_info.read_index_corrupt = TRUE;
667 /* pa_log("read_index invalidated"); */
670 request_auto_timing_update(s, TRUE);
673 static void auto_timing_update_callback(pa_mainloop_api *m, pa_time_event *e, const struct timeval *tv, void *userdata) {
674 pa_stream *s = userdata;
677 pa_assert(PA_REFCNT_VALUE(s) >= 1);
680 request_auto_timing_update(s, FALSE);
684 static void create_stream_complete(pa_stream *s) {
686 pa_assert(PA_REFCNT_VALUE(s) >= 1);
687 pa_assert(s->state == PA_STREAM_CREATING);
689 pa_stream_set_state(s, PA_STREAM_READY);
691 if (s->requested_bytes > 0 && s->write_callback)
692 s->write_callback(s, s->requested_bytes, s->write_userdata);
694 if (s->flags & PA_STREAM_AUTO_TIMING_UPDATE) {
696 pa_gettimeofday(&tv);
697 tv.tv_usec += LATENCY_IPOL_INTERVAL_USEC; /* every 100 ms */
698 pa_assert(!s->auto_timing_update_event);
699 s->auto_timing_update_event = s->mainloop->time_new(s->mainloop, &tv, &auto_timing_update_callback, s);
701 request_auto_timing_update(s, TRUE);
704 check_smoother_status(s, TRUE, FALSE, FALSE);
707 static void automatic_buffer_attr(pa_stream *s, pa_buffer_attr *attr, const pa_sample_spec *ss) {
712 if (s->context->version >= 13)
715 /* Version older than 0.9.10 didn't do server side buffer_attr
716 * selection, hence we have to fake it on the client side. */
718 /* We choose fairly conservative values here, to not confuse
719 * old clients with extremely large playback buffers */
721 if (attr->maxlength == (uint32_t) -1)
722 attr->maxlength = 4*1024*1024; /* 4MB is the maximum queue length PulseAudio <= 0.9.9 supported. */
724 if (attr->tlength == (uint32_t) -1)
725 attr->tlength = pa_usec_to_bytes(250*PA_USEC_PER_MSEC, ss); /* 250ms of buffering */
727 if (attr->minreq == (uint32_t) -1)
728 attr->minreq = (attr->tlength)/5; /* Ask for more data when there are only 200ms left in the playback buffer */
730 if (attr->prebuf == (uint32_t) -1)
731 attr->prebuf = attr->tlength; /* Start to play only when the playback is fully filled up once */
733 if (attr->fragsize == (uint32_t) -1)
734 attr->fragsize = attr->tlength; /* Pass data to the app only when the buffer is filled up once */
737 void pa_create_stream_callback(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
738 pa_stream *s = userdata;
742 pa_assert(PA_REFCNT_VALUE(s) >= 1);
743 pa_assert(s->state == PA_STREAM_CREATING);
747 if (command != PA_COMMAND_REPLY) {
748 if (pa_context_handle_error(s->context, command, t, FALSE) < 0)
751 pa_stream_set_state(s, PA_STREAM_FAILED);
755 if (pa_tagstruct_getu32(t, &s->channel) < 0 ||
756 s->channel == PA_INVALID_INDEX ||
757 ((s->direction != PA_STREAM_UPLOAD) && (pa_tagstruct_getu32(t, &s->stream_index) < 0 || s->stream_index == PA_INVALID_INDEX)) ||
758 ((s->direction != PA_STREAM_RECORD) && pa_tagstruct_getu32(t, &s->requested_bytes) < 0)) {
759 pa_context_fail(s->context, PA_ERR_PROTOCOL);
763 if (s->context->version >= 9) {
764 if (s->direction == PA_STREAM_PLAYBACK) {
765 if (pa_tagstruct_getu32(t, &s->buffer_attr.maxlength) < 0 ||
766 pa_tagstruct_getu32(t, &s->buffer_attr.tlength) < 0 ||
767 pa_tagstruct_getu32(t, &s->buffer_attr.prebuf) < 0 ||
768 pa_tagstruct_getu32(t, &s->buffer_attr.minreq) < 0) {
769 pa_context_fail(s->context, PA_ERR_PROTOCOL);
772 } else if (s->direction == PA_STREAM_RECORD) {
773 if (pa_tagstruct_getu32(t, &s->buffer_attr.maxlength) < 0 ||
774 pa_tagstruct_getu32(t, &s->buffer_attr.fragsize) < 0) {
775 pa_context_fail(s->context, PA_ERR_PROTOCOL);
781 if (s->context->version >= 12 && s->direction != PA_STREAM_UPLOAD) {
784 const char *dn = NULL;
787 if (pa_tagstruct_get_sample_spec(t, &ss) < 0 ||
788 pa_tagstruct_get_channel_map(t, &cm) < 0 ||
789 pa_tagstruct_getu32(t, &s->device_index) < 0 ||
790 pa_tagstruct_gets(t, &dn) < 0 ||
791 pa_tagstruct_get_boolean(t, &suspended) < 0) {
792 pa_context_fail(s->context, PA_ERR_PROTOCOL);
796 if (!dn || s->device_index == PA_INVALID_INDEX ||
797 ss.channels != cm.channels ||
798 !pa_channel_map_valid(&cm) ||
799 !pa_sample_spec_valid(&ss) ||
800 (!(s->flags & PA_STREAM_FIX_FORMAT) && ss.format != s->sample_spec.format) ||
801 (!(s->flags & PA_STREAM_FIX_RATE) && ss.rate != s->sample_spec.rate) ||
802 (!(s->flags & PA_STREAM_FIX_CHANNELS) && !pa_channel_map_equal(&cm, &s->channel_map))) {
803 pa_context_fail(s->context, PA_ERR_PROTOCOL);
807 pa_xfree(s->device_name);
808 s->device_name = pa_xstrdup(dn);
809 s->suspended = suspended;
815 if (s->context->version >= 13 && s->direction != PA_STREAM_UPLOAD) {
818 if (pa_tagstruct_get_usec(t, &usec) < 0) {
819 pa_context_fail(s->context, PA_ERR_PROTOCOL);
823 if (s->direction == PA_STREAM_RECORD)
824 s->timing_info.configured_source_usec = usec;
826 s->timing_info.configured_sink_usec = usec;
829 if (!pa_tagstruct_eof(t)) {
830 pa_context_fail(s->context, PA_ERR_PROTOCOL);
834 if (s->direction == PA_STREAM_RECORD) {
835 pa_assert(!s->record_memblockq);
837 s->record_memblockq = pa_memblockq_new(
839 s->buffer_attr.maxlength,
841 pa_frame_size(&s->sample_spec),
848 s->channel_valid = TRUE;
849 pa_dynarray_put((s->direction == PA_STREAM_RECORD) ? s->context->record_streams : s->context->playback_streams, s->channel, s);
851 create_stream_complete(s);
857 static int create_stream(
858 pa_stream_direction_t direction,
861 const pa_buffer_attr *attr,
862 pa_stream_flags_t flags,
863 const pa_cvolume *volume,
864 pa_stream *sync_stream) {
870 pa_assert(PA_REFCNT_VALUE(s) >= 1);
871 pa_assert(direction == PA_STREAM_PLAYBACK || direction == PA_STREAM_RECORD);
873 PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_UNCONNECTED, PA_ERR_BADSTATE);
874 PA_CHECK_VALIDITY(s->context, s->direct_on_input == PA_INVALID_INDEX || direction == PA_STREAM_RECORD, PA_ERR_BADSTATE);
875 PA_CHECK_VALIDITY(s->context, !(flags & ~(PA_STREAM_START_CORKED|
876 PA_STREAM_INTERPOLATE_TIMING|
877 PA_STREAM_NOT_MONOTONOUS|
878 PA_STREAM_AUTO_TIMING_UPDATE|
879 PA_STREAM_NO_REMAP_CHANNELS|
880 PA_STREAM_NO_REMIX_CHANNELS|
881 PA_STREAM_FIX_FORMAT|
883 PA_STREAM_FIX_CHANNELS|
885 PA_STREAM_VARIABLE_RATE|
886 PA_STREAM_PEAK_DETECT|
887 PA_STREAM_START_MUTED|
888 PA_STREAM_ADJUST_LATENCY)), PA_ERR_INVALID);
890 PA_CHECK_VALIDITY(s->context, s->context->version >= 12 || !(flags & PA_STREAM_VARIABLE_RATE), PA_ERR_NOTSUPPORTED);
891 PA_CHECK_VALIDITY(s->context, s->context->version >= 13 || !(flags & PA_STREAM_PEAK_DETECT), PA_ERR_NOTSUPPORTED);
892 /* Althought some of the other flags are not supported on older
893 * version, we don't check for them here, because it doesn't hurt
894 * when they are passed but actually not supported. This makes
895 * client development easier */
897 PA_CHECK_VALIDITY(s->context, direction == PA_STREAM_PLAYBACK || !(flags & (PA_STREAM_START_MUTED)), PA_ERR_INVALID);
898 PA_CHECK_VALIDITY(s->context, direction == PA_STREAM_RECORD || !(flags & (PA_STREAM_PEAK_DETECT)), PA_ERR_INVALID);
899 PA_CHECK_VALIDITY(s->context, !volume || volume->channels == s->sample_spec.channels, PA_ERR_INVALID);
900 PA_CHECK_VALIDITY(s->context, !sync_stream || (direction == PA_STREAM_PLAYBACK && sync_stream->direction == PA_STREAM_PLAYBACK), PA_ERR_INVALID);
904 s->direction = direction;
906 s->corked = !!(flags & PA_STREAM_START_CORKED);
909 s->syncid = sync_stream->syncid;
912 s->buffer_attr = *attr;
913 automatic_buffer_attr(s, &s->buffer_attr, &s->sample_spec);
915 if (flags & PA_STREAM_INTERPOLATE_TIMING) {
919 pa_smoother_free(s->smoother);
921 s->smoother = pa_smoother_new(SMOOTHER_ADJUST_TIME, SMOOTHER_HISTORY_TIME, !(flags & PA_STREAM_NOT_MONOTONIC), SMOOTHER_MIN_HISTORY);
923 x = pa_rtclock_usec();
924 pa_smoother_set_time_offset(s->smoother, x);
925 pa_smoother_pause(s->smoother, x);
929 dev = s->direction == PA_STREAM_PLAYBACK ? s->context->conf->default_sink : s->context->conf->default_source;
931 t = pa_tagstruct_command(
933 s->direction == PA_STREAM_PLAYBACK ? PA_COMMAND_CREATE_PLAYBACK_STREAM : PA_COMMAND_CREATE_RECORD_STREAM,
936 if (s->context->version < 13)
937 pa_tagstruct_puts(t, pa_proplist_gets(s->proplist, PA_PROP_MEDIA_NAME));
941 PA_TAG_SAMPLE_SPEC, &s->sample_spec,
942 PA_TAG_CHANNEL_MAP, &s->channel_map,
943 PA_TAG_U32, PA_INVALID_INDEX,
945 PA_TAG_U32, s->buffer_attr.maxlength,
946 PA_TAG_BOOLEAN, s->corked,
949 if (s->direction == PA_STREAM_PLAYBACK) {
954 PA_TAG_U32, s->buffer_attr.tlength,
955 PA_TAG_U32, s->buffer_attr.prebuf,
956 PA_TAG_U32, s->buffer_attr.minreq,
957 PA_TAG_U32, s->syncid,
961 volume = pa_cvolume_reset(&cv, s->sample_spec.channels);
963 pa_tagstruct_put_cvolume(t, volume);
965 pa_tagstruct_putu32(t, s->buffer_attr.fragsize);
967 if (s->context->version >= 12) {
970 PA_TAG_BOOLEAN, flags & PA_STREAM_NO_REMAP_CHANNELS,
971 PA_TAG_BOOLEAN, flags & PA_STREAM_NO_REMIX_CHANNELS,
972 PA_TAG_BOOLEAN, flags & PA_STREAM_FIX_FORMAT,
973 PA_TAG_BOOLEAN, flags & PA_STREAM_FIX_RATE,
974 PA_TAG_BOOLEAN, flags & PA_STREAM_FIX_CHANNELS,
975 PA_TAG_BOOLEAN, flags & PA_STREAM_DONT_MOVE,
976 PA_TAG_BOOLEAN, flags & PA_STREAM_VARIABLE_RATE,
980 if (s->context->version >= 13) {
982 if (s->direction == PA_STREAM_PLAYBACK)
983 pa_tagstruct_put_boolean(t, flags & PA_STREAM_START_MUTED);
985 pa_tagstruct_put_boolean(t, flags & PA_STREAM_PEAK_DETECT);
989 PA_TAG_BOOLEAN, flags & PA_STREAM_ADJUST_LATENCY,
990 PA_TAG_PROPLIST, s->proplist,
993 if (s->direction == PA_STREAM_RECORD)
994 pa_tagstruct_putu32(t, s->direct_on_input);
997 pa_pstream_send_tagstruct(s->context->pstream, t);
998 pa_pdispatch_register_reply(s->context->pdispatch, tag, DEFAULT_TIMEOUT, pa_create_stream_callback, s, NULL);
1000 pa_stream_set_state(s, PA_STREAM_CREATING);
1006 int pa_stream_connect_playback(
1009 const pa_buffer_attr *attr,
1010 pa_stream_flags_t flags,
1012 pa_stream *sync_stream) {
1015 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1017 return create_stream(PA_STREAM_PLAYBACK, s, dev, attr, flags, volume, sync_stream);
1020 int pa_stream_connect_record(
1023 const pa_buffer_attr *attr,
1024 pa_stream_flags_t flags) {
1027 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1029 return create_stream(PA_STREAM_RECORD, s, dev, attr, flags, NULL, NULL);
1032 int pa_stream_write(
1036 void (*free_cb)(void *p),
1038 pa_seek_mode_t seek) {
1041 pa_seek_mode_t t_seek;
1047 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1050 PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1051 PA_CHECK_VALIDITY(s->context, s->direction == PA_STREAM_PLAYBACK || s->direction == PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1052 PA_CHECK_VALIDITY(s->context, seek <= PA_SEEK_RELATIVE_END, PA_ERR_INVALID);
1053 PA_CHECK_VALIDITY(s->context, s->direction == PA_STREAM_PLAYBACK || (seek == PA_SEEK_RELATIVE && offset == 0), PA_ERR_INVALID);
1063 while (t_length > 0) {
1067 if (free_cb && !pa_pstream_get_shm(s->context->pstream)) {
1068 chunk.memblock = pa_memblock_new_user(s->context->mempool, (void*) t_data, t_length, free_cb, 1);
1069 chunk.length = t_length;
1073 chunk.length = PA_MIN(t_length, pa_mempool_block_size_max(s->context->mempool));
1074 chunk.memblock = pa_memblock_new(s->context->mempool, chunk.length);
1076 d = pa_memblock_acquire(chunk.memblock);
1077 memcpy(d, t_data, chunk.length);
1078 pa_memblock_release(chunk.memblock);
1081 pa_pstream_send_memblock(s->context->pstream, s->channel, t_offset, t_seek, &chunk);
1084 t_seek = PA_SEEK_RELATIVE;
1086 t_data = (const uint8_t*) t_data + chunk.length;
1087 t_length -= chunk.length;
1089 pa_memblock_unref(chunk.memblock);
1092 if (free_cb && pa_pstream_get_shm(s->context->pstream))
1093 free_cb((void*) data);
1095 if (length < s->requested_bytes)
1096 s->requested_bytes -= length;
1098 s->requested_bytes = 0;
1100 /* FIXME!!! ^^^ will break when offset is != 0 and mode is not RELATIVE*/
1102 if (s->direction == PA_STREAM_PLAYBACK) {
1104 /* Update latency request correction */
1105 if (s->write_index_corrections[s->current_write_index_correction].valid) {
1107 if (seek == PA_SEEK_ABSOLUTE) {
1108 s->write_index_corrections[s->current_write_index_correction].corrupt = FALSE;
1109 s->write_index_corrections[s->current_write_index_correction].absolute = TRUE;
1110 s->write_index_corrections[s->current_write_index_correction].value = offset + length;
1111 } else if (seek == PA_SEEK_RELATIVE) {
1112 if (!s->write_index_corrections[s->current_write_index_correction].corrupt)
1113 s->write_index_corrections[s->current_write_index_correction].value += offset + length;
1115 s->write_index_corrections[s->current_write_index_correction].corrupt = TRUE;
1118 /* Update the write index in the already available latency data */
1119 if (s->timing_info_valid) {
1121 if (seek == PA_SEEK_ABSOLUTE) {
1122 s->timing_info.write_index_corrupt = FALSE;
1123 s->timing_info.write_index = offset + length;
1124 } else if (seek == PA_SEEK_RELATIVE) {
1125 if (!s->timing_info.write_index_corrupt)
1126 s->timing_info.write_index += offset + length;
1128 s->timing_info.write_index_corrupt = TRUE;
1131 if (!s->timing_info_valid || s->timing_info.write_index_corrupt)
1132 request_auto_timing_update(s, TRUE);
1138 int pa_stream_peek(pa_stream *s, const void **data, size_t *length) {
1140 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1144 PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1145 PA_CHECK_VALIDITY(s->context, s->direction == PA_STREAM_RECORD, PA_ERR_BADSTATE);
1147 if (!s->peek_memchunk.memblock) {
1149 if (pa_memblockq_peek(s->record_memblockq, &s->peek_memchunk) < 0) {
1155 s->peek_data = pa_memblock_acquire(s->peek_memchunk.memblock);
1158 pa_assert(s->peek_data);
1159 *data = (uint8_t*) s->peek_data + s->peek_memchunk.index;
1160 *length = s->peek_memchunk.length;
1164 int pa_stream_drop(pa_stream *s) {
1166 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1168 PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1169 PA_CHECK_VALIDITY(s->context, s->direction == PA_STREAM_RECORD, PA_ERR_BADSTATE);
1170 PA_CHECK_VALIDITY(s->context, s->peek_memchunk.memblock, PA_ERR_BADSTATE);
1172 pa_memblockq_drop(s->record_memblockq, s->peek_memchunk.length);
1174 /* Fix the simulated local read index */
1175 if (s->timing_info_valid && !s->timing_info.read_index_corrupt)
1176 s->timing_info.read_index += s->peek_memchunk.length;
1178 pa_assert(s->peek_data);
1179 pa_memblock_release(s->peek_memchunk.memblock);
1180 pa_memblock_unref(s->peek_memchunk.memblock);
1181 pa_memchunk_reset(&s->peek_memchunk);
1186 size_t pa_stream_writable_size(pa_stream *s) {
1188 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1190 PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE, (size_t) -1);
1191 PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->direction != PA_STREAM_RECORD, PA_ERR_BADSTATE, (size_t) -1);
1193 return s->requested_bytes;
1196 size_t pa_stream_readable_size(pa_stream *s) {
1198 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1200 PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE, (size_t) -1);
1201 PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->direction == PA_STREAM_RECORD, PA_ERR_BADSTATE, (size_t) -1);
1203 return pa_memblockq_get_length(s->record_memblockq);
1206 pa_operation * pa_stream_drain(pa_stream *s, pa_stream_success_cb_t cb, void *userdata) {
1212 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1214 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1215 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction == PA_STREAM_PLAYBACK, PA_ERR_BADSTATE);
1217 o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
1219 t = pa_tagstruct_command(s->context, PA_COMMAND_DRAIN_PLAYBACK_STREAM, &tag);
1220 pa_tagstruct_putu32(t, s->channel);
1221 pa_pstream_send_tagstruct(s->context->pstream, t);
1222 pa_pdispatch_register_reply(s->context->pdispatch, tag, DEFAULT_TIMEOUT, pa_stream_simple_ack_callback, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
1227 static pa_usec_t calc_time(pa_stream *s, pa_bool_t ignore_transport) {
1231 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1232 pa_assert(s->state == PA_STREAM_READY);
1233 pa_assert(s->direction != PA_STREAM_UPLOAD);
1234 pa_assert(s->timing_info_valid);
1235 pa_assert(s->direction != PA_STREAM_PLAYBACK || !s->timing_info.read_index_corrupt);
1236 pa_assert(s->direction != PA_STREAM_RECORD || !s->timing_info.write_index_corrupt);
1238 if (s->direction == PA_STREAM_PLAYBACK) {
1239 /* The last byte that was written into the output device
1240 * had this time value associated */
1241 usec = pa_bytes_to_usec(s->timing_info.read_index < 0 ? 0 : (uint64_t) s->timing_info.read_index, &s->sample_spec);
1243 if (!s->corked && !s->suspended) {
1245 if (!ignore_transport)
1246 /* Because the latency info took a little time to come
1247 * to us, we assume that the real output time is actually
1249 usec += s->timing_info.transport_usec;
1251 /* However, the output device usually maintains a buffer
1252 too, hence the real sample currently played is a little
1254 if (s->timing_info.sink_usec >= usec)
1257 usec -= s->timing_info.sink_usec;
1261 pa_assert(s->direction == PA_STREAM_RECORD);
1263 /* The last byte written into the server side queue had
1264 * this time value associated */
1265 usec = pa_bytes_to_usec(s->timing_info.write_index < 0 ? 0 : (uint64_t) s->timing_info.write_index, &s->sample_spec);
1267 if (!s->corked && !s->suspended) {
1269 if (!ignore_transport)
1270 /* Add transport latency */
1271 usec += s->timing_info.transport_usec;
1273 /* Add latency of data in device buffer */
1274 usec += s->timing_info.source_usec;
1276 /* If this is a monitor source, we need to correct the
1277 * time by the playback device buffer */
1278 if (s->timing_info.sink_usec >= usec)
1281 usec -= s->timing_info.sink_usec;
1288 static void stream_get_timing_info_callback(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
1289 pa_operation *o = userdata;
1290 struct timeval local, remote, now;
1292 pa_bool_t playing = FALSE;
1293 uint64_t underrun_for = 0, playing_for = 0;
1297 pa_assert(PA_REFCNT_VALUE(o) >= 1);
1299 if (!o->context || !o->stream)
1302 i = &o->stream->timing_info;
1304 o->stream->timing_info_valid = FALSE;
1305 i->write_index_corrupt = TRUE;
1306 i->read_index_corrupt = TRUE;
1308 if (command != PA_COMMAND_REPLY) {
1309 if (pa_context_handle_error(o->context, command, t, FALSE) < 0)
1314 if (pa_tagstruct_get_usec(t, &i->sink_usec) < 0 ||
1315 pa_tagstruct_get_usec(t, &i->source_usec) < 0 ||
1316 pa_tagstruct_get_boolean(t, &playing) < 0 ||
1317 pa_tagstruct_get_timeval(t, &local) < 0 ||
1318 pa_tagstruct_get_timeval(t, &remote) < 0 ||
1319 pa_tagstruct_gets64(t, &i->write_index) < 0 ||
1320 pa_tagstruct_gets64(t, &i->read_index) < 0) {
1322 pa_context_fail(o->context, PA_ERR_PROTOCOL);
1326 if (o->context->version >= 13 &&
1327 o->stream->direction == PA_STREAM_PLAYBACK)
1328 if (pa_tagstruct_getu64(t, &underrun_for) < 0 ||
1329 pa_tagstruct_getu64(t, &playing_for) < 0) {
1331 pa_context_fail(o->context, PA_ERR_PROTOCOL);
1336 if (!pa_tagstruct_eof(t)) {
1337 pa_context_fail(o->context, PA_ERR_PROTOCOL);
1340 o->stream->timing_info_valid = TRUE;
1341 i->write_index_corrupt = FALSE;
1342 i->read_index_corrupt = FALSE;
1344 i->playing = (int) playing;
1345 i->since_underrun = playing ? playing_for : underrun_for;
1347 pa_gettimeofday(&now);
1349 /* Calculcate timestamps */
1350 if (pa_timeval_cmp(&local, &remote) <= 0 && pa_timeval_cmp(&remote, &now) <= 0) {
1351 /* local and remote seem to have synchronized clocks */
1353 if (o->stream->direction == PA_STREAM_PLAYBACK)
1354 i->transport_usec = pa_timeval_diff(&remote, &local);
1356 i->transport_usec = pa_timeval_diff(&now, &remote);
1358 i->synchronized_clocks = TRUE;
1359 i->timestamp = remote;
1361 /* clocks are not synchronized, let's estimate latency then */
1362 i->transport_usec = pa_timeval_diff(&now, &local)/2;
1363 i->synchronized_clocks = FALSE;
1364 i->timestamp = local;
1365 pa_timeval_add(&i->timestamp, i->transport_usec);
1368 /* Invalidate read and write indexes if necessary */
1369 if (tag < o->stream->read_index_not_before)
1370 i->read_index_corrupt = TRUE;
1372 if (tag < o->stream->write_index_not_before)
1373 i->write_index_corrupt = TRUE;
1375 if (o->stream->direction == PA_STREAM_PLAYBACK) {
1376 /* Write index correction */
1379 uint32_t ctag = tag;
1381 /* Go through the saved correction values and add up the
1382 * total correction.*/
1383 for (n = 0, j = o->stream->current_write_index_correction+1;
1384 n < PA_MAX_WRITE_INDEX_CORRECTIONS;
1385 n++, j = (j + 1) % PA_MAX_WRITE_INDEX_CORRECTIONS) {
1387 /* Step over invalid data or out-of-date data */
1388 if (!o->stream->write_index_corrections[j].valid ||
1389 o->stream->write_index_corrections[j].tag < ctag)
1392 /* Make sure that everything is in order */
1393 ctag = o->stream->write_index_corrections[j].tag+1;
1395 /* Now fix the write index */
1396 if (o->stream->write_index_corrections[j].corrupt) {
1397 /* A corrupting seek was made */
1398 i->write_index_corrupt = TRUE;
1399 } else if (o->stream->write_index_corrections[j].absolute) {
1400 /* An absolute seek was made */
1401 i->write_index = o->stream->write_index_corrections[j].value;
1402 i->write_index_corrupt = FALSE;
1403 } else if (!i->write_index_corrupt) {
1404 /* A relative seek was made */
1405 i->write_index += o->stream->write_index_corrections[j].value;
1409 /* Clear old correction entries */
1410 for (n = 0; n < PA_MAX_WRITE_INDEX_CORRECTIONS; n++) {
1411 if (!o->stream->write_index_corrections[n].valid)
1414 if (o->stream->write_index_corrections[n].tag <= tag)
1415 o->stream->write_index_corrections[n].valid = FALSE;
1419 if (o->stream->direction == PA_STREAM_RECORD) {
1420 /* Read index correction */
1422 if (!i->read_index_corrupt)
1423 i->read_index -= pa_memblockq_get_length(o->stream->record_memblockq);
1426 /* Update smoother */
1427 if (o->stream->smoother) {
1430 u = x = pa_rtclock_usec() - i->transport_usec;
1432 if (o->stream->direction == PA_STREAM_PLAYBACK && o->context->version >= 13) {
1435 /* If we weren't playing then it will take some time
1436 * until the audio will actually come out through the
1437 * speakers. Since we follow that timing here, we need
1438 * to try to fix this up */
1440 su = pa_bytes_to_usec(i->since_underrun, &o->stream->sample_spec);
1442 if (su < i->sink_usec)
1443 x += i->sink_usec - su;
1447 pa_smoother_pause(o->stream->smoother, x);
1449 /* Update the smoother */
1450 if ((o->stream->direction == PA_STREAM_PLAYBACK && !i->read_index_corrupt) ||
1451 (o->stream->direction == PA_STREAM_RECORD && !i->write_index_corrupt))
1452 pa_smoother_put(o->stream->smoother, u, calc_time(o->stream, TRUE));
1455 pa_smoother_resume(o->stream->smoother, x);
1459 o->stream->auto_timing_update_requested = FALSE;
1461 if (o->stream->latency_update_callback)
1462 o->stream->latency_update_callback(o->stream, o->stream->latency_update_userdata);
1464 if (o->callback && o->stream && o->stream->state == PA_STREAM_READY) {
1465 pa_stream_success_cb_t cb = (pa_stream_success_cb_t) o->callback;
1466 cb(o->stream, o->stream->timing_info_valid, o->userdata);
1471 pa_operation_done(o);
1472 pa_operation_unref(o);
1475 pa_operation* pa_stream_update_timing_info(pa_stream *s, pa_stream_success_cb_t cb, void *userdata) {
1483 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1485 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1486 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1488 if (s->direction == PA_STREAM_PLAYBACK) {
1489 /* Find a place to store the write_index correction data for this entry */
1490 cidx = (s->current_write_index_correction + 1) % PA_MAX_WRITE_INDEX_CORRECTIONS;
1492 /* Check if we could allocate a correction slot. If not, there are too many outstanding queries */
1493 PA_CHECK_VALIDITY_RETURN_NULL(s->context, !s->write_index_corrections[cidx].valid, PA_ERR_INTERNAL);
1495 o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
1497 t = pa_tagstruct_command(
1499 s->direction == PA_STREAM_PLAYBACK ? PA_COMMAND_GET_PLAYBACK_LATENCY : PA_COMMAND_GET_RECORD_LATENCY,
1501 pa_tagstruct_putu32(t, s->channel);
1502 pa_tagstruct_put_timeval(t, pa_gettimeofday(&now));
1504 pa_pstream_send_tagstruct(s->context->pstream, t);
1505 pa_pdispatch_register_reply(s->context->pdispatch, tag, DEFAULT_TIMEOUT, stream_get_timing_info_callback, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
1507 if (s->direction == PA_STREAM_PLAYBACK) {
1508 /* Fill in initial correction data */
1510 s->current_write_index_correction = cidx;
1512 s->write_index_corrections[cidx].valid = TRUE;
1513 s->write_index_corrections[cidx].absolute = FALSE;
1514 s->write_index_corrections[cidx].corrupt = FALSE;
1515 s->write_index_corrections[cidx].tag = tag;
1516 s->write_index_corrections[cidx].value = 0;
1522 void pa_stream_disconnect_callback(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
1523 pa_stream *s = userdata;
1527 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1531 if (command != PA_COMMAND_REPLY) {
1532 if (pa_context_handle_error(s->context, command, t, FALSE) < 0)
1535 pa_stream_set_state(s, PA_STREAM_FAILED);
1537 } else if (!pa_tagstruct_eof(t)) {
1538 pa_context_fail(s->context, PA_ERR_PROTOCOL);
1542 pa_stream_set_state(s, PA_STREAM_TERMINATED);
1548 int pa_stream_disconnect(pa_stream *s) {
1553 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1555 PA_CHECK_VALIDITY(s->context, s->channel_valid, PA_ERR_BADSTATE);
1556 PA_CHECK_VALIDITY(s->context, s->context->state == PA_CONTEXT_READY, PA_ERR_BADSTATE);
1560 t = pa_tagstruct_command(
1562 s->direction == PA_STREAM_PLAYBACK ? PA_COMMAND_DELETE_PLAYBACK_STREAM :
1563 (s->direction == PA_STREAM_RECORD ? PA_COMMAND_DELETE_RECORD_STREAM : PA_COMMAND_DELETE_UPLOAD_STREAM),
1565 pa_tagstruct_putu32(t, s->channel);
1566 pa_pstream_send_tagstruct(s->context->pstream, t);
1567 pa_pdispatch_register_reply(s->context->pdispatch, tag, DEFAULT_TIMEOUT, pa_stream_disconnect_callback, s, NULL);
1573 void pa_stream_set_read_callback(pa_stream *s, pa_stream_request_cb_t cb, void *userdata) {
1575 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1577 if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1580 s->read_callback = cb;
1581 s->read_userdata = userdata;
1584 void pa_stream_set_write_callback(pa_stream *s, pa_stream_request_cb_t cb, void *userdata) {
1586 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1588 if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1591 s->write_callback = cb;
1592 s->write_userdata = userdata;
1595 void pa_stream_set_state_callback(pa_stream *s, pa_stream_notify_cb_t cb, void *userdata) {
1597 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1599 if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1602 s->state_callback = cb;
1603 s->state_userdata = userdata;
1606 void pa_stream_set_overflow_callback(pa_stream *s, pa_stream_notify_cb_t cb, void *userdata) {
1608 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1610 if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1613 s->overflow_callback = cb;
1614 s->overflow_userdata = userdata;
1617 void pa_stream_set_underflow_callback(pa_stream *s, pa_stream_notify_cb_t cb, void *userdata) {
1619 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1621 if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1624 s->underflow_callback = cb;
1625 s->underflow_userdata = userdata;
1628 void pa_stream_set_latency_update_callback(pa_stream *s, pa_stream_notify_cb_t cb, void *userdata) {
1630 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1632 if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1635 s->latency_update_callback = cb;
1636 s->latency_update_userdata = userdata;
1639 void pa_stream_set_moved_callback(pa_stream *s, pa_stream_notify_cb_t cb, void *userdata) {
1641 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1643 if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1646 s->moved_callback = cb;
1647 s->moved_userdata = userdata;
1650 void pa_stream_set_suspended_callback(pa_stream *s, pa_stream_notify_cb_t cb, void *userdata) {
1652 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1654 if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1657 s->suspended_callback = cb;
1658 s->suspended_userdata = userdata;
1661 void pa_stream_set_started_callback(pa_stream *s, pa_stream_notify_cb_t cb, void *userdata) {
1663 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1665 if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1668 s->started_callback = cb;
1669 s->started_userdata = userdata;
1672 void pa_stream_simple_ack_callback(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
1673 pa_operation *o = userdata;
1678 pa_assert(PA_REFCNT_VALUE(o) >= 1);
1683 if (command != PA_COMMAND_REPLY) {
1684 if (pa_context_handle_error(o->context, command, t, FALSE) < 0)
1688 } else if (!pa_tagstruct_eof(t)) {
1689 pa_context_fail(o->context, PA_ERR_PROTOCOL);
1694 pa_stream_success_cb_t cb = (pa_stream_success_cb_t) o->callback;
1695 cb(o->stream, success, o->userdata);
1699 pa_operation_done(o);
1700 pa_operation_unref(o);
1703 pa_operation* pa_stream_cork(pa_stream *s, int b, pa_stream_success_cb_t cb, void *userdata) {
1709 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1711 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1712 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1716 o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
1718 t = pa_tagstruct_command(
1720 s->direction == PA_STREAM_PLAYBACK ? PA_COMMAND_CORK_PLAYBACK_STREAM : PA_COMMAND_CORK_RECORD_STREAM,
1722 pa_tagstruct_putu32(t, s->channel);
1723 pa_tagstruct_put_boolean(t, !!b);
1724 pa_pstream_send_tagstruct(s->context->pstream, t);
1725 pa_pdispatch_register_reply(s->context->pdispatch, tag, DEFAULT_TIMEOUT, pa_stream_simple_ack_callback, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
1727 check_smoother_status(s, FALSE, FALSE, FALSE);
1729 /* This might cause the indexes to hang/start again, hence
1730 * let's request a timing update */
1731 request_auto_timing_update(s, TRUE);
1736 static pa_operation* stream_send_simple_command(pa_stream *s, uint32_t command, pa_stream_success_cb_t cb, void *userdata) {
1742 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1744 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1746 o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
1748 t = pa_tagstruct_command(s->context, command, &tag);
1749 pa_tagstruct_putu32(t, s->channel);
1750 pa_pstream_send_tagstruct(s->context->pstream, t);
1751 pa_pdispatch_register_reply(s->context->pdispatch, tag, DEFAULT_TIMEOUT, pa_stream_simple_ack_callback, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
1756 pa_operation* pa_stream_flush(pa_stream *s, pa_stream_success_cb_t cb, void *userdata) {
1760 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1762 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1763 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1765 if (!(o = stream_send_simple_command(s, s->direction == PA_STREAM_PLAYBACK ? PA_COMMAND_FLUSH_PLAYBACK_STREAM : PA_COMMAND_FLUSH_RECORD_STREAM, cb, userdata)))
1768 if (s->direction == PA_STREAM_PLAYBACK) {
1770 if (s->write_index_corrections[s->current_write_index_correction].valid)
1771 s->write_index_corrections[s->current_write_index_correction].corrupt = TRUE;
1773 if (s->buffer_attr.prebuf > 0)
1774 check_smoother_status(s, FALSE, FALSE, TRUE);
1776 /* This will change the write index, but leave the
1777 * read index untouched. */
1778 invalidate_indexes(s, FALSE, TRUE);
1781 /* For record streams this has no influence on the write
1782 * index, but the read index might jump. */
1783 invalidate_indexes(s, TRUE, FALSE);
1788 pa_operation* pa_stream_prebuf(pa_stream *s, pa_stream_success_cb_t cb, void *userdata) {
1792 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1794 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1795 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction == PA_STREAM_PLAYBACK, PA_ERR_BADSTATE);
1796 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->buffer_attr.prebuf > 0, PA_ERR_BADSTATE);
1798 if (!(o = stream_send_simple_command(s, PA_COMMAND_PREBUF_PLAYBACK_STREAM, cb, userdata)))
1801 /* This might cause the read index to hang again, hence
1802 * let's request a timing update */
1803 request_auto_timing_update(s, TRUE);
1808 pa_operation* pa_stream_trigger(pa_stream *s, pa_stream_success_cb_t cb, void *userdata) {
1812 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1814 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1815 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction == PA_STREAM_PLAYBACK, PA_ERR_BADSTATE);
1816 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->buffer_attr.prebuf > 0, PA_ERR_BADSTATE);
1818 if (!(o = stream_send_simple_command(s, PA_COMMAND_TRIGGER_PLAYBACK_STREAM, cb, userdata)))
1821 /* This might cause the read index to start moving again, hence
1822 * let's request a timing update */
1823 request_auto_timing_update(s, TRUE);
1828 pa_operation* pa_stream_set_name(pa_stream *s, const char *name, pa_stream_success_cb_t cb, void *userdata) {
1832 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1835 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1836 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1838 if (s->context->version >= 13) {
1839 pa_proplist *p = pa_proplist_new();
1841 pa_proplist_sets(p, PA_PROP_APPLICATION_NAME, name);
1842 o = pa_stream_proplist_update(s, PA_UPDATE_REPLACE, p, cb, userdata);
1843 pa_proplist_free(p);
1848 o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
1849 t = pa_tagstruct_command(
1851 s->direction == PA_STREAM_RECORD ? PA_COMMAND_SET_RECORD_STREAM_NAME : PA_COMMAND_SET_PLAYBACK_STREAM_NAME,
1853 pa_tagstruct_putu32(t, s->channel);
1854 pa_tagstruct_puts(t, name);
1855 pa_pstream_send_tagstruct(s->context->pstream, t);
1856 pa_pdispatch_register_reply(s->context->pdispatch, tag, DEFAULT_TIMEOUT, pa_stream_simple_ack_callback, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
1862 int pa_stream_get_time(pa_stream *s, pa_usec_t *r_usec) {
1866 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1868 PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1869 PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1870 PA_CHECK_VALIDITY(s->context, s->timing_info_valid, PA_ERR_NODATA);
1871 PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_PLAYBACK || !s->timing_info.read_index_corrupt, PA_ERR_NODATA);
1872 PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_RECORD || !s->timing_info.write_index_corrupt, PA_ERR_NODATA);
1875 usec = pa_smoother_get(s->smoother, pa_rtclock_usec());
1877 usec = calc_time(s, FALSE);
1879 /* Make sure the time runs monotonically */
1880 if (!(s->flags & PA_STREAM_NOT_MONOTONOUS)) {
1881 if (usec < s->previous_time)
1882 usec = s->previous_time;
1884 s->previous_time = usec;
1893 static pa_usec_t time_counter_diff(pa_stream *s, pa_usec_t a, pa_usec_t b, int *negative) {
1895 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1903 if (negative && s->direction == PA_STREAM_RECORD) {
1911 int pa_stream_get_latency(pa_stream *s, pa_usec_t *r_usec, int *negative) {
1917 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1920 PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1921 PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1922 PA_CHECK_VALIDITY(s->context, s->timing_info_valid, PA_ERR_NODATA);
1923 PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_PLAYBACK || !s->timing_info.write_index_corrupt, PA_ERR_NODATA);
1924 PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_RECORD || !s->timing_info.read_index_corrupt, PA_ERR_NODATA);
1926 if ((r = pa_stream_get_time(s, &t)) < 0)
1929 if (s->direction == PA_STREAM_PLAYBACK)
1930 cindex = s->timing_info.write_index;
1932 cindex = s->timing_info.read_index;
1937 c = pa_bytes_to_usec(cindex, &s->sample_spec);
1939 if (s->direction == PA_STREAM_PLAYBACK)
1940 *r_usec = time_counter_diff(s, c, t, negative);
1942 *r_usec = time_counter_diff(s, t, c, negative);
1947 const pa_timing_info* pa_stream_get_timing_info(pa_stream *s) {
1949 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1951 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1952 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1953 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->timing_info_valid, PA_ERR_BADSTATE);
1955 return &s->timing_info;
1958 const pa_sample_spec* pa_stream_get_sample_spec(pa_stream *s) {
1960 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1962 return &s->sample_spec;
1965 const pa_channel_map* pa_stream_get_channel_map(pa_stream *s) {
1967 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1969 return &s->channel_map;
1972 const pa_buffer_attr* pa_stream_get_buffer_attr(pa_stream *s) {
1974 pa_assert(PA_REFCNT_VALUE(s) >= 1);
1976 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1977 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1978 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->context->version >= 9, PA_ERR_NOTSUPPORTED);
1980 return &s->buffer_attr;
1983 static void stream_set_buffer_attr_callback(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
1984 pa_operation *o = userdata;
1989 pa_assert(PA_REFCNT_VALUE(o) >= 1);
1994 if (command != PA_COMMAND_REPLY) {
1995 if (pa_context_handle_error(o->context, command, t, FALSE) < 0)
2001 if (o->stream->direction == PA_STREAM_PLAYBACK) {
2002 if (pa_tagstruct_getu32(t, &o->stream->buffer_attr.maxlength) < 0 ||
2003 pa_tagstruct_getu32(t, &o->stream->buffer_attr.tlength) < 0 ||
2004 pa_tagstruct_getu32(t, &o->stream->buffer_attr.prebuf) < 0 ||
2005 pa_tagstruct_getu32(t, &o->stream->buffer_attr.minreq) < 0) {
2006 pa_context_fail(o->context, PA_ERR_PROTOCOL);
2009 } else if (o->stream->direction == PA_STREAM_RECORD) {
2010 if (pa_tagstruct_getu32(t, &o->stream->buffer_attr.maxlength) < 0 ||
2011 pa_tagstruct_getu32(t, &o->stream->buffer_attr.fragsize) < 0) {
2012 pa_context_fail(o->context, PA_ERR_PROTOCOL);
2017 if (!pa_tagstruct_eof(t)) {
2018 pa_context_fail(o->context, PA_ERR_PROTOCOL);
2024 pa_stream_success_cb_t cb = (pa_stream_success_cb_t) o->callback;
2025 cb(o->stream, success, o->userdata);
2029 pa_operation_done(o);
2030 pa_operation_unref(o);
2034 pa_operation* pa_stream_set_buffer_attr(pa_stream *s, const pa_buffer_attr *attr, pa_stream_success_cb_t cb, void *userdata) {
2040 pa_assert(PA_REFCNT_VALUE(s) >= 1);
2043 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
2044 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
2045 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->context->version >= 12, PA_ERR_NOTSUPPORTED);
2047 o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
2049 t = pa_tagstruct_command(
2051 s->direction == PA_STREAM_RECORD ? PA_COMMAND_SET_RECORD_STREAM_BUFFER_ATTR : PA_COMMAND_SET_PLAYBACK_STREAM_BUFFER_ATTR,
2053 pa_tagstruct_putu32(t, s->channel);
2055 pa_tagstruct_putu32(t, attr->maxlength);
2057 if (s->direction == PA_STREAM_PLAYBACK)
2060 PA_TAG_U32, attr->tlength,
2061 PA_TAG_U32, attr->prebuf,
2062 PA_TAG_U32, attr->minreq,
2065 pa_tagstruct_putu32(t, attr->fragsize);
2067 if (s->context->version >= 13)
2068 pa_tagstruct_put_boolean(t, !!(s->flags & PA_STREAM_ADJUST_LATENCY));
2070 pa_pstream_send_tagstruct(s->context->pstream, t);
2071 pa_pdispatch_register_reply(s->context->pdispatch, tag, DEFAULT_TIMEOUT, stream_set_buffer_attr_callback, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
2073 /* This might cause changes in the read/write indexex, hence let's
2074 * request a timing update */
2075 request_auto_timing_update(s, TRUE);
2080 uint32_t pa_stream_get_device_index(pa_stream *s) {
2082 pa_assert(PA_REFCNT_VALUE(s) >= 1);
2084 PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE, PA_INVALID_INDEX);
2085 PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE, PA_INVALID_INDEX);
2086 PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->context->version >= 12, PA_ERR_NOTSUPPORTED, PA_INVALID_INDEX);
2087 PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->device_index != PA_INVALID_INDEX, PA_ERR_BADSTATE, PA_INVALID_INDEX);
2089 return s->device_index;
2092 const char *pa_stream_get_device_name(pa_stream *s) {
2094 pa_assert(PA_REFCNT_VALUE(s) >= 1);
2096 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
2097 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
2098 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->context->version >= 12, PA_ERR_NOTSUPPORTED);
2099 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->device_name, PA_ERR_BADSTATE);
2101 return s->device_name;
2104 int pa_stream_is_suspended(pa_stream *s) {
2106 pa_assert(PA_REFCNT_VALUE(s) >= 1);
2108 PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
2109 PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
2110 PA_CHECK_VALIDITY(s->context, s->context->version >= 12, PA_ERR_NOTSUPPORTED);
2112 return s->suspended;
2115 int pa_stream_is_corked(pa_stream *s) {
2117 pa_assert(PA_REFCNT_VALUE(s) >= 1);
2119 PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
2120 PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
2125 static void stream_update_sample_rate_callback(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
2126 pa_operation *o = userdata;
2131 pa_assert(PA_REFCNT_VALUE(o) >= 1);
2136 if (command != PA_COMMAND_REPLY) {
2137 if (pa_context_handle_error(o->context, command, t, FALSE) < 0)
2143 if (!pa_tagstruct_eof(t)) {
2144 pa_context_fail(o->context, PA_ERR_PROTOCOL);
2149 o->stream->sample_spec.rate = PA_PTR_TO_UINT(o->private);
2150 pa_assert(pa_sample_spec_valid(&o->stream->sample_spec));
2153 pa_stream_success_cb_t cb = (pa_stream_success_cb_t) o->callback;
2154 cb(o->stream, success, o->userdata);
2158 pa_operation_done(o);
2159 pa_operation_unref(o);
2163 pa_operation *pa_stream_update_sample_rate(pa_stream *s, uint32_t rate, pa_stream_success_cb_t cb, void *userdata) {
2169 pa_assert(PA_REFCNT_VALUE(s) >= 1);
2171 PA_CHECK_VALIDITY_RETURN_NULL(s->context, rate > 0 && rate <= PA_RATE_MAX, PA_ERR_INVALID);
2172 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
2173 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
2174 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->flags & PA_STREAM_VARIABLE_RATE, PA_ERR_BADSTATE);
2175 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->context->version >= 12, PA_ERR_NOTSUPPORTED);
2177 o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
2178 o->private = PA_UINT_TO_PTR(rate);
2180 t = pa_tagstruct_command(
2182 s->direction == PA_STREAM_RECORD ? PA_COMMAND_UPDATE_RECORD_STREAM_SAMPLE_RATE : PA_COMMAND_UPDATE_PLAYBACK_STREAM_SAMPLE_RATE,
2184 pa_tagstruct_putu32(t, s->channel);
2185 pa_tagstruct_putu32(t, rate);
2187 pa_pstream_send_tagstruct(s->context->pstream, t);
2188 pa_pdispatch_register_reply(s->context->pdispatch, tag, DEFAULT_TIMEOUT, stream_update_sample_rate_callback, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
2193 pa_operation *pa_stream_proplist_update(pa_stream *s, pa_update_mode_t mode, pa_proplist *p, pa_stream_success_cb_t cb, void *userdata) {
2199 pa_assert(PA_REFCNT_VALUE(s) >= 1);
2201 PA_CHECK_VALIDITY_RETURN_NULL(s->context, mode == PA_UPDATE_SET || mode == PA_UPDATE_MERGE || mode == PA_UPDATE_REPLACE, PA_ERR_INVALID);
2202 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
2203 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
2204 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->context->version >= 13, PA_ERR_NOTSUPPORTED);
2206 o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
2208 t = pa_tagstruct_command(
2210 s->direction == PA_STREAM_RECORD ? PA_COMMAND_UPDATE_RECORD_STREAM_PROPLIST : PA_COMMAND_UPDATE_PLAYBACK_STREAM_PROPLIST,
2212 pa_tagstruct_putu32(t, s->channel);
2213 pa_tagstruct_putu32(t, (uint32_t) mode);
2214 pa_tagstruct_put_proplist(t, p);
2216 pa_pstream_send_tagstruct(s->context->pstream, t);
2217 pa_pdispatch_register_reply(s->context->pdispatch, tag, DEFAULT_TIMEOUT, pa_stream_simple_ack_callback, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
2219 /* Please note that we don't update s->proplist here, because we
2220 * don't export that field */
2225 pa_operation *pa_stream_proplist_remove(pa_stream *s, const char *const keys[], pa_stream_success_cb_t cb, void *userdata) {
2229 const char * const*k;
2232 pa_assert(PA_REFCNT_VALUE(s) >= 1);
2234 PA_CHECK_VALIDITY_RETURN_NULL(s->context, keys && keys[0], PA_ERR_INVALID);
2235 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
2236 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
2237 PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->context->version >= 13, PA_ERR_NOTSUPPORTED);
2239 o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
2241 t = pa_tagstruct_command(
2243 s->direction == PA_STREAM_RECORD ? PA_COMMAND_REMOVE_RECORD_STREAM_PROPLIST : PA_COMMAND_REMOVE_PLAYBACK_STREAM_PROPLIST,
2245 pa_tagstruct_putu32(t, s->channel);
2247 for (k = keys; *k; k++)
2248 pa_tagstruct_puts(t, *k);
2250 pa_tagstruct_puts(t, NULL);
2252 pa_pstream_send_tagstruct(s->context->pstream, t);
2253 pa_pdispatch_register_reply(s->context->pdispatch, tag, DEFAULT_TIMEOUT, pa_stream_simple_ack_callback, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
2255 /* Please note that we don't update s->proplist here, because we
2256 * don't export that field */
2261 int pa_stream_set_monitor_stream(pa_stream *s, uint32_t sink_input_idx) {
2263 pa_assert(PA_REFCNT_VALUE(s) >= 1);
2265 PA_CHECK_VALIDITY(s->context, sink_input_idx != PA_INVALID_INDEX, PA_ERR_INVALID);
2266 PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_UNCONNECTED, PA_ERR_BADSTATE);
2267 PA_CHECK_VALIDITY(s->context, s->context->version >= 13, PA_ERR_NOTSUPPORTED);
2269 s->direct_on_input = sink_input_idx;
2274 uint32_t pa_stream_get_monitor_stream(pa_stream *s) {
2276 pa_assert(PA_REFCNT_VALUE(s) >= 1);
2278 PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->direct_on_input != PA_INVALID_INDEX, PA_ERR_BADSTATE, PA_INVALID_INDEX);
2279 PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->context->version >= 13, PA_ERR_NOTSUPPORTED, PA_INVALID_INDEX);
2281 return s->direct_on_input;