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