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