src/pulsecore/sink.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 <stdlib.h>
  28 #include <string.h>
  29 #include <stdio.h>
  30
  31 #include <pulse/introspect.h>
  32 #include <pulse/utf8.h>
  33 #include <pulse/xmalloc.h>
  34 #include <pulse/timeval.h>
  35
  36 #include <pulsecore/sink-input.h>
  37 #include <pulsecore/namereg.h>
  38 #include <pulsecore/core-util.h>
  39 #include <pulsecore/sample-util.h>
  40 #include <pulsecore/core-subscribe.h>
  41 #include <pulsecore/log.h>
  42 #include <pulsecore/macro.h>
  43 #include <pulsecore/play-memblockq.h>
  44
  45 #include "sink.h"
  46
  47 #define MAX_MIX_CHANNELS 32
  48 #define MIX_BUFFER_LENGTH (PA_PAGE_SIZE)
  49 #define DEFAULT_MIN_LATENCY (4*PA_USEC_PER_MSEC)
  50
  51 static PA_DEFINE_CHECK_TYPE(pa_sink, pa_msgobject);
  52
  53 static void sink_free(pa_object *s);
  54
  55 pa_sink_new_data* pa_sink_new_data_init(pa_sink_new_data *data) {
  56     pa_assert(data);
  57
  58     memset(data, 0, sizeof(*data));
  59     data->proplist = pa_proplist_new();
  60
  61     return data;
  62 }
  63
  64 void pa_sink_new_data_set_name(pa_sink_new_data *data, const char *name) {
  65     pa_assert(data);
  66
  67     pa_xfree(data->name);
  68     data->name = pa_xstrdup(name);
  69 }
  70
  71 void pa_sink_new_data_set_sample_spec(pa_sink_new_data *data, const pa_sample_spec *spec) {
  72     pa_assert(data);
  73
  74     if ((data->sample_spec_is_set = !!spec))
  75         data->sample_spec = *spec;
  76 }
  77
  78 void pa_sink_new_data_set_channel_map(pa_sink_new_data *data, const pa_channel_map *map) {
  79     pa_assert(data);
  80
  81     if ((data->channel_map_is_set = !!map))
  82         data->channel_map = *map;
  83 }
  84
  85 void pa_sink_new_data_set_volume(pa_sink_new_data *data, const pa_cvolume *volume) {
  86     pa_assert(data);
  87
  88     if ((data->volume_is_set = !!volume))
  89         data->volume = *volume;
  90 }
  91
  92 void pa_sink_new_data_set_muted(pa_sink_new_data *data, pa_bool_t mute) {
  93     pa_assert(data);
  94
  95     data->muted_is_set = TRUE;
  96     data->muted = !!mute;
  97 }
  98
  99 void pa_sink_new_data_done(pa_sink_new_data *data) {
 100     pa_assert(data);
 101
 102     pa_xfree(data->name);
 103     pa_proplist_free(data->proplist);
 104 }
 105
 106 /* Called from main context */
 107 static void reset_callbacks(pa_sink *s) {
 108     pa_assert(s);
 109
 110     s->set_state = NULL;
 111     s->get_volume = NULL;
 112     s->set_volume = NULL;
 113     s->get_mute = NULL;
 114     s->set_mute = NULL;
 115     s->request_rewind = NULL;
 116     s->update_requested_latency = NULL;
 117 }
 118
 119 /* Called from main context */
 120 pa_sink* pa_sink_new(
 121         pa_core *core,
 122         pa_sink_new_data *data,
 123         pa_sink_flags_t flags) {
 124
 125     pa_sink *s;
 126     const char *name;
 127     char st[PA_SAMPLE_SPEC_SNPRINT_MAX], cm[PA_CHANNEL_MAP_SNPRINT_MAX];
 128     pa_source_new_data source_data;
 129     const char *dn;
 130
 131     pa_assert(core);
 132     pa_assert(data);
 133     pa_assert(data->name);
 134
 135     s = pa_msgobject_new(pa_sink);
 136
 137     if (!(name = pa_namereg_register(core, data->name, PA_NAMEREG_SINK, s, data->namereg_fail))) {
 138         pa_xfree(s);
 139         return NULL;
 140     }
 141
 142     pa_sink_new_data_set_name(data, name);
 143
 144     if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_NEW], data) < 0) {
 145         pa_xfree(s);
 146         pa_namereg_unregister(core, name);
 147         return NULL;
 148     }
 149
 150     pa_return_null_if_fail(!data->driver || pa_utf8_valid(data->driver));
 151     pa_return_null_if_fail(data->name && pa_utf8_valid(data->name) && data->name[0]);
 152
 153     pa_return_null_if_fail(data->sample_spec_is_set && pa_sample_spec_valid(&data->sample_spec));
 154
 155     if (!data->channel_map_is_set)
 156         pa_return_null_if_fail(pa_channel_map_init_auto(&data->channel_map, data->sample_spec.channels, PA_CHANNEL_MAP_DEFAULT));
 157
 158     pa_return_null_if_fail(pa_channel_map_valid(&data->channel_map));
 159     pa_return_null_if_fail(data->channel_map.channels == data->sample_spec.channels);
 160
 161     if (!data->volume_is_set)
 162         pa_cvolume_reset(&data->volume, data->sample_spec.channels);
 163
 164     pa_return_null_if_fail(pa_cvolume_valid(&data->volume));
 165     pa_return_null_if_fail(data->volume.channels == data->sample_spec.channels);
 166
 167     if (!data->muted_is_set)
 168         data->muted = FALSE;
 169
 170     if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_FIXATE], data) < 0) {
 171         pa_xfree(s);
 172         pa_namereg_unregister(core, name);
 173         return NULL;
 174     }
 175
 176     s->parent.parent.free = sink_free;
 177     s->parent.process_msg = pa_sink_process_msg;
 178
 179     s->core = core;
 180     s->state = PA_SINK_INIT;
 181     s->flags = flags;
 182     s->name = pa_xstrdup(name);
 183     s->proplist = pa_proplist_copy(data->proplist);
 184     s->driver = pa_xstrdup(data->driver);
 185     s->module = data->module;
 186
 187     s->sample_spec = data->sample_spec;
 188     s->channel_map = data->channel_map;
 189
 190     s->inputs = pa_idxset_new(NULL, NULL);
 191     s->n_corked = 0;
 192
 193     s->volume = data->volume;
 194     s->muted = data->muted;
 195     s->refresh_volume = s->refresh_muted = FALSE;
 196
 197     reset_callbacks(s);
 198     s->userdata = NULL;
 199
 200     s->asyncmsgq = NULL;
 201     s->rtpoll = NULL;
 202
 203     pa_silence_memchunk_get(
 204             &core->silence_cache,
 205             core->mempool,
 206             &s->silence,
 207             &s->sample_spec,
 208             0);
 209
 210     s->thread_info.inputs = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
 211     pa_cvolume_reset(&s->thread_info.soft_volume, s->sample_spec.channels);
 212     s->thread_info.soft_muted = FALSE;
 213     s->thread_info.state = s->state;
 214     s->thread_info.rewind_nbytes = 0;
 215     s->thread_info.rewind_requested = FALSE;
 216     s->thread_info.max_rewind = 0;
 217     s->thread_info.max_request = 0;
 218     s->thread_info.requested_latency_valid = FALSE;
 219     s->thread_info.requested_latency = 0;
 220     s->thread_info.min_latency = DEFAULT_MIN_LATENCY;
 221     s->thread_info.max_latency = 0;
 222
 223     pa_assert_se(pa_idxset_put(core->sinks, s, &s->index) >= 0);
 224
 225     pa_log_info("Created sink %u \"%s\" with sample spec %s and channel map %s",
 226                 s->index,
 227                 s->name,
 228                 pa_sample_spec_snprint(st, sizeof(st), &s->sample_spec),
 229                 pa_channel_map_snprint(cm, sizeof(cm), &s->channel_map));
 230
 231     pa_source_new_data_init(&source_data);
 232     pa_source_new_data_set_sample_spec(&source_data, &s->sample_spec);
 233     pa_source_new_data_set_channel_map(&source_data, &s->channel_map);
 234     source_data.name = pa_sprintf_malloc("%s.monitor", name);
 235     source_data.driver = data->driver;
 236     source_data.module = data->module;
 237
 238     dn = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
 239     pa_proplist_setf(source_data.proplist, PA_PROP_DEVICE_DESCRIPTION, "Monitor of %s", dn ? dn : s->name);
 240     pa_proplist_sets(source_data.proplist, PA_PROP_DEVICE_CLASS, "monitor");
 241
 242     s->monitor_source = pa_source_new(core, &source_data, 0);
 243
 244     pa_source_new_data_done(&source_data);
 245
 246     if (!s->monitor_source) {
 247         pa_sink_unlink(s);
 248         pa_sink_unref(s);
 249         return NULL;
 250     }
 251
 252     s->monitor_source->monitor_of = s;
 253
 254     pa_source_set_latency_range(s->monitor_source, s->thread_info.min_latency, s->thread_info.max_latency);
 255     pa_source_set_max_rewind(s->monitor_source, s->thread_info.max_rewind);
 256
 257     return s;
 258 }
 259
 260 /* Called from main context */
 261 static int sink_set_state(pa_sink *s, pa_sink_state_t state) {
 262     int ret;
 263     pa_bool_t suspend_change;
 264     pa_sink_state_t original_state;
 265
 266     pa_assert(s);
 267
 268     if (s->state == state)
 269         return 0;
 270
 271     original_state = s->state;
 272
 273     suspend_change =
 274         (original_state == PA_SINK_SUSPENDED && PA_SINK_IS_OPENED(state)) ||
 275         (PA_SINK_IS_OPENED(original_state) && state == PA_SINK_SUSPENDED);
 276
 277     if (s->set_state)
 278         if ((ret = s->set_state(s, state)) < 0)
 279             return ret;
 280
 281     if (s->asyncmsgq)
 282         if ((ret = pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL)) < 0) {
 283
 284             if (s->set_state)
 285                 s->set_state(s, original_state);
 286
 287             return ret;
 288         }
 289
 290     s->state = state;
 291
 292     if (suspend_change) {
 293         pa_sink_input *i;
 294         uint32_t idx;
 295
 296         /* We're suspending or resuming, tell everyone about it */
 297
 298         for (i = PA_SINK_INPUT(pa_idxset_first(s->inputs, &idx)); i; i = PA_SINK_INPUT(pa_idxset_next(s->inputs, &idx)))
 299             if (i->suspend)
 300                 i->suspend(i, state == PA_SINK_SUSPENDED);
 301     }
 302
 303     if (state != PA_SINK_UNLINKED) /* if we enter UNLINKED state pa_sink_unlink() will fire the apropriate events */
 304         pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_STATE_CHANGED], s);
 305
 306     return 0;
 307 }
 308
 309 /* Called from main context */
 310 void pa_sink_put(pa_sink* s) {
 311     pa_sink_assert_ref(s);
 312
 313     pa_assert(s->state == PA_SINK_INIT);
 314
 315     /* The following fields must be initialized properly when calling _put() */
 316     pa_assert(s->asyncmsgq);
 317     pa_assert(s->rtpoll);
 318     pa_assert(!s->thread_info.min_latency || !s->thread_info.max_latency ||
 319               s->thread_info.min_latency <= s->thread_info.max_latency);
 320
 321     if (!(s->flags & PA_SINK_HW_VOLUME_CTRL)) {
 322         s->flags |= PA_SINK_DECIBEL_VOLUME;
 323
 324         s->thread_info.soft_volume = s->volume;
 325         s->thread_info.soft_muted = s->muted;
 326     }
 327
 328     pa_assert_se(sink_set_state(s, PA_SINK_IDLE) == 0);
 329
 330     pa_source_put(s->monitor_source);
 331
 332     pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK | PA_SUBSCRIPTION_EVENT_NEW, s->index);
 333     pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_PUT], s);
 334 }
 335
 336 /* Called from main context */
 337 void pa_sink_unlink(pa_sink* s) {
 338     pa_bool_t linked;
 339     pa_sink_input *i, *j = NULL;
 340
 341     pa_assert(s);
 342
 343     /* Please note that pa_sink_unlink() does more than simply
 344      * reversing pa_sink_put(). It also undoes the registrations
 345      * already done in pa_sink_new()! */
 346
 347     /* All operations here shall be idempotent, i.e. pa_sink_unlink()
 348      * may be called multiple times on the same sink without bad
 349      * effects. */
 350
 351     linked = PA_SINK_IS_LINKED(s->state);
 352
 353     if (linked)
 354         pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_UNLINK], s);
 355
 356     if (s->state != PA_SINK_UNLINKED)
 357         pa_namereg_unregister(s->core, s->name);
 358     pa_idxset_remove_by_data(s->core->sinks, s, NULL);
 359
 360     while ((i = pa_idxset_first(s->inputs, NULL))) {
 361         pa_assert(i != j);
 362         pa_sink_input_kill(i);
 363         j = i;
 364     }
 365
 366     if (linked)
 367         sink_set_state(s, PA_SINK_UNLINKED);
 368     else
 369         s->state = PA_SINK_UNLINKED;
 370
 371     reset_callbacks(s);
 372
 373     if (s->monitor_source)
 374         pa_source_unlink(s->monitor_source);
 375
 376     if (linked) {
 377         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK | PA_SUBSCRIPTION_EVENT_REMOVE, s->index);
 378         pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_UNLINK_POST], s);
 379     }
 380 }
 381
 382 /* Called from main context */
 383 static void sink_free(pa_object *o) {
 384     pa_sink *s = PA_SINK(o);
 385     pa_sink_input *i;
 386
 387     pa_assert(s);
 388     pa_assert(pa_sink_refcnt(s) == 0);
 389
 390     if (PA_SINK_IS_LINKED(s->state))
 391         pa_sink_unlink(s);
 392
 393     pa_log_info("Freeing sink %u \"%s\"", s->index, s->name);
 394
 395     if (s->monitor_source) {
 396         pa_source_unref(s->monitor_source);
 397         s->monitor_source = NULL;
 398     }
 399
 400     pa_idxset_free(s->inputs, NULL, NULL);
 401
 402     while ((i = pa_hashmap_steal_first(s->thread_info.inputs)))
 403         pa_sink_input_unref(i);
 404
 405     pa_hashmap_free(s->thread_info.inputs, NULL, NULL);
 406
 407     if (s->silence.memblock)
 408         pa_memblock_unref(s->silence.memblock);
 409
 410     pa_xfree(s->name);
 411     pa_xfree(s->driver);
 412
 413     if (s->proplist)
 414         pa_proplist_free(s->proplist);
 415
 416     pa_xfree(s);
 417 }
 418
 419 /* Called from main context */
 420 void pa_sink_set_asyncmsgq(pa_sink *s, pa_asyncmsgq *q) {
 421     pa_sink_assert_ref(s);
 422
 423     s->asyncmsgq = q;
 424
 425     if (s->monitor_source)
 426         pa_source_set_asyncmsgq(s->monitor_source, q);
 427 }
 428
 429 /* Called from main context */
 430 void pa_sink_set_rtpoll(pa_sink *s, pa_rtpoll *p) {
 431     pa_sink_assert_ref(s);
 432
 433     s->rtpoll = p;
 434     if (s->monitor_source)
 435         pa_source_set_rtpoll(s->monitor_source, p);
 436 }
 437
 438 /* Called from main context */
 439 int pa_sink_update_status(pa_sink*s) {
 440     pa_sink_assert_ref(s);
 441     pa_assert(PA_SINK_IS_LINKED(s->state));
 442
 443     if (s->state == PA_SINK_SUSPENDED)
 444         return 0;
 445
 446     return sink_set_state(s, pa_sink_used_by(s) ? PA_SINK_RUNNING : PA_SINK_IDLE);
 447 }
 448
 449 /* Called from main context */
 450 int pa_sink_suspend(pa_sink *s, pa_bool_t suspend) {
 451     pa_sink_assert_ref(s);
 452     pa_assert(PA_SINK_IS_LINKED(s->state));
 453
 454     if (suspend)
 455         return sink_set_state(s, PA_SINK_SUSPENDED);
 456     else
 457         return sink_set_state(s, pa_sink_used_by(s) ? PA_SINK_RUNNING : PA_SINK_IDLE);
 458 }
 459
 460 /* Called from IO thread context */
 461 void pa_sink_process_rewind(pa_sink *s, size_t nbytes) {
 462     pa_sink_input *i;
 463     void *state = NULL;
 464     pa_sink_assert_ref(s);
 465     pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
 466
 467     s->thread_info.rewind_nbytes = 0;
 468     s->thread_info.rewind_requested = FALSE;
 469
 470     if (nbytes > 0)
 471         pa_log_debug("Processing rewind...");
 472
 473     while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL))) {
 474         pa_sink_input_assert_ref(i);
 475         pa_sink_input_process_rewind(i, nbytes);
 476     }
 477
 478     if (nbytes > 0)
 479         if (s->monitor_source && PA_SOURCE_IS_OPENED(s->monitor_source->thread_info.state))
 480             pa_source_process_rewind(s->monitor_source, nbytes);
 481 }
 482
 483 /* Called from IO thread context */
 484 static unsigned fill_mix_info(pa_sink *s, size_t *length, pa_mix_info *info, unsigned maxinfo) {
 485     pa_sink_input *i;
 486     unsigned n = 0;
 487     void *state = NULL;
 488     size_t mixlength = *length;
 489
 490     pa_sink_assert_ref(s);
 491     pa_assert(info);
 492
 493     while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL)) && maxinfo > 0) {
 494         pa_sink_input_assert_ref(i);
 495
 496         if (pa_sink_input_peek(i, *length, &info->chunk, &info->volume) < 0)
 497             continue;
 498
 499         if (mixlength == 0 || info->chunk.length < mixlength)
 500             mixlength = info->chunk.length;
 501
 502         if (pa_memblock_is_silence(info->chunk.memblock)) {
 503             pa_memblock_unref(info->chunk.memblock);
 504             continue;
 505         }
 506
 507         info->userdata = pa_sink_input_ref(i);
 508
 509         pa_assert(info->chunk.memblock);
 510         pa_assert(info->chunk.length > 0);
 511
 512         info++;
 513         n++;
 514         maxinfo--;
 515     }
 516
 517     if (mixlength > 0)
 518         *length = mixlength;
 519
 520     return n;
 521 }
 522
 523 /* Called from IO thread context */
 524 static void inputs_drop(pa_sink *s, pa_mix_info *info, unsigned n, pa_memchunk *result) {
 525     pa_sink_input *i;
 526     void *state = NULL;
 527     unsigned p = 0;
 528     unsigned n_unreffed = 0;
 529
 530     pa_sink_assert_ref(s);
 531     pa_assert(result);
 532     pa_assert(result->memblock);
 533     pa_assert(result->length > 0);
 534
 535     /* We optimize for the case where the order of the inputs has not changed */
 536
 537     while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL))) {
 538         unsigned j;
 539         pa_mix_info* m = NULL;
 540
 541         pa_sink_input_assert_ref(i);
 542
 543         /* Let's try to find the matching entry info the pa_mix_info array */
 544         for (j = 0; j < n; j ++) {
 545
 546             if (info[p].userdata == i) {
 547                 m = info + p;
 548                 break;
 549             }
 550
 551             p++;
 552             if (p >= n)
 553                 p = 0;
 554         }
 555
 556         /* Drop read data */
 557         pa_sink_input_drop(i, result->length);
 558
 559         if (s->monitor_source && PA_SOURCE_IS_OPENED(pa_source_get_state(s->monitor_source))) {
 560
 561             if (pa_hashmap_size(i->thread_info.direct_outputs) > 0) {
 562                 void *ostate = NULL;
 563                 pa_source_output *o;
 564                 pa_memchunk c;
 565
 566                 if (m && m->chunk.memblock) {
 567                     c = m->chunk;
 568                     pa_memblock_ref(c.memblock);
 569                     pa_assert(result->length <= c.length);
 570                     c.length = result->length;
 571
 572                     pa_memchunk_make_writable(&c, 0);
 573                     pa_volume_memchunk(&c, &s->sample_spec, &m->volume);
 574                 } else {
 575                     c = s->silence;
 576                     pa_memblock_ref(c.memblock);
 577                     pa_assert(result->length <= c.length);
 578                     c.length = result->length;
 579                 }
 580
 581                 while ((o = pa_hashmap_iterate(i->thread_info.direct_outputs, &ostate, NULL))) {
 582                     pa_source_output_assert_ref(o);
 583                     pa_assert(o->direct_on_input == i);
 584                     pa_source_post_direct(s->monitor_source, o, &c);
 585                 }
 586
 587                 pa_memblock_unref(c.memblock);
 588             }
 589         }
 590
 591         if (m) {
 592             if (m->chunk.memblock)
 593                 pa_memblock_unref(m->chunk.memblock);
 594                 pa_memchunk_reset(&m->chunk);
 595
 596             pa_sink_input_unref(m->userdata);
 597             m->userdata = NULL;
 598
 599             n_unreffed += 1;
 600         }
 601     }
 602
 603     /* Now drop references to entries that are included in the
 604      * pa_mix_info array but don't exist anymore */
 605
 606     if (n_unreffed < n) {
 607         for (; n > 0; info++, n--) {
 608             if (info->userdata)
 609                 pa_sink_input_unref(info->userdata);
 610             if (info->chunk.memblock)
 611                 pa_memblock_unref(info->chunk.memblock);
 612         }
 613     }
 614
 615     if (s->monitor_source && PA_SOURCE_IS_OPENED(pa_source_get_state(s->monitor_source)))
 616         pa_source_post(s->monitor_source, result);
 617 }
 618
 619 /* Called from IO thread context */
 620 void pa_sink_render(pa_sink*s, size_t length, pa_memchunk *result) {
 621     pa_mix_info info[MAX_MIX_CHANNELS];
 622     unsigned n;
 623     size_t block_size_max;
 624
 625     pa_sink_assert_ref(s);
 626     pa_assert(PA_SINK_IS_OPENED(s->thread_info.state));
 627     pa_assert(pa_frame_aligned(length, &s->sample_spec));
 628     pa_assert(result);
 629
 630     pa_sink_ref(s);
 631
 632     pa_assert(!s->thread_info.rewind_requested);
 633     pa_assert(s->thread_info.rewind_nbytes == 0);
 634
 635     if (length <= 0)
 636         length = pa_frame_align(MIX_BUFFER_LENGTH, &s->sample_spec);
 637
 638     block_size_max = pa_mempool_block_size_max(s->core->mempool);
 639     if (length > block_size_max)
 640         length = pa_frame_align(block_size_max, &s->sample_spec);
 641
 642     pa_assert(length > 0);
 643
 644     n = s->thread_info.state == PA_SINK_RUNNING ? fill_mix_info(s, &length, info, MAX_MIX_CHANNELS) : 0;
 645
 646     if (n == 0) {
 647
 648         *result = s->silence;
 649         pa_memblock_ref(result->memblock);
 650
 651         if (result->length > length)
 652             result->length = length;
 653
 654     } else if (n == 1) {
 655         pa_cvolume volume;
 656
 657         *result = info[0].chunk;
 658         pa_memblock_ref(result->memblock);
 659
 660         if (result->length > length)
 661             result->length = length;
 662
 663         pa_sw_cvolume_multiply(&volume, &s->thread_info.soft_volume, &info[0].volume);
 664
 665         if (s->thread_info.soft_muted || !pa_cvolume_is_norm(&volume)) {
 666             pa_memchunk_make_writable(result, 0);
 667             if (s->thread_info.soft_muted || pa_cvolume_is_muted(&volume))
 668                 pa_silence_memchunk(result, &s->sample_spec);
 669             else
 670                 pa_volume_memchunk(result, &s->sample_spec, &volume);
 671         }
 672     } else {
 673         void *ptr;
 674         result->memblock = pa_memblock_new(s->core->mempool, length);
 675
 676         ptr = pa_memblock_acquire(result->memblock);
 677         result->length = pa_mix(info, n,
 678                                 ptr, length,
 679                                 &s->sample_spec,
 680                                 &s->thread_info.soft_volume,
 681                                 s->thread_info.soft_muted);
 682         pa_memblock_release(result->memblock);
 683
 684         result->index = 0;
 685     }
 686
 687     if (s->thread_info.state == PA_SINK_RUNNING)
 688         inputs_drop(s, info, n, result);
 689
 690     pa_sink_unref(s);
 691 }
 692
 693 /* Called from IO thread context */
 694 void pa_sink_render_into(pa_sink*s, pa_memchunk *target) {
 695     pa_mix_info info[MAX_MIX_CHANNELS];
 696     unsigned n;
 697     size_t length, block_size_max;
 698
 699     pa_sink_assert_ref(s);
 700     pa_assert(PA_SINK_IS_OPENED(s->thread_info.state));
 701     pa_assert(target);
 702     pa_assert(target->memblock);
 703     pa_assert(target->length > 0);
 704     pa_assert(pa_frame_aligned(target->length, &s->sample_spec));
 705
 706     pa_sink_ref(s);
 707
 708     pa_assert(!s->thread_info.rewind_requested);
 709     pa_assert(s->thread_info.rewind_nbytes == 0);
 710
 711     length = target->length;
 712     block_size_max = pa_mempool_block_size_max(s->core->mempool);
 713     if (length > block_size_max)
 714         length = pa_frame_align(block_size_max, &s->sample_spec);
 715
 716     pa_assert(length > 0);
 717
 718     n = s->thread_info.state == PA_SINK_RUNNING ? fill_mix_info(s, &length, info, MAX_MIX_CHANNELS) : 0;
 719
 720     if (n == 0) {
 721         if (target->length > length)
 722             target->length = length;
 723
 724         pa_silence_memchunk(target, &s->sample_spec);
 725     } else if (n == 1) {
 726         pa_cvolume volume;
 727
 728         if (target->length > length)
 729             target->length = length;
 730
 731         pa_sw_cvolume_multiply(&volume, &s->thread_info.soft_volume, &info[0].volume);
 732
 733         if (s->thread_info.soft_muted || pa_cvolume_is_muted(&volume))
 734             pa_silence_memchunk(target, &s->sample_spec);
 735         else {
 736             pa_memchunk vchunk;
 737
 738             vchunk = info[0].chunk;
 739             pa_memblock_ref(vchunk.memblock);
 740
 741             if (vchunk.length > length)
 742                 vchunk.length = length;
 743
 744             if (!pa_cvolume_is_norm(&volume)) {
 745                 pa_memchunk_make_writable(&vchunk, 0);
 746                 pa_volume_memchunk(&vchunk, &s->sample_spec, &volume);
 747             }
 748
 749             pa_memchunk_memcpy(target, &vchunk);
 750             pa_memblock_unref(vchunk.memblock);
 751         }
 752
 753     } else {
 754         void *ptr;
 755
 756         ptr = pa_memblock_acquire(target->memblock);
 757
 758         target->length = pa_mix(info, n,
 759                                 (uint8_t*) ptr + target->index, length,
 760                                 &s->sample_spec,
 761                                 &s->thread_info.soft_volume,
 762                                 s->thread_info.soft_muted);
 763
 764         pa_memblock_release(target->memblock);
 765     }
 766
 767     if (s->thread_info.state == PA_SINK_RUNNING)
 768         inputs_drop(s, info, n, target);
 769
 770     pa_sink_unref(s);
 771 }
 772
 773 /* Called from IO thread context */
 774 void pa_sink_render_into_full(pa_sink *s, pa_memchunk *target) {
 775     pa_memchunk chunk;
 776     size_t l, d;
 777
 778     pa_sink_assert_ref(s);
 779     pa_assert(PA_SINK_IS_OPENED(s->thread_info.state));
 780     pa_assert(target);
 781     pa_assert(target->memblock);
 782     pa_assert(target->length > 0);
 783     pa_assert(pa_frame_aligned(target->length, &s->sample_spec));
 784
 785     pa_sink_ref(s);
 786
 787     pa_assert(!s->thread_info.rewind_requested);
 788     pa_assert(s->thread_info.rewind_nbytes == 0);
 789
 790     l = target->length;
 791     d = 0;
 792     while (l > 0) {
 793         chunk = *target;
 794         chunk.index += d;
 795         chunk.length -= d;
 796
 797         pa_sink_render_into(s, &chunk);
 798
 799         d += chunk.length;
 800         l -= chunk.length;
 801     }
 802
 803     pa_sink_unref(s);
 804 }
 805
 806 /* Called from IO thread context */
 807 void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result) {
 808     pa_sink_assert_ref(s);
 809     pa_assert(PA_SINK_IS_OPENED(s->thread_info.state));
 810     pa_assert(length > 0);
 811     pa_assert(pa_frame_aligned(length, &s->sample_spec));
 812     pa_assert(result);
 813
 814     pa_assert(!s->thread_info.rewind_requested);
 815     pa_assert(s->thread_info.rewind_nbytes == 0);
 816
 817     /*** This needs optimization ***/
 818
 819     result->index = 0;
 820     result->length = length;
 821     result->memblock = pa_memblock_new(s->core->mempool, length);
 822
 823     pa_sink_render_into_full(s, result);
 824 }
 825
 826 /* Called from main thread */
 827 pa_usec_t pa_sink_get_latency(pa_sink *s) {
 828     pa_usec_t usec = 0;
 829
 830     pa_sink_assert_ref(s);
 831     pa_assert(PA_SINK_IS_LINKED(s->state));
 832
 833     /* The returned value is supposed to be in the time domain of the sound card! */
 834
 835     if (!PA_SINK_IS_OPENED(s->state))
 836         return 0;
 837
 838     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_LATENCY, &usec, 0, NULL) == 0);
 839
 840     return usec;
 841 }
 842
 843 /* Called from main thread */
 844 void pa_sink_set_volume(pa_sink *s, const pa_cvolume *volume) {
 845     pa_bool_t changed;
 846     pa_sink_set_volume_data data;
 847
 848     pa_sink_assert_ref(s);
 849     pa_assert(PA_SINK_IS_LINKED(s->state));
 850     pa_assert(volume);
 851     pa_assert(pa_cvolume_valid(volume));
 852     pa_assert(pa_cvolume_compatible(volume, &s->sample_spec));
 853
 854     data.sink = s;
 855     data.volume = *volume;
 856
 857     changed = !pa_cvolume_equal(&data.volume, &s->volume);
 858
 859     if (changed && pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_SET_VOLUME], &data) < 0)
 860         return;
 861
 862     s->volume = data.volume;
 863
 864     if (s->set_volume && s->set_volume(s) < 0)
 865         s->set_volume = NULL;
 866
 867     if (!s->set_volume)
 868         pa_sink_set_soft_volume(s, volume);
 869
 870     if (changed)
 871         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 872 }
 873
 874 /* Called from main thread */
 875 void pa_sink_set_soft_volume(pa_sink *s, const pa_cvolume *volume) {
 876     pa_sink_assert_ref(s);
 877     pa_assert(volume);
 878
 879     if (PA_SINK_IS_LINKED(s->state))
 880         pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_VOLUME, volume, 0, NULL);
 881     else
 882         s->thread_info.soft_volume = *volume;
 883 }
 884
 885 /* Called from main thread */
 886 const pa_cvolume *pa_sink_get_volume(pa_sink *s, pa_bool_t force_refresh) {
 887     pa_sink_assert_ref(s);
 888     pa_assert(PA_SINK_IS_LINKED(s->state));
 889
 890     if (s->refresh_volume || force_refresh) {
 891         struct pa_cvolume old_volume = s->volume;
 892
 893         if (s->get_volume && s->get_volume(s) < 0)
 894             s->get_volume = NULL;
 895
 896         if (!s->get_volume)
 897             pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_VOLUME, &s->volume, 0, NULL);
 898
 899         if (!pa_cvolume_equal(&old_volume, &s->volume))
 900             pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 901     }
 902
 903     return &s->volume;
 904 }
 905
 906 /* Called from main thread */
 907 void pa_sink_set_mute(pa_sink *s, pa_bool_t mute) {
 908     pa_bool_t changed;
 909
 910     pa_sink_assert_ref(s);
 911     pa_assert(PA_SINK_IS_LINKED(s->state));
 912
 913     changed = s->muted != mute;
 914     s->muted = mute;
 915
 916     if (s->set_mute && s->set_mute(s) < 0)
 917         s->set_mute = NULL;
 918
 919     if (!s->set_mute)
 920         pa_asyncmsgq_post(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_MUTE, PA_UINT_TO_PTR(mute), 0, NULL, NULL);
 921
 922     if (changed)
 923         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 924 }
 925
 926 /* Called from main thread */
 927 pa_bool_t pa_sink_get_mute(pa_sink *s, pa_bool_t force_refresh) {
 928
 929     pa_sink_assert_ref(s);
 930     pa_assert(PA_SINK_IS_LINKED(s->state));
 931
 932     if (s->refresh_muted || force_refresh) {
 933         pa_bool_t old_muted = s->muted;
 934
 935         if (s->get_mute && s->get_mute(s) < 0)
 936             s->get_mute = NULL;
 937
 938         if (!s->get_mute)
 939             pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_MUTE, &s->muted, 0, NULL);
 940
 941         if (old_muted != s->muted)
 942             pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 943     }
 944
 945     return s->muted;
 946 }
 947
 948 /* Called from main thread */
 949 void pa_sink_set_description(pa_sink *s, const char *description) {
 950     const char *old;
 951     pa_sink_assert_ref(s);
 952
 953     if (!description && !pa_proplist_contains(s->proplist, PA_PROP_DEVICE_DESCRIPTION))
 954         return;
 955
 956     old = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
 957
 958     if (old && description && !strcmp(old, description))
 959         return;
 960
 961     if (description)
 962         pa_proplist_sets(s->proplist, PA_PROP_DEVICE_DESCRIPTION, description);
 963     else
 964         pa_proplist_unset(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
 965
 966     if (s->monitor_source) {
 967         char *n;
 968
 969         n = pa_sprintf_malloc("Monitor Source of %s", description ? description : s->name);
 970         pa_source_set_description(s->monitor_source, n);
 971         pa_xfree(n);
 972     }
 973
 974     if (PA_SINK_IS_LINKED(s->state)) {
 975         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 976         pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_PROPLIST_CHANGED], s);
 977     }
 978 }
 979
 980 /* Called from main thread */
 981 unsigned pa_sink_linked_by(pa_sink *s) {
 982     unsigned ret;
 983
 984     pa_sink_assert_ref(s);
 985     pa_assert(PA_SINK_IS_LINKED(s->state));
 986
 987     ret = pa_idxset_size(s->inputs);
 988
 989     /* We add in the number of streams connected to us here. Please
 990      * not the asymmmetry to pa_sink_used_by()! */
 991
 992     if (s->monitor_source)
 993         ret += pa_source_linked_by(s->monitor_source);
 994
 995     return ret;
 996 }
 997
 998 /* Called from main thread */
 999 unsigned pa_sink_used_by(pa_sink *s) {
1000     unsigned ret;
1001
1002     pa_sink_assert_ref(s);
1003     pa_assert(PA_SINK_IS_LINKED(s->state));
1004
1005     ret = pa_idxset_size(s->inputs);
1006     pa_assert(ret >= s->n_corked);
1007
1008     /* Streams connected to our monitor source do not matter for
1009      * pa_sink_used_by()!.*/
1010
1011     return ret - s->n_corked;
1012 }
1013
1014 /* Called from IO thread, except when it is not */
1015 int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
1016     pa_sink *s = PA_SINK(o);
1017     pa_sink_assert_ref(s);
1018
1019     switch ((pa_sink_message_t) code) {
1020
1021         case PA_SINK_MESSAGE_ADD_INPUT: {
1022             pa_sink_input *i = PA_SINK_INPUT(userdata);
1023
1024             /* If you change anything here, make sure to change the
1025              * sink input handling a few lines down at
1026              * PA_SINK_MESSAGE_FINISH_MOVE, too. */
1027
1028             pa_hashmap_put(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index), pa_sink_input_ref(i));
1029
1030             /* Since the caller sleeps in pa_sink_input_put(), we can
1031              * safely access data outside of thread_info even though
1032              * it is mutable */
1033
1034             if ((i->thread_info.sync_prev = i->sync_prev)) {
1035                 pa_assert(i->sink == i->thread_info.sync_prev->sink);
1036                 pa_assert(i->sync_prev->sync_next == i);
1037                 i->thread_info.sync_prev->thread_info.sync_next = i;
1038             }
1039
1040             if ((i->thread_info.sync_next = i->sync_next)) {
1041                 pa_assert(i->sink == i->thread_info.sync_next->sink);
1042                 pa_assert(i->sync_next->sync_prev == i);
1043                 i->thread_info.sync_next->thread_info.sync_prev = i;
1044             }
1045
1046             pa_assert(!i->thread_info.attached);
1047             i->thread_info.attached = TRUE;
1048
1049             if (i->attach)
1050                 i->attach(i);
1051
1052             pa_sink_input_set_state_within_thread(i, i->state);
1053
1054             /* The requested latency of the sink input needs to be
1055              * fixed up and then configured on the sink */
1056
1057             if (i->thread_info.requested_sink_latency != (pa_usec_t) -1)
1058                 pa_sink_input_set_requested_latency_within_thread(i, i->thread_info.requested_sink_latency);
1059
1060             pa_sink_input_update_max_rewind(i, s->thread_info.max_rewind);
1061             pa_sink_input_update_max_request(i, s->thread_info.max_request);
1062
1063             /* We don't rewind here automatically. This is left to the
1064              * sink input implementor because some sink inputs need a
1065              * slow start, i.e. need some time to buffer client
1066              * samples before beginning streaming. */
1067
1068             return 0;
1069         }
1070
1071         case PA_SINK_MESSAGE_REMOVE_INPUT: {
1072             pa_sink_input *i = PA_SINK_INPUT(userdata);
1073
1074             /* If you change anything here, make sure to change the
1075              * sink input handling a few lines down at
1076              * PA_SINK_MESSAGE_PREPAPRE_MOVE, too. */
1077
1078             if (i->detach)
1079                 i->detach(i);
1080
1081             pa_sink_input_set_state_within_thread(i, i->state);
1082
1083             pa_assert(i->thread_info.attached);
1084             i->thread_info.attached = FALSE;
1085
1086             /* Since the caller sleeps in pa_sink_input_unlink(),
1087              * we can safely access data outside of thread_info even
1088              * though it is mutable */
1089
1090             pa_assert(!i->sync_prev);
1091             pa_assert(!i->sync_next);
1092
1093             if (i->thread_info.sync_prev) {
1094                 i->thread_info.sync_prev->thread_info.sync_next = i->thread_info.sync_prev->sync_next;
1095                 i->thread_info.sync_prev = NULL;
1096             }
1097
1098             if (i->thread_info.sync_next) {
1099                 i->thread_info.sync_next->thread_info.sync_prev = i->thread_info.sync_next->sync_prev;
1100                 i->thread_info.sync_next = NULL;
1101             }
1102
1103             if (pa_hashmap_remove(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index)))
1104                 pa_sink_input_unref(i);
1105
1106             pa_sink_invalidate_requested_latency(s);
1107             pa_sink_request_rewind(s, (size_t) -1);
1108
1109             return 0;
1110         }
1111
1112         case PA_SINK_MESSAGE_START_MOVE: {
1113             pa_sink_input *i = PA_SINK_INPUT(userdata);
1114
1115             /* We don't support moving synchronized streams. */
1116             pa_assert(!i->sync_prev);
1117             pa_assert(!i->sync_next);
1118             pa_assert(!i->thread_info.sync_next);
1119             pa_assert(!i->thread_info.sync_prev);
1120
1121             if (i->thread_info.state != PA_SINK_INPUT_CORKED) {
1122                 pa_usec_t usec = 0;
1123                 size_t sink_nbytes, total_nbytes;
1124
1125                 /* Get the latency of the sink */
1126                 if (PA_MSGOBJECT(s)->process_msg(PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_LATENCY, &usec, 0, NULL) < 0)
1127                     usec = 0;
1128
1129                 sink_nbytes = pa_usec_to_bytes(usec, &s->sample_spec);
1130                 total_nbytes = sink_nbytes + pa_memblockq_get_length(i->thread_info.render_memblockq);
1131
1132                 if (total_nbytes > 0) {
1133                     i->thread_info.rewrite_nbytes = i->thread_info.resampler ? pa_resampler_request(i->thread_info.resampler, total_nbytes) : total_nbytes;
1134                     i->thread_info.rewrite_flush = TRUE;
1135                     pa_sink_input_process_rewind(i, sink_nbytes);
1136                 }
1137             }
1138
1139             if (i->detach)
1140                 i->detach(i);
1141
1142             pa_assert(i->thread_info.attached);
1143             i->thread_info.attached = FALSE;
1144
1145             /* Let's remove the sink input ...*/
1146             if (pa_hashmap_remove(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index)))
1147                 pa_sink_input_unref(i);
1148
1149             pa_sink_invalidate_requested_latency(s);
1150
1151             pa_log_debug("Requesting rewind due to started move");
1152             pa_sink_request_rewind(s, (size_t) -1);
1153
1154             return 0;
1155         }
1156
1157         case PA_SINK_MESSAGE_FINISH_MOVE: {
1158             pa_sink_input *i = PA_SINK_INPUT(userdata);
1159
1160             /* We don't support moving synchronized streams. */
1161             pa_assert(!i->sync_prev);
1162             pa_assert(!i->sync_next);
1163             pa_assert(!i->thread_info.sync_next);
1164             pa_assert(!i->thread_info.sync_prev);
1165
1166             pa_hashmap_put(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index), pa_sink_input_ref(i));
1167
1168             pa_assert(!i->thread_info.attached);
1169             i->thread_info.attached = TRUE;
1170
1171             if (i->attach)
1172                 i->attach(i);
1173
1174             if (i->thread_info.requested_sink_latency != (pa_usec_t) -1)
1175                 pa_sink_input_set_requested_latency_within_thread(i, i->thread_info.requested_sink_latency);
1176
1177             pa_sink_input_update_max_rewind(i, s->thread_info.max_rewind);
1178             pa_sink_input_update_max_request(i, s->thread_info.max_request);
1179
1180             if (i->thread_info.state != PA_SINK_INPUT_CORKED) {
1181                 pa_usec_t usec = 0;
1182                 size_t nbytes;
1183
1184                 /* Get the latency of the sink */
1185                 if (PA_MSGOBJECT(s)->process_msg(PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_LATENCY, &usec, 0, NULL) < 0)
1186                     usec = 0;
1187
1188                 nbytes = pa_usec_to_bytes(usec, &s->sample_spec);
1189
1190                 if (nbytes > 0)
1191                     pa_sink_input_drop(i, nbytes);
1192
1193                 pa_log_debug("Requesting rewind due to finished move");
1194                 pa_sink_request_rewind(s, nbytes);
1195             }
1196
1197             return 0;
1198         }
1199
1200         case PA_SINK_MESSAGE_SET_VOLUME:
1201             s->thread_info.soft_volume = *((pa_cvolume*) userdata);
1202
1203             pa_sink_request_rewind(s, (size_t) -1);
1204             return 0;
1205
1206         case PA_SINK_MESSAGE_SET_MUTE:
1207             s->thread_info.soft_muted = PA_PTR_TO_UINT(userdata);
1208
1209             pa_sink_request_rewind(s, (size_t) -1);
1210             return 0;
1211
1212         case PA_SINK_MESSAGE_GET_VOLUME:
1213             *((pa_cvolume*) userdata) = s->thread_info.soft_volume;
1214             return 0;
1215
1216         case PA_SINK_MESSAGE_GET_MUTE:
1217             *((pa_bool_t*) userdata) = s->thread_info.soft_muted;
1218             return 0;
1219
1220         case PA_SINK_MESSAGE_SET_STATE:
1221
1222             s->thread_info.state = PA_PTR_TO_UINT(userdata);
1223             return 0;
1224
1225         case PA_SINK_MESSAGE_DETACH:
1226
1227             /* Detach all streams */
1228             pa_sink_detach_within_thread(s);
1229             return 0;
1230
1231         case PA_SINK_MESSAGE_ATTACH:
1232
1233             /* Reattach all streams */
1234             pa_sink_attach_within_thread(s);
1235             return 0;
1236
1237         case PA_SINK_MESSAGE_GET_REQUESTED_LATENCY: {
1238
1239             pa_usec_t *usec = userdata;
1240             *usec = pa_sink_get_requested_latency_within_thread(s);
1241
1242             if (*usec == (pa_usec_t) -1)
1243                 *usec = s->thread_info.max_latency;
1244
1245             return 0;
1246         }
1247
1248         case PA_SINK_MESSAGE_SET_LATENCY_RANGE: {
1249             pa_usec_t *r = userdata;
1250
1251             pa_sink_update_latency_range(s, r[0], r[1]);
1252
1253             return 0;
1254         }
1255
1256         case PA_SINK_MESSAGE_GET_LATENCY_RANGE: {
1257             pa_usec_t *r = userdata;
1258
1259             r[0] = s->thread_info.min_latency;
1260             r[1] = s->thread_info.max_latency;
1261
1262             return 0;
1263         }
1264
1265         case PA_SINK_MESSAGE_GET_MAX_REWIND:
1266
1267             *((size_t*) userdata) = s->thread_info.max_rewind;
1268             return 0;
1269
1270         case PA_SINK_MESSAGE_GET_MAX_REQUEST:
1271
1272             *((size_t*) userdata) = s->thread_info.max_request;
1273             return 0;
1274
1275         case PA_SINK_MESSAGE_GET_LATENCY:
1276         case PA_SINK_MESSAGE_MAX:
1277             ;
1278     }
1279
1280     return -1;
1281 }
1282
1283 /* Called from main thread */
1284 int pa_sink_suspend_all(pa_core *c, pa_bool_t suspend) {
1285     pa_sink *sink;
1286     uint32_t idx;
1287     int ret = 0;
1288
1289     pa_core_assert_ref(c);
1290
1291     for (sink = PA_SINK(pa_idxset_first(c->sinks, &idx)); sink; sink = PA_SINK(pa_idxset_next(c->sinks, &idx)))
1292         ret -= pa_sink_suspend(sink, suspend) < 0;
1293
1294     return ret;
1295 }
1296
1297 /* Called from main thread */
1298 void pa_sink_detach(pa_sink *s) {
1299     pa_sink_assert_ref(s);
1300     pa_assert(PA_SINK_IS_LINKED(s->state));
1301
1302     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_DETACH, NULL, 0, NULL) == 0);
1303 }
1304
1305 /* Called from main thread */
1306 void pa_sink_attach(pa_sink *s) {
1307     pa_sink_assert_ref(s);
1308     pa_assert(PA_SINK_IS_LINKED(s->state));
1309
1310     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_ATTACH, NULL, 0, NULL) == 0);
1311 }
1312
1313 /* Called from IO thread */
1314 void pa_sink_detach_within_thread(pa_sink *s) {
1315     pa_sink_input *i;
1316     void *state = NULL;
1317
1318     pa_sink_assert_ref(s);
1319     pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1320
1321     while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL)))
1322         if (i->detach)
1323             i->detach(i);
1324
1325     if (s->monitor_source)
1326         pa_source_detach_within_thread(s->monitor_source);
1327 }
1328
1329 /* Called from IO thread */
1330 void pa_sink_attach_within_thread(pa_sink *s) {
1331     pa_sink_input *i;
1332     void *state = NULL;
1333
1334     pa_sink_assert_ref(s);
1335     pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1336
1337     while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL)))
1338         if (i->attach)
1339             i->attach(i);
1340
1341     if (s->monitor_source)
1342         pa_source_attach_within_thread(s->monitor_source);
1343 }
1344
1345 /* Called from IO thread */
1346 void pa_sink_request_rewind(pa_sink*s, size_t nbytes) {
1347     pa_sink_assert_ref(s);
1348     pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1349
1350     if (nbytes == (size_t) -1)
1351         nbytes = s->thread_info.max_rewind;
1352
1353     nbytes = PA_MIN(nbytes, s->thread_info.max_rewind);
1354
1355     if (s->thread_info.rewind_requested &&
1356         nbytes <= s->thread_info.rewind_nbytes)
1357         return;
1358
1359     s->thread_info.rewind_nbytes = nbytes;
1360     s->thread_info.rewind_requested = TRUE;
1361
1362     if (s->request_rewind)
1363         s->request_rewind(s);
1364 }
1365
1366 /* Called from IO thread */
1367 pa_usec_t pa_sink_get_requested_latency_within_thread(pa_sink *s) {
1368     pa_usec_t result = (pa_usec_t) -1;
1369     pa_sink_input *i;
1370     void *state = NULL;
1371     pa_usec_t monitor_latency;
1372
1373     pa_sink_assert_ref(s);
1374
1375     if (s->thread_info.requested_latency_valid)
1376         return s->thread_info.requested_latency;
1377
1378     while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL)))
1379
1380         if (i->thread_info.requested_sink_latency != (pa_usec_t) -1 &&
1381             (result == (pa_usec_t) -1 || result > i->thread_info.requested_sink_latency))
1382             result = i->thread_info.requested_sink_latency;
1383
1384     monitor_latency = pa_source_get_requested_latency_within_thread(s->monitor_source);
1385
1386     if (monitor_latency != (pa_usec_t) -1 &&
1387         (result == (pa_usec_t) -1 || result > monitor_latency))
1388         result = monitor_latency;
1389
1390     if (result != (pa_usec_t) -1) {
1391         if (s->thread_info.max_latency > 0 && result > s->thread_info.max_latency)
1392             result = s->thread_info.max_latency;
1393
1394         if (s->thread_info.min_latency > 0 && result < s->thread_info.min_latency)
1395             result = s->thread_info.min_latency;
1396     }
1397
1398     s->thread_info.requested_latency = result;
1399     s->thread_info.requested_latency_valid = TRUE;
1400
1401     return result;
1402 }
1403
1404 /* Called from main thread */
1405 pa_usec_t pa_sink_get_requested_latency(pa_sink *s) {
1406     pa_usec_t usec = 0;
1407
1408     pa_sink_assert_ref(s);
1409     pa_assert(PA_SINK_IS_LINKED(s->state));
1410
1411     if (!PA_SINK_IS_OPENED(s->state))
1412         return 0;
1413
1414     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_REQUESTED_LATENCY, &usec, 0, NULL) == 0);
1415     return usec;
1416 }
1417
1418 /* Called from IO thread */
1419 void pa_sink_set_max_rewind(pa_sink *s, size_t max_rewind) {
1420     pa_sink_input *i;
1421     void *state = NULL;
1422
1423     pa_sink_assert_ref(s);
1424
1425     if (max_rewind == s->thread_info.max_rewind)
1426         return;
1427
1428     s->thread_info.max_rewind = max_rewind;
1429
1430     if (PA_SINK_IS_LINKED(s->thread_info.state)) {
1431         while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL)))
1432             pa_sink_input_update_max_rewind(i, s->thread_info.max_rewind);
1433     }
1434
1435     if (s->monitor_source)
1436         pa_source_set_max_rewind(s->monitor_source, s->thread_info.max_rewind);
1437 }
1438
1439 /* Called from IO thread */
1440 void pa_sink_set_max_request(pa_sink *s, size_t max_request) {
1441     void *state = NULL;
1442
1443     pa_sink_assert_ref(s);
1444
1445     if (max_request == s->thread_info.max_request)
1446         return;
1447
1448     s->thread_info.max_request = max_request;
1449
1450     if (PA_SINK_IS_LINKED(s->thread_info.state)) {
1451         pa_sink_input *i;
1452
1453         while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL)))
1454             pa_sink_input_update_max_request(i, s->thread_info.max_request);
1455     }
1456 }
1457
1458 /* Called from IO thread */
1459 void pa_sink_invalidate_requested_latency(pa_sink *s) {
1460     pa_sink_input *i;
1461     void *state = NULL;
1462
1463     pa_sink_assert_ref(s);
1464
1465     s->thread_info.requested_latency_valid = FALSE;
1466
1467     if (s->update_requested_latency)
1468         s->update_requested_latency(s);
1469
1470     while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL)))
1471         if (i->update_sink_requested_latency)
1472             i->update_sink_requested_latency(i);
1473 }
1474
1475 /* Called from main thread */
1476 void pa_sink_set_latency_range(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency) {
1477     pa_sink_assert_ref(s);
1478
1479     /* min_latency == 0:           no limit
1480      * min_latency == (size_t) -1: default limit
1481      * min_latency anything else:  specified limit
1482      *
1483      * Similar for max_latency */
1484
1485     if (min_latency == (pa_usec_t) -1)
1486         min_latency = DEFAULT_MIN_LATENCY;
1487
1488     if (max_latency == (pa_usec_t) -1)
1489         max_latency = min_latency;
1490
1491     pa_assert(!min_latency || !max_latency ||
1492               min_latency <= max_latency);
1493
1494     if (PA_SINK_IS_LINKED(s->state)) {
1495         pa_usec_t r[2];
1496
1497         r[0] = min_latency;
1498         r[1] = max_latency;
1499
1500         pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_LATENCY_RANGE, r, 0, NULL) == 0);
1501     } else {
1502         s->thread_info.min_latency = min_latency;
1503         s->thread_info.max_latency = max_latency;
1504
1505         s->monitor_source->thread_info.min_latency = min_latency;
1506         s->monitor_source->thread_info.max_latency = max_latency;
1507
1508         s->thread_info.requested_latency_valid = s->monitor_source->thread_info.requested_latency_valid = FALSE;
1509     }
1510 }
1511
1512 /* Called from main thread */
1513 void pa_sink_get_latency_range(pa_sink *s, pa_usec_t *min_latency, pa_usec_t *max_latency) {
1514    pa_sink_assert_ref(s);
1515    pa_assert(min_latency);
1516    pa_assert(max_latency);
1517
1518    if (PA_SINK_IS_LINKED(s->state)) {
1519        pa_usec_t r[2] = { 0, 0 };
1520
1521        pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_LATENCY_RANGE, r, 0, NULL) == 0);
1522
1523        *min_latency = r[0];
1524        *max_latency = r[1];
1525    } else {
1526        *min_latency = s->thread_info.min_latency;
1527        *max_latency = s->thread_info.max_latency;
1528    }
1529 }
1530
1531 /* Called from IO thread */
1532 void pa_sink_update_latency_range(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency) {
1533     pa_sink_input *i;
1534     void *state = NULL;
1535
1536     pa_sink_assert_ref(s);
1537
1538     s->thread_info.min_latency = min_latency;
1539     s->thread_info.max_latency = max_latency;
1540
1541     while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL)))
1542         if (i->update_sink_latency_range)
1543             i->update_sink_latency_range(i);
1544
1545     pa_sink_invalidate_requested_latency(s);
1546
1547     pa_source_update_latency_range(s->monitor_source, min_latency, max_latency);
1548 }
1549
1550 size_t pa_sink_get_max_rewind(pa_sink *s) {
1551     size_t r;
1552     pa_sink_assert_ref(s);
1553
1554     if (!PA_SINK_IS_LINKED(s->state))
1555         return s->thread_info.max_rewind;
1556
1557     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_MAX_REWIND, &r, 0, NULL) == 0);
1558
1559     return r;
1560 }
1561
1562 size_t pa_sink_get_max_request(pa_sink *s) {
1563     size_t r;
1564     pa_sink_assert_ref(s);
1565
1566     if (!PA_SINK_IS_LINKED(s->state))
1567         return s->thread_info.max_request;
1568
1569     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_MAX_REQUEST, &r, 0, NULL) == 0);
1570
1571     return r;
1572 }