4 This file is part of polypaudio.
6 polypaudio is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as published
8 by the Free Software Foundation; either version 2 of the License,
9 or (at your option) any later version.
11 polypaudio is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License
17 along with polypaudio; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
31 #include <polyp/def.h>
32 #include <polypcore/xmalloc.h>
33 #include <polypcore/pstream-util.h>
34 #include <polypcore/util.h>
35 #include <polypcore/log.h>
36 #include <polypcore/hashmap.h>
40 #define LATENCY_IPOL_INTERVAL_USEC (10000L)
42 pa_stream
*pa_stream_new(pa_context
*c
, const char *name
, const pa_sample_spec
*ss
, const pa_channel_map
*map
) {
48 PA_CHECK_VALIDITY_RETURN_NULL(c
, ss
&& pa_sample_spec_valid(ss
), PA_ERR_INVALID
);
49 PA_CHECK_VALIDITY_RETURN_NULL(c
, !map
|| (pa_channel_map_valid(map
) && map
->channels
== ss
->channels
), PA_ERR_INVALID
);
51 s
= pa_xnew(pa_stream
, 1);
54 s
->mainloop
= c
->mainloop
;
56 s
->read_callback
= NULL
;
57 s
->read_userdata
= NULL
;
58 s
->write_callback
= NULL
;
59 s
->write_userdata
= NULL
;
60 s
->state_callback
= NULL
;
61 s
->state_userdata
= NULL
;
62 s
->overflow_callback
= NULL
;
63 s
->overflow_userdata
= NULL
;
64 s
->underflow_callback
= NULL
;
65 s
->underflow_userdata
= NULL
;
67 s
->direction
= PA_STREAM_NODIRECTION
;
68 s
->name
= pa_xstrdup(name
);
73 s
->channel_map
= *map
;
75 pa_channel_map_init_auto(&s
->channel_map
, ss
->channels
);
79 s
->syncid
= c
->csyncid
++;
80 s
->device_index
= PA_INVALID_INDEX
;
81 s
->requested_bytes
= 0;
82 s
->state
= PA_STREAM_UNCONNECTED
;
83 memset(&s
->buffer_attr
, 0, sizeof(s
->buffer_attr
));
85 s
->peek_memchunk
.index
= 0;
86 s
->peek_memchunk
.length
= 0;
87 s
->peek_memchunk
.memblock
= NULL
;
89 s
->record_memblockq
= NULL
;
92 s
->timing_info_valid
= 0;
93 s
->read_index_not_before
= 0;
94 s
->write_index_not_before
= 0;
96 for (i
= 0; i
< PA_MAX_WRITE_INDEX_CORRECTIONS
; i
++)
97 s
->write_index_corrections
[i
].valid
= 0;
98 s
->current_write_index_correction
= 0;
102 s
->ipol_usec_valid
= 0;
103 s
->ipol_timestamp
.tv_sec
= 0;
104 s
->ipol_timestamp
.tv_usec
= 0;
106 s
->auto_timing_update_event
= NULL
;
107 s
->auto_timing_update_requested
= 0;
109 PA_LLIST_PREPEND(pa_stream
, c
->streams
, s
);
111 /* The context and stream will point at each other. We cannot ref count
112 both though since that will create a loop. */
113 pa_context_ref(s
->context
);
118 static void stream_free(pa_stream
*s
) {
119 assert(s
&& s
->context
&& !s
->channel_valid
);
121 PA_LLIST_REMOVE(pa_stream
, s
->context
->streams
, s
);
123 pa_context_unref(s
->context
);
125 if (s
->auto_timing_update_event
) {
127 s
->mainloop
->time_free(s
->auto_timing_update_event
);
130 if (s
->peek_memchunk
.memblock
)
131 pa_memblock_unref(s
->peek_memchunk
.memblock
);
133 if (s
->record_memblockq
)
134 pa_memblockq_free(s
->record_memblockq
);
140 void pa_stream_unref(pa_stream
*s
) {
148 pa_stream
* pa_stream_ref(pa_stream
*s
) {
156 pa_stream_state_t
pa_stream_get_state(pa_stream
*s
) {
163 pa_context
* pa_stream_get_context(pa_stream
*s
) {
170 uint32_t pa_stream_get_index(pa_stream
*s
) {
174 PA_CHECK_VALIDITY_RETURN_ANY(s
->context
, s
->state
== PA_STREAM_READY
, PA_ERR_BADSTATE
, PA_INVALID_INDEX
);
176 return s
->device_index
;
179 void pa_stream_set_state(pa_stream
*s
, pa_stream_state_t st
) {
190 if ((st
== PA_STREAM_FAILED
|| st
== PA_STREAM_TERMINATED
) && s
->context
) {
191 /* Detach from context */
193 if (s
->channel_valid
)
194 pa_dynarray_put((s
->direction
== PA_STREAM_PLAYBACK
) ? s
->context
->playback_streams
: s
->context
->record_streams
, s
->channel
, NULL
);
197 s
->channel_valid
= 0;
199 /* We keep a ref as long as we're connected */
203 if (s
->state_callback
)
204 s
->state_callback(s
, s
->state_userdata
);
209 void pa_command_stream_killed(pa_pdispatch
*pd
, uint32_t command
, PA_GCC_UNUSED
uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
210 pa_context
*c
= userdata
;
215 assert(command
== PA_COMMAND_PLAYBACK_STREAM_KILLED
|| command
== PA_COMMAND_RECORD_STREAM_KILLED
);
221 if (pa_tagstruct_getu32(t
, &channel
) < 0 ||
222 !pa_tagstruct_eof(t
)) {
223 pa_context_fail(c
, PA_ERR_PROTOCOL
);
227 if (!(s
= pa_dynarray_get(command
== PA_COMMAND_PLAYBACK_STREAM_KILLED
? c
->playback_streams
: c
->record_streams
, channel
)))
230 pa_context_set_error(c
, PA_ERR_KILLED
);
231 pa_stream_set_state(s
, PA_STREAM_FAILED
);
237 void pa_command_request(pa_pdispatch
*pd
, uint32_t command
, PA_GCC_UNUSED
uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
239 pa_context
*c
= userdata
;
240 uint32_t bytes
, channel
;
243 assert(command
== PA_COMMAND_REQUEST
);
249 if (pa_tagstruct_getu32(t
, &channel
) < 0 ||
250 pa_tagstruct_getu32(t
, &bytes
) < 0 ||
251 !pa_tagstruct_eof(t
)) {
252 pa_context_fail(c
, PA_ERR_PROTOCOL
);
256 if (!(s
= pa_dynarray_get(c
->playback_streams
, channel
)))
259 if (s
->state
== PA_STREAM_READY
) {
260 s
->requested_bytes
+= bytes
;
262 if (s
->requested_bytes
> 0 && s
->write_callback
)
263 s
->write_callback(s
, s
->requested_bytes
, s
->write_userdata
);
270 void pa_command_overflow_or_underflow(pa_pdispatch
*pd
, uint32_t command
, PA_GCC_UNUSED
uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
272 pa_context
*c
= userdata
;
276 assert(command
== PA_COMMAND_OVERFLOW
|| command
== PA_COMMAND_UNDERFLOW
);
282 if (pa_tagstruct_getu32(t
, &channel
) < 0 ||
283 !pa_tagstruct_eof(t
)) {
284 pa_context_fail(c
, PA_ERR_PROTOCOL
);
288 if (!(s
= pa_dynarray_get(c
->playback_streams
, channel
)))
291 if (s
->state
== PA_STREAM_READY
) {
293 if (command
== PA_COMMAND_OVERFLOW
) {
294 if (s
->overflow_callback
)
295 s
->overflow_callback(s
, s
->overflow_userdata
);
296 } else if (command
== PA_COMMAND_UNDERFLOW
) {
297 if (s
->underflow_callback
)
298 s
->underflow_callback(s
, s
->underflow_userdata
);
306 static void request_auto_timing_update(pa_stream
*s
, int force
) {
310 if (!(s
->flags
& PA_STREAM_AUTO_TIMING_UPDATE
))
313 if (s
->state
== PA_STREAM_READY
&&
314 (force
|| !s
->auto_timing_update_requested
)) {
317 /* pa_log("automatically requesting new timing data"); */
319 if ((o
= pa_stream_update_timing_info(s
, NULL
, NULL
))) {
320 pa_operation_unref(o
);
321 s
->auto_timing_update_requested
= 1;
325 pa_gettimeofday(&next
);
326 pa_timeval_add(&next
, LATENCY_IPOL_INTERVAL_USEC
);
327 s
->mainloop
->time_restart(s
->auto_timing_update_event
, &next
);
330 static void invalidate_indexes(pa_stream
*s
, int r
, int w
) {
333 pa_log("invalidate r:%u w:%u tag:%u", r
, w
, s
->context
->ctag
);
335 if (s
->state
!= PA_STREAM_READY
)
339 s
->write_index_not_before
= s
->context
->ctag
;
341 if (s
->timing_info_valid
)
342 s
->timing_info
.write_index_corrupt
= 1;
344 pa_log("write_index invalidated");
349 s
->read_index_not_before
= s
->context
->ctag
;
351 if (s
->timing_info_valid
)
352 s
->timing_info
.read_index_corrupt
= 1;
354 pa_log("read_index invalidated");
357 if ((s
->direction
== PA_STREAM_PLAYBACK
&& r
) ||
358 (s
->direction
== PA_STREAM_RECORD
&& w
))
359 s
->ipol_usec_valid
= 0;
361 request_auto_timing_update(s
, 1);
364 static void auto_timing_update_callback(pa_mainloop_api
*m
, pa_time_event
*e
, PA_GCC_UNUSED
const struct timeval
*tv
, void *userdata
) {
365 pa_stream
*s
= userdata
;
367 pa_log("time event");
370 request_auto_timing_update(s
, 0);
374 void pa_create_stream_callback(pa_pdispatch
*pd
, uint32_t command
, PA_GCC_UNUSED
uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
375 pa_stream
*s
= userdata
;
380 assert(s
->state
== PA_STREAM_CREATING
);
384 if (command
!= PA_COMMAND_REPLY
) {
385 if (pa_context_handle_error(s
->context
, command
, t
) < 0)
388 pa_stream_set_state(s
, PA_STREAM_FAILED
);
392 if (pa_tagstruct_getu32(t
, &s
->channel
) < 0 ||
393 ((s
->direction
!= PA_STREAM_UPLOAD
) && pa_tagstruct_getu32(t
, &s
->device_index
) < 0) ||
394 ((s
->direction
!= PA_STREAM_RECORD
) && pa_tagstruct_getu32(t
, &s
->requested_bytes
) < 0) ||
395 !pa_tagstruct_eof(t
)) {
396 pa_context_fail(s
->context
, PA_ERR_PROTOCOL
);
400 if (s
->direction
== PA_STREAM_RECORD
) {
401 assert(!s
->record_memblockq
);
403 s
->record_memblockq
= pa_memblockq_new(
405 s
->buffer_attr
.maxlength
,
407 pa_frame_size(&s
->sample_spec
),
411 s
->context
->memblock_stat
);
414 s
->channel_valid
= 1;
415 pa_dynarray_put((s
->direction
== PA_STREAM_RECORD
) ? s
->context
->record_streams
: s
->context
->playback_streams
, s
->channel
, s
);
417 /* We add an extra ref as long as we're connected (i.e. in the dynarray) */
420 pa_stream_set_state(s
, PA_STREAM_READY
);
422 if (s
->direction
!= PA_STREAM_UPLOAD
&&
423 s
->flags
& PA_STREAM_AUTO_TIMING_UPDATE
) {
426 pa_gettimeofday(&tv
);
427 tv
.tv_usec
+= LATENCY_IPOL_INTERVAL_USEC
; /* every 100 ms */
429 assert(!s
->auto_timing_update_event
);
430 s
->auto_timing_update_event
= s
->mainloop
->time_new(s
->mainloop
, &tv
, &auto_timing_update_callback
, s
);
432 request_auto_timing_update(s
, 1);
435 if (s
->requested_bytes
> 0 && s
->ref
> 1 && s
->write_callback
)
436 s
->write_callback(s
, s
->requested_bytes
, s
->write_userdata
);
442 static int create_stream(
443 pa_stream_direction_t direction
,
446 const pa_buffer_attr
*attr
,
447 pa_stream_flags_t flags
,
448 const pa_cvolume
*volume
,
449 pa_stream
*sync_stream
) {
457 PA_CHECK_VALIDITY(s
->context
, s
->state
== PA_STREAM_UNCONNECTED
, PA_ERR_BADSTATE
);
458 PA_CHECK_VALIDITY(s
->context
, !(flags
& ~((direction
!= PA_STREAM_UPLOAD
?
459 PA_STREAM_START_CORKED
|
460 PA_STREAM_INTERPOLATE_TIMING
|
461 PA_STREAM_NOT_MONOTONOUS
|
462 PA_STREAM_AUTO_TIMING_UPDATE
: 0))), PA_ERR_INVALID
);
463 PA_CHECK_VALIDITY(s
->context
, direction
== PA_STREAM_PLAYBACK
|| flags
== 0, PA_ERR_INVALID
);
464 PA_CHECK_VALIDITY(s
->context
, !volume
|| volume
->channels
== s
->sample_spec
.channels
, PA_ERR_INVALID
);
465 PA_CHECK_VALIDITY(s
->context
, !sync_stream
|| (direction
== PA_STREAM_PLAYBACK
&& sync_stream
->direction
== PA_STREAM_PLAYBACK
), PA_ERR_INVALID
);
469 s
->direction
= direction
;
473 s
->syncid
= sync_stream
->syncid
;
476 s
->buffer_attr
= *attr
;
479 s
->buffer_attr
.tlength
= pa_bytes_per_second(&s
->sample_spec
)/2;
480 s
->buffer_attr
.maxlength
= (s
->buffer_attr
.tlength
*3)/2;
481 s
->buffer_attr
.minreq
= s
->buffer_attr
.tlength
/100;
482 s
->buffer_attr
.prebuf
= s
->buffer_attr
.tlength
- s
->buffer_attr
.minreq
;
483 s
->buffer_attr
.fragsize
= s
->buffer_attr
.tlength
/100;
487 dev
= s
->direction
== PA_STREAM_PLAYBACK
? s
->context
->conf
->default_sink
: s
->context
->conf
->default_source
;
489 t
= pa_tagstruct_command(
491 s
->direction
== PA_STREAM_PLAYBACK
? PA_COMMAND_CREATE_PLAYBACK_STREAM
: PA_COMMAND_CREATE_RECORD_STREAM
,
496 PA_TAG_STRING
, s
->name
,
497 PA_TAG_SAMPLE_SPEC
, &s
->sample_spec
,
498 PA_TAG_CHANNEL_MAP
, &s
->channel_map
,
499 PA_TAG_U32
, PA_INVALID_INDEX
,
501 PA_TAG_U32
, s
->buffer_attr
.maxlength
,
502 PA_TAG_BOOLEAN
, !!(flags
& PA_STREAM_START_CORKED
),
505 if (s
->direction
== PA_STREAM_PLAYBACK
) {
510 PA_TAG_U32
, s
->buffer_attr
.tlength
,
511 PA_TAG_U32
, s
->buffer_attr
.prebuf
,
512 PA_TAG_U32
, s
->buffer_attr
.minreq
,
513 PA_TAG_U32
, s
->syncid
,
517 volume
= pa_cvolume_reset(&cv
, s
->sample_spec
.channels
);
519 pa_tagstruct_put_cvolume(t
, volume
);
521 pa_tagstruct_putu32(t
, s
->buffer_attr
.fragsize
);
523 pa_pstream_send_tagstruct(s
->context
->pstream
, t
);
524 pa_pdispatch_register_reply(s
->context
->pdispatch
, tag
, DEFAULT_TIMEOUT
, pa_create_stream_callback
, s
);
526 pa_stream_set_state(s
, PA_STREAM_CREATING
);
532 int pa_stream_connect_playback(
535 const pa_buffer_attr
*attr
,
536 pa_stream_flags_t flags
,
538 pa_stream
*sync_stream
) {
543 return create_stream(PA_STREAM_PLAYBACK
, s
, dev
, attr
, flags
, volume
, sync_stream
);
546 int pa_stream_connect_record(
549 const pa_buffer_attr
*attr
,
550 pa_stream_flags_t flags
) {
555 return create_stream(PA_STREAM_RECORD
, s
, dev
, attr
, flags
, NULL
, NULL
);
562 void (*free_cb
)(void *p
),
564 pa_seek_mode_t seek
) {
572 PA_CHECK_VALIDITY(s
->context
, s
->state
== PA_STREAM_READY
, PA_ERR_BADSTATE
);
573 PA_CHECK_VALIDITY(s
->context
, s
->direction
== PA_STREAM_PLAYBACK
|| s
->direction
== PA_STREAM_UPLOAD
, PA_ERR_BADSTATE
);
574 PA_CHECK_VALIDITY(s
->context
, seek
<= PA_SEEK_RELATIVE_END
, PA_ERR_INVALID
);
575 PA_CHECK_VALIDITY(s
->context
, s
->direction
== PA_STREAM_PLAYBACK
|| (seek
== PA_SEEK_RELATIVE
&& offset
== 0), PA_ERR_INVALID
);
581 chunk
.memblock
= pa_memblock_new_user((void*) data
, length
, free_cb
, 1, s
->context
->memblock_stat
);
583 chunk
.memblock
= pa_memblock_new(length
, s
->context
->memblock_stat
);
584 memcpy(chunk
.memblock
->data
, data
, length
);
588 chunk
.length
= length
;
590 pa_pstream_send_memblock(s
->context
->pstream
, s
->channel
, offset
, seek
, &chunk
);
591 pa_memblock_unref(chunk
.memblock
);
593 if (length
< s
->requested_bytes
)
594 s
->requested_bytes
-= length
;
596 s
->requested_bytes
= 0;
598 if (s
->direction
== PA_STREAM_PLAYBACK
) {
600 /* Update latency request correction */
601 if (s
->write_index_corrections
[s
->current_write_index_correction
].valid
) {
603 if (seek
== PA_SEEK_ABSOLUTE
) {
604 s
->write_index_corrections
[s
->current_write_index_correction
].corrupt
= 0;
605 s
->write_index_corrections
[s
->current_write_index_correction
].absolute
= 1;
606 s
->write_index_corrections
[s
->current_write_index_correction
].value
= offset
+ length
;
607 } else if (seek
== PA_SEEK_RELATIVE
) {
608 if (!s
->write_index_corrections
[s
->current_write_index_correction
].corrupt
)
609 s
->write_index_corrections
[s
->current_write_index_correction
].value
+= offset
+ length
;
611 s
->write_index_corrections
[s
->current_write_index_correction
].corrupt
= 1;
614 /* Update the write index in the already available latency data */
615 if (s
->timing_info_valid
) {
617 if (seek
== PA_SEEK_ABSOLUTE
) {
618 s
->timing_info
.write_index_corrupt
= 0;
619 s
->timing_info
.write_index
= offset
+ length
;
620 } else if (seek
== PA_SEEK_RELATIVE
) {
621 if (!s
->timing_info
.write_index_corrupt
)
622 s
->timing_info
.write_index
+= offset
+ length
;
624 s
->timing_info
.write_index_corrupt
= 1;
627 if (!s
->timing_info_valid
|| s
->timing_info
.write_index_corrupt
)
628 request_auto_timing_update(s
, 1);
634 int pa_stream_peek(pa_stream
*s
, const void **data
, size_t *length
) {
640 PA_CHECK_VALIDITY(s
->context
, s
->state
== PA_STREAM_READY
, PA_ERR_BADSTATE
);
641 PA_CHECK_VALIDITY(s
->context
, s
->direction
== PA_STREAM_RECORD
, PA_ERR_BADSTATE
);
643 if (!s
->peek_memchunk
.memblock
) {
645 if (pa_memblockq_peek(s
->record_memblockq
, &s
->peek_memchunk
) < 0) {
652 *data
= (const char*) s
->peek_memchunk
.memblock
->data
+ s
->peek_memchunk
.index
;
653 *length
= s
->peek_memchunk
.length
;
657 int pa_stream_drop(pa_stream
*s
) {
661 PA_CHECK_VALIDITY(s
->context
, s
->state
== PA_STREAM_READY
, PA_ERR_BADSTATE
);
662 PA_CHECK_VALIDITY(s
->context
, s
->direction
== PA_STREAM_RECORD
, PA_ERR_BADSTATE
);
663 PA_CHECK_VALIDITY(s
->context
, s
->peek_memchunk
.memblock
, PA_ERR_BADSTATE
);
665 pa_memblockq_drop(s
->record_memblockq
, &s
->peek_memchunk
, s
->peek_memchunk
.length
);
667 pa_memblock_unref(s
->peek_memchunk
.memblock
);
668 s
->peek_memchunk
.length
= 0;
669 s
->peek_memchunk
.index
= 0;
670 s
->peek_memchunk
.memblock
= NULL
;
675 size_t pa_stream_writable_size(pa_stream
*s
) {
679 PA_CHECK_VALIDITY_RETURN_ANY(s
->context
, s
->state
== PA_STREAM_READY
, PA_ERR_BADSTATE
, (size_t) -1);
680 PA_CHECK_VALIDITY_RETURN_ANY(s
->context
, s
->direction
!= PA_STREAM_RECORD
, PA_ERR_BADSTATE
, (size_t) -1);
682 return s
->requested_bytes
;
685 size_t pa_stream_readable_size(pa_stream
*s
) {
689 PA_CHECK_VALIDITY_RETURN_ANY(s
->context
, s
->state
== PA_STREAM_READY
, PA_ERR_BADSTATE
, (size_t) -1);
690 PA_CHECK_VALIDITY_RETURN_ANY(s
->context
, s
->direction
== PA_STREAM_RECORD
, PA_ERR_BADSTATE
, (size_t) -1);
692 return pa_memblockq_get_length(s
->record_memblockq
);
695 pa_operation
* pa_stream_drain(pa_stream
*s
, pa_stream_success_cb_t cb
, void *userdata
) {
703 PA_CHECK_VALIDITY_RETURN_NULL(s
->context
, s
->state
== PA_STREAM_READY
, PA_ERR_BADSTATE
);
704 PA_CHECK_VALIDITY_RETURN_NULL(s
->context
, s
->direction
== PA_STREAM_PLAYBACK
, PA_ERR_BADSTATE
);
706 o
= pa_operation_new(s
->context
, s
, (pa_operation_cb_t
) cb
, userdata
);
708 t
= pa_tagstruct_command(s
->context
, PA_COMMAND_DRAIN_PLAYBACK_STREAM
, &tag
);
709 pa_tagstruct_putu32(t
, s
->channel
);
710 pa_pstream_send_tagstruct(s
->context
->pstream
, t
);
711 pa_pdispatch_register_reply(s
->context
->pdispatch
, tag
, DEFAULT_TIMEOUT
, pa_stream_simple_ack_callback
, o
);
713 return pa_operation_ref(o
);
716 static void stream_get_timing_info_callback(pa_pdispatch
*pd
, uint32_t command
, uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
717 pa_operation
*o
= userdata
;
718 struct timeval local
, remote
, now
;
726 i
= &o
->stream
->timing_info
;
728 pa_log("pre corrupt w:%u r:%u\n", !o
->stream
->timing_info_valid
|| i
->write_index_corrupt
,!o
->stream
->timing_info_valid
|| i
->read_index_corrupt
);
730 o
->stream
->timing_info_valid
= 0;
731 i
->write_index_corrupt
= 0;
732 i
->read_index_corrupt
= 0;
734 pa_log("timing update %u\n", tag
);
736 if (command
!= PA_COMMAND_REPLY
) {
737 if (pa_context_handle_error(o
->context
, command
, t
) < 0)
740 } else if (pa_tagstruct_get_usec(t
, &i
->sink_usec
) < 0 ||
741 pa_tagstruct_get_usec(t
, &i
->source_usec
) < 0 ||
742 pa_tagstruct_get_boolean(t
, &i
->playing
) < 0 ||
743 pa_tagstruct_get_timeval(t
, &local
) < 0 ||
744 pa_tagstruct_get_timeval(t
, &remote
) < 0 ||
745 pa_tagstruct_gets64(t
, &i
->write_index
) < 0 ||
746 pa_tagstruct_gets64(t
, &i
->read_index
) < 0 ||
747 !pa_tagstruct_eof(t
)) {
748 pa_context_fail(o
->context
, PA_ERR_PROTOCOL
);
752 o
->stream
->timing_info_valid
= 1;
754 pa_gettimeofday(&now
);
756 /* Calculcate timestamps */
757 if (pa_timeval_cmp(&local
, &remote
) <= 0 && pa_timeval_cmp(&remote
, &now
) <= 0) {
758 /* local and remote seem to have synchronized clocks */
760 if (o
->stream
->direction
== PA_STREAM_PLAYBACK
)
761 i
->transport_usec
= pa_timeval_diff(&remote
, &local
);
763 i
->transport_usec
= pa_timeval_diff(&now
, &remote
);
765 i
->synchronized_clocks
= 1;
766 i
->timestamp
= remote
;
768 /* clocks are not synchronized, let's estimate latency then */
769 i
->transport_usec
= pa_timeval_diff(&now
, &local
)/2;
770 i
->synchronized_clocks
= 0;
771 i
->timestamp
= local
;
772 pa_timeval_add(&i
->timestamp
, i
->transport_usec
);
775 /* Invalidate read and write indexes if necessary */
776 if (tag
< o
->stream
->read_index_not_before
)
777 i
->read_index_corrupt
= 1;
779 if (tag
< o
->stream
->write_index_not_before
)
780 i
->write_index_corrupt
= 1;
782 if (o
->stream
->direction
== PA_STREAM_PLAYBACK
) {
783 /* Write index correction */
788 /* Go through the saved correction values and add up the total correction.*/
790 for (n
= 0, j
= o
->stream
->current_write_index_correction
+1;
791 n
< PA_MAX_WRITE_INDEX_CORRECTIONS
;
792 n
++, j
= (j
+ 1) % PA_MAX_WRITE_INDEX_CORRECTIONS
) {
794 /* Step over invalid data or out-of-date data */
795 if (!o
->stream
->write_index_corrections
[j
].valid
||
796 o
->stream
->write_index_corrections
[j
].tag
< ctag
)
799 /* Make sure that everything is in order */
800 ctag
= o
->stream
->write_index_corrections
[j
].tag
+1;
802 /* Now fix the write index */
803 if (o
->stream
->write_index_corrections
[j
].corrupt
) {
804 /* A corrupting seek was made */
806 i
->write_index_corrupt
= 1;
807 } else if (o
->stream
->write_index_corrections
[j
].absolute
) {
808 /* An absolute seek was made */
809 i
->write_index
= o
->stream
->write_index_corrections
[j
].value
;
810 i
->write_index_corrupt
= 0;
811 } else if (!i
->write_index_corrupt
) {
812 /* A relative seek was made */
813 i
->write_index
+= o
->stream
->write_index_corrections
[j
].value
;
818 o
->stream
->ipol_timestamp
= now
;
819 o
->stream
->ipol_usec_valid
= 0;
822 o
->stream
->auto_timing_update_requested
= 0;
823 pa_log("post corrupt w:%u r:%u\n", i
->write_index_corrupt
|| !o
->stream
->timing_info_valid
, i
->read_index_corrupt
|| !o
->stream
->timing_info_valid
);
825 /* Clear old correction entries */
826 if (o
->stream
->direction
== PA_STREAM_PLAYBACK
) {
829 for (n
= 0; n
< PA_MAX_WRITE_INDEX_CORRECTIONS
; n
++) {
830 if (!o
->stream
->write_index_corrections
[n
].valid
)
833 if (o
->stream
->write_index_corrections
[n
].tag
<= tag
)
834 o
->stream
->write_index_corrections
[n
].valid
= 0;
839 pa_stream_success_cb_t cb
= (pa_stream_success_cb_t
) o
->callback
;
840 cb(o
->stream
, o
->stream
->timing_info_valid
, o
->userdata
);
845 pa_operation_done(o
);
846 pa_operation_unref(o
);
849 pa_operation
* pa_stream_update_timing_info(pa_stream
*s
, pa_stream_success_cb_t cb
, void *userdata
) {
859 PA_CHECK_VALIDITY_RETURN_NULL(s
->context
, s
->state
== PA_STREAM_READY
, PA_ERR_BADSTATE
);
860 PA_CHECK_VALIDITY_RETURN_NULL(s
->context
, s
->direction
!= PA_STREAM_UPLOAD
, PA_ERR_BADSTATE
);
862 if (s
->direction
== PA_STREAM_PLAYBACK
) {
863 /* Find a place to store the write_index correction data for this entry */
864 cidx
= (s
->current_write_index_correction
+ 1) % PA_MAX_WRITE_INDEX_CORRECTIONS
;
866 /* Check if we could allocate a correction slot. If not, there are too many outstanding queries */
867 PA_CHECK_VALIDITY_RETURN_NULL(s
->context
, !s
->write_index_corrections
[cidx
].valid
, PA_ERR_INTERNAL
);
869 o
= pa_operation_new(s
->context
, s
, (pa_operation_cb_t
) cb
, userdata
);
871 t
= pa_tagstruct_command(
873 s
->direction
== PA_STREAM_PLAYBACK
? PA_COMMAND_GET_PLAYBACK_LATENCY
: PA_COMMAND_GET_RECORD_LATENCY
,
875 pa_tagstruct_putu32(t
, s
->channel
);
876 pa_tagstruct_put_timeval(t
, pa_gettimeofday(&now
));
878 pa_pstream_send_tagstruct(s
->context
->pstream
, t
);
879 pa_pdispatch_register_reply(s
->context
->pdispatch
, tag
, DEFAULT_TIMEOUT
, stream_get_timing_info_callback
, o
);
881 if (s
->direction
== PA_STREAM_PLAYBACK
) {
882 /* Fill in initial correction data */
883 o
->stream
->current_write_index_correction
= cidx
;
884 o
->stream
->write_index_corrections
[cidx
].valid
= 1;
885 o
->stream
->write_index_corrections
[cidx
].tag
= tag
;
886 o
->stream
->write_index_corrections
[cidx
].absolute
= 0;
887 o
->stream
->write_index_corrections
[cidx
].value
= 0;
888 o
->stream
->write_index_corrections
[cidx
].corrupt
= 0;
891 pa_log("requesting update %u\n", tag
);
893 return pa_operation_ref(o
);
896 void pa_stream_disconnect_callback(pa_pdispatch
*pd
, uint32_t command
, PA_GCC_UNUSED
uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
897 pa_stream
*s
= userdata
;
905 if (command
!= PA_COMMAND_REPLY
) {
906 if (pa_context_handle_error(s
->context
, command
, t
) < 0)
909 pa_stream_set_state(s
, PA_STREAM_FAILED
);
911 } else if (!pa_tagstruct_eof(t
)) {
912 pa_context_fail(s
->context
, PA_ERR_PROTOCOL
);
916 pa_stream_set_state(s
, PA_STREAM_TERMINATED
);
922 int pa_stream_disconnect(pa_stream
*s
) {
929 PA_CHECK_VALIDITY(s
->context
, s
->channel_valid
, PA_ERR_BADSTATE
);
930 PA_CHECK_VALIDITY(s
->context
, s
->context
->state
== PA_CONTEXT_READY
, PA_ERR_BADSTATE
);
934 t
= pa_tagstruct_command(
936 s
->direction
== PA_STREAM_PLAYBACK
? PA_COMMAND_DELETE_PLAYBACK_STREAM
:
937 (s
->direction
== PA_STREAM_RECORD
? PA_COMMAND_DELETE_RECORD_STREAM
: PA_COMMAND_DELETE_UPLOAD_STREAM
),
939 pa_tagstruct_putu32(t
, s
->channel
);
940 pa_pstream_send_tagstruct(s
->context
->pstream
, t
);
941 pa_pdispatch_register_reply(s
->context
->pdispatch
, tag
, DEFAULT_TIMEOUT
, pa_stream_disconnect_callback
, s
);
947 void pa_stream_set_read_callback(pa_stream
*s
, pa_stream_request_cb_t cb
, void *userdata
) {
951 s
->read_callback
= cb
;
952 s
->read_userdata
= userdata
;
955 void pa_stream_set_write_callback(pa_stream
*s
, pa_stream_request_cb_t cb
, void *userdata
) {
959 s
->write_callback
= cb
;
960 s
->write_userdata
= userdata
;
963 void pa_stream_set_state_callback(pa_stream
*s
, pa_stream_notify_cb_t cb
, void *userdata
) {
967 s
->state_callback
= cb
;
968 s
->state_userdata
= userdata
;
971 void pa_stream_set_overflow_callback(pa_stream
*s
, pa_stream_notify_cb_t cb
, void *userdata
) {
975 s
->overflow_callback
= cb
;
976 s
->overflow_userdata
= userdata
;
979 void pa_stream_set_underflow_callback(pa_stream
*s
, pa_stream_notify_cb_t cb
, void *userdata
) {
983 s
->underflow_callback
= cb
;
984 s
->underflow_userdata
= userdata
;
987 void pa_stream_simple_ack_callback(pa_pdispatch
*pd
, uint32_t command
, PA_GCC_UNUSED
uint32_t tag
, pa_tagstruct
*t
, void *userdata
) {
988 pa_operation
*o
= userdata
;
996 if (command
!= PA_COMMAND_REPLY
) {
997 if (pa_context_handle_error(o
->context
, command
, t
) < 0)
1001 } else if (!pa_tagstruct_eof(t
)) {
1002 pa_context_fail(o
->context
, PA_ERR_PROTOCOL
);
1007 pa_stream_success_cb_t cb
= (pa_stream_success_cb_t
) o
->callback
;
1008 cb(o
->stream
, success
, o
->userdata
);
1012 pa_operation_done(o
);
1013 pa_operation_unref(o
);
1016 pa_operation
* pa_stream_cork(pa_stream
*s
, int b
, pa_stream_success_cb_t cb
, void *userdata
) {
1022 assert(s
->ref
>= 1);
1024 PA_CHECK_VALIDITY_RETURN_NULL(s
->context
, s
->state
== PA_STREAM_READY
, PA_ERR_BADSTATE
);
1025 PA_CHECK_VALIDITY_RETURN_NULL(s
->context
, s
->direction
!= PA_STREAM_UPLOAD
, PA_ERR_BADSTATE
);
1029 o
= pa_operation_new(s
->context
, s
, (pa_operation_cb_t
) cb
, userdata
);
1031 t
= pa_tagstruct_command(
1033 s
->direction
== PA_STREAM_PLAYBACK
? PA_COMMAND_CORK_PLAYBACK_STREAM
: PA_COMMAND_CORK_RECORD_STREAM
,
1035 pa_tagstruct_putu32(t
, s
->channel
);
1036 pa_tagstruct_put_boolean(t
, !!b
);
1037 pa_pstream_send_tagstruct(s
->context
->pstream
, t
);
1038 pa_pdispatch_register_reply(s
->context
->pdispatch
, tag
, DEFAULT_TIMEOUT
, pa_stream_simple_ack_callback
, o
);
1040 if (s
->direction
== PA_STREAM_PLAYBACK
)
1041 invalidate_indexes(s
, 1, 0);
1043 return pa_operation_ref(o
);
1046 static pa_operation
* stream_send_simple_command(pa_stream
*s
, uint32_t command
, pa_stream_success_cb_t cb
, void *userdata
) {
1052 assert(s
->ref
>= 1);
1054 PA_CHECK_VALIDITY_RETURN_NULL(s
->context
, s
->state
== PA_STREAM_READY
, PA_ERR_BADSTATE
);
1056 o
= pa_operation_new(s
->context
, s
, (pa_operation_cb_t
) cb
, userdata
);
1058 t
= pa_tagstruct_command(s
->context
, command
, &tag
);
1059 pa_tagstruct_putu32(t
, s
->channel
);
1060 pa_pstream_send_tagstruct(s
->context
->pstream
, t
);
1061 pa_pdispatch_register_reply(s
->context
->pdispatch
, tag
, DEFAULT_TIMEOUT
, pa_stream_simple_ack_callback
, o
);
1063 return pa_operation_ref(o
);
1066 pa_operation
* pa_stream_flush(pa_stream
*s
, pa_stream_success_cb_t cb
, void *userdata
) {
1069 PA_CHECK_VALIDITY_RETURN_NULL(s
->context
, s
->direction
!= PA_STREAM_UPLOAD
, PA_ERR_BADSTATE
);
1071 if ((o
= stream_send_simple_command(s
, s
->direction
== PA_STREAM_PLAYBACK
? PA_COMMAND_FLUSH_PLAYBACK_STREAM
: PA_COMMAND_FLUSH_RECORD_STREAM
, cb
, userdata
))) {
1073 if (s
->direction
== PA_STREAM_PLAYBACK
) {
1074 if (s
->write_index_corrections
[s
->current_write_index_correction
].valid
)
1075 s
->write_index_corrections
[s
->current_write_index_correction
].corrupt
= 1;
1077 if (s
->timing_info_valid
)
1078 s
->timing_info
.write_index_corrupt
= 1;
1080 if (s
->buffer_attr
.prebuf
> 0)
1081 invalidate_indexes(s
, 1, 0);
1083 request_auto_timing_update(s
, 1);
1085 invalidate_indexes(s
, 0, 1);
1091 pa_operation
* pa_stream_prebuf(pa_stream
*s
, pa_stream_success_cb_t cb
, void *userdata
) {
1094 PA_CHECK_VALIDITY_RETURN_NULL(s
->context
, s
->direction
== PA_STREAM_PLAYBACK
, PA_ERR_BADSTATE
);
1095 PA_CHECK_VALIDITY_RETURN_NULL(s
->context
, s
->buffer_attr
.prebuf
> 0, PA_ERR_BADSTATE
);
1097 if ((o
= stream_send_simple_command(s
, PA_COMMAND_PREBUF_PLAYBACK_STREAM
, cb
, userdata
)))
1098 invalidate_indexes(s
, 1, 0);
1103 pa_operation
* pa_stream_trigger(pa_stream
*s
, pa_stream_success_cb_t cb
, void *userdata
) {
1106 PA_CHECK_VALIDITY_RETURN_NULL(s
->context
, s
->direction
== PA_STREAM_PLAYBACK
, PA_ERR_BADSTATE
);
1107 PA_CHECK_VALIDITY_RETURN_NULL(s
->context
, s
->buffer_attr
.prebuf
> 0, PA_ERR_BADSTATE
);
1109 if ((o
= stream_send_simple_command(s
, PA_COMMAND_TRIGGER_PLAYBACK_STREAM
, cb
, userdata
)))
1110 invalidate_indexes(s
, 1, 0);
1115 pa_operation
* pa_stream_set_name(pa_stream
*s
, const char *name
, pa_stream_success_cb_t cb
, void *userdata
) {
1121 assert(s
->ref
>= 1);
1124 PA_CHECK_VALIDITY_RETURN_NULL(s
->context
, s
->state
== PA_STREAM_READY
, PA_ERR_BADSTATE
);
1125 PA_CHECK_VALIDITY_RETURN_NULL(s
->context
, s
->direction
!= PA_STREAM_UPLOAD
, PA_ERR_BADSTATE
);
1127 o
= pa_operation_new(s
->context
, s
, (pa_operation_cb_t
) cb
, userdata
);
1129 t
= pa_tagstruct_command(
1131 s
->direction
== PA_STREAM_RECORD
? PA_COMMAND_SET_RECORD_STREAM_NAME
: PA_COMMAND_SET_PLAYBACK_STREAM_NAME
,
1133 pa_tagstruct_putu32(t
, s
->channel
);
1134 pa_tagstruct_puts(t
, name
);
1135 pa_pstream_send_tagstruct(s
->context
->pstream
, t
);
1136 pa_pdispatch_register_reply(s
->context
->pdispatch
, tag
, DEFAULT_TIMEOUT
, pa_stream_simple_ack_callback
, o
);
1138 return pa_operation_ref(o
);
1141 int pa_stream_get_time(pa_stream
*s
, pa_usec_t
*r_usec
) {
1145 assert(s
->ref
>= 1);
1147 PA_CHECK_VALIDITY(s
->context
, s
->state
== PA_STREAM_READY
, PA_ERR_BADSTATE
);
1148 PA_CHECK_VALIDITY(s
->context
, s
->direction
!= PA_STREAM_UPLOAD
, PA_ERR_BADSTATE
);
1149 PA_CHECK_VALIDITY(s
->context
, s
->timing_info_valid
, PA_ERR_NODATA
);
1150 PA_CHECK_VALIDITY(s
->context
, s
->direction
!= PA_STREAM_PLAYBACK
|| !s
->timing_info
.read_index_corrupt
, PA_ERR_NODATA
);
1151 PA_CHECK_VALIDITY(s
->context
, s
->direction
!= PA_STREAM_RECORD
|| !s
->timing_info
.write_index_corrupt
, PA_ERR_NODATA
);
1153 if (s
->flags
& PA_STREAM_INTERPOLATE_TIMING
&& s
->ipol_usec_valid
)
1154 usec
= s
->ipol_usec
;
1156 if (s
->direction
== PA_STREAM_PLAYBACK
) {
1157 /* The last byte that was written into the output device
1158 * had this time value associated */
1159 usec
= pa_bytes_to_usec(s
->timing_info
.read_index
< 0 ? 0 : (uint64_t) s
->timing_info
.read_index
, &s
->sample_spec
);
1162 /* Because the latency info took a little time to come
1163 * to us, we assume that the real output time is actually
1165 usec
+= s
->timing_info
.transport_usec
;
1167 /* However, the output device usually maintains a buffer
1168 too, hence the real sample currently played is a little
1170 if (s
->timing_info
.sink_usec
>= usec
)
1173 usec
-= s
->timing_info
.sink_usec
;
1176 } else if (s
->direction
== PA_STREAM_RECORD
) {
1177 /* The last byte written into the server side queue had
1178 * this time value associated */
1179 usec
= pa_bytes_to_usec(s
->timing_info
.write_index
< 0 ? 0 : (uint64_t) s
->timing_info
.write_index
, &s
->sample_spec
);
1182 /* Add transport latency */
1183 usec
+= s
->timing_info
.transport_usec
;
1185 /* Add latency of data in device buffer */
1186 usec
+= s
->timing_info
.source_usec
;
1188 /* If this is a monitor source, we need to correct the
1189 * time by the playback device buffer */
1190 if (s
->timing_info
.sink_usec
>= usec
)
1193 usec
-= s
->timing_info
.sink_usec
;
1197 if (s
->flags
& PA_STREAM_INTERPOLATE_TIMING
) {
1198 s
->ipol_usec
= usec
;
1199 s
->ipol_usec_valid
= 1;
1203 /* Interpolate if requested */
1204 if (s
->flags
& PA_STREAM_INTERPOLATE_TIMING
) {
1206 /* We just add the time that passed since the latency info was
1211 usec
+= pa_timeval_diff(pa_gettimeofday(&now
), &s
->ipol_timestamp
);
1212 s
->ipol_timestamp
= now
;
1216 /* Make sure the time runs monotonically */
1217 if (!(s
->flags
& PA_STREAM_NOT_MONOTONOUS
)) {
1218 if (usec
< s
->previous_time
)
1219 usec
= s
->previous_time
;
1221 s
->previous_time
= usec
;
1230 static pa_usec_t
time_counter_diff(pa_stream
*s
, pa_usec_t a
, pa_usec_t b
, int *negative
) {
1232 assert(s
->ref
>= 1);
1240 if (negative
&& s
->direction
== PA_STREAM_RECORD
) {
1248 int pa_stream_get_latency(pa_stream
*s
, pa_usec_t
*r_usec
, int *negative
) {
1254 assert(s
->ref
>= 1);
1257 PA_CHECK_VALIDITY(s
->context
, s
->state
== PA_STREAM_READY
, PA_ERR_BADSTATE
);
1258 PA_CHECK_VALIDITY(s
->context
, s
->direction
!= PA_STREAM_UPLOAD
, PA_ERR_BADSTATE
);
1259 PA_CHECK_VALIDITY(s
->context
, s
->timing_info_valid
, PA_ERR_NODATA
);
1260 PA_CHECK_VALIDITY(s
->context
, s
->direction
!= PA_STREAM_PLAYBACK
|| !s
->timing_info
.write_index_corrupt
, PA_ERR_NODATA
);
1261 PA_CHECK_VALIDITY(s
->context
, s
->direction
!= PA_STREAM_RECORD
|| !s
->timing_info
.read_index_corrupt
, PA_ERR_NODATA
);
1263 if ((r
= pa_stream_get_time(s
, &t
)) < 0)
1266 if (s
->direction
== PA_STREAM_PLAYBACK
)
1267 cindex
= s
->timing_info
.write_index
;
1269 cindex
= s
->timing_info
.read_index
;
1274 c
= pa_bytes_to_usec(cindex
, &s
->sample_spec
);
1276 if (s
->direction
== PA_STREAM_PLAYBACK
)
1277 *r_usec
= time_counter_diff(s
, c
, t
, negative
);
1279 *r_usec
= time_counter_diff(s
, t
, c
, negative
);
1284 const pa_timing_info
* pa_stream_get_timing_info(pa_stream
*s
) {
1286 assert(s
->ref
>= 1);
1288 PA_CHECK_VALIDITY_RETURN_NULL(s
->context
, s
->state
== PA_STREAM_READY
, PA_ERR_BADSTATE
);
1289 PA_CHECK_VALIDITY_RETURN_NULL(s
->context
, s
->direction
!= PA_STREAM_UPLOAD
, PA_ERR_BADSTATE
);
1290 PA_CHECK_VALIDITY_RETURN_NULL(s
->context
, s
->timing_info_valid
, PA_ERR_BADSTATE
);
1292 return &s
->timing_info
;
1295 const pa_sample_spec
* pa_stream_get_sample_spec(pa_stream
*s
) {
1297 assert(s
->ref
>= 1);
1299 return &s
->sample_spec
;
1302 const pa_channel_map
* pa_stream_get_channel_map(pa_stream
*s
) {
1304 assert(s
->ref
>= 1);
1306 return &s
->channel_map
;