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