src/pulsecore/sink-input.c

   1 /***
   2   This file is part of PulseAudio.
   3
   4   Copyright 2004-2006 Lennart Poettering
   5   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
   6
   7   PulseAudio is free software; you can redistribute it and/or modify
   8   it under the terms of the GNU Lesser General Public License as published
   9   by the Free Software Foundation; either version 2 of the License,
  10   or (at your option) any later version.
  11
  12   PulseAudio is distributed in the hope that it will be useful, but
  13   WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15   General Public License for more details.
  16
  17   You should have received a copy of the GNU Lesser General Public License
  18   along with PulseAudio; if not, write to the Free Software
  19   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  20   USA.
  21 ***/
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include <config.h>
  25 #endif
  26
  27 #include <stdio.h>
  28 #include <stdlib.h>
  29 #include <string.h>
  30
  31 #include <pulse/utf8.h>
  32 #include <pulse/xmalloc.h>
  33 #include <pulse/util.h>
  34
  35 #include <pulsecore/sample-util.h>
  36 #include <pulsecore/core-subscribe.h>
  37 #include <pulsecore/log.h>
  38 #include <pulsecore/play-memblockq.h>
  39 #include <pulsecore/namereg.h>
  40 #include <pulsecore/core-util.h>
  41
  42 #include "sink-input.h"
  43
  44 #define MEMBLOCKQ_MAXLENGTH (32*1024*1024)
  45 #define CONVERT_BUFFER_LENGTH (PA_PAGE_SIZE)
  46
  47 static PA_DEFINE_CHECK_TYPE(pa_sink_input, pa_msgobject);
  48
  49 static void sink_input_free(pa_object *o);
  50
  51 pa_sink_input_new_data* pa_sink_input_new_data_init(pa_sink_input_new_data *data) {
  52     pa_assert(data);
  53
  54     memset(data, 0, sizeof(*data));
  55     data->resample_method = PA_RESAMPLER_INVALID;
  56     data->proplist = pa_proplist_new();
  57
  58     return data;
  59 }
  60
  61 void pa_sink_input_new_data_set_sample_spec(pa_sink_input_new_data *data, const pa_sample_spec *spec) {
  62     pa_assert(data);
  63
  64     if ((data->sample_spec_is_set = !!spec))
  65         data->sample_spec = *spec;
  66 }
  67
  68 void pa_sink_input_new_data_set_channel_map(pa_sink_input_new_data *data, const pa_channel_map *map) {
  69     pa_assert(data);
  70
  71     if ((data->channel_map_is_set = !!map))
  72         data->channel_map = *map;
  73 }
  74
  75 void pa_sink_input_new_data_set_volume(pa_sink_input_new_data *data, const pa_cvolume *volume) {
  76     pa_assert(data);
  77
  78     if ((data->volume_is_set = !!volume))
  79         data->volume = *volume;
  80 }
  81
  82 void pa_sink_input_new_data_apply_volume_factor(pa_sink_input_new_data *data, const pa_cvolume *volume_factor) {
  83     pa_assert(data);
  84     pa_assert(volume_factor);
  85
  86     if (data->volume_factor_is_set)
  87         pa_sw_cvolume_multiply(&data->volume_factor, &data->volume_factor, volume_factor);
  88     else {
  89         data->volume_factor_is_set = TRUE;
  90         data->volume_factor = *volume_factor;
  91     }
  92 }
  93
  94 void pa_sink_input_new_data_set_muted(pa_sink_input_new_data *data, pa_bool_t mute) {
  95     pa_assert(data);
  96
  97     data->muted_is_set = TRUE;
  98     data->muted = !!mute;
  99 }
 100
 101 void pa_sink_input_new_data_done(pa_sink_input_new_data *data) {
 102     pa_assert(data);
 103
 104     pa_proplist_free(data->proplist);
 105 }
 106
 107 /* Called from main context */
 108 static void reset_callbacks(pa_sink_input *i) {
 109     pa_assert(i);
 110
 111     i->pop = NULL;
 112     i->process_rewind = NULL;
 113     i->update_max_rewind = NULL;
 114     i->update_max_request = NULL;
 115     i->update_sink_requested_latency = NULL;
 116     i->update_sink_latency_range = NULL;
 117     i->attach = NULL;
 118     i->detach = NULL;
 119     i->suspend = NULL;
 120     i->moved = NULL;
 121     i->kill = NULL;
 122     i->get_latency = NULL;
 123     i->state_change = NULL;
 124     i->may_move_to = NULL;
 125 }
 126
 127 /* Called from main context */
 128 int pa_sink_input_new(
 129         pa_sink_input **_i,
 130         pa_core *core,
 131         pa_sink_input_new_data *data,
 132         pa_sink_input_flags_t flags) {
 133
 134     pa_sink_input *i;
 135     pa_resampler *resampler = NULL;
 136     char st[PA_SAMPLE_SPEC_SNPRINT_MAX], cm[PA_CHANNEL_MAP_SNPRINT_MAX];
 137     pa_channel_map original_cm;
 138     int r;
 139
 140     pa_assert(_i);
 141     pa_assert(core);
 142     pa_assert(data);
 143
 144     if (data->client)
 145         pa_proplist_update(data->proplist, PA_UPDATE_MERGE, data->client->proplist);
 146
 147     if ((r = pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_INPUT_NEW], data)) < 0)
 148         return r;
 149
 150     pa_return_val_if_fail(!data->driver || pa_utf8_valid(data->driver), -PA_ERR_INVALID);
 151
 152     if (!data->sink) {
 153         data->sink = pa_namereg_get(core, NULL, PA_NAMEREG_SINK);
 154         data->save_sink = FALSE;
 155     }
 156
 157     pa_return_val_if_fail(data->sink, -PA_ERR_NOENTITY);
 158     pa_return_val_if_fail(PA_SINK_IS_LINKED(pa_sink_get_state(data->sink)), -PA_ERR_BADSTATE);
 159     pa_return_val_if_fail(!data->sync_base || (data->sync_base->sink == data->sink && pa_sink_input_get_state(data->sync_base) == PA_SINK_INPUT_CORKED), -PA_ERR_INVALID);
 160     pa_return_val_if_fail(!(flags & PA_SINK_INPUT_FAIL_ON_SUSPEND) || pa_sink_get_state(data->sink) != PA_SINK_SUSPENDED, -PA_ERR_BADSTATE);
 161
 162     if (!data->sample_spec_is_set)
 163         data->sample_spec = data->sink->sample_spec;
 164
 165     pa_return_val_if_fail(pa_sample_spec_valid(&data->sample_spec), -PA_ERR_INVALID);
 166
 167     if (!data->channel_map_is_set) {
 168         if (pa_channel_map_compatible(&data->sink->channel_map, &data->sample_spec))
 169             data->channel_map = data->sink->channel_map;
 170         else
 171             pa_channel_map_init_extend(&data->channel_map, data->sample_spec.channels, PA_CHANNEL_MAP_DEFAULT);
 172     }
 173
 174     pa_return_val_if_fail(pa_channel_map_valid(&data->channel_map), -PA_ERR_INVALID);
 175     pa_return_val_if_fail(pa_channel_map_compatible(&data->channel_map, &data->sample_spec), -PA_ERR_INVALID);
 176
 177     if (!data->volume_is_set) {
 178
 179         if (data->sink->flags & PA_SINK_FLAT_VOLUME) {
 180             data->volume = *pa_sink_get_volume(data->sink, FALSE);
 181             pa_cvolume_remap(&data->volume, &data->sink->channel_map, &data->channel_map);
 182             data->volume_is_absolute = TRUE;
 183         } else {
 184             pa_cvolume_reset(&data->volume, data->sample_spec.channels);
 185             data->volume_is_absolute = FALSE;
 186         }
 187
 188         data->save_volume = FALSE;
 189     }
 190
 191     pa_return_val_if_fail(pa_cvolume_valid(&data->volume), -PA_ERR_INVALID);
 192     pa_return_val_if_fail(pa_cvolume_compatible(&data->volume, &data->sample_spec), -PA_ERR_INVALID);
 193
 194     if (!data->volume_factor_is_set)
 195         pa_cvolume_reset(&data->volume_factor, data->sample_spec.channels);
 196
 197     pa_return_val_if_fail(pa_cvolume_valid(&data->volume_factor), -PA_ERR_INVALID);
 198     pa_return_val_if_fail(pa_cvolume_compatible(&data->volume_factor, &data->sample_spec), -PA_ERR_INVALID);
 199
 200     if (!data->muted_is_set)
 201         data->muted = FALSE;
 202
 203     if (flags & PA_SINK_INPUT_FIX_FORMAT)
 204         data->sample_spec.format = data->sink->sample_spec.format;
 205
 206     if (flags & PA_SINK_INPUT_FIX_RATE)
 207         data->sample_spec.rate = data->sink->sample_spec.rate;
 208
 209     original_cm = data->channel_map;
 210
 211     if (flags & PA_SINK_INPUT_FIX_CHANNELS) {
 212         data->sample_spec.channels = data->sink->sample_spec.channels;
 213         data->channel_map = data->sink->channel_map;
 214     }
 215
 216     pa_assert(pa_sample_spec_valid(&data->sample_spec));
 217     pa_assert(pa_channel_map_valid(&data->channel_map));
 218
 219     /* Due to the fixing of the sample spec the volume might not match anymore */
 220     pa_cvolume_remap(&data->volume, &original_cm, &data->channel_map);
 221
 222     if (data->resample_method == PA_RESAMPLER_INVALID)
 223         data->resample_method = core->resample_method;
 224
 225     pa_return_val_if_fail(data->resample_method < PA_RESAMPLER_MAX, -PA_ERR_INVALID);
 226
 227     if ((r = pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_INPUT_FIXATE], data)) < 0)
 228         return r;
 229
 230     if (pa_idxset_size(data->sink->inputs) >= PA_MAX_INPUTS_PER_SINK) {
 231         pa_log_warn("Failed to create sink input: too many inputs per sink.");
 232         return -PA_ERR_TOOLARGE;
 233     }
 234
 235     if ((flags & PA_SINK_INPUT_VARIABLE_RATE) ||
 236         !pa_sample_spec_equal(&data->sample_spec, &data->sink->sample_spec) ||
 237         !pa_channel_map_equal(&data->channel_map, &data->sink->channel_map)) {
 238
 239         if (!(resampler = pa_resampler_new(
 240                       core->mempool,
 241                       &data->sample_spec, &data->channel_map,
 242                       &data->sink->sample_spec, &data->sink->channel_map,
 243                       data->resample_method,
 244                       ((flags & PA_SINK_INPUT_VARIABLE_RATE) ? PA_RESAMPLER_VARIABLE_RATE : 0) |
 245                       ((flags & PA_SINK_INPUT_NO_REMAP) ? PA_RESAMPLER_NO_REMAP : 0) |
 246                       (core->disable_remixing || (flags & PA_SINK_INPUT_NO_REMIX) ? PA_RESAMPLER_NO_REMIX : 0) |
 247                       (core->disable_lfe_remixing ? PA_RESAMPLER_NO_LFE : 0)))) {
 248             pa_log_warn("Unsupported resampling operation.");
 249             return -PA_ERR_NOTSUPPORTED;
 250         }
 251     }
 252
 253     i = pa_msgobject_new(pa_sink_input);
 254     i->parent.parent.free = sink_input_free;
 255     i->parent.process_msg = pa_sink_input_process_msg;
 256
 257     i->core = core;
 258     i->state = PA_SINK_INPUT_INIT;
 259     i->flags = flags;
 260     i->proplist = pa_proplist_copy(data->proplist);
 261     i->driver = pa_xstrdup(pa_path_get_filename(data->driver));
 262     i->module = data->module;
 263     i->sink = data->sink;
 264     i->client = data->client;
 265
 266     i->requested_resample_method = data->resample_method;
 267     i->actual_resample_method = resampler ? pa_resampler_get_method(resampler) : PA_RESAMPLER_INVALID;
 268     i->sample_spec = data->sample_spec;
 269     i->channel_map = data->channel_map;
 270
 271     if ((i->sink->flags & PA_SINK_FLAT_VOLUME) && !data->volume_is_absolute) {
 272         /* When the 'absolute' bool is not set then we'll treat the volume
 273          * as relative to the sink volume even in flat volume mode */
 274
 275         pa_cvolume t = *pa_sink_get_volume(data->sink, FALSE);
 276         pa_cvolume_remap(&t, &data->sink->channel_map, &data->channel_map);
 277
 278         pa_sw_cvolume_multiply(&i->virtual_volume, &data->volume, &t);
 279     } else
 280         i->virtual_volume = data->volume;
 281
 282     i->volume_factor = data->volume_factor;
 283     pa_cvolume_init(&i->soft_volume);
 284     i->save_volume = data->save_volume;
 285     i->save_sink = data->save_sink;
 286     i->save_muted = data->save_muted;
 287
 288     i->muted = data->muted;
 289
 290     if (data->sync_base) {
 291         i->sync_next = data->sync_base->sync_next;
 292         i->sync_prev = data->sync_base;
 293
 294         if (data->sync_base->sync_next)
 295             data->sync_base->sync_next->sync_prev = i;
 296         data->sync_base->sync_next = i;
 297     } else
 298         i->sync_next = i->sync_prev = NULL;
 299
 300     i->direct_outputs = pa_idxset_new(NULL, NULL);
 301
 302     reset_callbacks(i);
 303     i->userdata = NULL;
 304
 305     i->thread_info.state = i->state;
 306     i->thread_info.attached = FALSE;
 307     pa_atomic_store(&i->thread_info.drained, 1);
 308     i->thread_info.sample_spec = i->sample_spec;
 309     i->thread_info.resampler = resampler;
 310     i->thread_info.soft_volume = i->soft_volume;
 311     i->thread_info.muted = i->muted;
 312     i->thread_info.requested_sink_latency = (pa_usec_t) -1;
 313     i->thread_info.rewrite_nbytes = 0;
 314     i->thread_info.rewrite_flush = FALSE;
 315     i->thread_info.dont_rewind_render = FALSE;
 316     i->thread_info.underrun_for = (uint64_t) -1;
 317     i->thread_info.playing_for = 0;
 318     i->thread_info.direct_outputs = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
 319
 320     i->thread_info.render_memblockq = pa_memblockq_new(
 321             0,
 322             MEMBLOCKQ_MAXLENGTH,
 323             0,
 324             pa_frame_size(&i->sink->sample_spec),
 325             0,
 326             1,
 327             0,
 328             &i->sink->silence);
 329
 330     pa_assert_se(pa_idxset_put(core->sink_inputs, pa_sink_input_ref(i), &i->index) == 0);
 331     pa_assert_se(pa_idxset_put(i->sink->inputs, i, NULL) == 0);
 332
 333     if (i->client)
 334         pa_assert_se(pa_idxset_put(i->client->sink_inputs, i, NULL) >= 0);
 335
 336     pa_log_info("Created input %u \"%s\" on %s with sample spec %s and channel map %s",
 337                 i->index,
 338                 pa_strnull(pa_proplist_gets(i->proplist, PA_PROP_MEDIA_NAME)),
 339                 i->sink->name,
 340                 pa_sample_spec_snprint(st, sizeof(st), &i->sample_spec),
 341                 pa_channel_map_snprint(cm, sizeof(cm), &i->channel_map));
 342
 343     /* Don't forget to call pa_sink_input_put! */
 344
 345     *_i = i;
 346     return 0;
 347 }
 348
 349 /* Called from main context */
 350 static void update_n_corked(pa_sink_input *i, pa_sink_input_state_t state) {
 351     pa_assert(i);
 352
 353     if (!i->sink)
 354         return;
 355
 356     if (i->state == PA_SINK_INPUT_CORKED && state != PA_SINK_INPUT_CORKED)
 357         pa_assert_se(i->sink->n_corked -- >= 1);
 358     else if (i->state != PA_SINK_INPUT_CORKED && state == PA_SINK_INPUT_CORKED)
 359         i->sink->n_corked++;
 360 }
 361
 362 /* Called from main context */
 363 static void sink_input_set_state(pa_sink_input *i, pa_sink_input_state_t state) {
 364     pa_sink_input *ssync;
 365     pa_assert(i);
 366
 367     if (state == PA_SINK_INPUT_DRAINED)
 368         state = PA_SINK_INPUT_RUNNING;
 369
 370     if (i->state == state)
 371         return;
 372
 373     pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL) == 0);
 374
 375     update_n_corked(i, state);
 376     i->state = state;
 377
 378     for (ssync = i->sync_prev; ssync; ssync = ssync->sync_prev) {
 379         update_n_corked(ssync, state);
 380         ssync->state = state;
 381     }
 382     for (ssync = i->sync_next; ssync; ssync = ssync->sync_next) {
 383         update_n_corked(ssync, state);
 384         ssync->state = state;
 385     }
 386
 387     if (state != PA_SINK_INPUT_UNLINKED) {
 388         pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED], i);
 389
 390         for (ssync = i->sync_prev; ssync; ssync = ssync->sync_prev)
 391             pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED], ssync);
 392
 393         for (ssync = i->sync_next; ssync; ssync = ssync->sync_next)
 394             pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED], ssync);
 395     }
 396
 397     pa_sink_update_status(i->sink);
 398 }
 399
 400 /* Called from main context */
 401 void pa_sink_input_unlink(pa_sink_input *i) {
 402     pa_bool_t linked;
 403     pa_source_output *o, *p =  NULL;
 404     pa_assert(i);
 405
 406     /* See pa_sink_unlink() for a couple of comments how this function
 407      * works */
 408
 409     pa_sink_input_ref(i);
 410
 411     linked = PA_SINK_INPUT_IS_LINKED(i->state);
 412
 413     if (linked)
 414         pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_UNLINK], i);
 415
 416     if (i->sync_prev)
 417         i->sync_prev->sync_next = i->sync_next;
 418     if (i->sync_next)
 419         i->sync_next->sync_prev = i->sync_prev;
 420
 421     i->sync_prev = i->sync_next = NULL;
 422
 423     pa_idxset_remove_by_data(i->core->sink_inputs, i, NULL);
 424
 425     if (i->sink)
 426         if (pa_idxset_remove_by_data(i->sink->inputs, i, NULL))
 427             pa_sink_input_unref(i);
 428
 429     if (i->client)
 430         pa_idxset_remove_by_data(i->client->sink_inputs, i, NULL);
 431
 432     while ((o = pa_idxset_first(i->direct_outputs, NULL))) {
 433         pa_assert(o != p);
 434         pa_source_output_kill(o);
 435         p = o;
 436     }
 437
 438     update_n_corked(i, PA_SINK_INPUT_UNLINKED);
 439     i->state = PA_SINK_INPUT_UNLINKED;
 440
 441     if (linked && i->sink) {
 442         /* We might need to update the sink's volume if we are in flat volume mode. */
 443         if (i->sink->flags & PA_SINK_FLAT_VOLUME) {
 444             pa_cvolume new_volume;
 445             pa_sink_update_flat_volume(i->sink, &new_volume);
 446             pa_sink_set_volume(i->sink, &new_volume, FALSE, FALSE);
 447         }
 448
 449         if (i->sink->asyncmsgq)
 450             pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_REMOVE_INPUT, i, 0, NULL) == 0);
 451     }
 452
 453     reset_callbacks(i);
 454
 455     if (linked) {
 456         pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_REMOVE, i->index);
 457         pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_UNLINK_POST], i);
 458     }
 459
 460     if (i->sink) {
 461         pa_sink_update_status(i->sink);
 462         i->sink = NULL;
 463     }
 464
 465     pa_sink_input_unref(i);
 466 }
 467
 468 /* Called from main context */
 469 static void sink_input_free(pa_object *o) {
 470     pa_sink_input* i = PA_SINK_INPUT(o);
 471
 472     pa_assert(i);
 473     pa_assert(pa_sink_input_refcnt(i) == 0);
 474
 475     if (PA_SINK_INPUT_IS_LINKED(i->state))
 476         pa_sink_input_unlink(i);
 477
 478     pa_log_info("Freeing input %u \"%s\"", i->index, pa_strnull(pa_proplist_gets(i->proplist, PA_PROP_MEDIA_NAME)));
 479
 480     pa_assert(!i->thread_info.attached);
 481
 482     if (i->thread_info.render_memblockq)
 483         pa_memblockq_free(i->thread_info.render_memblockq);
 484
 485     if (i->thread_info.resampler)
 486         pa_resampler_free(i->thread_info.resampler);
 487
 488     if (i->proplist)
 489         pa_proplist_free(i->proplist);
 490
 491     if (i->direct_outputs)
 492         pa_idxset_free(i->direct_outputs, NULL, NULL);
 493
 494     if (i->thread_info.direct_outputs)
 495         pa_hashmap_free(i->thread_info.direct_outputs, NULL, NULL);
 496
 497     pa_xfree(i->driver);
 498     pa_xfree(i);
 499 }
 500
 501 /* Called from main context */
 502 void pa_sink_input_put(pa_sink_input *i) {
 503     pa_sink_input_state_t state;
 504     pa_sink_input_assert_ref(i);
 505
 506     pa_assert(i->state == PA_SINK_INPUT_INIT);
 507
 508     /* The following fields must be initialized properly */
 509     pa_assert(i->pop);
 510     pa_assert(i->process_rewind);
 511     pa_assert(i->kill);
 512
 513     state = i->flags & PA_SINK_INPUT_START_CORKED ? PA_SINK_INPUT_CORKED : PA_SINK_INPUT_RUNNING;
 514
 515     update_n_corked(i, state);
 516     i->state = state;
 517
 518     /* We might need to update the sink's volume if we are in flat volume mode. */
 519     if (i->sink->flags & PA_SINK_FLAT_VOLUME) {
 520         pa_cvolume new_volume;
 521         pa_sink_update_flat_volume(i->sink, &new_volume);
 522         pa_sink_set_volume(i->sink, &new_volume, FALSE, FALSE);
 523     } else
 524         pa_sw_cvolume_multiply(&i->soft_volume, &i->virtual_volume, &i->volume_factor);
 525
 526     i->thread_info.soft_volume = i->soft_volume;
 527     i->thread_info.muted = i->muted;
 528
 529     pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_ADD_INPUT, i, 0, NULL) == 0);
 530
 531     pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_NEW, i->index);
 532     pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_PUT], i);
 533
 534     pa_sink_update_status(i->sink);
 535 }
 536
 537 /* Called from main context */
 538 void pa_sink_input_kill(pa_sink_input*i) {
 539     pa_sink_input_assert_ref(i);
 540     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
 541
 542     i->kill(i);
 543 }
 544
 545 /* Called from main context */
 546 pa_usec_t pa_sink_input_get_latency(pa_sink_input *i, pa_usec_t *sink_latency) {
 547     pa_usec_t r[2] = { 0, 0 };
 548
 549     pa_sink_input_assert_ref(i);
 550     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
 551
 552     pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_GET_LATENCY, r, 0, NULL) == 0);
 553
 554     if (i->get_latency)
 555         r[0] += i->get_latency(i);
 556
 557     if (sink_latency)
 558         *sink_latency = r[1];
 559
 560     return r[0];
 561 }
 562
 563 /* Called from thread context */
 564 void pa_sink_input_peek(pa_sink_input *i, size_t slength /* in sink frames */, pa_memchunk *chunk, pa_cvolume *volume) {
 565     pa_bool_t do_volume_adj_here;
 566     pa_bool_t volume_is_norm;
 567     size_t block_size_max_sink, block_size_max_sink_input;
 568     size_t ilength;
 569
 570     pa_sink_input_assert_ref(i);
 571     pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
 572     pa_assert(pa_frame_aligned(slength, &i->sink->sample_spec));
 573     pa_assert(chunk);
 574     pa_assert(volume);
 575
 576 /*     pa_log_debug("peek"); */
 577
 578     pa_assert(i->thread_info.state == PA_SINK_INPUT_RUNNING ||
 579               i->thread_info.state == PA_SINK_INPUT_CORKED ||
 580               i->thread_info.state == PA_SINK_INPUT_DRAINED);
 581
 582     block_size_max_sink_input = i->thread_info.resampler ?
 583         pa_resampler_max_block_size(i->thread_info.resampler) :
 584         pa_frame_align(pa_mempool_block_size_max(i->core->mempool), &i->sample_spec);
 585
 586     block_size_max_sink = pa_frame_align(pa_mempool_block_size_max(i->core->mempool), &i->sink->sample_spec);
 587
 588     /* Default buffer size */
 589     if (slength <= 0)
 590         slength = pa_frame_align(CONVERT_BUFFER_LENGTH, &i->sink->sample_spec);
 591
 592     if (slength > block_size_max_sink)
 593         slength = block_size_max_sink;
 594
 595     if (i->thread_info.resampler) {
 596         ilength = pa_resampler_request(i->thread_info.resampler, slength);
 597
 598         if (ilength <= 0)
 599             ilength = pa_frame_align(CONVERT_BUFFER_LENGTH, &i->sample_spec);
 600     } else
 601         ilength = slength;
 602
 603     if (ilength > block_size_max_sink_input)
 604         ilength = block_size_max_sink_input;
 605
 606     /* If the channel maps of the sink and this stream differ, we need
 607      * to adjust the volume *before* we resample. Otherwise we can do
 608      * it after and leave it for the sink code */
 609
 610     do_volume_adj_here = !pa_channel_map_equal(&i->channel_map, &i->sink->channel_map);
 611     volume_is_norm = pa_cvolume_is_norm(&i->thread_info.soft_volume) && !i->thread_info.muted;
 612
 613     while (!pa_memblockq_is_readable(i->thread_info.render_memblockq)) {
 614         pa_memchunk tchunk;
 615
 616         /* There's nothing in our render queue. We need to fill it up
 617          * with data from the implementor. */
 618
 619         if (i->thread_info.state == PA_SINK_INPUT_CORKED ||
 620             i->pop(i, ilength, &tchunk) < 0) {
 621
 622             /* OK, we're corked or the implementor didn't give us any
 623              * data, so let's just hand out silence */
 624             pa_atomic_store(&i->thread_info.drained, 1);
 625
 626             pa_memblockq_seek(i->thread_info.render_memblockq, (int64_t) slength, PA_SEEK_RELATIVE);
 627             i->thread_info.playing_for = 0;
 628             if (i->thread_info.underrun_for != (uint64_t) -1)
 629                 i->thread_info.underrun_for += ilength;
 630             break;
 631         }
 632
 633         pa_atomic_store(&i->thread_info.drained, 0);
 634
 635         pa_assert(tchunk.length > 0);
 636         pa_assert(tchunk.memblock);
 637
 638         i->thread_info.underrun_for = 0;
 639         i->thread_info.playing_for += tchunk.length;
 640
 641         while (tchunk.length > 0) {
 642             pa_memchunk wchunk;
 643
 644             wchunk = tchunk;
 645             pa_memblock_ref(wchunk.memblock);
 646
 647             if (wchunk.length > block_size_max_sink_input)
 648                 wchunk.length = block_size_max_sink_input;
 649
 650             /* It might be necessary to adjust the volume here */
 651             if (do_volume_adj_here && !volume_is_norm) {
 652                 pa_memchunk_make_writable(&wchunk, 0);
 653
 654                 if (i->thread_info.muted)
 655                     pa_silence_memchunk(&wchunk, &i->thread_info.sample_spec);
 656                 else
 657                     pa_volume_memchunk(&wchunk, &i->thread_info.sample_spec, &i->thread_info.soft_volume);
 658             }
 659
 660             if (!i->thread_info.resampler)
 661                 pa_memblockq_push_align(i->thread_info.render_memblockq, &wchunk);
 662             else {
 663                 pa_memchunk rchunk;
 664                 pa_resampler_run(i->thread_info.resampler, &wchunk, &rchunk);
 665
 666 /*                 pa_log_debug("pushing %lu", (unsigned long) rchunk.length); */
 667
 668                 if (rchunk.memblock) {
 669                     pa_memblockq_push_align(i->thread_info.render_memblockq, &rchunk);
 670                     pa_memblock_unref(rchunk.memblock);
 671                 }
 672             }
 673
 674             pa_memblock_unref(wchunk.memblock);
 675
 676             tchunk.index += wchunk.length;
 677             tchunk.length -= wchunk.length;
 678         }
 679
 680         pa_memblock_unref(tchunk.memblock);
 681     }
 682
 683     pa_assert_se(pa_memblockq_peek(i->thread_info.render_memblockq, chunk) >= 0);
 684
 685     pa_assert(chunk->length > 0);
 686     pa_assert(chunk->memblock);
 687
 688 /*     pa_log_debug("peeking %lu", (unsigned long) chunk->length); */
 689
 690     if (chunk->length > block_size_max_sink)
 691         chunk->length = block_size_max_sink;
 692
 693     /* Let's see if we had to apply the volume adjustment ourselves,
 694      * or if this can be done by the sink for us */
 695
 696     if (do_volume_adj_here)
 697         /* We had different channel maps, so we already did the adjustment */
 698         pa_cvolume_reset(volume, i->sink->sample_spec.channels);
 699     else if (i->thread_info.muted)
 700         /* We've both the same channel map, so let's have the sink do the adjustment for us*/
 701         pa_cvolume_mute(volume, i->sink->sample_spec.channels);
 702     else
 703         *volume = i->thread_info.soft_volume;
 704 }
 705
 706 /* Called from thread context */
 707 void pa_sink_input_drop(pa_sink_input *i, size_t nbytes /* in sink sample spec */) {
 708     pa_sink_input_assert_ref(i);
 709
 710     pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
 711     pa_assert(pa_frame_aligned(nbytes, &i->sink->sample_spec));
 712     pa_assert(nbytes > 0);
 713
 714 /*     pa_log_debug("dropping %lu", (unsigned long) nbytes); */
 715
 716     pa_memblockq_drop(i->thread_info.render_memblockq, nbytes);
 717 }
 718
 719 /* Called from thread context */
 720 void pa_sink_input_process_rewind(pa_sink_input *i, size_t nbytes /* in sink sample spec */) {
 721     size_t lbq;
 722     pa_bool_t called = FALSE;
 723     pa_sink_input_assert_ref(i);
 724
 725     pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
 726     pa_assert(pa_frame_aligned(nbytes, &i->sink->sample_spec));
 727
 728 /*     pa_log_debug("rewind(%lu, %lu)", (unsigned long) nbytes, (unsigned long) i->thread_info.rewrite_nbytes); */
 729
 730     lbq = pa_memblockq_get_length(i->thread_info.render_memblockq);
 731
 732     if (nbytes > 0 && !i->thread_info.dont_rewind_render) {
 733         pa_log_debug("Have to rewind %lu bytes on render memblockq.", (unsigned long) nbytes);
 734         pa_memblockq_rewind(i->thread_info.render_memblockq, nbytes);
 735     }
 736
 737     if (i->thread_info.rewrite_nbytes == (size_t) -1) {
 738
 739         /* We were asked to drop all buffered data, and rerequest new
 740          * data from implementor the next time push() is called */
 741
 742         pa_memblockq_flush_write(i->thread_info.render_memblockq);
 743
 744     } else if (i->thread_info.rewrite_nbytes > 0) {
 745         size_t max_rewrite, amount;
 746
 747         /* Calculate how much make sense to rewrite at most */
 748         max_rewrite = nbytes + lbq;
 749
 750         /* Transform into local domain */
 751         if (i->thread_info.resampler)
 752             max_rewrite = pa_resampler_request(i->thread_info.resampler, max_rewrite);
 753
 754         /* Calculate how much of the rewinded data should actually be rewritten */
 755         amount = PA_MIN(i->thread_info.rewrite_nbytes, max_rewrite);
 756
 757         if (amount > 0) {
 758             pa_log_debug("Have to rewind %lu bytes on implementor.", (unsigned long) amount);
 759
 760             /* Tell the implementor */
 761             if (i->process_rewind)
 762                 i->process_rewind(i, amount);
 763             called = TRUE;
 764
 765             /* Convert back to to sink domain */
 766             if (i->thread_info.resampler)
 767                 amount = pa_resampler_result(i->thread_info.resampler, amount);
 768
 769             if (amount > 0)
 770                 /* Ok, now update the write pointer */
 771                 pa_memblockq_seek(i->thread_info.render_memblockq, - ((int64_t) amount), PA_SEEK_RELATIVE);
 772
 773             if (i->thread_info.rewrite_flush)
 774                 pa_memblockq_silence(i->thread_info.render_memblockq);
 775
 776             /* And reset the resampler */
 777             if (i->thread_info.resampler)
 778                 pa_resampler_reset(i->thread_info.resampler);
 779         }
 780     }
 781
 782     if (!called)
 783         if (i->process_rewind)
 784             i->process_rewind(i, 0);
 785
 786     i->thread_info.rewrite_nbytes = 0;
 787     i->thread_info.rewrite_flush = FALSE;
 788     i->thread_info.dont_rewind_render = FALSE;
 789 }
 790
 791 /* Called from thread context */
 792 void pa_sink_input_update_max_rewind(pa_sink_input *i, size_t nbytes  /* in the sink's sample spec */) {
 793     pa_sink_input_assert_ref(i);
 794     pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
 795     pa_assert(pa_frame_aligned(nbytes, &i->sink->sample_spec));
 796
 797     pa_memblockq_set_maxrewind(i->thread_info.render_memblockq, nbytes);
 798
 799     if (i->update_max_rewind)
 800         i->update_max_rewind(i, i->thread_info.resampler ? pa_resampler_request(i->thread_info.resampler, nbytes) : nbytes);
 801 }
 802
 803 /* Called from thread context */
 804 void pa_sink_input_update_max_request(pa_sink_input *i, size_t nbytes  /* in the sink's sample spec */) {
 805     pa_sink_input_assert_ref(i);
 806     pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
 807     pa_assert(pa_frame_aligned(nbytes, &i->sink->sample_spec));
 808
 809     if (i->update_max_request)
 810         i->update_max_request(i, i->thread_info.resampler ? pa_resampler_request(i->thread_info.resampler, nbytes) : nbytes);
 811 }
 812
 813 /* Called from thread context */
 814 static pa_usec_t fixup_latency(pa_sink *s, pa_usec_t usec) {
 815     pa_sink_assert_ref(s);
 816
 817     if (usec == (pa_usec_t) -1)
 818         return usec;
 819
 820     if (s->thread_info.max_latency > 0 && usec > s->thread_info.max_latency)
 821         usec = s->thread_info.max_latency;
 822
 823     if (s->thread_info.min_latency > 0 && usec < s->thread_info.min_latency)
 824         usec = s->thread_info.min_latency;
 825
 826     return usec;
 827 }
 828
 829 /* Called from thread context */
 830 pa_usec_t pa_sink_input_set_requested_latency_within_thread(pa_sink_input *i, pa_usec_t usec) {
 831     pa_sink_input_assert_ref(i);
 832
 833     usec = fixup_latency(i->sink, usec);
 834     i->thread_info.requested_sink_latency = usec;
 835     pa_sink_invalidate_requested_latency(i->sink);
 836
 837     return usec;
 838 }
 839
 840 /* Called from main context */
 841 pa_usec_t pa_sink_input_set_requested_latency(pa_sink_input *i, pa_usec_t usec) {
 842     pa_sink_input_assert_ref(i);
 843
 844     if (PA_SINK_INPUT_IS_LINKED(i->state))
 845         pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY, &usec, 0, NULL) == 0);
 846     else
 847         /* If this sink input is not realized yet, we have to touch
 848          * the thread info data directly */
 849
 850         i->thread_info.requested_sink_latency = usec;
 851
 852     return usec;
 853 }
 854
 855 /* Called from main context */
 856 pa_usec_t pa_sink_input_get_requested_latency(pa_sink_input *i) {
 857     pa_usec_t usec = 0;
 858
 859     pa_sink_input_assert_ref(i);
 860
 861     if (PA_SINK_INPUT_IS_LINKED(i->state))
 862         pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY, &usec, 0, NULL) == 0);
 863     else
 864         /* If this sink input is not realized yet, we have to touch
 865          * the thread info data directly */
 866         usec = i->thread_info.requested_sink_latency;
 867
 868     return usec;
 869 }
 870
 871 /* Called from main context */
 872 void pa_sink_input_set_volume(pa_sink_input *i, const pa_cvolume *volume, pa_bool_t save) {
 873     pa_sink_input_assert_ref(i);
 874     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
 875     pa_assert(volume);
 876     pa_assert(pa_cvolume_valid(volume));
 877     pa_assert(pa_cvolume_compatible(volume, &i->sample_spec));
 878
 879     if (pa_cvolume_equal(volume, &i->virtual_volume))
 880         return;
 881
 882     i->virtual_volume = *volume;
 883     i->save_volume = save;
 884
 885     if (i->sink->flags & PA_SINK_FLAT_VOLUME) {
 886         pa_cvolume new_volume;
 887
 888         /* We are in flat volume mode, so let's update all sink input
 889          * volumes and update the flat volume of the sink */
 890
 891         pa_sink_update_flat_volume(i->sink, &new_volume);
 892         pa_sink_set_volume(i->sink, &new_volume, FALSE, TRUE);
 893
 894     } else {
 895
 896         /* OK, we are in normal volume mode. The volume only affects
 897          * ourselves */
 898         pa_sw_cvolume_multiply(&i->soft_volume, volume, &i->volume_factor);
 899
 900         /* Hooks have the ability to play games with i->soft_volume */
 901         pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_SET_VOLUME], i);
 902
 903         pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_SOFT_VOLUME, NULL, 0, NULL) == 0);
 904     }
 905
 906     /* The virtual volume changed, let's tell people so */
 907     pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
 908 }
 909
 910 /* Called from main context */
 911 const pa_cvolume *pa_sink_input_get_volume(pa_sink_input *i) {
 912     pa_sink_input_assert_ref(i);
 913     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
 914
 915     return &i->virtual_volume;
 916 }
 917
 918 /* Called from main context */
 919 void pa_sink_input_set_mute(pa_sink_input *i, pa_bool_t mute, pa_bool_t save) {
 920     pa_assert(i);
 921     pa_sink_input_assert_ref(i);
 922     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
 923
 924     if (!i->muted == !mute)
 925         return;
 926
 927     i->muted = mute;
 928     i->save_muted = save;
 929
 930     pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_SOFT_MUTE, NULL, 0, NULL) == 0);
 931     pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
 932 }
 933
 934 /* Called from main context */
 935 pa_bool_t pa_sink_input_get_mute(pa_sink_input *i) {
 936     pa_sink_input_assert_ref(i);
 937     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
 938
 939     return i->muted;
 940 }
 941
 942 /* Called from main thread */
 943 void pa_sink_input_update_proplist(pa_sink_input *i, pa_update_mode_t mode, pa_proplist *p) {
 944     pa_sink_input_assert_ref(i);
 945     pa_assert(p);
 946
 947     pa_proplist_update(i->proplist, mode, p);
 948
 949     if (PA_SINK_IS_LINKED(i->state)) {
 950         pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_PROPLIST_CHANGED], i);
 951         pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
 952     }
 953 }
 954
 955 /* Called from main context */
 956 void pa_sink_input_cork(pa_sink_input *i, pa_bool_t b) {
 957     pa_sink_input_assert_ref(i);
 958     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
 959
 960     sink_input_set_state(i, b ? PA_SINK_INPUT_CORKED : PA_SINK_INPUT_RUNNING);
 961 }
 962
 963 /* Called from main context */
 964 int pa_sink_input_set_rate(pa_sink_input *i, uint32_t rate) {
 965     pa_sink_input_assert_ref(i);
 966     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
 967     pa_return_val_if_fail(i->thread_info.resampler, -PA_ERR_BADSTATE);
 968
 969     if (i->sample_spec.rate == rate)
 970         return 0;
 971
 972     i->sample_spec.rate = rate;
 973
 974     pa_asyncmsgq_post(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_RATE, PA_UINT_TO_PTR(rate), 0, NULL, NULL);
 975
 976     pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
 977     return 0;
 978 }
 979
 980 /* Called from main context */
 981 void pa_sink_input_set_name(pa_sink_input *i, const char *name) {
 982     const char *old;
 983     pa_sink_input_assert_ref(i);
 984
 985     if (!name && !pa_proplist_contains(i->proplist, PA_PROP_MEDIA_NAME))
 986         return;
 987
 988     old = pa_proplist_gets(i->proplist, PA_PROP_MEDIA_NAME);
 989
 990     if (old && name && !strcmp(old, name))
 991         return;
 992
 993     if (name)
 994         pa_proplist_sets(i->proplist, PA_PROP_MEDIA_NAME, name);
 995     else
 996         pa_proplist_unset(i->proplist, PA_PROP_MEDIA_NAME);
 997
 998     if (PA_SINK_INPUT_IS_LINKED(i->state)) {
 999         pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_PROPLIST_CHANGED], i);
