src/pulsecore/card.c

   1 /***
   2   This file is part of PulseAudio.
   3
   4   Copyright 2009 Lennart Poettering
   5
   6   PulseAudio is free software; you can redistribute it and/or modify
   7   it under the terms of the GNU Lesser General Public License as published
   8   by the Free Software Foundation; either version 2.1 of the License,
   9   or (at your option) any later version.
  10
  11   PulseAudio is distributed in the hope that it will be useful, but
  12   WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14   General Public License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public License
  17   along with PulseAudio; if not, write to the Free Software
  18   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  19   USA.
  20 ***/
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include <config.h>
  24 #endif
  25
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29
  30 #include <pulse/xmalloc.h>
  31 #include <pulse/util.h>
  32
  33 #include <pulsecore/log.h>
  34 #include <pulsecore/macro.h>
  35 #include <pulsecore/core-util.h>
  36 #include <pulsecore/namereg.h>
  37 #include <pulsecore/device-port.h>
  38
  39 #include "card.h"
  40
  41 pa_card_profile *pa_card_profile_new(const char *name, const char *description, size_t extra) {
  42     pa_card_profile *c;
  43
  44     pa_assert(name);
  45
  46     c = pa_xmalloc(PA_ALIGN(sizeof(pa_card_profile)) + extra);
  47     c->card = NULL;
  48     c->name = pa_xstrdup(name);
  49     c->description = pa_xstrdup(description);
  50
  51     c->priority = 0;
  52     c->n_sinks = c->n_sources = 0;
  53     c->max_sink_channels = c->max_source_channels = 0;
  54     c->available = PA_AVAILABLE_UNKNOWN;
  55
  56     return c;
  57 }
  58
  59 void pa_card_profile_free(pa_card_profile *c) {
  60     pa_assert(c);
  61
  62     pa_xfree(c->name);
  63     pa_xfree(c->description);
  64     pa_xfree(c);
  65 }
  66
  67 void pa_card_profile_set_available(pa_card_profile *c, pa_available_t available) {
  68     pa_core *core;
  69
  70     pa_assert(c);
  71     pa_assert(c->card); /* Modify member variable directly during creation instead of using this function */
  72
  73     if (c->available == available)
  74         return;
  75
  76     c->available = available;
  77     pa_log_debug("Setting card %s profile %s to availability status %s", c->card->name, c->name,
  78                  available == PA_AVAILABLE_YES ? "yes" : available == PA_AVAILABLE_NO ? "no" : "unknown");
  79
  80     /* Post subscriptions to the card which owns us */
  81     pa_assert_se(core = c->card->core);
  82     pa_subscription_post(core, PA_SUBSCRIPTION_EVENT_CARD|PA_SUBSCRIPTION_EVENT_CHANGE, c->card->index);
  83
  84     pa_hook_fire(&core->hooks[PA_CORE_HOOK_CARD_PROFILE_AVAILABLE_CHANGED], c);
  85 }
  86
  87 pa_card_new_data* pa_card_new_data_init(pa_card_new_data *data) {
  88     pa_assert(data);
  89
  90     memset(data, 0, sizeof(*data));
  91     data->proplist = pa_proplist_new();
  92     data->profiles = pa_hashmap_new_full(pa_idxset_string_hash_func, pa_idxset_string_compare_func, NULL, (pa_free_cb_t) pa_card_profile_free);
  93     data->ports = pa_hashmap_new_full(pa_idxset_string_hash_func, pa_idxset_string_compare_func, NULL, (pa_free_cb_t) pa_device_port_unref);
  94     return data;
  95 }
  96
  97 void pa_card_new_data_set_name(pa_card_new_data *data, const char *name) {
  98     pa_assert(data);
  99
 100     pa_xfree(data->name);
 101     data->name = pa_xstrdup(name);
 102 }
 103
 104 void pa_card_new_data_set_profile(pa_card_new_data *data, const char *profile) {
 105     pa_assert(data);
 106
 107     pa_xfree(data->active_profile);
 108     data->active_profile = pa_xstrdup(profile);
 109 }
 110
 111 void pa_card_new_data_done(pa_card_new_data *data) {
 112
 113     pa_assert(data);
 114
 115     pa_proplist_free(data->proplist);
 116
 117     if (data->profiles)
 118         pa_hashmap_free(data->profiles);
 119
 120     if (data->ports)
 121         pa_hashmap_free(data->ports);
 122
 123     pa_xfree(data->name);
 124     pa_xfree(data->active_profile);
 125 }
 126
 127 pa_card *pa_card_new(pa_core *core, pa_card_new_data *data) {
 128     pa_card *c;
 129     const char *name;
 130     void *state;
 131     pa_card_profile *profile;
 132     pa_device_port *port;
 133
 134     pa_core_assert_ref(core);
 135     pa_assert(data);
 136     pa_assert(data->name);
 137     pa_assert(data->profiles);
 138     pa_assert(!pa_hashmap_isempty(data->profiles));
 139
 140     c = pa_xnew(pa_card, 1);
 141
 142     if (!(name = pa_namereg_register(core, data->name, PA_NAMEREG_CARD, c, data->namereg_fail))) {
 143         pa_xfree(c);
 144         return NULL;
 145     }
 146
 147     pa_card_new_data_set_name(data, name);
 148
 149     if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_CARD_NEW], data) < 0) {
 150         pa_xfree(c);
 151         pa_namereg_unregister(core, name);
 152         return NULL;
 153     }
 154
 155     c->core = core;
 156     c->name = pa_xstrdup(data->name);
 157     c->proplist = pa_proplist_copy(data->proplist);
 158     c->driver = pa_xstrdup(pa_path_get_filename(data->driver));
 159     c->module = data->module;
 160
 161     c->sinks = pa_idxset_new(NULL, NULL);
 162     c->sources = pa_idxset_new(NULL, NULL);
 163
 164     /* As a minor optimization we just steal the list instead of
 165      * copying it here */
 166     pa_assert_se(c->profiles = data->profiles);
 167     data->profiles = NULL;
 168     pa_assert_se(c->ports = data->ports);
 169     data->ports = NULL;
 170
 171     PA_HASHMAP_FOREACH(profile, c->profiles, state)
 172         profile->card = c;
 173
 174     PA_HASHMAP_FOREACH(port, c->ports, state)
 175         port->card = c;
 176
 177     c->active_profile = NULL;
 178     c->save_profile = false;
 179
 180     if (data->active_profile)
 181         if ((c->active_profile = pa_hashmap_get(c->profiles, data->active_profile)))
 182             c->save_profile = data->save_profile;
 183
 184     if (!c->active_profile) {
 185         PA_HASHMAP_FOREACH(profile, c->profiles, state) {
 186             if (profile->available == PA_AVAILABLE_NO)
 187                 continue;
 188
 189             if (!c->active_profile || profile->priority > c->active_profile->priority)
 190                 c->active_profile = profile;
 191         }
 192         /* If all profiles are not available, then we still need to pick one */
 193         if (!c->active_profile) {
 194             PA_HASHMAP_FOREACH(profile, c->profiles, state)
 195                 if (!c->active_profile || profile->priority > c->active_profile->priority)
 196                     c->active_profile = profile;
 197         }
 198         pa_assert(c->active_profile);
 199     }
 200
 201     c->userdata = NULL;
 202     c->set_profile = NULL;
 203
 204     pa_device_init_description(c->proplist);
 205     pa_device_init_icon(c->proplist, true);
 206     pa_device_init_intended_roles(c->proplist);
 207
 208     pa_assert_se(pa_idxset_put(core->cards, c, &c->index) >= 0);
 209
 210     pa_log_info("Created %u \"%s\"", c->index, c->name);
 211     pa_subscription_post(core, PA_SUBSCRIPTION_EVENT_CARD|PA_SUBSCRIPTION_EVENT_NEW, c->index);
 212
 213     pa_hook_fire(&core->hooks[PA_CORE_HOOK_CARD_PUT], c);
 214     return c;
 215 }
 216
 217 void pa_card_free(pa_card *c) {
 218     pa_core *core;
 219
 220     pa_assert(c);
 221     pa_assert(c->core);
 222
 223     core = c->core;
 224
 225     pa_hook_fire(&core->hooks[PA_CORE_HOOK_CARD_UNLINK], c);
 226
 227     pa_namereg_unregister(core, c->name);
 228
 229     pa_idxset_remove_by_data(c->core->cards, c, NULL);
 230
 231     pa_log_info("Freed %u \"%s\"", c->index, c->name);
 232
 233     pa_subscription_post(c->core, PA_SUBSCRIPTION_EVENT_CARD|PA_SUBSCRIPTION_EVENT_REMOVE, c->index);
 234
 235     pa_assert(pa_idxset_isempty(c->sinks));
 236     pa_idxset_free(c->sinks, NULL);
 237     pa_assert(pa_idxset_isempty(c->sources));
 238     pa_idxset_free(c->sources, NULL);
 239
 240     pa_hashmap_free(c->ports);
 241
 242     if (c->profiles)
 243         pa_hashmap_free(c->profiles);
 244
 245     pa_proplist_free(c->proplist);
 246     pa_xfree(c->driver);
 247     pa_xfree(c->name);
 248     pa_xfree(c);
 249 }
 250
 251 void pa_card_add_profile(pa_card *c, pa_card_profile *profile) {
 252     pa_assert(c);
 253     pa_assert(profile);
 254
 255     /* take ownership of the profile */
 256     pa_assert_se(pa_hashmap_put(c->profiles, profile->name, profile) >= 0);
 257     profile->card = c;
 258
 259     pa_subscription_post(c->core, PA_SUBSCRIPTION_EVENT_CARD|PA_SUBSCRIPTION_EVENT_CHANGE, c->index);
 260
 261     pa_hook_fire(&c->core->hooks[PA_CORE_HOOK_CARD_PROFILE_ADDED], profile);
 262 }
 263
 264 int pa_card_set_profile(pa_card *c, pa_card_profile *profile, bool save) {
 265     int r;
 266
 267     pa_assert(c);
 268     pa_assert(profile);
 269     pa_assert(profile->card == c);
 270
 271     if (!c->set_profile) {
 272         pa_log_debug("set_profile() operation not implemented for card %u \"%s\"", c->index, c->name);
 273         return -PA_ERR_NOTIMPLEMENTED;
 274     }
 275
 276     if (c->active_profile == profile) {
 277         c->save_profile = c->save_profile || save;
 278         return 0;
 279     }
 280
 281     if ((r = c->set_profile(c, profile)) < 0)
 282         return r;
 283
 284     pa_subscription_post(c->core, PA_SUBSCRIPTION_EVENT_CARD|PA_SUBSCRIPTION_EVENT_CHANGE, c->index);
 285
 286     pa_log_info("Changed profile of card %u \"%s\" to %s", c->index, c->name, profile->name);
 287
 288     c->active_profile = profile;
 289     c->save_profile = save;
 290
 291     pa_hook_fire(&c->core->hooks[PA_CORE_HOOK_CARD_PROFILE_CHANGED], c);
 292
 293     return 0;
 294 }
 295
 296 int pa_card_suspend(pa_card *c, bool suspend, pa_suspend_cause_t cause) {
 297     pa_sink *sink;
 298     pa_source *source;
 299     uint32_t idx;
 300     int ret = 0;
 301
 302     pa_assert(c);
 303     pa_assert(cause != 0);
 304
 305     PA_IDXSET_FOREACH(sink, c->sinks, idx) {
 306         int r;
 307
 308         if ((r = pa_sink_suspend(sink, suspend, cause)) < 0)
 309             ret = r;
 310     }
 311
 312     PA_IDXSET_FOREACH(source, c->sources, idx) {
 313         int r;
 314
 315         if ((r = pa_source_suspend(source, suspend, cause)) < 0)
 316             ret = r;
 317     }
 318
 319     return ret;
 320 }