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 = (uint32_t) 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, 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, 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, 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, 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, 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_mainloop_api *m, pa_time_event *e, 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 += (suseconds_t) 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 = (uint32_t) 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, 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     pa_bool_t volume_set = FALSE;
 869
 870     pa_assert(s);
 871     pa_assert(PA_REFCNT_VALUE(s) >= 1);
 872     pa_assert(direction == PA_STREAM_PLAYBACK || direction == PA_STREAM_RECORD);
 873
 874     PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_UNCONNECTED, PA_ERR_BADSTATE);
 875     PA_CHECK_VALIDITY(s->context, s->direct_on_input == PA_INVALID_INDEX || direction == PA_STREAM_RECORD, PA_ERR_BADSTATE);
 876     PA_CHECK_VALIDITY(s->context, !(flags & ~(PA_STREAM_START_CORKED|
 877                                               PA_STREAM_INTERPOLATE_TIMING|
 878                                               PA_STREAM_NOT_MONOTONOUS|
 879                                               PA_STREAM_AUTO_TIMING_UPDATE|
 880                                               PA_STREAM_NO_REMAP_CHANNELS|
 881                                               PA_STREAM_NO_REMIX_CHANNELS|
 882                                               PA_STREAM_FIX_FORMAT|
 883                                               PA_STREAM_FIX_RATE|
 884                                               PA_STREAM_FIX_CHANNELS|
 885                                               PA_STREAM_DONT_MOVE|
 886                                               PA_STREAM_VARIABLE_RATE|
 887                                               PA_STREAM_PEAK_DETECT|
 888                                               PA_STREAM_START_MUTED|
 889                                               PA_STREAM_ADJUST_LATENCY)), PA_ERR_INVALID);
 890
 891     PA_CHECK_VALIDITY(s->context, s->context->version >= 12 || !(flags & PA_STREAM_VARIABLE_RATE), PA_ERR_NOTSUPPORTED);
 892     PA_CHECK_VALIDITY(s->context, s->context->version >= 13 || !(flags & PA_STREAM_PEAK_DETECT), PA_ERR_NOTSUPPORTED);
 893     /* Althought some of the other flags are not supported on older
 894      * version, we don't check for them here, because it doesn't hurt
 895      * when they are passed but actually not supported. This makes
 896      * client development easier */
 897
 898     PA_CHECK_VALIDITY(s->context, direction == PA_STREAM_PLAYBACK || !(flags & (PA_STREAM_START_MUTED)), PA_ERR_INVALID);
 899     PA_CHECK_VALIDITY(s->context, direction == PA_STREAM_RECORD || !(flags & (PA_STREAM_PEAK_DETECT)), PA_ERR_INVALID);
 900     PA_CHECK_VALIDITY(s->context, !volume || volume->channels == s->sample_spec.channels, PA_ERR_INVALID);
 901     PA_CHECK_VALIDITY(s->context, !sync_stream || (direction == PA_STREAM_PLAYBACK && sync_stream->direction == PA_STREAM_PLAYBACK), PA_ERR_INVALID);
 902
 903     pa_stream_ref(s);
 904
 905     s->direction = direction;
 906     s->flags = flags;
 907     s->corked = !!(flags & PA_STREAM_START_CORKED);
 908
 909     if (sync_stream)
 910         s->syncid = sync_stream->syncid;
 911
 912     if (attr)
 913         s->buffer_attr = *attr;
 914     automatic_buffer_attr(s, &s->buffer_attr, &s->sample_spec);
 915
 916     if (flags & PA_STREAM_INTERPOLATE_TIMING) {
 917         pa_usec_t x;
 918
 919         if (s->smoother)
 920             pa_smoother_free(s->smoother);
 921
 922         s->smoother = pa_smoother_new(SMOOTHER_ADJUST_TIME, SMOOTHER_HISTORY_TIME, !(flags & PA_STREAM_NOT_MONOTONIC), SMOOTHER_MIN_HISTORY);
 923
 924         x = pa_rtclock_usec();
 925         pa_smoother_set_time_offset(s->smoother, x);
 926         pa_smoother_pause(s->smoother, x);
 927     }
 928
 929     if (!dev)
 930         dev = s->direction == PA_STREAM_PLAYBACK ? s->context->conf->default_sink : s->context->conf->default_source;
 931
 932     t = pa_tagstruct_command(
 933             s->context,
 934             (uint32_t) (s->direction == PA_STREAM_PLAYBACK ? PA_COMMAND_CREATE_PLAYBACK_STREAM : PA_COMMAND_CREATE_RECORD_STREAM),
 935             &tag);
 936
 937     if (s->context->version < 13)
 938         pa_tagstruct_puts(t, pa_proplist_gets(s->proplist, PA_PROP_MEDIA_NAME));
 939
 940     pa_tagstruct_put(
 941             t,
 942             PA_TAG_SAMPLE_SPEC, &s->sample_spec,
 943             PA_TAG_CHANNEL_MAP, &s->channel_map,
 944             PA_TAG_U32, PA_INVALID_INDEX,
 945             PA_TAG_STRING, dev,
 946             PA_TAG_U32, s->buffer_attr.maxlength,
 947             PA_TAG_BOOLEAN, s->corked,
 948             PA_TAG_INVALID);
 949
 950     if (s->direction == PA_STREAM_PLAYBACK) {
 951         pa_cvolume cv;
 952
 953         pa_tagstruct_put(
 954                 t,
 955                 PA_TAG_U32, s->buffer_attr.tlength,
 956                 PA_TAG_U32, s->buffer_attr.prebuf,
 957                 PA_TAG_U32, s->buffer_attr.minreq,
 958                 PA_TAG_U32, s->syncid,
 959                 PA_TAG_INVALID);
 960
 961         volume_set = !!volume;
 962
 963         if (!volume)
 964             volume = pa_cvolume_reset(&cv, s->sample_spec.channels);
 965
 966         pa_tagstruct_put_cvolume(t, volume);
 967     } else
 968         pa_tagstruct_putu32(t, s->buffer_attr.fragsize);
 969
 970     if (s->context->version >= 12) {
 971         pa_tagstruct_put(
 972                 t,
 973                 PA_TAG_BOOLEAN, flags & PA_STREAM_NO_REMAP_CHANNELS,
 974                 PA_TAG_BOOLEAN, flags & PA_STREAM_NO_REMIX_CHANNELS,
 975                 PA_TAG_BOOLEAN, flags & PA_STREAM_FIX_FORMAT,
 976                 PA_TAG_BOOLEAN, flags & PA_STREAM_FIX_RATE,
 977                 PA_TAG_BOOLEAN, flags & PA_STREAM_FIX_CHANNELS,
 978                 PA_TAG_BOOLEAN, flags & PA_STREAM_DONT_MOVE,
 979                 PA_TAG_BOOLEAN, flags & PA_STREAM_VARIABLE_RATE,
 980                 PA_TAG_INVALID);
 981     }
 982
 983     if (s->context->version >= 13) {
 984
 985         if (s->direction == PA_STREAM_PLAYBACK)
 986             pa_tagstruct_put_boolean(t, flags & PA_STREAM_START_MUTED);
 987         else
 988             pa_tagstruct_put_boolean(t, flags & PA_STREAM_PEAK_DETECT);
 989
 990         pa_tagstruct_put(
 991                 t,
 992                 PA_TAG_BOOLEAN, flags & PA_STREAM_ADJUST_LATENCY,
 993                 PA_TAG_PROPLIST, s->proplist,
 994                 PA_TAG_INVALID);
 995
 996         if (s->direction == PA_STREAM_RECORD)
 997             pa_tagstruct_putu32(t, s->direct_on_input);
 998     }
 999
