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.1 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, see <http://www.gnu.org/licenses/>.
  19 ***/
  20
  21 #ifdef HAVE_CONFIG_H
  22 #include <config.h>
  23 #endif
  24
  25 #include <stdio.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28
  29 #include <pulse/introspect.h>
  30 #include <pulse/format.h>
  31 #include <pulse/utf8.h>
  32 #include <pulse/xmalloc.h>
  33 #include <pulse/timeval.h>
  34 #include <pulse/util.h>
  35 #include <pulse/rtclock.h>
  36 #include <pulse/internal.h>
  37
  38 #include <pulsecore/i18n.h>
  39 #include <pulsecore/sink-input.h>
  40 #include <pulsecore/namereg.h>
  41 #include <pulsecore/core-util.h>
  42 #include <pulsecore/sample-util.h>
  43 #include <pulsecore/mix.h>
  44 #include <pulsecore/core-subscribe.h>
  45 #include <pulsecore/log.h>
  46 #include <pulsecore/macro.h>
  47 #include <pulsecore/play-memblockq.h>
  48 #include <pulsecore/flist.h>
  49
  50 #include "sink.h"
  51
  52 #define MAX_MIX_CHANNELS 32
  53 #define MIX_BUFFER_LENGTH (pa_page_size())
  54 #define ABSOLUTE_MIN_LATENCY (500)
  55 #define ABSOLUTE_MAX_LATENCY (10*PA_USEC_PER_SEC)
  56 #define DEFAULT_FIXED_LATENCY (250*PA_USEC_PER_MSEC)
  57
  58 PA_DEFINE_PUBLIC_CLASS(pa_sink, pa_msgobject);
  59
  60 struct pa_sink_volume_change {
  61     pa_usec_t at;
  62     pa_cvolume hw_volume;
  63
  64     PA_LLIST_FIELDS(pa_sink_volume_change);
  65 };
  66
  67 struct sink_message_set_port {
  68     pa_device_port *port;
  69     int ret;
  70 };
  71
  72 static void sink_free(pa_object *s);
  73
  74 static void pa_sink_volume_change_push(pa_sink *s);
  75 static void pa_sink_volume_change_flush(pa_sink *s);
  76 static void pa_sink_volume_change_rewind(pa_sink *s, size_t nbytes);
  77
  78 pa_sink_new_data* pa_sink_new_data_init(pa_sink_new_data *data) {
  79     pa_assert(data);
  80
  81     pa_zero(*data);
  82     data->proplist = pa_proplist_new();
  83     data->ports = pa_hashmap_new_full(pa_idxset_string_hash_func, pa_idxset_string_compare_func, NULL, (pa_free_cb_t) pa_device_port_unref);
  84
  85     return data;
  86 }
  87
  88 void pa_sink_new_data_set_name(pa_sink_new_data *data, const char *name) {
  89     pa_assert(data);
  90
  91     pa_xfree(data->name);
  92     data->name = pa_xstrdup(name);
  93 }
  94
  95 void pa_sink_new_data_set_sample_spec(pa_sink_new_data *data, const pa_sample_spec *spec) {
  96     pa_assert(data);
  97
  98     if ((data->sample_spec_is_set = !!spec))
  99         data->sample_spec = *spec;
 100 }
 101
 102 void pa_sink_new_data_set_channel_map(pa_sink_new_data *data, const pa_channel_map *map) {
 103     pa_assert(data);
 104
 105     if ((data->channel_map_is_set = !!map))
 106         data->channel_map = *map;
 107 }
 108
 109 void pa_sink_new_data_set_alternate_sample_rate(pa_sink_new_data *data, const uint32_t alternate_sample_rate) {
 110     pa_assert(data);
 111
 112     data->alternate_sample_rate_is_set = true;
 113     data->alternate_sample_rate = alternate_sample_rate;
 114 }
 115
 116 void pa_sink_new_data_set_volume(pa_sink_new_data *data, const pa_cvolume *volume) {
 117     pa_assert(data);
 118
 119     if ((data->volume_is_set = !!volume))
 120         data->volume = *volume;
 121 }
 122
 123 void pa_sink_new_data_set_muted(pa_sink_new_data *data, bool mute) {
 124     pa_assert(data);
 125
 126     data->muted_is_set = true;
 127     data->muted = mute;
 128 }
 129
 130 void pa_sink_new_data_set_port(pa_sink_new_data *data, const char *port) {
 131     pa_assert(data);
 132
 133     pa_xfree(data->active_port);
 134     data->active_port = pa_xstrdup(port);
 135 }
 136
 137 void pa_sink_new_data_done(pa_sink_new_data *data) {
 138     pa_assert(data);
 139
 140     pa_proplist_free(data->proplist);
 141
 142     if (data->ports)
 143         pa_hashmap_free(data->ports);
 144
 145     pa_xfree(data->name);
 146     pa_xfree(data->active_port);
 147 }
 148
 149 /* Called from main context */
 150 static void reset_callbacks(pa_sink *s) {
 151     pa_assert(s);
 152
 153     s->set_state = NULL;
 154     s->get_volume = NULL;
 155     s->set_volume = NULL;
 156     s->write_volume = NULL;
 157     s->get_mute = NULL;
 158     s->set_mute = NULL;
 159     s->request_rewind = NULL;
 160     s->update_requested_latency = NULL;
 161     s->set_port = NULL;
 162     s->get_formats = NULL;
 163     s->set_formats = NULL;
 164     s->update_rate = NULL;
 165 }
 166
 167 /* Called from main context */
 168 pa_sink* pa_sink_new(
 169         pa_core *core,
 170         pa_sink_new_data *data,
 171         pa_sink_flags_t flags) {
 172
 173     pa_sink *s;
 174     const char *name;
 175     char st[PA_SAMPLE_SPEC_SNPRINT_MAX], cm[PA_CHANNEL_MAP_SNPRINT_MAX];
 176     pa_source_new_data source_data;
 177     const char *dn;
 178     char *pt;
 179
 180     pa_assert(core);
 181     pa_assert(data);
 182     pa_assert(data->name);
 183     pa_assert_ctl_context();
 184
 185     s = pa_msgobject_new(pa_sink);
 186
 187     if (!(name = pa_namereg_register(core, data->name, PA_NAMEREG_SINK, s, data->namereg_fail))) {
 188         pa_log_debug("Failed to register name %s.", data->name);
 189         pa_xfree(s);
 190         return NULL;
 191     }
 192
 193     pa_sink_new_data_set_name(data, name);
 194
 195     if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_NEW], data) < 0) {
 196         pa_xfree(s);
 197         pa_namereg_unregister(core, name);
 198         return NULL;
 199     }
 200
 201     /* FIXME, need to free s here on failure */
 202
 203     pa_return_null_if_fail(!data->driver || pa_utf8_valid(data->driver));
 204     pa_return_null_if_fail(data->name && pa_utf8_valid(data->name) && data->name[0]);
 205
 206     pa_return_null_if_fail(data->sample_spec_is_set && pa_sample_spec_valid(&data->sample_spec));
 207
 208     if (!data->channel_map_is_set)
 209         pa_return_null_if_fail(pa_channel_map_init_auto(&data->channel_map, data->sample_spec.channels, PA_CHANNEL_MAP_DEFAULT));
 210
 211     pa_return_null_if_fail(pa_channel_map_valid(&data->channel_map));
 212     pa_return_null_if_fail(data->channel_map.channels == data->sample_spec.channels);
 213
 214     /* FIXME: There should probably be a general function for checking whether
 215      * the sink volume is allowed to be set, like there is for sink inputs. */
 216     pa_assert(!data->volume_is_set || !(flags & PA_SINK_SHARE_VOLUME_WITH_MASTER));
 217
 218     if (!data->volume_is_set) {
 219         pa_cvolume_reset(&data->volume, data->sample_spec.channels);
 220         data->save_volume = false;
 221     }
 222
 223     pa_return_null_if_fail(pa_cvolume_valid(&data->volume));
 224     pa_return_null_if_fail(pa_cvolume_compatible(&data->volume, &data->sample_spec));
 225
 226     if (!data->muted_is_set)
 227         data->muted = false;
 228
 229     if (data->card)
 230         pa_proplist_update(data->proplist, PA_UPDATE_MERGE, data->card->proplist);
 231
 232     pa_device_init_description(data->proplist, data->card);
 233     pa_device_init_icon(data->proplist, true);
 234     pa_device_init_intended_roles(data->proplist);
 235
 236     if (!data->active_port) {
 237         pa_device_port *p = pa_device_port_find_best(data->ports);
 238         if (p)
 239             pa_sink_new_data_set_port(data, p->name);
 240     }
 241
 242     if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_FIXATE], data) < 0) {
 243         pa_xfree(s);
 244         pa_namereg_unregister(core, name);
 245         return NULL;
 246     }
 247
 248     s->parent.parent.free = sink_free;
 249     s->parent.process_msg = pa_sink_process_msg;
 250
 251     s->core = core;
 252     s->state = PA_SINK_INIT;
 253     s->flags = flags;
 254     s->priority = 0;
 255     s->suspend_cause = data->suspend_cause;
 256     pa_sink_set_mixer_dirty(s, false);
 257     s->name = pa_xstrdup(name);
 258     s->proplist = pa_proplist_copy(data->proplist);
 259     s->driver = pa_xstrdup(pa_path_get_filename(data->driver));
 260     s->module = data->module;
 261     s->card = data->card;
 262
 263     s->priority = pa_device_init_priority(s->proplist);
 264
 265     s->sample_spec = data->sample_spec;
 266     s->channel_map = data->channel_map;
 267     s->default_sample_rate = s->sample_spec.rate;
 268
 269     if (data->alternate_sample_rate_is_set)
 270         s->alternate_sample_rate = data->alternate_sample_rate;
 271     else
 272         s->alternate_sample_rate = s->core->alternate_sample_rate;
 273
 274     if (s->sample_spec.rate == s->alternate_sample_rate) {
 275         pa_log_warn("Default and alternate sample rates are the same.");
 276         s->alternate_sample_rate = 0;
 277     }
 278
 279     s->inputs = pa_idxset_new(NULL, NULL);
 280     s->n_corked = 0;
 281     s->input_to_master = NULL;
 282
 283     s->reference_volume = s->real_volume = data->volume;
 284     pa_cvolume_reset(&s->soft_volume, s->sample_spec.channels);
 285     s->base_volume = PA_VOLUME_NORM;
 286     s->n_volume_steps = PA_VOLUME_NORM+1;
 287     s->muted = data->muted;
 288     s->refresh_volume = s->refresh_muted = false;
 289
 290     reset_callbacks(s);
 291     s->userdata = NULL;
 292
 293     s->asyncmsgq = NULL;
 294
 295     /* As a minor optimization we just steal the list instead of
 296      * copying it here */
 297     s->ports = data->ports;
 298     data->ports = NULL;
 299
 300     s->active_port = NULL;
 301     s->save_port = false;
 302
 303     if (data->active_port)
 304         if ((s->active_port = pa_hashmap_get(s->ports, data->active_port)))
 305             s->save_port = data->save_port;
 306
 307     /* Hopefully the active port has already been assigned in the previous call
 308        to pa_device_port_find_best, but better safe than sorry */
 309     if (!s->active_port)
 310         s->active_port = pa_device_port_find_best(s->ports);
 311
 312     if (s->active_port)
 313         s->port_latency_offset = s->active_port->latency_offset;
 314     else
 315         s->port_latency_offset = 0;
 316
 317     s->save_volume = data->save_volume;
 318     s->save_muted = data->save_muted;
 319
 320     pa_silence_memchunk_get(
 321             &core->silence_cache,
 322             core->mempool,
 323             &s->silence,
 324             &s->sample_spec,
 325             0);
 326
 327     s->thread_info.rtpoll = NULL;
 328     s->thread_info.inputs = pa_hashmap_new_full(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func, NULL,
 329                                                 (pa_free_cb_t) pa_sink_input_unref);
 330     s->thread_info.soft_volume =  s->soft_volume;
 331     s->thread_info.soft_muted = s->muted;
 332     s->thread_info.state = s->state;
 333     s->thread_info.rewind_nbytes = 0;
 334     s->thread_info.rewind_requested = false;
 335     s->thread_info.max_rewind = 0;
 336     s->thread_info.max_request = 0;
 337     s->thread_info.requested_latency_valid = false;
 338     s->thread_info.requested_latency = 0;
 339     s->thread_info.min_latency = ABSOLUTE_MIN_LATENCY;
 340     s->thread_info.max_latency = ABSOLUTE_MAX_LATENCY;
 341     s->thread_info.fixed_latency = flags & PA_SINK_DYNAMIC_LATENCY ? 0 : DEFAULT_FIXED_LATENCY;
 342
 343     PA_LLIST_HEAD_INIT(pa_sink_volume_change, s->thread_info.volume_changes);
 344     s->thread_info.volume_changes_tail = NULL;
 345     pa_sw_cvolume_multiply(&s->thread_info.current_hw_volume, &s->soft_volume, &s->real_volume);
 346     s->thread_info.volume_change_safety_margin = core->deferred_volume_safety_margin_usec;
 347     s->thread_info.volume_change_extra_delay = core->deferred_volume_extra_delay_usec;
 348     s->thread_info.port_latency_offset = s->port_latency_offset;
 349
 350     /* FIXME: This should probably be moved to pa_sink_put() */
 351     pa_assert_se(pa_idxset_put(core->sinks, s, &s->index) >= 0);
 352
 353     if (s->card)
 354         pa_assert_se(pa_idxset_put(s->card->sinks, s, NULL) >= 0);
 355
 356     pt = pa_proplist_to_string_sep(s->proplist, "\n    ");
 357     pa_log_info("Created sink %u \"%s\" with sample spec %s and channel map %s\n    %s",
 358                 s->index,
 359                 s->name,
 360                 pa_sample_spec_snprint(st, sizeof(st), &s->sample_spec),
 361                 pa_channel_map_snprint(cm, sizeof(cm), &s->channel_map),
 362                 pt);
 363     pa_xfree(pt);
 364
 365     pa_source_new_data_init(&source_data);
 366     pa_source_new_data_set_sample_spec(&source_data, &s->sample_spec);
 367     pa_source_new_data_set_channel_map(&source_data, &s->channel_map);
 368     pa_source_new_data_set_alternate_sample_rate(&source_data, s->alternate_sample_rate);
 369     source_data.name = pa_sprintf_malloc("%s.monitor", name);
 370     source_data.driver = data->driver;
 371     source_data.module = data->module;
 372     source_data.card = data->card;
 373
 374     dn = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
 375     pa_proplist_setf(source_data.proplist, PA_PROP_DEVICE_DESCRIPTION, "Monitor of %s", dn ? dn : s->name);
 376     pa_proplist_sets(source_data.proplist, PA_PROP_DEVICE_CLASS, "monitor");
 377
 378     s->monitor_source = pa_source_new(core, &source_data,
 379                                       ((flags & PA_SINK_LATENCY) ? PA_SOURCE_LATENCY : 0) |
 380                                       ((flags & PA_SINK_DYNAMIC_LATENCY) ? PA_SOURCE_DYNAMIC_LATENCY : 0));
 381
 382     pa_source_new_data_done(&source_data);
 383
 384     if (!s->monitor_source) {
 385         pa_sink_unlink(s);
 386         pa_sink_unref(s);
 387         return NULL;
 388     }
 389
 390     s->monitor_source->monitor_of = s;
 391
 392     pa_source_set_latency_range(s->monitor_source, s->thread_info.min_latency, s->thread_info.max_latency);
 393     pa_source_set_fixed_latency(s->monitor_source, s->thread_info.fixed_latency);
 394     pa_source_set_max_rewind(s->monitor_source, s->thread_info.max_rewind);
 395
 396     return s;
 397 }
 398
 399 /* Called from main context */
 400 static int sink_set_state(pa_sink *s, pa_sink_state_t state) {
 401     int ret;
 402     bool suspend_change;
 403     pa_sink_state_t original_state;
 404
 405     pa_assert(s);
 406     pa_assert_ctl_context();
 407
 408     if (s->state == state)
 409         return 0;
 410
 411     original_state = s->state;
 412
 413     suspend_change =
 414         (original_state == PA_SINK_SUSPENDED && PA_SINK_IS_OPENED(state)) ||
 415         (PA_SINK_IS_OPENED(original_state) && state == PA_SINK_SUSPENDED);
 416
 417     if (s->set_state)
 418         if ((ret = s->set_state(s, state)) < 0)
 419             return ret;
 420
 421     if (s->asyncmsgq)
 422         if ((ret = pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL)) < 0) {
 423
 424             if (s->set_state)
 425                 s->set_state(s, original_state);
 426
 427             return ret;
 428         }
 429
 430     s->state = state;
 431
 432     if (state != PA_SINK_UNLINKED) { /* if we enter UNLINKED state pa_sink_unlink() will fire the appropriate events */
 433         pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_STATE_CHANGED], s);
 434         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK | PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 435     }
 436
 437     if (suspend_change) {
 438         pa_sink_input *i;
 439         uint32_t idx;
 440
 441         /* We're suspending or resuming, tell everyone about it */
 442
 443         PA_IDXSET_FOREACH(i, s->inputs, idx)
 444             if (s->state == PA_SINK_SUSPENDED &&
 445                 (i->flags & PA_SINK_INPUT_KILL_ON_SUSPEND))
 446                 pa_sink_input_kill(i);
 447             else if (i->suspend)
 448                 i->suspend(i, state == PA_SINK_SUSPENDED);
 449
 450         if (s->monitor_source)
 451             pa_source_sync_suspend(s->monitor_source);
 452     }
 453
 454     return 0;
 455 }
 456
 457 void pa_sink_set_get_volume_callback(pa_sink *s, pa_sink_cb_t cb) {
 458     pa_assert(s);
 459
 460     s->get_volume = cb;
 461 }
 462
 463 void pa_sink_set_set_volume_callback(pa_sink *s, pa_sink_cb_t cb) {
 464     pa_sink_flags_t flags;
 465
 466     pa_assert(s);
 467     pa_assert(!s->write_volume || cb);
 468
 469     s->set_volume = cb;
 470
 471     /* Save the current flags so we can tell if they've changed */
 472     flags = s->flags;
 473
 474     if (cb) {
 475         /* The sink implementor is responsible for setting decibel volume support */
 476         s->flags |= PA_SINK_HW_VOLUME_CTRL;
 477     } else {
 478         s->flags &= ~PA_SINK_HW_VOLUME_CTRL;
 479         /* See note below in pa_sink_put() about volume sharing and decibel volumes */
 480         pa_sink_enable_decibel_volume(s, !(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER));
 481     }
 482
 483     /* If the flags have changed after init, let any clients know via a change event */
 484     if (s->state != PA_SINK_INIT && flags != s->flags)
 485         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 486 }
 487
 488 void pa_sink_set_write_volume_callback(pa_sink *s, pa_sink_cb_t cb) {
 489     pa_sink_flags_t flags;
 490
 491     pa_assert(s);
 492     pa_assert(!cb || s->set_volume);
 493
 494     s->write_volume = cb;
 495
 496     /* Save the current flags so we can tell if they've changed */
 497     flags = s->flags;
 498
 499     if (cb)
 500         s->flags |= PA_SINK_DEFERRED_VOLUME;
 501     else
 502         s->flags &= ~PA_SINK_DEFERRED_VOLUME;
 503
 504     /* If the flags have changed after init, let any clients know via a change event */
 505     if (s->state != PA_SINK_INIT && flags != s->flags)
 506         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 507 }
 508
 509 void pa_sink_set_get_mute_callback(pa_sink *s, pa_sink_get_mute_cb_t cb) {
 510     pa_assert(s);
 511
 512     s->get_mute = cb;
 513 }
 514
 515 void pa_sink_set_set_mute_callback(pa_sink *s, pa_sink_cb_t cb) {
 516     pa_sink_flags_t flags;
 517
 518     pa_assert(s);
 519
 520     s->set_mute = cb;
 521
 522     /* Save the current flags so we can tell if they've changed */
 523     flags = s->flags;
 524
 525     if (cb)
 526         s->flags |= PA_SINK_HW_MUTE_CTRL;
 527     else
 528         s->flags &= ~PA_SINK_HW_MUTE_CTRL;
 529
 530     /* If the flags have changed after init, let any clients know via a change event */
 531     if (s->state != PA_SINK_INIT && flags != s->flags)
 532         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 533 }
 534
 535 static void enable_flat_volume(pa_sink *s, bool enable) {
 536     pa_sink_flags_t flags;
 537
 538     pa_assert(s);
 539
 540     /* Always follow the overall user preference here */
 541     enable = enable && s->core->flat_volumes;
 542
 543     /* Save the current flags so we can tell if they've changed */
 544     flags = s->flags;
 545
 546     if (enable)
 547         s->flags |= PA_SINK_FLAT_VOLUME;
 548     else
 549         s->flags &= ~PA_SINK_FLAT_VOLUME;
 550
 551     /* If the flags have changed after init, let any clients know via a change event */
 552     if (s->state != PA_SINK_INIT && flags != s->flags)
 553         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 554 }
 555
 556 void pa_sink_enable_decibel_volume(pa_sink *s, bool enable) {
 557     pa_sink_flags_t flags;
 558
 559     pa_assert(s);
 560
 561     /* Save the current flags so we can tell if they've changed */
 562     flags = s->flags;
 563
 564     if (enable) {
 565         s->flags |= PA_SINK_DECIBEL_VOLUME;
 566         enable_flat_volume(s, true);
 567     } else {
 568         s->flags &= ~PA_SINK_DECIBEL_VOLUME;
 569         enable_flat_volume(s, false);
 570     }
 571
 572     /* If the flags have changed after init, let any clients know via a change event */
 573     if (s->state != PA_SINK_INIT && flags != s->flags)
 574         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 575 }
 576
 577 /* Called from main context */
 578 void pa_sink_put(pa_sink* s) {
 579     pa_sink_assert_ref(s);
 580     pa_assert_ctl_context();
 581
 582     pa_assert(s->state == PA_SINK_INIT);
 583     pa_assert(!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER) || pa_sink_is_filter(s));
 584
 585     /* The following fields must be initialized properly when calling _put() */
 586     pa_assert(s->asyncmsgq);
 587     pa_assert(s->thread_info.min_latency <= s->thread_info.max_latency);
 588
 589     /* Generally, flags should be initialized via pa_sink_new(). As a
 590      * special exception we allow some volume related flags to be set
 591      * between _new() and _put() by the callback setter functions above.
 592      *
 593      * Thus we implement a couple safeguards here which ensure the above
 594      * setters were used (or at least the implementor made manual changes
 595      * in a compatible way).
 596      *
 597      * Note: All of these flags set here can change over the life time
 598      * of the sink. */
 599     pa_assert(!(s->flags & PA_SINK_HW_VOLUME_CTRL) || s->set_volume);
 600     pa_assert(!(s->flags & PA_SINK_DEFERRED_VOLUME) || s->write_volume);
 601     pa_assert(!(s->flags & PA_SINK_HW_MUTE_CTRL) || s->set_mute);
 602
 603     /* XXX: Currently decibel volume is disabled for all sinks that use volume
 604      * sharing. When the master sink supports decibel volume, it would be good
 605      * to have the flag also in the filter sink, but currently we don't do that
 606      * so that the flags of the filter sink never change when it's moved from
 607      * a master sink to another. One solution for this problem would be to
 608      * remove user-visible volume altogether from filter sinks when volume
 609      * sharing is used, but the current approach was easier to implement... */
 610     /* We always support decibel volumes in software, otherwise we leave it to
 611      * the sink implementor to set this flag as needed.
 612      *
 613      * Note: This flag can also change over the life time of the sink. */
 614     if (!(s->flags & PA_SINK_HW_VOLUME_CTRL) && !(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) {
 615         pa_sink_enable_decibel_volume(s, true);
 616         s->soft_volume = s->reference_volume;
 617     }
 618
 619     /* If the sink implementor support DB volumes by itself, we should always
 620      * try and enable flat volumes too */
 621     if ((s->flags & PA_SINK_DECIBEL_VOLUME))
 622         enable_flat_volume(s, true);
 623
 624     if (s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER) {
 625         pa_sink *root_sink = pa_sink_get_master(s);
 626
 627         pa_assert(root_sink);
 628
 629         s->reference_volume = root_sink->reference_volume;
 630         pa_cvolume_remap(&s->reference_volume, &root_sink->channel_map, &s->channel_map);
 631
 632         s->real_volume = root_sink->real_volume;
 633         pa_cvolume_remap(&s->real_volume, &root_sink->channel_map, &s->channel_map);
 634     } else
 635         /* We assume that if the sink implementor changed the default
 636          * volume he did so in real_volume, because that is the usual
 637          * place where he is supposed to place his changes.  */
 638         s->reference_volume = s->real_volume;
 639
 640     s->thread_info.soft_volume = s->soft_volume;
 641     s->thread_info.soft_muted = s->muted;
 642     pa_sw_cvolume_multiply(&s->thread_info.current_hw_volume, &s->soft_volume, &s->real_volume);
 643
 644     pa_assert((s->flags & PA_SINK_HW_VOLUME_CTRL)
 645               || (s->base_volume == PA_VOLUME_NORM
 646                   && ((s->flags & PA_SINK_DECIBEL_VOLUME || (s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)))));
 647     pa_assert(!(s->flags & PA_SINK_DECIBEL_VOLUME) || s->n_volume_steps == PA_VOLUME_NORM+1);
 648     pa_assert(!(s->flags & PA_SINK_DYNAMIC_LATENCY) == !(s->thread_info.fixed_latency == 0));
 649     pa_assert(!(s->flags & PA_SINK_LATENCY) == !(s->monitor_source->flags & PA_SOURCE_LATENCY));
 650     pa_assert(!(s->flags & PA_SINK_DYNAMIC_LATENCY) == !(s->monitor_source->flags & PA_SOURCE_DYNAMIC_LATENCY));
 651
 652     pa_assert(s->monitor_source->thread_info.fixed_latency == s->thread_info.fixed_latency);
 653     pa_assert(s->monitor_source->thread_info.min_latency == s->thread_info.min_latency);
 654     pa_assert(s->monitor_source->thread_info.max_latency == s->thread_info.max_latency);
 655
 656     if (s->suspend_cause)
 657         pa_assert_se(sink_set_state(s, PA_SINK_SUSPENDED) == 0);
 658     else
 659         pa_assert_se(sink_set_state(s, PA_SINK_IDLE) == 0);
 660
 661     pa_source_put(s->monitor_source);
 662
 663     pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK | PA_SUBSCRIPTION_EVENT_NEW, s->index);
 664     pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_PUT], s);
 665 }
 666
 667 /* Called from main context */
 668 void pa_sink_unlink(pa_sink* s) {
 669     bool linked;
 670     pa_sink_input *i, PA_UNUSED *j = NULL;
 671
 672     pa_sink_assert_ref(s);
 673     pa_assert_ctl_context();
 674
 675     /* Please note that pa_sink_unlink() does more than simply
 676      * reversing pa_sink_put(). It also undoes the registrations
 677      * already done in pa_sink_new()! */
 678
 679     if (s->unlink_requested)
 680         return;
 681
 682     s->unlink_requested = true;
 683
 684     linked = PA_SINK_IS_LINKED(s->state);
 685
 686     if (linked)
 687         pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_UNLINK], s);
 688
 689     if (s->state != PA_SINK_UNLINKED)
 690         pa_namereg_unregister(s->core, s->name);
 691     pa_idxset_remove_by_data(s->core->sinks, s, NULL);
 692
 693     if (s->card)
 694         pa_idxset_remove_by_data(s->card->sinks, s, NULL);
 695
 696     while ((i = pa_idxset_first(s->inputs, NULL))) {
 697         pa_assert(i != j);
 698         pa_sink_input_kill(i);
 699         j = i;
 700     }
 701
 702     if (linked)
 703         sink_set_state(s, PA_SINK_UNLINKED);
 704     else
 705         s->state = PA_SINK_UNLINKED;
 706
 707     reset_callbacks(s);
 708
 709     if (s->monitor_source)
 710         pa_source_unlink(s->monitor_source);
 711
 712     if (linked) {
 713         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK | PA_SUBSCRIPTION_EVENT_REMOVE, s->index);
 714         pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_UNLINK_POST], s);
 715     }
 716 }
 717
 718 /* Called from main context */
 719 static void sink_free(pa_object *o) {
 720     pa_sink *s = PA_SINK(o);
 721
 722     pa_assert(s);
 723     pa_assert_ctl_context();
 724     pa_assert(pa_sink_refcnt(s) == 0);
 725     pa_assert(!PA_SINK_IS_LINKED(s->state));
 726
 727     pa_log_info("Freeing sink %u \"%s\"", s->index, s->name);
 728
 729     pa_sink_volume_change_flush(s);
 730
 731     if (s->monitor_source) {
 732         pa_source_unref(s->monitor_source);
 733         s->monitor_source = NULL;
 734     }
 735
 736     pa_idxset_free(s->inputs, NULL);
 737     pa_hashmap_free(s->thread_info.inputs);
 738
 739     if (s->silence.memblock)
 740         pa_memblock_unref(s->silence.memblock);
 741
 742     pa_xfree(s->name);
 743     pa_xfree(s->driver);
 744
 745     if (s->proplist)
 746         pa_proplist_free(s->proplist);
 747
 748     if (s->ports)
 749         pa_hashmap_free(s->ports);
 750
 751     pa_xfree(s);
 752 }
 753
 754 /* Called from main context, and not while the IO thread is active, please */
 755 void pa_sink_set_asyncmsgq(pa_sink *s, pa_asyncmsgq *q) {
 756     pa_sink_assert_ref(s);
 757     pa_assert_ctl_context();
 758
 759     s->asyncmsgq = q;
 760
 761     if (s->monitor_source)
 762         pa_source_set_asyncmsgq(s->monitor_source, q);
 763 }
 764
 765 /* Called from main context, and not while the IO thread is active, please */
 766 void pa_sink_update_flags(pa_sink *s, pa_sink_flags_t mask, pa_sink_flags_t value) {
 767     pa_sink_flags_t old_flags;
 768     pa_sink_input *input;
 769     uint32_t idx;
 770
 771     pa_sink_assert_ref(s);
 772     pa_assert_ctl_context();
 773
 774     /* For now, allow only a minimal set of flags to be changed. */
 775     pa_assert((mask & ~(PA_SINK_DYNAMIC_LATENCY|PA_SINK_LATENCY)) == 0);
 776
 777     old_flags = s->flags;
 778     s->flags = (s->flags & ~mask) | (value & mask);
 779
 780     if (s->flags == old_flags)
 781         return;
 782
 783     if ((s->flags & PA_SINK_LATENCY) != (old_flags & PA_SINK_LATENCY))
 784         pa_log_debug("Sink %s: LATENCY flag %s.", s->name, (s->flags & PA_SINK_LATENCY) ? "enabled" : "disabled");
 785
 786     if ((s->flags & PA_SINK_DYNAMIC_LATENCY) != (old_flags & PA_SINK_DYNAMIC_LATENCY))
 787         pa_log_debug("Sink %s: DYNAMIC_LATENCY flag %s.",
 788                      s->name, (s->flags & PA_SINK_DYNAMIC_LATENCY) ? "enabled" : "disabled");
 789
 790     pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK | PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 791     pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_FLAGS_CHANGED], s);
 792
 793     if (s->monitor_source)
 794         pa_source_update_flags(s->monitor_source,
 795                                ((mask & PA_SINK_LATENCY) ? PA_SOURCE_LATENCY : 0) |
 796                                ((mask & PA_SINK_DYNAMIC_LATENCY) ? PA_SOURCE_DYNAMIC_LATENCY : 0),
 797                                ((value & PA_SINK_LATENCY) ? PA_SOURCE_LATENCY : 0) |
 798                                ((value & PA_SINK_DYNAMIC_LATENCY) ? PA_SOURCE_DYNAMIC_LATENCY : 0));
 799
 800     PA_IDXSET_FOREACH(input, s->inputs, idx) {
 801         if (input->origin_sink)
 802             pa_sink_update_flags(input->origin_sink, mask, value);
 803     }
 804 }
 805
 806 /* Called from IO context, or before _put() from main context */
 807 void pa_sink_set_rtpoll(pa_sink *s, pa_rtpoll *p) {
 808     pa_sink_assert_ref(s);
 809     pa_sink_assert_io_context(s);
 810
 811     s->thread_info.rtpoll = p;
 812
 813     if (s->monitor_source)
 814         pa_source_set_rtpoll(s->monitor_source, p);
 815 }
 816
 817 /* Called from main context */
 818 int pa_sink_update_status(pa_sink*s) {
 819     pa_sink_assert_ref(s);
 820     pa_assert_ctl_context();
 821     pa_assert(PA_SINK_IS_LINKED(s->state));
 822
 823     if (s->state == PA_SINK_SUSPENDED)
 824         return 0;
 825
 826     return sink_set_state(s, pa_sink_used_by(s) ? PA_SINK_RUNNING : PA_SINK_IDLE);
 827 }
 828
 829 /* Called from any context - must be threadsafe */
 830 void pa_sink_set_mixer_dirty(pa_sink *s, bool is_dirty) {
 831     pa_atomic_store(&s->mixer_dirty, is_dirty ? 1 : 0);
 832 }
 833
 834 /* Called from main context */
 835 int pa_sink_suspend(pa_sink *s, bool suspend, pa_suspend_cause_t cause) {
 836     pa_sink_assert_ref(s);
 837     pa_assert_ctl_context();
 838     pa_assert(PA_SINK_IS_LINKED(s->state));
 839     pa_assert(cause != 0);
 840
 841     if (suspend) {
 842         s->suspend_cause |= cause;
 843         s->monitor_source->suspend_cause |= cause;
 844     } else {
 845         s->suspend_cause &= ~cause;
 846         s->monitor_source->suspend_cause &= ~cause;
 847     }
 848
 849     if (!(s->suspend_cause & PA_SUSPEND_SESSION) && (pa_atomic_load(&s->mixer_dirty) != 0)) {
 850         /* This might look racy but isn't: If somebody sets mixer_dirty exactly here,
 851            it'll be handled just fine. */
 852         pa_sink_set_mixer_dirty(s, false);
 853         pa_log_debug("Mixer is now accessible. Updating alsa mixer settings.");
 854         if (s->active_port && s->set_port) {
 855             if (s->flags & PA_SINK_DEFERRED_VOLUME) {
 856                 struct sink_message_set_port msg = { .port = s->active_port, .ret = 0 };
 857                 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_PORT, &msg, 0, NULL) == 0);
 858             }
 859             else
 860                 s->set_port(s, s->active_port);
 861         }
 862         else {
 863             if (s->set_mute)
 864                 s->set_mute(s);
 865             if (s->set_volume)
 866                 s->set_volume(s);
 867         }
 868     }
 869
 870     if ((pa_sink_get_state(s) == PA_SINK_SUSPENDED) == !!s->suspend_cause)
 871         return 0;
 872
 873     pa_log_debug("Suspend cause of sink %s is 0x%04x, %s", s->name, s->suspend_cause, s->suspend_cause ? "suspending" : "resuming");
 874
 875     if (s->suspend_cause)
 876         return sink_set_state(s, PA_SINK_SUSPENDED);
 877     else
 878         return sink_set_state(s, pa_sink_used_by(s) ? PA_SINK_RUNNING : PA_SINK_IDLE);
 879 }
 880
 881 /* Called from main context */
 882 pa_queue *pa_sink_move_all_start(pa_sink *s, pa_queue *q) {
 883     pa_sink_input *i, *n;
 884     uint32_t idx;
 885
 886     pa_sink_assert_ref(s);
 887     pa_assert_ctl_context();
 888     pa_assert(PA_SINK_IS_LINKED(s->state));
 889
 890     if (!q)
 891         q = pa_queue_new();
 892
 893     for (i = PA_SINK_INPUT(pa_idxset_first(s->inputs, &idx)); i; i = n) {
 894         n = PA_SINK_INPUT(pa_idxset_next(s->inputs, &idx));
 895
 896         pa_sink_input_ref(i);
 897
 898         if (pa_sink_input_start_move(i) >= 0)
 899             pa_queue_push(q, i);
 900         else
 901             pa_sink_input_unref(i);
 902     }
 903
 904     return q;
 905 }
 906
 907 /* Called from main context */
 908 void pa_sink_move_all_finish(pa_sink *s, pa_queue *q, bool save) {
 909     pa_sink_input *i;
 910
 911     pa_sink_assert_ref(s);
 912     pa_assert_ctl_context();
 913     pa_assert(PA_SINK_IS_LINKED(s->state));
 914     pa_assert(q);
 915
 916     while ((i = PA_SINK_INPUT(pa_queue_pop(q)))) {
 917         if (pa_sink_input_finish_move(i, s, save) < 0)
 918             pa_sink_input_fail_move(i);
 919
 920         pa_sink_input_unref(i);
 921     }
 922
 923     pa_queue_free(q, NULL);
 924 }
 925
 926 /* Called from main context */
 927 void pa_sink_move_all_fail(pa_queue *q) {
 928     pa_sink_input *i;
 929
 930     pa_assert_ctl_context();
 931     pa_assert(q);
 932
 933     while ((i = PA_SINK_INPUT(pa_queue_pop(q)))) {
 934         pa_sink_input_fail_move(i);
 935         pa_sink_input_unref(i);
 936     }
 937
 938     pa_queue_free(q, NULL);
 939 }
 940
 941  /* Called from IO thread context */
 942 size_t pa_sink_process_input_underruns(pa_sink *s, size_t left_to_play) {
 943     pa_sink_input *i;
 944     void *state = NULL;
 945     size_t result = 0;
 946
 947     pa_sink_assert_ref(s);
 948     pa_sink_assert_io_context(s);
 949
 950     PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state) {
 951         size_t uf = i->thread_info.underrun_for_sink;
 952
 953         /* Propagate down the filter tree */
 954         if (i->origin_sink) {
 955             size_t filter_result, left_to_play_origin;
 956
 957             /* The recursive call works in the origin sink domain ... */
 958             left_to_play_origin = pa_convert_size(left_to_play, &i->sink->sample_spec, &i->origin_sink->sample_spec);
 959
 960             /* .. and returns the time to sleep before waking up. We need the
 961              * underrun duration for comparisons, so we undo the subtraction on
 962              * the return value... */
 963             filter_result = left_to_play_origin - pa_sink_process_input_underruns(i->origin_sink, left_to_play_origin);
 964
 965             /* ... and convert it back to the master sink domain */
 966             filter_result = pa_convert_size(filter_result, &i->origin_sink->sample_spec, &i->sink->sample_spec);
 967
 968             /* Remember the longest underrun so far */
 969             if (filter_result > result)
 970                 result = filter_result;
 971         }
 972
 973         if (uf == 0) {
 974             /* No underrun here, move on */
 975             continue;
 976         } else if (uf >= left_to_play) {
 977             /* The sink has possibly consumed all the data the sink input provided */
 978             pa_sink_input_process_underrun(i);
 979         } else if (uf > result) {
 980             /* Remember the longest underrun so far */
 981             result = uf;
 982         }
 983     }
 984
 985     if (result > 0)
 986         pa_log_debug("%s: Found underrun %ld bytes ago (%ld bytes ahead in playback buffer)", s->name,
 987                 (long) result, (long) left_to_play - result);
 988     return left_to_play - result;
 989 }
 990
 991 /* Called from IO thread context */
 992 void pa_sink_process_rewind(pa_sink *s, size_t nbytes) {
 993     pa_sink_input *i;
 994     void *state = NULL;
 995
 996     pa_sink_assert_ref(s);
 997     pa_sink_assert_io_context(s);
 998     pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
 999
1000     /* If nobody requested this and this is actually no real rewind
1001      * then we can short cut this. Please note that this means that
1002      * not all rewind requests triggered upstream will always be
1003      * translated in actual requests! */
1004     if (!s->thread_info.rewind_requested && nbytes <= 0)
1005         return;
1006
1007     s->thread_info.rewind_nbytes = 0;
1008     s->thread_info.rewind_requested = false;
1009
1010     if (nbytes > 0) {
1011         pa_log_debug("Processing rewind...");
1012         if (s->flags & PA_SINK_DEFERRED_VOLUME)
1013             pa_sink_volume_change_rewind(s, nbytes);
1014     }
1015
1016     PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state) {
1017         pa_sink_input_assert_ref(i);
1018         pa_sink_input_process_rewind(i, nbytes);
1019     }
1020
1021     if (nbytes > 0) {
1022         if (s->monitor_source && PA_SOURCE_IS_LINKED(s->monitor_source->thread_info.state))
1023             pa_source_process_rewind(s->monitor_source, nbytes);
1024     }
1025 }
1026
1027 /* Called from IO thread context */
1028 static unsigned fill_mix_info(pa_sink *s, size_t *length, pa_mix_info *info, unsigned maxinfo) {
1029     pa_sink_input *i;
1030     unsigned n = 0;
1031     void *state = NULL;
1032     size_t mixlength = *length;
1033
1034     pa_sink_assert_ref(s);
1035     pa_sink_assert_io_context(s);
1036     pa_assert(info);
1037
1038     while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL)) && maxinfo > 0) {
1039         pa_sink_input_assert_ref(i);
1040
1041         pa_sink_input_peek(i, *length, &info->chunk, &info->volume);
1042
1043         if (mixlength == 0 || info->chunk.length < mixlength)
1044             mixlength = info->chunk.length;
1045
1046         if (pa_memblock_is_silence(info->chunk.memblock)) {
1047             pa_memblock_unref(info->chunk.memblock);
1048             continue;
1049         }
1050
1051         info->userdata = pa_sink_input_ref(i);
1052
1053         pa_assert(info->chunk.memblock);
1054         pa_assert(info->chunk.length > 0);
1055
1056         info++;
1057         n++;
1058         maxinfo--;
1059     }
1060
1061     if (mixlength > 0)
1062         *length = mixlength;
1063
1064     return n;
1065 }
1066
1067 /* Called from IO thread context */
1068 static void inputs_drop(pa_sink *s, pa_mix_info *info, unsigned n, pa_memchunk *result) {
1069     pa_sink_input *i;
1070     void *state;
1071     unsigned p = 0;
1072     unsigned n_unreffed = 0;
1073
1074     pa_sink_assert_ref(s);
1075     pa_sink_assert_io_context(s);
1076     pa_assert(result);
1077     pa_assert(result->memblock);
1078     pa_assert(result->length > 0);
1079
1080     /* We optimize for the case where the order of the inputs has not changed */
1081
1082     PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state) {
1083         unsigned j;
1084         pa_mix_info* m = NULL;
1085
1086         pa_sink_input_assert_ref(i);
1087
1088         /* Let's try to find the matching entry info the pa_mix_info array */
1089         for (j = 0; j < n; j ++) {
1090
1091             if (info[p].userdata == i) {
1092                 m = info + p;
1093                 break;
1094             }
1095
1096             p++;
1097             if (p >= n)
1098                 p = 0;
1099         }
1100
1101         /* Drop read data */
1102         pa_sink_input_drop(i, result->length);
1103
1104         if (s->monitor_source && PA_SOURCE_IS_LINKED(s->monitor_source->thread_info.state)) {
1105
1106             if (pa_hashmap_size(i->thread_info.direct_outputs) > 0) {
1107                 void *ostate = NULL;
1108                 pa_source_output *o;
1109                 pa_memchunk c;
1110
1111                 if (m && m->chunk.memblock) {
1112                     c = m->chunk;
1113                     pa_memblock_ref(c.memblock);
1114                     pa_assert(result->length <= c.length);
1115                     c.length = result->length;
1116
1117                     pa_memchunk_make_writable(&c, 0);
1118                     pa_volume_memchunk(&c, &s->sample_spec, &m->volume);
1119                 } else {
1120                     c = s->silence;
1121                     pa_memblock_ref(c.memblock);
1122                     pa_assert(result->length <= c.length);
1123                     c.length = result->length;
1124                 }
1125
1126                 while ((o = pa_hashmap_iterate(i->thread_info.direct_outputs, &ostate, NULL))) {
1127                     pa_source_output_assert_ref(o);
1128                     pa_assert(o->direct_on_input == i);
1129                     pa_source_post_direct(s->monitor_source, o, &c);
1130                 }
1131
1132                 pa_memblock_unref(c.memblock);
1133             }
1134         }
1135
1136         if (m) {
1137             if (m->chunk.memblock) {
1138                 pa_memblock_unref(m->chunk.memblock);
1139                 pa_memchunk_reset(&m->chunk);
1140             }
1141
1142             pa_sink_input_unref(m->userdata);
1143             m->userdata = NULL;
1144
1145             n_unreffed += 1;
1146         }
1147     }
1148
1149     /* Now drop references to entries that are included in the
1150      * pa_mix_info array but don't exist anymore */
1151
1152     if (n_unreffed < n) {
1153         for (; n > 0; info++, n--) {
1154             if (info->userdata)
1155                 pa_sink_input_unref(info->userdata);
1156             if (info->chunk.memblock)
1157                 pa_memblock_unref(info->chunk.memblock);
1158         }
1159     }
1160
1161     if (s->monitor_source && PA_SOURCE_IS_LINKED(s->monitor_source->thread_info.state))
1162         pa_source_post(s->monitor_source, result);
1163 }
1164
1165 /* Called from IO thread context */
1166 void pa_sink_render(pa_sink*s, size_t length, pa_memchunk *result) {
1167     pa_mix_info info[MAX_MIX_CHANNELS];
1168     unsigned n;
1169     size_t block_size_max;
1170
1171     pa_sink_assert_ref(s);
1172     pa_sink_assert_io_context(s);
1173     pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1174     pa_assert(pa_frame_aligned(length, &s->sample_spec));
1175     pa_assert(result);
1176
1177     pa_assert(!s->thread_info.rewind_requested);
1178     pa_assert(s->thread_info.rewind_nbytes == 0);
1179
1180     if (s->thread_info.state == PA_SINK_SUSPENDED) {
1181         result->memblock = pa_memblock_ref(s->silence.memblock);
1182         result->index = s->silence.index;
1183         result->length = PA_MIN(s->silence.length, length);
1184         return;
1185     }
1186
1187     pa_sink_ref(s);
1188
1189     if (length <= 0)
1190         length = pa_frame_align(MIX_BUFFER_LENGTH, &s->sample_spec);
1191
1192     block_size_max = pa_mempool_block_size_max(s->core->mempool);
1193     if (length > block_size_max)
1194         length = pa_frame_align(block_size_max, &s->sample_spec);
1195
1196     pa_assert(length > 0);
1197
1198     n = fill_mix_info(s, &length, info, MAX_MIX_CHANNELS);
1199
1200     if (n == 0) {
1201
1202         *result = s->silence;
1203         pa_memblock_ref(result->memblock);
1204
1205         if (result->length > length)
1206             result->length = length;
1207
1208     } else if (n == 1) {
1209         pa_cvolume volume;
1210
1211         *result = info[0].chunk;
1212         pa_memblock_ref(result->memblock);
1213
1214         if (result->length > length)
1215             result->length = length;
1216
1217         pa_sw_cvolume_multiply(&volume, &s->thread_info.soft_volume, &info[0].volume);
1218
1219         if (s->thread_info.soft_muted || pa_cvolume_is_muted(&volume)) {
1220             pa_memblock_unref(result->memblock);
1221             pa_silence_memchunk_get(&s->core->silence_cache,
1222                                     s->core->mempool,
1223                                     result,
1224                                     &s->sample_spec,
1225                                     result->length);
1226         } else if (!pa_cvolume_is_norm(&volume)) {
1227             pa_memchunk_make_writable(result, 0);
1228             pa_volume_memchunk(result, &s->sample_spec, &volume);
1229         }
1230     } else {
1231         void *ptr;
1232         result->memblock = pa_memblock_new(s->core->mempool, length);
1233
1234         ptr = pa_memblock_acquire(result->memblock);
1235         result->length = pa_mix(info, n,
1236                                 ptr, length,
1237                                 &s->sample_spec,
1238                                 &s->thread_info.soft_volume,
1239                                 s->thread_info.soft_muted);
1240         pa_memblock_release(result->memblock);
1241
1242         result->index = 0;
1243     }
1244
1245     inputs_drop(s, info, n, result);
1246
1247     pa_sink_unref(s);
1248 }
1249
1250 /* Called from IO thread context */
1251 void pa_sink_render_into(pa_sink*s, pa_memchunk *target) {
1252     pa_mix_info info[MAX_MIX_CHANNELS];
1253     unsigned n;
1254     size_t length, block_size_max;
1255
1256     pa_sink_assert_ref(s);
1257     pa_sink_assert_io_context(s);
1258     pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1259     pa_assert(target);
1260     pa_assert(target->memblock);
1261     pa_assert(target->length > 0);
1262     pa_assert(pa_frame_aligned(target->length, &s->sample_spec));
1263
1264     pa_assert(!s->thread_info.rewind_requested);
1265     pa_assert(s->thread_info.rewind_nbytes == 0);
1266
1267     if (s->thread_info.state == PA_SINK_SUSPENDED) {
1268         pa_silence_memchunk(target, &s->sample_spec);
1269         return;
1270     }
1271
1272     pa_sink_ref(s);
1273
1274     length = target->length;
1275     block_size_max = pa_mempool_block_size_max(s->core->mempool);
1276     if (length > block_size_max)
1277         length = pa_frame_align(block_size_max, &s->sample_spec);
1278
1279     pa_assert(length > 0);
1280
1281     n = fill_mix_info(s, &length, info, MAX_MIX_CHANNELS);
1282
1283     if (n == 0) {
1284         if (target->length > length)
1285             target->length = length;
1286
1287         pa_silence_memchunk(target, &s->sample_spec);
1288     } else if (n == 1) {
1289         pa_cvolume volume;
1290
1291         if (target->length > length)
1292             target->length = length;
1293
1294         pa_sw_cvolume_multiply(&volume, &s->thread_info.soft_volume, &info[0].volume);
1295
1296         if (s->thread_info.soft_muted || pa_cvolume_is_muted(&volume))
1297             pa_silence_memchunk(target, &s->sample_spec);
1298         else {
1299             pa_memchunk vchunk;
1300
1301             vchunk = info[0].chunk;
1302             pa_memblock_ref(vchunk.memblock);
1303
1304             if (vchunk.length > length)
1305                 vchunk.length = length;
1306
1307             if (!pa_cvolume_is_norm(&volume)) {
1308                 pa_memchunk_make_writable(&vchunk, 0);
1309                 pa_volume_memchunk(&vchunk, &s->sample_spec, &volume);
1310             }
1311
1312             pa_memchunk_memcpy(target, &vchunk);
1313             pa_memblock_unref(vchunk.memblock);
1314         }
1315
1316     } else {
1317         void *ptr;
1318
1319         ptr = pa_memblock_acquire(target->memblock);
1320
1321         target->length = pa_mix(info, n,
1322                                 (uint8_t*) ptr + target->index, length,
1323                                 &s->sample_spec,
1324                                 &s->thread_info.soft_volume,
1325                                 s->thread_info.soft_muted);
1326
1327         pa_memblock_release(target->memblock);
1328     }
1329
1330     inputs_drop(s, info, n, target);
1331
1332     pa_sink_unref(s);
1333 }
1334
1335 /* Called from IO thread context */
1336 void pa_sink_render_into_full(pa_sink *s, pa_memchunk *target) {
1337     pa_memchunk chunk;
1338     size_t l, d;
1339
1340     pa_sink_assert_ref(s);
1341     pa_sink_assert_io_context(s);
1342     pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1343     pa_assert(target);
1344     pa_assert(target->memblock);
1345     pa_assert(target->length > 0);
1346     pa_assert(pa_frame_aligned(target->length, &s->sample_spec));
1347
1348     pa_assert(!s->thread_info.rewind_requested);
1349     pa_assert(s->thread_info.rewind_nbytes == 0);
1350
1351     if (s->thread_info.state == PA_SINK_SUSPENDED) {
1352         pa_silence_memchunk(target, &s->sample_spec);
1353         return;
1354     }
1355
1356     pa_sink_ref(s);
1357
1358     l = target->length;
1359     d = 0;
1360     while (l > 0) {
1361         chunk = *target;
1362         chunk.index += d;
1363         chunk.length -= d;
1364
1365         pa_sink_render_into(s, &chunk);
1366
1367         d += chunk.length;
1368         l -= chunk.length;
1369     }
1370
1371     pa_sink_unref(s);
1372 }
1373
1374 /* Called from IO thread context */
1375 void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result) {
1376     pa_sink_assert_ref(s);
1377     pa_sink_assert_io_context(s);
1378     pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1379     pa_assert(length > 0);
1380     pa_assert(pa_frame_aligned(length, &s->sample_spec));
1381     pa_assert(result);
1382
1383     pa_assert(!s->thread_info.rewind_requested);
1384     pa_assert(s->thread_info.rewind_nbytes == 0);
1385
1386     pa_sink_ref(s);
1387
1388     pa_sink_render(s, length, result);
1389
1390     if (result->length < length) {
1391         pa_memchunk chunk;
1392
1393         pa_memchunk_make_writable(result, length);
1394
1395         chunk.memblock = result->memblock;
1396         chunk.index = result->index + result->length;
1397         chunk.length = length - result->length;
1398
1399         pa_sink_render_into_full(s, &chunk);
1400
1401         result->length = length;
1402     }
1403
1404     pa_sink_unref(s);
1405 }
1406
1407 /* Called from main thread */
1408 int pa_sink_update_rate(pa_sink *s, uint32_t rate, bool passthrough) {
1409     int ret = -1;
1410     uint32_t desired_rate = rate;
1411     uint32_t default_rate = s->default_sample_rate;
1412     uint32_t alternate_rate = s->alternate_sample_rate;
1413     uint32_t idx;
1414     pa_sink_input *i;
1415     bool default_rate_is_usable = false;
1416     bool alternate_rate_is_usable = false;
1417
1418     if (rate == s->sample_spec.rate)
1419         return 0;
1420
1421     if (!s->update_rate)
1422         return -1;
1423
1424     if (PA_UNLIKELY(default_rate == alternate_rate && !passthrough)) {
1425         pa_log_debug("Default and alternate sample rates are the same, so there is no point in switching.");
1426         return -1;
1427     }
1428
1429     if (PA_SINK_IS_RUNNING(s->state)) {
1430         pa_log_info("Cannot update rate, SINK_IS_RUNNING, will keep using %u Hz",
1431                     s->sample_spec.rate);
1432         return -1;
1433     }
1434
1435     if (s->monitor_source) {
1436         if (PA_SOURCE_IS_RUNNING(s->monitor_source->state) == true) {
1437             pa_log_info("Cannot update rate, monitor source is RUNNING");
1438             return -1;
1439         }
1440     }
1441
1442     if (PA_UNLIKELY(!pa_sample_rate_valid(desired_rate)))
1443         return -1;
1444
1445     if (!passthrough && default_rate != desired_rate && alternate_rate != desired_rate) {
1446         if (default_rate % 11025 == 0 && desired_rate % 11025 == 0)
1447             default_rate_is_usable = true;
1448         if (default_rate % 4000 == 0 && desired_rate % 4000 == 0)
1449             default_rate_is_usable = true;
1450         if (alternate_rate && alternate_rate % 11025 == 0 && desired_rate % 11025 == 0)
1451             alternate_rate_is_usable = true;
1452         if (alternate_rate && alternate_rate % 4000 == 0 && desired_rate % 4000 == 0)
1453             alternate_rate_is_usable = true;
1454
1455         if (alternate_rate_is_usable && !default_rate_is_usable)
1456             desired_rate = alternate_rate;
1457         else
1458             desired_rate = default_rate;
1459     }
1460
1461     if (desired_rate == s->sample_spec.rate)
1462         return -1;
1463
1464     if (!passthrough && pa_sink_used_by(s) > 0)
1465         return -1;
1466
1467     pa_log_debug("Suspending sink %s due to changing the sample rate.", s->name);
1468     pa_sink_suspend(s, true, PA_SUSPEND_INTERNAL);
1469
1470     if (s->update_rate(s, desired_rate) >= 0) {
1471         /* update monitor source as well */
1472         if (s->monitor_source && !passthrough)
1473             pa_source_update_rate(s->monitor_source, desired_rate, false);
1474         pa_log_info("Changed sampling rate successfully");
1475
1476         PA_IDXSET_FOREACH(i, s->inputs, idx) {
1477             if (i->state == PA_SINK_INPUT_CORKED)
1478                 pa_sink_input_update_rate(i);
1479         }
1480
1481         ret = 0;
1482     }
1483
1484     pa_sink_suspend(s, false, PA_SUSPEND_INTERNAL);
1485
1486     return ret;
1487 }
1488
1489 /* Called from main thread */
1490 pa_usec_t pa_sink_get_latency(pa_sink *s) {
1491     pa_usec_t usec = 0;
1492
1493     pa_sink_assert_ref(s);
1494     pa_assert_ctl_context();
1495     pa_assert(PA_SINK_IS_LINKED(s->state));
1496
1497     /* The returned value is supposed to be in the time domain of the sound card! */
1498
1499     if (s->state == PA_SINK_SUSPENDED)
1500         return 0;
1501
1502     if (!(s->flags & PA_SINK_LATENCY))
1503         return 0;
1504
1505     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_LATENCY, &usec, 0, NULL) == 0);
1506
1507     /* usec is unsigned, so check that the offset can be added to usec without
1508      * underflowing. */
1509     if (-s->port_latency_offset <= (int64_t) usec)
1510         usec += s->port_latency_offset;
1511     else
1512         usec = 0;
1513
1514     return usec;
1515 }
1516
1517 /* Called from IO thread */
1518 pa_usec_t pa_sink_get_latency_within_thread(pa_sink *s) {
1519     pa_usec_t usec = 0;
1520     pa_msgobject *o;
1521
1522     pa_sink_assert_ref(s);
1523     pa_sink_assert_io_context(s);
1524     pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1525
1526     /* The returned value is supposed to be in the time domain of the sound card! */
1527
1528     if (s->thread_info.state == PA_SINK_SUSPENDED)
1529         return 0;
1530
1531     if (!(s->flags & PA_SINK_LATENCY))
1532         return 0;
1533
1534     o = PA_MSGOBJECT(s);
1535
1536     /* FIXME: We probably should make this a proper vtable callback instead of going through process_msg() */
1537
1538     if (o->process_msg(o, PA_SINK_MESSAGE_GET_LATENCY, &usec, 0, NULL) < 0)
1539         return -1;
1540
1541     /* usec is unsigned, so check that the offset can be added to usec without
1542      * underflowing. */
1543     if (-s->thread_info.port_latency_offset <= (int64_t) usec)
1544         usec += s->thread_info.port_latency_offset;
1545     else
1546         usec = 0;
1547
1548     return usec;
1549 }
1550
1551 /* Called from the main thread (and also from the IO thread while the main
1552  * thread is waiting).
1553  *
1554  * When a sink uses volume sharing, it never has the PA_SINK_FLAT_VOLUME flag
1555  * set. Instead, flat volume mode is detected by checking whether the root sink
1556  * has the flag set. */
1557 bool pa_sink_flat_volume_enabled(pa_sink *s) {
1558     pa_sink_assert_ref(s);
1559
1560     s = pa_sink_get_master(s);
1561
1562     if (PA_LIKELY(s))
1563         return (s->flags & PA_SINK_FLAT_VOLUME);
1564     else
1565         return false;
1566 }
1567
1568 /* Called from the main thread (and also from the IO thread while the main
1569  * thread is waiting). */
1570 pa_sink *pa_sink_get_master(pa_sink *s) {
1571     pa_sink_assert_ref(s);
1572
1573     while (s && (s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) {
1574         if (PA_UNLIKELY(!s->input_to_master))
1575             return NULL;
1576
1577         s = s->input_to_master->sink;
1578     }
1579
1580     return s;
1581 }
1582
1583 /* Called from main context */
1584 bool pa_sink_is_filter(pa_sink *s) {
1585     pa_sink_assert_ref(s);
1586
1587     return (s->input_to_master != NULL);
1588 }
1589
1590 /* Called from main context */
1591 bool pa_sink_is_passthrough(pa_sink *s) {
1592     pa_sink_input *alt_i;
1593     uint32_t idx;
1594
1595     pa_sink_assert_ref(s);
1596
1597     /* one and only one PASSTHROUGH input can possibly be connected */
1598     if (pa_idxset_size(s->inputs) == 1) {
1599         alt_i = pa_idxset_first(s->inputs, &idx);
1600
1601         if (pa_sink_input_is_passthrough(alt_i))
1602             return true;
1603     }
1604
1605     return false;
1606 }
1607
1608 /* Called from main context */
1609 void pa_sink_enter_passthrough(pa_sink *s) {
1610     pa_cvolume volume;
1611
1612     /* disable the monitor in passthrough mode */
1613     if (s->monitor_source) {
1614         pa_log_debug("Suspending monitor source %s, because the sink is entering the passthrough mode.", s->monitor_source->name);
1615         pa_source_suspend(s->monitor_source, true, PA_SUSPEND_PASSTHROUGH);
1616     }
1617
1618     /* set the volume to NORM */
1619     s->saved_volume = *pa_sink_get_volume(s, true);
1620     s->saved_save_volume = s->save_volume;
1621
1622     pa_cvolume_set(&volume, s->sample_spec.channels, PA_MIN(s->base_volume, PA_VOLUME_NORM));
1623     pa_sink_set_volume(s, &volume, true, false);
1624 }
1625
1626 /* Called from main context */
1627 void pa_sink_leave_passthrough(pa_sink *s) {
1628     /* Unsuspend monitor */
1629     if (s->monitor_source) {
1630         pa_log_debug("Resuming monitor source %s, because the sink is leaving the passthrough mode.", s->monitor_source->name);
1631         pa_source_suspend(s->monitor_source, false, PA_SUSPEND_PASSTHROUGH);
1632     }
1633
1634     /* Restore sink volume to what it was before we entered passthrough mode */
1635     pa_sink_set_volume(s, &s->saved_volume, true, s->saved_save_volume);
1636
1637     pa_cvolume_init(&s->saved_volume);
1638     s->saved_save_volume = false;
1639 }
1640
1641 /* Called from main context. */
1642 static void compute_reference_ratio(pa_sink_input *i) {
1643     unsigned c = 0;
1644     pa_cvolume remapped;
1645     pa_cvolume ratio;
1646
1647     pa_assert(i);
1648     pa_assert(pa_sink_flat_volume_enabled(i->sink));
1649
1650     /*
1651      * Calculates the reference ratio from the sink's reference
1652      * volume. This basically calculates:
1653      *
1654      * i->reference_ratio = i->volume / i->sink->reference_volume
1655      */
1656
1657     remapped = i->sink->reference_volume;
1658     pa_cvolume_remap(&remapped, &i->sink->channel_map, &i->channel_map);
1659
1660     ratio = i->reference_ratio;
1661
1662     for (c = 0; c < i->sample_spec.channels; c++) {
1663
1664         /* We don't update when the sink volume is 0 anyway */
1665         if (remapped.values[c] <= PA_VOLUME_MUTED)
1666             continue;
1667
1668         /* Don't update the reference ratio unless necessary */
1669         if (pa_sw_volume_multiply(
1670                     ratio.values[c],
1671                     remapped.values[c]) == i->volume.values[c])
1672             continue;
1673
1674         ratio.values[c] = pa_sw_volume_divide(
1675                 i->volume.values[c],
1676                 remapped.values[c]);
1677     }
1678
1679     pa_sink_input_set_reference_ratio(i, &ratio);
1680 }
1681
1682 /* Called from main context. Only called for the root sink in volume sharing
1683  * cases, except for internal recursive calls. */
1684 static void compute_reference_ratios(pa_sink *s) {
1685     uint32_t idx;
1686     pa_sink_input *i;
1687
1688     pa_sink_assert_ref(s);
1689     pa_assert_ctl_context();
1690     pa_assert(PA_SINK_IS_LINKED(s->state));
1691     pa_assert(pa_sink_flat_volume_enabled(s));
1692
1693     PA_IDXSET_FOREACH(i, s->inputs, idx) {
1694         compute_reference_ratio(i);
1695
1696         if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER))
1697             compute_reference_ratios(i->origin_sink);
1698     }
1699 }
1700
1701 /* Called from main context. Only called for the root sink in volume sharing
1702  * cases, except for internal recursive calls. */
1703 static void compute_real_ratios(pa_sink *s) {
1704     pa_sink_input *i;
1705     uint32_t idx;
1706
1707     pa_sink_assert_ref(s);
1708     pa_assert_ctl_context();
1709     pa_assert(PA_SINK_IS_LINKED(s->state));
1710     pa_assert(pa_sink_flat_volume_enabled(s));
1711
1712     PA_IDXSET_FOREACH(i, s->inputs, idx) {
1713         unsigned c;
1714         pa_cvolume remapped;
1715
1716         if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) {
1717             /* The origin sink uses volume sharing, so this input's real ratio
1718              * is handled as a special case - the real ratio must be 0 dB, and
1719              * as a result i->soft_volume must equal i->volume_factor. */
1720             pa_cvolume_reset(&i->real_ratio, i->real_ratio.channels);
1721             i->soft_volume = i->volume_factor;
1722
1723             compute_real_ratios(i->origin_sink);
1724
1725             continue;
1726         }
1727
1728         /*
1729          * This basically calculates:
1730          *
1731          * i->real_ratio := i->volume / s->real_volume
1732          * i->soft_volume := i->real_ratio * i->volume_factor
1733          */
1734
1735         remapped = s->real_volume;
1736         pa_cvolume_remap(&remapped, &s->channel_map, &i->channel_map);
1737
1738         i->real_ratio.channels = i->sample_spec.channels;
1739         i->soft_volume.channels = i->sample_spec.channels;
1740
1741         for (c = 0; c < i->sample_spec.channels; c++) {
1742
1743             if (remapped.values[c] <= PA_VOLUME_MUTED) {
1744                 /* We leave i->real_ratio untouched */
1745                 i->soft_volume.values[c] = PA_VOLUME_MUTED;
1746                 continue;
1747             }
1748
1749             /* Don't lose accuracy unless necessary */
1750             if (pa_sw_volume_multiply(
1751                         i->real_ratio.values[c],
1752                         remapped.values[c]) != i->volume.values[c])
1753
1754                 i->real_ratio.values[c] = pa_sw_volume_divide(
1755                         i->volume.values[c],
1756                         remapped.values[c]);
1757
1758             i->soft_volume.values[c] = pa_sw_volume_multiply(
1759                     i->real_ratio.values[c],
1760                     i->volume_factor.values[c]);
1761         }
1762
1763         /* We don't copy the soft_volume to the thread_info data
1764          * here. That must be done by the caller */
1765     }
1766 }
1767
1768 static pa_cvolume *cvolume_remap_minimal_impact(
1769         pa_cvolume *v,
1770         const pa_cvolume *template,
1771         const pa_channel_map *from,
1772         const pa_channel_map *to) {
1773
1774     pa_cvolume t;
1775
1776     pa_assert(v);
1777     pa_assert(template);
1778     pa_assert(from);
1779     pa_assert(to);
1780     pa_assert(pa_cvolume_compatible_with_channel_map(v, from));
1781     pa_assert(pa_cvolume_compatible_with_channel_map(template, to));
1782
1783     /* Much like pa_cvolume_remap(), but tries to minimize impact when
1784      * mapping from sink input to sink volumes:
1785      *
1786      * If template is a possible remapping from v it is used instead
1787      * of remapping anew.
1788      *
1789      * If the channel maps don't match we set an all-channel volume on
1790      * the sink to ensure that changing a volume on one stream has no
1791      * effect that cannot be compensated for in another stream that
1792      * does not have the same channel map as the sink. */
1793
1794     if (pa_channel_map_equal(from, to))
1795         return v;
1796
1797     t = *template;
1798     if (pa_cvolume_equal(pa_cvolume_remap(&t, to, from), v)) {
1799         *v = *template;
1800         return v;
1801     }
1802
1803     pa_cvolume_set(v, to->channels, pa_cvolume_max(v));
1804     return v;
1805 }
1806
1807 /* Called from main thread. Only called for the root sink in volume sharing
1808  * cases, except for internal recursive calls. */
1809 static void get_maximum_input_volume(pa_sink *s, pa_cvolume *max_volume, const pa_channel_map *channel_map) {
1810     pa_sink_input *i;
1811     uint32_t idx;
1812
1813     pa_sink_assert_ref(s);
1814     pa_assert(max_volume);
1815     pa_assert(channel_map);
1816     pa_assert(pa_sink_flat_volume_enabled(s));
1817
1818     PA_IDXSET_FOREACH(i, s->inputs, idx) {
1819         pa_cvolume remapped;
1820
1821         if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) {
1822             get_maximum_input_volume(i->origin_sink, max_volume, channel_map);
1823
1824             /* Ignore this input. The origin sink uses volume sharing, so this
1825              * input's volume will be set to be equal to the root sink's real
1826              * volume. Obviously this input's current volume must not then
1827              * affect what the root sink's real volume will be. */
1828             continue;
1829         }
1830
1831         remapped = i->volume;
1832         cvolume_remap_minimal_impact(&remapped, max_volume, &i->channel_map, channel_map);
1833         pa_cvolume_merge(max_volume, max_volume, &remapped);
1834     }
1835 }
1836
1837 /* Called from main thread. Only called for the root sink in volume sharing
1838  * cases, except for internal recursive calls. */
1839 static bool has_inputs(pa_sink *s) {
1840     pa_sink_input *i;
1841     uint32_t idx;
1842
1843     pa_sink_assert_ref(s);
1844
1845     PA_IDXSET_FOREACH(i, s->inputs, idx) {
1846         if (!i->origin_sink || !(i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER) || has_inputs(i->origin_sink))
1847             return true;
1848     }
1849
1850     return false;
1851 }
1852
1853 /* Called from main thread. Only called for the root sink in volume sharing
1854  * cases, except for internal recursive calls. */
1855 static void update_real_volume(pa_sink *s, const pa_cvolume *new_volume, pa_channel_map *channel_map) {
1856     pa_sink_input *i;
1857     uint32_t idx;
1858
1859     pa_sink_assert_ref(s);
1860     pa_assert(new_volume);
1861     pa_assert(channel_map);
1862
1863     s->real_volume = *new_volume;
1864     pa_cvolume_remap(&s->real_volume, channel_map, &s->channel_map);
1865
1866     PA_IDXSET_FOREACH(i, s->inputs, idx) {
1867         if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) {
1868             if (pa_sink_flat_volume_enabled(s)) {
1869                 pa_cvolume new_input_volume;
1870
1871                 /* Follow the root sink's real volume. */
1872                 new_input_volume = *new_volume;
1873                 pa_cvolume_remap(&new_input_volume, channel_map, &i->channel_map);
1874                 pa_sink_input_set_volume_direct(i, &new_input_volume);
1875                 compute_reference_ratio(i);
1876             }
1877
1878             update_real_volume(i->origin_sink, new_volume, channel_map);
1879         }
1880     }
1881 }
1882
1883 /* Called from main thread. Only called for the root sink in shared volume
1884  * cases. */
1885 static void compute_real_volume(pa_sink *s) {
1886     pa_sink_assert_ref(s);
1887     pa_assert_ctl_context();
1888     pa_assert(PA_SINK_IS_LINKED(s->state));
1889     pa_assert(pa_sink_flat_volume_enabled(s));
1890     pa_assert(!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER));
1891
1892     /* This determines the maximum volume of all streams and sets
1893      * s->real_volume accordingly. */
1894
1895     if (!has_inputs(s)) {
1896         /* In the special case that we have no sink inputs we leave the
1897          * volume unmodified. */
1898         update_real_volume(s, &s->reference_volume, &s->channel_map);
1899         return;
1900     }
1901
1902     pa_cvolume_mute(&s->real_volume, s->channel_map.channels);
1903
1904     /* First let's determine the new maximum volume of all inputs
1905      * connected to this sink */
1906     get_maximum_input_volume(s, &s->real_volume, &s->channel_map);
1907     update_real_volume(s, &s->real_volume, &s->channel_map);
1908
1909     /* Then, let's update the real ratios/soft volumes of all inputs
1910      * connected to this sink */
1911     compute_real_ratios(s);
1912 }
1913
1914 /* Called from main thread. Only called for the root sink in shared volume
1915  * cases, except for internal recursive calls. */
1916 static void propagate_reference_volume(pa_sink *s) {
1917     pa_sink_input *i;
1918     uint32_t idx;
1919
1920     pa_sink_assert_ref(s);
1921     pa_assert_ctl_context();
1922     pa_assert(PA_SINK_IS_LINKED(s->state));
1923     pa_assert(pa_sink_flat_volume_enabled(s));
1924
1925     /* This is called whenever the sink volume changes that is not
1926      * caused by a sink input volume change. We need to fix up the
1927      * sink input volumes accordingly */
1928
1929     PA_IDXSET_FOREACH(i, s->inputs, idx) {
1930         pa_cvolume new_volume;
1931
1932         if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) {
1933             propagate_reference_volume(i->origin_sink);
1934
1935             /* Since the origin sink uses volume sharing, this input's volume
1936              * needs to be updated to match the root sink's real volume, but
1937              * that will be done later in update_shared_real_volume(). */
1938             continue;
1939         }
1940
1941         /* This basically calculates:
1942          *
1943          * i->volume := s->reference_volume * i->reference_ratio  */
1944
1945         new_volume = s->reference_volume;
1946         pa_cvolume_remap(&new_volume, &s->channel_map, &i->channel_map);
1947         pa_sw_cvolume_multiply(&new_volume, &new_volume, &i->reference_ratio);
1948         pa_sink_input_set_volume_direct(i, &new_volume);
1949     }
1950 }
1951
1952 /* Called from main thread. Only called for the root sink in volume sharing
1953  * cases, except for internal recursive calls. The return value indicates
1954  * whether any reference volume actually changed. */
1955 static bool update_reference_volume(pa_sink *s, const pa_cvolume *v, const pa_channel_map *channel_map, bool save) {
1956     pa_cvolume volume;
1957     bool reference_volume_changed;
1958     pa_sink_input *i;
1959     uint32_t idx;
1960
1961     pa_sink_assert_ref(s);
1962     pa_assert(PA_SINK_IS_LINKED(s->state));
1963     pa_assert(v);
1964     pa_assert(channel_map);
1965     pa_assert(pa_cvolume_valid(v));
1966
1967     volume = *v;
1968     pa_cvolume_remap(&volume, channel_map, &s->channel_map);
1969
1970     reference_volume_changed = !pa_cvolume_equal(&volume, &s->reference_volume);
1971     pa_sink_set_reference_volume_direct(s, &volume);
1972
1973     s->save_volume = (!reference_volume_changed && s->save_volume) || save;
1974
1975     if (!reference_volume_changed && !(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER))
1976         /* If the root sink's volume doesn't change, then there can't be any
1977          * changes in the other sinks in the sink tree either.
1978          *
1979          * It's probably theoretically possible that even if the root sink's
1980          * volume changes slightly, some filter sink doesn't change its volume
1981          * due to rounding errors. If that happens, we still want to propagate
1982          * the changed root sink volume to the sinks connected to the
1983          * intermediate sink that didn't change its volume. This theoretical
1984          * possibility is the reason why we have that !(s->flags &
1985          * PA_SINK_SHARE_VOLUME_WITH_MASTER) condition. Probably nobody would
1986          * notice even if we returned here false always if
1987          * reference_volume_changed is false. */
1988         return false;
1989
1990     PA_IDXSET_FOREACH(i, s->inputs, idx) {
1991         if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER))
1992             update_reference_volume(i->origin_sink, v, channel_map, false);
1993     }
1994
1995     return true;
1996 }
1997
1998 /* Called from main thread */
1999 void pa_sink_set_volume(
2000         pa_sink *s,
2001         const pa_cvolume *volume,
2002         bool send_msg,
2003         bool save) {
2004
2005     pa_cvolume new_reference_volume;
2006     pa_sink *root_sink;
2007
2008     pa_sink_assert_ref(s);
2009     pa_assert_ctl_context();
2010     pa_assert(PA_SINK_IS_LINKED(s->state));
2011     pa_assert(!volume || pa_cvolume_valid(volume));
2012     pa_assert(volume || pa_sink_flat_volume_enabled(s));
2013     pa_assert(!volume || volume->channels == 1 || pa_cvolume_compatible(volume, &s->sample_spec));
2014
2015     /* make sure we don't change the volume when a PASSTHROUGH input is connected ...
2016      * ... *except* if we're being invoked to reset the volume to ensure 0 dB gain */
2017     if (pa_sink_is_passthrough(s) && (!volume || !pa_cvolume_is_norm(volume))) {
2018         pa_log_warn("Cannot change volume, Sink is connected to PASSTHROUGH input");
2019         return;
2020     }
2021
2022     /* In case of volume sharing, the volume is set for the root sink first,
2023      * from which it's then propagated to the sharing sinks. */
2024     root_sink = pa_sink_get_master(s);
2025
2026     if (PA_UNLIKELY(!root_sink))
2027         return;
2028
2029     /* As a special exception we accept mono volumes on all sinks --
2030      * even on those with more complex channel maps */
2031
2032     if (volume) {
2033         if (pa_cvolume_compatible(volume, &s->sample_spec))
2034             new_reference_volume = *volume;
2035         else {
2036             new_reference_volume = s->reference_volume;
2037             pa_cvolume_scale(&new_reference_volume, pa_cvolume_max(volume));
2038         }
2039
2040         pa_cvolume_remap(&new_reference_volume, &s->channel_map, &root_sink->channel_map);
2041
2042         if (update_reference_volume(root_sink, &new_reference_volume, &root_sink->channel_map, save)) {
2043             if (pa_sink_flat_volume_enabled(root_sink)) {
2044                 /* OK, propagate this volume change back to the inputs */
2045                 propagate_reference_volume(root_sink);
2046
2047                 /* And now recalculate the real volume */
2048                 compute_real_volume(root_sink);
2049             } else
2050                 update_real_volume(root_sink, &root_sink->reference_volume, &root_sink->channel_map);
2051         }
2052
2053     } else {
2054         /* If volume is NULL we synchronize the sink's real and
2055          * reference volumes with the stream volumes. */
2056
2057         pa_assert(pa_sink_flat_volume_enabled(root_sink));
2058
2059         /* Ok, let's determine the new real volume */
2060         compute_real_volume(root_sink);
2061
2062         /* Let's 'push' the reference volume if necessary */
2063         pa_cvolume_merge(&new_reference_volume, &s->reference_volume, &root_sink->real_volume);
2064         /* If the sink and its root don't have the same number of channels, we need to remap */
2065         if (s != root_sink && !pa_channel_map_equal(&s->channel_map, &root_sink->channel_map))
2066             pa_cvolume_remap(&new_reference_volume, &s->channel_map, &root_sink->channel_map);
2067         update_reference_volume(root_sink, &new_reference_volume, &root_sink->channel_map, save);
2068
2069         /* Now that the reference volume is updated, we can update the streams'
2070          * reference ratios. */
2071         compute_reference_ratios(root_sink);
2072     }
2073
2074     if (root_sink->set_volume) {
2075         /* If we have a function set_volume(), then we do not apply a
2076          * soft volume by default. However, set_volume() is free to
2077          * apply one to root_sink->soft_volume */
2078
2079         pa_cvolume_reset(&root_sink->soft_volume, root_sink->sample_spec.channels);
2080         if (!(root_sink->flags & PA_SINK_DEFERRED_VOLUME))
2081             root_sink->set_volume(root_sink);
2082
2083     } else
2084         /* If we have no function set_volume(), then the soft volume
2085          * becomes the real volume */
2086         root_sink->soft_volume = root_sink->real_volume;
2087
2088     /* This tells the sink that soft volume and/or real volume changed */
2089     if (send_msg)
2090         pa_assert_se(pa_asyncmsgq_send(root_sink->asyncmsgq, PA_MSGOBJECT(root_sink), PA_SINK_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL) == 0);
2091 }
2092
2093 /* Called from the io thread if sync volume is used, otherwise from the main thread.
2094  * Only to be called by sink implementor */
2095 void pa_sink_set_soft_volume(pa_sink *s, const pa_cvolume *volume) {
2096
2097     pa_sink_assert_ref(s);
2098     pa_assert(!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER));
2099
2100     if (s->flags & PA_SINK_DEFERRED_VOLUME)
2101         pa_sink_assert_io_context(s);
2102     else
2103         pa_assert_ctl_context();
2104
2105     if (!volume)
2106         pa_cvolume_reset(&s->soft_volume, s->sample_spec.channels);
2107     else
2108         s->soft_volume = *volume;
2109
2110     if (PA_SINK_IS_LINKED(s->state) && !(s->flags & PA_SINK_DEFERRED_VOLUME))
2111         pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_VOLUME, NULL, 0, NULL) == 0);
2112     else
2113         s->thread_info.soft_volume = s->soft_volume;
2114 }
2115
2116 /* Called from the main thread. Only called for the root sink in volume sharing
2117  * cases, except for internal recursive calls. */
2118 static void propagate_real_volume(pa_sink *s, const pa_cvolume *old_real_volume) {
2119     pa_sink_input *i;
2120     uint32_t idx;
2121
2122     pa_sink_assert_ref(s);
2123     pa_assert(old_real_volume);
2124     pa_assert_ctl_context();
2125     pa_assert(PA_SINK_IS_LINKED(s->state));
2126
2127     /* This is called when the hardware's real volume changes due to
2128      * some external event. We copy the real volume into our
2129      * reference volume and then rebuild the stream volumes based on
2130      * i->real_ratio which should stay fixed. */
2131
2132     if (!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) {
2133         if (pa_cvolume_equal(old_real_volume, &s->real_volume))
2134             return;
2135
2136         /* 1. Make the real volume the reference volume */
2137         update_reference_volume(s, &s->real_volume, &s->channel_map, true);
2138     }
2139
2140     if (pa_sink_flat_volume_enabled(s)) {
2141
2142         PA_IDXSET_FOREACH(i, s->inputs, idx) {
2143             pa_cvolume new_volume;
2144
2145             /* 2. Since the sink's reference and real volumes are equal
2146              * now our ratios should be too. */
2147             pa_sink_input_set_reference_ratio(i, &i->real_ratio);
2148
2149             /* 3. Recalculate the new stream reference volume based on the
2150              * reference ratio and the sink's reference volume.
2151              *
2152              * This basically calculates:
2153              *
2154              * i->volume = s->reference_volume * i->reference_ratio
2155              *
2156              * This is identical to propagate_reference_volume() */
2157             new_volume = s->reference_volume;
2158             pa_cvolume_remap(&new_volume, &s->channel_map, &i->channel_map);
2159             pa_sw_cvolume_multiply(&new_volume, &new_volume, &i->reference_ratio);
2160             pa_sink_input_set_volume_direct(i, &new_volume);
2161
2162             if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER))
2163                 propagate_real_volume(i->origin_sink, old_real_volume);
2164         }
2165     }
2166
2167     /* Something got changed in the hardware. It probably makes sense
2168      * to save changed hw settings given that hw volume changes not
2169      * triggered by PA are almost certainly done by the user. */
2170     if (!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER))
2171         s->save_volume = true;
2172 }
2173
2174 /* Called from io thread */
2175 void pa_sink_update_volume_and_mute(pa_sink *s) {
2176     pa_assert(s);
2177     pa_sink_assert_io_context(s);
2178
2179     pa_asyncmsgq_post(pa_thread_mq_get()->outq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE, NULL, 0, NULL, NULL);
2180 }
2181
2182 /* Called from main thread */
2183 const pa_cvolume *pa_sink_get_volume(pa_sink *s, bool force_refresh) {
2184     pa_sink_assert_ref(s);
2185     pa_assert_ctl_context();
2186     pa_assert(PA_SINK_IS_LINKED(s->state));
2187
2188     if (s->refresh_volume || force_refresh) {
2189         struct pa_cvolume old_real_volume;
2190
2191         pa_assert(!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER));
2192
2193         old_real_volume = s->real_volume;
2194
2195         if (!(s->flags & PA_SINK_DEFERRED_VOLUME) && s->get_volume)
2196             s->get_volume(s);
2197
2198         pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_VOLUME, NULL, 0, NULL) == 0);
2199
2200         update_real_volume(s, &s->real_volume, &s->channel_map);
2201         propagate_real_volume(s, &old_real_volume);
2202     }
2203
2204     return &s->reference_volume;
2205 }
2206
2207 /* Called from main thread. In volume sharing cases, only the root sink may
2208  * call this. */
2209 void pa_sink_volume_changed(pa_sink *s, const pa_cvolume *new_real_volume) {
2210     pa_cvolume old_real_volume;
2211
2212     pa_sink_assert_ref(s);
2213     pa_assert_ctl_context();
2214     pa_assert(PA_SINK_IS_LINKED(s->state));
2215     pa_assert(!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER));
2216
2217     /* The sink implementor may call this if the volume changed to make sure everyone is notified */
2218
2219     old_real_volume = s->real_volume;
2220     update_real_volume(s, new_real_volume, &s->channel_map);
2221     propagate_real_volume(s, &old_real_volume);
2222 }
2223
2224 /* Called from main thread */
2225 void pa_sink_set_mute(pa_sink *s, bool mute, bool save) {
2226     bool old_muted;
2227
2228     pa_sink_assert_ref(s);
2229     pa_assert_ctl_context();
2230
2231     old_muted = s->muted;
2232
2233     if (mute == old_muted) {
2234         s->save_muted |= save;
2235         return;
2236     }
2237
2238     s->muted = mute;
2239     s->save_muted = save;
2240
2241     if (!(s->flags & PA_SINK_DEFERRED_VOLUME) && s->set_mute) {
2242         s->set_mute_in_progress = true;
2243         s->set_mute(s);
2244         s->set_mute_in_progress = false;
2245     }
2246
2247     if (!PA_SINK_IS_LINKED(s->state))
2248         return;
2249
2250     pa_log_debug("The mute of sink %s changed from %s to %s.", s->name, pa_yes_no(old_muted), pa_yes_no(mute));
2251     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_MUTE, NULL, 0, NULL) == 0);
2252     pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
2253     pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_MUTE_CHANGED], s);
2254 }
2255
2256 /* Called from main thread */
2257 bool pa_sink_get_mute(pa_sink *s, bool force_refresh) {
2258
2259     pa_sink_assert_ref(s);
2260     pa_assert_ctl_context();
2261     pa_assert(PA_SINK_IS_LINKED(s->state));
2262
2263     if ((s->refresh_muted || force_refresh) && s->get_mute) {
2264         bool mute;
2265
2266         if (s->flags & PA_SINK_DEFERRED_VOLUME) {
2267             if (pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_MUTE, &mute, 0, NULL) >= 0)
2268                 pa_sink_mute_changed(s, mute);
2269         } else {
2270             if (s->get_mute(s, &mute) >= 0)
2271                 pa_sink_mute_changed(s, mute);
2272         }
2273     }
2274
2275     return s->muted;
2276 }
2277
2278 /* Called from main thread */
2279 void pa_sink_mute_changed(pa_sink *s, bool new_muted) {
2280     pa_sink_assert_ref(s);
2281     pa_assert_ctl_context();
2282     pa_assert(PA_SINK_IS_LINKED(s->state));
2283
2284     if (s->set_mute_in_progress)
2285         return;
2286
2287     /* pa_sink_set_mute() does this same check, so this may appear redundant,
2288      * but we must have this here also, because the save parameter of
2289      * pa_sink_set_mute() would otherwise have unintended side effects (saving
2290      * the mute state when it shouldn't be saved). */
2291     if (new_muted == s->muted)
2292         return;
2293
2294     pa_sink_set_mute(s, new_muted, true);
2295 }
2296
2297 /* Called from main thread */
2298 bool pa_sink_update_proplist(pa_sink *s, pa_update_mode_t mode, pa_proplist *p) {
2299     pa_sink_assert_ref(s);
2300     pa_assert_ctl_context();
2301
2302     if (p)
2303         pa_proplist_update(s->proplist, mode, p);
2304
2305     if (PA_SINK_IS_LINKED(s->state)) {
2306         pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_PROPLIST_CHANGED], s);
2307         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
2308     }
2309
2310     return true;
2311 }
2312
2313 /* Called from main thread */
2314 /* FIXME -- this should be dropped and be merged into pa_sink_update_proplist() */
2315 void pa_sink_set_description(pa_sink *s, const char *description) {
2316     const char *old;
2317     pa_sink_assert_ref(s);
2318     pa_assert_ctl_context();
2319
2320     if (!description && !pa_proplist_contains(s->proplist, PA_PROP_DEVICE_DESCRIPTION))
2321         return;
2322
2323     old = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
2324
2325     if (old && description && pa_streq(old, description))
2326         return;
2327
2328     if (description)
2329         pa_proplist_sets(s->proplist, PA_PROP_DEVICE_DESCRIPTION, description);
2330     else
2331         pa_proplist_unset(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
2332
2333     if (s->monitor_source) {
2334         char *n;
2335
2336         n = pa_sprintf_malloc("Monitor Source of %s", description ? description : s->name);
2337         pa_source_set_description(s->monitor_source, n);
2338         pa_xfree(n);
2339     }
2340
2341     if (PA_SINK_IS_LINKED(s->state)) {
2342         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
2343         pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_PROPLIST_CHANGED], s);
2344     }
2345 }
2346
2347 /* Called from main thread */
2348 unsigned pa_sink_linked_by(pa_sink *s) {
2349     unsigned ret;
2350
2351     pa_sink_assert_ref(s);
2352     pa_assert_ctl_context();
2353     pa_assert(PA_SINK_IS_LINKED(s->state));
2354
2355     ret = pa_idxset_size(s->inputs);
2356
2357     /* We add in the number of streams connected to us here. Please
2358      * note the asymmetry to pa_sink_used_by()! */
2359
2360     if (s->monitor_source)
2361         ret += pa_source_linked_by(s->monitor_source);
2362
2363     return ret;
2364 }
2365
2366 /* Called from main thread */
2367 unsigned pa_sink_used_by(pa_sink *s) {
2368     unsigned ret;
2369
2370     pa_sink_assert_ref(s);
2371     pa_assert_ctl_context();
2372     pa_assert(PA_SINK_IS_LINKED(s->state));
2373
2374     ret = pa_idxset_size(s->inputs);
2375     pa_assert(ret >= s->n_corked);
2376
2377     /* Streams connected to our monitor source do not matter for
2378      * pa_sink_used_by()!.*/
2379
2380     return ret - s->n_corked;
2381 }
2382
2383 /* Called from main thread */
2384 unsigned pa_sink_check_suspend(pa_sink *s, pa_sink_input *ignore_input, pa_source_output *ignore_output) {
2385     unsigned ret;
2386     pa_sink_input *i;
2387     uint32_t idx;
2388
2389     pa_sink_assert_ref(s);
2390     pa_assert_ctl_context();
2391
2392     if (!PA_SINK_IS_LINKED(s->state))
2393         return 0;
2394
2395     ret = 0;
2396
2397     PA_IDXSET_FOREACH(i, s->inputs, idx) {
2398         pa_sink_input_state_t st;
2399
2400         if (i == ignore_input)
2401             continue;
2402
2403         st = pa_sink_input_get_state(i);
2404
2405         /* We do not assert here. It is perfectly valid for a sink input to
2406          * be in the INIT state (i.e. created, marked done but not yet put)
2407          * and we should not care if it's unlinked as it won't contribute
2408          * towards our busy status.
2409          */
2410         if (!PA_SINK_INPUT_IS_LINKED(st))
2411             continue;
2412
2413         if (st == PA_SINK_INPUT_CORKED)
2414             continue;
2415
2416         if (i->flags & PA_SINK_INPUT_DONT_INHIBIT_AUTO_SUSPEND)
2417             continue;
2418
2419         ret ++;
2420     }
2421
2422     if (s->monitor_source)
2423         ret += pa_source_check_suspend(s->monitor_source, ignore_output);
2424
2425     return ret;
2426 }
2427
2428 /* Called from the IO thread */
2429 static void sync_input_volumes_within_thread(pa_sink *s) {
2430     pa_sink_input *i;
2431     void *state = NULL;
2432
2433     pa_sink_assert_ref(s);
2434     pa_sink_assert_io_context(s);
2435
2436     PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state) {
2437         if (pa_cvolume_equal(&i->thread_info.soft_volume, &i->soft_volume))
2438             continue;
2439
2440         i->thread_info.soft_volume = i->soft_volume;
2441         pa_sink_input_request_rewind(i, 0, true, false, false);
2442     }
2443 }
2444
2445 /* Called from the IO thread. Only called for the root sink in volume sharing
2446  * cases, except for internal recursive calls. */
2447 static void set_shared_volume_within_thread(pa_sink *s) {
2448     pa_sink_input *i = NULL;
2449     void *state = NULL;
2450
2451     pa_sink_assert_ref(s);
2452
2453     PA_MSGOBJECT(s)->process_msg(PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_VOLUME_SYNCED, NULL, 0, NULL);
2454
2455     PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state) {
2456         if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER))
2457             set_shared_volume_within_thread(i->origin_sink);
2458     }
2459 }
2460
2461 /* Called from IO thread, except when it is not */
2462 int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
2463     pa_sink *s = PA_SINK(o);
2464     pa_sink_assert_ref(s);
2465
2466     switch ((pa_sink_message_t) code) {
2467
2468         case PA_SINK_MESSAGE_ADD_INPUT: {
2469             pa_sink_input *i = PA_SINK_INPUT(userdata);
2470
2471             /* If you change anything here, make sure to change the
2472              * sink input handling a few lines down at
2473              * PA_SINK_MESSAGE_FINISH_MOVE, too. */
2474
2475             pa_hashmap_put(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index), pa_sink_input_ref(i));
2476
2477             /* Since the caller sleeps in pa_sink_input_put(), we can
2478              * safely access data outside of thread_info even though
2479              * it is mutable */
2480
2481             if ((i->thread_info.sync_prev = i->sync_prev)) {
2482                 pa_assert(i->sink == i->thread_info.sync_prev->sink);
2483                 pa_assert(i->sync_prev->sync_next == i);
2484                 i->thread_info.sync_prev->thread_info.sync_next = i;
2485             }
2486
2487             if ((i->thread_info.sync_next = i->sync_next)) {
2488                 pa_assert(i->sink == i->thread_info.sync_next->sink);
2489                 pa_assert(i->sync_next->sync_prev == i);
2490                 i->thread_info.sync_next->thread_info.sync_prev = i;
2491             }
2492
2493             pa_assert(!i->thread_info.attached);
2494             i->thread_info.attached = true;
2495
2496             if (i->attach)
2497                 i->attach(i);
2498
2499             pa_sink_input_set_state_within_thread(i, i->state);
2500
2501             /* The requested latency of the sink input needs to be fixed up and
2502              * then configured on the sink. If this causes the sink latency to
2503              * go down, the sink implementor is responsible for doing a rewind
2504              * in the update_requested_latency() callback to ensure that the
2505              * sink buffer doesn't contain more data than what the new latency
2506              * allows.
2507              *
2508              * XXX: Does it really make sense to push this responsibility to
2509              * the sink implementors? Wouldn't it be better to do it once in
2510              * the core than many times in the modules? */
2511
2512             if (i->thread_info.requested_sink_latency != (pa_usec_t) -1)
2513                 pa_sink_input_set_requested_latency_within_thread(i, i->thread_info.requested_sink_latency);
2514
2515             pa_sink_input_update_max_rewind(i, s->thread_info.max_rewind);
2516             pa_sink_input_update_max_request(i, s->thread_info.max_request);
2517
2518             /* We don't rewind here automatically. This is left to the
2519              * sink input implementor because some sink inputs need a
2520              * slow start, i.e. need some time to buffer client
2521              * samples before beginning streaming.
2522              *
2523              * XXX: Does it really make sense to push this functionality to
2524              * the sink implementors? Wouldn't it be better to do it once in
2525              * the core than many times in the modules? */
2526
2527             /* In flat volume mode we need to update the volume as
2528              * well */
2529             return o->process_msg(o, PA_SINK_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL);
2530         }
2531
2532         case PA_SINK_MESSAGE_REMOVE_INPUT: {
2533             pa_sink_input *i = PA_SINK_INPUT(userdata);
2534
2535             /* If you change anything here, make sure to change the
2536              * sink input handling a few lines down at
2537              * PA_SINK_MESSAGE_START_MOVE, too. */
2538
2539             pa_assert(i->thread_info.attached);
2540             i->thread_info.attached = false;
2541
2542             if (i->detach)
2543                 i->detach(i);
2544
2545             pa_sink_input_set_state_within_thread(i, i->state);
2546
2547             /* Since the caller sleeps in pa_sink_input_unlink(),
2548              * we can safely access data outside of thread_info even
2549              * though it is mutable */
2550
2551             pa_assert(!i->sync_prev);
2552             pa_assert(!i->sync_next);
2553
2554             if (i->thread_info.sync_prev) {
2555                 i->thread_info.sync_prev->thread_info.sync_next = i->thread_info.sync_prev->sync_next;
2556                 i->thread_info.sync_prev = NULL;
2557             }
2558
2559             if (i->thread_info.sync_next) {
2560                 i->thread_info.sync_next->thread_info.sync_prev = i->thread_info.sync_next->sync_prev;
2561                 i->thread_info.sync_next = NULL;
2562             }
2563
2564             pa_hashmap_remove_and_free(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index));
2565             pa_sink_invalidate_requested_latency(s, true);
2566             pa_sink_request_rewind(s, (size_t) -1);
2567
2568             /* In flat volume mode we need to update the volume as
2569              * well */
2570             return o->process_msg(o, PA_SINK_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL);
2571         }
2572
2573         case PA_SINK_MESSAGE_START_MOVE: {
2574             pa_sink_input *i = PA_SINK_INPUT(userdata);
2575
2576             /* We don't support moving synchronized streams. */
2577             pa_assert(!i->sync_prev);
2578             pa_assert(!i->sync_next);
2579             pa_assert(!i->thread_info.sync_next);
2580             pa_assert(!i->thread_info.sync_prev);
2581
2582             if (i->thread_info.state != PA_SINK_INPUT_CORKED) {
2583                 pa_usec_t usec = 0;
2584                 size_t sink_nbytes, total_nbytes;
2585
2586                 /* The old sink probably has some audio from this
2587                  * stream in its buffer. We want to "take it back" as
2588                  * much as possible and play it to the new sink. We
2589                  * don't know at this point how much the old sink can
2590                  * rewind. We have to pick something, and that
2591                  * something is the full latency of the old sink here.
2592                  * So we rewind the stream buffer by the sink latency
2593                  * amount, which may be more than what we should
2594                  * rewind. This can result in a chunk of audio being
2595                  * played both to the old sink and the new sink.
2596                  *
2597                  * FIXME: Fix this code so that we don't have to make
2598                  * guesses about how much the sink will actually be
2599                  * able to rewind. If someone comes up with a solution
2600                  * for this, something to note is that the part of the
2601                  * latency that the old sink couldn't rewind should
2602                  * ideally be compensated after the stream has moved
2603                  * to the new sink by adding silence. The new sink
2604                  * most likely can't start playing the moved stream
2605                  * immediately, and that gap should be removed from
2606                  * the "compensation silence" (at least at the time of
2607                  * writing this, the move finish code will actually
2608                  * already take care of dropping the new sink's
2609                  * unrewindable latency, so taking into account the
2610                  * unrewindable latency of the old sink is the only
2611                  * problem).
2612                  *
2613                  * The render_memblockq contents are discarded,
2614                  * because when the sink changes, the format of the
2615                  * audio stored in the render_memblockq may change
2616                  * too, making the stored audio invalid. FIXME:
2617                  * However, the read and write indices are moved back
2618                  * the same amount, so if they are not the same now,
2619                  * they won't be the same after the rewind either. If
2620                  * the write index of the render_memblockq is ahead of
2621                  * the read index, then the render_memblockq will feed
2622                  * the new sink some silence first, which it shouldn't
2623                  * do. The write index should be flushed to be the
2624                  * same as the read index. */
2625
2626                 /* Get the latency of the sink */
2627                 usec = pa_sink_get_latency_within_thread(s);
2628                 sink_nbytes = pa_usec_to_bytes(usec, &s->sample_spec);
2629                 total_nbytes = sink_nbytes + pa_memblockq_get_length(i->thread_info.render_memblockq);
2630
2631                 if (total_nbytes > 0) {
2632                     i->thread_info.rewrite_nbytes = i->thread_info.resampler ? pa_resampler_request(i->thread_info.resampler, total_nbytes) : total_nbytes;
2633                     i->thread_info.rewrite_flush = true;
2634                     pa_sink_input_process_rewind(i, sink_nbytes);
2635                 }
2636             }
2637
2638             pa_assert(i->thread_info.attached);
2639             i->thread_info.attached = false;
2640
2641             if (i->detach)
2642                 i->detach(i);
2643
2644             /* Let's remove the sink input ...*/
2645             pa_hashmap_remove_and_free(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index));
2646
2647             pa_sink_invalidate_requested_latency(s, true);
2648
2649             pa_log_debug("Requesting rewind due to started move");
2650             pa_sink_request_rewind(s, (size_t) -1);
2651
2652             /* In flat volume mode we need to update the volume as
2653              * well */
2654             return o->process_msg(o, PA_SINK_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL);
2655         }
2656
2657         case PA_SINK_MESSAGE_FINISH_MOVE: {
2658             pa_sink_input *i = PA_SINK_INPUT(userdata);
2659
2660             /* We don't support moving synchronized streams. */
2661             pa_assert(!i->sync_prev);
2662             pa_assert(!i->sync_next);
2663             pa_assert(!i->thread_info.sync_next);
2664             pa_assert(!i->thread_info.sync_prev);
2665
2666             pa_hashmap_put(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index), pa_sink_input_ref(i));
2667
2668             pa_assert(!i->thread_info.attached);
2669             i->thread_info.attached = true;
2670
2671             if (i->attach)
2672                 i->attach(i);
2673
2674             if (i->thread_info.state != PA_SINK_INPUT_CORKED) {
2675                 pa_usec_t usec = 0;
2676                 size_t nbytes;
2677
2678                 /* In the ideal case the new sink would start playing
2679                  * the stream immediately. That requires the sink to
2680                  * be able to rewind all of its latency, which usually
2681                  * isn't possible, so there will probably be some gap
2682                  * before the moved stream becomes audible. We then
2683                  * have two possibilities: 1) start playing the stream
2684                  * from where it is now, or 2) drop the unrewindable
2685                  * latency of the sink from the stream. With option 1
2686                  * we won't lose any audio but the stream will have a
2687                  * pause. With option 2 we may lose some audio but the
2688                  * stream time will be somewhat in sync with the wall
2689                  * clock. Lennart seems to have chosen option 2 (one
2690                  * of the reasons might have been that option 1 is
2691                  * actually much harder to implement), so we drop the
2692                  * latency of the new sink from the moved stream and
2693                  * hope that the sink will undo most of that in the
2694                  * rewind. */
2695
2696                 /* Get the latency of the sink */
2697                 usec = pa_sink_get_latency_within_thread(s);
2698                 nbytes = pa_usec_to_bytes(usec, &s->sample_spec);
2699
2700                 if (nbytes > 0)
2701                     pa_sink_input_drop(i, nbytes);
2702
2703                 pa_log_debug("Requesting rewind due to finished move");
2704                 pa_sink_request_rewind(s, nbytes);
2705             }
2706
2707             /* Updating the requested sink latency has to be done
2708              * after the sink rewind request, not before, because
2709              * otherwise the sink may limit the rewind amount
2710              * needlessly. */
2711
2712             if (i->thread_info.requested_sink_latency != (pa_usec_t) -1)
2713                 pa_sink_input_set_requested_latency_within_thread(i, i->thread_info.requested_sink_latency);
2714
2715             pa_sink_input_update_max_rewind(i, s->thread_info.max_rewind);
2716             pa_sink_input_update_max_request(i, s->thread_info.max_request);
2717
2718             return o->process_msg(o, PA_SINK_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL);
2719         }
2720
2721         case PA_SINK_MESSAGE_SET_SHARED_VOLUME: {
2722             pa_sink *root_sink = pa_sink_get_master(s);
2723
2724             if (PA_LIKELY(root_sink))
2725                 set_shared_volume_within_thread(root_sink);
2726
2727             return 0;
2728         }
2729
2730         case PA_SINK_MESSAGE_SET_VOLUME_SYNCED:
2731
2732             if (s->flags & PA_SINK_DEFERRED_VOLUME) {
2733                 s->set_volume(s);
2734                 pa_sink_volume_change_push(s);
2735             }
2736             /* Fall through ... */
2737
2738         case PA_SINK_MESSAGE_SET_VOLUME:
2739
2740             if (!pa_cvolume_equal(&s->thread_info.soft_volume, &s->soft_volume)) {
2741                 s->thread_info.soft_volume = s->soft_volume;
2742                 pa_sink_request_rewind(s, (size_t) -1);
2743             }
2744
2745             /* Fall through ... */
2746
2747         case PA_SINK_MESSAGE_SYNC_VOLUMES:
2748             sync_input_volumes_within_thread(s);
2749             return 0;
2750
2751         case PA_SINK_MESSAGE_GET_VOLUME:
2752
2753             if ((s->flags & PA_SINK_DEFERRED_VOLUME) && s->get_volume) {
2754                 s->get_volume(s);
2755                 pa_sink_volume_change_flush(s);
2756                 pa_sw_cvolume_divide(&s->thread_info.current_hw_volume, &s->real_volume, &s->soft_volume);
2757             }
2758
2759             /* In case sink implementor reset SW volume. */
2760             if (!pa_cvolume_equal(&s->thread_info.soft_volume, &s->soft_volume)) {
2761                 s->thread_info.soft_volume = s->soft_volume;
2762                 pa_sink_request_rewind(s, (size_t) -1);
2763             }
2764
2765             return 0;
2766
2767         case PA_SINK_MESSAGE_SET_MUTE:
2768
2769             if (s->thread_info.soft_muted != s->muted) {
2770                 s->thread_info.soft_muted = s->muted;
2771                 pa_sink_request_rewind(s, (size_t) -1);
2772             }
2773
2774             if (s->flags & PA_SINK_DEFERRED_VOLUME && s->set_mute)
2775                 s->set_mute(s);
2776
2777             return 0;
2778
2779         case PA_SINK_MESSAGE_GET_MUTE:
2780
2781             if (s->flags & PA_SINK_DEFERRED_VOLUME && s->get_mute)
2782                 return s->get_mute(s, userdata);
2783
2784             return 0;
2785
2786         case PA_SINK_MESSAGE_SET_STATE: {
2787
2788             bool suspend_change =
2789                 (s->thread_info.state == PA_SINK_SUSPENDED && PA_SINK_IS_OPENED(PA_PTR_TO_UINT(userdata))) ||
2790                 (PA_SINK_IS_OPENED(s->thread_info.state) && PA_PTR_TO_UINT(userdata) == PA_SINK_SUSPENDED);
2791
2792             s->thread_info.state = PA_PTR_TO_UINT(userdata);
2793
2794             if (s->thread_info.state == PA_SINK_SUSPENDED) {
2795                 s->thread_info.rewind_nbytes = 0;
2796                 s->thread_info.rewind_requested = false;
2797             }
2798
2799             if (suspend_change) {
2800                 pa_sink_input *i;
2801                 void *state = NULL;
2802
2803                 while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL)))
2804                     if (i->suspend_within_thread)
2805                         i->suspend_within_thread(i, s->thread_info.state == PA_SINK_SUSPENDED);
2806             }
2807
2808             return 0;
2809         }
2810
2811         case PA_SINK_MESSAGE_GET_REQUESTED_LATENCY: {
2812
2813             pa_usec_t *usec = userdata;
2814             *usec = pa_sink_get_requested_latency_within_thread(s);
2815
2816             /* Yes, that's right, the IO thread will see -1 when no
2817              * explicit requested latency is configured, the main
2818              * thread will see max_latency */
2819             if (*usec == (pa_usec_t) -1)
2820                 *usec = s->thread_info.max_latency;
2821
2822             return 0;
2823         }
2824
2825         case PA_SINK_MESSAGE_SET_LATENCY_RANGE: {
2826             pa_usec_t *r = userdata;
2827
2828             pa_sink_set_latency_range_within_thread(s, r[0], r[1]);
2829
2830             return 0;
2831         }
2832
2833         case PA_SINK_MESSAGE_GET_LATENCY_RANGE: {
2834             pa_usec_t *r = userdata;
2835
2836             r[0] = s->thread_info.min_latency;
2837             r[1] = s->thread_info.max_latency;
2838
2839             return 0;
2840         }
2841
2842         case PA_SINK_MESSAGE_GET_FIXED_LATENCY:
2843
2844             *((pa_usec_t*) userdata) = s->thread_info.fixed_latency;
2845             return 0;
2846
2847         case PA_SINK_MESSAGE_SET_FIXED_LATENCY:
2848
2849             pa_sink_set_fixed_latency_within_thread(s, (pa_usec_t) offset);
2850             return 0;
2851
2852         case PA_SINK_MESSAGE_GET_MAX_REWIND:
2853
2854             *((size_t*) userdata) = s->thread_info.max_rewind;
2855             return 0;
2856
2857         case PA_SINK_MESSAGE_GET_MAX_REQUEST:
2858
2859             *((size_t*) userdata) = s->thread_info.max_request;
2860             return 0;
2861
2862         case PA_SINK_MESSAGE_SET_MAX_REWIND:
2863
2864             pa_sink_set_max_rewind_within_thread(s, (size_t) offset);
2865             return 0;
2866
2867         case PA_SINK_MESSAGE_SET_MAX_REQUEST:
2868
2869             pa_sink_set_max_request_within_thread(s, (size_t) offset);
2870             return 0;
2871
2872         case PA_SINK_MESSAGE_SET_PORT:
2873
2874             pa_assert(userdata);
2875             if (s->set_port) {
2876                 struct sink_message_set_port *msg_data = userdata;
2877                 msg_data->ret = s->set_port(s, msg_data->port);
2878             }
2879             return 0;
2880
2881         case PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE:
2882             /* This message is sent from IO-thread and handled in main thread. */
2883             pa_assert_ctl_context();
2884
2885             /* Make sure we're not messing with main thread when no longer linked */
2886             if (!PA_SINK_IS_LINKED(s->state))
2887                 return 0;
2888
2889             pa_sink_get_volume(s, true);
2890             pa_sink_get_mute(s, true);
2891             return 0;
2892
2893         case PA_SINK_MESSAGE_SET_PORT_LATENCY_OFFSET:
2894             s->thread_info.port_latency_offset = offset;
2895             return 0;
2896
2897         case PA_SINK_MESSAGE_GET_LATENCY:
2898         case PA_SINK_MESSAGE_MAX:
2899             ;
2900     }
2901
2902     return -1;
2903 }
2904
2905 /* Called from main thread */
2906 int pa_sink_suspend_all(pa_core *c, bool suspend, pa_suspend_cause_t cause) {
2907     pa_sink *sink;
2908     uint32_t idx;
2909     int ret = 0;
2910
2911     pa_core_assert_ref(c);
2912     pa_assert_ctl_context();
2913     pa_assert(cause != 0);
2914
2915     PA_IDXSET_FOREACH(sink, c->sinks, idx) {
2916         int r;
2917
2918         if ((r = pa_sink_suspend(sink, suspend, cause)) < 0)
2919             ret = r;
2920     }
2921
2922     return ret;
2923 }
2924
2925 /* Called from IO thread */
2926 void pa_sink_detach_within_thread(pa_sink *s) {
2927     pa_sink_input *i;
2928     void *state = NULL;
2929
2930     pa_sink_assert_ref(s);
2931     pa_sink_assert_io_context(s);
2932     pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
2933
2934     PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
2935         if (i->detach)
2936             i->detach(i);
2937
2938     if (s->monitor_source)
2939         pa_source_detach_within_thread(s->monitor_source);
2940 }
2941
2942 /* Called from IO thread */
2943 void pa_sink_attach_within_thread(pa_sink *s) {
2944     pa_sink_input *i;
2945     void *state = NULL;
2946
2947     pa_sink_assert_ref(s);
2948     pa_sink_assert_io_context(s);
2949     pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
2950
2951     PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
2952         if (i->attach)
2953             i->attach(i);
2954
2955     if (s->monitor_source)
2956         pa_source_attach_within_thread(s->monitor_source);
2957 }
2958
2959 /* Called from IO thread */
2960 void pa_sink_request_rewind(pa_sink*s, size_t nbytes) {
2961     pa_sink_assert_ref(s);
2962     pa_sink_assert_io_context(s);
2963     pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
2964
2965     if (nbytes == (size_t) -1)
2966         nbytes = s->thread_info.max_rewind;
2967
2968     nbytes = PA_MIN(nbytes, s->thread_info.max_rewind);
2969
2970     if (s->thread_info.rewind_requested &&
2971         nbytes <= s->thread_info.rewind_nbytes)
2972         return;
2973
2974     s->thread_info.rewind_nbytes = nbytes;
2975     s->thread_info.rewind_requested = true;
2976
2977     if (s->request_rewind)
2978         s->request_rewind(s);
2979 }
2980
2981 /* Called from IO thread */
2982 pa_usec_t pa_sink_get_requested_latency_within_thread(pa_sink *s) {
2983     pa_usec_t result = (pa_usec_t) -1;
2984     pa_sink_input *i;
2985     void *state = NULL;
2986     pa_usec_t monitor_latency;
2987
2988     pa_sink_assert_ref(s);
2989     pa_sink_assert_io_context(s);
2990
2991     if (!(s->flags & PA_SINK_DYNAMIC_LATENCY))
2992         return PA_CLAMP(s->thread_info.fixed_latency, s->thread_info.min_latency, s->thread_info.max_latency);
2993
2994     if (s->thread_info.requested_latency_valid)
2995         return s->thread_info.requested_latency;
2996
2997     PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
2998         if (i->thread_info.requested_sink_latency != (pa_usec_t) -1 &&
2999             (result == (pa_usec_t) -1 || result > i->thread_info.requested_sink_latency))
3000             result = i->thread_info.requested_sink_latency;
3001
3002     monitor_latency = pa_source_get_requested_latency_within_thread(s->monitor_source);
3003
3004     if (monitor_latency != (pa_usec_t) -1 &&
3005         (result == (pa_usec_t) -1 || result > monitor_latency))
3006         result = monitor_latency;
3007
3008     if (result != (pa_usec_t) -1)
3009         result = PA_CLAMP(result, s->thread_info.min_latency, s->thread_info.max_latency);
3010
3011     if (PA_SINK_IS_LINKED(s->thread_info.state)) {
3012         /* Only cache if properly initialized */
3013         s->thread_info.requested_latency = result;
3014         s->thread_info.requested_latency_valid = true;
3015     }
3016
3017     return result;
3018 }
3019
3020 /* Called from main thread */
3021 pa_usec_t pa_sink_get_requested_latency(pa_sink *s) {
3022     pa_usec_t usec = 0;
3023
3024     pa_sink_assert_ref(s);
3025     pa_assert_ctl_context();
3026     pa_assert(PA_SINK_IS_LINKED(s->state));
3027
3028     if (s->state == PA_SINK_SUSPENDED)
3029         return 0;
3030
3031     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_REQUESTED_LATENCY, &usec, 0, NULL) == 0);
3032
3033     return usec;
3034 }
3035
3036 /* Called from IO as well as the main thread -- the latter only before the IO thread started up */
3037 void pa_sink_set_max_rewind_within_thread(pa_sink *s, size_t max_rewind) {
3038     pa_sink_input *i;
3039     void *state = NULL;
3040
3041     pa_sink_assert_ref(s);
3042     pa_sink_assert_io_context(s);
3043
3044     if (max_rewind == s->thread_info.max_rewind)
3045         return;
3046
3047     s->thread_info.max_rewind = max_rewind;
3048
3049     if (PA_SINK_IS_LINKED(s->thread_info.state))
3050         PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
3051             pa_sink_input_update_max_rewind(i, s->thread_info.max_rewind);
3052
3053     if (s->monitor_source)
3054         pa_source_set_max_rewind_within_thread(s->monitor_source, s->thread_info.max_rewind);
3055 }
3056
3057 /* Called from main thread */
3058 void pa_sink_set_max_rewind(pa_sink *s, size_t max_rewind) {
3059     pa_sink_assert_ref(s);
3060     pa_assert_ctl_context();
3061
3062     if (PA_SINK_IS_LINKED(s->state))
3063         pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_MAX_REWIND, NULL, max_rewind, NULL) == 0);
3064     else
3065         pa_sink_set_max_rewind_within_thread(s, max_rewind);
3066 }
3067
3068 /* Called from IO as well as the main thread -- the latter only before the IO thread started up */
3069 void pa_sink_set_max_request_within_thread(pa_sink *s, size_t max_request) {
3070     void *state = NULL;
3071
3072     pa_sink_assert_ref(s);
3073     pa_sink_assert_io_context(s);
3074
3075     if (max_request == s->thread_info.max_request)
3076         return;
3077
3078     s->thread_info.max_request = max_request;
3079
3080     if (PA_SINK_IS_LINKED(s->thread_info.state)) {
3081         pa_sink_input *i;
3082
3083         PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
3084             pa_sink_input_update_max_request(i, s->thread_info.max_request);
3085     }
3086 }
3087
3088 /* Called from main thread */
3089 void pa_sink_set_max_request(pa_sink *s, size_t max_request) {
3090     pa_sink_assert_ref(s);
3091     pa_assert_ctl_context();
3092
3093     if (PA_SINK_IS_LINKED(s->state))
3094         pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_MAX_REQUEST, NULL, max_request, NULL) == 0);
3095     else
3096         pa_sink_set_max_request_within_thread(s, max_request);
3097 }
3098
3099 /* Called from IO thread */
3100 void pa_sink_invalidate_requested_latency(pa_sink *s, bool dynamic) {
3101     pa_sink_input *i;
3102     void *state = NULL;
3103
3104     pa_sink_assert_ref(s);
3105     pa_sink_assert_io_context(s);
3106
3107     if ((s->flags & PA_SINK_DYNAMIC_LATENCY))
3108         s->thread_info.requested_latency_valid = false;
3109     else if (dynamic)
3110         return;
3111
3112     if (PA_SINK_IS_LINKED(s->thread_info.state)) {
3113
3114         if (s->update_requested_latency)
3115             s->update_requested_latency(s);
3116
3117         PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
3118             if (i->update_sink_requested_latency)
3119                 i->update_sink_requested_latency(i);
3120     }
3121 }
3122
3123 /* Called from main thread */
3124 void pa_sink_set_latency_range(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency) {
3125     pa_sink_assert_ref(s);
3126     pa_assert_ctl_context();
3127
3128     /* min_latency == 0:           no limit
3129      * min_latency anything else:  specified limit
3130      *
3131      * Similar for max_latency */
3132
3133     if (min_latency < ABSOLUTE_MIN_LATENCY)
3134         min_latency = ABSOLUTE_MIN_LATENCY;
3135
3136     if (max_latency <= 0 ||
3137         max_latency > ABSOLUTE_MAX_LATENCY)
3138         max_latency = ABSOLUTE_MAX_LATENCY;
3139
3140     pa_assert(min_latency <= max_latency);
3141
3142     /* Hmm, let's see if someone forgot to set PA_SINK_DYNAMIC_LATENCY here... */
3143     pa_assert((min_latency == ABSOLUTE_MIN_LATENCY &&
3144                max_latency == ABSOLUTE_MAX_LATENCY) ||
3145               (s->flags & PA_SINK_DYNAMIC_LATENCY));
3146
3147     if (PA_SINK_IS_LINKED(s->state)) {
3148         pa_usec_t r[2];
3149
3150         r[0] = min_latency;
3151         r[1] = max_latency;
3152
3153         pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_LATENCY_RANGE, r, 0, NULL) == 0);
3154     } else
3155         pa_sink_set_latency_range_within_thread(s, min_latency, max_latency);
3156 }
3157
3158 /* Called from main thread */
3159 void pa_sink_get_latency_range(pa_sink *s, pa_usec_t *min_latency, pa_usec_t *max_latency) {
3160     pa_sink_assert_ref(s);
3161     pa_assert_ctl_context();
3162     pa_assert(min_latency);
3163     pa_assert(max_latency);
3164
3165     if (PA_SINK_IS_LINKED(s->state)) {
3166         pa_usec_t r[2] = { 0, 0 };
3167
3168         pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_LATENCY_RANGE, r, 0, NULL) == 0);
3169
3170         *min_latency = r[0];
3171         *max_latency = r[1];
3172     } else {
3173         *min_latency = s->thread_info.min_latency;
3174         *max_latency = s->thread_info.max_latency;
3175     }
3176 }
3177
3178 /* Called from IO thread */
3179 void pa_sink_set_latency_range_within_thread(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency) {
3180     pa_sink_assert_ref(s);
3181     pa_sink_assert_io_context(s);
3182
3183     pa_assert(min_latency >= ABSOLUTE_MIN_LATENCY);
3184     pa_assert(max_latency <= ABSOLUTE_MAX_LATENCY);
3185     pa_assert(min_latency <= max_latency);
3186
3187     /* Hmm, let's see if someone forgot to set PA_SINK_DYNAMIC_LATENCY here... */
3188     pa_assert((min_latency == ABSOLUTE_MIN_LATENCY &&
3189                max_latency == ABSOLUTE_MAX_LATENCY) ||
3190               (s->flags & PA_SINK_DYNAMIC_LATENCY));
3191
3192     if (s->thread_info.min_latency == min_latency &&
3193         s->thread_info.max_latency == max_latency)
3194         return;
3195
3196     s->thread_info.min_latency = min_latency;
3197     s->thread_info.max_latency = max_latency;
3198
3199     if (PA_SINK_IS_LINKED(s->thread_info.state)) {
3200         pa_sink_input *i;
3201         void *state = NULL;
3202
3203         PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
3204             if (i->update_sink_latency_range)
3205                 i->update_sink_latency_range(i);
3206     }
3207
3208     pa_sink_invalidate_requested_latency(s, false);
3209
3210     pa_source_set_latency_range_within_thread(s->monitor_source, min_latency, max_latency);
3211 }
3212
3213 /* Called from main thread */
3214 void pa_sink_set_fixed_latency(pa_sink *s, pa_usec_t latency) {
3215     pa_sink_assert_ref(s);
3216     pa_assert_ctl_context();
3217
3218     if (s->flags & PA_SINK_DYNAMIC_LATENCY) {
3219         pa_assert(latency == 0);
3220         return;
3221     }
3222
3223     if (latency < ABSOLUTE_MIN_LATENCY)
3224         latency = ABSOLUTE_MIN_LATENCY;
3225
3226     if (latency > ABSOLUTE_MAX_LATENCY)
3227         latency = ABSOLUTE_MAX_LATENCY;
3228
3229     if (PA_SINK_IS_LINKED(s->state))
3230         pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_FIXED_LATENCY, NULL, (int64_t) latency, NULL) == 0);
3231     else
3232         s->thread_info.fixed_latency = latency;
3233
3234     pa_source_set_fixed_latency(s->monitor_source, latency);
3235 }
3236
3237 /* Called from main thread */
3238 pa_usec_t pa_sink_get_fixed_latency(pa_sink *s) {
3239     pa_usec_t latency;
3240
3241     pa_sink_assert_ref(s);
3242     pa_assert_ctl_context();
3243
3244     if (s->flags & PA_SINK_DYNAMIC_LATENCY)
3245         return 0;
3246
3247     if (PA_SINK_IS_LINKED(s->state))
3248         pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_FIXED_LATENCY, &latency, 0, NULL) == 0);
3249     else
3250         latency = s->thread_info.fixed_latency;
3251
3252     return latency;
3253 }
3254
3255 /* Called from IO thread */
3256 void pa_sink_set_fixed_latency_within_thread(pa_sink *s, pa_usec_t latency) {
3257     pa_sink_assert_ref(s);
3258     pa_sink_assert_io_context(s);
3259
3260     if (s->flags & PA_SINK_DYNAMIC_LATENCY) {
3261         pa_assert(latency == 0);
3262         s->thread_info.fixed_latency = 0;
3263
3264         if (s->monitor_source)
3265             pa_source_set_fixed_latency_within_thread(s->monitor_source, 0);
3266
3267         return;
3268     }
3269
3270     pa_assert(latency >= ABSOLUTE_MIN_LATENCY);
3271     pa_assert(latency <= ABSOLUTE_MAX_LATENCY);
3272
3273     if (s->thread_info.fixed_latency == latency)
3274         return;
3275
3276     s->thread_info.fixed_latency = latency;
3277
3278     if (PA_SINK_IS_LINKED(s->thread_info.state)) {
3279         pa_sink_input *i;
3280         void *state = NULL;
3281
3282         PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
3283             if (i->update_sink_fixed_latency)
3284                 i->update_sink_fixed_latency(i);
3285     }
3286
3287     pa_sink_invalidate_requested_latency(s, false);
3288
3289     pa_source_set_fixed_latency_within_thread(s->monitor_source, latency);
3290 }
3291
3292 /* Called from main context */
3293 void pa_sink_set_port_latency_offset(pa_sink *s, int64_t offset) {
3294     pa_sink_assert_ref(s);
3295
3296     s->port_latency_offset = offset;
3297
3298     if (PA_SINK_IS_LINKED(s->state))
3299         pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_PORT_LATENCY_OFFSET, NULL, offset, NULL) == 0);
3300     else
3301         s->thread_info.port_latency_offset = offset;
3302 }
3303
3304 /* Called from main context */
3305 size_t pa_sink_get_max_rewind(pa_sink *s) {
3306     size_t r;
3307     pa_assert_ctl_context();
3308     pa_sink_assert_ref(s);
3309
3310     if (!PA_SINK_IS_LINKED(s->state))
3311         return s->thread_info.max_rewind;
3312
3313     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_MAX_REWIND, &r, 0, NULL) == 0);
3314
3315     return r;
3316 }
3317
3318 /* Called from main context */
3319 size_t pa_sink_get_max_request(pa_sink *s) {
3320     size_t r;
3321     pa_sink_assert_ref(s);
3322     pa_assert_ctl_context();
3323
3324     if (!PA_SINK_IS_LINKED(s->state))
3325         return s->thread_info.max_request;
3326
3327     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_MAX_REQUEST, &r, 0, NULL) == 0);
3328
3329     return r;
3330 }
3331
3332 /* Called from main context */
3333 int pa_sink_set_port(pa_sink *s, const char *name, bool save) {
3334     pa_device_port *port;
3335     int ret;
3336
3337     pa_sink_assert_ref(s);
3338     pa_assert_ctl_context();
3339
3340     if (!s->set_port) {
3341         pa_log_debug("set_port() operation not implemented for sink %u \"%s\"", s->index, s->name);
3342         return -PA_ERR_NOTIMPLEMENTED;
3343     }
3344
3345     if (!name)
3346         return -PA_ERR_NOENTITY;
3347
3348     if (!(port = pa_hashmap_get(s->ports, name)))
3349         return -PA_ERR_NOENTITY;
3350
3351     if (s->active_port == port) {
3352         s->save_port = s->save_port || save;
3353         return 0;
3354     }
3355
3356     if (s->flags & PA_SINK_DEFERRED_VOLUME) {
3357         struct sink_message_set_port msg = { .port = port, .ret = 0 };
3358         pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_PORT, &msg, 0, NULL) == 0);
3359         ret = msg.ret;
3360     }
3361     else
3362         ret = s->set_port(s, port);
3363
3364     if (ret < 0)
3365         return -PA_ERR_NOENTITY;
3366
3367     pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
3368
3369     pa_log_info("Changed port of sink %u \"%s\" to %s", s->index, s->name, port->name);
3370
3371     s->active_port = port;
3372     s->save_port = save;
3373
3374     pa_sink_set_port_latency_offset(s, s->active_port->latency_offset);
3375
3376     pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_PORT_CHANGED], s);
3377
3378     return 0;
3379 }
3380
3381 bool pa_device_init_icon(pa_proplist *p, bool is_sink) {
3382     const char *ff, *c, *t = NULL, *s = "", *profile, *bus;
3383
3384     pa_assert(p);
3385
3386     if (pa_proplist_contains(p, PA_PROP_DEVICE_ICON_NAME))
3387         return true;
3388
3389     if ((ff = pa_proplist_gets(p, PA_PROP_DEVICE_FORM_FACTOR))) {
3390
3391         if (pa_streq(ff, "microphone"))
3392             t = "audio-input-microphone";
3393         else if (pa_streq(ff, "webcam"))
3394             t = "camera-web";
3395         else if (pa_streq(ff, "computer"))
3396             t = "computer";
3397         else if (pa_streq(ff, "handset"))
3398             t = "phone";
3399         else if (pa_streq(ff, "portable"))
3400             t = "multimedia-player";
3401         else if (pa_streq(ff, "tv"))
3402             t = "video-display";
3403
3404         /*
3405          * The following icons are not part of the icon naming spec,
3406          * because Rodney Dawes sucks as the maintainer of that spec.
3407          *
3408          * http://lists.freedesktop.org/archives/xdg/2009-May/010397.html
3409          */
3410         else if (pa_streq(ff, "headset"))
3411             t = "audio-headset";
3412         else if (pa_streq(ff, "headphone"))
3413             t = "audio-headphones";
3414         else if (pa_streq(ff, "speaker"))
3415             t = "audio-speakers";
3416         else if (pa_streq(ff, "hands-free"))
3417             t = "audio-handsfree";
3418     }
3419
3420     if (!t)
3421         if ((c = pa_proplist_gets(p, PA_PROP_DEVICE_CLASS)))
3422             if (pa_streq(c, "modem"))
3423                 t = "modem";
3424
3425     if (!t) {
3426         if (is_sink)
3427             t = "audio-card";
3428         else
3429             t = "audio-input-microphone";
3430     }
3431
3432     if ((profile = pa_proplist_gets(p, PA_PROP_DEVICE_PROFILE_NAME))) {
3433         if (strstr(profile, "analog"))
3434             s = "-analog";
3435         else if (strstr(profile, "iec958"))
3436             s = "-iec958";
3437         else if (strstr(profile, "hdmi"))
3438             s = "-hdmi";
3439     }
3440
3441     bus = pa_proplist_gets(p, PA_PROP_DEVICE_BUS);
3442
3443     pa_proplist_setf(p, PA_PROP_DEVICE_ICON_NAME, "%s%s%s%s", t, pa_strempty(s), bus ? "-" : "", pa_strempty(bus));
3444
3445     return true;
3446 }
3447
3448 bool pa_device_init_description(pa_proplist *p, pa_card *card) {
3449     const char *s, *d = NULL, *k;
3450     pa_assert(p);
3451
3452     if (pa_proplist_contains(p, PA_PROP_DEVICE_DESCRIPTION))
3453         return true;
3454
3455     if (card)
3456         if ((s = pa_proplist_gets(card->proplist, PA_PROP_DEVICE_DESCRIPTION)))
3457             d = s;
3458
3459     if (!d)
3460         if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_FORM_FACTOR)))
3461             if (pa_streq(s, "internal"))
3462                 d = _("Built-in Audio");
3463
3464     if (!d)
3465         if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_CLASS)))
3466             if (pa_streq(s, "modem"))
3467                 d = _("Modem");
3468
3469     if (!d)
3470         d = pa_proplist_gets(p, PA_PROP_DEVICE_PRODUCT_NAME);
3471
3472     if (!d)
3473         return false;
3474
3475     k = pa_proplist_gets(p, PA_PROP_DEVICE_PROFILE_DESCRIPTION);
3476
3477     if (d && k)
3478         pa_proplist_setf(p, PA_PROP_DEVICE_DESCRIPTION, "%s %s", d, k);
3479     else if (d)
3480         pa_proplist_sets(p, PA_PROP_DEVICE_DESCRIPTION, d);
3481
3482     return true;
3483 }
3484
3485 bool pa_device_init_intended_roles(pa_proplist *p) {
3486     const char *s;
3487     pa_assert(p);
3488
3489     if (pa_proplist_contains(p, PA_PROP_DEVICE_INTENDED_ROLES))
3490         return true;
3491
3492     if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_FORM_FACTOR)))
3493         if (pa_streq(s, "handset") || pa_streq(s, "hands-free")
3494             || pa_streq(s, "headset")) {
3495             pa_proplist_sets(p, PA_PROP_DEVICE_INTENDED_ROLES, "phone");
3496             return true;
3497         }
3498
3499     return false;
3500 }
3501
3502 unsigned pa_device_init_priority(pa_proplist *p) {
3503     const char *s;
3504     unsigned priority = 0;
3505
3506     pa_assert(p);
3507
3508     if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_CLASS))) {
3509
3510         if (pa_streq(s, "sound"))
3511             priority += 9000;
3512         else if (!pa_streq(s, "modem"))
3513             priority += 1000;
3514     }
3515
3516     if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_FORM_FACTOR))) {
3517
3518         if (pa_streq(s, "internal"))
3519             priority += 900;
3520         else if (pa_streq(s, "speaker"))
3521             priority += 500;
3522         else if (pa_streq(s, "headphone"))
3523             priority += 400;
3524     }
3525
3526     if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_BUS))) {
3527
3528         if (pa_streq(s, "pci"))
3529             priority += 50;
3530         else if (pa_streq(s, "usb"))
3531             priority += 40;
3532         else if (pa_streq(s, "bluetooth"))
3533             priority += 30;
3534     }
3535
3536     if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_PROFILE_NAME))) {
3537
3538         if (pa_startswith(s, "analog-"))
3539             priority += 9;
3540         else if (pa_startswith(s, "iec958-"))
3541             priority += 8;
3542     }
3543
3544     return priority;
3545 }
3546
3547 PA_STATIC_FLIST_DECLARE(pa_sink_volume_change, 0, pa_xfree);
3548
3549 /* Called from the IO thread. */
3550 static pa_sink_volume_change *pa_sink_volume_change_new(pa_sink *s) {
3551     pa_sink_volume_change *c;
3552     if (!(c = pa_flist_pop(PA_STATIC_FLIST_GET(pa_sink_volume_change))))
3553         c = pa_xnew(pa_sink_volume_change, 1);
3554
3555     PA_LLIST_INIT(pa_sink_volume_change, c);
3556     c->at = 0;
3557     pa_cvolume_reset(&c->hw_volume, s->sample_spec.channels);
3558     return c;
3559 }
3560
3561 /* Called from the IO thread. */
3562 static void pa_sink_volume_change_free(pa_sink_volume_change *c) {
3563     pa_assert(c);
3564     if (pa_flist_push(PA_STATIC_FLIST_GET(pa_sink_volume_change), c) < 0)
3565         pa_xfree(c);
3566 }
3567
3568 /* Called from the IO thread. */
3569 void pa_sink_volume_change_push(pa_sink *s) {
3570     pa_sink_volume_change *c = NULL;
3571     pa_sink_volume_change *nc = NULL;
3572     pa_sink_volume_change *pc = NULL;
3573     uint32_t safety_margin = s->thread_info.volume_change_safety_margin;
3574
3575     const char *direction = NULL;
3576
3577     pa_assert(s);
3578     nc = pa_sink_volume_change_new(s);
3579
3580     /* NOTE: There is already more different volumes in pa_sink that I can remember.
3581      *       Adding one more volume for HW would get us rid of this, but I am trying
3582      *       to survive with the ones we already have. */
3583     pa_sw_cvolume_divide(&nc->hw_volume, &s->real_volume, &s->soft_volume);
3584
3585     if (!s->thread_info.volume_changes && pa_cvolume_equal(&nc->hw_volume, &s->thread_info.current_hw_volume)) {
3586         pa_log_debug("Volume not changing");
3587         pa_sink_volume_change_free(nc);
3588         return;
3589     }
3590
3591     nc->at = pa_sink_get_latency_within_thread(s);
3592     nc->at += pa_rtclock_now() + s->thread_info.volume_change_extra_delay;
3593
3594     if (s->thread_info.volume_changes_tail) {
3595         for (c = s->thread_info.volume_changes_tail; c; c = c->prev) {
3596             /* If volume is going up let's do it a bit late. If it is going
3597              * down let's do it a bit early. */
3598             if (pa_cvolume_avg(&nc->hw_volume) > pa_cvolume_avg(&c->hw_volume)) {
3599                 if (nc->at + safety_margin > c->at) {
3600                     nc->at += safety_margin;
3601                     direction = "up";
3602                     break;
3603                 }
3604             }
3605             else if (nc->at - safety_margin > c->at) {
3606                     nc->at -= safety_margin;
3607                     direction = "down";
3608                     break;
3609             }
3610         }
3611     }
3612
3613     if (c == NULL) {
3614         if (pa_cvolume_avg(&nc->hw_volume) > pa_cvolume_avg(&s->thread_info.current_hw_volume)) {
3615             nc->at += safety_margin;
3616             direction = "up";
3617         } else {
3618             nc->at -= safety_margin;
3619             direction = "down";
3620         }
3621         PA_LLIST_PREPEND(pa_sink_volume_change, s->thread_info.volume_changes, nc);
3622     }
3623     else {
3624         PA_LLIST_INSERT_AFTER(pa_sink_volume_change, s->thread_info.volume_changes, c, nc);
3625     }
3626
3627     pa_log_debug("Volume going %s to %d at %llu", direction, pa_cvolume_avg(&nc->hw_volume), (long long unsigned) nc->at);
3628
3629     /* We can ignore volume events that came earlier but should happen later than this. */
3630     PA_LLIST_FOREACH_SAFE(c, pc, nc->next) {
3631         pa_log_debug("Volume change to %d at %llu was dropped", pa_cvolume_avg(&c->hw_volume), (long long unsigned) c->at);
3632         pa_sink_volume_change_free(c);
3633     }
3634     nc->next = NULL;
3635     s->thread_info.volume_changes_tail = nc;
3636 }
3637
3638 /* Called from the IO thread. */
3639 static void pa_sink_volume_change_flush(pa_sink *s) {
3640     pa_sink_volume_change *c = s->thread_info.volume_changes;
3641     pa_assert(s);
3642     s->thread_info.volume_changes = NULL;
3643     s->thread_info.volume_changes_tail = NULL;
3644     while (c) {
3645         pa_sink_volume_change *next = c->next;
3646         pa_sink_volume_change_free(c);
3647         c = next;
3648     }
3649 }
3650
3651 /* Called from the IO thread. */
3652 bool pa_sink_volume_change_apply(pa_sink *s, pa_usec_t *usec_to_next) {
3653     pa_usec_t now;
3654     bool ret = false;
3655
3656     pa_assert(s);
3657
3658     if (!s->thread_info.volume_changes || !PA_SINK_IS_LINKED(s->state)) {
3659         if (usec_to_next)
3660             *usec_to_next = 0;
3661         return ret;
3662     }
3663
3664     pa_assert(s->write_volume);
3665
3666     now = pa_rtclock_now();
3667
3668     while (s->thread_info.volume_changes && now >= s->thread_info.volume_changes->at) {
3669         pa_sink_volume_change *c = s->thread_info.volume_changes;
3670         PA_LLIST_REMOVE(pa_sink_volume_change, s->thread_info.volume_changes, c);
3671         pa_log_debug("Volume change to %d at %llu was written %llu usec late",
3672                      pa_cvolume_avg(&c->hw_volume), (long long unsigned) c->at, (long long unsigned) (now - c->at));
3673         ret = true;
3674         s->thread_info.current_hw_volume = c->hw_volume;
3675         pa_sink_volume_change_free(c);
3676     }
3677
3678     if (ret)
3679         s->write_volume(s);
3680
3681     if (s->thread_info.volume_changes) {
3682         if (usec_to_next)
3683             *usec_to_next = s->thread_info.volume_changes->at - now;
3684         if (pa_log_ratelimit(PA_LOG_DEBUG))
3685             pa_log_debug("Next volume change in %lld usec", (long long) (s->thread_info.volume_changes->at - now));
3686     }
3687     else {
3688         if (usec_to_next)
3689             *usec_to_next = 0;
3690         s->thread_info.volume_changes_tail = NULL;
3691     }
3692     return ret;
3693 }
3694
3695 /* Called from the IO thread. */
3696 static void pa_sink_volume_change_rewind(pa_sink *s, size_t nbytes) {
3697     /* All the queued volume events later than current latency are shifted to happen earlier. */
3698     pa_sink_volume_change *c;
3699     pa_volume_t prev_vol = pa_cvolume_avg(&s->thread_info.current_hw_volume);
3700     pa_usec_t rewound = pa_bytes_to_usec(nbytes, &s->sample_spec);
3701     pa_usec_t limit = pa_sink_get_latency_within_thread(s);
3702
3703     pa_log_debug("latency = %lld", (long long) limit);
3704     limit += pa_rtclock_now() + s->thread_info.volume_change_extra_delay;
3705
3706     PA_LLIST_FOREACH(c, s->thread_info.volume_changes) {
3707         pa_usec_t modified_limit = limit;
3708         if (prev_vol > pa_cvolume_avg(&c->hw_volume))
3709             modified_limit -= s->thread_info.volume_change_safety_margin;
3710         else
3711             modified_limit += s->thread_info.volume_change_safety_margin;
3712         if (c->at > modified_limit) {
3713             c->at -= rewound;
3714             if (c->at < modified_limit)
3715                 c->at = modified_limit;
3716         }
3717         prev_vol = pa_cvolume_avg(&c->hw_volume);
3718     }
3719     pa_sink_volume_change_apply(s, NULL);
3720 }
3721
3722 /* Called from the main thread */
3723 /* Gets the list of formats supported by the sink. The members and idxset must
3724  * be freed by the caller. */
3725 pa_idxset* pa_sink_get_formats(pa_sink *s) {
3726     pa_idxset *ret;
3727
3728     pa_assert(s);
3729
3730     if (s->get_formats) {
3731         /* Sink supports format query, all is good */
3732         ret = s->get_formats(s);
3733     } else {
3734         /* Sink doesn't support format query, so assume it does PCM */
3735         pa_format_info *f = pa_format_info_new();
3736         f->encoding = PA_ENCODING_PCM;
3737
3738         ret = pa_idxset_new(NULL, NULL);
3739         pa_idxset_put(ret, f, NULL);
3740     }
3741
3742     return ret;
3743 }
3744
3745 /* Called from the main thread */
3746 /* Allows an external source to set what formats a sink supports if the sink
3747  * permits this. The function makes a copy of the formats on success. */
3748 bool pa_sink_set_formats(pa_sink *s, pa_idxset *formats) {
3749     pa_assert(s);
3750     pa_assert(formats);
3751
3752     if (s->set_formats)
3753         /* Sink supports setting formats -- let's give it a shot */
3754         return s->set_formats(s, formats);
3755     else
3756         /* Sink doesn't support setting this -- bail out */
3757         return false;
3758 }
3759
3760 /* Called from the main thread */
3761 /* Checks if the sink can accept this format */
3762 bool pa_sink_check_format(pa_sink *s, pa_format_info *f) {
3763     pa_idxset *formats = NULL;
3764     bool ret = false;
3765
3766     pa_assert(s);
3767     pa_assert(f);
3768
3769     formats = pa_sink_get_formats(s);
3770
3771     if (formats) {
3772         pa_format_info *finfo_device;
3773         uint32_t i;
3774
3775         PA_IDXSET_FOREACH(finfo_device, formats, i) {
3776             if (pa_format_info_is_compatible(finfo_device, f)) {
3777                 ret = true;
3778                 break;
3779             }
3780         }
3781
3782         pa_idxset_free(formats, (pa_free_cb_t) pa_format_info_free);
3783     }
3784
3785     return ret;
3786 }
3787
3788 /* Called from the main thread */
3789 /* Calculates the intersection between formats supported by the sink and
3790  * in_formats, and returns these, in the order of the sink's formats. */
3791 pa_idxset* pa_sink_check_formats(pa_sink *s, pa_idxset *in_formats) {
3792     pa_idxset *out_formats = pa_idxset_new(NULL, NULL), *sink_formats = NULL;
3793     pa_format_info *f_sink, *f_in;
3794     uint32_t i, j;
3795
3796     pa_assert(s);
3797
3798     if (!in_formats || pa_idxset_isempty(in_formats))
3799         goto done;
3800
3801     sink_formats = pa_sink_get_formats(s);
3802
3803     PA_IDXSET_FOREACH(f_sink, sink_formats, i) {
3804         PA_IDXSET_FOREACH(f_in, in_formats, j) {
3805             if (pa_format_info_is_compatible(f_sink, f_in))
3806                 pa_idxset_put(out_formats, pa_format_info_copy(f_in), NULL);
3807         }
3808     }
3809
3810 done:
3811     if (sink_formats)
3812         pa_idxset_free(sink_formats, (pa_free_cb_t) pa_format_info_free);
3813
3814     return out_formats;
3815 }
3816
3817 /* Called from the main thread. */
3818 void pa_sink_set_reference_volume_direct(pa_sink *s, const pa_cvolume *volume) {
3819     pa_cvolume old_volume;
3820     char old_volume_str[PA_CVOLUME_SNPRINT_VERBOSE_MAX];
3821     char new_volume_str[PA_CVOLUME_SNPRINT_VERBOSE_MAX];
3822
3823     pa_assert(s);
3824     pa_assert(volume);
3825
3826     old_volume = s->reference_volume;
3827
3828     if (pa_cvolume_equal(volume, &old_volume))
3829         return;
3830
3831     s->reference_volume = *volume;
3832     pa_log_debug("The reference volume of sink %s changed from %s to %s.", s->name,
3833                  pa_cvolume_snprint_verbose(old_volume_str, sizeof(old_volume_str), &old_volume, &s->channel_map,
3834                                             s->flags & PA_SINK_DECIBEL_VOLUME),
3835                  pa_cvolume_snprint_verbose(new_volume_str, sizeof(new_volume_str), volume, &s->channel_map,
3836                                             s->flags & PA_SINK_DECIBEL_VOLUME));
3837
3838     pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
3839     pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_VOLUME_CHANGED], s);
3840 }