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