src/pulsecore/source.c

   1 /* $Id$ */
   2
   3 /***
   4   This file is part of PulseAudio.
   5
   6   Copyright 2004-2006 Lennart Poettering
   7   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
   8
   9   PulseAudio is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU Lesser General Public License as published
  11   by the Free Software Foundation; either version 2 of the License,
  12   or (at your option) any later version.
  13
  14   PulseAudio is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with PulseAudio; if not, write to the Free Software
  21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  22   USA.
  23 ***/
  24
  25 #ifdef HAVE_CONFIG_H
  26 #include <config.h>
  27 #endif
  28
  29 #include <stdio.h>
  30 #include <stdlib.h>
  31 #include <string.h>
  32
  33 #include <pulse/utf8.h>
  34 #include <pulse/xmalloc.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 static PA_DEFINE_CHECK_TYPE(pa_source, pa_msgobject);
  45
  46 static void source_free(pa_object *o);
  47
  48 pa_source* pa_source_new(
  49         pa_core *core,
  50         const char *driver,
  51         const char *name,
  52         int fail,
  53         const pa_sample_spec *spec,
  54         const pa_channel_map *map) {
  55
  56     pa_source *s;
  57     char st[256];
  58     pa_channel_map tmap;
  59
  60     pa_assert(core);
  61     pa_assert(name);
  62     pa_assert(spec);
  63
  64     pa_return_null_if_fail(pa_sample_spec_valid(spec));
  65
  66     if (!map)
  67         map = pa_channel_map_init_auto(&tmap, spec->channels, PA_CHANNEL_MAP_DEFAULT);
  68
  69     pa_return_null_if_fail(map && pa_channel_map_valid(map));
  70     pa_return_null_if_fail(map->channels == spec->channels);
  71     pa_return_null_if_fail(!driver || pa_utf8_valid(driver));
  72     pa_return_null_if_fail(pa_utf8_valid(name) && *name);
  73
  74     s = pa_msgobject_new(pa_source);
  75
  76     if (!(name = pa_namereg_register(core, name, PA_NAMEREG_SOURCE, s, fail))) {
  77         pa_xfree(s);
  78         return NULL;
  79     }
  80
  81     s->parent.parent.free = source_free;
  82     s->parent.process_msg = pa_source_process_msg;
  83
  84     s->core = core;
  85     s->state = PA_SOURCE_INIT;
  86     s->flags = 0;
  87     s->name = pa_xstrdup(name);
  88     s->description = NULL;
  89     s->driver = pa_xstrdup(driver);
  90     s->module = NULL;
  91
  92     s->sample_spec = *spec;
  93     s->channel_map = *map;
  94
  95     s->outputs = pa_idxset_new(NULL, NULL);
  96     s->n_corked = 0;
  97     s->monitor_of = NULL;
  98
  99     pa_cvolume_reset(&s->volume, spec->channels);
 100     s->muted = 0;
 101     s->refresh_volume = s->refresh_muted = 0;
 102
 103     s->get_latency = NULL;
 104     s->set_volume = NULL;
 105     s->get_volume = NULL;
 106     s->set_mute = NULL;
 107     s->get_mute = NULL;
 108     s->set_state = NULL;
 109     s->userdata = NULL;
 110
 111     s->asyncmsgq = NULL;
 112     s->rtpoll = NULL;
 113
 114     pa_assert_se(pa_idxset_put(core->sources, s, &s->index) >= 0);
 115
 116     pa_sample_spec_snprint(st, sizeof(st), spec);
 117     pa_log_info("Created source %u \"%s\" with sample spec \"%s\"", s->index, s->name, st);
 118
 119     s->thread_info.outputs = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
 120     s->thread_info.soft_volume = s->volume;
 121     s->thread_info.soft_muted = s->muted;
 122     s->thread_info.state = s->state;
 123
 124     return s;
 125 }
 126
 127 void pa_source_put(pa_source *s) {
 128     pa_source_assert_ref(s);
 129
 130     pa_assert(s->state == PA_SINK_INIT);
 131     pa_assert(s->rtpoll);
 132     pa_assert(s->asyncmsgq);
 133
 134     s->thread_info.state = s->state = PA_SOURCE_IDLE;
 135
 136     pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE | PA_SUBSCRIPTION_EVENT_NEW, s->index);
 137     pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_NEW_POST], s);
 138 }
 139
 140 static int source_set_state(pa_source *s, pa_source_state_t state) {
 141     int ret;
 142
 143     pa_assert(s);
 144
 145     if (s->state == state)
 146         return 0;
 147
 148     if (state == PA_SOURCE_SUSPENDED && !(s->flags & PA_SOURCE_CAN_SUSPEND))
 149         return -1;
 150
 151     if ((s->state == PA_SOURCE_SUSPENDED && PA_SOURCE_OPENED(state)) ||
 152         (PA_SOURCE_OPENED(s->state) && state == PA_SOURCE_SUSPENDED)) {
 153         pa_source_output *o;
 154         uint32_t idx;
 155
 156         /* We're suspending or resuming, tell everyone about it */
 157
 158         for (o = PA_SOURCE_OUTPUT(pa_idxset_first(s->outputs, &idx)); o; o = PA_SOURCE_OUTPUT(pa_idxset_next(s->outputs, &idx)))
 159             if (o->suspend)
 160                 o->suspend(o, state == PA_SINK_SUSPENDED);
 161     }
 162
 163     if (s->set_state)
 164         if ((ret = s->set_state(s, state)) < 0)
 165             return -1;
 166
 167     if (pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL) < 0)
 168         return -1;
 169
 170     s->state = state;
 171
 172     if (state != PA_SOURCE_UNLINKED) /* if we enter UNLINKED state pa_source_unlink() will fire the apropriate events */
 173         pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_STATE_CHANGED], s);
 174     return 0;
 175 }
 176
 177 void pa_source_unlink(pa_source *s) {
 178     pa_source_output *o, *j = NULL;
 179
 180     pa_assert(s);
 181     pa_assert(PA_SOURCE_LINKED(s->state));
 182
 183     pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_UNLINK], s);
 184
 185     pa_namereg_unregister(s->core, s->name);
 186     pa_idxset_remove_by_data(s->core->sources, s, NULL);
 187
 188     while ((o = pa_idxset_first(s->outputs, NULL))) {
 189         pa_assert(o != j);
 190         pa_source_output_kill(o);
 191         j = o;
 192     }
 193
 194     source_set_state(s, PA_SOURCE_UNLINKED);
 195
 196     s->get_latency = NULL;
 197     s->get_volume = NULL;
 198     s->set_volume = NULL;
 199     s->set_mute = NULL;
 200     s->get_mute = NULL;
 201     s->set_state = NULL;
 202
 203     pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE | PA_SUBSCRIPTION_EVENT_REMOVE, s->index);
 204
 205     pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_UNLINK_POST], s);
 206 }
 207
 208 static void source_free(pa_object *o) {
 209     pa_source_output *so;
 210     pa_source *s = PA_SOURCE(o);
 211
 212     pa_assert(s);
 213     pa_assert(pa_source_refcnt(s) == 0);
 214
 215     if (PA_SOURCE_LINKED(s->state))
 216         pa_source_unlink(s);
 217
 218     pa_log_info("Freeing source %u \"%s\"", s->index, s->name);
 219
 220     pa_idxset_free(s->outputs, NULL, NULL);
 221
 222     while ((so = pa_hashmap_steal_first(s->thread_info.outputs)))
 223         pa_source_output_unref(so);
 224
 225     pa_hashmap_free(s->thread_info.outputs, NULL, NULL);
 226
 227     pa_xfree(s->name);
 228     pa_xfree(s->description);
 229     pa_xfree(s->driver);
 230     pa_xfree(s);
 231 }
 232
 233 int pa_source_update_status(pa_source*s) {
 234     pa_source_assert_ref(s);
 235     pa_assert(PA_SOURCE_LINKED(s->state));
 236
 237     if (s->state == PA_SOURCE_SUSPENDED)
 238         return 0;
 239
 240     return source_set_state(s, pa_source_used_by(s) ? PA_SOURCE_RUNNING : PA_SOURCE_IDLE);
 241 }
 242
 243 int pa_source_suspend(pa_source *s, int suspend) {
 244     pa_source_assert_ref(s);
 245     pa_assert(PA_SOURCE_LINKED(s->state));
 246
 247     if (suspend)
 248         return source_set_state(s, PA_SOURCE_SUSPENDED);
 249     else
 250         return source_set_state(s, pa_source_used_by(s) ? PA_SOURCE_RUNNING : PA_SOURCE_IDLE);
 251 }
 252
 253 void pa_source_ping(pa_source *s) {
 254     pa_source_assert_ref(s);
 255     pa_assert(PA_SOURCE_LINKED(s->state));
 256
 257     pa_asyncmsgq_post(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_PING, NULL, 0, NULL, NULL);
 258 }
 259
 260 void pa_source_post(pa_source*s, const pa_memchunk *chunk) {
 261     pa_source_output *o;
 262     void *state = NULL;
 263
 264     pa_source_assert_ref(s);
 265     pa_assert(PA_SOURCE_OPENED(s->thread_info.state));
 266     pa_assert(chunk);
 267
 268     if (s->thread_info.state != PA_SOURCE_RUNNING)
 269         return;
 270
 271     if (s->thread_info.soft_muted || !pa_cvolume_is_norm(&s->thread_info.soft_volume)) {
 272         pa_memchunk vchunk = *chunk;
 273
 274         pa_memblock_ref(vchunk.memblock);
 275         pa_memchunk_make_writable(&vchunk, 0);
 276
 277         if (s->thread_info.soft_muted || pa_cvolume_is_muted(&s->thread_info.soft_volume))
 278             pa_silence_memchunk(&vchunk, &s->sample_spec);
 279         else
 280             pa_volume_memchunk(&vchunk, &s->sample_spec, &s->thread_info.soft_volume);
 281
 282         while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
 283             pa_source_output_push(o, &vchunk);
 284
 285         pa_memblock_unref(vchunk.memblock);
 286     } else {
 287
 288         while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
 289             pa_source_output_push(o, chunk);
 290     }
 291 }
 292
 293 pa_usec_t pa_source_get_latency(pa_source *s) {
 294     pa_usec_t usec;
 295
 296     pa_source_assert_ref(s);
 297     pa_assert(PA_SOURCE_LINKED(s->state));
 298
 299     if (!PA_SOURCE_OPENED(s->state))
 300         return 0;
 301
 302     if (s->get_latency)
 303         return s->get_latency(s);
 304
 305     if (pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_LATENCY, &usec, 0, NULL) < 0)
 306         return 0;
 307
 308     return usec;
 309 }
 310
 311 void pa_source_set_volume(pa_source *s, const pa_cvolume *volume) {
 312     int changed;
 313
 314     pa_source_assert_ref(s);
 315     pa_assert(PA_SOURCE_LINKED(s->state));
 316     pa_assert(volume);
 317
 318     changed = !pa_cvolume_equal(volume, &s->volume);
 319     s->volume = *volume;
 320
 321     if (s->set_volume && s->set_volume(s) < 0)
 322         s->set_volume = NULL;
 323
 324     if (!s->set_volume)
 325         pa_asyncmsgq_post(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_VOLUME, pa_xnewdup(struct pa_cvolume, volume, 1), 0, NULL, pa_xfree);
 326
 327     if (changed)
 328         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 329 }
 330
 331 const pa_cvolume *pa_source_get_volume(pa_source *s) {
 332     pa_cvolume old_volume;
 333
 334     pa_source_assert_ref(s);
 335     pa_assert(PA_SOURCE_LINKED(s->state));
 336
 337     old_volume = s->volume;
 338
 339     if (s->get_volume && s->get_volume(s) < 0)
 340         s->get_volume = NULL;
 341
 342     if (!s->get_volume && s->refresh_volume)
 343         pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_VOLUME, &s->volume, 0, NULL);
 344
 345     if (!pa_cvolume_equal(&old_volume, &s->volume))
 346         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 347
 348     return &s->volume;
 349 }
 350
 351 void pa_source_set_mute(pa_source *s, int mute) {
 352     int changed;
 353
 354     pa_source_assert_ref(s);
 355     pa_assert(PA_SOURCE_LINKED(s->state));
 356
 357     changed = s->muted != mute;
 358     s->muted = mute;
 359
 360     if (s->set_mute && s->set_mute(s) < 0)
 361         s->set_mute = NULL;
 362
 363     if (!s->set_mute)
 364         pa_asyncmsgq_post(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_MUTE, PA_UINT_TO_PTR(mute), 0, NULL, NULL);
 365
 366     if (changed)
 367         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 368 }
 369
 370 int pa_source_get_mute(pa_source *s) {
 371     int old_muted;
 372
 373     pa_source_assert_ref(s);
 374     pa_assert(PA_SOURCE_LINKED(s->state));
 375
 376     old_muted = s->muted;
 377
 378     if (s->get_mute && s->get_mute(s) < 0)
 379         s->get_mute = NULL;
 380
 381     if (!s->get_mute && s->refresh_muted)
 382         pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_MUTE, &s->muted, 0, NULL);
 383
 384     if (old_muted != s->muted)
 385         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 386
 387     return s->muted;
 388 }
 389
 390 void pa_source_set_module(pa_source *s, pa_module *m) {
 391     pa_source_assert_ref(s);
 392
 393     if (m == s->module)
 394         return;
 395
 396     s->module = m;
 397
 398     pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 399 }
 400
 401 void pa_source_set_description(pa_source *s, const char *description) {
 402     pa_source_assert_ref(s);
 403
 404     if (!description && !s->description)
 405         return;
 406
 407     if (description && s->description && !strcmp(description, s->description))
 408         return;
 409
 410     pa_xfree(s->description);
 411     s->description = pa_xstrdup(description);
 412
 413     pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 414 }
 415
 416 void pa_source_set_asyncmsgq(pa_source *s, pa_asyncmsgq *q) {
 417     pa_source_assert_ref(s);
 418     pa_assert(q);
 419
 420     s->asyncmsgq = q;
 421 }
 422
 423 void pa_source_set_rtpoll(pa_source *s, pa_rtpoll *p) {
 424     pa_source_assert_ref(s);
 425     pa_assert(p);
 426
 427     s->rtpoll = p;
 428 }
 429
 430 unsigned pa_source_linked_by(pa_source *s) {
 431     pa_source_assert_ref(s);
 432     pa_assert(PA_SOURCE_LINKED(s->state));
 433
 434     return pa_idxset_size(s->outputs);
 435 }
 436
 437 unsigned pa_source_used_by(pa_source *s) {
 438     unsigned ret;
 439
 440     pa_source_assert_ref(s);
 441     pa_assert(PA_SOURCE_LINKED(s->state));
 442
 443     ret = pa_idxset_size(s->outputs);
 444     pa_assert(ret >= s->n_corked);
 445
 446     return ret - s->n_corked;
 447 }
 448
 449 int pa_source_process_msg(pa_msgobject *object, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
 450     pa_source *s = PA_SOURCE(object);
 451     pa_source_assert_ref(s);
 452     pa_assert(PA_SOURCE_LINKED(s->thread_info.state));
 453
 454     switch ((pa_source_message_t) code) {
 455         case PA_SOURCE_MESSAGE_ADD_OUTPUT: {
 456             pa_source_output *o = PA_SOURCE_OUTPUT(userdata);
 457             pa_hashmap_put(s->thread_info.outputs, PA_UINT32_TO_PTR(o->index), pa_source_output_ref(o));
 458
 459             if (o->attach)
 460                 o->attach(o);
 461
 462             return 0;
 463         }
 464
 465         case PA_SOURCE_MESSAGE_REMOVE_OUTPUT: {
 466             pa_source_output *o = PA_SOURCE_OUTPUT(userdata);
 467
 468             if (o->detach)
 469                 o->detach(o);
 470
 471             if (pa_hashmap_remove(s->thread_info.outputs, PA_UINT32_TO_PTR(o->index)))
 472                 pa_source_output_unref(o);
 473
 474             return 0;
 475         }
 476
 477         case PA_SOURCE_MESSAGE_SET_VOLUME:
 478             s->thread_info.soft_volume = *((pa_cvolume*) userdata);
 479             return 0;
 480
 481         case PA_SOURCE_MESSAGE_SET_MUTE:
 482             s->thread_info.soft_muted = PA_PTR_TO_UINT(userdata);
 483             return 0;
 484
 485         case PA_SOURCE_MESSAGE_GET_VOLUME:
 486             *((pa_cvolume*) userdata) = s->thread_info.soft_volume;
 487             return 0;
 488
 489         case PA_SOURCE_MESSAGE_GET_MUTE:
 490             *((int*) userdata) = s->thread_info.soft_muted;
 491             return 0;
 492
 493         case PA_SOURCE_MESSAGE_PING:
 494             return 0;
 495
 496         case PA_SOURCE_MESSAGE_SET_STATE:
 497             s->thread_info.state = PA_PTR_TO_UINT(userdata);
 498             return 0;
 499
 500         case PA_SOURCE_MESSAGE_DETACH:
 501
 502             /* We're detaching all our output streams so that the
 503              * asyncmsgq and rtpoll fields can be changed without
 504              * problems */
 505             pa_source_detach_within_thread(s);
 506             break;
 507
 508         case PA_SOURCE_MESSAGE_ATTACH:
 509
 510             /* Reattach all streams */
 511             pa_source_attach_within_thread(s);
 512             break;
 513
 514         case PA_SOURCE_MESSAGE_GET_LATENCY:
 515         case PA_SOURCE_MESSAGE_MAX:
 516             ;
 517     }
 518
 519     return -1;
 520 }
 521
 522 int pa_source_suspend_all(pa_core *c, int suspend) {
 523     uint32_t idx;
 524     pa_source *source;
 525     int ret = 0;
 526
 527     pa_core_assert_ref(c);
 528
 529     for (source = PA_SOURCE(pa_idxset_first(c->sources, &idx)); source; source = PA_SOURCE(pa_idxset_next(c->sources, &idx)))
 530         ret -= pa_source_suspend(source, suspend) < 0;
 531
 532     return ret;
 533 }
 534
 535 void pa_source_detach(pa_source *s) {
 536     pa_source_assert_ref(s);
 537     pa_assert(PA_SOURCE_LINKED(s->state));
 538
 539     pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_DETACH, NULL, 0, NULL);
 540 }
 541
 542 void pa_source_attach(pa_source *s) {
 543     pa_source_assert_ref(s);
 544     pa_assert(PA_SOURCE_LINKED(s->state));
 545
 546     pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_ATTACH, NULL, 0, NULL);
 547 }
 548
 549 void pa_source_detach_within_thread(pa_source *s) {
 550     pa_source_output *o;
 551     void *state = NULL;
 552
 553     pa_source_assert_ref(s);
 554     pa_assert(PA_SOURCE_LINKED(s->thread_info.state));
 555
 556     while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
 557         if (o->detach)
 558             o->detach(o);
 559 }
 560
 561 void pa_source_attach_within_thread(pa_source *s) {
 562     pa_source_output *o;
 563     void *state = NULL;
 564
 565     pa_source_assert_ref(s);
 566     pa_assert(PA_SOURCE_LINKED(s->thread_info.state));
 567
 568     while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
 569         if (o->attach)
 570             o->attach(o);
 571
 572 }