1000     if (s->context->version >= 14 &&
1001         s->direction == PA_STREAM_PLAYBACK) {
1002
1003         pa_tagstruct_put(
1004                 t,
1005                 PA_TAG_BOOLEAN, volume_set,
1006                 PA_TAG_INVALID);
1007     }
1008
1009     pa_pstream_send_tagstruct(s->context->pstream, t);
1010     pa_pdispatch_register_reply(s->context->pdispatch, tag, DEFAULT_TIMEOUT, pa_create_stream_callback, s, NULL);
1011
1012     pa_stream_set_state(s, PA_STREAM_CREATING);
1013
1014     pa_stream_unref(s);
1015     return 0;
1016 }
1017
1018 int pa_stream_connect_playback(
1019         pa_stream *s,
1020         const char *dev,
1021         const pa_buffer_attr *attr,
1022         pa_stream_flags_t flags,
1023         pa_cvolume *volume,
1024         pa_stream *sync_stream) {
1025
1026     pa_assert(s);
1027     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1028
1029     return create_stream(PA_STREAM_PLAYBACK, s, dev, attr, flags, volume, sync_stream);
1030 }
1031
1032 int pa_stream_connect_record(
1033         pa_stream *s,
1034         const char *dev,
1035         const pa_buffer_attr *attr,
1036         pa_stream_flags_t flags) {
1037
1038     pa_assert(s);
1039     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1040
1041     return create_stream(PA_STREAM_RECORD, s, dev, attr, flags, NULL, NULL);
1042 }
1043
1044 int pa_stream_write(
1045         pa_stream *s,
1046         const void *data,
1047         size_t length,
1048         void (*free_cb)(void *p),
1049         int64_t offset,
1050         pa_seek_mode_t seek) {
1051
1052     pa_memchunk chunk;
1053     pa_seek_mode_t t_seek;
1054     int64_t t_offset;
1055     size_t t_length;
1056     const void *t_data;
1057
1058     pa_assert(s);
1059     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1060     pa_assert(data);
1061
1062     PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1063     PA_CHECK_VALIDITY(s->context, s->direction == PA_STREAM_PLAYBACK || s->direction == PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1064     PA_CHECK_VALIDITY(s->context, seek <= PA_SEEK_RELATIVE_END, PA_ERR_INVALID);
1065     PA_CHECK_VALIDITY(s->context, s->direction == PA_STREAM_PLAYBACK || (seek == PA_SEEK_RELATIVE && offset == 0), PA_ERR_INVALID);
1066
1067     if (length <= 0)
1068         return 0;
1069
1070     t_seek = seek;
1071     t_offset = offset;
1072     t_length = length;
1073     t_data = data;
1074
1075     while (t_length > 0) {
1076
1077         chunk.index = 0;
1078
1079         if (free_cb && !pa_pstream_get_shm(s->context->pstream)) {
1080             chunk.memblock = pa_memblock_new_user(s->context->mempool, (void*) t_data, t_length, free_cb, 1);
1081             chunk.length = t_length;
1082         } else {
1083             void *d;
1084
1085             chunk.length = PA_MIN(t_length, pa_mempool_block_size_max(s->context->mempool));
1086             chunk.memblock = pa_memblock_new(s->context->mempool, chunk.length);
1087
1088             d = pa_memblock_acquire(chunk.memblock);
1089             memcpy(d, t_data, chunk.length);
1090             pa_memblock_release(chunk.memblock);
1091         }
1092
1093         pa_pstream_send_memblock(s->context->pstream, s->channel, t_offset, t_seek, &chunk);
1094
1095         t_offset = 0;
1096         t_seek = PA_SEEK_RELATIVE;
1097
1098         t_data = (const uint8_t*) t_data + chunk.length;
1099         t_length -= chunk.length;
1100
1101         pa_memblock_unref(chunk.memblock);
1102     }
1103
1104     if (free_cb && pa_pstream_get_shm(s->context->pstream))
1105         free_cb((void*) data);
1106
1107     if (length < s->requested_bytes)
1108         s->requested_bytes -= (uint32_t) length;
1109     else
1110         s->requested_bytes = 0;
1111
1112     /* FIXME!!! ^^^ will break when offset is != 0 and mode is not RELATIVE*/
1113
1114     if (s->direction == PA_STREAM_PLAYBACK) {
1115
1116         /* Update latency request correction */
1117         if (s->write_index_corrections[s->current_write_index_correction].valid) {
1118
1119             if (seek == PA_SEEK_ABSOLUTE) {
1120                 s->write_index_corrections[s->current_write_index_correction].corrupt = FALSE;
1121                 s->write_index_corrections[s->current_write_index_correction].absolute = TRUE;
1122                 s->write_index_corrections[s->current_write_index_correction].value = offset + (int64_t) length;
1123             } else if (seek == PA_SEEK_RELATIVE) {
1124                 if (!s->write_index_corrections[s->current_write_index_correction].corrupt)
1125                     s->write_index_corrections[s->current_write_index_correction].value += offset + (int64_t) length;
1126             } else
1127                 s->write_index_corrections[s->current_write_index_correction].corrupt = TRUE;
1128         }
1129
1130         /* Update the write index in the already available latency data */
1131         if (s->timing_info_valid) {
1132
1133             if (seek == PA_SEEK_ABSOLUTE) {
1134                 s->timing_info.write_index_corrupt = FALSE;
1135                 s->timing_info.write_index = offset + (int64_t) length;
1136             } else if (seek == PA_SEEK_RELATIVE) {
1137                 if (!s->timing_info.write_index_corrupt)
1138                     s->timing_info.write_index += offset + (int64_t) length;
1139             } else
1140                 s->timing_info.write_index_corrupt = TRUE;
1141         }
1142
1143         if (!s->timing_info_valid || s->timing_info.write_index_corrupt)
1144             request_auto_timing_update(s, TRUE);
1145     }
1146
1147     return 0;
1148 }
1149
1150 int pa_stream_peek(pa_stream *s, const void **data, size_t *length) {
1151     pa_assert(s);
1152     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1153     pa_assert(data);
1154     pa_assert(length);
1155
1156     PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1157     PA_CHECK_VALIDITY(s->context, s->direction == PA_STREAM_RECORD, PA_ERR_BADSTATE);
1158
1159     if (!s->peek_memchunk.memblock) {
1160
1161         if (pa_memblockq_peek(s->record_memblockq, &s->peek_memchunk) < 0) {
1162             *data = NULL;
1163             *length = 0;
1164             return 0;
1165         }
1166
1167         s->peek_data = pa_memblock_acquire(s->peek_memchunk.memblock);
1168     }
1169
1170     pa_assert(s->peek_data);
1171     *data = (uint8_t*) s->peek_data + s->peek_memchunk.index;
1172     *length = s->peek_memchunk.length;
1173     return 0;
1174 }
1175
1176 int pa_stream_drop(pa_stream *s) {
1177     pa_assert(s);
1178     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1179
1180     PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1181     PA_CHECK_VALIDITY(s->context, s->direction == PA_STREAM_RECORD, PA_ERR_BADSTATE);
1182     PA_CHECK_VALIDITY(s->context, s->peek_memchunk.memblock, PA_ERR_BADSTATE);
1183
1184     pa_memblockq_drop(s->record_memblockq, s->peek_memchunk.length);
1185
1186     /* Fix the simulated local read index */
1187     if (s->timing_info_valid && !s->timing_info.read_index_corrupt)
1188         s->timing_info.read_index += (int64_t) s->peek_memchunk.length;
1189
1190     pa_assert(s->peek_data);
1191     pa_memblock_release(s->peek_memchunk.memblock);
1192     pa_memblock_unref(s->peek_memchunk.memblock);
1193     pa_memchunk_reset(&s->peek_memchunk);
1194
1195     return 0;
1196 }
1197
1198 size_t pa_stream_writable_size(pa_stream *s) {
1199     pa_assert(s);
1200     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1201
1202     PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE, (size_t) -1);
1203     PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->direction != PA_STREAM_RECORD, PA_ERR_BADSTATE, (size_t) -1);
1204
1205     return s->requested_bytes;
1206 }
1207
1208 size_t pa_stream_readable_size(pa_stream *s) {
1209     pa_assert(s);
1210     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1211
1212     PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE, (size_t) -1);
1213     PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->direction == PA_STREAM_RECORD, PA_ERR_BADSTATE, (size_t) -1);
1214
1215     return pa_memblockq_get_length(s->record_memblockq);
1216 }
1217
1218 pa_operation * pa_stream_drain(pa_stream *s, pa_stream_success_cb_t cb, void *userdata) {
1219     pa_operation *o;
1220     pa_tagstruct *t;
1221     uint32_t tag;
1222
1223     pa_assert(s);
1224     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1225
1226     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1227     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction == PA_STREAM_PLAYBACK, PA_ERR_BADSTATE);
1228
1229     o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
1230
1231     t = pa_tagstruct_command(s->context, PA_COMMAND_DRAIN_PLAYBACK_STREAM, &tag);
1232     pa_tagstruct_putu32(t, s->channel);
1233     pa_pstream_send_tagstruct(s->context->pstream, t);
1234     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);
1235
1236     return o;
1237 }
1238
1239 static pa_usec_t calc_time(pa_stream *s, pa_bool_t ignore_transport) {
1240     pa_usec_t usec;
1241
1242     pa_assert(s);
1243     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1244     pa_assert(s->state == PA_STREAM_READY);
1245     pa_assert(s->direction != PA_STREAM_UPLOAD);
1246     pa_assert(s->timing_info_valid);
1247     pa_assert(s->direction != PA_STREAM_PLAYBACK || !s->timing_info.read_index_corrupt);
1248     pa_assert(s->direction != PA_STREAM_RECORD || !s->timing_info.write_index_corrupt);
1249
1250     if (s->direction == PA_STREAM_PLAYBACK) {
1251         /* The last byte that was written into the output device
1252          * had this time value associated */
1253         usec = pa_bytes_to_usec(s->timing_info.read_index < 0 ? 0 : (uint64_t) s->timing_info.read_index, &s->sample_spec);
1254
1255         if (!s->corked && !s->suspended) {
1256
1257             if (!ignore_transport)
1258                 /* Because the latency info took a little time to come
1259                  * to us, we assume that the real output time is actually
1260                  * a little ahead */
1261                 usec += s->timing_info.transport_usec;
1262
1263             /* However, the output device usually maintains a buffer
1264                too, hence the real sample currently played is a little
1265                back  */
1266             if (s->timing_info.sink_usec >= usec)
1267                 usec = 0;
1268             else
1269                 usec -= s->timing_info.sink_usec;
1270         }
1271
1272     } else {
1273         pa_assert(s->direction == PA_STREAM_RECORD);
1274
1275         /* The last byte written into the server side queue had
1276          * this time value associated */
1277         usec = pa_bytes_to_usec(s->timing_info.write_index < 0 ? 0 : (uint64_t) s->timing_info.write_index, &s->sample_spec);
1278
1279         if (!s->corked && !s->suspended) {
1280
1281             if (!ignore_transport)
1282                 /* Add transport latency */
1283                 usec += s->timing_info.transport_usec;
1284
1285             /* Add latency of data in device buffer */
1286             usec += s->timing_info.source_usec;
1287
1288             /* If this is a monitor source, we need to correct the
1289              * time by the playback device buffer */
1290             if (s->timing_info.sink_usec >= usec)
1291                 usec = 0;
1292             else
1293                 usec -= s->timing_info.sink_usec;
1294         }
1295     }
1296
1297     return usec;
1298 }
1299
1300 static void stream_get_timing_info_callback(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
1301     pa_operation *o = userdata;
1302     struct timeval local, remote, now;
1303     pa_timing_info *i;
1304     pa_bool_t playing = FALSE;
1305     uint64_t underrun_for = 0, playing_for = 0;
1306
1307     pa_assert(pd);
1308     pa_assert(o);
1309     pa_assert(PA_REFCNT_VALUE(o) >= 1);
1310
1311     if (!o->context || !o->stream)
1312         goto finish;
1313
1314     i = &o->stream->timing_info;
1315
1316     o->stream->timing_info_valid = FALSE;
1317     i->write_index_corrupt = TRUE;
1318     i->read_index_corrupt = TRUE;
1319
1320     if (command != PA_COMMAND_REPLY) {
1321         if (pa_context_handle_error(o->context, command, t, FALSE) < 0)
1322             goto finish;
1323
1324     } else {
1325
1326         if (pa_tagstruct_get_usec(t, &i->sink_usec) < 0 ||
1327             pa_tagstruct_get_usec(t, &i->source_usec) < 0 ||
1328             pa_tagstruct_get_boolean(t, &playing) < 0 ||
1329             pa_tagstruct_get_timeval(t, &local) < 0 ||
1330             pa_tagstruct_get_timeval(t, &remote) < 0 ||
1331             pa_tagstruct_gets64(t, &i->write_index) < 0 ||
1332             pa_tagstruct_gets64(t, &i->read_index) < 0) {
1333
1334             pa_context_fail(o->context, PA_ERR_PROTOCOL);
1335             goto finish;
1336         }
1337
1338         if (o->context->version >= 13 &&
1339             o->stream->direction == PA_STREAM_PLAYBACK)
1340             if (pa_tagstruct_getu64(t, &underrun_for) < 0 ||
1341                 pa_tagstruct_getu64(t, &playing_for) < 0) {
1342
1343                 pa_context_fail(o->context, PA_ERR_PROTOCOL);
1344                 goto finish;
1345             }
1346
1347
1348         if (!pa_tagstruct_eof(t)) {
1349             pa_context_fail(o->context, PA_ERR_PROTOCOL);
1350             goto finish;
1351         }
1352         o->stream->timing_info_valid = TRUE;
1353         i->write_index_corrupt = FALSE;
1354         i->read_index_corrupt = FALSE;
1355
1356         i->playing = (int) playing;
1357         i->since_underrun = (int64_t) (playing ? playing_for : underrun_for);
1358
1359         pa_gettimeofday(&now);
1360
1361         /* Calculcate timestamps */
1362         if (pa_timeval_cmp(&local, &remote) <= 0 && pa_timeval_cmp(&remote, &now) <= 0) {
1363             /* local and remote seem to have synchronized clocks */
1364
1365             if (o->stream->direction == PA_STREAM_PLAYBACK)
1366                 i->transport_usec = pa_timeval_diff(&remote, &local);
1367             else
1368                 i->transport_usec = pa_timeval_diff(&now, &remote);
1369
1370             i->synchronized_clocks = TRUE;
1371             i->timestamp = remote;
1372         } else {
1373             /* clocks are not synchronized, let's estimate latency then */
1374             i->transport_usec = pa_timeval_diff(&now, &local)/2;
1375             i->synchronized_clocks = FALSE;
1376             i->timestamp = local;
1377             pa_timeval_add(&i->timestamp, i->transport_usec);
1378         }
1379
1380         /* Invalidate read and write indexes if necessary */
1381         if (tag < o->stream->read_index_not_before)
1382             i->read_index_corrupt = TRUE;
1383
1384         if (tag < o->stream->write_index_not_before)
1385             i->write_index_corrupt = TRUE;
1386
1387         if (o->stream->direction == PA_STREAM_PLAYBACK) {
1388             /* Write index correction */
1389
1390             int n, j;
1391             uint32_t ctag = tag;
1392
1393             /* Go through the saved correction values and add up the
1394              * total correction.*/
1395             for (n = 0, j = o->stream->current_write_index_correction+1;
1396                  n < PA_MAX_WRITE_INDEX_CORRECTIONS;
1397                  n++, j = (j + 1) % PA_MAX_WRITE_INDEX_CORRECTIONS) {
1398
1399                 /* Step over invalid data or out-of-date data */
1400                 if (!o->stream->write_index_corrections[j].valid ||
1401                     o->stream->write_index_corrections[j].tag < ctag)
1402                     continue;
1403
1404                 /* Make sure that everything is in order */
1405                 ctag = o->stream->write_index_corrections[j].tag+1;
1406
1407                 /* Now fix the write index */
1408                 if (o->stream->write_index_corrections[j].corrupt) {
1409                     /* A corrupting seek was made */
1410                     i->write_index_corrupt = TRUE;
1411                 } else if (o->stream->write_index_corrections[j].absolute) {
1412                     /* An absolute seek was made */
1413                     i->write_index = o->stream->write_index_corrections[j].value;
1414                     i->write_index_corrupt = FALSE;
1415                 } else if (!i->write_index_corrupt) {
1416                     /* A relative seek was made */
1417                     i->write_index += o->stream->write_index_corrections[j].value;
1418                 }
1419             }
1420
1421             /* Clear old correction entries */
1422             for (n = 0; n < PA_MAX_WRITE_INDEX_CORRECTIONS; n++) {
1423                 if (!o->stream->write_index_corrections[n].valid)
1424                     continue;
1425
1426                 if (o->stream->write_index_corrections[n].tag <= tag)
1427                     o->stream->write_index_corrections[n].valid = FALSE;
1428             }
1429         }
1430
1431         if (o->stream->direction == PA_STREAM_RECORD) {
1432             /* Read index correction */
1433
1434             if (!i->read_index_corrupt)
1435                 i->read_index -= (int64_t) pa_memblockq_get_length(o->stream->record_memblockq);
1436         }
1437
1438         /* Update smoother */
1439         if (o->stream->smoother) {
1440             pa_usec_t u, x;
1441
1442             u = x = pa_rtclock_usec() - i->transport_usec;
1443
1444             if (o->stream->direction == PA_STREAM_PLAYBACK && o->context->version >= 13) {
1445                 pa_usec_t su;
1446
1447                 /* If we weren't playing then it will take some time
1448                  * until the audio will actually come out through the
1449                  * speakers. Since we follow that timing here, we need
1450                  * to try to fix this up */
1451
1452                 su = pa_bytes_to_usec((uint64_t) i->since_underrun, &o->stream->sample_spec);
1453
1454                 if (su < i->sink_usec)
1455                     x += i->sink_usec - su;
1456             }
1457
1458             if (!i->playing)
1459                 pa_smoother_pause(o->stream->smoother, x);
1460
1461             /* Update the smoother */
1462             if ((o->stream->direction == PA_STREAM_PLAYBACK && !i->read_index_corrupt) ||
1463                 (o->stream->direction == PA_STREAM_RECORD && !i->write_index_corrupt))
1464                 pa_smoother_put(o->stream->smoother, u, calc_time(o->stream, TRUE));
1465
1466             if (i->playing)
1467                 pa_smoother_resume(o->stream->smoother, x);
1468         }
1469     }
1470
1471     o->stream->auto_timing_update_requested = FALSE;
1472
1473     if (o->stream->latency_update_callback)
1474         o->stream->latency_update_callback(o->stream, o->stream->latency_update_userdata);
1475
1476     if (o->callback && o->stream && o->stream->state == PA_STREAM_READY) {
1477         pa_stream_success_cb_t cb = (pa_stream_success_cb_t) o->callback;
1478         cb(o->stream, o->stream->timing_info_valid, o->userdata);
1479     }
1480
1481 finish:
1482
1483     pa_operation_done(o);
1484     pa_operation_unref(o);
1485 }
1486
1487 pa_operation* pa_stream_update_timing_info(pa_stream *s, pa_stream_success_cb_t cb, void *userdata) {
1488     uint32_t tag;
1489     pa_operation *o;
1490     pa_tagstruct *t;
1491     struct timeval now;
1492     int cidx = 0;
1493
1494     pa_assert(s);
1495     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1496
1497     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1498     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1499
1500     if (s->direction == PA_STREAM_PLAYBACK) {
1501         /* Find a place to store the write_index correction data for this entry */
1502         cidx = (s->current_write_index_correction + 1) % PA_MAX_WRITE_INDEX_CORRECTIONS;
1503
1504         /* Check if we could allocate a correction slot. If not, there are too many outstanding queries */
1505         PA_CHECK_VALIDITY_RETURN_NULL(s->context, !s->write_index_corrections[cidx].valid, PA_ERR_INTERNAL);
1506     }
1507     o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
1508
1509     t = pa_tagstruct_command(
1510             s->context,
1511             (uint32_t) (s->direction == PA_STREAM_PLAYBACK ? PA_COMMAND_GET_PLAYBACK_LATENCY : PA_COMMAND_GET_RECORD_LATENCY),
1512             &tag);
1513     pa_tagstruct_putu32(t, s->channel);
1514     pa_tagstruct_put_timeval(t, pa_gettimeofday(&now));
1515
1516     pa_pstream_send_tagstruct(s->context->pstream, t);
1517     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);
1518
1519     if (s->direction == PA_STREAM_PLAYBACK) {
1520         /* Fill in initial correction data */
1521
1522         s->current_write_index_correction = cidx;
1523
1524         s->write_index_corrections[cidx].valid = TRUE;
1525         s->write_index_corrections[cidx].absolute = FALSE;
1526         s->write_index_corrections[cidx].corrupt = FALSE;
1527         s->write_index_corrections[cidx].tag = tag;
1528         s->write_index_corrections[cidx].value = 0;
1529     }
1530
1531     return o;
1532 }
1533
1534 void pa_stream_disconnect_callback(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
1535     pa_stream *s = userdata;
1536
1537     pa_assert(pd);
1538     pa_assert(s);
1539     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1540
1541     pa_stream_ref(s);
1542
1543     if (command != PA_COMMAND_REPLY) {
1544         if (pa_context_handle_error(s->context, command, t, FALSE) < 0)
1545             goto finish;
1546
1547         pa_stream_set_state(s, PA_STREAM_FAILED);
1548         goto finish;
1549     } else if (!pa_tagstruct_eof(t)) {
1550         pa_context_fail(s->context, PA_ERR_PROTOCOL);
1551         goto finish;
1552     }
1553
1554     pa_stream_set_state(s, PA_STREAM_TERMINATED);
1555
1556 finish:
1557     pa_stream_unref(s);
1558 }
1559
1560 int pa_stream_disconnect(pa_stream *s) {
1561     pa_tagstruct *t;
1562     uint32_t tag;
1563
1564     pa_assert(s);
1565     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1566
1567     PA_CHECK_VALIDITY(s->context, s->channel_valid, PA_ERR_BADSTATE);
1568     PA_CHECK_VALIDITY(s->context, s->context->state == PA_CONTEXT_READY, PA_ERR_BADSTATE);
1569
1570     pa_stream_ref(s);
1571
1572     t = pa_tagstruct_command(
1573             s->context,
1574             (uint32_t) (s->direction == PA_STREAM_PLAYBACK ? PA_COMMAND_DELETE_PLAYBACK_STREAM :
1575                         (s->direction == PA_STREAM_RECORD ? PA_COMMAND_DELETE_RECORD_STREAM : PA_COMMAND_DELETE_UPLOAD_STREAM)),
1576             &tag);
1577     pa_tagstruct_putu32(t, s->channel);
1578     pa_pstream_send_tagstruct(s->context->pstream, t);
1579     pa_pdispatch_register_reply(s->context->pdispatch, tag, DEFAULT_TIMEOUT, pa_stream_disconnect_callback, s, NULL);
1580
1581     pa_stream_unref(s);
1582     return 0;
1583 }
1584
1585 void pa_stream_set_read_callback(pa_stream *s, pa_stream_request_cb_t cb, void *userdata) {
1586     pa_assert(s);
1587     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1588
1589     if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1590         return;
1591
1592     s->read_callback = cb;
1593     s->read_userdata = userdata;
1594 }
1595
1596 void pa_stream_set_write_callback(pa_stream *s, pa_stream_request_cb_t cb, void *userdata) {
1597     pa_assert(s);
1598     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1599
1600     if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1601         return;
1602
1603     s->write_callback = cb;
1604     s->write_userdata = userdata;
1605 }
1606
1607 void pa_stream_set_state_callback(pa_stream *s, pa_stream_notify_cb_t cb, void *userdata) {
1608     pa_assert(s);
1609     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1610
1611     if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1612         return;
1613
1614     s->state_callback = cb;
1615     s->state_userdata = userdata;
1616 }
1617
1618 void pa_stream_set_overflow_callback(pa_stream *s, pa_stream_notify_cb_t cb, void *userdata) {
1619     pa_assert(s);
1620     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1621
1622     if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1623         return;
1624
1625     s->overflow_callback = cb;
1626     s->overflow_userdata = userdata;
1627 }
1628
1629 void pa_stream_set_underflow_callback(pa_stream *s, pa_stream_notify_cb_t cb, void *userdata) {
1630     pa_assert(s);
1631     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1632
1633     if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1634         return;
1635
1636     s->underflow_callback = cb;
1637     s->underflow_userdata = userdata;
1638 }
1639
1640 void pa_stream_set_latency_update_callback(pa_stream *s, pa_stream_notify_cb_t cb, void *userdata) {
1641     pa_assert(s);
1642     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1643
1644     if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1645         return;
1646
1647     s->latency_update_callback = cb;
1648     s->latency_update_userdata = userdata;
1649 }
1650
1651 void pa_stream_set_moved_callback(pa_stream *s, pa_stream_notify_cb_t cb, void *userdata) {
1652     pa_assert(s);
1653     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1654
1655     if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1656         return;
1657
1658     s->moved_callback = cb;
1659     s->moved_userdata = userdata;
1660 }
1661
1662 void pa_stream_set_suspended_callback(pa_stream *s, pa_stream_notify_cb_t cb, void *userdata) {
1663     pa_assert(s);
1664     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1665
1666     if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1667         return;
1668
1669     s->suspended_callback = cb;
1670     s->suspended_userdata = userdata;
1671 }
1672
1673 void pa_stream_set_started_callback(pa_stream *s, pa_stream_notify_cb_t cb, void *userdata) {
1674     pa_assert(s);
1675     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1676
1677     if (s->state == PA_STREAM_TERMINATED || s->state == PA_STREAM_FAILED)
1678         return;
1679
1680     s->started_callback = cb;
1681     s->started_userdata = userdata;
1682 }
1683
1684 void pa_stream_simple_ack_callback(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
1685     pa_operation *o = userdata;
1686     int success = 1;
1687
1688     pa_assert(pd);
1689     pa_assert(o);
1690     pa_assert(PA_REFCNT_VALUE(o) >= 1);
1691
1692     if (!o->context)
1693         goto finish;
1694
1695     if (command != PA_COMMAND_REPLY) {
1696         if (pa_context_handle_error(o->context, command, t, FALSE) < 0)
1697             goto finish;
1698
1699         success = 0;
1700     } else if (!pa_tagstruct_eof(t)) {
1701         pa_context_fail(o->context, PA_ERR_PROTOCOL);
1702         goto finish;
1703     }
1704
1705     if (o->callback) {
1706         pa_stream_success_cb_t cb = (pa_stream_success_cb_t) o->callback;
1707         cb(o->stream, success, o->userdata);
1708     }
1709
1710 finish:
1711     pa_operation_done(o);
1712     pa_operation_unref(o);
1713 }
1714
1715 pa_operation* pa_stream_cork(pa_stream *s, int b, pa_stream_success_cb_t cb, void *userdata) {
1716     pa_operation *o;
1717     pa_tagstruct *t;
1718     uint32_t tag;
1719
1720     pa_assert(s);
1721     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1722
1723     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1724     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1725
1726     s->corked = b;
1727
1728     o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
1729
1730     t = pa_tagstruct_command(
1731             s->context,
1732             (uint32_t) (s->direction == PA_STREAM_PLAYBACK ? PA_COMMAND_CORK_PLAYBACK_STREAM : PA_COMMAND_CORK_RECORD_STREAM),
1733             &tag);
1734     pa_tagstruct_putu32(t, s->channel);
1735     pa_tagstruct_put_boolean(t, !!b);
1736     pa_pstream_send_tagstruct(s->context->pstream, t);
1737     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);
1738
1739     check_smoother_status(s, FALSE, FALSE, FALSE);
1740
1741     /* This might cause the indexes to hang/start again, hence
1742      * let's request a timing update */
1743     request_auto_timing_update(s, TRUE);
1744
1745     return o;
1746 }
1747
1748 static pa_operation* stream_send_simple_command(pa_stream *s, uint32_t command, pa_stream_success_cb_t cb, void *userdata) {
1749     pa_tagstruct *t;
1750     pa_operation *o;
1751     uint32_t tag;
1752
1753     pa_assert(s);
1754     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1755
1756     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1757
1758     o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
1759
1760     t = pa_tagstruct_command(s->context, command, &tag);
1761     pa_tagstruct_putu32(t, s->channel);
1762     pa_pstream_send_tagstruct(s->context->pstream, t);
1763     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);
1764
1765     return o;
1766 }
1767
1768 pa_operation* pa_stream_flush(pa_stream *s, pa_stream_success_cb_t cb, void *userdata) {
1769     pa_operation *o;
1770
1771     pa_assert(s);
1772     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1773
1774     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1775     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1776
1777     if (!(o = stream_send_simple_command(s, (uint32_t) (s->direction == PA_STREAM_PLAYBACK ? PA_COMMAND_FLUSH_PLAYBACK_STREAM : PA_COMMAND_FLUSH_RECORD_STREAM), cb, userdata)))
1778         return NULL;
1779
1780     if (s->direction == PA_STREAM_PLAYBACK) {
1781
1782         if (s->write_index_corrections[s->current_write_index_correction].valid)
1783             s->write_index_corrections[s->current_write_index_correction].corrupt = TRUE;
1784
1785         if (s->buffer_attr.prebuf > 0)
1786             check_smoother_status(s, FALSE, FALSE, TRUE);
1787
1788         /* This will change the write index, but leave the
1789          * read index untouched. */
1790         invalidate_indexes(s, FALSE, TRUE);
1791
1792     } else
1793         /* For record streams this has no influence on the write
1794          * index, but the read index might jump. */
1795         invalidate_indexes(s, TRUE, FALSE);
1796
1797     return o;
1798 }
1799
1800 pa_operation* pa_stream_prebuf(pa_stream *s, pa_stream_success_cb_t cb, void *userdata) {
1801     pa_operation *o;
1802
1803     pa_assert(s);
1804     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1805
1806     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1807     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction == PA_STREAM_PLAYBACK, PA_ERR_BADSTATE);
1808     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->buffer_attr.prebuf > 0, PA_ERR_BADSTATE);
1809
1810     if (!(o = stream_send_simple_command(s, PA_COMMAND_PREBUF_PLAYBACK_STREAM, cb, userdata)))
1811         return NULL;
1812
1813     /* This might cause the read index to hang again, hence
1814      * let's request a timing update */
1815     request_auto_timing_update(s, TRUE);
1816
1817     return o;
1818 }
1819
1820 pa_operation* pa_stream_trigger(pa_stream *s, pa_stream_success_cb_t cb, void *userdata) {
1821     pa_operation *o;
1822
1823     pa_assert(s);
1824     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1825
1826     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1827     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction == PA_STREAM_PLAYBACK, PA_ERR_BADSTATE);
1828     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->buffer_attr.prebuf > 0, PA_ERR_BADSTATE);
1829
1830     if (!(o = stream_send_simple_command(s, PA_COMMAND_TRIGGER_PLAYBACK_STREAM, cb, userdata)))
1831         return NULL;
1832
1833     /* This might cause the read index to start moving again, hence
1834      * let's request a timing update */
1835     request_auto_timing_update(s, TRUE);
1836
1837     return o;
1838 }
1839
1840 pa_operation* pa_stream_set_name(pa_stream *s, const char *name, pa_stream_success_cb_t cb, void *userdata) {
1841     pa_operation *o;
1842
1843     pa_assert(s);
1844     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1845     pa_assert(name);
1846
1847     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1848     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1849
1850     if (s->context->version >= 13) {
1851         pa_proplist *p = pa_proplist_new();
1852
1853         pa_proplist_sets(p, PA_PROP_APPLICATION_NAME, name);
1854         o = pa_stream_proplist_update(s, PA_UPDATE_REPLACE, p, cb, userdata);
1855         pa_proplist_free(p);
1856     } else {
1857         pa_tagstruct *t;
1858         uint32_t tag;
1859
1860         o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
1861         t = pa_tagstruct_command(
1862                 s->context,
1863                 (uint32_t) (s->direction == PA_STREAM_RECORD ? PA_COMMAND_SET_RECORD_STREAM_NAME : PA_COMMAND_SET_PLAYBACK_STREAM_NAME),
1864                 &tag);
1865         pa_tagstruct_putu32(t, s->channel);
1866         pa_tagstruct_puts(t, name);
1867         pa_pstream_send_tagstruct(s->context->pstream, t);
1868         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);
1869     }
1870
1871     return o;
1872 }
1873
1874 int pa_stream_get_time(pa_stream *s, pa_usec_t *r_usec) {
1875     pa_usec_t usec;
1876
1877     pa_assert(s);
1878     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1879
1880     PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1881     PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1882     PA_CHECK_VALIDITY(s->context, s->timing_info_valid, PA_ERR_NODATA);
1883     PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_PLAYBACK || !s->timing_info.read_index_corrupt, PA_ERR_NODATA);
1884     PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_RECORD || !s->timing_info.write_index_corrupt, PA_ERR_NODATA);
1885
1886     if (s->smoother)
1887         usec = pa_smoother_get(s->smoother, pa_rtclock_usec());
1888     else
1889         usec = calc_time(s, FALSE);
1890
1891     /* Make sure the time runs monotonically */
1892     if (!(s->flags & PA_STREAM_NOT_MONOTONOUS)) {
1893         if (usec < s->previous_time)
1894             usec = s->previous_time;
1895         else
1896             s->previous_time = usec;
1897     }
1898
1899     if (r_usec)
1900         *r_usec = usec;
1901
1902     return 0;
1903 }
1904
1905 static pa_usec_t time_counter_diff(pa_stream *s, pa_usec_t a, pa_usec_t b, int *negative) {
1906     pa_assert(s);
1907     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1908
1909     if (negative)
1910         *negative = 0;
1911
1912     if (a >= b)
1913         return a-b;
1914     else {
1915         if (negative && s->direction == PA_STREAM_RECORD) {
1916             *negative = 1;
1917             return b-a;
1918         } else
1919             return 0;
1920     }
1921 }
1922
1923 int pa_stream_get_latency(pa_stream *s, pa_usec_t *r_usec, int *negative) {
1924     pa_usec_t t, c;
1925     int r;
1926     int64_t cindex;
1927
1928     pa_assert(s);
1929     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1930     pa_assert(r_usec);
1931
1932     PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1933     PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1934     PA_CHECK_VALIDITY(s->context, s->timing_info_valid, PA_ERR_NODATA);
1935     PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_PLAYBACK || !s->timing_info.write_index_corrupt, PA_ERR_NODATA);
1936     PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_RECORD || !s->timing_info.read_index_corrupt, PA_ERR_NODATA);
1937
1938     if ((r = pa_stream_get_time(s, &t)) < 0)
1939         return r;
1940
1941     if (s->direction == PA_STREAM_PLAYBACK)
1942         cindex = s->timing_info.write_index;
1943     else
1944         cindex = s->timing_info.read_index;
1945
1946     if (cindex < 0)
1947         cindex = 0;
1948
1949     c = pa_bytes_to_usec((uint64_t) cindex, &s->sample_spec);
1950
1951     if (s->direction == PA_STREAM_PLAYBACK)
1952         *r_usec = time_counter_diff(s, c, t, negative);
1953     else
1954         *r_usec = time_counter_diff(s, t, c, negative);
1955
1956     return 0;
1957 }
1958
1959 const pa_timing_info* pa_stream_get_timing_info(pa_stream *s) {
1960     pa_assert(s);
1961     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1962
1963     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1964     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1965     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->timing_info_valid, PA_ERR_BADSTATE);
1966
1967     return &s->timing_info;
1968 }
1969
1970 const pa_sample_spec* pa_stream_get_sample_spec(pa_stream *s) {
1971     pa_assert(s);
1972     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1973
1974     return &s->sample_spec;
1975 }
1976
1977 const pa_channel_map* pa_stream_get_channel_map(pa_stream *s) {
1978     pa_assert(s);
1979     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1980
1981     return &s->channel_map;
1982 }
1983
1984 const pa_buffer_attr* pa_stream_get_buffer_attr(pa_stream *s) {
1985     pa_assert(s);
1986     pa_assert(PA_REFCNT_VALUE(s) >= 1);
1987
1988     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
1989     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
1990     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->context->version >= 9, PA_ERR_NOTSUPPORTED);
1991
1992     return &s->buffer_attr;
1993 }
1994
1995 static void stream_set_buffer_attr_callback(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
1996     pa_operation *o = userdata;
1997     int success = 1;
1998
1999     pa_assert(pd);
2000     pa_assert(o);
2001     pa_assert(PA_REFCNT_VALUE(o) >= 1);
2002
2003     if (!o->context)
2004         goto finish;
2005
2006     if (command != PA_COMMAND_REPLY) {
2007         if (pa_context_handle_error(o->context, command, t, FALSE) < 0)
2008             goto finish;
2009
2010         success = 0;
2011     } else {
2012
2013         if (o->stream->direction == PA_STREAM_PLAYBACK) {
2014             if (pa_tagstruct_getu32(t, &o->stream->buffer_attr.maxlength) < 0 ||
2015                 pa_tagstruct_getu32(t, &o->stream->buffer_attr.tlength) < 0 ||
2016                 pa_tagstruct_getu32(t, &o->stream->buffer_attr.prebuf) < 0 ||
2017                 pa_tagstruct_getu32(t, &o->stream->buffer_attr.minreq) < 0) {
2018                 pa_context_fail(o->context, PA_ERR_PROTOCOL);
2019                 goto finish;
2020             }
2021         } else if (o->stream->direction == PA_STREAM_RECORD) {
2022             if (pa_tagstruct_getu32(t, &o->stream->buffer_attr.maxlength) < 0 ||
2023                 pa_tagstruct_getu32(t, &o->stream->buffer_attr.fragsize) < 0) {
2024                 pa_context_fail(o->context, PA_ERR_PROTOCOL);
2025                 goto finish;
2026             }
2027         }
2028
2029         if (!pa_tagstruct_eof(t)) {
2030             pa_context_fail(o->context, PA_ERR_PROTOCOL);
2031             goto finish;
2032         }
2033     }
2034
2035     if (o->callback) {
2036         pa_stream_success_cb_t cb = (pa_stream_success_cb_t) o->callback;
2037         cb(o->stream, success, o->userdata);
2038     }
2039
2040 finish:
2041     pa_operation_done(o);
2042     pa_operation_unref(o);
2043 }
2044
2045
2046 pa_operation* pa_stream_set_buffer_attr(pa_stream *s, const pa_buffer_attr *attr, pa_stream_success_cb_t cb, void *userdata) {
2047     pa_operation *o;
2048     pa_tagstruct *t;
2049     uint32_t tag;
2050
2051     pa_assert(s);
2052     pa_assert(PA_REFCNT_VALUE(s) >= 1);
2053     pa_assert(attr);
2054
2055     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
2056     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
2057     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->context->version >= 12, PA_ERR_NOTSUPPORTED);
2058
2059     o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
2060
2061     t = pa_tagstruct_command(
2062             s->context,
2063             (uint32_t) (s->direction == PA_STREAM_RECORD ? PA_COMMAND_SET_RECORD_STREAM_BUFFER_ATTR : PA_COMMAND_SET_PLAYBACK_STREAM_BUFFER_ATTR),
2064             &tag);
2065     pa_tagstruct_putu32(t, s->channel);
2066
2067     pa_tagstruct_putu32(t, attr->maxlength);
2068
2069     if (s->direction == PA_STREAM_PLAYBACK)
2070         pa_tagstruct_put(
2071                 t,
2072                 PA_TAG_U32, attr->tlength,
2073                 PA_TAG_U32, attr->prebuf,
2074                 PA_TAG_U32, attr->minreq,
2075                 PA_TAG_INVALID);
2076     else
2077         pa_tagstruct_putu32(t, attr->fragsize);
2078
2079     if (s->context->version >= 13)
2080         pa_tagstruct_put_boolean(t, !!(s->flags & PA_STREAM_ADJUST_LATENCY));
2081
2082     pa_pstream_send_tagstruct(s->context->pstream, t);
2083     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);
2084
2085     /* This might cause changes in the read/write indexex, hence let's
2086      * request a timing update */
2087     request_auto_timing_update(s, TRUE);
2088
2089     return o;
2090 }
2091
2092 uint32_t pa_stream_get_device_index(pa_stream *s) {
2093     pa_assert(s);
2094     pa_assert(PA_REFCNT_VALUE(s) >= 1);
2095
2096     PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE, PA_INVALID_INDEX);
2097     PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE, PA_INVALID_INDEX);
2098     PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->context->version >= 12, PA_ERR_NOTSUPPORTED, PA_INVALID_INDEX);
2099     PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->device_index != PA_INVALID_INDEX, PA_ERR_BADSTATE, PA_INVALID_INDEX);
2100
2101     return s->device_index;
2102 }
2103
2104 const char *pa_stream_get_device_name(pa_stream *s) {
2105     pa_assert(s);
2106     pa_assert(PA_REFCNT_VALUE(s) >= 1);
2107
2108     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
2109     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
2110     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->context->version >= 12, PA_ERR_NOTSUPPORTED);
2111     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->device_name, PA_ERR_BADSTATE);
2112
2113     return s->device_name;
2114 }
2115
2116 int pa_stream_is_suspended(pa_stream *s) {
2117     pa_assert(s);
2118     pa_assert(PA_REFCNT_VALUE(s) >= 1);
2119
2120     PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
2121     PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
2122     PA_CHECK_VALIDITY(s->context, s->context->version >= 12, PA_ERR_NOTSUPPORTED);
2123
2124     return s->suspended;
2125 }
2126
2127 int pa_stream_is_corked(pa_stream *s) {
2128     pa_assert(s);
2129     pa_assert(PA_REFCNT_VALUE(s) >= 1);
2130
2131     PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
2132     PA_CHECK_VALIDITY(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
2133
2134     return s->corked;
2135 }
2136
2137 static void stream_update_sample_rate_callback(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
2138     pa_operation *o = userdata;
2139     int success = 1;
2140
2141     pa_assert(pd);
2142     pa_assert(o);
2143     pa_assert(PA_REFCNT_VALUE(o) >= 1);
2144
2145     if (!o->context)
2146         goto finish;
2147
2148     if (command != PA_COMMAND_REPLY) {
2149         if (pa_context_handle_error(o->context, command, t, FALSE) < 0)
2150             goto finish;
2151
2152         success = 0;
2153     } else {
2154
2155         if (!pa_tagstruct_eof(t)) {
2156             pa_context_fail(o->context, PA_ERR_PROTOCOL);
2157             goto finish;
2158         }
2159     }
2160
2161     o->stream->sample_spec.rate = PA_PTR_TO_UINT(o->private);
2162     pa_assert(pa_sample_spec_valid(&o->stream->sample_spec));
2163
2164     if (o->callback) {
2165         pa_stream_success_cb_t cb = (pa_stream_success_cb_t) o->callback;
2166         cb(o->stream, success, o->userdata);
2167     }
2168
2169 finish:
2170     pa_operation_done(o);
2171     pa_operation_unref(o);
2172 }
2173
2174
2175 pa_operation *pa_stream_update_sample_rate(pa_stream *s, uint32_t rate, pa_stream_success_cb_t cb, void *userdata) {
2176     pa_operation *o;
2177     pa_tagstruct *t;
2178     uint32_t tag;
2179
2180     pa_assert(s);
2181     pa_assert(PA_REFCNT_VALUE(s) >= 1);
2182
2183     PA_CHECK_VALIDITY_RETURN_NULL(s->context, rate > 0 && rate <= PA_RATE_MAX, PA_ERR_INVALID);
2184     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
2185     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
2186     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->flags & PA_STREAM_VARIABLE_RATE, PA_ERR_BADSTATE);
2187     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->context->version >= 12, PA_ERR_NOTSUPPORTED);
2188
2189     o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
2190     o->private = PA_UINT_TO_PTR(rate);
2191
2192     t = pa_tagstruct_command(
2193             s->context,
2194             (uint32_t) (s->direction == PA_STREAM_RECORD ? PA_COMMAND_UPDATE_RECORD_STREAM_SAMPLE_RATE : PA_COMMAND_UPDATE_PLAYBACK_STREAM_SAMPLE_RATE),
2195             &tag);
2196     pa_tagstruct_putu32(t, s->channel);
2197     pa_tagstruct_putu32(t, rate);
2198
2199     pa_pstream_send_tagstruct(s->context->pstream, t);
2200     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);
2201
2202     return o;
2203 }
2204
2205 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) {
2206     pa_operation *o;
2207     pa_tagstruct *t;
2208     uint32_t tag;
2209
2210     pa_assert(s);
2211     pa_assert(PA_REFCNT_VALUE(s) >= 1);
2212
2213     PA_CHECK_VALIDITY_RETURN_NULL(s->context, mode == PA_UPDATE_SET || mode == PA_UPDATE_MERGE || mode == PA_UPDATE_REPLACE, PA_ERR_INVALID);
2214     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
2215     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
2216     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->context->version >= 13, PA_ERR_NOTSUPPORTED);
2217
2218     o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
2219
2220     t = pa_tagstruct_command(
2221             s->context,
2222             (uint32_t) (s->direction == PA_STREAM_RECORD ? PA_COMMAND_UPDATE_RECORD_STREAM_PROPLIST : PA_COMMAND_UPDATE_PLAYBACK_STREAM_PROPLIST),
2223             &tag);
2224     pa_tagstruct_putu32(t, s->channel);
2225     pa_tagstruct_putu32(t, (uint32_t) mode);
2226     pa_tagstruct_put_proplist(t, p);
2227
2228     pa_pstream_send_tagstruct(s->context->pstream, t);
2229     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);
2230
2231     /* Please note that we don't update s->proplist here, because we
2232      * don't export that field */
2233
2234     return o;
2235 }
2236
2237 pa_operation *pa_stream_proplist_remove(pa_stream *s, const char *const keys[], pa_stream_success_cb_t cb, void *userdata) {
2238     pa_operation *o;
2239     pa_tagstruct *t;
2240     uint32_t tag;
2241     const char * const*k;
2242
2243     pa_assert(s);
2244     pa_assert(PA_REFCNT_VALUE(s) >= 1);
2245
2246     PA_CHECK_VALIDITY_RETURN_NULL(s->context, keys && keys[0], PA_ERR_INVALID);
2247     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->state == PA_STREAM_READY, PA_ERR_BADSTATE);
2248     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->direction != PA_STREAM_UPLOAD, PA_ERR_BADSTATE);
2249     PA_CHECK_VALIDITY_RETURN_NULL(s->context, s->context->version >= 13, PA_ERR_NOTSUPPORTED);
2250
2251     o = pa_operation_new(s->context, s, (pa_operation_cb_t) cb, userdata);
2252
2253     t = pa_tagstruct_command(
2254             s->context,
2255             (uint32_t) (s->direction == PA_STREAM_RECORD ? PA_COMMAND_REMOVE_RECORD_STREAM_PROPLIST : PA_COMMAND_REMOVE_PLAYBACK_STREAM_PROPLIST),
2256             &tag);
2257     pa_tagstruct_putu32(t, s->channel);
2258
2259     for (k = keys; *k; k++)
2260         pa_tagstruct_puts(t, *k);
2261
2262     pa_tagstruct_puts(t, NULL);
2263
2264     pa_pstream_send_tagstruct(s->context->pstream, t);
2265     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);
2266
2267     /* Please note that we don't update s->proplist here, because we
2268      * don't export that field */
2269
2270     return o;
2271 }
2272
2273 int pa_stream_set_monitor_stream(pa_stream *s, uint32_t sink_input_idx) {
2274     pa_assert(s);
2275     pa_assert(PA_REFCNT_VALUE(s) >= 1);
2276
2277     PA_CHECK_VALIDITY(s->context, sink_input_idx != PA_INVALID_INDEX, PA_ERR_INVALID);
2278     PA_CHECK_VALIDITY(s->context, s->state == PA_STREAM_UNCONNECTED, PA_ERR_BADSTATE);
2279     PA_CHECK_VALIDITY(s->context, s->context->version >= 13, PA_ERR_NOTSUPPORTED);
2280
2281     s->direct_on_input = sink_input_idx;
2282
2283     return 0;
2284 }
2285
2286 uint32_t pa_stream_get_monitor_stream(pa_stream *s) {
2287     pa_assert(s);
2288     pa_assert(PA_REFCNT_VALUE(s) >= 1);
2289
2290     PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->direct_on_input != PA_INVALID_INDEX, PA_ERR_BADSTATE, PA_INVALID_INDEX);
2291     PA_CHECK_VALIDITY_RETURN_ANY(s->context, s->context->version >= 13, PA_ERR_NOTSUPPORTED, PA_INVALID_INDEX);
2292
2293     return s->direct_on_input;
2294 }