1000         pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
1001     }
1002 }
1003
1004 /* Called from main context */
1005 pa_resample_method_t pa_sink_input_get_resample_method(pa_sink_input *i) {
1006     pa_sink_input_assert_ref(i);
1007
1008     return i->actual_resample_method;
1009 }
1010
1011 /* Called from main context */
1012 pa_bool_t pa_sink_input_may_move(pa_sink_input *i) {
1013     pa_sink_input_assert_ref(i);
1014     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1015
1016     if (i->flags & PA_SINK_INPUT_DONT_MOVE)
1017         return FALSE;
1018
1019     if (i->sync_next || i->sync_prev) {
1020         pa_log_warn("Moving synchronised streams not supported.");
1021         return FALSE;
1022     }
1023
1024     return TRUE;
1025 }
1026
1027 /* Called from main context */
1028 pa_bool_t pa_sink_input_may_move_to(pa_sink_input *i, pa_sink *dest) {
1029     pa_sink_input_assert_ref(i);
1030     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1031     pa_sink_assert_ref(dest);
1032
1033     if (dest == i->sink)
1034         return TRUE;
1035
1036     if (!pa_sink_input_may_move(i))
1037         return FALSE;
1038
1039     if (pa_idxset_size(dest->inputs) >= PA_MAX_INPUTS_PER_SINK) {
1040         pa_log_warn("Failed to move sink input: too many inputs per sink.");
1041         return FALSE;
1042     }
1043
1044     if (i->may_move_to)
1045         if (!i->may_move_to(i, dest))
1046             return FALSE;
1047
1048     return TRUE;
1049 }
1050
1051 /* Called from main context */
1052 int pa_sink_input_start_move(pa_sink_input *i) {
1053     pa_source_output *o, *p = NULL;
1054     pa_sink *origin;
1055     int r;
1056
1057     pa_sink_input_assert_ref(i);
1058     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1059     pa_assert(i->sink);
1060
1061     if (!pa_sink_input_may_move(i))
1062         return -PA_ERR_NOTSUPPORTED;
1063
1064     if ((r = pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_MOVE_START], i)) < 0)
1065         return r;
1066
1067     origin = i->sink;
1068
1069     /* Kill directly connected outputs */
1070     while ((o = pa_idxset_first(i->direct_outputs, NULL))) {
1071         pa_assert(o != p);
1072         pa_source_output_kill(o);
1073         p = o;
1074     }
1075     pa_assert(pa_idxset_isempty(i->direct_outputs));
1076
1077     pa_idxset_remove_by_data(i->sink->inputs, i, NULL);
1078
1079     if (pa_sink_input_get_state(i) == PA_SINK_INPUT_CORKED)
1080         pa_assert_se(i->sink->n_corked-- >= 1);
1081
1082     if (i->sink->flags & PA_SINK_FLAT_VOLUME) {
1083         pa_cvolume new_volume;
1084
1085         /* Make the absolute volume relative */
1086         i->virtual_volume = i->soft_volume;
1087         i->soft_volume = i->volume_factor;
1088
1089         /* We might need to update the sink's volume if we are in flat
1090          * volume mode. */
1091         pa_sink_update_flat_volume(i->sink, &new_volume);
1092         pa_sink_set_volume(i->sink, &new_volume, FALSE, FALSE);
1093     }
1094
1095     pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_START_MOVE, i, 0, NULL) == 0);
1096
1097     pa_sink_update_status(i->sink);
1098     i->sink = NULL;
1099
1100     return 0;
1101 }
1102
1103 /* Called from main context */
1104 int pa_sink_input_finish_move(pa_sink_input *i, pa_sink *dest, pa_bool_t save) {
1105     pa_resampler *new_resampler;
1106
1107     pa_sink_input_assert_ref(i);
1108     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1109     pa_assert(!i->sink);
1110     pa_sink_assert_ref(dest);
1111
1112     if (!pa_sink_input_may_move_to(i, dest))
1113         return -PA_ERR_NOTSUPPORTED;
1114
1115     if (i->thread_info.resampler &&
1116         pa_sample_spec_equal(pa_resampler_output_sample_spec(i->thread_info.resampler), &dest->sample_spec) &&
1117         pa_channel_map_equal(pa_resampler_output_channel_map(i->thread_info.resampler), &dest->channel_map))
1118
1119         /* Try to reuse the old resampler if possible */
1120         new_resampler = i->thread_info.resampler;
1121
1122     else if ((i->flags & PA_SINK_INPUT_VARIABLE_RATE) ||
1123              !pa_sample_spec_equal(&i->sample_spec, &dest->sample_spec) ||
1124              !pa_channel_map_equal(&i->channel_map, &dest->channel_map)) {
1125
1126         /* Okey, we need a new resampler for the new sink */
1127
1128         if (!(new_resampler = pa_resampler_new(
1129                       i->core->mempool,
1130                       &i->sample_spec, &i->channel_map,
1131                       &dest->sample_spec, &dest->channel_map,
1132                       i->requested_resample_method,
1133                       ((i->flags & PA_SINK_INPUT_VARIABLE_RATE) ? PA_RESAMPLER_VARIABLE_RATE : 0) |
1134                       ((i->flags & PA_SINK_INPUT_NO_REMAP) ? PA_RESAMPLER_NO_REMAP : 0) |
1135                       (i->core->disable_remixing || (i->flags & PA_SINK_INPUT_NO_REMIX) ? PA_RESAMPLER_NO_REMIX : 0)))) {
1136             pa_log_warn("Unsupported resampling operation.");
1137             return -PA_ERR_NOTSUPPORTED;
1138         }
1139     } else
1140         new_resampler = NULL;
1141
1142     i->sink = dest;
1143     i->save_sink = save;
1144     pa_idxset_put(dest->inputs, i, NULL);
1145
1146     if (pa_sink_input_get_state(i) == PA_SINK_INPUT_CORKED)
1147         i->sink->n_corked++;
1148
1149     /* Replace resampler and render queue */
1150     if (new_resampler != i->thread_info.resampler) {
1151
1152         if (i->thread_info.resampler)
1153             pa_resampler_free(i->thread_info.resampler);
1154         i->thread_info.resampler = new_resampler;
1155
1156         pa_memblockq_free(i->thread_info.render_memblockq);
1157
1158         i->thread_info.render_memblockq = pa_memblockq_new(
1159                 0,
1160                 MEMBLOCKQ_MAXLENGTH,
1161                 0,
1162                 pa_frame_size(&i->sink->sample_spec),
1163                 0,
1164                 1,
1165                 0,
1166                 &i->sink->silence);
1167     }
1168
1169     pa_sink_update_status(dest);
1170
1171     if (i->sink->flags & PA_SINK_FLAT_VOLUME) {
1172         pa_cvolume new_volume;
1173
1174         /* Make relative volume absolute again */
1175         pa_cvolume t = dest->virtual_volume;
1176         pa_cvolume_remap(&t, &dest->channel_map, &i->channel_map);
1177         pa_sw_cvolume_multiply(&i->virtual_volume, &i->virtual_volume, &t);
1178
1179         /* We might need to update the sink's volume if we are in flat volume mode. */
1180         pa_sink_update_flat_volume(i->sink, &new_volume);
1181         pa_sink_set_volume(i->sink, &new_volume, FALSE, FALSE);
1182     }
1183
1184     pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_FINISH_MOVE, i, 0, NULL) == 0);
1185
1186     pa_log_debug("Successfully moved sink input %i to %s.", i->index, dest->name);
1187
1188     /* Notify everyone */
1189     if (i->moved)
1190         i->moved(i);
1191
1192     pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_MOVE_FINISH], i);
1193     pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
1194
1195     return 0;
1196 }
1197
1198 /* Called from main context */
1199 int pa_sink_input_move_to(pa_sink_input *i, pa_sink *dest, pa_bool_t save) {
1200     int r;
1201
1202     pa_sink_input_assert_ref(i);
1203     pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1204     pa_assert(i->sink);
1205     pa_sink_assert_ref(dest);
1206
1207     if (dest == i->sink)
1208         return 0;
1209
1210     if (!pa_sink_input_may_move_to(i, dest))
1211         return -PA_ERR_NOTSUPPORTED;
1212
1213     if ((r = pa_sink_input_start_move(i)) < 0)
1214         return r;
1215
1216     if ((r = pa_sink_input_finish_move(i, dest, save)) < 0)
1217         return r;
1218
1219     return 0;
1220 }
1221
1222 /* Called from IO thread context */
1223 void pa_sink_input_set_state_within_thread(pa_sink_input *i, pa_sink_input_state_t state) {
1224     pa_bool_t corking, uncorking;
1225     pa_sink_input_assert_ref(i);
1226
1227     if (state == i->thread_info.state)
1228         return;
1229
1230     if ((state == PA_SINK_INPUT_DRAINED || state == PA_SINK_INPUT_RUNNING) &&
1231         !(i->thread_info.state == PA_SINK_INPUT_DRAINED || i->thread_info.state != PA_SINK_INPUT_RUNNING))
1232         pa_atomic_store(&i->thread_info.drained, 1);
1233
1234     corking = state == PA_SINK_INPUT_CORKED && i->thread_info.state == PA_SINK_INPUT_RUNNING;
1235     uncorking = i->thread_info.state == PA_SINK_INPUT_CORKED && state == PA_SINK_INPUT_RUNNING;
1236
1237     if (i->state_change)
1238         i->state_change(i, state);
1239
1240     i->thread_info.state = state;
1241
1242     if (corking) {
1243
1244         pa_log_debug("Requesting rewind due to corking");
1245
1246         /* This will tell the implementing sink input driver to rewind
1247          * so that the unplayed already mixed data is not lost */
1248         pa_sink_input_request_rewind(i, 0, TRUE, TRUE, FALSE);
1249
1250     } else if (uncorking) {
1251
1252         i->thread_info.underrun_for = (uint64_t) -1;
1253         i->thread_info.playing_for = 0;
1254
1255         pa_log_debug("Requesting rewind due to uncorking");
1256
1257         /* OK, we're being uncorked. Make sure we're not rewound when
1258          * the hw buffer is remixed and request a remix. */
1259         pa_sink_input_request_rewind(i, 0, FALSE, TRUE, TRUE);
1260     }
1261 }
1262
1263 /* Called from thread context, except when it is not. */
1264 int pa_sink_input_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
1265     pa_sink_input *i = PA_SINK_INPUT(o);
1266     pa_sink_input_assert_ref(i);
1267
1268     switch (code) {
1269
1270         case PA_SINK_INPUT_MESSAGE_SET_SOFT_VOLUME:
1271             if (!pa_cvolume_equal(&i->thread_info.soft_volume, &i->soft_volume)) {
1272                 i->thread_info.soft_volume = i->soft_volume;
1273                 pa_sink_input_request_rewind(i, 0, TRUE, FALSE, FALSE);
1274             }
1275             return 0;
1276
1277         case PA_SINK_INPUT_MESSAGE_SET_SOFT_MUTE:
1278             if (i->thread_info.muted != i->muted) {
1279                 i->thread_info.muted = i->muted;
1280                 pa_sink_input_request_rewind(i, 0, TRUE, FALSE, FALSE);
1281             }
1282             return 0;
1283
1284         case PA_SINK_INPUT_MESSAGE_GET_LATENCY: {
1285             pa_usec_t *r = userdata;
1286             pa_usec_t sink_usec = 0;
1287
1288             r[0] += pa_bytes_to_usec(pa_memblockq_get_length(i->thread_info.render_memblockq), &i->sink->sample_spec);
1289
1290             if (i->sink->parent.process_msg(PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_GET_LATENCY, &sink_usec, 0, NULL) >= 0)
1291                 r[1] += sink_usec;
1292
1293             return 0;
1294         }
1295
1296         case PA_SINK_INPUT_MESSAGE_SET_RATE:
1297
1298             i->thread_info.sample_spec.rate = PA_PTR_TO_UINT(userdata);
1299             pa_resampler_set_input_rate(i->thread_info.resampler, PA_PTR_TO_UINT(userdata));
1300
1301             return 0;
1302
1303         case PA_SINK_INPUT_MESSAGE_SET_STATE: {
1304             pa_sink_input *ssync;
1305
1306             pa_sink_input_set_state_within_thread(i, PA_PTR_TO_UINT(userdata));
1307
1308             for (ssync = i->thread_info.sync_prev; ssync; ssync = ssync->thread_info.sync_prev)
1309                 pa_sink_input_set_state_within_thread(ssync, PA_PTR_TO_UINT(userdata));
1310
1311             for (ssync = i->thread_info.sync_next; ssync; ssync = ssync->thread_info.sync_next)
1312                 pa_sink_input_set_state_within_thread(ssync, PA_PTR_TO_UINT(userdata));
1313
1314             return 0;
1315         }
1316
1317         case PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY: {
1318             pa_usec_t *usec = userdata;
1319
1320             *usec = pa_sink_input_set_requested_latency_within_thread(i, *usec);
1321             return 0;
1322         }
1323
1324         case PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY: {
1325             pa_usec_t *r = userdata;
1326
1327             *r = i->thread_info.requested_sink_latency;
1328             return 0;
1329         }
1330     }
1331
1332     return -PA_ERR_NOTIMPLEMENTED;
1333 }
1334
1335 /* Called from main thread */
1336 pa_sink_input_state_t pa_sink_input_get_state(pa_sink_input *i) {
1337     pa_sink_input_assert_ref(i);
1338
1339     if (i->state == PA_SINK_INPUT_RUNNING || i->state == PA_SINK_INPUT_DRAINED)
1340         return pa_atomic_load(&i->thread_info.drained) ? PA_SINK_INPUT_DRAINED : PA_SINK_INPUT_RUNNING;
1341
1342     return i->state;
1343 }
1344
1345 /* Called from IO context */
1346 pa_bool_t pa_sink_input_safe_to_remove(pa_sink_input *i) {
1347     pa_sink_input_assert_ref(i);
1348
1349     if (PA_SINK_INPUT_IS_LINKED(i->thread_info.state))
1350         return pa_memblockq_is_empty(i->thread_info.render_memblockq);
1351
1352     return TRUE;
1353 }
1354
1355 /* Called from IO context */
1356 void pa_sink_input_request_rewind(pa_sink_input *i, size_t nbytes  /* in our sample spec */, pa_bool_t rewrite, pa_bool_t flush, pa_bool_t dont_rewind_render) {
1357     size_t lbq;
1358
1359     /* If 'rewrite' is TRUE the sink is rewound as far as requested
1360      * and possible and the exact value of this is passed back the
1361      * implementor via process_rewind(). If 'flush' is also TRUE all
1362      * already rendered data is also dropped.
1363      *
1364      * If 'rewrite' is FALSE the sink is rewound as far as requested
1365      * and possible and the already rendered data is dropped so that
1366      * in the next iteration we read new data from the
1367      * implementor. This implies 'flush' is TRUE.  If
1368      * dont_rewind_render is TRUE then the render memblockq is not
1369      * rewound. */
1370
1371     pa_sink_input_assert_ref(i);
1372
1373     nbytes = PA_MAX(i->thread_info.rewrite_nbytes, nbytes);
1374
1375 /*     pa_log_debug("request rewrite %lu", (unsigned long) nbytes); */
1376
1377     /* We don't take rewind requests while we are corked */
1378     if (i->thread_info.state == PA_SINK_INPUT_CORKED)
1379         return;
1380
1381     pa_assert(rewrite || flush);
1382     pa_assert(!dont_rewind_render || !rewrite);
1383
1384     /* Calculate how much we can rewind locally without having to
1385      * touch the sink */
1386     if (rewrite)
1387         lbq = pa_memblockq_get_length(i->thread_info.render_memblockq);
1388     else
1389         lbq = 0;
1390
1391     /* Check if rewinding for the maximum is requested, and if so, fix up */
1392     if (nbytes <= 0) {
1393
1394         /* Calculate maximum number of bytes that could be rewound in theory */
1395         nbytes = i->sink->thread_info.max_rewind + lbq;
1396
1397         /* Transform from sink domain */
1398         if (i->thread_info.resampler)
1399             nbytes = pa_resampler_request(i->thread_info.resampler, nbytes);
1400     }
1401
1402     if (i->thread_info.rewrite_nbytes != (size_t) -1) {
1403         if (rewrite) {
1404             /* Make sure to not overwrite over underruns */
1405             if (nbytes > i->thread_info.playing_for)
1406                 nbytes = (size_t) i->thread_info.playing_for;
1407
1408             i->thread_info.rewrite_nbytes = nbytes;
1409         } else
1410             i->thread_info.rewrite_nbytes = (size_t) -1;
1411     }
1412
1413     i->thread_info.rewrite_flush =
1414         i->thread_info.rewrite_flush ||
1415         (flush && i->thread_info.rewrite_nbytes != 0);
1416
1417     i->thread_info.dont_rewind_render =
1418         i->thread_info.dont_rewind_render ||
1419         dont_rewind_render;
1420
1421     if (nbytes != (size_t) -1) {
1422
1423         /* Transform to sink domain */
1424         if (i->thread_info.resampler)
1425             nbytes = pa_resampler_result(i->thread_info.resampler, nbytes);
1426
1427         if (nbytes > lbq)
1428             pa_sink_request_rewind(i->sink, nbytes - lbq);
1429         else
1430             /* This call will make sure process_rewind() is called later */
1431             pa_sink_request_rewind(i->sink, 0);
1432     }
1433 }
1434
1435 /* Called from main context */
1436 pa_memchunk* pa_sink_input_get_silence(pa_sink_input *i, pa_memchunk *ret) {
1437     pa_sink_input_assert_ref(i);
1438     pa_assert(ret);
1439
1440     pa_silence_memchunk_get(
1441                 &i->core->silence_cache,
1442                 i->core->mempool,
1443                 ret,
1444                 &i->sample_spec,
1445                 i->thread_info.resampler ? pa_resampler_max_block_size(i->thread_info.resampler) : 0);
1446
1447     return ret;
1448 }