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