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