src/pulsecore/source.c

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