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_OPENED(s->thread_info.state));
 483
 484     if (nbytes <= 0)
 485         return;
 486
 487     pa_log_debug("Processing rewind...");
 488
 489     while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL))) {
 490         pa_source_output_assert_ref(o);
 491         pa_source_output_process_rewind(o, nbytes);
 492     }
 493 }
 494
 495 /* Called from IO thread context */
 496 void pa_source_post(pa_source*s, const pa_memchunk *chunk) {
 497     pa_source_output *o;
 498     void *state = NULL;
 499
 500     pa_source_assert_ref(s);
 501     pa_assert(PA_SOURCE_IS_OPENED(s->thread_info.state));
 502     pa_assert(chunk);
 503
 504     if (s->thread_info.soft_muted || !pa_cvolume_is_norm(&s->thread_info.soft_volume)) {
 505         pa_memchunk vchunk = *chunk;
 506
 507         pa_memblock_ref(vchunk.memblock);
 508         pa_memchunk_make_writable(&vchunk, 0);
 509
 510         if (s->thread_info.soft_muted || pa_cvolume_is_muted(&s->thread_info.soft_volume))
 511             pa_silence_memchunk(&vchunk, &s->sample_spec);
 512         else
 513             pa_volume_memchunk(&vchunk, &s->sample_spec, &s->thread_info.soft_volume);
 514
 515         while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL))) {
 516             pa_source_output_assert_ref(o);
 517
 518             if (!o->thread_info.direct_on_input)
 519                 pa_source_output_push(o, &vchunk);
 520         }
 521
 522         pa_memblock_unref(vchunk.memblock);
 523     } else {
 524
 525         while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL))) {
 526             pa_source_output_assert_ref(o);
 527
 528             if (!o->thread_info.direct_on_input)
 529                 pa_source_output_push(o, chunk);
 530         }
 531     }
 532 }
 533
 534 /* Called from IO thread context */
 535 void pa_source_post_direct(pa_source*s, pa_source_output *o, const pa_memchunk *chunk) {
 536     pa_source_assert_ref(s);
 537     pa_assert(PA_SOURCE_IS_OPENED(s->thread_info.state));
 538     pa_source_output_assert_ref(o);
 539     pa_assert(o->thread_info.direct_on_input);
 540     pa_assert(chunk);
 541
 542     if (s->thread_info.soft_muted || !pa_cvolume_is_norm(&s->thread_info.soft_volume)) {
 543         pa_memchunk vchunk = *chunk;
 544
 545         pa_memblock_ref(vchunk.memblock);
 546         pa_memchunk_make_writable(&vchunk, 0);
 547
 548         if (s->thread_info.soft_muted || pa_cvolume_is_muted(&s->thread_info.soft_volume))
 549             pa_silence_memchunk(&vchunk, &s->sample_spec);
 550         else
 551             pa_volume_memchunk(&vchunk, &s->sample_spec, &s->thread_info.soft_volume);
 552
 553         pa_source_output_push(o, &vchunk);
 554
 555         pa_memblock_unref(vchunk.memblock);
 556     } else
 557         pa_source_output_push(o, chunk);
 558 }
 559
 560 /* Called from main thread */
 561 pa_usec_t pa_source_get_latency(pa_source *s) {
 562     pa_usec_t usec;
 563
 564     pa_source_assert_ref(s);
 565     pa_assert(PA_SOURCE_IS_LINKED(s->state));
 566
 567     if (!PA_SOURCE_IS_OPENED(s->state))
 568         return 0;
 569
 570     if (!(s->flags & PA_SOURCE_LATENCY))
 571         return 0;
 572
 573     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_LATENCY, &usec, 0, NULL) == 0);
 574
 575     return usec;
 576 }
 577
 578 /* Called from main thread */
 579 void pa_source_set_volume(pa_source *s, const pa_cvolume *volume) {
 580     pa_cvolume old_virtual_volume;
 581     pa_bool_t virtual_volume_changed;
 582
 583     pa_source_assert_ref(s);
 584     pa_assert(PA_SOURCE_IS_LINKED(s->state));
 585     pa_assert(volume);
 586     pa_assert(pa_cvolume_valid(volume));
 587     pa_assert(pa_cvolume_compatible(volume, &s->sample_spec));
 588
 589     old_virtual_volume = s->virtual_volume;
 590     s->virtual_volume = *volume;
 591     virtual_volume_changed = !pa_cvolume_equal(&old_virtual_volume, &s->virtual_volume);
 592
 593     if (s->set_volume) {
 594         pa_cvolume_reset(&s->soft_volume, s->sample_spec.channels);
 595         s->set_volume(s);
 596     } else
 597         s->soft_volume = s->virtual_volume;
 598
 599     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_VOLUME, NULL, 0, NULL) == 0);
 600
 601     if (virtual_volume_changed)
 602         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 603 }
 604
 605 /* Called from main thread. Only to be called by source implementor */
 606 void pa_source_set_soft_volume(pa_source *s, const pa_cvolume *volume) {
 607     pa_source_assert_ref(s);
 608     pa_assert(volume);
 609
 610     if (PA_SOURCE_IS_LINKED(s->state))
 611         pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_VOLUME, NULL, 0, NULL) == 0);
 612     else
 613         s->thread_info.soft_volume = *volume;
 614 }
 615
 616 /* Called from main thread */
 617 const pa_cvolume *pa_source_get_volume(pa_source *s, pa_bool_t force_refresh) {
 618     pa_source_assert_ref(s);
 619     pa_assert(PA_SOURCE_IS_LINKED(s->state));
 620
 621     if (s->refresh_volume || force_refresh) {
 622         pa_cvolume old_virtual_volume = s->virtual_volume;
 623
 624         if (s->get_volume)
 625             s->get_volume(s);
 626
 627         pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_VOLUME, NULL, 0, NULL) == 0);
 628
 629         if (!pa_cvolume_equal(&old_virtual_volume, &s->virtual_volume))
 630             pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 631     }
 632
 633     return &s->virtual_volume;
 634 }
 635
 636 /* Called from main thread */
 637 void pa_source_set_mute(pa_source *s, pa_bool_t mute) {
 638     pa_bool_t old_muted;
 639
 640     pa_source_assert_ref(s);
 641     pa_assert(PA_SOURCE_IS_LINKED(s->state));
 642
 643     old_muted = s->muted;
 644     s->muted = mute;
 645
 646     if (s->set_mute)
 647         s->set_mute(s);
 648
 649     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_MUTE, NULL, 0, NULL) == 0);
 650
 651     if (old_muted != s->muted)
 652         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 653 }
 654
 655 /* Called from main thread */
 656 pa_bool_t pa_source_get_mute(pa_source *s, pa_bool_t force_refresh) {
 657
 658     pa_source_assert_ref(s);
 659     pa_assert(PA_SOURCE_IS_LINKED(s->state));
 660
 661     if (s->refresh_muted || force_refresh) {
 662         pa_bool_t old_muted = s->muted;
 663
 664         if (s->get_mute)
 665             s->get_mute(s);
 666
 667         pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_MUTE, NULL, 0, NULL) == 0);
 668
 669         if (old_muted != s->muted)
 670             pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 671     }
 672
 673     return s->muted;
 674 }
 675
 676 /* Called from main thread */
 677 pa_bool_t pa_source_update_proplist(pa_source *s, pa_update_mode_t mode, pa_proplist *p) {
 678
 679     pa_source_assert_ref(s);
 680
 681     pa_proplist_update(s->proplist, mode, p);
 682
 683     if (PA_SOURCE_IS_LINKED(s->state)) {
 684         pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_PROPLIST_CHANGED], s);
 685         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 686     }
 687
 688     return TRUE;
 689 }
 690
 691 /* Called from main thread */
 692 void pa_source_set_description(pa_source *s, const char *description) {
 693     const char *old;
 694     pa_source_assert_ref(s);
 695
 696     if (!description && !pa_proplist_contains(s->proplist, PA_PROP_DEVICE_DESCRIPTION))
 697         return;
 698
 699     old = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
 700
 701     if (old && description && !strcmp(old, description))
 702         return;
 703
 704     if (description)
 705         pa_proplist_sets(s->proplist, PA_PROP_DEVICE_DESCRIPTION, description);
 706     else
 707         pa_proplist_unset(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
 708
 709     if (PA_SOURCE_IS_LINKED(s->state)) {
 710         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 711         pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_PROPLIST_CHANGED], s);
 712     }
 713 }
 714
 715 /* Called from main thread */
 716 unsigned pa_source_linked_by(pa_source *s) {
 717     pa_source_assert_ref(s);
 718     pa_assert(PA_SOURCE_IS_LINKED(s->state));
 719
 720     return pa_idxset_size(s->outputs);
 721 }
 722
 723 /* Called from main thread */
 724 unsigned pa_source_used_by(pa_source *s) {
 725     unsigned ret;
 726
 727     pa_source_assert_ref(s);
 728     pa_assert(PA_SOURCE_IS_LINKED(s->state));
 729
 730     ret = pa_idxset_size(s->outputs);
 731     pa_assert(ret >= s->n_corked);
 732
 733     return ret - s->n_corked;
 734 }
 735
 736 /* Called from main thread */
 737 unsigned pa_source_check_suspend(pa_source *s) {
 738     unsigned ret;
 739     pa_source_output *o;
 740     uint32_t idx;
 741
 742     pa_source_assert_ref(s);
 743
 744     if (!PA_SOURCE_IS_LINKED(s->state))
 745         return 0;
 746
 747     ret = 0;
 748
 749     for (o = PA_SOURCE_OUTPUT(pa_idxset_first(s->outputs, &idx)); o; o = PA_SOURCE_OUTPUT(pa_idxset_next(s->outputs, &idx))) {
 750         pa_source_output_state_t st;
 751
 752         st = pa_source_output_get_state(o);
 753         pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(st));
 754
 755         if (st == PA_SOURCE_OUTPUT_CORKED)
 756             continue;
 757
 758         if (o->flags & PA_SOURCE_OUTPUT_DONT_INHIBIT_AUTO_SUSPEND)
 759             continue;
 760
 761         ret ++;
 762     }
 763
 764     return ret;
 765 }
 766
 767 /* Called from IO thread, except when it is not */
 768 int pa_source_process_msg(pa_msgobject *object, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
 769     pa_source *s = PA_SOURCE(object);
 770     pa_source_assert_ref(s);
 771
 772     switch ((pa_source_message_t) code) {
 773
 774         case PA_SOURCE_MESSAGE_ADD_OUTPUT: {
 775             pa_source_output *o = PA_SOURCE_OUTPUT(userdata);
 776
 777             pa_hashmap_put(s->thread_info.outputs, PA_UINT32_TO_PTR(o->index), pa_source_output_ref(o));
 778
 779             if (o->direct_on_input) {
 780                 o->thread_info.direct_on_input = o->direct_on_input;
 781                 pa_hashmap_put(o->thread_info.direct_on_input->thread_info.direct_outputs, PA_UINT32_TO_PTR(o->index), o);
 782             }
 783
 784             pa_assert(!o->thread_info.attached);
 785             o->thread_info.attached = TRUE;
 786
 787             if (o->attach)
 788                 o->attach(o);
 789
 790             pa_source_output_set_state_within_thread(o, o->state);
 791
 792             if (o->thread_info.requested_source_latency != (pa_usec_t) -1)
 793                 pa_source_output_set_requested_latency_within_thread(o, o->thread_info.requested_source_latency);
 794
 795             pa_source_output_update_max_rewind(o, s->thread_info.max_rewind);
 796
 797             /* We don't just invalidate the requested latency here,
 798              * because if we are in a move we might need to fix up the
 799              * requested latency. */
 800             pa_source_output_set_requested_latency_within_thread(o, o->thread_info.requested_source_latency);
 801
 802             return 0;
 803         }
 804
 805         case PA_SOURCE_MESSAGE_REMOVE_OUTPUT: {
 806             pa_source_output *o = PA_SOURCE_OUTPUT(userdata);
 807
 808             pa_source_output_set_state_within_thread(o, o->state);
 809
 810             if (o->detach)
 811                 o->detach(o);
 812
 813             pa_assert(o->thread_info.attached);
 814             o->thread_info.attached = FALSE;
 815
 816             if (o->thread_info.direct_on_input) {
 817                 pa_hashmap_remove(o->thread_info.direct_on_input->thread_info.direct_outputs, PA_UINT32_TO_PTR(o->index));
 818                 o->thread_info.direct_on_input = NULL;
 819             }
 820
 821             if (pa_hashmap_remove(s->thread_info.outputs, PA_UINT32_TO_PTR(o->index)))
 822                 pa_source_output_unref(o);
 823
 824             pa_source_invalidate_requested_latency(s);
 825
 826             return 0;
 827         }
 828
 829         case PA_SOURCE_MESSAGE_SET_VOLUME:
 830             s->thread_info.soft_volume = s->soft_volume;
 831             return 0;
 832
 833         case PA_SOURCE_MESSAGE_GET_VOLUME:
 834             return 0;
 835
 836         case PA_SOURCE_MESSAGE_SET_MUTE:
 837             s->thread_info.soft_muted = s->muted;
 838             return 0;
 839
 840         case PA_SOURCE_MESSAGE_GET_MUTE:
 841             return 0;
 842
 843         case PA_SOURCE_MESSAGE_SET_STATE:
 844             s->thread_info.state = PA_PTR_TO_UINT(userdata);
 845             return 0;
 846
 847         case PA_SOURCE_MESSAGE_DETACH:
 848
 849             /* Detach all streams */
 850             pa_source_detach_within_thread(s);
 851             return 0;
 852
 853         case PA_SOURCE_MESSAGE_ATTACH:
 854
 855             /* Reattach all streams */
 856             pa_source_attach_within_thread(s);
 857             return 0;
 858
 859         case PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY: {
 860
 861             pa_usec_t *usec = userdata;
 862             *usec = pa_source_get_requested_latency_within_thread(s);
 863
 864             if (*usec == (pa_usec_t) -1)
 865                 *usec = s->thread_info.max_latency;
 866
 867             return 0;
 868         }
 869
 870         case PA_SOURCE_MESSAGE_SET_LATENCY_RANGE: {
 871             pa_usec_t *r = userdata;
 872
 873             pa_source_update_latency_range(s, r[0], r[1]);
 874
 875             return 0;
 876         }
 877
 878         case PA_SOURCE_MESSAGE_GET_LATENCY_RANGE: {
 879             pa_usec_t *r = userdata;
 880
 881             r[0] = s->thread_info.min_latency;
 882             r[1] = s->thread_info.max_latency;
 883
 884             return 0;
 885         }
 886
 887         case PA_SOURCE_MESSAGE_GET_MAX_REWIND:
 888
 889             *((size_t*) userdata) = s->thread_info.max_rewind;
 890             return 0;
 891
 892         case PA_SOURCE_MESSAGE_GET_LATENCY:
 893
 894             if (s->monitor_of) {
 895                 *((pa_usec_t*) userdata) = 0;
 896                 return 0;
 897             }
 898
 899             /* Implementors need to overwrite this implementation! */
 900             return -1;
 901
 902         case PA_SOURCE_MESSAGE_MAX:
 903             ;
 904     }
 905
 906     return -1;
 907 }
 908
 909 /* Called from main thread */
 910 int pa_source_suspend_all(pa_core *c, pa_bool_t suspend) {
 911     uint32_t idx;
 912     pa_source *source;
 913     int ret = 0;
 914
 915     pa_core_assert_ref(c);
 916
 917     for (source = PA_SOURCE(pa_idxset_first(c->sources, &idx)); source; source = PA_SOURCE(pa_idxset_next(c->sources, &idx)))
 918         ret -= pa_source_suspend(source, suspend) < 0;
 919
 920     return ret;
 921 }
 922
 923 /* Called from main thread */
 924 void pa_source_detach(pa_source *s) {
 925     pa_source_assert_ref(s);
 926     pa_assert(PA_SOURCE_IS_LINKED(s->state));
 927
 928     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_DETACH, NULL, 0, NULL) == 0);
 929 }
 930
 931 /* Called from main thread */
 932 void pa_source_attach(pa_source *s) {
 933     pa_source_assert_ref(s);
 934     pa_assert(PA_SOURCE_IS_LINKED(s->state));
 935
 936     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_ATTACH, NULL, 0, NULL) == 0);
 937 }
 938
 939 /* Called from IO thread */
 940 void pa_source_detach_within_thread(pa_source *s) {
 941     pa_source_output *o;
 942     void *state = NULL;
 943
 944     pa_source_assert_ref(s);
 945     pa_assert(PA_SOURCE_IS_LINKED(s->thread_info.state));
 946
 947     while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
 948         if (o->detach)
 949             o->detach(o);
 950 }
 951
 952 /* Called from IO thread */
 953 void pa_source_attach_within_thread(pa_source *s) {
 954     pa_source_output *o;
 955     void *state = NULL;
 956
 957     pa_source_assert_ref(s);
 958     pa_assert(PA_SOURCE_IS_LINKED(s->thread_info.state));
 959
 960     while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
 961         if (o->attach)
 962             o->attach(o);
 963 }
 964
 965 /* Called from IO thread */
 966 pa_usec_t pa_source_get_requested_latency_within_thread(pa_source *s) {
 967     pa_usec_t result = (pa_usec_t) -1;
 968     pa_source_output *o;
 969     void *state = NULL;
 970
 971     pa_source_assert_ref(s);
 972
 973     if (s->thread_info.requested_latency_valid)
 974         return s->thread_info.requested_latency;
 975
 976     while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
 977
 978         if (o->thread_info.requested_source_latency != (pa_usec_t) -1 &&
 979             (result == (pa_usec_t) -1 || result > o->thread_info.requested_source_latency))
 980             result = o->thread_info.requested_source_latency;
 981
 982     if (result != (pa_usec_t) -1) {
 983         if (s->thread_info.max_latency > 0 && result > s->thread_info.max_latency)
 984             result = s->thread_info.max_latency;
 985
 986         if (s->thread_info.min_latency > 0 && result < s->thread_info.min_latency)
 987             result = s->thread_info.min_latency;
 988     }
 989
 990     s->thread_info.requested_latency = result;
 991     s->thread_info.requested_latency_valid = TRUE;
 992
 993     return result;
 994 }
 995
 996 /* Called from main thread */
 997 pa_usec_t pa_source_get_requested_latency(pa_source *s) {
 998     pa_usec_t usec;
 999
1000     pa_source_assert_ref(s);
1001     pa_assert(PA_SOURCE_IS_LINKED(s->state));
1002
1003     if (!PA_SOURCE_IS_OPENED(s->state))
1004         return 0;
1005
1006     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY, &usec, 0, NULL) == 0);
1007
1008     return usec;
1009 }
1010
1011 /* Called from IO thread */
1012 void pa_source_set_max_rewind(pa_source *s, size_t max_rewind) {
1013     pa_source_output *o;
1014     void *state = NULL;
1015
1016     pa_source_assert_ref(s);
1017
1018     if (max_rewind == s->thread_info.max_rewind)
1019         return;
1020
1021     s->thread_info.max_rewind = max_rewind;
1022
1023     if (PA_SOURCE_IS_LINKED(s->thread_info.state)) {
1024         while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
1025             pa_source_output_update_max_rewind(o, s->thread_info.max_rewind);
1026     }
1027 }
1028
1029 void pa_source_invalidate_requested_latency(pa_source *s) {
1030     pa_source_output *o;
1031     void *state = NULL;
1032
1033     pa_source_assert_ref(s);
1034
1035     s->thread_info.requested_latency_valid = FALSE;
1036
1037     if (s->update_requested_latency)
1038         s->update_requested_latency(s);
1039
1040     while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
1041         if (o->update_source_requested_latency)
1042             o->update_source_requested_latency(o);
1043
1044     if (s->monitor_of)
1045         pa_sink_invalidate_requested_latency(s->monitor_of);
1046 }
1047
1048 void pa_source_set_latency_range(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency) {
1049     pa_source_assert_ref(s);
1050
1051     /* min_latency == 0:           no limit
1052      * min_latency == (size_t) -1: default limit
1053      * min_latency anything else:  specified limit
1054      *
1055      * Similar for max_latency */
1056
1057     if (min_latency == (pa_usec_t) -1)
1058         min_latency = DEFAULT_MIN_LATENCY;
1059
1060     if (max_latency == (pa_usec_t) -1)
1061         max_latency = min_latency;
1062
1063     pa_assert(!min_latency || !max_latency ||
1064               min_latency <= max_latency);
1065
1066     if (PA_SOURCE_IS_LINKED(s->state)) {
1067         pa_usec_t r[2];
1068
1069         r[0] = min_latency;
1070         r[1] = max_latency;
1071
1072         pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_LATENCY_RANGE, r, 0, NULL) == 0);
1073     } else {
1074         s->thread_info.min_latency = min_latency;
1075         s->thread_info.max_latency = max_latency;
1076
1077         s->thread_info.requested_latency_valid = FALSE;
1078     }
1079 }
1080
1081 void pa_source_get_latency_range(pa_source *s, pa_usec_t *min_latency, pa_usec_t *max_latency) {
1082    pa_source_assert_ref(s);
1083    pa_assert(min_latency);
1084    pa_assert(max_latency);
1085
1086    if (PA_SOURCE_IS_LINKED(s->state)) {
1087        pa_usec_t r[2] = { 0, 0 };
1088
1089        pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_LATENCY_RANGE, r, 0, NULL) == 0);
1090
1091        *min_latency = r[0];
1092        *max_latency = r[1];
1093    } else {
1094        *min_latency = s->thread_info.min_latency;
1095        *max_latency = s->thread_info.max_latency;
1096    }
1097 }
1098
1099 /* Called from IO thread */
1100 void pa_source_update_latency_range(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency) {
1101     pa_source_output *o;
1102     void *state = NULL;
1103
1104     pa_source_assert_ref(s);
1105
1106     s->thread_info.min_latency = min_latency;
1107     s->thread_info.max_latency = max_latency;
1108
1109     while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
1110         if (o->update_source_latency_range)
1111             o->update_source_latency_range(o);
1112
1113     pa_source_invalidate_requested_latency(s);
1114 }
1115
1116 size_t pa_source_get_max_rewind(pa_source *s) {
1117     size_t r;
1118     pa_source_assert_ref(s);
1119
1120     if (!PA_SOURCE_IS_LINKED(s->state))
1121         return s->thread_info.max_rewind;
1122
1123     pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_MAX_REWIND, &r, 0, NULL) == 0);
1124
1125     return r;
1126 }