2 * module-murphy-ivi -- PulseAudio module for providing audio routing support
3 * Copyright (c) 2012, Intel Corporation.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU Lesser General Public License,
7 * version 2.1, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE.
12 * See the GNU Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public License
15 * along with this program; if not, write to the
16 * Free Software Foundation, Inc., 51 Franklin St - Fifth Floor, Boston,
25 #include <pulsecore/pulsecore-config.h>
27 #include <pulse/proplist.h>
28 #include <pulsecore/module.h>
33 #include "constrain.h"
40 static void rtgroup_destroy(struct userdata *, mir_rtgroup *);
41 static int rtgroup_print(mir_rtgroup *, char *, int);
42 static void rtgroup_update_module_property(struct userdata *, mir_direction,
45 static void add_rtentry(struct userdata *, mir_direction, mir_rtgroup *,
47 static void remove_rtentry(struct userdata *, mir_rtentry *);
49 static void make_explicit_routes(struct userdata *, uint32_t);
50 static mir_node *find_default_route(struct userdata *, mir_node *, uint32_t);
51 static void implement_preroute(struct userdata *, mir_node *, mir_node *,
53 static void implement_default_route(struct userdata *, mir_node *, mir_node *,
56 static int uint32_cmp(uint32_t, uint32_t);
58 static int node_priority(struct userdata *, mir_node *);
60 static int volume_class(mir_node *);
62 static int print_routing_table(pa_hashmap *, const char *, char *, int);
65 static void pa_hashmap_rtgroup_free(void *rtg, void *u)
67 rtgroup_destroy(u, rtg);
71 pa_router *pa_router_init(struct userdata *u)
73 size_t num_classes = mir_application_class_end;
74 pa_router *router = pa_xnew0(pa_router, 1);
76 router->rtgroups.input = pa_hashmap_new(pa_idxset_string_hash_func,
77 pa_idxset_string_compare_func);
78 router->rtgroups.output = pa_hashmap_new(pa_idxset_string_hash_func,
79 pa_idxset_string_compare_func);
81 router->maplen = num_classes;
83 router->classmap.input = pa_xnew0(mir_rtgroup *, num_classes);
84 router->classmap.output = pa_xnew0(mir_rtgroup *, num_classes);
86 router->priormap = pa_xnew0(int, num_classes);
88 MIR_DLIST_INIT(router->nodlist);
89 MIR_DLIST_INIT(router->connlist);
94 void pa_router_done(struct userdata *u)
97 mir_connection *conn, *c;
102 if (u && (router = u->router)) {
103 MIR_DLIST_FOR_EACH_SAFE(mir_node, rtprilist, e,n, &router->nodlist) {
104 MIR_DLIST_UNLINK(mir_node, rtprilist, e);
107 MIR_DLIST_FOR_EACH_SAFE(mir_connection,link, conn,c,&router->connlist){
108 MIR_DLIST_UNLINK(mir_connection, link, conn);
112 PA_HASHMAP_FOREACH(rtg, router->rtgroups.input, state) {
113 rtgroup_destroy(u, rtg);
116 PA_HASHMAP_FOREACH(rtg, router->rtgroups.output, state) {
117 rtgroup_destroy(u, rtg);
120 pa_hashmap_free(router->rtgroups.input, NULL);
121 pa_hashmap_free(router->rtgroups.output, NULL);
123 pa_xfree(router->classmap.input);
124 pa_xfree(router->classmap.output);
126 pa_xfree(router->priormap);
134 void mir_router_assign_class_priority(struct userdata *u,
142 pa_assert_se((router = u->router));
143 pa_assert_se((priormap = router->priormap));
145 if (class >= 0 && class < router->maplen) {
146 pa_log_debug("assigning priority %d to class '%s'",
147 pri, mir_node_type_str(class));
148 priormap[class] = pri;
153 mir_rtgroup *mir_router_create_rtgroup(struct userdata *u,
156 mir_rtgroup_accept_t accept,
157 mir_rtgroup_compare_t compare)
164 pa_assert(type == mir_input || type == mir_output);
168 pa_assert_se((router = u->router));
170 if (type == mir_input)
171 table = router->rtgroups.input;
173 table = router->rtgroups.output;
177 rtg = pa_xnew0(mir_rtgroup, 1);
178 rtg->name = pa_xstrdup(name);
179 rtg->accept = accept;
180 rtg->compare = compare;
181 MIR_DLIST_INIT(rtg->entries);
183 if (pa_hashmap_put(table, rtg->name, rtg) < 0) {
189 pa_log_debug("%s routing group '%s' created",
190 mir_direction_str(type), name);
195 void mir_router_destroy_rtgroup(struct userdata *u,
205 pa_assert_se((router = u->router));
207 if (type == mir_input)
208 table = router->rtgroups.input;
210 table = router->rtgroups.output;
214 if (!(rtg = pa_hashmap_remove(table, name))) {
215 pa_log_debug("can't destroy %s routing group '%s': group not found",
216 mir_direction_str(type), name);
219 rtgroup_destroy(u, rtg);
220 pa_log_debug("routing group '%s' destroyed", name);
225 pa_bool_t mir_router_assign_class_to_rtgroup(struct userdata *u,
228 const char *rtgrpnam)
232 mir_rtgroup **classmap;
235 const char *direction;
238 pa_assert(type == mir_input || type == mir_output);
240 pa_assert_se((router = u->router));
242 if (type == mir_input) {
243 rtable = router->rtgroups.input;
244 classmap = router->classmap.input;
247 rtable = router->rtgroups.output;
248 classmap = router->classmap.output;
251 if (class < 0 || class >= router->maplen) {
252 pa_log_debug("can't assign class (%d) to routing group '%s': "
253 "class id is out of range (0 - %d)",
254 class, rtgrpnam, router->maplen);
258 clnam = mir_node_type_str(class);
259 direction = mir_direction_str(type);
261 if (!(rtg = pa_hashmap_get(rtable, rtgrpnam))) {
262 pa_log_debug("can't assign class '%s' to %s routing group '%s': "
263 "router group not found", clnam, direction, rtgrpnam);
266 classmap[class] = rtg;
268 pa_log_debug("class '%s' assigned to %s routing group '%s'",
269 clnam, direction, rtgrpnam);
276 void mir_router_register_node(struct userdata *u, mir_node *node)
286 pa_assert_se((router = u->router));
288 if (node->direction == mir_output) {
289 if (node->implement == mir_device) {
290 PA_HASHMAP_FOREACH(rtg, router->rtgroups.output, state) {
291 add_rtentry(u, mir_output, rtg, node);
298 if (node->direction == mir_input) {
300 if (node->implement == mir_device) &&
301 !pa_classify_loopback_stream(node))
305 if (node->implement == mir_device) {
306 PA_HASHMAP_FOREACH(rtg, router->rtgroups.input, state) {
307 add_rtentry(u, mir_input, rtg, node);
310 if (!pa_classify_loopback_stream(node))
314 priority = node_priority(u, node);
316 MIR_DLIST_FOR_EACH(mir_node, rtprilist, before, &router->nodlist) {
317 if (priority < node_priority(u, before)) {
318 MIR_DLIST_INSERT_BEFORE(mir_node, rtprilist, node,
324 MIR_DLIST_APPEND(mir_node, rtprilist, node, &router->nodlist);
330 void mir_router_unregister_node(struct userdata *u, mir_node *node)
333 mir_rtentry *rte, *n;
337 pa_assert_se((router = u->router));
339 MIR_DLIST_FOR_EACH_SAFE(mir_rtentry,nodchain, rte,n, &node->rtentries) {
340 remove_rtentry(u, rte);
343 MIR_DLIST_UNLINK(mir_node, rtprilist, node);
346 mir_connection *mir_router_add_explicit_route(struct userdata *u,
352 mir_connection *conn;
357 pa_assert_se((router = u->router));
359 conn = pa_xnew0(mir_connection, 1);
360 MIR_DLIST_INIT(conn->link);
362 conn->from = from->index;
363 conn->to = to->index;
365 MIR_DLIST_APPEND(mir_connection, link, conn, &router->connlist);
367 mir_router_make_routing(u);
372 void mir_router_remove_explicit_route(struct userdata *u, mir_connection *conn)
381 pa_assert_se((core = u->core));
382 pa_assert_se((router = u->router));
384 MIR_DLIST_UNLINK(mir_connection, link, conn);
386 if (!(from = mir_node_find_by_index(u, conn->from)) ||
387 !(to = mir_node_find_by_index(u, conn->to)) )
389 pa_log_debug("can't remove explicit route: some node was not found");
392 pa_log_debug("tear down link '%s' => '%s'", from->amname, to->amname);
394 if (!mir_switch_teardown_link(u, from, to)) {
395 pa_log_debug("can't remove explicit route: "
396 "failed to teardown link");
400 mir_router_make_routing(u);
408 int mir_router_print_rtgroups(struct userdata *u, char *buf, int len)
416 pa_assert_se((router = u->router));
417 pa_assert(router->rtgroups.input);
418 pa_assert(router->rtgroups.output);
423 p += print_routing_table(router->rtgroups.input, "input", p, e-p);
426 p += print_routing_table(router->rtgroups.output, "output", p, e-p);
432 mir_node *mir_router_make_prerouting(struct userdata *u, mir_node *data)
443 pa_assert_se((router = u->router));
444 pa_assert_se((data->implement == mir_stream));
446 priority = node_priority(u, data);
449 stamp = pa_utils_new_stamp();
451 make_explicit_routes(u, stamp);
453 MIR_DLIST_FOR_EACH_BACKWARD(mir_node, rtprilist, start, &router->nodlist) {
454 if (start->implement == mir_device) {
456 if (start->direction == mir_output)
457 continue; /* we should never get here */
458 if (!start->mux && !start->loop)
459 continue; /* skip not looped back input nodes */
462 continue; /* only looped back devices routed here */
465 if (priority >= node_priority(u, start)) {
466 if ((target = find_default_route(u, data, stamp)))
467 implement_preroute(u, data, target, stamp);
471 if (start->stamp >= stamp)
474 if ((end = find_default_route(u, start, stamp)))
475 implement_default_route(u, start, end, stamp);
478 if (!done && (target = find_default_route(u, data, stamp)))
479 implement_preroute(u, data, target, stamp);
485 void mir_router_make_routing(struct userdata *u)
487 static pa_bool_t ongoing_routing;
495 pa_assert_se((router = u->router));
500 ongoing_routing = TRUE;
501 stamp = pa_utils_new_stamp();
503 make_explicit_routes(u, stamp);
505 MIR_DLIST_FOR_EACH_BACKWARD(mir_node,rtprilist, start, &router->nodlist) {
506 if (start->implement == mir_device) {
508 if (start->direction == mir_output)
509 continue; /* we should never get here */
510 if (!start->mux && !start->loop)
511 continue; /* skip not looped back input nodes */
514 continue; /* only looped back devices routed here */
517 if (start->stamp >= stamp)
520 if ((end = find_default_route(u, start, stamp)))
521 implement_default_route(u, start, end, stamp);
524 pa_fader_apply_volume_limits(u, stamp);
526 ongoing_routing = FALSE;
531 pa_bool_t mir_router_default_accept(struct userdata *u, mir_rtgroup *rtg,
540 const char *role, *excluded_role;
548 if (class == mir_bluetooth_carkit)
550 else if (class == mir_jack || class == mir_hdmi) {
551 pa_assert_se((core = u->core));
553 if (node->direction == mir_input) {
554 source = pa_idxset_get_by_index(core->sources,node->paidx);
555 pl = source ? source->proplist : NULL;
556 excluded_role = "hfp_uplink";
559 sink = pa_idxset_get_by_index(core->sinks, node->paidx);
560 pl = sink ? sink->proplist : NULL;
561 excluded_role = "hfp_downlink";
563 role = pl ? pa_proplist_gets(pl, PA_PROP_NODE_ROLE) : NULL;
564 accept = role ? strcmp(role, excluded_role) : TRUE;
567 accept = (class >= mir_device_class_begin &&
568 class < mir_device_class_end);
575 pa_bool_t mir_router_phone_accept(struct userdata *u, mir_rtgroup *rtg,
583 const char *role, *expected_role;
591 if (class >= mir_device_class_begin && class < mir_device_class_end) {
592 if (class != mir_bluetooth_a2dp &&
593 class != mir_spdif &&
594 class != mir_bluetooth_source &&
595 class != mir_bluetooth_sink &&
596 class != mir_bluetooth_carkit )
598 if (class == mir_usb_headphone || class == mir_wired_headphone) {
601 else if (class == mir_jack || class == mir_hdmi) {
602 pa_assert_se((core = u->core));
604 if (node->direction == mir_input) {
605 source = pa_idxset_get_by_index(core->sources,node->paidx);
606 pl = source ? source->proplist : NULL;
607 expected_role = "hfp_uplink";
610 sink = pa_idxset_get_by_index(core->sinks, node->paidx);
611 pl = sink ? sink->proplist : NULL;
612 expected_role = "hfp_downlink";
614 if (!pl || !(role = pa_proplist_gets(pl, PA_PROP_NODE_ROLE)) ||
615 strcmp(role, expected_role))
629 int mir_router_default_compare(struct userdata *u, mir_rtgroup *rtg,
630 mir_node *n1, mir_node *n2)
640 if (n1->type == mir_null)
642 if (n2->type == mir_null)
645 p1 = ((((n1->channels & 31) << 5) + n1->privacy) << 2) + n1->location;
646 p2 = ((((n2->channels & 31) << 5) + n2->privacy) << 2) + n2->location;
648 p1 = (p1 << 8) + ((n1->type - mir_device_class_begin) & 0xff);
649 p2 = (p2 << 8) + ((n2->type - mir_device_class_begin) & 0xff);
651 return uint32_cmp(p1,p2);
655 int mir_router_phone_compare(struct userdata *u, mir_rtgroup *rtg,
656 mir_node *n1, mir_node *n2)
666 if (n1->type == mir_null)
668 if (n2->type == mir_null)
671 p1 = (n1->privacy << 8) + ((n1->type - mir_device_class_begin) & 0xff);
672 p2 = (n2->privacy << 8) + ((n2->type - mir_device_class_begin) & 0xff);
674 return uint32_cmp(p1,p2);
678 static void rtgroup_destroy(struct userdata *u, mir_rtgroup *rtg)
680 mir_rtentry *rte, *n;
685 MIR_DLIST_FOR_EACH_SAFE(mir_rtentry, link, rte,n, &rtg->entries) {
686 remove_rtentry(u, rte);
693 static int rtgroup_print(mir_rtgroup *rtg, char *buf, int len)
703 MIR_DLIST_FOR_EACH_BACKWARD(mir_rtentry, link, rte, &rtg->entries) {
707 p += snprintf(p, e-p, " '%s'", node->amname);
713 static void rtgroup_update_module_property(struct userdata *u,
724 pa_assert(rtg->name);
725 pa_assert_se((module = u->module));
727 snprintf(key, sizeof(key), PA_PROP_ROUTING_TABLE ".%s.%s",
728 mir_direction_str(type), rtg->name);
729 ret = rtgroup_print(rtg, value, sizeof(value));
734 pa_proplist_sets(module->proplist, key, value+1); /* skip ' '@beginning */
737 static void add_rtentry(struct userdata *u,
743 mir_rtentry *rte, *before;
748 pa_assert_se((router = u->router));
750 if (!rtg->accept(u, rtg, node)) {
751 pa_log_debug("refuse node '%s' registration to routing group '%s'",
752 node->amname, rtg->name);
756 rte = pa_xnew0(mir_rtentry, 1);
758 MIR_DLIST_APPEND(mir_rtentry, nodchain, rte, &node->rtentries);
762 MIR_DLIST_FOR_EACH(mir_rtentry, link, before, &rtg->entries) {
763 if (rtg->compare(u, rtg, node, before->node) < 0) {
764 MIR_DLIST_INSERT_BEFORE(mir_rtentry, link, rte, &before->link);
769 MIR_DLIST_APPEND(mir_rtentry, link, rte, &rtg->entries);
772 rtgroup_update_module_property(u, type, rtg);
773 pa_log_debug("node '%s' added to routing group '%s'",
774 node->amname, rtg->name);
777 static void remove_rtentry(struct userdata *u, mir_rtentry *rte)
784 pa_assert_se((rtg = rte->group));
785 pa_assert_se((node = rte->node));
787 MIR_DLIST_UNLINK(mir_rtentry, link, rte);
788 MIR_DLIST_UNLINK(mir_rtentry, nodchain, rte);
792 rtgroup_update_module_property(u, node->direction, rtg);
795 static void make_explicit_routes(struct userdata *u, uint32_t stamp)
798 mir_connection *conn;
803 pa_assert_se((router = u->router));
805 MIR_DLIST_FOR_EACH_BACKWARD(mir_connection,link, conn, &router->connlist) {
809 if (!(from = mir_node_find_by_index(u, conn->from)) ||
810 !(to = mir_node_find_by_index(u, conn->to)) )
812 pa_log_debug("ignoring explicit route %u: some of the nodes "
813 "not found", conn->amid);
817 if (!mir_switch_setup_link(u, from, to, TRUE))
820 if (from->implement == mir_stream)
823 if (to->implement == mir_device)
824 mir_volume_add_limiting_class(u, to, volume_class(from), stamp);
829 static mir_node *find_default_route(struct userdata *u,
833 pa_router *router = u->router;
834 mir_node_type class = pa_classify_guess_application_class(start);
835 mir_rtgroup **classmap;
840 if (class < 0 || class > router->maplen) {
841 pa_log_debug("can't route '%s': class %d is out of range (0 - %d)",
842 start->amname, class, router->maplen);
846 switch (start->direction) {
847 case mir_input: classmap = router->classmap.output; break;
848 case mir_output: classmap = router->classmap.input; break;
849 default: classmap = NULL; break;
852 if (!classmap || !(rtg = classmap[class])) {
853 pa_log_debug("node '%s' won't be routed beacuse its class '%s' "
854 "is not assigned to any router group",
855 start->amname, mir_node_type_str(class));
859 pa_log_debug("using '%s' router group when routing '%s'",
860 rtg->name, start->amname);
863 MIR_DLIST_FOR_EACH_BACKWARD(mir_rtentry, link, rte, &rtg->entries) {
864 if (!(end = rte->node)) {
865 pa_log(" node was null in mir_rtentry");
870 pa_log_debug(" '%s' ignored. Skipping...",end->amname);
874 if (!end->available) {
875 pa_log_debug(" '%s' not available. Skipping...", end->amname);
879 if (end->paidx == PA_IDXSET_INVALID && !end->paport) {
880 /* requires profile change. We do it only for BT headsets */
881 if (end->type != mir_bluetooth_a2dp &&
882 end->type != mir_bluetooth_sco )
884 pa_log_debug(" '%s' has no sink. Skipping...", end->amname);
889 if (rte->stamp < stamp)
890 mir_constrain_apply(u, end, stamp);
893 pa_log_debug(" '%s' is blocked by constraints. Skipping...",
899 pa_log_debug("routing '%s' => '%s'", start->amname, end->amname);
904 pa_log_debug("could not find route for '%s'", start->amname);
909 static void implement_preroute(struct userdata *u,
914 if (data->direction == mir_output)
915 mir_switch_setup_link(u, target, NULL, FALSE);
917 mir_switch_setup_link(u, NULL, target, FALSE);
918 mir_volume_add_limiting_class(u, target, data->type, stamp);
922 static void implement_default_route(struct userdata *u,
927 if (start->direction == mir_output)
928 mir_switch_setup_link(u, end, start, FALSE);
930 mir_switch_setup_link(u, start, end, FALSE);
931 mir_volume_add_limiting_class(u, end, volume_class(start), stamp);
936 static int uint32_cmp(uint32_t v1, uint32_t v2)
945 static int node_priority(struct userdata *u, mir_node *node)
952 pa_assert_se((router = u->router));
953 pa_assert(router->priormap);
955 class = pa_classify_guess_application_class(node);
957 if (class < 0 || class >= router->maplen)
960 return router->priormap[class];
963 static int volume_class(mir_node *node)
965 int device_class[mir_device_class_end - mir_device_class_begin] = {
966 [ mir_bluetooth_carkit - mir_device_class_begin ] = mir_phone,
967 [ mir_bluetooth_source - mir_device_class_begin ] = mir_player,
976 if (t >= mir_application_class_begin && t < mir_application_class_end)
979 if (t >= mir_device_class_begin && t < mir_device_class_end)
980 return device_class[t - mir_device_class_begin];
982 return mir_node_type_unknown;
986 static int print_routing_table(pa_hashmap *table,
1000 e = (p = buf) + len;
1004 p += snprintf(p, e-p, "%s routing table:\n", type);
1009 PA_HASHMAP_FOREACH(rtg, table, state) {
1013 p += snprintf(p, e-p, " %s:", rtg->name);
1016 p += rtgroup_print(rtg, p, e-p);
1019 p += snprintf(p, e-p, "\n");
1023 p += snprintf(p, e-p, " <empty>\n");
1034 * indent-tabs-mode: nil