src/pulsecore/source-output.c

   1 /***
   2   This file is part of PulseAudio.
   3
   4   Copyright 2004-2006 Lennart Poettering
   5
   6   PulseAudio is free software; you can redistribute it and/or modify
   7   it under the terms of the GNU Lesser General Public License as published
   8   by the Free Software Foundation; either version 2.1 of the License,
   9   or (at your option) any later version.
  10
  11   PulseAudio is distributed in the hope that it will be useful, but
  12   WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14   General Public License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public License
  17   along with PulseAudio; if not, write to the Free Software
  18   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  19   USA.
  20 ***/
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include <config.h>
  24 #endif
  25
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29
  30 #include <pulse/utf8.h>
  31 #include <pulse/xmalloc.h>
  32 #include <pulse/util.h>
  33 #include <pulse/internal.h>
  34
  35 #include <pulsecore/sample-util.h>
  36 #include <pulsecore/core-subscribe.h>
  37 #include <pulsecore/log.h>
  38 #include <pulsecore/namereg.h>
  39 #include <pulsecore/core-util.h>
  40
  41 #include "source-output.h"
  42
  43 #define MEMBLOCKQ_MAXLENGTH (32*1024*1024)
  44
  45 PA_DEFINE_PUBLIC_CLASS(pa_source_output, pa_msgobject);
  46
  47 static void source_output_free(pa_object* mo);
  48 static void set_real_ratio(pa_source_output *o, const pa_cvolume *v);
  49
  50 pa_source_output_new_data* pa_source_output_new_data_init(pa_source_output_new_data *data) {
  51     pa_assert(data);
  52
  53     pa_zero(*data);
  54     data->resample_method = PA_RESAMPLER_INVALID;
  55     data->proplist = pa_proplist_new();
  56     data->volume_writable = TRUE;
  57
  58     return data;
  59 }
  60
  61 void pa_source_output_new_data_set_sample_spec(pa_source_output_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_source_output_new_data_set_channel_map(pa_source_output_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 pa_bool_t pa_source_output_new_data_is_passthrough(pa_source_output_new_data *data) {
  76     pa_assert(data);
  77
  78     if (PA_LIKELY(data->format) && PA_UNLIKELY(!pa_format_info_is_pcm(data->format)))
  79         return TRUE;
  80
  81     if (PA_UNLIKELY(data->flags & PA_SOURCE_OUTPUT_PASSTHROUGH))
  82         return TRUE;
  83
  84     return FALSE;
  85 }
  86
  87 void pa_source_output_new_data_set_volume(pa_source_output_new_data *data, const pa_cvolume *volume) {
  88     pa_assert(data);
  89     pa_assert(data->volume_writable);
  90
  91     if ((data->volume_is_set = !!volume))
  92         data->volume = *volume;
  93 }
  94
  95 void pa_source_output_new_data_apply_volume_factor(pa_source_output_new_data *data, const pa_cvolume *volume_factor) {
  96     pa_assert(data);
  97     pa_assert(volume_factor);
  98
  99     if (data->volume_factor_is_set)
 100         pa_sw_cvolume_multiply(&data->volume_factor, &data->volume_factor, volume_factor);
 101     else {
 102         data->volume_factor_is_set = TRUE;
 103         data->volume_factor = *volume_factor;
 104     }
 105 }
 106
 107 void pa_source_output_new_data_apply_volume_factor_source(pa_source_output_new_data *data, const pa_cvolume *volume_factor) {
 108     pa_assert(data);
 109     pa_assert(volume_factor);
 110
 111     if (data->volume_factor_source_is_set)
 112         pa_sw_cvolume_multiply(&data->volume_factor_source, &data->volume_factor_source, volume_factor);
 113     else {
 114         data->volume_factor_source_is_set = TRUE;
 115         data->volume_factor_source = *volume_factor;
 116     }
 117 }
 118
 119 void pa_source_output_new_data_set_muted(pa_source_output_new_data *data, pa_bool_t mute) {
 120     pa_assert(data);
 121
 122     data->muted_is_set = TRUE;
 123     data->muted = !!mute;
 124 }
 125
 126 pa_bool_t pa_source_output_new_data_set_source(pa_source_output_new_data *data, pa_source *s, pa_bool_t save) {
 127     pa_bool_t ret = TRUE;
 128     pa_idxset *formats = NULL;
 129
 130     pa_assert(data);
 131     pa_assert(s);
 132
 133     if (!data->req_formats) {
 134         /* We're not working with the extended API */
 135         data->source = s;
 136         data->save_source = save;
 137     } else {
 138         /* Extended API: let's see if this source supports the formats the client would like */
 139         formats = pa_source_check_formats(s, data->req_formats);
 140
 141         if (formats && !pa_idxset_isempty(formats)) {
 142             /* Source supports at least one of the requested formats */
 143             data->source = s;
 144             data->save_source = save;
 145             if (data->nego_formats)
 146                 pa_idxset_free(data->nego_formats, (pa_free2_cb_t) pa_format_info_free2, NULL);
 147             data->nego_formats = formats;
 148         } else {
 149             /* Source doesn't support any of the formats requested by the client */
 150             if (formats)
 151                 pa_idxset_free(formats, (pa_free2_cb_t) pa_format_info_free2, NULL);
 152             ret = FALSE;
 153         }
 154     }
 155
 156     return ret;
 157 }
 158
 159 pa_bool_t pa_source_output_new_data_set_formats(pa_source_output_new_data *data, pa_idxset *formats) {
 160     pa_assert(data);
 161     pa_assert(formats);
 162
 163     if (data->req_formats)
 164         pa_idxset_free(formats, (pa_free2_cb_t) pa_format_info_free2, NULL);
 165
 166     data->req_formats = formats;
 167
 168     if (data->source) {
 169         /* Trigger format negotiation */
 170         return pa_source_output_new_data_set_source(data, data->source, data->save_source);
 171     }
 172
 173     return TRUE;
 174 }
 175
 176 void pa_source_output_new_data_done(pa_source_output_new_data *data) {
 177     pa_assert(data);
 178
 179     if (data->req_formats)
 180         pa_idxset_free(data->req_formats, (pa_free2_cb_t) pa_format_info_free2, NULL);
 181
 182     if (data->nego_formats)
 183         pa_idxset_free(data->nego_formats, (pa_free2_cb_t) pa_format_info_free2, NULL);
 184
 185     if (data->format)
 186         pa_format_info_free(data->format);
 187
 188     pa_proplist_free(data->proplist);
 189 }
 190
 191 /* Called from main context */
 192 static void reset_callbacks(pa_source_output *o) {
 193     pa_assert(o);
 194
 195     o->push = NULL;
 196     o->process_rewind = NULL;
 197     o->update_max_rewind = NULL;
 198     o->update_source_requested_latency = NULL;
 199     o->update_source_latency_range = NULL;
 200     o->update_source_fixed_latency = NULL;
 201     o->attach = NULL;
 202     o->detach = NULL;
 203     o->suspend = NULL;
 204     o->suspend_within_thread = NULL;
 205     o->moving = NULL;
 206     o->kill = NULL;
 207     o->get_latency = NULL;
 208     o->state_change = NULL;
 209     o->may_move_to = NULL;
 210     o->send_event = NULL;
 211     o->volume_changed = NULL;
 212     o->mute_changed = NULL;
 213 }
 214
 215 /* Called from main context */
 216 int pa_source_output_new(
 217         pa_source_output**_o,
 218         pa_core *core,
 219         pa_source_output_new_data *data) {
 220
 221     pa_source_output *o;
 222     pa_resampler *resampler = NULL;
 223     char st[PA_SAMPLE_SPEC_SNPRINT_MAX], cm[PA_CHANNEL_MAP_SNPRINT_MAX];
 224     pa_channel_map original_cm;
 225     int r;
 226     char *pt;
 227     pa_sample_spec ss;
 228     pa_channel_map map;
 229
 230     pa_assert(_o);
 231     pa_assert(core);
 232     pa_assert(data);
 233     pa_assert_ctl_context();
 234
 235     if (data->client)
 236         pa_proplist_update(data->proplist, PA_UPDATE_MERGE, data->client->proplist);
 237
 238     if (data->destination_source && (data->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER))
 239         data->volume_writable = FALSE;
 240
 241     if (!data->req_formats) {
 242         /* From this point on, we want to work only with formats, and get back
 243          * to using the sample spec and channel map after all decisions w.r.t.
 244          * routing are complete. */
 245         pa_idxset *tmp = pa_idxset_new(NULL, NULL);
 246         pa_format_info *f = pa_format_info_from_sample_spec(&data->sample_spec,
 247                 data->channel_map_is_set ? &data->channel_map : NULL);
 248         pa_idxset_put(tmp, f, NULL);
 249         pa_source_output_new_data_set_formats(data, tmp);
 250     }
 251
 252     if ((r = pa_hook_fire(&core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_NEW], data)) < 0)
 253         return r;
 254
 255     pa_return_val_if_fail(!data->driver || pa_utf8_valid(data->driver), -PA_ERR_INVALID);
 256
 257     if (!data->source) {
 258         pa_source *source = pa_namereg_get(core, NULL, PA_NAMEREG_SOURCE);
 259         pa_return_val_if_fail(source, -PA_ERR_NOENTITY);
 260         pa_source_output_new_data_set_source(data, source, FALSE);
 261     }
 262
 263     /* Routing's done, we have a source. Now let's fix the format and set up the
 264      * sample spec */
 265
 266     /* If something didn't pick a format for us, pick the top-most format since
 267      * we assume this is sorted in priority order */
 268     if (!data->format && data->nego_formats && !pa_idxset_isempty(data->nego_formats))
 269         data->format = pa_format_info_copy(pa_idxset_first(data->nego_formats, NULL));
 270
 271     pa_return_val_if_fail(data->format, -PA_ERR_NOTSUPPORTED);
 272
 273     /* Now populate the sample spec and format according to the final
 274      * format that we've negotiated */
 275     if (PA_LIKELY(data->format->encoding == PA_ENCODING_PCM)) {
 276         pa_return_val_if_fail(pa_format_info_to_sample_spec(data->format, &ss, &map), -PA_ERR_INVALID);
 277         pa_source_output_new_data_set_sample_spec(data, &ss);
 278         if (pa_channel_map_valid(&map))
 279             pa_source_output_new_data_set_channel_map(data, &map);
 280     } else {
 281         pa_return_val_if_fail(pa_format_info_to_sample_spec_fake(data->format, &ss), -PA_ERR_INVALID);
 282         pa_source_output_new_data_set_sample_spec(data, &ss);
 283     }
 284
 285     pa_return_val_if_fail(PA_SOURCE_IS_LINKED(pa_source_get_state(data->source)), -PA_ERR_BADSTATE);
 286     pa_return_val_if_fail(!data->direct_on_input || data->direct_on_input->sink == data->source->monitor_of, -PA_ERR_INVALID);
 287
 288     if (!data->sample_spec_is_set)
 289         data->sample_spec = data->source->sample_spec;
 290
 291     pa_return_val_if_fail(pa_sample_spec_valid(&data->sample_spec), -PA_ERR_INVALID);
 292
 293     if (!data->channel_map_is_set) {
 294         if (pa_channel_map_compatible(&data->source->channel_map, &data->sample_spec))
 295             data->channel_map = data->source->channel_map;
 296         else
 297             pa_channel_map_init_extend(&data->channel_map, data->sample_spec.channels, PA_CHANNEL_MAP_DEFAULT);
 298     }
 299
 300     pa_return_val_if_fail(pa_channel_map_compatible(&data->channel_map, &data->sample_spec), -PA_ERR_INVALID);
 301
 302     /* Don't restore (or save) stream volume for passthrough streams and
 303      * prevent attenuation/gain */
 304     if (pa_source_output_new_data_is_passthrough(data)) {
 305         data->volume_is_set = TRUE;
 306         pa_cvolume_reset(&data->volume, data->sample_spec.channels);
 307         data->volume_is_absolute = TRUE;
 308         data->save_volume = FALSE;
 309     }
 310
 311     if (!data->volume_is_set) {
 312         pa_cvolume_reset(&data->volume, data->sample_spec.channels);
 313         data->volume_is_absolute = FALSE;
 314         data->save_volume = FALSE;
 315     }
 316
 317     pa_return_val_if_fail(pa_cvolume_compatible(&data->volume, &data->sample_spec), -PA_ERR_INVALID);
 318
 319     if (!data->volume_factor_is_set)
 320         pa_cvolume_reset(&data->volume_factor, data->sample_spec.channels);
 321
 322     pa_return_val_if_fail(pa_cvolume_compatible(&data->volume_factor, &data->sample_spec), -PA_ERR_INVALID);
 323
 324     if (!data->volume_factor_source_is_set)
 325         pa_cvolume_reset(&data->volume_factor_source, data->source->sample_spec.channels);
 326
 327     pa_return_val_if_fail(pa_cvolume_compatible(&data->volume_factor_source, &data->source->sample_spec), -PA_ERR_INVALID);
 328
 329     if (!data->muted_is_set)
 330         data->muted = FALSE;
 331
 332     if (data->flags & PA_SOURCE_OUTPUT_FIX_FORMAT)
 333         data->sample_spec.format = data->source->sample_spec.format;
 334
 335     if (data->flags & PA_SOURCE_OUTPUT_FIX_RATE)
 336         data->sample_spec.rate = data->source->sample_spec.rate;
 337
 338     original_cm = data->channel_map;
 339
 340     if (data->flags & PA_SOURCE_OUTPUT_FIX_CHANNELS) {
 341         data->sample_spec.channels = data->source->sample_spec.channels;
 342         data->channel_map = data->source->channel_map;
 343     }
 344
 345     pa_assert(pa_sample_spec_valid(&data->sample_spec));
 346     pa_assert(pa_channel_map_valid(&data->channel_map));
 347
 348     /* Due to the fixing of the sample spec the volume might not match anymore */
 349     pa_cvolume_remap(&data->volume, &original_cm, &data->channel_map);
 350
 351     if (!(data->flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) &&
 352         !pa_sample_spec_equal(&data->sample_spec, &data->source->sample_spec)){
 353         /* try to change source rate. This is done before the FIXATE hook since
 354            module-suspend-on-idle can resume a source */
 355
 356         pa_log_info("Trying to change sample rate");
 357         if (pa_source_update_rate(data->source, data->sample_spec.rate, pa_source_output_new_data_is_passthrough(data)) == TRUE)
 358             pa_log_info("Rate changed to %u Hz",
 359                         data->source->sample_spec.rate);
 360         else
 361             pa_log_info("Resampling enabled to %u Hz", data->source->sample_spec.rate);
 362     }
 363
 364     if (data->resample_method == PA_RESAMPLER_INVALID)
 365         data->resample_method = core->resample_method;
 366
 367     pa_return_val_if_fail(data->resample_method < PA_RESAMPLER_MAX, -PA_ERR_INVALID);
 368
 369     if ((r = pa_hook_fire(&core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_FIXATE], data)) < 0)
 370         return r;
 371
 372     if ((data->flags & PA_SOURCE_OUTPUT_NO_CREATE_ON_SUSPEND) &&
 373         pa_source_get_state(data->source) == PA_SOURCE_SUSPENDED) {
 374         pa_log("Failed to create source output: source is suspended.");
 375         return -PA_ERR_BADSTATE;
 376     }
 377
 378     if (pa_idxset_size(data->source->outputs) >= PA_MAX_OUTPUTS_PER_SOURCE) {
 379         pa_log("Failed to create source output: too many outputs per source.");
 380         return -PA_ERR_TOOLARGE;
 381     }
 382
 383     if ((data->flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) ||
 384         !pa_sample_spec_equal(&data->sample_spec, &data->source->sample_spec) ||
 385         !pa_channel_map_equal(&data->channel_map, &data->source->channel_map)) {
 386
 387         if (!pa_source_output_new_data_is_passthrough(data)) /* no resampler for passthrough content */
 388             if (!(resampler = pa_resampler_new(
 389                         core->mempool,
 390                         &data->source->sample_spec, &data->source->channel_map,
 391                         &data->sample_spec, &data->channel_map,
 392                         data->resample_method,
 393                         ((data->flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) ? PA_RESAMPLER_VARIABLE_RATE : 0) |
 394                         ((data->flags & PA_SOURCE_OUTPUT_NO_REMAP) ? PA_RESAMPLER_NO_REMAP : 0) |
 395                         (core->disable_remixing || (data->flags & PA_SOURCE_OUTPUT_NO_REMIX) ? PA_RESAMPLER_NO_REMIX : 0) |
 396                         (core->disable_lfe_remixing ? PA_RESAMPLER_NO_LFE : 0)))) {
 397                 pa_log_warn("Unsupported resampling operation.");
 398                 return -PA_ERR_NOTSUPPORTED;
 399             }
 400     }
 401
 402     o = pa_msgobject_new(pa_source_output);
 403     o->parent.parent.free = source_output_free;
 404     o->parent.process_msg = pa_source_output_process_msg;
 405
 406     o->core = core;
 407     o->state = PA_SOURCE_OUTPUT_INIT;
 408     o->flags = data->flags;
 409     o->proplist = pa_proplist_copy(data->proplist);
 410     o->driver = pa_xstrdup(pa_path_get_filename(data->driver));
 411     o->module = data->module;
 412     o->source = data->source;
 413     o->destination_source = data->destination_source;
 414     o->client = data->client;
 415
 416     o->requested_resample_method = data->resample_method;
 417     o->actual_resample_method = resampler ? pa_resampler_get_method(resampler) : PA_RESAMPLER_INVALID;
 418     o->sample_spec = data->sample_spec;
 419     o->channel_map = data->channel_map;
 420     o->format = pa_format_info_copy(data->format);
 421
 422     if (!data->volume_is_absolute && pa_source_flat_volume_enabled(o->source)) {
 423         pa_cvolume remapped;
 424
 425         /* When the 'absolute' bool is not set then we'll treat the volume
 426          * as relative to the source volume even in flat volume mode */
 427         remapped = data->source->reference_volume;
 428         pa_cvolume_remap(&remapped, &data->source->channel_map, &data->channel_map);
 429         pa_sw_cvolume_multiply(&o->volume, &data->volume, &remapped);
 430     } else
 431         o->volume = data->volume;
 432
 433     o->volume_factor = data->volume_factor;
 434     o->volume_factor_source = data->volume_factor_source;
 435     o->real_ratio = o->reference_ratio = data->volume;
 436     pa_cvolume_reset(&o->soft_volume, o->sample_spec.channels);
 437     pa_cvolume_reset(&o->real_ratio, o->sample_spec.channels);
 438     o->volume_writable = data->volume_writable;
 439     o->save_volume = data->save_volume;
 440     o->save_source = data->save_source;
 441     o->save_muted = data->save_muted;
 442
 443     o->muted = data->muted;
 444
 445     o->direct_on_input = data->direct_on_input;
 446
 447     reset_callbacks(o);
 448     o->userdata = NULL;
 449
 450     o->thread_info.state = o->state;
 451     o->thread_info.attached = FALSE;
 452     o->thread_info.sample_spec = o->sample_spec;
 453     o->thread_info.resampler = resampler;
 454     o->thread_info.soft_volume = o->soft_volume;
 455     o->thread_info.muted = o->muted;
 456     o->thread_info.requested_source_latency = (pa_usec_t) -1;
 457     o->thread_info.direct_on_input = o->direct_on_input;
 458
 459     o->thread_info.delay_memblockq = pa_memblockq_new(
 460             "source output delay_memblockq",
 461             0,
 462             MEMBLOCKQ_MAXLENGTH,
 463             0,
 464             &o->source->sample_spec,
 465             0,
 466             1,
 467             0,
 468             &o->source->silence);
 469
 470     pa_assert_se(pa_idxset_put(core->source_outputs, o, &o->index) == 0);
 471     pa_assert_se(pa_idxset_put(o->source->outputs, pa_source_output_ref(o), NULL) == 0);
 472
 473     if (o->client)
 474         pa_assert_se(pa_idxset_put(o->client->source_outputs, o, NULL) >= 0);
 475
 476     if (o->direct_on_input)
 477         pa_assert_se(pa_idxset_put(o->direct_on_input->direct_outputs, o, NULL) == 0);
 478
 479     pt = pa_proplist_to_string_sep(o->proplist, "\n    ");
 480     pa_log_info("Created output %u \"%s\" on %s with sample spec %s and channel map %s\n    %s",
 481                 o->index,
 482                 pa_strnull(pa_proplist_gets(o->proplist, PA_PROP_MEDIA_NAME)),
 483                 o->source->name,
 484                 pa_sample_spec_snprint(st, sizeof(st), &o->sample_spec),
 485                 pa_channel_map_snprint(cm, sizeof(cm), &o->channel_map),
 486                 pt);
 487     pa_xfree(pt);
 488
 489     /* Don't forget to call pa_source_output_put! */
 490
 491     *_o = o;
 492     return 0;
 493 }
 494
 495 /* Called from main context */
 496 static void update_n_corked(pa_source_output *o, pa_source_output_state_t state) {
 497     pa_assert(o);
 498     pa_assert_ctl_context();
 499
 500     if (!o->source)
 501         return;
 502
 503     if (o->state == PA_SOURCE_OUTPUT_CORKED && state != PA_SOURCE_OUTPUT_CORKED)
 504         pa_assert_se(o->source->n_corked -- >= 1);
 505     else if (o->state != PA_SOURCE_OUTPUT_CORKED && state == PA_SOURCE_OUTPUT_CORKED)
 506         o->source->n_corked++;
 507 }
 508
 509 /* Called from main context */
 510 static void source_output_set_state(pa_source_output *o, pa_source_output_state_t state) {
 511
 512     pa_assert(o);
 513     pa_assert_ctl_context();
 514
 515     if (o->state == state)
 516         return;
 517
 518     if (o->state == PA_SOURCE_OUTPUT_CORKED && state == PA_SOURCE_OUTPUT_RUNNING && pa_source_used_by(o->source) == 0) {
 519         /* We were uncorked and the source was not playing anything -- let's try
 520          * to update the sample rate to avoid resampling */
 521         pa_source_update_rate(o->source, o->sample_spec.rate, pa_source_output_is_passthrough(o));
 522     }
 523
 524     pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL) == 0);
 525
 526     update_n_corked(o, state);
 527     o->state = state;
 528
 529     if (state != PA_SOURCE_OUTPUT_UNLINKED) {
 530         pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_STATE_CHANGED], o);
 531
 532         if (PA_SOURCE_OUTPUT_IS_LINKED(state))
 533             pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
 534     }
 535
 536     pa_source_update_status(o->source);
 537 }
 538
 539 /* Called from main context */
 540 void pa_source_output_unlink(pa_source_output*o) {
 541     pa_bool_t linked;
 542     pa_assert(o);
 543     pa_assert_ctl_context();
 544
 545     /* See pa_sink_unlink() for a couple of comments how this function
 546      * works */
 547
 548     pa_source_output_ref(o);
 549
 550     linked = PA_SOURCE_OUTPUT_IS_LINKED(o->state);
 551
 552     if (linked)
 553         pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK], o);
 554
 555     if (o->direct_on_input)
 556         pa_idxset_remove_by_data(o->direct_on_input->direct_outputs, o, NULL);
 557
 558     pa_idxset_remove_by_data(o->core->source_outputs, o, NULL);
 559
 560     if (o->source)
 561         if (pa_idxset_remove_by_data(o->source->outputs, o, NULL))
 562             pa_source_output_unref(o);
 563
 564     if (o->client)
 565         pa_idxset_remove_by_data(o->client->source_outputs, o, NULL);
 566
 567     update_n_corked(o, PA_SOURCE_OUTPUT_UNLINKED);
 568     o->state = PA_SOURCE_OUTPUT_UNLINKED;
 569
 570     if (linked && o->source) {
 571         if (pa_source_output_is_passthrough(o))
 572             pa_source_leave_passthrough(o->source);
 573
 574         /* We might need to update the source's volume if we are in flat volume mode. */
 575         if (pa_source_flat_volume_enabled(o->source))
 576             pa_source_set_volume(o->source, NULL, FALSE, FALSE);
 577
 578         if (o->source->asyncmsgq)
 579             pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_REMOVE_OUTPUT, o, 0, NULL) == 0);
 580     }
 581
 582     reset_callbacks(o);
 583
 584     if (linked) {
 585         pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_REMOVE, o->index);
 586         pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK_POST], o);
 587     }
 588
 589     if (o->source) {
 590         pa_source_update_status(o->source);
 591         o->source = NULL;
 592     }
 593
 594     pa_core_maybe_vacuum(o->core);
 595
 596     pa_source_output_unref(o);
 597 }
 598
 599 /* Called from main context */
 600 static void source_output_free(pa_object* mo) {
 601     pa_source_output *o = PA_SOURCE_OUTPUT(mo);
 602
 603     pa_assert(o);
 604     pa_assert_ctl_context();
 605     pa_assert(pa_source_output_refcnt(o) == 0);
 606
 607     if (PA_SOURCE_OUTPUT_IS_LINKED(o->state))
 608         pa_source_output_unlink(o);
 609
 610     pa_log_info("Freeing output %u \"%s\"", o->index, pa_strnull(pa_proplist_gets(o->proplist, PA_PROP_MEDIA_NAME)));
 611
 612     if (o->thread_info.delay_memblockq)
 613         pa_memblockq_free(o->thread_info.delay_memblockq);
 614
 615     if (o->thread_info.resampler)
 616         pa_resampler_free(o->thread_info.resampler);
 617
 618     if (o->format)
 619         pa_format_info_free(o->format);
 620
 621     if (o->proplist)
 622         pa_proplist_free(o->proplist);
 623
 624     pa_xfree(o->driver);
 625     pa_xfree(o);
 626 }
 627
 628 /* Called from main context */
 629 void pa_source_output_put(pa_source_output *o) {
 630     pa_source_output_state_t state;
 631
 632     pa_source_output_assert_ref(o);
 633     pa_assert_ctl_context();
 634
 635     pa_assert(o->state == PA_SOURCE_OUTPUT_INIT);
 636
 637     /* The following fields must be initialized properly */
 638     pa_assert(o->push);
 639     pa_assert(o->kill);
 640
 641     state = o->flags & PA_SOURCE_OUTPUT_START_CORKED ? PA_SOURCE_OUTPUT_CORKED : PA_SOURCE_OUTPUT_RUNNING;
 642
 643     update_n_corked(o, state);
 644     o->state = state;
 645
 646     /* We might need to update the source's volume if we are in flat volume mode. */
 647     if (pa_source_flat_volume_enabled(o->source))
 648         pa_source_set_volume(o->source, NULL, FALSE, o->save_volume);
 649     else {
 650         if (o->destination_source && (o->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER)) {
 651             pa_assert(pa_cvolume_is_norm(&o->volume));
 652             pa_assert(pa_cvolume_is_norm(&o->reference_ratio));
 653         }
 654
 655         set_real_ratio(o, &o->volume);
 656     }
 657
 658     if (pa_source_output_is_passthrough(o))
 659         pa_source_enter_passthrough(o->source);
 660
 661     o->thread_info.soft_volume = o->soft_volume;
 662     o->thread_info.muted = o->muted;
 663
 664     pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_ADD_OUTPUT, o, 0, NULL) == 0);
 665
 666     pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_NEW, o->index);
 667     pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_PUT], o);
 668
 669     pa_source_update_status(o->source);
 670 }
 671
 672 /* Called from main context */
 673 void pa_source_output_kill(pa_source_output*o) {
 674     pa_source_output_assert_ref(o);
 675     pa_assert_ctl_context();
 676     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
 677
 678     o->kill(o);
 679 }
 680
 681 /* Called from main context */
 682 pa_usec_t pa_source_output_get_latency(pa_source_output *o, pa_usec_t *source_latency) {
 683     pa_usec_t r[2] = { 0, 0 };
 684
 685     pa_source_output_assert_ref(o);
 686     pa_assert_ctl_context();
 687     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
 688
 689     pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY, r, 0, NULL) == 0);
 690
 691     if (o->get_latency)
 692         r[0] += o->get_latency(o);
 693
 694     if (source_latency)
 695         *source_latency = r[1];
 696
 697     return r[0];
 698 }
 699
 700 /* Called from thread context */
 701 void pa_source_output_push(pa_source_output *o, const pa_memchunk *chunk) {
 702     pa_bool_t need_volume_factor_source;
 703     pa_bool_t volume_is_norm;
 704     size_t length;
 705     size_t limit, mbs = 0;
 706
 707     pa_source_output_assert_ref(o);
 708     pa_source_output_assert_io_context(o);
 709     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->thread_info.state));
 710     pa_assert(chunk);
 711     pa_assert(pa_frame_aligned(chunk->length, &o->source->sample_spec));
 712
 713     if (!o->push || o->thread_info.state == PA_SOURCE_OUTPUT_CORKED)
 714         return;
 715
 716     pa_assert(o->thread_info.state == PA_SOURCE_OUTPUT_RUNNING);
 717
 718     if (pa_memblockq_push(o->thread_info.delay_memblockq, chunk) < 0) {
 719         pa_log_debug("Delay queue overflow!");
 720         pa_memblockq_seek(o->thread_info.delay_memblockq, (int64_t) chunk->length, PA_SEEK_RELATIVE, TRUE);
 721     }
 722
 723     limit = o->process_rewind ? 0 : o->source->thread_info.max_rewind;
 724
 725     volume_is_norm = pa_cvolume_is_norm(&o->thread_info.soft_volume) && !o->thread_info.muted;
 726     need_volume_factor_source = !pa_cvolume_is_norm(&o->volume_factor_source);
 727
 728     if (limit > 0 && o->source->monitor_of) {
 729         pa_usec_t latency;
 730         size_t n;
 731
 732         /* Hmm, check the latency for knowing how much of the buffered
 733          * data is actually still unplayed and might hence still
 734          * change. This is suboptimal. Ideally we'd have a call like
 735          * pa_sink_get_changeable_size() or so that tells us how much
 736          * of the queued data is actually still changeable. Hence
 737          * FIXME! */
 738
 739         latency = pa_sink_get_latency_within_thread(o->source->monitor_of);
 740
 741         n = pa_usec_to_bytes(latency, &o->source->sample_spec);
 742
 743         if (n < limit)
 744             limit = n;
 745     }
 746
 747     /* Implement the delay queue */
 748     while ((length = pa_memblockq_get_length(o->thread_info.delay_memblockq)) > limit) {
 749         pa_memchunk qchunk;
 750         pa_bool_t nvfs = need_volume_factor_source;
 751
 752         length -= limit;
 753
 754         pa_assert_se(pa_memblockq_peek(o->thread_info.delay_memblockq, &qchunk) >= 0);
 755
 756         if (qchunk.length > length)
 757             qchunk.length = length;
 758
 759         pa_assert(qchunk.length > 0);
 760
 761         /* It might be necessary to adjust the volume here */
 762         if (!volume_is_norm) {
 763             pa_memchunk_make_writable(&qchunk, 0);
 764
 765             if (o->thread_info.muted) {
 766                 pa_silence_memchunk(&qchunk, &o->source->sample_spec);
 767                 nvfs = FALSE;
 768
 769             } else if (!o->thread_info.resampler && nvfs) {
 770                 pa_cvolume v;
 771
 772                 /* If we don't need a resampler we can merge the
 773                  * post and the pre volume adjustment into one */
 774
 775                 pa_sw_cvolume_multiply(&v, &o->thread_info.soft_volume, &o->volume_factor_source);
 776                 pa_volume_memchunk(&qchunk, &o->source->sample_spec, &v);
 777                 nvfs = FALSE;
 778
 779             } else
 780                 pa_volume_memchunk(&qchunk, &o->source->sample_spec, &o->thread_info.soft_volume);
 781         }
 782
 783         if (!o->thread_info.resampler) {
 784             if (nvfs) {
 785                 pa_memchunk_make_writable(&qchunk, 0);
 786                 pa_volume_memchunk(&qchunk, &o->thread_info.sample_spec, &o->volume_factor_source);
 787             }
 788
 789             o->push(o, &qchunk);
 790         } else {
 791             pa_memchunk rchunk;
 792
 793             if (mbs == 0)
 794                 mbs = pa_resampler_max_block_size(o->thread_info.resampler);
 795
 796             if (qchunk.length > mbs)
 797                 qchunk.length = mbs;
 798
 799             pa_resampler_run(o->thread_info.resampler, &qchunk, &rchunk);
 800
 801             if (rchunk.length > 0) {
 802                 if (nvfs) {
 803                     pa_memchunk_make_writable(&rchunk, 0);
 804                     pa_volume_memchunk(&rchunk, &o->thread_info.sample_spec, &o->volume_factor_source);
 805                 }
 806
 807                 o->push(o, &rchunk);
 808             }
 809
 810             if (rchunk.memblock)
 811                 pa_memblock_unref(rchunk.memblock);
 812         }
 813
 814         pa_memblock_unref(qchunk.memblock);
 815         pa_memblockq_drop(o->thread_info.delay_memblockq, qchunk.length);
 816     }
 817 }
 818
 819 /* Called from thread context */
 820 void pa_source_output_process_rewind(pa_source_output *o, size_t nbytes /* in source sample spec */) {
 821
 822     pa_source_output_assert_ref(o);
 823     pa_source_output_assert_io_context(o);
 824     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->thread_info.state));
 825     pa_assert(pa_frame_aligned(nbytes, &o->source->sample_spec));
 826
 827     if (nbytes <= 0)
 828         return;
 829
 830     if (o->process_rewind) {
 831         pa_assert(pa_memblockq_get_length(o->thread_info.delay_memblockq) == 0);
 832
 833         if (o->thread_info.resampler)
 834             nbytes = pa_resampler_result(o->thread_info.resampler, nbytes);
 835
 836         pa_log_debug("Have to rewind %lu bytes on implementor.", (unsigned long) nbytes);
 837
 838         if (nbytes > 0)
 839             o->process_rewind(o, nbytes);
 840
 841         if (o->thread_info.resampler)
 842             pa_resampler_reset(o->thread_info.resampler);
 843
 844     } else
 845         pa_memblockq_rewind(o->thread_info.delay_memblockq, nbytes);
 846 }
 847
 848 /* Called from thread context */
 849 size_t pa_source_output_get_max_rewind(pa_source_output *o) {
 850     pa_source_output_assert_ref(o);
 851     pa_source_output_assert_io_context(o);
 852
 853     return o->thread_info.resampler ? pa_resampler_request(o->thread_info.resampler, o->source->thread_info.max_rewind) : o->source->thread_info.max_rewind;
 854 }
 855
 856 /* Called from thread context */
 857 void pa_source_output_update_max_rewind(pa_source_output *o, size_t nbytes  /* in the source's sample spec */) {
 858     pa_source_output_assert_ref(o);
 859     pa_source_output_assert_io_context(o);
 860     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->thread_info.state));
 861     pa_assert(pa_frame_aligned(nbytes, &o->source->sample_spec));
 862
 863     if (o->update_max_rewind)
 864         o->update_max_rewind(o, o->thread_info.resampler ? pa_resampler_result(o->thread_info.resampler, nbytes) : nbytes);
 865 }
 866
 867 /* Called from thread context */
 868 pa_usec_t pa_source_output_set_requested_latency_within_thread(pa_source_output *o, pa_usec_t usec) {
 869     pa_source_output_assert_ref(o);
 870     pa_source_output_assert_io_context(o);
 871
 872     if (!(o->source->flags & PA_SOURCE_DYNAMIC_LATENCY))
 873         usec = o->source->thread_info.fixed_latency;
 874
 875     if (usec != (pa_usec_t) -1)
 876         usec = PA_CLAMP(usec, o->source->thread_info.min_latency, o->source->thread_info.max_latency);
 877
 878     o->thread_info.requested_source_latency = usec;
 879     pa_source_invalidate_requested_latency(o->source, TRUE);
 880
 881     return usec;
 882 }
 883
 884 /* Called from main context */
 885 pa_usec_t pa_source_output_set_requested_latency(pa_source_output *o, pa_usec_t usec) {
 886     pa_source_output_assert_ref(o);
 887     pa_assert_ctl_context();
 888
 889     if (PA_SOURCE_OUTPUT_IS_LINKED(o->state) && o->source) {
 890         pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_SET_REQUESTED_LATENCY, &usec, 0, NULL) == 0);
 891         return usec;
 892     }
 893
 894     /* If this source output is not realized yet or is being moved, we
 895      * have to touch the thread info data directly */
 896
 897     if (o->source) {
 898         if (!(o->source->flags & PA_SOURCE_DYNAMIC_LATENCY))
 899             usec = pa_source_get_fixed_latency(o->source);
 900
 901         if (usec != (pa_usec_t) -1) {
 902             pa_usec_t min_latency, max_latency;
 903             pa_source_get_latency_range(o->source, &min_latency, &max_latency);
 904             usec = PA_CLAMP(usec, min_latency, max_latency);
 905         }
 906     }
 907
 908     o->thread_info.requested_source_latency = usec;
 909
 910     return usec;
 911 }
 912
 913 /* Called from main context */
 914 pa_usec_t pa_source_output_get_requested_latency(pa_source_output *o) {
 915     pa_source_output_assert_ref(o);
 916     pa_assert_ctl_context();
 917
 918     if (PA_SOURCE_OUTPUT_IS_LINKED(o->state) && o->source) {
 919         pa_usec_t usec = 0;
 920         pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_GET_REQUESTED_LATENCY, &usec, 0, NULL) == 0);
 921         return usec;
 922     }
 923
 924     /* If this source output is not realized yet or is being moved, we
 925      * have to touch the thread info data directly */
 926
 927     return o->thread_info.requested_source_latency;
 928 }
 929
 930 /* Called from main context */
 931 void pa_source_output_set_volume(pa_source_output *o, const pa_cvolume *volume, pa_bool_t save, pa_bool_t absolute) {
 932     pa_cvolume v;
 933
 934     pa_source_output_assert_ref(o);
 935     pa_assert_ctl_context();
 936     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
 937     pa_assert(volume);
 938     pa_assert(pa_cvolume_valid(volume));
 939     pa_assert(volume->channels == 1 || pa_cvolume_compatible(volume, &o->sample_spec));
 940     pa_assert(o->volume_writable);
 941
 942     if (!absolute && pa_source_flat_volume_enabled(o->source)) {
 943         v = o->source->reference_volume;
 944         pa_cvolume_remap(&v, &o->source->channel_map, &o->channel_map);
 945
 946         if (pa_cvolume_compatible(volume, &o->sample_spec))
 947             volume = pa_sw_cvolume_multiply(&v, &v, volume);
 948         else
 949             volume = pa_sw_cvolume_multiply_scalar(&v, &v, pa_cvolume_max(volume));
 950     } else {
 951         if (!pa_cvolume_compatible(volume, &o->sample_spec)) {
 952             v = o->volume;
 953             volume = pa_cvolume_scale(&v, pa_cvolume_max(volume));
 954         }
 955     }
 956
 957     if (pa_cvolume_equal(volume, &o->volume)) {
 958         o->save_volume = o->save_volume || save;
 959         return;
 960     }
 961
 962     o->volume = *volume;
 963     o->save_volume = save;
 964
 965     if (pa_source_flat_volume_enabled(o->source)) {
 966         /* We are in flat volume mode, so let's update all source input
 967          * volumes and update the flat volume of the source */
 968
 969         pa_source_set_volume(o->source, NULL, TRUE, save);
 970
 971     } else {
 972         /* OK, we are in normal volume mode. The volume only affects
 973          * ourselves */
 974         set_real_ratio(o, volume);
 975
 976         /* Copy the new soft_volume to the thread_info struct */
 977         pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_SET_SOFT_VOLUME, NULL, 0, NULL) == 0);
 978     }
 979
 980     /* The volume changed, let's tell people so */
 981     if (o->volume_changed)
 982         o->volume_changed(o);
 983
 984     /* The virtual volume changed, let's tell people so */
 985     pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
 986 }
 987
 988 /* Called from main context */
 989 static void set_real_ratio(pa_source_output *o, const pa_cvolume *v) {
 990     pa_source_output_assert_ref(o);
 991     pa_assert_ctl_context();
 992     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
 993     pa_assert(!v || pa_cvolume_compatible(v, &o->sample_spec));
 994
 995     /* This basically calculates:
 996      *
 997      * o->real_ratio := v
 998      * o->soft_volume := o->real_ratio * o->volume_factor */
 999
1000     if (v)
1001         o->real_ratio = *v;
1002     else
1003         pa_cvolume_reset(&o->real_ratio, o->sample_spec.channels);
1004
1005     pa_sw_cvolume_multiply(&o->soft_volume, &o->real_ratio, &o->volume_factor);
1006     /* We don't copy the data to the thread_info data. That's left for someone else to do */
1007 }
1008
1009 /* Called from main or I/O context */
1010 pa_bool_t pa_source_output_is_passthrough(pa_source_output *o) {
1011     pa_source_output_assert_ref(o);
1012
1013     if (PA_UNLIKELY(!pa_format_info_is_pcm(o->format)))
1014         return TRUE;
1015
1016     if (PA_UNLIKELY(o->flags & PA_SOURCE_OUTPUT_PASSTHROUGH))
1017         return TRUE;
1018
1019     return FALSE;
1020 }
1021
1022 /* Called from main context */
1023 pa_bool_t pa_source_output_is_volume_readable(pa_source_output *o) {
1024     pa_source_output_assert_ref(o);
1025     pa_assert_ctl_context();
1026
1027     return !pa_source_output_is_passthrough(o);
1028 }
1029
1030 /* Called from main context */
1031 pa_cvolume *pa_source_output_get_volume(pa_source_output *o, pa_cvolume *volume, pa_bool_t absolute) {
1032     pa_source_output_assert_ref(o);
1033     pa_assert_ctl_context();
1034     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1035     pa_assert(pa_source_output_is_volume_readable(o));
1036
1037     if (absolute || !pa_source_flat_volume_enabled(o->source))
1038         *volume = o->volume;
1039     else
1040         *volume = o->reference_ratio;
1041
1042     return volume;
1043 }
1044
1045 /* Called from main context */
1046 void pa_source_output_set_mute(pa_source_output *o, pa_bool_t mute, pa_bool_t save) {
1047     pa_source_output_assert_ref(o);
1048     pa_assert_ctl_context();
1049     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1050
1051     if (!o->muted == !mute) {
1052         o->save_muted = o->save_muted || mute;
1053         return;
1054     }
1055
1056     o->muted = mute;
1057     o->save_muted = save;
1058
1059     pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_SET_SOFT_MUTE, NULL, 0, NULL) == 0);
1060
1061     /* The mute status changed, let's tell people so */
1062     if (o->mute_changed)
1063         o->mute_changed(o);
1064
1065     pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
1066 }
1067
1068 /* Called from main context */
1069 pa_bool_t pa_source_output_get_mute(pa_source_output *o) {
1070     pa_source_output_assert_ref(o);
1071     pa_assert_ctl_context();
1072     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1073
1074     return o->muted;
1075 }
1076
1077 /* Called from main thread */
1078 void pa_source_output_update_proplist(pa_source_output *o, pa_update_mode_t mode, pa_proplist *p) {
1079     pa_source_output_assert_ref(o);
1080     pa_assert_ctl_context();
1081
1082     if (p)
1083         pa_proplist_update(o->proplist, mode, p);
1084
1085     if (PA_SOURCE_OUTPUT_IS_LINKED(o->state)) {
1086         pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_PROPLIST_CHANGED], o);
1087         pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
1088     }
1089 }
1090
1091 /* Called from main context */
1092 void pa_source_output_cork(pa_source_output *o, pa_bool_t b) {
1093     pa_source_output_assert_ref(o);
1094     pa_assert_ctl_context();
1095     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1096
1097     source_output_set_state(o, b ? PA_SOURCE_OUTPUT_CORKED : PA_SOURCE_OUTPUT_RUNNING);
1098 }
1099
1100 /* Called from main context */
1101 int pa_source_output_set_rate(pa_source_output *o, uint32_t rate) {
1102     pa_source_output_assert_ref(o);
1103     pa_assert_ctl_context();
1104     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1105     pa_return_val_if_fail(o->thread_info.resampler, -PA_ERR_BADSTATE);
1106
1107     if (o->sample_spec.rate == rate)
1108         return 0;
1109
1110     o->sample_spec.rate = rate;
1111
1112     pa_asyncmsgq_post(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_SET_RATE, PA_UINT_TO_PTR(rate), 0, NULL, NULL);
1113
1114     pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
1115     return 0;
1116 }
1117
1118 /* Called from main context */
1119 void pa_source_output_set_name(pa_source_output *o, const char *name) {
1120     const char *old;
1121     pa_assert_ctl_context();
1122     pa_source_output_assert_ref(o);
1123
1124     if (!name && !pa_proplist_contains(o->proplist, PA_PROP_MEDIA_NAME))
1125         return;
1126
1127     old = pa_proplist_gets(o->proplist, PA_PROP_MEDIA_NAME);
1128
1129     if (old && name && !strcmp(old, name))
1130         return;
1131
1132     if (name)
1133         pa_proplist_sets(o->proplist, PA_PROP_MEDIA_NAME, name);
1134     else
1135         pa_proplist_unset(o->proplist, PA_PROP_MEDIA_NAME);
1136
1137     if (PA_SOURCE_OUTPUT_IS_LINKED(o->state)) {
1138         pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_PROPLIST_CHANGED], o);
1139         pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
1140     }
1141 }
1142
1143 /* Called from main context */
1144 pa_resample_method_t pa_source_output_get_resample_method(pa_source_output *o) {
1145     pa_source_output_assert_ref(o);
1146     pa_assert_ctl_context();
1147
1148     return o->actual_resample_method;
1149 }
1150
1151 /* Called from main context */
1152 pa_bool_t pa_source_output_may_move(pa_source_output *o) {
1153     pa_source_output_assert_ref(o);
1154     pa_assert_ctl_context();
1155     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1156
1157     if (o->flags & PA_SOURCE_OUTPUT_DONT_MOVE)
1158         return FALSE;
1159
1160     if (o->direct_on_input)
1161         return FALSE;
1162
1163     return TRUE;
1164 }
1165
1166 /* Called from main context */
1167 pa_bool_t pa_source_output_may_move_to(pa_source_output *o, pa_source *dest) {
1168     pa_source_output_assert_ref(o);
1169     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1170     pa_source_assert_ref(dest);
1171
1172     if (dest == o->source)
1173         return TRUE;
1174
1175     if (!pa_source_output_may_move(o))
1176         return FALSE;
1177
1178     if (pa_idxset_size(dest->outputs) >= PA_MAX_OUTPUTS_PER_SOURCE) {
1179         pa_log_warn("Failed to move source output: too many outputs per source.");
1180         return FALSE;
1181     }
1182
1183     if (o->may_move_to)
1184         if (!o->may_move_to(o, dest))
1185             return FALSE;
1186
1187     return TRUE;
1188 }
1189
1190 /* Called from main context */
1191 int pa_source_output_start_move(pa_source_output *o) {
1192     pa_source *origin;
1193     int r;
1194
1195     pa_source_output_assert_ref(o);
1196     pa_assert_ctl_context();
1197     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1198     pa_assert(o->source);
1199
1200     if (!pa_source_output_may_move(o))
1201         return -PA_ERR_NOTSUPPORTED;
1202
1203     if ((r = pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_START], o)) < 0)
1204         return r;
1205
1206     origin = o->source;
1207
1208     pa_idxset_remove_by_data(o->source->outputs, o, NULL);
1209
1210     if (pa_source_output_get_state(o) == PA_SOURCE_OUTPUT_CORKED)
1211         pa_assert_se(origin->n_corked-- >= 1);
1212
1213     if (pa_source_output_is_passthrough(o))
1214         pa_source_leave_passthrough(o->source);
1215
1216     if (pa_source_flat_volume_enabled(o->source))
1217         /* We might need to update the source's volume if we are in flat
1218          * volume mode. */
1219         pa_source_set_volume(o->source, NULL, FALSE, FALSE);
1220
1221     pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_REMOVE_OUTPUT, o, 0, NULL) == 0);
1222
1223     pa_source_update_status(o->source);
1224     o->source = NULL;
1225
1226     pa_source_output_unref(o);
1227
1228     return 0;
1229 }
1230
1231 /* Called from main context. If it has an origin source that uses volume sharing,
1232  * then also the origin source and all streams connected to it need to update
1233  * their volume - this function does all that by using recursion. */
1234 static void update_volume_due_to_moving(pa_source_output *o, pa_source *dest) {
1235     pa_cvolume old_volume;
1236
1237     pa_assert(o);
1238     pa_assert(dest);
1239     pa_assert(o->source); /* The destination source should already be set. */
1240
1241     if (o->destination_source && (o->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER)) {
1242         pa_source *root_source;
1243         pa_source_output *destination_source_output;
1244         uint32_t idx;
1245
1246         root_source = pa_source_get_master(o->source);
1247
1248         if (PA_UNLIKELY(!root_source))
1249             return;
1250
1251         if (pa_source_flat_volume_enabled(o->source)) {
1252             /* Ok, so the origin source uses volume sharing, and flat volume is
1253              * enabled. The volume will have to be updated as follows:
1254              *
1255              *     o->volume := o->source->real_volume
1256              *         (handled later by pa_source_set_volume)
1257              *     o->reference_ratio := o->volume / o->source->reference_volume
1258              *         (handled later by pa_source_set_volume)
1259              *     o->real_ratio stays unchanged
1260              *         (streams whose origin source uses volume sharing should
1261              *          always have real_ratio of 0 dB)
1262              *     o->soft_volume stays unchanged
1263              *         (streams whose origin source uses volume sharing should
1264              *          always have volume_factor as soft_volume, so no change
1265              *          should be needed) */
1266
1267             pa_assert(pa_cvolume_is_norm(&o->real_ratio));
1268             pa_assert(pa_cvolume_equal(&o->soft_volume, &o->volume_factor));
1269
1270             /* Notifications will be sent by pa_source_set_volume(). */
1271
1272         } else {
1273             /* Ok, so the origin source uses volume sharing, and flat volume is
1274              * disabled. The volume will have to be updated as follows:
1275              *
1276              *     o->volume := 0 dB
1277              *     o->reference_ratio := 0 dB
1278              *     o->real_ratio stays unchanged
1279              *         (streams whose origin source uses volume sharing should
1280              *          always have real_ratio of 0 dB)
1281              *     o->soft_volume stays unchanged
1282              *         (streams whose origin source uses volume sharing should
1283              *          always have volume_factor as soft_volume, so no change
1284              *          should be needed) */
1285
1286             old_volume = o->volume;
1287             pa_cvolume_reset(&o->volume, o->volume.channels);
1288             pa_cvolume_reset(&o->reference_ratio, o->reference_ratio.channels);
1289             pa_assert(pa_cvolume_is_norm(&o->real_ratio));
1290             pa_assert(pa_cvolume_equal(&o->soft_volume, &o->volume_factor));
1291
1292             /* Notify others about the changed source output volume. */
1293             if (!pa_cvolume_equal(&o->volume, &old_volume)) {
1294                 if (o->volume_changed)
1295                     o->volume_changed(o);
1296
1297                 pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
1298             }
1299         }
1300
1301         /* Additionally, the origin source volume needs updating:
1302          *
1303          *     o->destination_source->reference_volume := root_source->reference_volume
1304          *     o->destination_source->real_volume := root_source->real_volume
1305          *     o->destination_source->soft_volume stays unchanged
1306          *         (sources that use volume sharing should always have
1307          *          soft_volume of 0 dB) */
1308
1309         old_volume = o->destination_source->reference_volume;
1310
1311         o->destination_source->reference_volume = root_source->reference_volume;
1312         pa_cvolume_remap(&o->destination_source->reference_volume, &root_source->channel_map, &o->destination_source->channel_map);
1313
1314         o->destination_source->real_volume = root_source->real_volume;
1315         pa_cvolume_remap(&o->destination_source->real_volume, &root_source->channel_map, &o->destination_source->channel_map);
1316
1317         pa_assert(pa_cvolume_is_norm(&o->destination_source->soft_volume));
1318
1319         /* Notify others about the changed source volume. If you wonder whether
1320          * o->destination_source->set_volume() should be called somewhere, that's not
1321          * the case, because sources that use volume sharing shouldn't have any
1322          * internal volume that set_volume() would update. If you wonder
1323          * whether the thread_info variables should be synced, yes, they
1324          * should, and it's done by the PA_SOURCE_MESSAGE_FINISH_MOVE message
1325          * handler. */
1326         if (!pa_cvolume_equal(&o->destination_source->reference_volume, &old_volume))
1327             pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, o->destination_source->index);
1328
1329         /* Recursively update origin source outputs. */
1330         PA_IDXSET_FOREACH(destination_source_output, o->destination_source->outputs, idx)
1331             update_volume_due_to_moving(destination_source_output, dest);
1332
1333     } else {
1334         old_volume = o->volume;
1335
1336         if (pa_source_flat_volume_enabled(o->source)) {
1337             /* Ok, so this is a regular stream, and flat volume is enabled. The
1338              * volume will have to be updated as follows:
1339              *
1340              *     o->volume := o->reference_ratio * o->source->reference_volume
1341              *     o->reference_ratio stays unchanged
1342              *     o->real_ratio := o->volume / o->source->real_volume
1343              *         (handled later by pa_source_set_volume)
1344              *     o->soft_volume := o->real_ratio * o->volume_factor
1345              *         (handled later by pa_source_set_volume) */
1346
1347             o->volume = o->source->reference_volume;
1348             pa_cvolume_remap(&o->volume, &o->source->channel_map, &o->channel_map);
1349             pa_sw_cvolume_multiply(&o->volume, &o->volume, &o->reference_ratio);
1350
1351         } else {
1352             /* Ok, so this is a regular stream, and flat volume is disabled.
1353              * The volume will have to be updated as follows:
1354              *
1355              *     o->volume := o->reference_ratio
1356              *     o->reference_ratio stays unchanged
1357              *     o->real_ratio := o->reference_ratio
1358              *     o->soft_volume := o->real_ratio * o->volume_factor */
1359
1360             o->volume = o->reference_ratio;
1361             o->real_ratio = o->reference_ratio;
1362             pa_sw_cvolume_multiply(&o->soft_volume, &o->real_ratio, &o->volume_factor);
1363         }
1364
1365         /* Notify others about the changed source output volume. */
1366         if (!pa_cvolume_equal(&o->volume, &old_volume)) {
1367             /* XXX: In case o->source has flat volume enabled, then real_ratio
1368              * and soft_volume are not updated yet. Let's hope that the
1369              * callback implementation doesn't care about those variables... */
1370             if (o->volume_changed)
1371                 o->volume_changed(o);
1372
1373             pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
1374         }
1375     }
1376
1377     /* If o->source == dest, then recursion has finished, and we can finally call
1378      * pa_source_set_volume(), which will do the rest of the updates. */
1379     if ((o->source == dest) && pa_source_flat_volume_enabled(o->source))
1380         pa_source_set_volume(o->source, NULL, FALSE, o->save_volume);
1381 }
1382
1383 /* Called from main context */
1384 int pa_source_output_finish_move(pa_source_output *o, pa_source *dest, pa_bool_t save) {
1385     pa_source_output_assert_ref(o);
1386     pa_assert_ctl_context();
1387     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1388     pa_assert(!o->source);
1389     pa_source_assert_ref(dest);
1390
1391     if (!pa_source_output_may_move_to(o, dest))
1392         return -PA_ERR_NOTSUPPORTED;
1393
1394     if (pa_source_output_is_passthrough(o) && !pa_source_check_format(dest, o->format)) {
1395         pa_proplist *p = pa_proplist_new();
1396         pa_log_debug("New source doesn't support stream format, sending format-changed and killing");
1397         /* Tell the client what device we want to be on if it is going to
1398          * reconnect */
1399         pa_proplist_sets(p, "device", dest->name);
1400         pa_source_output_send_event(o, PA_STREAM_EVENT_FORMAT_LOST, p);
1401         pa_proplist_free(p);
1402         return -PA_ERR_NOTSUPPORTED;
1403     }
1404
1405     if (!(o->flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) &&
1406         !pa_sample_spec_equal(&o->sample_spec, &dest->sample_spec)){
1407         /* try to change dest sink rate if possible without glitches.
1408            module-suspend-on-idle resumes destination source with
1409            SOURCE_OUTPUT_MOVE_FINISH hook */
1410
1411         pa_log_info("Trying to change sample rate");
1412         if (pa_source_update_rate(dest, o->sample_spec.rate, pa_source_output_is_passthrough(o)) == TRUE)
1413             pa_log_info("Rate changed to %u Hz",
1414                         dest->sample_spec.rate);
1415         else
1416             pa_log_info("Resampling enabled to %u Hz",
1417                         dest->sample_spec.rate);
1418     }
1419
1420     if (o->moving)
1421         o->moving(o, dest);
1422
1423     o->source = dest;
1424     o->save_source = save;
1425     pa_idxset_put(o->source->outputs, pa_source_output_ref(o), NULL);
1426
1427     pa_cvolume_remap(&o->volume_factor_source, &o->channel_map, &o->source->channel_map);
1428
1429     if (pa_source_output_get_state(o) == PA_SOURCE_OUTPUT_CORKED)
1430         o->source->n_corked++;
1431
1432     pa_source_output_update_rate(o);
1433
1434     pa_source_update_status(dest);
1435
1436     update_volume_due_to_moving(o, dest);
1437
1438     if (pa_source_output_is_passthrough(o))
1439         pa_source_enter_passthrough(o->source);
1440
1441     pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_ADD_OUTPUT, o, 0, NULL) == 0);
1442
1443     pa_log_debug("Successfully moved source output %i to %s.", o->index, dest->name);
1444
1445     /* Notify everyone */
1446     pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_FINISH], o);
1447     pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
1448
1449     return 0;
1450 }
1451
1452 /* Called from main context */
1453 void pa_source_output_fail_move(pa_source_output *o) {
1454
1455     pa_source_output_assert_ref(o);
1456     pa_assert_ctl_context();
1457     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1458     pa_assert(!o->source);
1459
1460     /* Check if someone wants this source output? */
1461     if (pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_FAIL], o) == PA_HOOK_STOP)
1462         return;
1463
1464     if (o->moving)
1465         o->moving(o, NULL);
1466
1467     pa_source_output_kill(o);
1468 }
1469
1470 /* Called from main context */
1471 int pa_source_output_move_to(pa_source_output *o, pa_source *dest, pa_bool_t save) {
1472     int r;
1473
1474     pa_source_output_assert_ref(o);
1475     pa_assert_ctl_context();
1476     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1477     pa_assert(o->source);
1478     pa_source_assert_ref(dest);
1479
1480     if (dest == o->source)
1481         return 0;
1482
1483     if (!pa_source_output_may_move_to(o, dest))
1484         return -PA_ERR_NOTSUPPORTED;
1485
1486     pa_source_output_ref(o);
1487
1488     if ((r = pa_source_output_start_move(o)) < 0) {
1489         pa_source_output_unref(o);
1490         return r;
1491     }
1492
1493     if ((r = pa_source_output_finish_move(o, dest, save)) < 0) {
1494         pa_source_output_fail_move(o);
1495         pa_source_output_unref(o);
1496         return r;
1497     }
1498
1499     pa_source_output_unref(o);
1500
1501     return 0;
1502 }
1503
1504 /* Called from IO thread context */
1505 void pa_source_output_set_state_within_thread(pa_source_output *o, pa_source_output_state_t state) {
1506     pa_source_output_assert_ref(o);
1507     pa_source_output_assert_io_context(o);
1508
1509     if (state == o->thread_info.state)
1510         return;
1511
1512     if (o->state_change)
1513         o->state_change(o, state);
1514
1515     o->thread_info.state = state;
1516 }
1517
1518 /* Called from IO thread context, except when it is not */
1519 int pa_source_output_process_msg(pa_msgobject *mo, int code, void *userdata, int64_t offset, pa_memchunk* chunk) {
1520     pa_source_output *o = PA_SOURCE_OUTPUT(mo);
1521     pa_source_output_assert_ref(o);
1522
1523     switch (code) {
1524
1525         case PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY: {
1526             pa_usec_t *r = userdata;
1527
1528             r[0] += pa_bytes_to_usec(pa_memblockq_get_length(o->thread_info.delay_memblockq), &o->source->sample_spec);
1529             r[1] += pa_source_get_latency_within_thread(o->source);
1530
1531             return 0;
1532         }
1533
1534         case PA_SOURCE_OUTPUT_MESSAGE_SET_RATE:
1535
1536             o->thread_info.sample_spec.rate = PA_PTR_TO_UINT(userdata);
1537             pa_resampler_set_output_rate(o->thread_info.resampler, PA_PTR_TO_UINT(userdata));
1538             return 0;
1539
1540         case PA_SOURCE_OUTPUT_MESSAGE_SET_STATE:
1541
1542             pa_source_output_set_state_within_thread(o, PA_PTR_TO_UINT(userdata));
1543
1544             return 0;
1545
1546         case PA_SOURCE_OUTPUT_MESSAGE_SET_REQUESTED_LATENCY: {
1547             pa_usec_t *usec = userdata;
1548
1549             *usec = pa_source_output_set_requested_latency_within_thread(o, *usec);
1550
1551             return 0;
1552         }
1553
1554         case PA_SOURCE_OUTPUT_MESSAGE_GET_REQUESTED_LATENCY: {
1555             pa_usec_t *r = userdata;
1556
1557             *r = o->thread_info.requested_source_latency;
1558             return 0;
1559         }
1560
1561         case PA_SOURCE_OUTPUT_MESSAGE_SET_SOFT_VOLUME:
1562             if (!pa_cvolume_equal(&o->thread_info.soft_volume, &o->soft_volume)) {
1563                 o->thread_info.soft_volume = o->soft_volume;
1564             }
1565             return 0;
1566
1567         case PA_SOURCE_OUTPUT_MESSAGE_SET_SOFT_MUTE:
1568             if (o->thread_info.muted != o->muted) {
1569                 o->thread_info.muted = o->muted;
1570             }
1571             return 0;
1572     }
1573
1574     return -PA_ERR_NOTIMPLEMENTED;
1575 }
1576
1577 /* Called from main context */
1578 void pa_source_output_send_event(pa_source_output *o, const char *event, pa_proplist *data) {
1579     pa_proplist *pl = NULL;
1580     pa_source_output_send_event_hook_data hook_data;
1581
1582     pa_source_output_assert_ref(o);
1583     pa_assert_ctl_context();
1584     pa_assert(event);
1585
1586     if (!o->send_event)
1587         return;
1588
1589     if (!data)
1590         data = pl = pa_proplist_new();
1591
1592     hook_data.source_output = o;
1593     hook_data.data = data;
1594     hook_data.event = event;
1595
1596     if (pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_SEND_EVENT], &hook_data) < 0)
1597         goto finish;
1598
1599     o->send_event(o, event, data);
1600
1601 finish:
1602     if (pl)
1603         pa_proplist_free(pl);
1604 }
1605
1606 /* Called from main context */
1607 /* Updates the source output's resampler with whatever the current source
1608  * requires -- useful when the underlying source's rate might have changed */
1609 int pa_source_output_update_rate(pa_source_output *o) {
1610     pa_resampler *new_resampler;
1611     char *memblockq_name;
1612
1613     pa_source_output_assert_ref(o);
1614     pa_assert_ctl_context();
1615
1616     if (o->thread_info.resampler &&
1617         pa_sample_spec_equal(pa_resampler_input_sample_spec(o->thread_info.resampler), &o->source->sample_spec) &&
1618         pa_channel_map_equal(pa_resampler_input_channel_map(o->thread_info.resampler), &o->source->channel_map))
1619
1620         new_resampler = o->thread_info.resampler;
1621
1622     else if (!pa_source_output_is_passthrough(o) &&
1623         ((o->flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) ||
1624          !pa_sample_spec_equal(&o->sample_spec, &o->source->sample_spec) ||
1625          !pa_channel_map_equal(&o->channel_map, &o->source->channel_map))) {
1626
1627         new_resampler = pa_resampler_new(o->core->mempool,
1628                                      &o->source->sample_spec, &o->source->channel_map,
1629                                      &o->sample_spec, &o->channel_map,
1630                                      o->requested_resample_method,
1631                                      ((o->flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) ? PA_RESAMPLER_VARIABLE_RATE : 0) |
1632                                      ((o->flags & PA_SOURCE_OUTPUT_NO_REMAP) ? PA_RESAMPLER_NO_REMAP : 0) |
1633                                      (o->core->disable_remixing || (o->flags & PA_SOURCE_OUTPUT_NO_REMIX) ? PA_RESAMPLER_NO_REMIX : 0));
1634
1635         if (!new_resampler) {
1636             pa_log_warn("Unsupported resampling operation.");
1637             return -PA_ERR_NOTSUPPORTED;
1638         }
1639     } else
1640         new_resampler = NULL;
1641
1642     if (new_resampler == o->thread_info.resampler)
1643         return 0;
1644
1645     if (o->thread_info.resampler)
1646         pa_resampler_free(o->thread_info.resampler);
1647
1648     o->thread_info.resampler = new_resampler;
1649
1650     pa_memblockq_free(o->thread_info.delay_memblockq);
1651
1652     memblockq_name = pa_sprintf_malloc("source output delay_memblockq [%u]", o->index);
1653     o->thread_info.delay_memblockq = pa_memblockq_new(
1654             memblockq_name,
1655             0,
1656             MEMBLOCKQ_MAXLENGTH,
1657             0,
1658             &o->source->sample_spec,
1659             0,
1660             1,
1661             0,
1662             &o->source->silence);
1663     pa_xfree(memblockq_name);
1664
1665     o->actual_resample_method = new_resampler ? pa_resampler_get_method(new_resampler) : PA_RESAMPLER_INVALID;
1666
1667     pa_log_debug("Updated resmpler for source output %d", o->index);
1668
1669     return 0;
1670 }