src/pulsecore/source.c

   1 /***
   2   This file is part of PulseAudio.
   3
   4   Copyright 2004-2006 Lennart Poettering
   5   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
   6
   7   PulseAudio is free software; you can redistribute it and/or modify
   8   it under the terms of the GNU Lesser General Public License as published
   9   by the Free Software Foundation; either version 2 of the License,
  10   or (at your option) any later version.
  11
  12   PulseAudio is distributed in the hope that it will be useful, but
  13   WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15   General Public License for more details.
  16
  17   You should have received a copy of the GNU Lesser General Public License
  18   along with PulseAudio; if not, write to the Free Software
  19   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  20   USA.
  21 ***/
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include <config.h>
  25 #endif
  26
  27 #include <stdio.h>
  28 #include <stdlib.h>
  29 #include <string.h>
  30
  31 #include <pulse/utf8.h>
  32 #include <pulse/xmalloc.h>
  33 #include <pulse/timeval.h>
  34
  35 #include <pulsecore/source-output.h>
  36 #include <pulsecore/namereg.h>
  37 #include <pulsecore/core-subscribe.h>
  38 #include <pulsecore/log.h>
  39 #include <pulsecore/sample-util.h>
  40
  41 #include "source.h"
  42
  43 #define DEFAULT_MIN_LATENCY (4*PA_USEC_PER_MSEC)
  44
  45 static PA_DEFINE_CHECK_TYPE(pa_source, pa_msgobject);
  46
  47 static void source_free(pa_object *o);
  48
  49 pa_source_new_data* pa_source_new_data_init(pa_source_new_data *data) {
  50     pa_assert(data);
  51
  52     memset(data, 0, sizeof(*data));
  53     data->proplist = pa_proplist_new();
  54
  55     return data;
  56 }
  57
  58 void pa_source_new_data_set_name(pa_source_new_data *data, const char *name) {
  59     pa_assert(data);
  60
  61     pa_xfree(data->name);
  62     data->name = pa_xstrdup(name);
  63 }
  64
  65 void pa_source_new_data_set_sample_spec(pa_source_new_data *data, const pa_sample_spec *spec) {
  66     pa_assert(data);
  67
  68     if ((data->sample_spec_is_set = !!spec))
  69         data->sample_spec = *spec;
  70 }
  71
  72 void pa_source_new_data_set_channel_map(pa_source_new_data *data, const pa_channel_map *map) {
  73     pa_assert(data);
  74
  75     if ((data->channel_map_is_set = !!map))
  76         data->channel_map = *map;
  77 }
  78
  79 void pa_source_new_data_set_volume(pa_source_new_data *data, const pa_cvolume *volume) {
  80     pa_assert(data);
  81
  82     if ((data->volume_is_set = !!volume))
  83         data->volume = *volume;
  84 }
  85
  86 void pa_source_new_data_set_muted(pa_source_new_data *data, pa_bool_t mute) {
  87     pa_assert(data);
  88
  89     data->muted_is_set = TRUE;
  90     data->muted = !!mute;
  91 }
  92
  93 void pa_source_new_data_done(pa_source_new_data *data) {
  94     pa_assert(data);
  95
  96     pa_xfree(data->name);
  97     pa_proplist_free(data->proplist);
  98 }
  99
 100 /* Called from main context */
 101 static void reset_callbacks(pa_source *s) {
 102     pa_assert(s);
 103
 104     s->set_state = NULL;
 105     s->get_volume = NULL;
 106     s->set_volume = NULL;
 107     s->get_mute = NULL;
 108     s->set_mute = NULL;
 109     s->update_requested_latency = NULL;
 110 }
 111
 112 /* Called from main context */
 113 pa_source* pa_source_new(
 114         pa_core *core,
 115         pa_source_new_data *data,
 116         pa_source_flags_t flags) {
 117
 118     pa_source *s;
 119     const char *name;
 120     char st[PA_SAMPLE_SPEC_SNPRINT_MAX], cm[PA_CHANNEL_MAP_SNPRINT_MAX];
 121
 122     pa_assert(core);
 123     pa_assert(data);
 124     pa_assert(data->name);
 125
 126     s = pa_msgobject_new(pa_source);
 127
 128     if (!(name = pa_namereg_register(core, data->name, PA_NAMEREG_SOURCE, s, data->namereg_fail))) {
 129         pa_xfree(s);
 130         return NULL;
 131     }
 132
 133     pa_source_new_data_set_name(data, name);
 134
 135     if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SOURCE_NEW], data) < 0) {
 136         pa_xfree(s);
 137         pa_namereg_unregister(core, name);
 138         return NULL;
 139     }
 140
 141     pa_return_null_if_fail(!data->driver || pa_utf8_valid(data->driver));
 142     pa_return_null_if_fail(data->name && pa_utf8_valid(data->name) && data->name[0]);
 143
 144     pa_return_null_if_fail(data->sample_spec_is_set && pa_sample_spec_valid(&data->sample_spec));
 145
 146     if (!data->channel_map_is_set)
 147         pa_return_null_if_fail(pa_channel_map_init_auto(&data->channel_map, data->sample_spec.channels, PA_CHANNEL_MAP_DEFAULT));
 148
 149     pa_return_null_if_fail(pa_channel_map_valid(&data->channel_map));
 150     pa_return_null_if_fail(data->channel_map.channels == data->sample_spec.channels);
 151
 152     if (!data->volume_is_set)
 153         pa_cvolume_reset(&data->volume, data->sample_spec.channels);
 154
 155     pa_return_null_if_fail(pa_cvolume_valid(&data->volume));
 156     pa_return_null_if_fail(data->volume.channels == data->sample_spec.channels);
 157
 158     if (!data->muted_is_set)
 159         data->muted = FALSE;
 160
 161     if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SOURCE_FIXATE], data) < 0) {
 162         pa_xfree(s);
 163         pa_namereg_unregister(core, name);
 164         return NULL;
 165     }
 166
 167     s->parent.parent.free = source_free;
 168     s->parent.process_msg = pa_source_process_msg;
 169
 170     s->core = core;
 171     s->state = PA_SOURCE_INIT;
 172     s->flags = flags;
 173     s->name = pa_xstrdup(name);
 174     s->proplist = pa_proplist_copy(data->proplist);
 175     s->driver = pa_xstrdup(data->driver);
 176     s->module = data->module;
 177
 178     s->sample_spec = data->sample_spec;
 179     s->channel_map = data->channel_map;
 180
 181     s->outputs = pa_idxset_new(NULL, NULL);
 182     s->n_corked = 0;
 183     s->monitor_of = NULL;
 184
 185     s->volume = data->volume;
 186     s->muted = data->muted;
 187     s->refresh_volume = s->refresh_muted = FALSE;
 188     s->base_volume = PA_VOLUME_NORM;
 189
 190     reset_callbacks(s);
 191     s->userdata = NULL;
 192
 193     s->asyncmsgq = NULL;
 194     s->rtpoll = NULL;
 195
 196     pa_silence_memchunk_get(
 197             &core->silence_cache,
 198             core->mempool,
 199             &s->silence,
 200             &s->sample_spec,
 201             0);
 202
 203     s->thread_info.outputs = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
 204     pa_cvolume_reset(&s->thread_info.soft_volume, s->sample_spec.channels);
 205     s->thread_info.soft_muted = FALSE;
 206     s->thread_info.state = s->state;
 207     s->thread_info.max_rewind = 0;
 208     s->thread_info.requested_latency_valid = FALSE;
 209     s->thread_info.requested_latency = 0;
 210     s->thread_info.min_latency = DEFAULT_MIN_LATENCY;
 211     s->thread_info.max_latency = 0;
 212
 213     pa_assert_se(pa_idxset_put(core->sources, s, &s->index) >= 0);
 214
 215     pa_log_info("Created source %u \"%s\" with sample spec %s and channel map %s",
 216                 s->index,
 217                 s->name,
 218                 pa_sample_spec_snprint(st, sizeof(st), &s->sample_spec),
 219                 pa_channel_map_snprint(cm, sizeof(cm), &s->channel_map));
 220
 221     return s;
 222 }
 223
 224 /* Called from main context */
 225 static int source_set_state(pa_source *s, pa_source_state_t state) {
 226     int ret;
 227     pa_bool_t suspend_change;
 228     pa_source_state_t original_state;
 229
 230     pa_assert(s);
 231
 232     if (s->state == state)
 233         return 0;
 234
 235     original_state = s->state;
 236
 237     suspend_change =
 238         (original_state == PA_SOURCE_SUSPENDED && PA_SOURCE_IS_OPENED(state)) ||
 239         (PA_SOURCE_IS_OPENED(original_state) && state == PA_SOURCE_SUSPENDED);
 240
 241     if (s->set_state)
 242         if ((ret = s->set_state(s, state)) < 0)
 243             return ret;
 244
 245     if (s->asyncmsgq)
 246         if ((ret = pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL)) < 0) {
 247
 248             if (s->set_state)
 249                 s->set_state(s, original_state);
 250
 251             return ret;
 252         }
 253
 254     s->state = state;
 255
 256     if (suspend_change) {
 257         pa_source_output *o;
 258         uint32_t idx;
 259
 260         /* We're suspending or resuming, tell everyone about it */
 261
 262         for (o = PA_SOURCE_OUTPUT(pa_idxset_first(s->outputs, &idx)); o; o = PA_SOURCE_OUTPUT(pa_idxset_next(s->outputs, &idx)))
 263             if (o->suspend)
 264                 o->suspend(o, state == PA_SOURCE_SUSPENDED);
 265     }
 266
 267     if (state != PA_SOURCE_UNLINKED) /* if we enter UNLINKED state pa_source_unlink() will fire the apropriate events */
 268         pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_STATE_CHANGED], s);
 269
 270     return 0;
 271 }
 272
 273 /* Called from main context */
 274 void pa_source_put(pa_source *s) {
 275     pa_source_assert_ref(s);
 276
 277     pa_assert(s->state == PA_SOURCE_INIT);
 278
 279     /* The following fields must be initialized properly when calling _put() */
 280     pa_assert(s->asyncmsgq);
 281     pa_assert(s->rtpoll);
 282     pa_assert(!s->thread_info.min_latency || !s->thread_info.max_latency ||
 283               s->thread_info.min_latency <= s->thread_info.max_latency);
 284
 285     if (!(s->flags & PA_SOURCE_HW_VOLUME_CTRL)) {
 286         s->flags |= PA_SOURCE_DECIBEL_VOLUME;
 287
 288         s->thread_info.soft_volume = s->volume;
 289         s->thread_info.soft_muted = s->muted;
 290     }
 291
 292     pa_assert_se(source_set_state(s, PA_SOURCE_IDLE) == 0);
 293
 294     pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE | PA_SUBSCRIPTION_EVENT_NEW, s->index);
 295     pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_PUT], s);
 296 }
 297
 298 /* Called from main context */
 299 void pa_source_unlink(pa_source *s) {
 300     pa_bool_t linked;
 301     pa_source_output *o, *j = NULL;
 302
 303     pa_assert(s);
 304
 305     /* See pa_sink_unlink() for a couple of comments how this function
 306      * works. */
 307
 308     linked = PA_SOURCE_IS_LINKED(s->state);
 309
 310     if (linked)
 311         pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_UNLINK], s);
 312
 313     if (s->state != PA_SOURCE_UNLINKED)
 314         pa_namereg_unregister(s->core, s->name);
 315     pa_idxset_remove_by_data(s->core->sources, s, NULL);
 316
 317     while ((o = pa_idxset_first(s->outputs, NULL))) {
 318         pa_assert(o != j);
 319         pa_source_output_kill(o);
 320         j = o;
 321     }
 322
 323     if (linked)
 324         source_set_state(s, PA_SOURCE_UNLINKED);
 325     else
 326         s->state = PA_SOURCE_UNLINKED;
 327
 328     reset_callbacks(s);
 329
 330     if (linked) {
 331         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE | PA_SUBSCRIPTION_EVENT_REMOVE, s->index);
 332         pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_UNLINK_POST], s);
 333     }
 334 }
 335
 336 /* Called from main context */
 337 static void source_free(pa_object *o) {
 338     pa_source_output *so;
 339     pa_source *s = PA_SOURCE(o);
 340
 341     pa_assert(s);
 342     pa_assert(pa_source_refcnt(s) == 0);
 343
 344     if (PA_SOURCE_IS_LINKED(s->state))
 345         pa_source_unlink(s);
 346
 347     pa_log_info("Freeing source %u \"%s\"", s->index, s->name);
 348
 349     pa_idxset_free(s->outputs, NULL, NULL);
 350
 351     while ((so = pa_hashmap_steal_first(s->thread_info.outputs)))
 352         pa_source_output_unref(so);
 353
 354     pa_hashmap_free(s->thread_info.outputs, NULL, NULL);
 355
 356     if (s->silence.memblock)
 357         pa_memblock_unref(s->silence.memblock);
 358
 359     pa_xfree(s->name);
 360     pa_xfree(s->driver);
 361
 362     if (s->proplist)
 363         pa_proplist_free(s->proplist);
 364
 365     pa_xfree(s);
 366 }
 367
 368 /* Called from main context */
 369 void pa_source_set_asyncmsgq(pa_source *s, pa_asyncmsgq *q) {
 370     pa_source_assert_ref(s);
 371
 372     s->asyncmsgq = q;
 373 }
 374
 375 /* Called from main context */
 376 void pa_source_set_rtpoll(pa_source *s, pa_rtpoll *p) {
 377     pa_source_assert_ref(s);
 378
 379     s->rtpoll = p;
 380 }
 381
 382 /* Called from main context */
 383 int pa_source_update_status(pa_source*s) {
 384     pa_source_assert_ref(s);
 385     pa_assert(PA_SOURCE_IS_LINKED(s->state));
 386
 387     if (s->state == PA_SOURCE_SUSPENDED)
 388         return 0;
 389
 390     return source_set_state(s, pa_source_used_by(s) ? PA_SOURCE_RUNNING : PA_SOURCE_IDLE);
 391 }
 392
 393 /* Called from main context */
 394 int pa_source_suspend(pa_source *s, pa_bool_t suspend) {
 395     pa_source_assert_ref(s);
 396     pa_assert(PA_SOURCE_IS_LINKED(s->state));
 397
 398     if (suspend)
 399         return source_set_state(s, PA_SOURCE_SUSPENDED);
 400     else
 401         return source_set_state(s, pa_source_used_by(s) ? PA_SOURCE_RUNNING : PA_SOURCE_IDLE);
 402 }
 403
 404 /* Called from IO thread context */
 405 void pa_source_process_rewind(pa_source *s, size_t nbytes) {
 406     pa_source_output *o;
 407     void *state = NULL;
 408
 409     pa_source_assert_ref(s);
 410     pa_assert(PA_SOURCE_IS_OPENED(s->thread_info.state));
 411
 412     if (nbytes <= 0)
 413         return;
 414
 415     pa_log_debug("Processing rewind...");
 416
 417     while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL))) {
 418         pa_source_output_assert_ref(o);
 419         pa_source_output_process_rewind(o, nbytes);
 420     }
 421 }
 422
 423 /* Called from IO thread context */
 424 void pa_source_post(pa_source*s, const pa_memchunk *chunk) {
 425     pa_source_output *o;
 426     void *state = NULL;
 427
 428     pa_source_assert_ref(s);
 429     pa_assert(PA_SOURCE_IS_OPENED(s->thread_info.state));
 430     pa_assert(chunk);
 431
 432     if (s->thread_info.soft_muted || !pa_cvolume_is_norm(&s->thread_info.soft_volume)) {
 433         pa_memchunk vchunk = *chunk;
 434
 435         pa_memblock_ref(vchunk.memblock);
 436         pa_memchunk_make_writable(&vchunk, 0);
 437
 438         if (s->thread_info.soft_muted || pa_cvolume_is_muted(&s->thread_info.soft_volume))
 439             pa_silence_memchunk(&vchunk, &s->sample_spec);
 440         else
 441             pa_volume_memchunk(&vchunk, &s->sample_spec, &s->thread_info.soft_volume);
 442
 443         while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL))) {
 444             pa_source_output_assert_ref(o);
 445
 446             if (!o->thread_info.direct_on_input)
 447                 pa_source_output_push(o, &vchunk);
 448         }
 449
 450         pa_memblock_unref(vchunk.memblock);
 451     } else {
 452
 453         while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL))) {
 454             pa_source_output_assert_ref(o);
 455
 456             if (!o->thread_info.direct_on_input)
 457                 pa_source_output_push(o, chunk);
 458         }
 459     }
 460 }
 461
 462 /* Called from IO thread context */
 463 void pa_source_post_direct(pa_source*s, pa_source_output *o, const pa_memchunk *chunk) {
 464     pa_source_assert_ref(s);
 465     pa_assert(PA_SOURCE_IS_OPENED(s->thread_info.state));
 466     pa_source_output_assert_ref(o);
 467     pa_assert(o->thread_info.direct_on_input);
 468     pa_assert(chunk);
 469
 470     if (s->thread_info.soft_muted || !pa_cvolume_is_norm(&s->thread_info.soft_volume)) {
 471         pa_memchunk vchunk = *chunk;
 472
 473         pa_memblock_ref(vchunk.memblock);
 474         pa_memchunk_make_writable(&vchunk, 0);
 475
 476         if (s->thread_info.soft_muted || pa_cvolume_is_muted(&s->thread_info.soft_volume))
 477             pa_silence_memchunk(&vchunk, &s->sample_spec);
 478         else
 479             pa_volume_memchunk(&vchunk, &s->sample_spec, &s->thread_info.soft_volume);
 480
 481         pa_source_output_push(o, &vchunk);
 482
 483         pa_memblock_unref(vchunk.memblock);
 484     } else
 485         pa_source_output_push(o, chunk);
 486 }
 487
 488 /* Called from main thread */
 489 pa_usec_t pa_source_get_latency(pa_source *s) {
 490     pa_usec_t usec;
 491
 492     pa_source_assert_ref(s);
 493     pa_assert(PA_SOURCE_IS_LINKED(s->state));
 494
 495     if (!PA_SOURCE_IS_OPENED(s->state))
 496         return 0;
 497
 498     if (!(s->flags & PA_SOURCE_LATENCY))
 499         return 0;
 500
 501     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_LATENCY, &usec, 0, NULL) == 0);
 502
 503     return usec;
 504 }
 505
 506 /* Called from main thread */
 507 void pa_source_set_volume(pa_source *s, const pa_cvolume *volume) {
 508     pa_bool_t changed;
 509
 510     pa_source_assert_ref(s);
 511     pa_assert(PA_SOURCE_IS_LINKED(s->state));
 512     pa_assert(volume);
 513
 514     changed = !pa_cvolume_equal(volume, &s->volume);
 515     s->volume = *volume;
 516
 517     if (s->set_volume && s->set_volume(s) < 0)
 518         s->set_volume = NULL;
 519
 520     if (!s->set_volume)
 521         pa_source_set_soft_volume(s, volume);
 522
 523     if (changed)
 524         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 525 }
 526
 527 /* Called from main thread */
 528 void pa_source_set_soft_volume(pa_source *s, const pa_cvolume *volume) {
 529     pa_source_assert_ref(s);
 530     pa_assert(volume);
 531
 532     if (PA_SOURCE_IS_LINKED(s->state))
 533         pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_VOLUME, volume, 0, NULL);
 534     else
 535         s->thread_info.soft_volume = *volume;
 536 }
 537
 538 /* Called from main thread */
 539 const pa_cvolume *pa_source_get_volume(pa_source *s, pa_bool_t force_refresh) {
 540     pa_source_assert_ref(s);
 541     pa_assert(PA_SOURCE_IS_LINKED(s->state));
 542
 543     if (s->refresh_volume || force_refresh) {
 544         pa_cvolume old_volume = s->volume;
 545
 546         if (s->get_volume && s->get_volume(s) < 0)
 547             s->get_volume = NULL;
 548
 549         if (!s->get_volume)
 550             pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_VOLUME, &s->volume, 0, NULL);
 551
 552         if (!pa_cvolume_equal(&old_volume, &s->volume))
 553             pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 554     }
 555
 556     return &s->volume;
 557 }
 558
 559 /* Called from main thread */
 560 void pa_source_set_mute(pa_source *s, pa_bool_t mute) {
 561     pa_bool_t changed;
 562
 563     pa_source_assert_ref(s);
 564     pa_assert(PA_SOURCE_IS_LINKED(s->state));
 565
 566     changed = s->muted != mute;
 567     s->muted = mute;
 568
 569     if (s->set_mute && s->set_mute(s) < 0)
 570         s->set_mute = NULL;
 571
 572     if (!s->set_mute)
 573         pa_asyncmsgq_post(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_MUTE, PA_UINT_TO_PTR(mute), 0, NULL, NULL);
 574
 575     if (changed)
 576         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 577 }
 578
 579 /* Called from main thread */
 580 pa_bool_t pa_source_get_mute(pa_source *s, pa_bool_t force_refresh) {
 581
 582     pa_source_assert_ref(s);
 583     pa_assert(PA_SOURCE_IS_LINKED(s->state));
 584
 585     if (s->refresh_muted || force_refresh) {
 586         pa_bool_t old_muted = s->muted;
 587
 588         if (s->get_mute && s->get_mute(s) < 0)
 589             s->get_mute = NULL;
 590
 591         if (!s->get_mute)
 592             pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_MUTE, &s->muted, 0, NULL);
 593
 594         if (old_muted != s->muted)
 595             pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 596     }
 597
 598     return s->muted;
 599 }
 600
 601 pa_bool_t pa_source_update_proplist(pa_source *s, pa_update_mode_t mode, pa_proplist *p) {
 602
 603     pa_source_assert_ref(s);
 604
 605     pa_proplist_update(s->proplist, mode, p);
 606
 607     if (PA_SOURCE_IS_LINKED(s->state)) {
 608         pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_PROPLIST_CHANGED], s);
 609         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 610     }
 611
 612     return TRUE;
 613 }
 614
 615 /* Called from main thread */
 616 void pa_source_set_description(pa_source *s, const char *description) {
 617     const char *old;
 618     pa_source_assert_ref(s);
 619
 620     if (!description && !pa_proplist_contains(s->proplist, PA_PROP_DEVICE_DESCRIPTION))
 621         return;
 622
 623     old = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
 624
 625     if (old && description && !strcmp(old, description))
 626         return;
 627
 628     if (description)
 629         pa_proplist_sets(s->proplist, PA_PROP_DEVICE_DESCRIPTION, description);
 630     else
 631         pa_proplist_unset(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
 632
 633     if (PA_SOURCE_IS_LINKED(s->state)) {
 634         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 635         pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_PROPLIST_CHANGED], s);
 636     }
 637 }
 638
 639 /* Called from main thread */
 640 unsigned pa_source_linked_by(pa_source *s) {
 641     pa_source_assert_ref(s);
 642     pa_assert(PA_SOURCE_IS_LINKED(s->state));
 643
 644     return pa_idxset_size(s->outputs);
 645 }
 646
 647 /* Called from main thread */
 648 unsigned pa_source_used_by(pa_source *s) {
 649     unsigned ret;
 650
 651     pa_source_assert_ref(s);
 652     pa_assert(PA_SOURCE_IS_LINKED(s->state));
 653
 654     ret = pa_idxset_size(s->outputs);
 655     pa_assert(ret >= s->n_corked);
 656
 657     return ret - s->n_corked;
 658 }
 659
 660 /* Called from main thread */
 661 unsigned pa_source_check_suspend(pa_source *s) {
 662     unsigned ret;
 663     pa_source_output *o;
 664     uint32_t idx;
 665
 666     pa_source_assert_ref(s);
 667
 668     if (!PA_SOURCE_IS_LINKED(s->state))
 669         return 0;
 670
 671     ret = 0;
 672
 673     for (o = PA_SOURCE_OUTPUT(pa_idxset_first(s->outputs, &idx)); o; o = PA_SOURCE_OUTPUT(pa_idxset_next(s->outputs, &idx))) {
 674         pa_source_output_state_t st;
 675
 676         st = pa_source_output_get_state(o);
 677         pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(st));
 678
 679         if (st == PA_SOURCE_OUTPUT_CORKED)
 680             continue;
 681
 682         if (o->flags & PA_SOURCE_OUTPUT_DONT_INHIBIT_AUTO_SUSPEND)
 683             continue;
 684
 685         ret ++;
 686     }
 687
 688     return ret;
 689 }
 690
 691 /* Called from IO thread, except when it is not */
 692 int pa_source_process_msg(pa_msgobject *object, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
 693     pa_source *s = PA_SOURCE(object);
 694     pa_source_assert_ref(s);
 695
 696     switch ((pa_source_message_t) code) {
 697
 698         case PA_SOURCE_MESSAGE_ADD_OUTPUT: {
 699             pa_source_output *o = PA_SOURCE_OUTPUT(userdata);
 700
 701             pa_hashmap_put(s->thread_info.outputs, PA_UINT32_TO_PTR(o->index), pa_source_output_ref(o));
 702
 703             if (o->direct_on_input) {
 704                 o->thread_info.direct_on_input = o->direct_on_input;
 705                 pa_hashmap_put(o->thread_info.direct_on_input->thread_info.direct_outputs, PA_UINT32_TO_PTR(o->index), o);
 706             }
 707
 708             pa_assert(!o->thread_info.attached);
 709             o->thread_info.attached = TRUE;
 710
 711             if (o->attach)
 712                 o->attach(o);
 713
 714             pa_source_output_set_state_within_thread(o, o->state);
 715
 716             if (o->thread_info.requested_source_latency != (pa_usec_t) -1)
 717                 pa_source_output_set_requested_latency_within_thread(o, o->thread_info.requested_source_latency);
 718
 719             pa_source_output_update_max_rewind(o, s->thread_info.max_rewind);
 720
 721             /* We don't just invalidate the requested latency here,
 722              * because if we are in a move we might need to fix up the
 723              * requested latency. */
 724             pa_source_output_set_requested_latency_within_thread(o, o->thread_info.requested_source_latency);
 725
 726             return 0;
 727         }
 728
 729         case PA_SOURCE_MESSAGE_REMOVE_OUTPUT: {
 730             pa_source_output *o = PA_SOURCE_OUTPUT(userdata);
 731
 732             pa_source_output_set_state_within_thread(o, o->state);
 733
 734             if (o->detach)
 735                 o->detach(o);
 736
 737             pa_assert(o->thread_info.attached);
 738             o->thread_info.attached = FALSE;
 739
 740             if (o->thread_info.direct_on_input) {
 741                 pa_hashmap_remove(o->thread_info.direct_on_input->thread_info.direct_outputs, PA_UINT32_TO_PTR(o->index));
 742                 o->thread_info.direct_on_input = NULL;
 743             }
 744
 745             if (pa_hashmap_remove(s->thread_info.outputs, PA_UINT32_TO_PTR(o->index)))
 746                 pa_source_output_unref(o);
 747
 748             pa_source_invalidate_requested_latency(s);
 749
 750             return 0;
 751         }
 752
 753         case PA_SOURCE_MESSAGE_SET_VOLUME:
 754             s->thread_info.soft_volume = *((pa_cvolume*) userdata);
 755             return 0;
 756
 757         case PA_SOURCE_MESSAGE_SET_MUTE:
 758             s->thread_info.soft_muted = PA_PTR_TO_UINT(userdata);
 759             return 0;
 760
 761         case PA_SOURCE_MESSAGE_GET_VOLUME:
 762             *((pa_cvolume*) userdata) = s->thread_info.soft_volume;
 763             return 0;
 764
 765         case PA_SOURCE_MESSAGE_GET_MUTE:
 766             *((pa_bool_t*) userdata) = s->thread_info.soft_muted;
 767             return 0;
 768
 769         case PA_SOURCE_MESSAGE_SET_STATE:
 770             s->thread_info.state = PA_PTR_TO_UINT(userdata);
 771             return 0;
 772
 773         case PA_SOURCE_MESSAGE_DETACH:
 774
 775             /* Detach all streams */
 776             pa_source_detach_within_thread(s);
 777             return 0;
 778
 779         case PA_SOURCE_MESSAGE_ATTACH:
 780
 781             /* Reattach all streams */
 782             pa_source_attach_within_thread(s);
 783             return 0;
 784
 785         case PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY: {
 786
 787             pa_usec_t *usec = userdata;
 788             *usec = pa_source_get_requested_latency_within_thread(s);
 789
 790             if (*usec == (pa_usec_t) -1)
 791                 *usec = s->thread_info.max_latency;
 792
 793             return 0;
 794         }
 795
 796         case PA_SOURCE_MESSAGE_SET_LATENCY_RANGE: {
 797             pa_usec_t *r = userdata;
 798
 799             pa_source_update_latency_range(s, r[0], r[1]);
 800
 801             return 0;
 802         }
 803
 804         case PA_SOURCE_MESSAGE_GET_LATENCY_RANGE: {
 805             pa_usec_t *r = userdata;
 806
 807             r[0] = s->thread_info.min_latency;
 808             r[1] = s->thread_info.max_latency;
 809
 810             return 0;
 811         }
 812
 813         case PA_SOURCE_MESSAGE_GET_MAX_REWIND:
 814
 815             *((size_t*) userdata) = s->thread_info.max_rewind;
 816             return 0;
 817
 818         case PA_SOURCE_MESSAGE_GET_LATENCY:
 819
 820             if (s->monitor_of) {
 821                 *((pa_usec_t*) userdata) = 0;
 822                 return 0;
 823             }
 824
 825             /* Implementors need to overwrite this implementation! */
 826             return -1;
 827
 828         case PA_SOURCE_MESSAGE_MAX:
 829             ;
 830     }
 831
 832     return -1;
 833 }
 834
 835 /* Called from main thread */
 836 int pa_source_suspend_all(pa_core *c, pa_bool_t suspend) {
 837     uint32_t idx;
 838     pa_source *source;
 839     int ret = 0;
 840
 841     pa_core_assert_ref(c);
 842
 843     for (source = PA_SOURCE(pa_idxset_first(c->sources, &idx)); source; source = PA_SOURCE(pa_idxset_next(c->sources, &idx)))
 844         ret -= pa_source_suspend(source, suspend) < 0;
 845
 846     return ret;
 847 }
 848
 849 /* Called from main thread */
 850 void pa_source_detach(pa_source *s) {
 851     pa_source_assert_ref(s);
 852     pa_assert(PA_SOURCE_IS_LINKED(s->state));
 853
 854     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_DETACH, NULL, 0, NULL) == 0);
 855 }
 856
 857 /* Called from main thread */
 858 void pa_source_attach(pa_source *s) {
 859     pa_source_assert_ref(s);
 860     pa_assert(PA_SOURCE_IS_LINKED(s->state));
 861
 862     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_ATTACH, NULL, 0, NULL) == 0);
 863 }
 864
 865 /* Called from IO thread */
 866 void pa_source_detach_within_thread(pa_source *s) {
 867     pa_source_output *o;
 868     void *state = NULL;
 869
 870     pa_source_assert_ref(s);
 871     pa_assert(PA_SOURCE_IS_LINKED(s->thread_info.state));
 872
 873     while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
 874         if (o->detach)
 875             o->detach(o);
 876 }
 877
 878 /* Called from IO thread */
 879 void pa_source_attach_within_thread(pa_source *s) {
 880     pa_source_output *o;
 881     void *state = NULL;
 882
 883     pa_source_assert_ref(s);
 884     pa_assert(PA_SOURCE_IS_LINKED(s->thread_info.state));
 885
 886     while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
 887         if (o->attach)
 888             o->attach(o);
 889 }
 890
 891 /* Called from IO thread */
 892 pa_usec_t pa_source_get_requested_latency_within_thread(pa_source *s) {
 893     pa_usec_t result = (pa_usec_t) -1;
 894     pa_source_output *o;
 895     void *state = NULL;
 896
 897     pa_source_assert_ref(s);
 898
 899     if (s->thread_info.requested_latency_valid)
 900         return s->thread_info.requested_latency;
 901
 902     while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
 903
 904         if (o->thread_info.requested_source_latency != (pa_usec_t) -1 &&
 905             (result == (pa_usec_t) -1 || result > o->thread_info.requested_source_latency))
 906             result = o->thread_info.requested_source_latency;
 907
 908     if (result != (pa_usec_t) -1) {
 909         if (s->thread_info.max_latency > 0 && result > s->thread_info.max_latency)
 910             result = s->thread_info.max_latency;
 911
 912         if (s->thread_info.min_latency > 0 && result < s->thread_info.min_latency)
 913             result = s->thread_info.min_latency;
 914     }
 915
 916     s->thread_info.requested_latency = result;
 917     s->thread_info.requested_latency_valid = TRUE;
 918
 919     return result;
 920 }
 921
 922 /* Called from main thread */
 923 pa_usec_t pa_source_get_requested_latency(pa_source *s) {
 924     pa_usec_t usec;
 925
 926     pa_source_assert_ref(s);
 927     pa_assert(PA_SOURCE_IS_LINKED(s->state));
 928
 929     if (!PA_SOURCE_IS_OPENED(s->state))
 930         return 0;
 931
 932     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY, &usec, 0, NULL) == 0);
 933
 934     return usec;
 935 }
 936
 937 /* Called from IO thread */
 938 void pa_source_set_max_rewind(pa_source *s, size_t max_rewind) {
 939     pa_source_output *o;
 940     void *state = NULL;
 941
 942     pa_source_assert_ref(s);
 943
 944     if (max_rewind == s->thread_info.max_rewind)
 945         return;
 946
 947     s->thread_info.max_rewind = max_rewind;
 948
 949     if (PA_SOURCE_IS_LINKED(s->thread_info.state)) {
 950         while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
 951             pa_source_output_update_max_rewind(o, s->thread_info.max_rewind);
 952     }
 953 }
 954
 955 void pa_source_invalidate_requested_latency(pa_source *s) {
 956     pa_source_output *o;
 957     void *state = NULL;
 958
 959     pa_source_assert_ref(s);
 960
 961     s->thread_info.requested_latency_valid = FALSE;
 962
 963     if (s->update_requested_latency)
 964         s->update_requested_latency(s);
 965
 966     while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
 967         if (o->update_source_requested_latency)
 968             o->update_source_requested_latency(o);
 969
 970     if (s->monitor_of)
 971         pa_sink_invalidate_requested_latency(s->monitor_of);
 972 }
 973
 974 void pa_source_set_latency_range(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency) {
 975     pa_source_assert_ref(s);
 976
 977     /* min_latency == 0:           no limit
 978      * min_latency == (size_t) -1: default limit
 979      * min_latency anything else:  specified limit
 980      *
 981      * Similar for max_latency */
 982
 983     if (min_latency == (pa_usec_t) -1)
 984         min_latency = DEFAULT_MIN_LATENCY;
 985
 986     if (max_latency == (pa_usec_t) -1)
 987         max_latency = min_latency;
 988
 989     pa_assert(!min_latency || !max_latency ||
 990               min_latency <= max_latency);
 991
 992     if (PA_SOURCE_IS_LINKED(s->state)) {
 993         pa_usec_t r[2];
 994
 995         r[0] = min_latency;
 996         r[1] = max_latency;
 997
 998         pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_LATENCY_RANGE, r, 0, NULL) == 0);
 999     } else {
1000         s->thread_info.min_latency = min_latency;
1001         s->thread_info.max_latency = max_latency;
1002
1003         s->thread_info.requested_latency_valid = FALSE;
1004     }
1005 }
1006
1007 void pa_source_get_latency_range(pa_source *s, pa_usec_t *min_latency, pa_usec_t *max_latency) {
1008    pa_source_assert_ref(s);
1009    pa_assert(min_latency);
1010    pa_assert(max_latency);
1011
1012    if (PA_SOURCE_IS_LINKED(s->state)) {
1013        pa_usec_t r[2] = { 0, 0 };
1014
1015        pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_LATENCY_RANGE, r, 0, NULL) == 0);
1016
1017        *min_latency = r[0];
1018        *max_latency = r[1];
1019    } else {
1020        *min_latency = s->thread_info.min_latency;
1021        *max_latency = s->thread_info.max_latency;
1022    }
1023 }
1024
1025 /* Called from IO thread */
1026 void pa_source_update_latency_range(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency) {
1027     pa_source_output *o;
1028     void *state = NULL;
1029
1030     pa_source_assert_ref(s);
1031
1032     s->thread_info.min_latency = min_latency;
1033     s->thread_info.max_latency = max_latency;
1034
1035     while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
1036         if (o->update_source_latency_range)
1037             o->update_source_latency_range(o);
1038
1039     pa_source_invalidate_requested_latency(s);
1040 }
1041
1042 size_t pa_source_get_max_rewind(pa_source *s) {
1043     size_t r;
1044     pa_source_assert_ref(s);
1045
1046     if (!PA_SOURCE_IS_LINKED(s->state))
1047         return s->thread_info.max_rewind;
1048
1049     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_MAX_REWIND, &r, 0, NULL) == 0);
1050
1051     return r;
1052 }