src/modules/module-intended-roles.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 <pulse/xmalloc.h>
  27 #include <pulse/volume.h>
  28 #include <pulse/timeval.h>
  29 #include <pulse/util.h>
  30
  31 #include <pulsecore/core-error.h>
  32 #include <pulsecore/module.h>
  33 #include <pulsecore/core-util.h>
  34 #include <pulsecore/modargs.h>
  35 #include <pulsecore/log.h>
  36 #include <pulsecore/core-subscribe.h>
  37 #include <pulsecore/sink-input.h>
  38 #include <pulsecore/source-output.h>
  39 #include <pulsecore/namereg.h>
  40
  41 #include "module-intended-roles-symdef.h"
  42
  43 PA_MODULE_AUTHOR("Lennart Poettering");
  44 PA_MODULE_DESCRIPTION("Automatically set device of streams based of intended roles of devices");
  45 PA_MODULE_VERSION(PACKAGE_VERSION);
  46 PA_MODULE_LOAD_ONCE(TRUE);
  47 PA_MODULE_USAGE(
  48         "on_hotplug=<When new device becomes available, recheck streams?> "
  49         "on_rescue=<When device becomes unavailable, recheck streams?>");
  50
  51 static const char* const valid_modargs[] = {
  52     "on_hotplug",
  53     "on_rescue",
  54     NULL
  55 };
  56
  57 struct userdata {
  58     pa_core *core;
  59     pa_module *module;
  60
  61     pa_hook_slot
  62         *sink_input_new_hook_slot,
  63         *source_output_new_hook_slot,
  64         *sink_put_hook_slot,
  65         *source_put_hook_slot,
  66         *sink_unlink_hook_slot,
  67         *source_unlink_hook_slot;
  68
  69     pa_bool_t on_hotplug:1;
  70     pa_bool_t on_rescue:1;
  71 };
  72
  73 static pa_bool_t role_match(pa_proplist *proplist, const char *role) {
  74     const char *ir;
  75     char *r;
  76     const char *state = NULL;
  77
  78     if (!(ir = pa_proplist_gets(proplist, PA_PROP_DEVICE_INTENDED_ROLES)))
  79         return FALSE;
  80
  81     while ((r = pa_split_spaces(ir, &state))) {
  82
  83         if (pa_streq(role, r)) {
  84             pa_xfree(r);
  85             return TRUE;
  86         }
  87
  88         pa_xfree(r);
  89     }
  90
  91     return FALSE;
  92 }
  93
  94 static pa_hook_result_t sink_input_new_hook_callback(pa_core *c, pa_sink_input_new_data *new_data, struct userdata *u) {
  95     const char *role;
  96     pa_sink *s, *def;
  97     uint32_t idx;
  98
  99     pa_assert(c);
 100     pa_assert(new_data);
 101     pa_assert(u);
 102
 103     if (!new_data->proplist) {
 104         pa_log_debug("New stream lacks property data.");
 105         return PA_HOOK_OK;
 106     }
 107
 108     if (new_data->sink) {
 109         pa_log_debug("Not setting device for stream %s, because already set.", pa_strnull(pa_proplist_gets(new_data->proplist, PA_PROP_MEDIA_NAME)));
 110         return PA_HOOK_OK;
 111     }
 112
 113     if (!(role = pa_proplist_gets(new_data->proplist, PA_PROP_MEDIA_ROLE))) {
 114         pa_log_debug("Not setting device for stream %s, because it lacks role.", pa_strnull(pa_proplist_gets(new_data->proplist, PA_PROP_MEDIA_NAME)));
 115         return PA_HOOK_OK;
 116     }
 117
 118     /* Prefer the default sink over any other sink, just in case... */
 119     if ((def = pa_namereg_get_default_sink(c)))
 120         if (role_match(def->proplist, role)) {
 121             new_data->sink = def;
 122             new_data->save_sink = FALSE;
 123             return PA_HOOK_OK;
 124         }
 125
 126     PA_IDXSET_FOREACH(s, c->sinks, idx) {
 127         if (s == def)
 128             continue;
 129
 130         if (!PA_SINK_IS_LINKED(pa_sink_get_state(s)))
 131             continue;
 132
 133         if (role_match(s->proplist, role)) {
 134             new_data->sink = s;
 135             new_data->save_sink = FALSE;
 136             return PA_HOOK_OK;
 137         }
 138     }
 139
 140     return PA_HOOK_OK;
 141 }
 142
 143 static pa_hook_result_t source_output_new_hook_callback(pa_core *c, pa_source_output_new_data *new_data, struct userdata *u) {
 144     const char *role;
 145     pa_source *s, *def;
 146     uint32_t idx;
 147
 148     pa_assert(c);
 149     pa_assert(new_data);
 150     pa_assert(u);
 151
 152     if (!new_data->proplist) {
 153         pa_log_debug("New stream lacks property data.");
 154         return PA_HOOK_OK;
 155     }
 156
 157     if (new_data->source) {
 158         pa_log_debug("Not setting device for stream %s, because already set.", pa_strnull(pa_proplist_gets(new_data->proplist, PA_PROP_MEDIA_NAME)));
 159         return PA_HOOK_OK;
 160     }
 161
 162     if (!(role = pa_proplist_gets(new_data->proplist, PA_PROP_MEDIA_ROLE))) {
 163         pa_log_debug("Not setting device for stream %s, because it lacks role.", pa_strnull(pa_proplist_gets(new_data->proplist, PA_PROP_MEDIA_NAME)));
 164         return PA_HOOK_OK;
 165     }
 166
 167     /* Prefer the default source over any other source, just in case... */
 168     if ((def = pa_namereg_get_default_source(c)))
 169         if (role_match(def->proplist, role)) {
 170             new_data->source = def;
 171             new_data->save_source = FALSE;
 172             return PA_HOOK_OK;
 173         }
 174
 175     PA_IDXSET_FOREACH(s, c->sources, idx) {
 176         if (s == def)
 177             continue;
 178
 179         if (!PA_SOURCE_IS_LINKED(pa_source_get_state(s)))
 180             continue;
 181
 182         if (role_match(s->proplist, role)) {
 183             new_data->source = s;
 184             new_data->save_source = FALSE;
 185             return PA_HOOK_OK;
 186         }
 187     }
 188
 189     return PA_HOOK_OK;
 190 }
 191
 192 static pa_hook_result_t sink_put_hook_callback(pa_core *c, pa_sink *sink, struct userdata *u) {
 193     pa_sink_input *si;
 194     uint32_t idx;
 195
 196     pa_assert(c);
 197     pa_assert(sink);
 198     pa_assert(u);
 199     pa_assert(u->on_hotplug);
 200
 201     PA_IDXSET_FOREACH(si, c->sink_inputs, idx) {
 202         const char *role;
 203
 204         if (si->sink == sink)
 205             continue;
 206
 207         if (si->save_sink)
 208             continue;
 209
 210         /* Skip this if it is already in the process of being moved
 211          * anyway */
 212         if (!si->sink)
 213             continue;
 214
 215         /* It might happen that a stream and a sink are set up at the
 216            same time, in which case we want to make sure we don't
 217            interfere with that */
 218         if (!PA_SINK_INPUT_IS_LINKED(pa_sink_input_get_state(si)))
 219             continue;
 220
 221         if (!(role = pa_proplist_gets(si->proplist, PA_PROP_MEDIA_ROLE)))
 222             continue;
 223
 224         if (role_match(si->sink->proplist, role))
 225             continue;
 226
 227         if (!role_match(sink->proplist, role))
 228             continue;
 229
 230         pa_sink_input_move_to(si, sink, FALSE);
 231     }
 232
 233     return PA_HOOK_OK;
 234 }
 235
 236 static pa_hook_result_t source_put_hook_callback(pa_core *c, pa_source *source, struct userdata *u) {
 237     pa_source_output *so;
 238     uint32_t idx;
 239
 240     pa_assert(c);
 241     pa_assert(source);
 242     pa_assert(u);
 243     pa_assert(u->on_hotplug);
 244
 245     PA_IDXSET_FOREACH(so, c->source_outputs, idx) {
 246         const char *role;
 247
 248         if (so->source == source)
 249             continue;
 250
 251         if (so->save_source)
 252             continue;
 253
 254         if (so->direct_on_input)
 255             continue;
 256
 257         /* Skip this if it is already in the process of being moved
 258          * anyway */
 259         if (!so->source)
 260             continue;
 261
 262         /* It might happen that a stream and a source are set up at the
 263            same time, in which case we want to make sure we don't
 264            interfere with that */
 265         if (!PA_SOURCE_OUTPUT_IS_LINKED(pa_source_output_get_state(so)))
 266             continue;
 267
 268         if (!(role = pa_proplist_gets(so->proplist, PA_PROP_MEDIA_ROLE)))
 269             continue;
 270
 271         if (role_match(so->source->proplist, role))
 272             continue;
 273
 274         if (!role_match(source->proplist, role))
 275             continue;
 276
 277         pa_source_output_move_to(so, source, FALSE);
 278     }
 279
 280     return PA_HOOK_OK;
 281 }
 282
 283 static pa_hook_result_t sink_unlink_hook_callback(pa_core *c, pa_sink *sink, struct userdata *u) {
 284     pa_sink_input *si;
 285     uint32_t idx;
 286     pa_sink *def;
 287
 288     pa_assert(c);
 289     pa_assert(sink);
 290     pa_assert(u);
 291     pa_assert(u->on_rescue);
 292
 293     /* There's no point in doing anything if the core is shut down anyway */
 294     if (c->state == PA_CORE_SHUTDOWN)
 295         return PA_HOOK_OK;
 296
 297     /* If there not default sink, then there is no sink at all */
 298     if (!(def = pa_namereg_get_default_sink(c)))
 299         return PA_HOOK_OK;
 300
 301     PA_IDXSET_FOREACH(si, sink->inputs, idx) {
 302         const char *role;
 303         uint32_t jdx;
 304         pa_sink *d;
 305
 306         if (!si->sink)
 307             continue;
 308
 309         if (!(role = pa_proplist_gets(si->proplist, PA_PROP_MEDIA_ROLE)))
 310             continue;
 311
 312         /* Would the default sink fit? If so, let's use it */
 313         if (def != sink && role_match(def->proplist, role))
 314             if (pa_sink_input_move_to(si, def, FALSE) >= 0)
 315                 continue;
 316
 317         /* Try to find some other fitting sink */
 318         PA_IDXSET_FOREACH(d, c->sinks, jdx) {
 319             if (d == def || d == sink)
 320                 continue;
 321
 322             if (!PA_SINK_IS_LINKED(pa_sink_get_state(d)))
 323                 continue;
 324
 325             if (role_match(d->proplist, role))
 326                 if (pa_sink_input_move_to(si, d, FALSE) >= 0)
 327                     break;
 328         }
 329     }
 330
 331     return PA_HOOK_OK;
 332 }
 333
 334 static pa_hook_result_t source_unlink_hook_callback(pa_core *c, pa_source *source, struct userdata *u) {
 335     pa_source_output *so;
 336     uint32_t idx;
 337     pa_source *def;
 338
 339     pa_assert(c);
 340     pa_assert(source);
 341     pa_assert(u);
 342     pa_assert(u->on_rescue);
 343
 344     /* There's no point in doing anything if the core is shut down anyway */
 345     if (c->state == PA_CORE_SHUTDOWN)
 346         return PA_HOOK_OK;
 347
 348     /* If there not default source, then there is no source at all */
 349     if (!(def = pa_namereg_get_default_source(c)))
 350         return PA_HOOK_OK;
 351
 352     PA_IDXSET_FOREACH(so, source->outputs, idx) {
 353         const char *role;
 354         uint32_t jdx;
 355         pa_source *d;
 356
 357         if (so->direct_on_input)
 358             continue;
 359
 360         if (!so->source)
 361             continue;
 362
 363         if (!(role = pa_proplist_gets(so->proplist, PA_PROP_MEDIA_ROLE)))
 364             continue;
 365
 366         /* Would the default source fit? If so, let's use it */
 367         if (def != source && role_match(def->proplist, role) && !source->monitor_of == !def->monitor_of) {
 368             pa_source_output_move_to(so, def, FALSE);
 369             continue;
 370         }
 371
 372         /* Try to find some other fitting source */
 373         PA_IDXSET_FOREACH(d, c->sources, jdx) {
 374             if (d == def || d == source)
 375                 continue;
 376
 377             if (!PA_SOURCE_IS_LINKED(pa_source_get_state(d)))
 378                 continue;
 379
 380             if (role_match(d->proplist, role) && !source->monitor_of == !d->monitor_of) {
 381                 pa_source_output_move_to(so, d, FALSE);
 382                 break;
 383             }
 384         }
 385     }
 386
 387     return PA_HOOK_OK;
 388 }
 389
 390 int pa__init(pa_module*m) {
 391     pa_modargs *ma = NULL;
 392     struct userdata *u;
 393     pa_bool_t on_hotplug = TRUE, on_rescue = TRUE;
 394
 395     pa_assert(m);
 396
 397     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 398         pa_log("Failed to parse module arguments");
 399         goto fail;
 400     }
 401
 402     if (pa_modargs_get_value_boolean(ma, "on_hotplug", &on_hotplug) < 0 ||
 403         pa_modargs_get_value_boolean(ma, "on_rescue", &on_rescue) < 0) {
 404         pa_log("on_hotplug= and on_rescue= expect boolean arguments");
 405         goto fail;
 406     }
 407
 408     m->userdata = u = pa_xnew0(struct userdata, 1);
 409     u->core = m->core;
 410     u->module = m;
 411     u->on_hotplug = on_hotplug;
 412     u->on_rescue = on_rescue;
 413
 414     /* A little bit later than module-stream-restore */
 415     u->sink_input_new_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_INPUT_NEW], PA_HOOK_EARLY+10, (pa_hook_cb_t) sink_input_new_hook_callback, u);
 416     u->source_output_new_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_NEW], PA_HOOK_EARLY+10, (pa_hook_cb_t) source_output_new_hook_callback, u);
 417
 418     if (on_hotplug) {
 419         /* A little bit later than module-stream-restore */
 420         u->sink_put_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_PUT], PA_HOOK_LATE+10, (pa_hook_cb_t) sink_put_hook_callback, u);
 421         u->source_put_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SOURCE_PUT], PA_HOOK_LATE+10, (pa_hook_cb_t) source_put_hook_callback, u);
 422     }
 423
 424     if (on_rescue) {
 425         /* A little bit later than module-stream-restore, a little bit earlier than module-rescue-streams, ... */
 426         u->sink_unlink_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_UNLINK], PA_HOOK_LATE+10, (pa_hook_cb_t) sink_unlink_hook_callback, u);
 427         u->source_unlink_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SOURCE_UNLINK], PA_HOOK_LATE+10, (pa_hook_cb_t) source_unlink_hook_callback, u);
 428     }
 429
 430     pa_modargs_free(ma);
 431     return 0;
 432
 433 fail:
 434     pa__done(m);
 435
 436     if (ma)
 437         pa_modargs_free(ma);
 438
 439     return  -1;
 440 }
 441
 442 void pa__done(pa_module*m) {
 443     struct userdata* u;
 444
 445     pa_assert(m);
 446
 447     if (!(u = m->userdata))
 448         return;
 449
 450     if (u->sink_input_new_hook_slot)
 451         pa_hook_slot_free(u->sink_input_new_hook_slot);
 452     if (u->source_output_new_hook_slot)
 453         pa_hook_slot_free(u->source_output_new_hook_slot);
 454
 455     if (u->sink_put_hook_slot)
 456         pa_hook_slot_free(u->sink_put_hook_slot);
 457     if (u->source_put_hook_slot)
 458         pa_hook_slot_free(u->source_put_hook_slot);
 459
 460     if (u->sink_unlink_hook_slot)
 461         pa_hook_slot_free(u->sink_unlink_hook_slot);
 462     if (u->source_unlink_hook_slot)
 463         pa_hook_slot_free(u->source_unlink_hook_slot);
 464
 465     pa_xfree(u);
 466 }