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