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
  34 #include <pulsecore/sample-util.h>
  35 #include <pulsecore/core-subscribe.h>
  36 #include <pulsecore/log.h>
  37 #include <pulsecore/namereg.h>
  38 #include <pulsecore/core-util.h>
  39
  40 #include "source-output.h"
  41
  42 #define MEMBLOCKQ_MAXLENGTH (32*1024*1024)
  43
  44 PA_DEFINE_PUBLIC_CLASS(pa_source_output, pa_msgobject);
  45
  46 static void source_output_free(pa_object* mo);
  47
  48 pa_source_output_new_data* pa_source_output_new_data_init(pa_source_output_new_data *data) {
  49     pa_assert(data);
  50
  51     pa_zero(*data);
  52     data->resample_method = PA_RESAMPLER_INVALID;
  53     data->proplist = pa_proplist_new();
  54
  55     return data;
  56 }
  57
  58 void pa_source_output_new_data_set_sample_spec(pa_source_output_new_data *data, const pa_sample_spec *spec) {
  59     pa_assert(data);
  60
  61     if ((data->sample_spec_is_set = !!spec))
  62         data->sample_spec = *spec;
  63 }
  64
  65 void pa_source_output_new_data_set_channel_map(pa_source_output_new_data *data, const pa_channel_map *map) {
  66     pa_assert(data);
  67
  68     if ((data->channel_map_is_set = !!map))
  69         data->channel_map = *map;
  70 }
  71
  72 void pa_source_output_new_data_done(pa_source_output_new_data *data) {
  73     pa_assert(data);
  74
  75     pa_proplist_free(data->proplist);
  76 }
  77
  78 /* Called from main context */
  79 static void reset_callbacks(pa_source_output *o) {
  80     pa_assert(o);
  81
  82     o->push = NULL;
  83     o->process_rewind = NULL;
  84     o->update_max_rewind = NULL;
  85     o->update_source_requested_latency = NULL;
  86     o->update_source_latency_range = NULL;
  87     o->update_source_fixed_latency = NULL;
  88     o->attach = NULL;
  89     o->detach = NULL;
  90     o->suspend = NULL;
  91     o->suspend_within_thread = NULL;
  92     o->moving = NULL;
  93     o->kill = NULL;
  94     o->get_latency = NULL;
  95     o->state_change = NULL;
  96     o->may_move_to = NULL;
  97     o->send_event = NULL;
  98 }
  99
 100 /* Called from main context */
 101 int pa_source_output_new(
 102         pa_source_output**_o,
 103         pa_core *core,
 104         pa_source_output_new_data *data) {
 105
 106     pa_source_output *o;
 107     pa_resampler *resampler = NULL;
 108     char st[PA_SAMPLE_SPEC_SNPRINT_MAX], cm[PA_CHANNEL_MAP_SNPRINT_MAX];
 109     int r;
 110     char *pt;
 111
 112     pa_assert(_o);
 113     pa_assert(core);
 114     pa_assert(data);
 115     pa_assert_ctl_context();
 116
 117     if (data->client)
 118         pa_proplist_update(data->proplist, PA_UPDATE_MERGE, data->client->proplist);
 119
 120     if ((r = pa_hook_fire(&core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_NEW], data)) < 0)
 121         return r;
 122
 123     pa_return_val_if_fail(!data->driver || pa_utf8_valid(data->driver), -PA_ERR_INVALID);
 124
 125     if (!data->source) {
 126         data->source = pa_namereg_get(core, NULL, PA_NAMEREG_SOURCE);
 127         data->save_source = FALSE;
 128     }
 129
 130     pa_return_val_if_fail(data->source, -PA_ERR_NOENTITY);
 131     pa_return_val_if_fail(PA_SOURCE_IS_LINKED(pa_source_get_state(data->source)), -PA_ERR_BADSTATE);
 132     pa_return_val_if_fail(!data->direct_on_input || data->direct_on_input->sink == data->source->monitor_of, -PA_ERR_INVALID);
 133
 134     if (!data->sample_spec_is_set)
 135         data->sample_spec = data->source->sample_spec;
 136
 137     pa_return_val_if_fail(pa_sample_spec_valid(&data->sample_spec), -PA_ERR_INVALID);
 138
 139     if (!data->channel_map_is_set) {
 140         if (pa_channel_map_compatible(&data->source->channel_map, &data->sample_spec))
 141             data->channel_map = data->source->channel_map;
 142         else
 143             pa_channel_map_init_extend(&data->channel_map, data->sample_spec.channels, PA_CHANNEL_MAP_DEFAULT);
 144     }
 145
 146     pa_return_val_if_fail(pa_channel_map_valid(&data->channel_map), -PA_ERR_INVALID);
 147     pa_return_val_if_fail(pa_channel_map_compatible(&data->channel_map, &data->sample_spec), -PA_ERR_INVALID);
 148
 149     if (data->flags & PA_SOURCE_OUTPUT_FIX_FORMAT)
 150         data->sample_spec.format = data->source->sample_spec.format;
 151
 152     if (data->flags & PA_SOURCE_OUTPUT_FIX_RATE)
 153         data->sample_spec.rate = data->source->sample_spec.rate;
 154
 155     if (data->flags & PA_SOURCE_OUTPUT_FIX_CHANNELS) {
 156         data->sample_spec.channels = data->source->sample_spec.channels;
 157         data->channel_map = data->source->channel_map;
 158     }
 159
 160     pa_assert(pa_sample_spec_valid(&data->sample_spec));
 161     pa_assert(pa_channel_map_valid(&data->channel_map));
 162
 163     if (data->resample_method == PA_RESAMPLER_INVALID)
 164         data->resample_method = core->resample_method;
 165
 166     pa_return_val_if_fail(data->resample_method < PA_RESAMPLER_MAX, -PA_ERR_INVALID);
 167
 168     if ((r = pa_hook_fire(&core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_FIXATE], data)) < 0)
 169         return r;
 170
 171     if ((data->flags & PA_SOURCE_OUTPUT_NO_CREATE_ON_SUSPEND) &&
 172         pa_source_get_state(data->source) == PA_SOURCE_SUSPENDED) {
 173         pa_log("Failed to create source output: source is suspended.");
 174         return -PA_ERR_BADSTATE;
 175     }
 176
 177     if (pa_idxset_size(data->source->outputs) >= PA_MAX_OUTPUTS_PER_SOURCE) {
 178         pa_log("Failed to create source output: too many outputs per source.");
 179         return -PA_ERR_TOOLARGE;
 180     }
 181
 182     if ((data->flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) ||
 183         !pa_sample_spec_equal(&data->sample_spec, &data->source->sample_spec) ||
 184         !pa_channel_map_equal(&data->channel_map, &data->source->channel_map)) {
 185
 186         if (!(resampler = pa_resampler_new(
 187                       core->mempool,
 188                       &data->source->sample_spec, &data->source->channel_map,
 189                       &data->sample_spec, &data->channel_map,
 190                       data->resample_method,
 191                       ((data->flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) ? PA_RESAMPLER_VARIABLE_RATE : 0) |
 192                       ((data->flags & PA_SOURCE_OUTPUT_NO_REMAP) ? PA_RESAMPLER_NO_REMAP : 0) |
 193                       (core->disable_remixing || (data->flags & PA_SOURCE_OUTPUT_NO_REMIX) ? PA_RESAMPLER_NO_REMIX : 0) |
 194                       (core->disable_lfe_remixing ? PA_RESAMPLER_NO_LFE : 0)))) {
 195             pa_log_warn("Unsupported resampling operation.");
 196             return -PA_ERR_NOTSUPPORTED;
 197         }
 198     }
 199
 200     o = pa_msgobject_new(pa_source_output);
 201     o->parent.parent.free = source_output_free;
 202     o->parent.process_msg = pa_source_output_process_msg;
 203
 204     o->core = core;
 205     o->state = PA_SOURCE_OUTPUT_INIT;
 206     o->flags = data->flags;
 207     o->proplist = pa_proplist_copy(data->proplist);
 208     o->driver = pa_xstrdup(pa_path_get_filename(data->driver));
 209     o->module = data->module;
 210     o->source = data->source;
 211     o->destination_source = data->destination_source;
 212     o->client = data->client;
 213
 214     o->actual_resample_method = resampler ? pa_resampler_get_method(resampler) : PA_RESAMPLER_INVALID;
 215     o->requested_resample_method = data->resample_method;
 216     o->sample_spec = data->sample_spec;
 217     o->channel_map = data->channel_map;
 218
 219     o->direct_on_input = data->direct_on_input;
 220
 221     o->save_source = data->save_source;
 222
 223     reset_callbacks(o);
 224     o->userdata = NULL;
 225
 226     o->thread_info.state = o->state;
 227     o->thread_info.attached = FALSE;
 228     o->thread_info.sample_spec = o->sample_spec;
 229     o->thread_info.resampler = resampler;
 230     o->thread_info.requested_source_latency = (pa_usec_t) -1;
 231     o->thread_info.direct_on_input = o->direct_on_input;
 232
 233     o->thread_info.delay_memblockq = pa_memblockq_new(
 234             0,
 235             MEMBLOCKQ_MAXLENGTH,
 236             0,
 237             pa_frame_size(&o->source->sample_spec),
 238             0,
 239             1,
 240             0,
 241             &o->source->silence);
 242
 243     pa_assert_se(pa_idxset_put(core->source_outputs, o, &o->index) == 0);
 244     pa_assert_se(pa_idxset_put(o->source->outputs, pa_source_output_ref(o), NULL) == 0);
 245
 246     if (o->client)
 247         pa_assert_se(pa_idxset_put(o->client->source_outputs, o, NULL) >= 0);
 248
 249     if (o->direct_on_input)
 250         pa_assert_se(pa_idxset_put(o->direct_on_input->direct_outputs, o, NULL) == 0);
 251
 252     pt = pa_proplist_to_string_sep(o->proplist, "\n    ");
 253     pa_log_info("Created output %u \"%s\" on %s with sample spec %s and channel map %s\n    %s",
 254                 o->index,
 255                 pa_strnull(pa_proplist_gets(o->proplist, PA_PROP_MEDIA_NAME)),
 256                 o->source->name,
 257                 pa_sample_spec_snprint(st, sizeof(st), &o->sample_spec),
 258                 pa_channel_map_snprint(cm, sizeof(cm), &o->channel_map),
 259                 pt);
 260     pa_xfree(pt);
 261
 262     /* Don't forget to call pa_source_output_put! */
 263
 264     *_o = o;
 265     return 0;
 266 }
 267
 268 /* Called from main context */
 269 static void update_n_corked(pa_source_output *o, pa_source_output_state_t state) {
 270     pa_assert(o);
 271     pa_assert_ctl_context();
 272
 273     if (!o->source)
 274         return;
 275
 276     if (o->state == PA_SOURCE_OUTPUT_CORKED && state != PA_SOURCE_OUTPUT_CORKED)
 277         pa_assert_se(o->source->n_corked -- >= 1);
 278     else if (o->state != PA_SOURCE_OUTPUT_CORKED && state == PA_SOURCE_OUTPUT_CORKED)
 279         o->source->n_corked++;
 280 }
 281
 282 /* Called from main context */
 283 static void source_output_set_state(pa_source_output *o, pa_source_output_state_t state) {
 284     pa_assert(o);
 285     pa_assert_ctl_context();
 286
 287     if (o->state == state)
 288         return;
 289
 290     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);
 291
 292     update_n_corked(o, state);
 293     o->state = state;
 294
 295     if (state != PA_SOURCE_OUTPUT_UNLINKED) {
 296         pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_STATE_CHANGED], o);
 297
 298         if (PA_SOURCE_OUTPUT_IS_LINKED(state))
 299             pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
 300     }
 301
 302     pa_source_update_status(o->source);
 303 }
 304
 305 /* Called from main context */
 306 void pa_source_output_unlink(pa_source_output*o) {
 307     pa_bool_t linked;
 308     pa_assert(o);
 309     pa_assert_ctl_context();
 310
 311     /* See pa_sink_unlink() for a couple of comments how this function
 312      * works */
 313
 314     pa_source_output_ref(o);
 315
 316     linked = PA_SOURCE_OUTPUT_IS_LINKED(o->state);
 317
 318     if (linked)
 319         pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK], o);
 320
 321     if (o->direct_on_input)
 322         pa_idxset_remove_by_data(o->direct_on_input->direct_outputs, o, NULL);
 323
 324     pa_idxset_remove_by_data(o->core->source_outputs, o, NULL);
 325
 326     if (o->source)
 327         if (pa_idxset_remove_by_data(o->source->outputs, o, NULL))
 328             pa_source_output_unref(o);
 329
 330     if (o->client)
 331         pa_idxset_remove_by_data(o->client->source_outputs, o, NULL);
 332
 333     update_n_corked(o, PA_SOURCE_OUTPUT_UNLINKED);
 334     o->state = PA_SOURCE_OUTPUT_UNLINKED;
 335
 336     if (linked && o->source)
 337         if (o->source->asyncmsgq)
 338             pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_REMOVE_OUTPUT, o, 0, NULL) == 0);
 339
 340     reset_callbacks(o);
 341
 342     if (linked) {
 343         pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_REMOVE, o->index);
 344         pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK_POST], o);
 345     }
 346
 347     if (o->source) {
 348         pa_source_update_status(o->source);
 349         o->source = NULL;
 350     }
 351
 352     pa_core_maybe_vacuum(o->core);
 353
 354     pa_source_output_unref(o);
 355 }
 356
 357 /* Called from main context */
 358 static void source_output_free(pa_object* mo) {
 359     pa_source_output *o = PA_SOURCE_OUTPUT(mo);
 360
 361     pa_assert(o);
 362     pa_assert_ctl_context();
 363     pa_assert(pa_source_output_refcnt(o) == 0);
 364
 365     if (PA_SOURCE_OUTPUT_IS_LINKED(o->state))
 366         pa_source_output_unlink(o);
 367
 368     pa_log_info("Freeing output %u \"%s\"", o->index, pa_strnull(pa_proplist_gets(o->proplist, PA_PROP_MEDIA_NAME)));
 369
 370     if (o->thread_info.delay_memblockq)
 371         pa_memblockq_free(o->thread_info.delay_memblockq);
 372
 373     if (o->thread_info.resampler)
 374         pa_resampler_free(o->thread_info.resampler);
 375
 376     if (o->proplist)
 377         pa_proplist_free(o->proplist);
 378
 379     pa_xfree(o->driver);
 380     pa_xfree(o);
 381 }
 382
 383 /* Called from main context */
 384 void pa_source_output_put(pa_source_output *o) {
 385     pa_source_output_state_t state;
 386
 387     pa_source_output_assert_ref(o);
 388     pa_assert_ctl_context();
 389
 390     pa_assert(o->state == PA_SOURCE_OUTPUT_INIT);
 391
 392     /* The following fields must be initialized properly */
 393     pa_assert(o->push);
 394     pa_assert(o->kill);
 395
 396     state = o->flags & PA_SOURCE_OUTPUT_START_CORKED ? PA_SOURCE_OUTPUT_CORKED : PA_SOURCE_OUTPUT_RUNNING;
 397
 398     update_n_corked(o, state);
 399     o->state = state;
 400
 401     pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_ADD_OUTPUT, o, 0, NULL) == 0);
 402
 403     pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_NEW, o->index);
 404     pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_PUT], o);
 405
 406     pa_source_update_status(o->source);
 407 }
 408
 409 /* Called from main context */
 410 void pa_source_output_kill(pa_source_output*o) {
 411     pa_source_output_assert_ref(o);
 412     pa_assert_ctl_context();
 413     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
 414
 415     o->kill(o);
 416 }
 417
 418 /* Called from main context */
 419 pa_usec_t pa_source_output_get_latency(pa_source_output *o, pa_usec_t *source_latency) {
 420     pa_usec_t r[2] = { 0, 0 };
 421
 422     pa_source_output_assert_ref(o);
 423     pa_assert_ctl_context();
 424     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
 425
 426     pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY, r, 0, NULL) == 0);
 427
 428     if (o->get_latency)
 429         r[0] += o->get_latency(o);
 430
 431     if (source_latency)
 432         *source_latency = r[1];
 433
 434     return r[0];
 435 }
 436
 437 /* Called from thread context */
 438 void pa_source_output_push(pa_source_output *o, const pa_memchunk *chunk) {
 439     size_t length;
 440     size_t limit, mbs = 0;
 441
 442     pa_source_output_assert_ref(o);
 443     pa_source_output_assert_io_context(o);
 444     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->thread_info.state));
 445     pa_assert(chunk);
 446     pa_assert(pa_frame_aligned(chunk->length, &o->source->sample_spec));
 447
 448     if (!o->push || o->thread_info.state == PA_SOURCE_OUTPUT_CORKED)
 449         return;
 450
 451     pa_assert(o->thread_info.state == PA_SOURCE_OUTPUT_RUNNING);
 452
 453     if (pa_memblockq_push(o->thread_info.delay_memblockq, chunk) < 0) {
 454         pa_log_debug("Delay queue overflow!");
 455         pa_memblockq_seek(o->thread_info.delay_memblockq, (int64_t) chunk->length, PA_SEEK_RELATIVE, TRUE);
 456     }
 457
 458     limit = o->process_rewind ? 0 : o->source->thread_info.max_rewind;
 459
 460     if (limit > 0 && o->source->monitor_of) {
 461         pa_usec_t latency;
 462         size_t n;
 463
 464         /* Hmm, check the latency for knowing how much of the buffered
 465          * data is actually still unplayed and might hence still
 466          * change. This is suboptimal. Ideally we'd have a call like
 467          * pa_sink_get_changeable_size() or so that tells us how much
 468          * of the queued data is actually still changeable. Hence
 469          * FIXME! */
 470
 471         latency = pa_sink_get_latency_within_thread(o->source->monitor_of);
 472
 473         n = pa_usec_to_bytes(latency, &o->source->sample_spec);
 474
 475         if (n < limit)
 476             limit = n;
 477     }
 478
 479     /* Implement the delay queue */
 480     while ((length = pa_memblockq_get_length(o->thread_info.delay_memblockq)) > limit) {
 481         pa_memchunk qchunk;
 482
 483         length -= limit;
 484
 485         pa_assert_se(pa_memblockq_peek(o->thread_info.delay_memblockq, &qchunk) >= 0);
 486
 487         if (qchunk.length > length)
 488             qchunk.length = length;
 489
 490         pa_assert(qchunk.length > 0);
 491
 492         if (!o->thread_info.resampler)
 493             o->push(o, &qchunk);
 494         else {
 495             pa_memchunk rchunk;
 496
 497             if (mbs == 0)
 498                 mbs = pa_resampler_max_block_size(o->thread_info.resampler);
 499
 500             if (qchunk.length > mbs)
 501                 qchunk.length = mbs;
 502
 503             pa_resampler_run(o->thread_info.resampler, &qchunk, &rchunk);
 504
 505             if (rchunk.length > 0)
 506                 o->push(o, &rchunk);
 507
 508             if (rchunk.memblock)
 509                 pa_memblock_unref(rchunk.memblock);
 510         }
 511
 512         pa_memblock_unref(qchunk.memblock);
 513         pa_memblockq_drop(o->thread_info.delay_memblockq, qchunk.length);
 514     }
 515 }
 516
 517 /* Called from thread context */
 518 void pa_source_output_process_rewind(pa_source_output *o, size_t nbytes /* in source sample spec */) {
 519
 520     pa_source_output_assert_ref(o);
 521     pa_source_output_assert_io_context(o);
 522     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->thread_info.state));
 523     pa_assert(pa_frame_aligned(nbytes, &o->source->sample_spec));
 524
 525     if (nbytes <= 0)
 526         return;
 527
 528     if (o->process_rewind) {
 529         pa_assert(pa_memblockq_get_length(o->thread_info.delay_memblockq) == 0);
 530
 531         if (o->thread_info.resampler)
 532             nbytes = pa_resampler_result(o->thread_info.resampler, nbytes);
 533
 534         pa_log_debug("Have to rewind %lu bytes on implementor.", (unsigned long) nbytes);
 535
 536         if (nbytes > 0)
 537             o->process_rewind(o, nbytes);
 538
 539         if (o->thread_info.resampler)
 540             pa_resampler_reset(o->thread_info.resampler);
 541
 542     } else
 543         pa_memblockq_rewind(o->thread_info.delay_memblockq, nbytes);
 544 }
 545
 546 /* Called from thread context */
 547 size_t pa_source_output_get_max_rewind(pa_source_output *o) {
 548     pa_source_output_assert_ref(o);
 549     pa_source_output_assert_io_context(o);
 550
 551     return o->thread_info.resampler ? pa_resampler_request(o->thread_info.resampler, o->source->thread_info.max_rewind) : o->source->thread_info.max_rewind;
 552 }
 553
 554 /* Called from thread context */
 555 void pa_source_output_update_max_rewind(pa_source_output *o, size_t nbytes  /* in the source's sample spec */) {
 556     pa_source_output_assert_ref(o);
 557     pa_source_output_assert_io_context(o);
 558     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->thread_info.state));
 559     pa_assert(pa_frame_aligned(nbytes, &o->source->sample_spec));
 560
 561     if (o->update_max_rewind)
 562         o->update_max_rewind(o, o->thread_info.resampler ? pa_resampler_result(o->thread_info.resampler, nbytes) : nbytes);
 563 }
 564
 565 /* Called from thread context */
 566 pa_usec_t pa_source_output_set_requested_latency_within_thread(pa_source_output *o, pa_usec_t usec) {
 567     pa_source_output_assert_ref(o);
 568     pa_source_output_assert_io_context(o);
 569
 570     if (!(o->source->flags & PA_SOURCE_DYNAMIC_LATENCY))
 571         usec = o->source->thread_info.fixed_latency;
 572
 573     if (usec != (pa_usec_t) -1)
 574         usec = PA_CLAMP(usec, o->source->thread_info.min_latency, o->source->thread_info.max_latency);
 575
 576     o->thread_info.requested_source_latency = usec;
 577     pa_source_invalidate_requested_latency(o->source, TRUE);
 578
 579     return usec;
 580 }
 581
 582 /* Called from main context */
 583 pa_usec_t pa_source_output_set_requested_latency(pa_source_output *o, pa_usec_t usec) {
 584     pa_source_output_assert_ref(o);
 585     pa_assert_ctl_context();
 586
 587     if (PA_SOURCE_OUTPUT_IS_LINKED(o->state) && o->source) {
 588         pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_SET_REQUESTED_LATENCY, &usec, 0, NULL) == 0);
 589         return usec;
 590     }
 591
 592     /* If this source output is not realized yet or is being moved, we
 593      * have to touch the thread info data directly */
 594
 595     if (o->source) {
 596         if (!(o->source->flags & PA_SOURCE_DYNAMIC_LATENCY))
 597             usec = pa_source_get_fixed_latency(o->source);
 598
 599         if (usec != (pa_usec_t) -1) {
 600             pa_usec_t min_latency, max_latency;
 601             pa_source_get_latency_range(o->source, &min_latency, &max_latency);
 602             usec = PA_CLAMP(usec, min_latency, max_latency);
 603         }
 604     }
 605
 606     o->thread_info.requested_source_latency = usec;
 607
 608     return usec;
 609 }
 610
 611 /* Called from main context */
 612 pa_usec_t pa_source_output_get_requested_latency(pa_source_output *o) {
 613     pa_source_output_assert_ref(o);
 614     pa_assert_ctl_context();
 615
 616     if (PA_SOURCE_OUTPUT_IS_LINKED(o->state) && o->source) {
 617         pa_usec_t usec = 0;
 618         pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_GET_REQUESTED_LATENCY, &usec, 0, NULL) == 0);
 619         return usec;
 620     }
 621
 622     /* If this source output is not realized yet or is being moved, we
 623      * have to touch the thread info data directly */
 624
 625     return o->thread_info.requested_source_latency;
 626 }
 627
 628 /* Called from main context */
 629 void pa_source_output_cork(pa_source_output *o, pa_bool_t b) {
 630     pa_source_output_assert_ref(o);
 631     pa_assert_ctl_context();
 632     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
 633
 634     source_output_set_state(o, b ? PA_SOURCE_OUTPUT_CORKED : PA_SOURCE_OUTPUT_RUNNING);
 635 }
 636
 637 /* Called from main context */
 638 int pa_source_output_set_rate(pa_source_output *o, uint32_t rate) {
 639     pa_source_output_assert_ref(o);
 640     pa_assert_ctl_context();
 641     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
 642     pa_return_val_if_fail(o->thread_info.resampler, -PA_ERR_BADSTATE);
 643
 644     if (o->sample_spec.rate == rate)
 645         return 0;
 646
 647     o->sample_spec.rate = rate;
 648
 649     pa_asyncmsgq_post(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_SET_RATE, PA_UINT_TO_PTR(rate), 0, NULL, NULL);
 650
 651     pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
 652     return 0;
 653 }
 654
 655 /* Called from main context */
 656 void pa_source_output_set_name(pa_source_output *o, const char *name) {
 657     const char *old;
 658     pa_assert_ctl_context();
 659     pa_source_output_assert_ref(o);
 660
 661     if (!name && !pa_proplist_contains(o->proplist, PA_PROP_MEDIA_NAME))
 662         return;
 663
 664     old = pa_proplist_gets(o->proplist, PA_PROP_MEDIA_NAME);
 665
 666     if (old && name && !strcmp(old, name))
 667         return;
 668
 669     if (name)
 670         pa_proplist_sets(o->proplist, PA_PROP_MEDIA_NAME, name);
 671     else
 672         pa_proplist_unset(o->proplist, PA_PROP_MEDIA_NAME);
 673
 674     if (PA_SOURCE_OUTPUT_IS_LINKED(o->state)) {
 675         pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_PROPLIST_CHANGED], o);
 676         pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
 677     }
 678 }
 679
 680 /* Called from main thread */
 681 void pa_source_output_update_proplist(pa_source_output *o, pa_update_mode_t mode, pa_proplist *p) {
 682     pa_source_output_assert_ref(o);
 683     pa_assert_ctl_context();
 684
 685     if (p)
 686         pa_proplist_update(o->proplist, mode, p);
 687
 688     if (PA_SOURCE_OUTPUT_IS_LINKED(o->state)) {
 689         pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_PROPLIST_CHANGED], o);
 690         pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
 691     }
 692 }
 693
 694 /* Called from main context */
 695 pa_resample_method_t pa_source_output_get_resample_method(pa_source_output *o) {
 696     pa_source_output_assert_ref(o);
 697     pa_assert_ctl_context();
 698
 699     return o->actual_resample_method;
 700 }
 701
 702 /* Called from main context */
 703 pa_bool_t pa_source_output_may_move(pa_source_output *o) {
 704     pa_source_output_assert_ref(o);
 705     pa_assert_ctl_context();
 706     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
 707
 708     if (o->flags & PA_SOURCE_OUTPUT_DONT_MOVE)
 709         return FALSE;
 710
 711     if (o->direct_on_input)
 712         return FALSE;
 713
 714     return TRUE;
 715 }
 716
 717 /* Called from main context */
 718 pa_bool_t pa_source_output_may_move_to(pa_source_output *o, pa_source *dest) {
 719     pa_source_output_assert_ref(o);
 720     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
 721     pa_source_assert_ref(dest);
 722
 723     if (dest == o->source)
 724         return TRUE;
 725
 726     if (!pa_source_output_may_move(o))
 727         return FALSE;
 728
 729     if (pa_idxset_size(dest->outputs) >= PA_MAX_OUTPUTS_PER_SOURCE) {
 730         pa_log_warn("Failed to move source output: too many outputs per source.");
 731         return FALSE;
 732     }
 733
 734     if (o->may_move_to)
 735         if (!o->may_move_to(o, dest))
 736             return FALSE;
 737
 738     return TRUE;
 739 }
 740
 741 /* Called from main context */
 742 int pa_source_output_start_move(pa_source_output *o) {
 743     pa_source *origin;
 744     int r;
 745
 746     pa_source_output_assert_ref(o);
 747     pa_assert_ctl_context();
 748     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
 749     pa_assert(o->source);
 750
 751     if (!pa_source_output_may_move(o))
 752         return -PA_ERR_NOTSUPPORTED;
 753
 754     if ((r = pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_START], o)) < 0)
 755         return r;
 756
 757     origin = o->source;
 758
 759     pa_idxset_remove_by_data(o->source->outputs, o, NULL);
 760
 761     if (pa_source_output_get_state(o) == PA_SOURCE_OUTPUT_CORKED)
 762         pa_assert_se(origin->n_corked-- >= 1);
 763
 764     pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_REMOVE_OUTPUT, o, 0, NULL) == 0);
 765
 766     pa_source_update_status(o->source);
 767     o->source = NULL;
 768
 769     pa_source_output_unref(o);
 770
 771     return 0;
 772 }
 773
 774 /* Called from main context */
 775 int pa_source_output_finish_move(pa_source_output *o, pa_source *dest, pa_bool_t save) {
 776     pa_resampler *new_resampler;
 777
 778     pa_source_output_assert_ref(o);
 779     pa_assert_ctl_context();
 780     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
 781     pa_assert(!o->source);
 782     pa_source_assert_ref(dest);
 783
 784     if (!pa_source_output_may_move_to(o, dest))
 785         return -1;
 786
 787     if (o->thread_info.resampler &&
 788         pa_sample_spec_equal(pa_resampler_input_sample_spec(o->thread_info.resampler), &dest->sample_spec) &&
 789         pa_channel_map_equal(pa_resampler_input_channel_map(o->thread_info.resampler), &dest->channel_map))
 790
 791         /* Try to reuse the old resampler if possible */
 792         new_resampler = o->thread_info.resampler;
 793
 794     else if ((o->flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) ||
 795              !pa_sample_spec_equal(&o->sample_spec, &dest->sample_spec) ||
 796              !pa_channel_map_equal(&o->channel_map, &dest->channel_map)) {
 797
 798         /* Okey, we need a new resampler for the new source */
 799
 800         if (!(new_resampler = pa_resampler_new(
 801                       o->core->mempool,
 802                       &dest->sample_spec, &dest->channel_map,
 803                       &o->sample_spec, &o->channel_map,
 804                       o->requested_resample_method,
 805                       ((o->flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) ? PA_RESAMPLER_VARIABLE_RATE : 0) |
 806                       ((o->flags & PA_SOURCE_OUTPUT_NO_REMAP) ? PA_RESAMPLER_NO_REMAP : 0) |
 807                       (o->core->disable_remixing || (o->flags & PA_SOURCE_OUTPUT_NO_REMIX) ? PA_RESAMPLER_NO_REMIX : 0)))) {
 808             pa_log_warn("Unsupported resampling operation.");
 809             return -PA_ERR_NOTSUPPORTED;
 810         }
 811     } else
 812         new_resampler = NULL;
 813
 814     if (o->moving)
 815         o->moving(o, dest);
 816
 817     o->source = dest;
 818     o->save_source = save;
 819     pa_idxset_put(o->source->outputs, pa_source_output_ref(o), NULL);
 820
 821     if (pa_source_output_get_state(o) == PA_SOURCE_OUTPUT_CORKED)
 822         o->source->n_corked++;
 823
 824     /* Replace resampler */
 825     if (new_resampler != o->thread_info.resampler) {
 826         if (o->thread_info.resampler)
 827             pa_resampler_free(o->thread_info.resampler);
 828         o->thread_info.resampler = new_resampler;
 829
 830         pa_memblockq_free(o->thread_info.delay_memblockq);
 831
 832         o->thread_info.delay_memblockq = pa_memblockq_new(
 833                 0,
 834                 MEMBLOCKQ_MAXLENGTH,
 835                 0,
 836                 pa_frame_size(&o->source->sample_spec),
 837                 0,
 838                 1,
 839                 0,
 840                 &o->source->silence);
 841     }
 842
 843     pa_source_update_status(dest);
 844
 845     pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_ADD_OUTPUT, o, 0, NULL) == 0);
 846
 847     pa_log_debug("Successfully moved source output %i to %s.", o->index, dest->name);
 848
 849     /* Notify everyone */
 850     pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_FINISH], o);
 851     pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
 852
 853     return 0;
 854 }
 855
 856 /* Called from main context */
 857 void pa_source_output_fail_move(pa_source_output *o) {
 858
 859     pa_source_output_assert_ref(o);
 860     pa_assert_ctl_context();
 861     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
 862     pa_assert(!o->source);
 863
 864     /* Check if someone wants this source output? */
 865     if (pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_FAIL], o) == PA_HOOK_STOP)
 866         return;
 867
 868     if (o->moving)
 869         o->moving(o, NULL);
 870
 871     pa_source_output_kill(o);
 872 }
 873
 874 /* Called from main context */
 875 int pa_source_output_move_to(pa_source_output *o, pa_source *dest, pa_bool_t save) {
 876     int r;
 877
 878     pa_source_output_assert_ref(o);
 879     pa_assert_ctl_context();
 880     pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
 881     pa_assert(o->source);
 882     pa_source_assert_ref(dest);
 883
 884     if (dest == o->source)
 885         return 0;
 886
 887     if (!pa_source_output_may_move_to(o, dest))
 888         return -PA_ERR_NOTSUPPORTED;
 889
 890     pa_source_output_ref(o);
 891
 892     if ((r = pa_source_output_start_move(o)) < 0) {
 893         pa_source_output_unref(o);
 894         return r;
 895     }
 896
 897     if ((r = pa_source_output_finish_move(o, dest, save)) < 0) {
 898         pa_source_output_fail_move(o);
 899         pa_source_output_unref(o);
 900         return r;
 901     }
 902
 903     pa_source_output_unref(o);
 904
 905     return 0;
 906 }
 907
 908 /* Called from IO thread context */
 909 void pa_source_output_set_state_within_thread(pa_source_output *o, pa_source_output_state_t state) {
 910     pa_source_output_assert_ref(o);
 911     pa_source_output_assert_io_context(o);
 912
 913     if (state == o->thread_info.state)
 914         return;
 915
 916     if (o->state_change)
 917         o->state_change(o, state);
 918
 919     o->thread_info.state = state;
 920 }
 921
 922 /* Called from IO thread context, except when it is not */
 923 int pa_source_output_process_msg(pa_msgobject *mo, int code, void *userdata, int64_t offset, pa_memchunk* chunk) {
 924     pa_source_output *o = PA_SOURCE_OUTPUT(mo);
 925     pa_source_output_assert_ref(o);
 926
 927     switch (code) {
 928
 929         case PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY: {
 930             pa_usec_t *r = userdata;
 931
 932             r[0] += pa_bytes_to_usec(pa_memblockq_get_length(o->thread_info.delay_memblockq), &o->source->sample_spec);
 933             r[1] += pa_source_get_latency_within_thread(o->source);
 934
 935             return 0;
 936         }
 937
 938         case PA_SOURCE_OUTPUT_MESSAGE_SET_RATE:
 939
 940             o->thread_info.sample_spec.rate = PA_PTR_TO_UINT(userdata);
 941             pa_resampler_set_output_rate(o->thread_info.resampler, PA_PTR_TO_UINT(userdata));
 942             return 0;
 943
 944         case PA_SOURCE_OUTPUT_MESSAGE_SET_STATE:
 945
 946             pa_source_output_set_state_within_thread(o, PA_PTR_TO_UINT(userdata));
 947             return 0;
 948
 949         case PA_SOURCE_OUTPUT_MESSAGE_SET_REQUESTED_LATENCY: {
 950             pa_usec_t *usec = userdata;
 951
 952             *usec = pa_source_output_set_requested_latency_within_thread(o, *usec);
 953
 954             return 0;
 955         }
 956
 957         case PA_SOURCE_OUTPUT_MESSAGE_GET_REQUESTED_LATENCY: {
 958             pa_usec_t *r = userdata;
 959
 960             *r = o->thread_info.requested_source_latency;
 961             return 0;
 962         }
 963     }
 964
 965     return -PA_ERR_NOTIMPLEMENTED;
 966 }
 967
 968 /* Called from main context */
 969 void pa_source_output_send_event(pa_source_output *o, const char *event, pa_proplist *data) {
 970     pa_proplist *pl = NULL;
 971     pa_source_output_send_event_hook_data hook_data;
 972
 973     pa_source_output_assert_ref(o);
 974     pa_assert_ctl_context();
 975     pa_assert(event);
 976
 977     if (!o->send_event)
 978         return;
 979
 980     if (!data)
 981         data = pl = pa_proplist_new();
 982
 983     hook_data.source_output = o;
 984     hook_data.data = data;
 985     hook_data.event = event;
 986
 987     if (pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_SEND_EVENT], &hook_data) < 0)
 988         goto finish;
 989
 990     o->send_event(o, event, data);
 991
 992 finish:
 993     if (pl)
 994         pa_proplist_free(pl);
 995 }