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