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->monitor_of = NULL;
  97
  98     pa_cvolume_reset(&s->volume, spec->channels);
  99     s->muted = 0;
 100     s->refresh_volume = s->refresh_muted = 0;
 101
 102     s->get_latency = NULL;
 103     s->set_volume = NULL;
 104     s->get_volume = NULL;
 105     s->set_mute = NULL;
 106     s->get_mute = NULL;
 107     s->set_state = NULL;
 108     s->userdata = NULL;
 109
 110     s->asyncmsgq = NULL;
 111     s->rtpoll = NULL;
 112
 113     pa_assert_se(pa_idxset_put(core->sources, s, &s->index) >= 0);
 114
 115     pa_sample_spec_snprint(st, sizeof(st), spec);
 116     pa_log_info("Created source %u \"%s\" with sample spec \"%s\"", s->index, s->name, st);
 117
 118     s->thread_info.outputs = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
 119     s->thread_info.soft_volume = s->volume;
 120     s->thread_info.soft_muted = s->muted;
 121     s->thread_info.state = s->state;
 122
 123     return s;
 124 }
 125
 126 void pa_source_put(pa_source *s) {
 127     pa_source_assert_ref(s);
 128
 129     pa_assert(s->state == PA_SINK_INIT);
 130     pa_assert(s->rtpoll);
 131     pa_assert(s->asyncmsgq);
 132
 133     s->thread_info.state = s->state = PA_SOURCE_IDLE;
 134
 135     pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE | PA_SUBSCRIPTION_EVENT_NEW, s->index);
 136     pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_NEW_POST], s);
 137 }
 138
 139 static int source_set_state(pa_source *s, pa_source_state_t state) {
 140     int ret;
 141
 142     pa_assert(s);
 143
 144     if (s->state == state)
 145         return 0;
 146
 147     if (state == PA_SOURCE_SUSPENDED && !(s->flags & PA_SOURCE_CAN_SUSPEND))
 148         return -1;
 149
 150     if ((s->state == PA_SOURCE_SUSPENDED && PA_SOURCE_OPENED(state)) ||
 151         (PA_SOURCE_OPENED(s->state) && state == PA_SOURCE_SUSPENDED)) {
 152         pa_source_output *o;
 153         uint32_t idx;
 154
 155         /* We're suspending or resuming, tell everyone about it */
 156
 157         for (o = PA_SOURCE_OUTPUT(pa_idxset_first(s->outputs, &idx)); o; o = PA_SOURCE_OUTPUT(pa_idxset_next(s->outputs, &idx)))
 158             if (o->suspend)
 159                 o->suspend(o, state == PA_SINK_SUSPENDED);
 160     }
 161
 162     if (s->set_state)
 163         if ((ret = s->set_state(s, state)) < 0)
 164             return -1;
 165
 166     if (pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL) < 0)
 167         return -1;
 168
 169     s->state = state;
 170
 171     if (state != PA_SOURCE_UNLINKED) /* if we enter UNLINKED state pa_source_unlink() will fire the apropriate events */
 172         pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_STATE_CHANGED], s);
 173     return 0;
 174 }
 175
 176 void pa_source_unlink(pa_source *s) {
 177     pa_source_output *o, *j = NULL;
 178
 179     pa_assert(s);
 180     pa_assert(PA_SOURCE_LINKED(s->state));
 181
 182     pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_UNLINK], s);
 183
 184     pa_namereg_unregister(s->core, s->name);
 185     pa_idxset_remove_by_data(s->core->sources, s, NULL);
 186
 187     while ((o = pa_idxset_first(s->outputs, NULL))) {
 188         pa_assert(o != j);
 189         pa_source_output_kill(o);
 190         j = o;
 191     }
 192
 193     source_set_state(s, PA_SOURCE_UNLINKED);
 194
 195     s->get_latency = NULL;
 196     s->get_volume = NULL;
 197     s->set_volume = NULL;
 198     s->set_mute = NULL;
 199     s->get_mute = NULL;
 200     s->set_state = NULL;
 201
 202     pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE | PA_SUBSCRIPTION_EVENT_REMOVE, s->index);
 203
 204     pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_UNLINK_POST], s);
 205 }
 206
 207 static void source_free(pa_object *o) {
 208     pa_source_output *so;
 209     pa_source *s = PA_SOURCE(o);
 210
 211     pa_assert(s);
 212     pa_assert(pa_source_refcnt(s) == 0);
 213
 214     if (PA_SOURCE_LINKED(s->state))
 215         pa_source_unlink(s);
 216
 217     pa_log_info("Freeing source %u \"%s\"", s->index, s->name);
 218
 219     pa_idxset_free(s->outputs, NULL, NULL);
 220
 221     while ((so = pa_hashmap_steal_first(s->thread_info.outputs)))
 222         pa_source_output_unref(so);
 223
 224     pa_hashmap_free(s->thread_info.outputs, NULL, NULL);
 225
 226     pa_xfree(s->name);
 227     pa_xfree(s->description);
 228     pa_xfree(s->driver);
 229     pa_xfree(s);
 230 }
 231
 232 int pa_source_update_status(pa_source*s) {
 233     pa_source_assert_ref(s);
 234     pa_assert(PA_SOURCE_LINKED(s->state));
 235
 236     if (s->state == PA_SOURCE_SUSPENDED)
 237         return 0;
 238
 239     return source_set_state(s, pa_source_used_by(s) ? PA_SOURCE_RUNNING : PA_SOURCE_IDLE);
 240 }
 241
 242 int pa_source_suspend(pa_source *s, int suspend) {
 243     pa_source_assert_ref(s);
 244     pa_assert(PA_SOURCE_LINKED(s->state));
 245
 246     if (suspend)
 247         return source_set_state(s, PA_SOURCE_SUSPENDED);
 248     else
 249         return source_set_state(s, pa_source_used_by(s) ? PA_SOURCE_RUNNING : PA_SOURCE_IDLE);
 250 }
 251
 252 void pa_source_ping(pa_source *s) {
 253     pa_source_assert_ref(s);
 254     pa_assert(PA_SOURCE_LINKED(s->state));
 255
 256     pa_asyncmsgq_post(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_PING, NULL, 0, NULL, NULL);
 257 }
 258
 259 void pa_source_post(pa_source*s, const pa_memchunk *chunk) {
 260     pa_source_output *o;
 261     void *state = NULL;
 262
 263     pa_source_assert_ref(s);
 264     pa_assert(PA_SOURCE_OPENED(s->thread_info.state));
 265     pa_assert(chunk);
 266
 267     if (s->thread_info.state != PA_SOURCE_RUNNING)
 268         return;
 269
 270     if (s->thread_info.soft_muted || !pa_cvolume_is_norm(&s->thread_info.soft_volume)) {
 271         pa_memchunk vchunk = *chunk;
 272
 273         pa_memblock_ref(vchunk.memblock);
 274         pa_memchunk_make_writable(&vchunk, 0);
 275
 276         if (s->thread_info.soft_muted || pa_cvolume_is_muted(&s->thread_info.soft_volume))
 277             pa_silence_memchunk(&vchunk, &s->sample_spec);
 278         else
 279             pa_volume_memchunk(&vchunk, &s->sample_spec, &s->thread_info.soft_volume);
 280
 281         while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
 282             pa_source_output_push(o, &vchunk);
 283
 284         pa_memblock_unref(vchunk.memblock);
 285     } else {
 286
 287         while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
 288             pa_source_output_push(o, chunk);
 289     }
 290 }
 291
 292 pa_usec_t pa_source_get_latency(pa_source *s) {
 293     pa_usec_t usec;
 294
 295     pa_source_assert_ref(s);
 296     pa_assert(PA_SOURCE_LINKED(s->state));
 297
 298     if (!PA_SOURCE_OPENED(s->state))
 299         return 0;
 300
 301     if (s->get_latency)
 302         return s->get_latency(s);
 303
 304     if (pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_LATENCY, &usec, 0, NULL) < 0)
 305         return 0;
 306
 307     return usec;
 308 }
 309
 310 void pa_source_set_volume(pa_source *s, const pa_cvolume *volume) {
 311     int changed;
 312
 313     pa_source_assert_ref(s);
 314     pa_assert(PA_SOURCE_LINKED(s->state));
 315     pa_assert(volume);
 316
 317     changed = !pa_cvolume_equal(volume, &s->volume);
 318     s->volume = *volume;
 319
 320     if (s->set_volume && s->set_volume(s) < 0)
 321         s->set_volume = NULL;
 322
 323     if (!s->set_volume)
 324         pa_asyncmsgq_post(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_VOLUME, pa_xnewdup(struct pa_cvolume, volume, 1), 0, NULL, pa_xfree);
 325
 326     if (changed)
 327         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 328 }
 329
 330 const pa_cvolume *pa_source_get_volume(pa_source *s) {
 331     pa_cvolume old_volume;
 332
 333     pa_source_assert_ref(s);
 334     pa_assert(PA_SOURCE_LINKED(s->state));
 335
 336     old_volume = s->volume;
 337
 338     if (s->get_volume && s->get_volume(s) < 0)
 339         s->get_volume = NULL;
 340
 341     if (!s->get_volume && s->refresh_volume)
 342         pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_VOLUME, &s->volume, 0, NULL);
 343
 344     if (!pa_cvolume_equal(&old_volume, &s->volume))
 345         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 346
 347     return &s->volume;
 348 }
 349
 350 void pa_source_set_mute(pa_source *s, int mute) {
 351     int changed;
 352
 353     pa_source_assert_ref(s);
 354     pa_assert(PA_SOURCE_LINKED(s->state));
 355
 356     changed = s->muted != mute;
 357     s->muted = mute;
 358
 359     if (s->set_mute && s->set_mute(s) < 0)
 360         s->set_mute = NULL;
 361
 362     if (!s->set_mute)
 363         pa_asyncmsgq_post(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_MUTE, PA_UINT_TO_PTR(mute), 0, NULL, NULL);
 364
 365     if (changed)
 366         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 367 }
 368
 369 int pa_source_get_mute(pa_source *s) {
 370     int old_muted;
 371
 372     pa_source_assert_ref(s);
 373     pa_assert(PA_SOURCE_LINKED(s->state));
 374
 375     old_muted = s->muted;
 376
 377     if (s->get_mute && s->get_mute(s) < 0)
 378         s->get_mute = NULL;
 379
 380     if (!s->get_mute && s->refresh_muted)
 381         pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_MUTE, &s->muted, 0, NULL);
 382
 383     if (old_muted != s->muted)
 384         pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 385
 386     return s->muted;
 387 }
 388
 389 void pa_source_set_module(pa_source *s, pa_module *m) {
 390     pa_source_assert_ref(s);
 391
 392     if (m == s->module)
 393         return;
 394
 395     s->module = m;
 396
 397     pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 398 }
 399
 400 void pa_source_set_description(pa_source *s, const char *description) {
 401     pa_source_assert_ref(s);
 402
 403     if (!description && !s->description)
 404         return;
 405
 406     if (description && s->description && !strcmp(description, s->description))
 407         return;
 408
 409     pa_xfree(s->description);
 410     s->description = pa_xstrdup(description);
 411
 412     pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
 413 }
 414
 415 void pa_source_set_asyncmsgq(pa_source *s, pa_asyncmsgq *q) {
 416     pa_source_assert_ref(s);
 417     pa_assert(q);
 418
 419     s->asyncmsgq = q;
 420 }
 421
 422 void pa_source_set_rtpoll(pa_source *s, pa_rtpoll *p) {
 423     pa_source_assert_ref(s);
 424     pa_assert(p);
 425
 426     s->rtpoll = p;
 427 }
 428
 429 unsigned pa_source_used_by(pa_source *s) {
 430     pa_source_assert_ref(s);
 431     pa_assert(PA_SOURCE_LINKED(s->state));
 432
 433     return pa_idxset_size(s->outputs);
 434 }
 435
 436 int pa_source_process_msg(pa_msgobject *object, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
 437     pa_source *s = PA_SOURCE(object);
 438     pa_source_assert_ref(s);
 439     pa_assert(PA_SOURCE_LINKED(s->thread_info.state));
 440
 441     switch ((pa_source_message_t) code) {
 442         case PA_SOURCE_MESSAGE_ADD_OUTPUT: {
 443             pa_source_output *o = PA_SOURCE_OUTPUT(userdata);
 444             pa_hashmap_put(s->thread_info.outputs, PA_UINT32_TO_PTR(o->index), pa_source_output_ref(o));
 445
 446             if (o->attach)
 447                 o->attach(o);
 448
 449             return 0;
 450         }
 451
 452         case PA_SOURCE_MESSAGE_REMOVE_OUTPUT: {
 453             pa_source_output *o = PA_SOURCE_OUTPUT(userdata);
 454
 455             if (o->detach)
 456                 o->detach(o);
 457
 458             if (pa_hashmap_remove(s->thread_info.outputs, PA_UINT32_TO_PTR(o->index)))
 459                 pa_source_output_unref(o);
 460
 461             return 0;
 462         }
 463
 464         case PA_SOURCE_MESSAGE_SET_VOLUME:
 465             s->thread_info.soft_volume = *((pa_cvolume*) userdata);
 466             return 0;
 467
 468         case PA_SOURCE_MESSAGE_SET_MUTE:
 469             s->thread_info.soft_muted = PA_PTR_TO_UINT(userdata);
 470             return 0;
 471
 472         case PA_SOURCE_MESSAGE_GET_VOLUME:
 473             *((pa_cvolume*) userdata) = s->thread_info.soft_volume;
 474             return 0;
 475
 476         case PA_SOURCE_MESSAGE_GET_MUTE:
 477             *((int*) userdata) = s->thread_info.soft_muted;
 478             return 0;
 479
 480         case PA_SOURCE_MESSAGE_PING:
 481             return 0;
 482
 483         case PA_SOURCE_MESSAGE_SET_STATE:
 484             s->thread_info.state = PA_PTR_TO_UINT(userdata);
 485             return 0;
 486
 487         case PA_SOURCE_MESSAGE_GET_LATENCY:
 488         case PA_SOURCE_MESSAGE_MAX:
 489             ;
 490     }
 491
 492     return -1;
 493 }
 494
 495 int pa_source_suspend_all(pa_core *c, int suspend) {
 496     uint32_t idx;
 497     pa_source *source;
 498     int ret = 0;
 499
 500     pa_core_assert_ref(c);
 501
 502     for (source = PA_SOURCE(pa_idxset_first(c->sources, &idx)); source; source = PA_SOURCE(pa_idxset_next(c->sources, &idx)))
 503         ret -= pa_source_suspend(source, suspend) < 0;
 504
 505     return ret;
 506 }