code.delx.au - pulseaudio/blob - src/pulse/stream.c

   1 /***
   2   This file is part of PulseAudio.
   3
   4   Copyright 2004-2006 Lennart Poettering
   5   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
   6
   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.
  11
  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.
  16
  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
  20   USA.
  21 ***/
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include <config.h>
  25 #endif
  26
  27 #include <string.h>
  28 #include <stdio.h>
  29 #include <string.h>
  30
  31 #include <pulse/def.h>
  32 #include <pulse/timeval.h>
  33 #include <pulse/xmalloc.h>
  34
  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>
  40
  41 #include "internal.h"
  42
  43 #define LATENCY_IPOL_INTERVAL_USEC (333*PA_USEC_PER_MSEC)
  44
  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)
  48
  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);
  51 }
  52
  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;
  72 }
  73
  74 pa_stream *pa_stream_new_with_proplist(
  75         pa_context *c,
  76         const char *name,
  77         const pa_sample_spec *ss,
  78         const pa_channel_map *map,
  79         pa_proplist *p) {
  80
  81     pa_stream *s;
  82     int i;
  83     pa_channel_map tmap;
  84
  85     pa_assert(c);
  86     pa_assert(PA_REFCNT_VALUE(c) >= 1);
  87
  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);
  92
  93     if (!map)
  94         PA_CHECK_VALIDITY_RETURN_NULL(c, map = pa_channel_map_init_auto(&tmap, ss->channels, PA_CHANNEL_MAP_DEFAULT), PA_ERR_INVALID);
  95
  96     s = pa_xnew(pa_stream, 1);
  97     PA_REFCNT_INIT(s);
  98     s->context = c;
  99     s->mainloop = c->mainloop;
 100
 101     s->direction = PA_STREAM_NODIRECTION;
 102     s->state = PA_STREAM_UNCONNECTED;
 103     s->flags = 0;
 104
 105     s->sample_spec = *ss;
 106     s->channel_map = *map;
 107
 108     s->direct_on_input = PA_INVALID_INDEX;
 109
 110     s->proplist = p ? pa_proplist_copy(p) : pa_proplist_new();
 111     if (name)
 112         pa_proplist_sets(s->proplist, PA_PROP_MEDIA_NAME, name);
 113
 114     s->channel = 0;
 115     s->channel_valid = FALSE;
 116     s->syncid = c->csyncid++;
 117     s->stream_index = PA_INVALID_INDEX;
 118
 119     s->requested_bytes = 0;
 120     memset(&s->buffer_attr, 0, sizeof(s->buffer_attr));
 121
 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. */
 125
 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;
 131
 132     s->device_index = PA_INVALID_INDEX;
 133     s->device_name = NULL;
 134     s->suspended = FALSE;
 135
 136     pa_memchunk_reset(&s->peek_memchunk);
 137     s->peek_data = NULL;
 138
 139     s->record_memblockq = NULL;
 140
 141     s->corked = FALSE;
 142
 143     memset(&s->timing_info, 0, sizeof(s->timing_info));
 144     s->timing_info_valid = FALSE;
 145
 146     s->previous_time = 0;
 147
 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;
 153
 154     s->auto_timing_update_event = NULL;
 155     s->auto_timing_update_requested = FALSE;
 156
 157     reset_callbacks(s);
 158
 159     s->smoother = NULL;
 160
 161     /* Refcounting is strictly one-way: from the "bigger" to the "smaller" object. */
 162     PA_LLIST_PREPEND(pa_stream, c->streams, s);
 163     pa_stream_ref(s);
 164
 165     return s;
 166 }
 167
 168 static void stream_unlink(pa_stream *s) {
 169     pa_operation *o, *n;
 170     pa_assert(s);
 171
 172     if (!s->context)
 173         return;
 174
 175     /* Detach from context */
 176
 177     /* Unref all operatio object that point to us */
 178     for (o = s->context->operations; o; o = n) {
 179         n = o->next;
 180
 181         if (o->stream == s)
 182             pa_operation_cancel(o);
 183     }
 184
 185     /* Drop all outstanding replies for this stream */
 186     if (s->context->pdispatch)
 187         pa_pdispatch_unregister_reply(s->context->pdispatch, s);
 188
 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);
 191         s->channel = 0;
 192         s->channel_valid = FALSE;
 193     }
 194
 195     PA_LLIST_REMOVE(pa_stream, s->context->streams, s);
 196     pa_stream_unref(s);
 197
 198     s->context = NULL;
 199
 200     if (s->auto_timing_update_event) {
 201         pa_assert(s->mainloop);
 202         s->mainloop->time_free(s->auto_timing_update_event);
 203     }
 204
 205     reset_callbacks(s);
 206 }
 207
 208 static void stream_free(pa_stream *s) {
 209     pa_assert(s);
 210
 211     stream_unlink(s);
 212
 213     if (s->peek_memchunk.memblock) {
 214         if (s->peek_data)
 215             pa_memblock_release(s->peek_memchunk.memblock);
 216         pa_memblock_unref(s->peek_memchunk.memblock);
 217     }
 218
 219     if (s->record_memblockq)
 220         pa_memblockq_free(s->record_memblockq);
 221
 222     if (s->proplist)
 223         pa_proplist_free(s->proplist);
 224
 225     if (s->smoother)
 226         pa_smoother_free(s->smoother);
 227
 228     pa_xfree(s->device_name);
 229     pa_xfree(s);
 230 }
 231
 232 void pa_stream_unref(pa_stream *s) {
 233     pa_assert(s);
 234     pa_assert(PA_REFCNT_VALUE(s) >= 1);
 235
 236     if (PA_REFCNT_DEC(s) <= 0)
 237         stream_free(s);
 238 }
 239
 240 pa_stream* pa_stream_ref(pa_stream *s) {
 241     pa_assert(s);
 242     pa_assert(PA_REFCNT_VALUE(s) >= 1);
 243
 244     PA_REFCNT_INC(s);
 245     return s;
 246 }
 247
 248 pa_stream_state_t pa_stream_get_state(pa_stream *s) {
 249     pa_assert(s);
 250     pa_assert(PA_REFCNT_VALUE(s) >= 1);
 251
 252     return s->state;
 253 }
 254
 255 pa_context* pa_stream_get_context(pa_stream *s) {
 256     pa_assert(s);
 257     pa_assert(PA_REFCNT_VALUE(s) >= 1);
 258
 259     return s->context;
 260 }
 261
 262 uint32_t pa_stream_get_index(pa_stream *s) {
 263     pa_assert(s);
 264     pa_assert(PA_REFCNT_VALUE(s) >= 1);
 265
 266     PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE, PA_INVALID_INDEX);
 267
 268     return s->stream_index;
 269 }
 270
 271 void pa_stream_set_state(pa_stream *s, pa_stream_state_t st) {
 272     pa_assert(s);
 273     pa_assert(PA_REFCNT_VALUE(s) >= 1);
 274
 275     if (s->state == st)
 276         return;
 277
 278     pa_stream_ref(s);
 279
 280     s->state = st;
 281
 282     if (s->state_callback)
 283         s->state_callback(s, s->state_userdata);
 284
 285     if ((st == PA_STREAM_FAILED || st == PA_STREAM_TERMINATED))
 286         stream_unlink(s);
 287
 288     pa_stream_unref(s);
 289 }
 290
 291 static void request_auto_timing_update(pa_stream *s, pa_bool_t force) {
 292     pa_assert(s);
 293     pa_assert(PA_REFCNT_VALUE(s) >= 1);
 294
 295     if (!(s->flags & PA_STREAM_AUTO_TIMING_UPDATE))
 296         return;
 297
 298     if (s->state == PA_STREAM_READY &&
 299         (force || !s->auto_timing_update_requested)) {
 300         pa_operation *o;
 301
 302 /*         pa_log("automatically requesting new timing data"); */
 303
 304         if ((o = pa_stream_update_timing_info(s, NULL, NULL))) {
 305             pa_operation_unref(o);
 306             s->auto_timing_update_requested = TRUE;
 307         }
 308     }
 309
 310     if (s->auto_timing_update_event) {
 311         struct timeval next;
 312         pa_gettimeofday(&next);
 313         pa_timeval_add(&next, LATENCY_IPOL_INTERVAL_USEC);
 314         s->mainloop->time_restart(s->auto_timing_update_event, &next);
 315     }
 316 }
 317
 318 void pa_command_stream_killed(pa_pdispatch *pd, uint32_t command, PA_GCC_UNUSED uint32_t tag, pa_tagstruct *t, void *userdata) {
 319     pa_context *c = userdata;
 320     pa_stream *s;
 321     uint32_t channel;
 322
 323     pa_assert(pd);
 324     pa_assert(command == PA_COMMAND_PLAYBACK_STREAM_KILLED || command == PA_COMMAND_RECORD_STREAM_KILLED);
 325     pa_assert(t);
 326     pa_assert(c);
 327     pa_assert(PA_REFCNT_VALUE(c) >= 1);
 328
 329     pa_context_ref(c);
 330
 331     if (pa_tagstruct_getu32(t, &channel) < 0 ||
 332         !pa_tagstruct_eof(t)) {
 333         pa_context_fail(c, PA_ERR_PROTOCOL);
 334         goto finish;
 335     }
 336
 337     if (!(s = pa_dynarray_get(command == PA_COMMAND_PLAYBACK_STREAM_KILLED ? c->playback_streams : c->record_streams, channel)))
 338         goto finish;
 339
 340     if (s->state != PA_STREAM_READY)
 341         goto finish;
 342
 343     pa_context_set_error(c, PA_ERR_KILLED);
 344     pa_stream_set_state(s, PA_STREAM_FAILED);
 345
 346 finish:
 347     pa_context_unref(c);
 348 }
 349
 350 static void check_smoother_status(pa_stream *s, pa_bool_t aposteriori, pa_bool_t force_start, pa_bool_t force_stop) {
 351     pa_usec_t x;
 352
 353     pa_assert(s);
 354     pa_assert(!force_start || !force_stop);
 355
 356     if (!s->smoother)
 357         return;
 358
 359     x = pa_rtclock_usec();
 360
 361     if (s->timing_info_valid) {
 362         if (aposteriori)
 363             x -= s->timing_info.transport_usec;
 364         else
 365             x += s->timing_info.transport_usec;
 366
 367         if (s->direction == PA_STREAM_PLAYBACK)
 368             /* it takes a while until the pause/resume is actually
 369              * audible */
 370             x += s->timing_info.sink_usec;
 371         else
 372             /* Data froma  while back will be dropped */
 373             x -= s->timing_info.source_usec;
 374     }
 375
 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);
 380
 381     /* Please note that we have no idea if playback actually started
 382      * if prebuf is non-zero! */
 383 }
 384
 385 void pa_command_stream_moved(pa_pdispatch *pd, uint32_t command, PA_GCC_UNUSED uint32_t tag, pa_tagstruct *t, void *userdata) {
 386     pa_context *c = userdata;
 387     pa_stream *s;
 388     uint32_t channel;
 389     const char *dn;
 390     pa_bool_t suspended;
 391     uint32_t di;
 392     pa_usec_t usec;
 393     uint32_t maxlength = 0, fragsize = 0, minreq = 0, tlength = 0, prebuf = 0;
 394
 395     pa_assert(pd);
 396     pa_assert(command == PA_COMMAND_PLAYBACK_STREAM_MOVED || command == PA_COMMAND_RECORD_STREAM_MOVED);
 397     pa_assert(t);
 398     pa_assert(c);
 399     pa_assert(PA_REFCNT_VALUE(c) >= 1);
 400
 401     pa_context_ref(c);
 402
 403     if (c->version < 12) {
 404         pa_context_fail(c, PA_ERR_PROTOCOL);
 405         goto finish;
 406     }
 407
 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);
 413         goto finish;
 414     }
 415
 416     if (c->version >= 13) {
 417
 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);
 423                 goto finish;
 424             }
 425         } else {
 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);
 432                 goto finish;
 433             }
 434         }
 435     }
 436
 437     if (!pa_tagstruct_eof(t)) {
 438         pa_context_fail(c, PA_ERR_PROTOCOL);
 439         goto finish;
 440     }
 441
 442     if (!dn || di == PA_INVALID_INDEX) {
 443         pa_context_fail(c, PA_ERR_PROTOCOL);
 444         goto finish;
 445     }
 446
 447     if (!(s = pa_dynarray_get(command == PA_COMMAND_PLAYBACK_STREAM_MOVED ? c->playback_streams : c->record_streams, channel)))
 448         goto finish;
 449
 450     if (s->state != PA_STREAM_READY)
 451         goto finish;
 452
 453     if (c->version >= 13) {
 454         if (s->direction == PA_STREAM_RECORD)
 455             s->timing_info.configured_source_usec = usec;
 456         else
 457             s->timing_info.configured_sink_usec = usec;
 458
 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;
 464     }
 465
 466     pa_xfree(s->device_name);
 467     s->device_name = pa_xstrdup(dn);
 468     s->device_index = di;
 469
 470     s->suspended = suspended;
 471
 472     check_smoother_status(s, TRUE, FALSE, FALSE);
 473     request_auto_timing_update(s, TRUE);
 474
 475     if (s->moved_callback)
 476         s->moved_callback(s, s->moved_userdata);
 477
 478 finish:
 479     pa_context_unref(c);
 480 }
 481
 482 void pa_command_stream_suspended(pa_pdispatch *pd, uint32_t command, PA_GCC_UNUSED uint32_t tag, pa_tagstruct *t, void *userdata) {
 483     pa_context *c = userdata;
 484     pa_stream *s;
 485     uint32_t channel;
 486     pa_bool_t suspended;
 487
 488     pa_assert(pd);
 489     pa_assert(command == PA_COMMAND_PLAYBACK_STREAM_SUSPENDED || command == PA_COMMAND_RECORD_STREAM_SUSPENDED);
 490     pa_assert(t);
 491     pa_assert(c);
 492     pa_assert(PA_REFCNT_VALUE(c) >= 1);
 493
 494     pa_context_ref(c);
 495
 496     if (c->version < 12) {
 497         pa_context_fail(c, PA_ERR_PROTOCOL);
 498         goto finish;
 499     }
 500
 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);
 505         goto finish;
 506     }
 507
 508     if (!(s = pa_dynarray_get(command == PA_COMMAND_PLAYBACK_STREAM_SUSPENDED ? c->playback_streams : c->record_streams, channel)))
 509         goto finish;
 510
 511     if (s->state != PA_STREAM_READY)
 512         goto finish;
 513
 514     s->suspended = suspended;
 515
 516     check_smoother_status(s, TRUE, FALSE, FALSE);
 517     request_auto_timing_update(s, TRUE);
 518
 519     if (s->suspended_callback)
 520         s->suspended_callback(s, s->suspended_userdata);
 521
 522 finish:
 523     pa_context_unref(c);
 524 }
 525
 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;
 528     pa_stream *s;
 529     uint32_t channel;
 530
 531     pa_assert(pd);
 532     pa_assert(command == PA_COMMAND_STARTED);
 533     pa_assert(t);
 534     pa_assert(c);
 535     pa_assert(PA_REFCNT_VALUE(c) >= 1);
 536
 537     pa_context_ref(c);
 538
 539     if (c->version < 13) {
 540         pa_context_fail(c, PA_ERR_PROTOCOL);
 541         goto finish;
 542     }
 543
 544     if (pa_tagstruct_getu32(t, &channel) < 0 ||
 545         !pa_tagstruct_eof(t)) {
 546         pa_context_fail(c, PA_ERR_PROTOCOL);
 547         goto finish;
 548     }
 549
 550     if (!(s = pa_dynarray_get(c->playback_streams, channel)))
 551         goto finish;
 552
 553     if (s->state != PA_STREAM_READY)
 554         goto finish;
 555
 556     check_smoother_status(s, TRUE, TRUE, FALSE);
 557     request_auto_timing_update(s, TRUE);
 558
 559     if (s->started_callback)
 560         s->started_callback(s, s->suspended_userdata);
 561
 562 finish:
 563     pa_context_unref(c);
 564 }
 565
 566 void pa_command_request(pa_pdispatch *pd, uint32_t command, PA_GCC_UNUSED uint32_t tag, pa_tagstruct *t, void *userdata) {
 567     pa_stream *s;
 568     pa_context *c = userdata;
 569     uint32_t bytes, channel;
 570
 571     pa_assert(pd);
 572     pa_assert(command == PA_COMMAND_REQUEST);
 573     pa_assert(t);
 574     pa_assert(c);
 575     pa_assert(PA_REFCNT_VALUE(c) >= 1);
 576
 577     pa_context_ref(c);
 578
 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);
 583         goto finish;
 584     }
 585
 586     if (!(s = pa_dynarray_get(c->playback_streams, channel)))
 587         goto finish;
 588
 589     if (s->state != PA_STREAM_READY)
 590         goto finish;
 591
 592     s->requested_bytes += bytes;
 593
 594     if (s->requested_bytes > 0 && s->write_callback)
 595         s->write_callback(s, s->requested_bytes, s->write_userdata);
 596
 597 finish:
 598     pa_context_unref(c);
 599 }
 600
 601 void pa_command_overflow_or_underflow(pa_pdispatch *pd, uint32_t command, PA_GCC_UNUSED uint32_t tag, pa_tagstruct *t, void *userdata) {
 602     pa_stream *s;
 603     pa_context *c = userdata;
 604     uint32_t channel;
 605
 606     pa_assert(pd);
 607     pa_assert(command == PA_COMMAND_OVERFLOW || command == PA_COMMAND_UNDERFLOW);
 608     pa_assert(t);
 609     pa_assert(c);
 610     pa_assert(PA_REFCNT_VALUE(c) >= 1);
 611
 612     pa_context_ref(c);
 613
 614     if (pa_tagstruct_getu32(t, &channel) < 0 ||
 615         !pa_tagstruct_eof(t)) {
 616         pa_context_fail(c, PA_ERR_PROTOCOL);
 617         goto finish;
 618     }
 619
 620     if (!(s = pa_dynarray_get(c->playback_streams, channel)))
 621         goto finish;
 622
 623     if (s->state != PA_STREAM_READY)
 624         goto finish;
 625
 626     if (s->buffer_attr.prebuf > 0)
 627         check_smoother_status(s, TRUE, FALSE, TRUE);
 628
 629     request_auto_timing_update(s, TRUE);
 630
 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);
 637     }
 638
 639  finish:
 640     pa_context_unref(c);
 641 }
 642
 643 static void invalidate_indexes(pa_stream *s, pa_bool_t r, pa_bool_t w) {
 644     pa_assert(s);
 645     pa_assert(PA_REFCNT_VALUE(s) >= 1);
 646
 647 /*     pa_log("invalidate r:%u w:%u tag:%u", r, w, s->context->ctag); */
 648
 649     if (s->state != PA_STREAM_READY)
 650         return;
 651
 652     if (w) {
 653         s->write_index_not_before = s->context->ctag;
 654
 655         if (s->timing_info_valid)
 656             s->timing_info.write_index_corrupt = TRUE;
 657
 658 /*         pa_log("write_index invalidated"); */
 659     }
 660
 661     if (r) {
 662         s->read_index_not_before = s->context->ctag;
 663
 664         if (s->timing_info_valid)
 665             s->timing_info.read_index_corrupt = TRUE;
 666
 667 /*         pa_log("read_index invalidated"); */
 668     }
 669
 670     request_auto_timing_update(s, TRUE);
 671 }
 672
 673 static void auto_timing_update_callback(PA_GCC_UNUSED pa_mainloop_api *m, PA_GCC_UNUSED pa_time_event *e, PA_GCC_UNUSED const struct timeval *tv, void *userdata) {
 674     pa_stream *s = userdata;
 675
 676     pa_assert(s);
 677     pa_assert(PA_REFCNT_VALUE(s) >= 1);
 678
 679     pa_stream_ref(s);
 680     request_auto_timing_update(s, FALSE);
 681     pa_stream_unref(s);
 682 }
 683
 684 static void create_stream_complete(pa_stream *s) {
 685     pa_assert(s);
 686     pa_assert(PA_REFCNT_VALUE(s) >= 1);
 687     pa_assert(s->state == PA_STREAM_CREATING);
 688
 689     pa_stream_set_state(s, PA_STREAM_READY);
 690
 691     if (s->requested_bytes > 0 && s->write_callback)
 692         s->write_callback(s, s->requested_bytes, s->write_userdata);
 693
 694     if (s->flags & PA_STREAM_AUTO_TIMING_UPDATE) {
 695         struct timeval tv;
 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);
 700
 701         request_auto_timing_update(s, TRUE);
 702     }
 703
 704     check_smoother_status(s, TRUE, FALSE, FALSE);
 705 }
 706
 707 static void automatic_buffer_attr(pa_stream *s, pa_buffer_attr *attr, const pa_sample_spec *ss) {
 708     pa_assert(s);
 709     pa_assert(attr);
 710     pa_assert(ss);
 711
 712     if (s->context->version >= 13)
 713         return;
 714
 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. */
 717
 718     /* We choose fairly conservative values here, to not confuse
 719      * old clients with extremely large playback buffers */
 720
 721     if (attr->maxlength == (uint32_t) -1)
 722         attr->maxlength = 4*1024*1024; /* 4MB is the maximum queue length PulseAudio <= 0.9.9 supported. */
 723
 724     if (attr->tlength == (uint32_t) -1)
 725         attr->tlength = pa_usec_to_bytes(250*PA_USEC_PER_MSEC, ss); /* 250ms of buffering */
 726
 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 */
 729
 730     if (attr->prebuf == (uint32_t) -1)
 731         attr->prebuf = attr->tlength; /* Start to play only when the playback is fully filled up once */
 732
 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 */
 735 }
 736
 737 void pa_create_stream_callback(pa_pdispatch *pd, uint32_t command, PA_GCC_UNUSED uint32_t tag, pa_tagstruct *t, void *userdata) {
 738     pa_stream *s = userdata;
 739
 740     pa_assert(pd);
 741     pa_assert(s);
 742     pa_assert(PA_REFCNT_VALUE(s) >= 1);
 743     pa_assert(s->state == PA_STREAM_CREATING);
 744
 745     pa_stream_ref(s);
 746
 747     if (command != PA_COMMAND_REPLY) {
 748         if (pa_context_handle_error(s->context, command, t, FALSE) < 0)
 749             goto finish;
 750
 751         pa_stream_set_state(s, PA_STREAM_FAILED);
 752         goto finish;
 753     }
 754
 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);
 760         goto finish;
 761     }
 762
 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);
 770                 goto finish;
 771             }
 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);
 776                 goto finish;
 777             }
 778         }
 779     }
 780
 781     if (s->context->version >= 12 && s->direction != PA_STREAM_UPLOAD) {
 782         pa_sample_spec ss;
 783         pa_channel_map cm;
 784         const char *dn = NULL;
 785         pa_bool_t suspended;
 786
 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);
 793             goto finish;
 794         }
 795
 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);
 804             goto finish;
 805         }
 806
 807         pa_xfree(s->device_name);
 808         s->device_name = pa_xstrdup(dn);
 809         s->suspended = suspended;
 810
 811         s->channel_map = cm;
 812         s->sample_spec = ss;
 813     }
 814
 815     if (s->context->version >= 13 && s->direction != PA_STREAM_UPLOAD) {
 816         pa_usec_t usec;
 817
 818         if (pa_tagstruct_get_usec(t, &usec) < 0) {
 819             pa_context_fail(s->context, PA_ERR_PROTOCOL);
 820             goto finish;
 821         }
 822
 823         if (s->direction == PA_STREAM_RECORD)
 824             s->timing_info.configured_source_usec = usec;
 825         else
 826             s->timing_info.configured_sink_usec = usec;
 827     }
 828
 829     if (!pa_tagstruct_eof(t)) {
 830         pa_context_fail(s->context, PA_ERR_PROTOCOL);
 831         goto finish;
 832     }
 833
 834     if (s->direction == PA_STREAM_RECORD) {
 835         pa_assert(!s->record_memblockq);
 836
 837         s->record_memblockq = pa_memblockq_new(
 838                 0,
 839                 s->buffer_attr.maxlength,
 840                 0,
 841                 pa_frame_size(&s->sample_spec),
 842                 1,
 843                 0,
 844                 0,
 845                 NULL);
 846     }
 847
 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);
 850
 851     create_stream_complete(s);
 852
 853 finish:
 854     pa_stream_unref(s);
 855 }
 856
 857 static int create_stream(
 858         pa_stream_direction_t direction,
 859         pa_stream *s,
 860         const char *dev,
 861         const pa_buffer_attr *attr,
 862         pa_stream_flags_t flags,
 863         const pa_cvolume *volume,
 864         pa_stream *sync_stream) {
 865
 866     pa_tagstruct *t;
 867     uint32_t tag;
 868
 869     pa_assert(s);
 870     pa_assert(PA_REFCNT_VALUE(s) >= 1);
 871     pa_assert(direction == PA_STREAM_PLAYBACK || direction == PA_STREAM_RECORD);
 872
 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|
 882                                               PA_STREAM_FIX_RATE|
 883                                               PA_STREAM_FIX_CHANNELS|
 884                                               PA_STREAM_DONT_MOVE|
 885                                               PA_STREAM_VARIABLE_RATE|
 886                                               PA_STREAM_PEAK_DETECT|
 887                                               PA_STREAM_START_MUTED|
 888                                               PA_STREAM_ADJUST_LATENCY)), PA_ERR_INVALID);
 889
 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 */
 896
 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);
 901
 902     pa_stream_ref(s);
 903
 904     s->direction = direction;
 905     s->flags = flags;
 906     s->corked = !!(flags & PA_STREAM_START_CORKED);
 907
 908     if (sync_stream)
 909         s->syncid = sync_stream->syncid;
 910
 911     if (attr)
 912         s->buffer_attr = *attr;
 913     automatic_buffer_attr(s, &s->buffer_attr, &s->sample_spec);
 914
 915     if (flags & PA_STREAM_INTERPOLATE_TIMING) {
 916         pa_usec_t x;
 917
 918         if (s->smoother)
 919             pa_smoother_free(s->smoother);
 920
 921         s->smoother = pa_smoother_new(SMOOTHER_ADJUST_TIME, SMOOTHER_HISTORY_TIME, !(flags & PA_STREAM_NOT_MONOTONIC), SMOOTHER_MIN_HISTORY);
 922
 923         x = pa_rtclock_usec();
 924         pa_smoother_set_time_offset(s->smoother, x);
 925         pa_smoother_pause(s->smoother, x);
 926     }
 927
 928     if (!dev)
 929         dev = s->direction == PA_STREAM_PLAYBACK ? s->context->conf->default_sink : s->context->conf->default_source;
 930
 931     t = pa_tagstruct_command(
 932             s->context,
 933             s->direction == PA_STREAM_PLAYBACK ? PA_COMMAND_CREATE_PLAYBACK_STREAM : PA_COMMAND_CREATE_RECORD_STREAM,
 934             &tag);
 935
 936     if (s->context->version < 13)
 937         pa_tagstruct_puts(t, pa_proplist_gets(s->proplist, PA_PROP_MEDIA_NAME));
 938
 939     pa_tagstruct_put(
 940             t,
 941             PA_TAG_SAMPLE_SPEC, &s->sample_spec,
 942             PA_TAG_CHANNEL_MAP, &s->channel_map,
 943             PA_TAG_U32, PA_INVALID_INDEX,
 944             PA_TAG_STRING, dev,
 945             PA_TAG_U32, s->buffer_attr.maxlength,
 946             PA_TAG_BOOLEAN, s->corked,
 947             PA_TAG_INVALID);
 948
 949     if (s->direction == PA_STREAM_PLAYBACK) {
 950         pa_cvolume cv;
 951
 952         pa_tagstruct_put(
 953                 t,
 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,
 958                 PA_TAG_INVALID);
 959
 960         if (!volume)
 961             volume = pa_cvolume_reset(&cv, s->sample_spec.channels);
 962
 963         pa_tagstruct_put_cvolume(t, volume);
 964     } else
 965         pa_tagstruct_putu32(t, s->buffer_attr.fragsize);
 966
 967     if (s->context->version >= 12) {
 968         pa_tagstruct_put(
 969                 t,
 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,
 977                 PA_TAG_INVALID);
 978     }
 979
 980     if (s->context->version >= 13) {
 981
 982         if (s->direction == PA_STREAM_PLAYBACK)
 983             pa_tagstruct_put_boolean(t, flags & PA_STREAM_START_MUTED);
 984         else
 985             pa_tagstruct_put_boolean(t, flags & PA_STREAM_PEAK_DETECT);
 986
 987         pa_tagstruct_put(
 988                 t,
 989                 PA_TAG_BOOLEAN, flags & PA_STREAM_ADJUST_LATENCY,
 990                 PA_TAG_PROPLIST, s->proplist,
 991                 PA_TAG_INVALID);
 992
 993         if (s->direction == PA_STREAM_RECORD)
 994             pa_tagstruct_putu32(t, s->direct_on_input);
 995     }
 996
 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);
 999
