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