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