1000     pa_stream_set_state(s, PA_STREAM_CREATING);
1001
1002     pa_stream_unref(s);
1003     return 0;
1004 }
1005
1006 int pa_stream_connect_playback(
1007         pa_stream *s,
1008         const char *dev,
1009         const pa_buffer_attr *attr,
1010         pa_stream_flags_t flags,
1011         pa_cvolume *volume,
1012         pa_stream *sync_stream) {
1013
1014     pa_assert(s);
1015     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1016
1017     return create_stream(PA_STREAM_PLAYBACK, s, dev, attr, flags, volume, sync_stream);
1018 }
1019
1020 int pa_stream_connect_record(
1021         pa_stream *s,
1022         const char *dev,
1023         const pa_buffer_attr *attr,
1024         pa_stream_flags_t flags) {
1025
1026     pa_assert(s);
1027     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1028
1029     return create_stream(PA_STREAM_RECORD, s, dev, attr, flags, NULL, NULL);
1030 }
1031
1032 int pa_stream_write(
1033         pa_stream *s,
1034         const void *data,
1035         size_t length,
1036         void (*free_cb)(void *p),
1037         int64_t offset,
1038         pa_seek_mode_t seek) {
1039
1040     pa_memchunk chunk;
1041     pa_seek_mode_t t_seek;
1042     int64_t t_offset;
1043     size_t t_length;
1044     const void *t_data;
1045
1046     pa_assert(s);
1047     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1048     pa_assert(data);
1049
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);
1054
1055     if (length <= 0)
1056         return 0;
1057
1058     t_seek = seek;
1059     t_offset = offset;
1060     t_length = length;
1061     t_data = data;
1062
1063     while (t_length > 0) {
1064
1065         chunk.index = 0;
1066
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;
1070         } else {
1071             void *d;
1072
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);
1075
1076             d = pa_memblock_acquire(chunk.memblock);
1077             memcpy(d, t_data, chunk.length);
1078             pa_memblock_release(chunk.memblock);
1079         }
1080
1081         pa_pstream_send_memblock(s->context->pstream, s->channel, t_offset, t_seek, &chunk);
1082
1083         t_offset = 0;
1084         t_seek = PA_SEEK_RELATIVE;
1085
1086         t_data = (const uint8_t*) t_data + chunk.length;
1087         t_length -= chunk.length;
1088
1089         pa_memblock_unref(chunk.memblock);
1090     }
1091
1092     if (free_cb && pa_pstream_get_shm(s->context->pstream))
1093         free_cb((void*) data);
1094
1095     if (length < s->requested_bytes)
1096         s->requested_bytes -= length;
1097     else
1098         s->requested_bytes = 0;
1099
1100     /* FIXME!!! ^^^ will break when offset is != 0 and mode is not RELATIVE*/
1101
1102     if (s->direction == PA_STREAM_PLAYBACK) {
1103
1104         /* Update latency request correction */
1105         if (s->write_index_corrections[s->current_write_index_correction].valid) {
1106
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;
1114             } else
1115                 s->write_index_corrections[s->current_write_index_correction].corrupt = TRUE;
1116         }
1117
1118         /* Update the write index in the already available latency data */
1119         if (s->timing_info_valid) {
1120
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;
1127             } else
1128                 s->timing_info.write_index_corrupt = TRUE;
1129         }
1130
1131         if (!s->timing_info_valid || s->timing_info.write_index_corrupt)
1132             request_auto_timing_update(s, TRUE);
1133     }
1134
1135     return 0;
1136 }
1137
1138 int pa_stream_peek(pa_stream *s, const void **data, size_t *length) {
1139     pa_assert(s);
1140     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1141     pa_assert(data);
1142     pa_assert(length);
1143
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);
1146
1147     if (!s->peek_memchunk.memblock) {
1148
1149         if (pa_memblockq_peek(s->record_memblockq, &s->peek_memchunk) < 0) {
1150             *data = NULL;
1151             *length = 0;
1152             return 0;
1153         }
1154
1155         s->peek_data = pa_memblock_acquire(s->peek_memchunk.memblock);
1156     }
1157
1158     pa_assert(s->peek_data);
1159     *data = (uint8_t*) s->peek_data + s->peek_memchunk.index;
1160     *length = s->peek_memchunk.length;
1161     return 0;
1162 }
1163
1164 int pa_stream_drop(pa_stream *s) {
1165     pa_assert(s);
1166     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1167
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);
1171
1172     pa_memblockq_drop(s->record_memblockq, s->peek_memchunk.length);
1173
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;
1177
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);
1182
1183     return 0;
1184 }
1185
1186 size_t pa_stream_writable_size(pa_stream *s) {
1187     pa_assert(s);
1188     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1189
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);
1192
1193     return s->requested_bytes;
1194 }
1195
1196 size_t pa_stream_readable_size(pa_stream *s) {
1197     pa_assert(s);
1198     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1199
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);
1202
1203     return pa_memblockq_get_length(s->record_memblockq);
1204 }
1205
1206 pa_operation * pa_stream_drain(pa_stream *s, pa_stream_success_cb_t cb, void *userdata) {
1207     pa_operation *o;
1208     pa_tagstruct *t;
1209     uint32_t tag;
1210
1211     pa_assert(s);
1212     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1213
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);
1216
1217     o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
1218
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);
1223
1224     return o;
1225 }
1226
1227 static pa_usec_t calc_time(pa_stream *s, pa_bool_t ignore_transport) {
1228     pa_usec_t usec;
1229
1230     pa_assert(s);
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);
1237
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);
1242
1243         if (!s->corked && !s->suspended) {
1244
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
1248                  * a little ahead */
1249                 usec += s->timing_info.transport_usec;
1250
1251             /* However, the output device usually maintains a buffer
1252                too, hence the real sample currently played is a little
1253                back  */
1254             if (s->timing_info.sink_usec >= usec)
1255                 usec = 0;
1256             else
1257                 usec -= s->timing_info.sink_usec;
1258         }
1259
1260     } else if (s->direction == PA_STREAM_RECORD) {
1261         /* The last byte written into the server side queue had
1262          * this time value associated */
1263         usec = pa_bytes_to_usec(s->timing_info.write_index < 0 ? 0 : (uint64_t) s->timing_info.write_index, &s->sample_spec);
1264
1265         if (!s->corked && !s->suspended) {
1266
1267             if (!ignore_transport)
1268                 /* Add transport latency */
1269                 usec += s->timing_info.transport_usec;
1270
1271             /* Add latency of data in device buffer */
1272             usec += s->timing_info.source_usec;
1273
1274             /* If this is a monitor source, we need to correct the
1275              * time by the playback device buffer */
1276             if (s->timing_info.sink_usec >= usec)
1277                 usec = 0;
1278             else
1279                 usec -= s->timing_info.sink_usec;
1280         }
1281     }
1282
1283     return usec;
1284 }
1285
1286 static void stream_get_timing_info_callback(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
1287     pa_operation *o = userdata;
1288     struct timeval local, remote, now;
1289     pa_timing_info *i;
1290     pa_bool_t playing = FALSE;
1291     uint64_t underrun_for = 0, playing_for = 0;
1292
1293     pa_assert(pd);
1294     pa_assert(o);
1295     pa_assert(PA_REFCNT_VALUE(o) >= 1);
1296
1297     if (!o->context || !o->stream)
1298         goto finish;
1299
1300     i = &o->stream->timing_info;
1301
1302     o->stream->timing_info_valid = FALSE;
1303     i->write_index_corrupt = TRUE;
1304     i->read_index_corrupt = TRUE;
1305
1306     if (command != PA_COMMAND_REPLY) {
1307         if (pa_context_handle_error(o->context, command, t, FALSE) < 0)
1308             goto finish;
1309
1310     } else {
1311
1312         if (pa_tagstruct_get_usec(t, &i->sink_usec) < 0 ||
1313             pa_tagstruct_get_usec(t, &i->source_usec) < 0 ||
1314             pa_tagstruct_get_boolean(t, &playing) < 0 ||
1315             pa_tagstruct_get_timeval(t, &local) < 0 ||
1316             pa_tagstruct_get_timeval(t, &remote) < 0 ||
1317             pa_tagstruct_gets64(t, &i->write_index) < 0 ||
1318             pa_tagstruct_gets64(t, &i->read_index) < 0) {
1319
1320             pa_context_fail(o->context, PA_ERR_PROTOCOL);
1321             goto finish;
1322         }
1323
1324         if (o->context->version >= 13 &&
1325             o->stream->direction == PA_STREAM_PLAYBACK)
1326             if (pa_tagstruct_getu64(t, &underrun_for) < 0 ||
1327                 pa_tagstruct_getu64(t, &playing_for) < 0) {
1328
1329                 pa_context_fail(o->context, PA_ERR_PROTOCOL);
1330                 goto finish;
1331             }
1332
1333
1334         if (!pa_tagstruct_eof(t)) {
1335             pa_context_fail(o->context, PA_ERR_PROTOCOL);
1336             goto finish;
1337         }
1338         o->stream->timing_info_valid = TRUE;
1339         i->write_index_corrupt = FALSE;
1340         i->read_index_corrupt = FALSE;
1341
1342         i->playing = (int) playing;
1343         i->since_underrun = playing ? playing_for : underrun_for;
1344
1345         pa_gettimeofday(&now);
1346
1347         /* Calculcate timestamps */
1348         if (pa_timeval_cmp(&local, &remote) <= 0 && pa_timeval_cmp(&remote, &now) <= 0) {
1349             /* local and remote seem to have synchronized clocks */
1350
1351             if (o->stream->direction == PA_STREAM_PLAYBACK)
1352                 i->transport_usec = pa_timeval_diff(&remote, &local);
1353             else
1354                 i->transport_usec = pa_timeval_diff(&now, &remote);
1355
1356             i->synchronized_clocks = TRUE;
1357             i->timestamp = remote;
1358         } else {
1359             /* clocks are not synchronized, let's estimate latency then */
1360             i->transport_usec = pa_timeval_diff(&now, &local)/2;
1361             i->synchronized_clocks = FALSE;
1362             i->timestamp = local;
1363             pa_timeval_add(&i->timestamp, i->transport_usec);
1364         }
1365
1366         /* Invalidate read and write indexes if necessary */
1367         if (tag < o->stream->read_index_not_before)
1368             i->read_index_corrupt = TRUE;
1369
1370         if (tag < o->stream->write_index_not_before)
1371             i->write_index_corrupt = TRUE;
1372
1373         if (o->stream->direction == PA_STREAM_PLAYBACK) {
1374             /* Write index correction */
1375
1376             int n, j;
1377             uint32_t ctag = tag;
1378
1379             /* Go through the saved correction values and add up the
1380              * total correction.*/
1381             for (n = 0, j = o->stream->current_write_index_correction+1;
1382                  n < PA_MAX_WRITE_INDEX_CORRECTIONS;
1383                  n++, j = (j + 1) % PA_MAX_WRITE_INDEX_CORRECTIONS) {
1384
1385                 /* Step over invalid data or out-of-date data */
1386                 if (!o->stream->write_index_corrections[j].valid ||
1387                     o->stream->write_index_corrections[j].tag < ctag)
1388                     continue;
1389
1390                 /* Make sure that everything is in order */
1391                 ctag = o->stream->write_index_corrections[j].tag+1;
1392
1393                 /* Now fix the write index */
1394                 if (o->stream->write_index_corrections[j].corrupt) {
1395                     /* A corrupting seek was made */
1396                     i->write_index_corrupt = TRUE;
1397                 } else if (o->stream->write_index_corrections[j].absolute) {
1398                     /* An absolute seek was made */
1399                     i->write_index = o->stream->write_index_corrections[j].value;
1400                     i->write_index_corrupt = FALSE;
1401                 } else if (!i->write_index_corrupt) {
1402                     /* A relative seek was made */
1403                     i->write_index += o->stream->write_index_corrections[j].value;
1404                 }
1405             }
1406
1407             /* Clear old correction entries */
1408             for (n = 0; n < PA_MAX_WRITE_INDEX_CORRECTIONS; n++) {
1409                 if (!o->stream->write_index_corrections[n].valid)
1410                     continue;
1411
1412                 if (o->stream->write_index_corrections[n].tag <= tag)
1413                     o->stream->write_index_corrections[n].valid = FALSE;
1414             }
1415         }
1416
1417         if (o->stream->direction == PA_STREAM_RECORD) {
1418             /* Read index correction */
1419
1420             if (!i->read_index_corrupt)
1421                 i->read_index -= pa_memblockq_get_length(o->stream->record_memblockq);
1422         }
1423
1424         /* Update smoother */
1425         if (o->stream->smoother) {
1426             pa_usec_t u, x;
1427
1428             u = x = pa_rtclock_usec() - i->transport_usec;
1429
1430             if (o->stream->direction == PA_STREAM_PLAYBACK && o->context->version >= 13) {
1431                 pa_usec_t su;
1432
1433                 /* If we weren't playing then it will take some time
1434                  * until the audio will actually come out through the
1435                  * speakers. Since we follow that timing here, we need
1436                  * to try to fix this up */
1437
1438                 su = pa_bytes_to_usec(i->since_underrun, &o->stream->sample_spec);
1439
1440                 if (su < i->sink_usec)
1441                     x += i->sink_usec - su;
1442             }
1443
1444             if (!i->playing)
1445                 pa_smoother_pause(o->stream->smoother, x);
1446
1447             /* Update the smoother */
1448             if ((o->stream->direction == PA_STREAM_PLAYBACK && !i->read_index_corrupt) ||
1449                 (o->stream->direction == PA_STREAM_RECORD && !i->write_index_corrupt))
1450                 pa_smoother_put(o->stream->smoother, u, calc_time(o->stream, TRUE));
1451
1452             if (i->playing)
1453                 pa_smoother_resume(o->stream->smoother, x);
1454         }
1455     }
1456
1457     o->stream->auto_timing_update_requested = FALSE;
1458
1459     if (o->stream->latency_update_callback)
1460         o->stream->latency_update_callback(o->stream, o->stream->latency_update_userdata);
1461
1462     if (o->callback && o->stream && o->stream->state == PA_STREAM_READY) {
1463         pa_stream_success_cb_t cb = (pa_stream_success_cb_t) o->callback;
1464         cb(o->stream, o->stream->timing_info_valid, o->userdata);
1465     }
1466
1467 finish:
1468
1469     pa_operation_done(o);
1470     pa_operation_unref(o);
1471 }
1472
1473 pa_operation* pa_stream_update_timing_info(pa_stream *s, pa_stream_success_cb_t cb, void *userdata) {
1474     uint32_t tag;
1475     pa_operation *o;
1476     pa_tagstruct *t;
1477     struct timeval now;
1478     int cidx = 0;
1479
1480     pa_assert(s);
1481     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1482
1483     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1484     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1485
1486     if (s->direction == PA_STREAM_PLAYBACK) {
1487         /* Find a place to store the write_index correction data for this entry */
1488         cidx = (s->current_write_index_correction + 1) % PA_MAX_WRITE_INDEX_CORRECTIONS;
1489
1490         /* Check if we could allocate a correction slot. If not, there are too many outstanding queries */
1491         PA_CHECK_VALIDITY_RETURN_NULL(s->context, !s->write_index_corrections[cidx].valid, PA_ERR_INTERNAL);
1492     }
1493     o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
1494
1495     t = pa_tagstruct_command(
1496             s->context,
1497             s->direction == PA_STREAM_PLAYBACK ? PA_COMMAND_GET_PLAYBACK_LATENCY : PA_COMMAND_GET_RECORD_LATENCY,
1498             &tag);
1499     pa_tagstruct_putu32(t, s->channel);
1500     pa_tagstruct_put_timeval(t, pa_gettimeofday(&now));
1501
1502     pa_pstream_send_tagstruct(s->context->pstream, t);
1503     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);
1504
1505     if (s->direction == PA_STREAM_PLAYBACK) {
1506         /* Fill in initial correction data */
1507
1508         s->current_write_index_correction = cidx;
1509
1510         s->write_index_corrections[cidx].valid = TRUE;
1511         s->write_index_corrections[cidx].absolute = FALSE;
1512         s->write_index_corrections[cidx].corrupt = FALSE;
1513         s->write_index_corrections[cidx].tag = tag;
1514         s->write_index_corrections[cidx].value = 0;
1515     }
1516
1517     return o;
1518 }
1519
1520 void pa_stream_disconnect_callback(pa_pdispatch *pd, uint32_t command, PA_GCC_UNUSED uint32_t tag, pa_tagstruct *t, void *userdata) {
1521     pa_stream *s = userdata;
1522
1523     pa_assert(pd);
1524     pa_assert(s);
1525     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1526
1527     pa_stream_ref(s);
1528
1529     if (command != PA_COMMAND_REPLY) {
1530         if (pa_context_handle_error(s->context, command, t, FALSE) < 0)
1531             goto finish;
1532
1533         pa_stream_set_state(s, PA_STREAM_FAILED);
1534         goto finish;
1535     } else if (!pa_tagstruct_eof(t)) {
1536         pa_context_fail(s->context, PA_ERR_PROTOCOL);
1537         goto finish;
1538     }
1539
1540     pa_stream_set_state(s, PA_STREAM_TERMINATED);
1541
1542 finish:
1543     pa_stream_unref(s);
1544 }
1545
1546 int pa_stream_disconnect(pa_stream *s) {
1547     pa_tagstruct *t;
1548     uint32_t tag;
1549
1550     pa_assert(s);
1551     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1552
1553     PA_CHECK_VALIDITY(s->context, s->channel_valid, PA_ERR_BADSTATE);
1554     PA_CHECK_VALIDITY(s->context, s->context->state == PA_CONTEXT_READY, PA_ERR_BADSTATE);
1555
1556     pa_stream_ref(s);
1557
1558     t = pa_tagstruct_command(
1559             s->context,
1560             s->direction == PA_STREAM_PLAYBACK ? PA_COMMAND_DELETE_PLAYBACK_STREAM :
1561             (s->direction == PA_STREAM_RECORD ? PA_COMMAND_DELETE_RECORD_STREAM : PA_COMMAND_DELETE_UPLOAD_STREAM),
1562             &tag);
1563     pa_tagstruct_putu32(t, s->channel);
1564     pa_pstream_send_tagstruct(s->context->pstream, t);
1565     pa_pdispatch_register_reply(s->context->pdispatch, tag, DEFAULT_TIMEOUT, pa_stream_disconnect_callback, s, NULL);
1566
1567     pa_stream_unref(s);
1568     return 0;
1569 }
1570
1571 void pa_stream_set_read_callback(pa_stream *s, pa_stream_request_cb_t cb, void *userdata) {
1572     pa_assert(s);
1573     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1574
1575     if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1576         return;
1577
1578     s->read_callback = cb;
1579     s->read_userdata = userdata;
1580 }
1581
1582 void pa_stream_set_write_callback(pa_stream *s, pa_stream_request_cb_t cb, void *userdata) {
1583     pa_assert(s);
1584     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1585
1586     if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1587         return;
1588
1589     s->write_callback = cb;
1590     s->write_userdata = userdata;
1591 }
1592
1593 void pa_stream_set_state_callback(pa_stream *s, pa_stream_notify_cb_t cb, void *userdata) {
1594     pa_assert(s);
1595     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1596
1597     if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1598         return;
1599
1600     s->state_callback = cb;
1601     s->state_userdata = userdata;
1602 }
1603
1604 void pa_stream_set_overflow_callback(pa_stream *s, pa_stream_notify_cb_t cb, void *userdata) {
1605     pa_assert(s);
1606     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1607
1608     if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1609         return;
1610
1611     s->overflow_callback = cb;
1612     s->overflow_userdata = userdata;
1613 }
1614
1615 void pa_stream_set_underflow_callback(pa_stream *s, pa_stream_notify_cb_t cb, void *userdata) {
1616     pa_assert(s);
1617     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1618
1619     if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1620         return;
1621
1622     s->underflow_callback = cb;
1623     s->underflow_userdata = userdata;
1624 }
1625
1626 void pa_stream_set_latency_update_callback(pa_stream *s, pa_stream_notify_cb_t cb, void *userdata) {
1627     pa_assert(s);
1628     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1629
1630     if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1631         return;
1632
1633     s->latency_update_callback = cb;
1634     s->latency_update_userdata = userdata;
1635 }
1636
1637 void pa_stream_set_moved_callback(pa_stream *s, pa_stream_notify_cb_t cb, void *userdata) {
1638     pa_assert(s);
1639     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1640
1641     if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1642         return;
1643
1644     s->moved_callback = cb;
1645     s->moved_userdata = userdata;
1646 }
1647
1648 void pa_stream_set_suspended_callback(pa_stream *s, pa_stream_notify_cb_t cb, void *userdata) {
1649     pa_assert(s);
1650     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1651
1652     if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1653         return;
1654
1655     s->suspended_callback = cb;
1656     s->suspended_userdata = userdata;
1657 }
1658
1659 void pa_stream_set_started_callback(pa_stream *s, pa_stream_notify_cb_t cb, void *userdata) {
1660     pa_assert(s);
1661     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1662
1663     if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1664         return;
1665
1666     s->started_callback = cb;
1667     s->started_userdata = userdata;
1668 }
1669
1670 void pa_stream_simple_ack_callback(pa_pdispatch *pd, uint32_t command, PA_GCC_UNUSED uint32_t tag, pa_tagstruct *t, void *userdata) {
1671     pa_operation *o = userdata;
1672     int success = 1;
1673
1674     pa_assert(pd);
1675     pa_assert(o);
1676     pa_assert(PA_REFCNT_VALUE(o) >= 1);
1677
1678     if (!o->context)
1679         goto finish;
1680
1681     if (command != PA_COMMAND_REPLY) {
1682         if (pa_context_handle_error(o->context, command, t, FALSE) < 0)
1683             goto finish;
1684
1685         success = 0;
1686     } else if (!pa_tagstruct_eof(t)) {
1687         pa_context_fail(o->context, PA_ERR_PROTOCOL);
1688         goto finish;
1689     }
1690
1691     if (o->callback) {
1692         pa_stream_success_cb_t cb = (pa_stream_success_cb_t) o->callback;
1693         cb(o->stream, success, o->userdata);
1694     }
1695
1696 finish:
1697     pa_operation_done(o);
1698     pa_operation_unref(o);
1699 }
1700
1701 pa_operation* pa_stream_cork(pa_stream *s, int b, pa_stream_success_cb_t cb, void *userdata) {
1702     pa_operation *o;
1703     pa_tagstruct *t;
1704     uint32_t tag;
1705
1706     pa_assert(s);
1707     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1708
1709     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1710     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1711
1712     s->corked = b;
1713
1714     o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
1715
1716     t = pa_tagstruct_command(
1717             s->context,
1718             s->direction == PA_STREAM_PLAYBACK ? PA_COMMAND_CORK_PLAYBACK_STREAM : PA_COMMAND_CORK_RECORD_STREAM,
1719             &tag);
1720     pa_tagstruct_putu32(t, s->channel);
1721     pa_tagstruct_put_boolean(t, !!b);
1722     pa_pstream_send_tagstruct(s->context->pstream, t);
1723     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);
1724
1725     check_smoother_status(s, FALSE, FALSE, FALSE);
1726
1727     /* This might cause the indexes to hang/start again, hence
1728      * let's request a timing update */
1729     request_auto_timing_update(s, TRUE);
1730
1731     return o;
1732 }
1733
1734 static pa_operation* stream_send_simple_command(pa_stream *s, uint32_t command, pa_stream_success_cb_t cb, void *userdata) {
1735     pa_tagstruct *t;
1736     pa_operation *o;
1737     uint32_t tag;
1738
1739     pa_assert(s);
1740     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1741
1742     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1743
1744     o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
1745
1746     t = pa_tagstruct_command(s->context, command, &tag);
1747     pa_tagstruct_putu32(t, s->channel);
1748     pa_pstream_send_tagstruct(s->context->pstream, t);
1749     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);
1750
1751     return o;
1752 }
1753
1754 pa_operation* pa_stream_flush(pa_stream *s, pa_stream_success_cb_t cb, void *userdata) {
1755     pa_operation *o;
1756
1757     pa_assert(s);
1758     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1759
1760     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1761     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1762
1763     if (!(o = stream_send_simple_command(s, s->direction == PA_STREAM_PLAYBACK ? PA_COMMAND_FLUSH_PLAYBACK_STREAM : PA_COMMAND_FLUSH_RECORD_STREAM, cb, userdata)))
1764         return NULL;
1765
1766     if (s->direction == PA_STREAM_PLAYBACK) {
1767
1768         if (s->write_index_corrections[s->current_write_index_correction].valid)
1769             s->write_index_corrections[s->current_write_index_correction].corrupt = TRUE;
1770
1771         if (s->buffer_attr.prebuf > 0)
1772             check_smoother_status(s, FALSE, FALSE, TRUE);
1773
1774         /* This will change the write index, but leave the
1775          * read index untouched. */
1776         invalidate_indexes(s, FALSE, TRUE);
1777
1778     } else
1779         /* For record streams this has no influence on the write
1780          * index, but the read index might jump. */
1781         invalidate_indexes(s, TRUE, FALSE);
1782
1783     return o;
1784 }
1785
1786 pa_operation* pa_stream_prebuf(pa_stream *s, pa_stream_success_cb_t cb, void *userdata) {
1787     pa_operation *o;
1788
1789     pa_assert(s);
1790     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1791
1792     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1793     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction == PA_STREAM_PLAYBACK, PA_ERR_BADSTATE);
1794     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->buffer_attr.prebuf > 0, PA_ERR_BADSTATE);
1795
1796     if (!(o = stream_send_simple_command(s, PA_COMMAND_PREBUF_PLAYBACK_STREAM, cb, userdata)))
1797         return NULL;
1798
1799     /* This might cause the read index to hang again, hence
1800      * let's request a timing update */
1801     request_auto_timing_update(s, TRUE);
1802
1803     return o;
1804 }
1805
1806 pa_operation* pa_stream_trigger(pa_stream *s, pa_stream_success_cb_t cb, void *userdata) {
1807     pa_operation *o;
1808
1809     pa_assert(s);
1810     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1811
1812     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1813     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction == PA_STREAM_PLAYBACK, PA_ERR_BADSTATE);
1814     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->buffer_attr.prebuf > 0, PA_ERR_BADSTATE);
1815
1816     if (!(o = stream_send_simple_command(s, PA_COMMAND_TRIGGER_PLAYBACK_STREAM, cb, userdata)))
1817         return NULL;
1818
1819     /* This might cause the read index to start moving again, hence
1820      * let's request a timing update */
1821     request_auto_timing_update(s, TRUE);
1822
1823     return o;
1824 }
1825
1826 pa_operation* pa_stream_set_name(pa_stream *s, const char *name, pa_stream_success_cb_t cb, void *userdata) {
1827     pa_operation *o;
1828
1829     pa_assert(s);
1830     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1831     pa_assert(name);
1832
1833     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1834     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1835
1836     if (s->context->version >= 13) {
1837         pa_proplist *p = pa_proplist_new();
1838
1839         pa_proplist_sets(p, PA_PROP_APPLICATION_NAME, name);
1840         o = pa_stream_proplist_update(s, PA_UPDATE_REPLACE, p, cb, userdata);
1841         pa_proplist_free(p);
1842     } else {
1843         pa_tagstruct *t;
1844         uint32_t tag;
1845
1846         o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
1847         t = pa_tagstruct_command(
1848                 s->context,
1849                 s->direction == PA_STREAM_RECORD ? PA_COMMAND_SET_RECORD_STREAM_NAME : PA_COMMAND_SET_PLAYBACK_STREAM_NAME,
1850                 &tag);
1851         pa_tagstruct_putu32(t, s->channel);
1852         pa_tagstruct_puts(t, name);
1853         pa_pstream_send_tagstruct(s->context->pstream, t);
1854         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);
1855     }
1856
1857     return o;
1858 }
1859
1860 int pa_stream_get_time(pa_stream *s, pa_usec_t *r_usec) {
1861     pa_usec_t usec;
1862
1863     pa_assert(s);
1864     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1865
1866     PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1867     PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1868     PA_CHECK_VALIDITY(s->context, s->timing_info_valid, PA_ERR_NODATA);
1869     PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_PLAYBACK || !s->timing_info.read_index_corrupt, PA_ERR_NODATA);
1870     PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_RECORD || !s->timing_info.write_index_corrupt, PA_ERR_NODATA);
1871
1872     if (s->smoother)
1873         usec = pa_smoother_get(s->smoother, pa_rtclock_usec());
1874     else
1875         usec = calc_time(s, FALSE);
1876
1877     /* Make sure the time runs monotonically */
1878     if (!(s->flags & PA_STREAM_NOT_MONOTONOUS)) {
1879         if (usec < s->previous_time)
1880             usec = s->previous_time;
1881         else
1882             s->previous_time = usec;
1883     }
1884
1885     if (r_usec)
1886         *r_usec = usec;
1887
1888     return 0;
1889 }
1890
1891 static pa_usec_t time_counter_diff(pa_stream *s, pa_usec_t a, pa_usec_t b, int *negative) {
1892     pa_assert(s);
1893     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1894
1895     if (negative)
1896         *negative = 0;
1897
1898     if (a >= b)
1899         return a-b;
1900     else {
1901         if (negative && s->direction == PA_STREAM_RECORD) {
1902             *negative = 1;
1903             return b-a;
1904         } else
1905             return 0;
1906     }
1907 }
1908
1909 int pa_stream_get_latency(pa_stream *s, pa_usec_t *r_usec, int *negative) {
1910     pa_usec_t t, c;
1911     int r;
1912     int64_t cindex;
1913
1914     pa_assert(s);
1915     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1916     pa_assert(r_usec);
1917
1918     PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1919     PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1920     PA_CHECK_VALIDITY(s->context, s->timing_info_valid, PA_ERR_NODATA);
1921     PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_PLAYBACK || !s->timing_info.write_index_corrupt, PA_ERR_NODATA);
1922     PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_RECORD || !s->timing_info.read_index_corrupt, PA_ERR_NODATA);
1923
1924     if ((r = pa_stream_get_time(s, &t)) < 0)
1925         return r;
1926
1927     if (s->direction == PA_STREAM_PLAYBACK)
1928         cindex = s->timing_info.write_index;
1929     else
1930         cindex = s->timing_info.read_index;
1931
1932     if (cindex < 0)
1933         cindex = 0;
1934
1935     c = pa_bytes_to_usec(cindex, &s->sample_spec);
1936
1937     if (s->direction == PA_STREAM_PLAYBACK)
1938         *r_usec = time_counter_diff(s, c, t, negative);
1939     else
1940         *r_usec = time_counter_diff(s, t, c, negative);
1941
1942     return 0;
1943 }
1944
1945 const pa_timing_info* pa_stream_get_timing_info(pa_stream *s) {
1946     pa_assert(s);
1947     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1948
1949     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1950     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1951     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->timing_info_valid, PA_ERR_BADSTATE);
1952
1953     return &s->timing_info;
1954 }
1955
1956 const pa_sample_spec* pa_stream_get_sample_spec(pa_stream *s) {
1957     pa_assert(s);
1958     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1959
1960     return &s->sample_spec;
1961 }
1962
1963 const pa_channel_map* pa_stream_get_channel_map(pa_stream *s) {
1964     pa_assert(s);
1965     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1966
1967     return &s->channel_map;
1968 }
1969
1970 const pa_buffer_attr* pa_stream_get_buffer_attr(pa_stream *s) {
1971     pa_assert(s);
1972     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1973
1974     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1975     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1976     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->context->version >= 9, PA_ERR_NOTSUPPORTED);
1977
1978     return &s->buffer_attr;
1979 }
1980
1981 static void stream_set_buffer_attr_callback(pa_pdispatch *pd, uint32_t command, PA_GCC_UNUSED uint32_t tag, pa_tagstruct *t, void *userdata) {
1982     pa_operation *o = userdata;
1983     int success = 1;
1984
1985     pa_assert(pd);
1986     pa_assert(o);
1987     pa_assert(PA_REFCNT_VALUE(o) >= 1);
1988
1989     if (!o->context)
1990         goto finish;
1991
1992     if (command != PA_COMMAND_REPLY) {
1993         if (pa_context_handle_error(o->context, command, t, FALSE) < 0)
1994             goto finish;
1995
1996         success = 0;
1997     } else {
1998
1999         if (o->stream->direction == PA_STREAM_PLAYBACK) {
2000             if (pa_tagstruct_getu32(t, &o->stream->buffer_attr.maxlength) < 0 ||
2001                 pa_tagstruct_getu32(t, &o->stream->buffer_attr.tlength) < 0 ||
2002                 pa_tagstruct_getu32(t, &o->stream->buffer_attr.prebuf) < 0 ||
2003                 pa_tagstruct_getu32(t, &o->stream->buffer_attr.minreq) < 0) {
2004                 pa_context_fail(o->context, PA_ERR_PROTOCOL);
2005                 goto finish;
2006             }
2007         } else if (o->stream->direction == PA_STREAM_RECORD) {
2008             if (pa_tagstruct_getu32(t, &o->stream->buffer_attr.maxlength) < 0 ||
2009                 pa_tagstruct_getu32(t, &o->stream->buffer_attr.fragsize) < 0) {
2010                 pa_context_fail(o->context, PA_ERR_PROTOCOL);
2011                 goto finish;
2012             }
2013         }
2014
2015         if (!pa_tagstruct_eof(t)) {
2016             pa_context_fail(o->context, PA_ERR_PROTOCOL);
2017             goto finish;
2018         }
2019     }
2020
2021     if (o->callback) {
2022         pa_stream_success_cb_t cb = (pa_stream_success_cb_t) o->callback;
2023         cb(o->stream, success, o->userdata);
2024     }
2025
2026 finish:
2027     pa_operation_done(o);
2028     pa_operation_unref(o);
2029 }
2030
2031
2032 pa_operation* pa_stream_set_buffer_attr(pa_stream *s, const pa_buffer_attr *attr, pa_stream_success_cb_t cb, void *userdata) {
2033     pa_operation *o;
2034     pa_tagstruct *t;
2035     uint32_t tag;
2036
2037     pa_assert(s);
2038     pa_assert(PA_REFCNT_VALUE(s) >= 1);
2039     pa_assert(attr);
2040
2041     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
2042     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
2043     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->context->version >= 12, PA_ERR_NOTSUPPORTED);
2044
2045     o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
2046
2047     t = pa_tagstruct_command(
2048             s->context,
2049             s->direction == PA_STREAM_RECORD ? PA_COMMAND_SET_RECORD_STREAM_BUFFER_ATTR : PA_COMMAND_SET_PLAYBACK_STREAM_BUFFER_ATTR,
2050             &tag);
2051     pa_tagstruct_putu32(t, s->channel);
2052
2053     pa_tagstruct_putu32(t, attr->maxlength);
2054
2055     if (s->direction == PA_STREAM_PLAYBACK)
2056         pa_tagstruct_put(
2057                 t,
2058                 PA_TAG_U32, attr->tlength,
2059                 PA_TAG_U32, attr->prebuf,
2060                 PA_TAG_U32, attr->minreq,
2061                 PA_TAG_INVALID);
2062     else
2063         pa_tagstruct_putu32(t, attr->fragsize);
2064
2065     if (s->context->version >= 13)
2066         pa_tagstruct_put_boolean(t, !!(s->flags & PA_STREAM_ADJUST_LATENCY));
2067
2068     pa_pstream_send_tagstruct(s->context->pstream, t);
2069     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);
2070
2071     /* This might cause changes in the read/write indexex, hence let's
2072      * request a timing update */
2073     request_auto_timing_update(s, TRUE);
2074
2075     return o;
2076 }
2077
2078 uint32_t pa_stream_get_device_index(pa_stream *s) {
2079     pa_assert(s);
2080     pa_assert(PA_REFCNT_VALUE(s) >= 1);
2081
2082     PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE, PA_INVALID_INDEX);
2083     PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE, PA_INVALID_INDEX);
2084     PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->context->version >= 12, PA_ERR_NOTSUPPORTED, PA_INVALID_INDEX);
2085     PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->device_index != PA_INVALID_INDEX, PA_ERR_BADSTATE, PA_INVALID_INDEX);
2086
2087     return s->device_index;
2088 }
2089
2090 const char *pa_stream_get_device_name(pa_stream *s) {
2091     pa_assert(s);
2092     pa_assert(PA_REFCNT_VALUE(s) >= 1);
2093
2094     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
2095     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
2096     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->context->version >= 12, PA_ERR_NOTSUPPORTED);
2097     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->device_name, PA_ERR_BADSTATE);
2098
2099     return s->device_name;
2100 }
2101
2102 int pa_stream_is_suspended(pa_stream *s) {
2103     pa_assert(s);
2104     pa_assert(PA_REFCNT_VALUE(s) >= 1);
2105
2106     PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
2107     PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
2108     PA_CHECK_VALIDITY(s->context, s->context->version >= 12, PA_ERR_NOTSUPPORTED);
2109
2110     return s->suspended;
2111 }
2112
2113 int pa_stream_is_corked(pa_stream *s) {
2114     pa_assert(s);
2115     pa_assert(PA_REFCNT_VALUE(s) >= 1);
2116
2117     PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
2118     PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
2119
2120     return s->corked;
2121 }
2122
2123 static void stream_update_sample_rate_callback(pa_pdispatch *pd, uint32_t command, PA_GCC_UNUSED uint32_t tag, pa_tagstruct *t, void *userdata) {
2124     pa_operation *o = userdata;
2125     int success = 1;
2126
2127     pa_assert(pd);
2128     pa_assert(o);
2129     pa_assert(PA_REFCNT_VALUE(o) >= 1);
2130
2131     if (!o->context)
2132         goto finish;
2133
2134     if (command != PA_COMMAND_REPLY) {
2135         if (pa_context_handle_error(o->context, command, t, FALSE) < 0)
2136             goto finish;
2137
2138         success = 0;
2139     } else {
2140
2141         if (!pa_tagstruct_eof(t)) {
2142             pa_context_fail(o->context, PA_ERR_PROTOCOL);
2143             goto finish;
2144         }
2145     }
2146
2147     o->stream->sample_spec.rate = PA_PTR_TO_UINT(o->private);
2148     pa_assert(pa_sample_spec_valid(&o->stream->sample_spec));
2149
2150     if (o->callback) {
2151         pa_stream_success_cb_t cb = (pa_stream_success_cb_t) o->callback;
2152         cb(o->stream, success, o->userdata);
2153     }
2154
2155 finish:
2156     pa_operation_done(o);
2157     pa_operation_unref(o);
2158 }
2159
2160
2161 pa_operation *pa_stream_update_sample_rate(pa_stream *s, uint32_t rate, pa_stream_success_cb_t cb, void *userdata) {
2162     pa_operation *o;
2163     pa_tagstruct *t;
2164     uint32_t tag;
2165
2166     pa_assert(s);
2167     pa_assert(PA_REFCNT_VALUE(s) >= 1);
2168
2169     PA_CHECK_VALIDITY_RETURN_NULL(s->context, rate > 0 && rate <= PA_RATE_MAX, PA_ERR_INVALID);
2170     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
2171     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
2172     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->flags & PA_STREAM_VARIABLE_RATE, PA_ERR_BADSTATE);
2173     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->context->version >= 12, PA_ERR_NOTSUPPORTED);
2174
2175     o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
2176     o->private = PA_UINT_TO_PTR(rate);
2177
2178     t = pa_tagstruct_command(
2179             s->context,
2180             s->direction == PA_STREAM_RECORD ? PA_COMMAND_UPDATE_RECORD_STREAM_SAMPLE_RATE : PA_COMMAND_UPDATE_PLAYBACK_STREAM_SAMPLE_RATE,
2181             &tag);
2182     pa_tagstruct_putu32(t, s->channel);
2183     pa_tagstruct_putu32(t, rate);
2184
2185     pa_pstream_send_tagstruct(s->context->pstream, t);
2186     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);
2187
2188     return o;
2189 }
2190
2191 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) {
2192     pa_operation *o;
2193     pa_tagstruct *t;
2194     uint32_t tag;
2195
2196     pa_assert(s);
2197     pa_assert(PA_REFCNT_VALUE(s) >= 1);
2198
2199     PA_CHECK_VALIDITY_RETURN_NULL(s->context, mode == PA_UPDATE_SET || mode == PA_UPDATE_MERGE || mode == PA_UPDATE_REPLACE, PA_ERR_INVALID);
2200     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
2201     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
2202     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->context->version >= 13, PA_ERR_NOTSUPPORTED);
2203
2204     o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
2205
2206     t = pa_tagstruct_command(
2207             s->context,
2208             s->direction == PA_STREAM_RECORD ? PA_COMMAND_UPDATE_RECORD_STREAM_PROPLIST : PA_COMMAND_UPDATE_PLAYBACK_STREAM_PROPLIST,
2209             &tag);
2210     pa_tagstruct_putu32(t, s->channel);
2211     pa_tagstruct_putu32(t, (uint32_t) mode);
2212     pa_tagstruct_put_proplist(t, p);
2213
2214     pa_pstream_send_tagstruct(s->context->pstream, t);
2215     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);
2216
2217     /* Please note that we don't update s->proplist here, because we
2218      * don't export that field */
2219
2220     return o;
2221 }
2222
2223 pa_operation *pa_stream_proplist_remove(pa_stream *s, const char *const keys[], pa_stream_success_cb_t cb, void *userdata) {
2224     pa_operation *o;
2225     pa_tagstruct *t;
2226     uint32_t tag;
2227     const char * const*k;
2228
2229     pa_assert(s);
2230     pa_assert(PA_REFCNT_VALUE(s) >= 1);
2231
2232     PA_CHECK_VALIDITY_RETURN_NULL(s->context, keys && keys[0], PA_ERR_INVALID);
2233     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
2234     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
2235     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->context->version >= 13, PA_ERR_NOTSUPPORTED);
2236
2237     o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
2238
2239     t = pa_tagstruct_command(
2240             s->context,
2241             s->direction == PA_STREAM_RECORD ? PA_COMMAND_REMOVE_RECORD_STREAM_PROPLIST : PA_COMMAND_REMOVE_PLAYBACK_STREAM_PROPLIST,
2242             &tag);
2243     pa_tagstruct_putu32(t, s->channel);
2244
2245     for (k = keys; *k; k++)
2246         pa_tagstruct_puts(t, *k);
2247
2248     pa_tagstruct_puts(t, NULL);
2249
2250     pa_pstream_send_tagstruct(s->context->pstream, t);
2251     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);
2252
2253     /* Please note that we don't update s->proplist here, because we
2254      * don't export that field */
2255
2256     return o;
2257 }
2258
2259 int pa_stream_set_monitor_stream(pa_stream *s, uint32_t sink_input_idx) {
2260     pa_assert(s);
2261     pa_assert(PA_REFCNT_VALUE(s) >= 1);
2262
2263     PA_CHECK_VALIDITY(s->context, sink_input_idx != PA_INVALID_INDEX, PA_ERR_INVALID);
2264     PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_UNCONNECTED, PA_ERR_BADSTATE);
2265     PA_CHECK_VALIDITY(s->context, s->context->version >= 13, PA_ERR_NOTSUPPORTED);
2266
2267     s->direct_on_input = sink_input_idx;
2268
2269     return 0;
2270 }
2271
2272 uint32_t pa_stream_get_monitor_stream(pa_stream *s) {
2273     pa_assert(s);
2274     pa_assert(PA_REFCNT_VALUE(s) >= 1);
2275
2276     PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->direct_on_input != PA_INVALID_INDEX, PA_ERR_BADSTATE, PA_INVALID_INDEX);
2277     PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->context->version >= 13, PA_ERR_NOTSUPPORTED, PA_INVALID_INDEX);
2278
2279     return s->direct_on_input;
2280 }