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