2 This file is part of PulseAudio.
4 Copyright 2009 Lennart Poettering
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.
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.
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
26 #include <pulse/xmalloc.h>
27 #include <pulse/volume.h>
28 #include <pulse/timeval.h>
29 #include <pulse/util.h>
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>
41 #include "module-intended-roles-symdef.h"
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
);
48 "on_hotplug=<When new device becomes available, recheck streams?> "
49 "on_rescue=<When device becomes unavailable, recheck streams?>");
51 static const char* const valid_modargs
[] = {
62 *sink_input_new_hook_slot
,
63 *source_output_new_hook_slot
,
65 *source_put_hook_slot
,
66 *sink_unlink_hook_slot
,
67 *source_unlink_hook_slot
;
69 pa_bool_t on_hotplug
:1;
70 pa_bool_t on_rescue
:1;
73 static pa_bool_t
role_match(pa_proplist
*proplist
, const char *role
) {
76 const char *state
= NULL
;
78 if (!(ir
= pa_proplist_gets(proplist
, PA_PROP_DEVICE_INTENDED_ROLES
)))
81 while ((r
= pa_split_spaces(ir
, &state
))) {
83 if (pa_streq(role
, r
)) {
94 static pa_hook_result_t
sink_input_new_hook_callback(pa_core
*c
, pa_sink_input_new_data
*new_data
, struct userdata
*u
) {
103 if (!new_data
->proplist
) {
104 pa_log_debug("New stream lacks property data.");
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
)));
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
)));
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
;
126 /* @todo: favour the highest priority device, not the first one we find? */
127 PA_IDXSET_FOREACH(s
, c
->sinks
, idx
) {
131 if (!PA_SINK_IS_LINKED(pa_sink_get_state(s
)))
134 if (role_match(s
->proplist
, role
)) {
136 new_data
->save_sink
= FALSE
;
144 static pa_hook_result_t
source_output_new_hook_callback(pa_core
*c
, pa_source_output_new_data
*new_data
, struct userdata
*u
) {
153 if (!new_data
->proplist
) {
154 pa_log_debug("New stream lacks property data.");
158 if (new_data
->source
) {
159 pa_log_debug("Not setting device for stream %s, because already set.", pa_strnull(pa_proplist_gets(new_data
->proplist
, PA_PROP_MEDIA_NAME
)));
163 if (!(role
= pa_proplist_gets(new_data
->proplist
, PA_PROP_MEDIA_ROLE
))) {
164 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
)));
168 /* Prefer the default source over any other source, just in case... */
169 if ((def
= pa_namereg_get_default_source(c
)))
170 if (role_match(def
->proplist
, role
)) {
171 new_data
->source
= def
;
172 new_data
->save_source
= FALSE
;
176 PA_IDXSET_FOREACH(s
, c
->sources
, idx
) {
183 if (!PA_SOURCE_IS_LINKED(pa_source_get_state(s
)))
186 /* @todo: favour the highest priority device, not the first one we find? */
187 if (role_match(s
->proplist
, role
)) {
188 new_data
->source
= s
;
189 new_data
->save_source
= FALSE
;
197 static pa_hook_result_t
sink_put_hook_callback(pa_core
*c
, pa_sink
*sink
, struct userdata
*u
) {
204 pa_assert(u
->on_hotplug
);
206 PA_IDXSET_FOREACH(si
, c
->sink_inputs
, idx
) {
209 if (si
->sink
== sink
)
215 /* Skip this if it is already in the process of being moved
220 /* It might happen that a stream and a sink are set up at the
221 same time, in which case we want to make sure we don't
222 interfere with that */
223 if (!PA_SINK_INPUT_IS_LINKED(pa_sink_input_get_state(si
)))
226 if (!(role
= pa_proplist_gets(si
->proplist
, PA_PROP_MEDIA_ROLE
)))
229 if (role_match(si
->sink
->proplist
, role
))
232 if (!role_match(sink
->proplist
, role
))
235 pa_sink_input_move_to(si
, sink
, FALSE
);
241 static pa_hook_result_t
source_put_hook_callback(pa_core
*c
, pa_source
*source
, struct userdata
*u
) {
242 pa_source_output
*so
;
248 pa_assert(u
->on_hotplug
);
250 if (source
->monitor_of
)
253 PA_IDXSET_FOREACH(so
, c
->source_outputs
, idx
) {
256 if (so
->source
== source
)
262 if (so
->direct_on_input
)
265 /* Skip this if it is already in the process of being moved
270 /* It might happen that a stream and a source are set up at the
271 same time, in which case we want to make sure we don't
272 interfere with that */
273 if (!PA_SOURCE_OUTPUT_IS_LINKED(pa_source_output_get_state(so
)))
276 if (!(role
= pa_proplist_gets(so
->proplist
, PA_PROP_MEDIA_ROLE
)))
279 if (role_match(so
->source
->proplist
, role
))
282 if (!role_match(source
->proplist
, role
))
285 pa_source_output_move_to(so
, source
, FALSE
);
291 static pa_hook_result_t
sink_unlink_hook_callback(pa_core
*c
, pa_sink
*sink
, struct userdata
*u
) {
299 pa_assert(u
->on_rescue
);
301 /* There's no point in doing anything if the core is shut down anyway */
302 if (c
->state
== PA_CORE_SHUTDOWN
)
305 /* If there not default sink, then there is no sink at all */
306 if (!(def
= pa_namereg_get_default_sink(c
)))
309 PA_IDXSET_FOREACH(si
, sink
->inputs
, idx
) {
317 if (!(role
= pa_proplist_gets(si
->proplist
, PA_PROP_MEDIA_ROLE
)))
320 /* Would the default sink fit? If so, let's use it */
321 if (def
!= sink
&& role_match(def
->proplist
, role
))
322 if (pa_sink_input_move_to(si
, def
, FALSE
) >= 0)
325 /* Try to find some other fitting sink */
326 /* @todo: favour the highest priority device, not the first one we find? */
327 PA_IDXSET_FOREACH(d
, c
->sinks
, jdx
) {
328 if (d
== def
|| d
== sink
)
331 if (!PA_SINK_IS_LINKED(pa_sink_get_state(d
)))
334 if (role_match(d
->proplist
, role
))
335 if (pa_sink_input_move_to(si
, d
, FALSE
) >= 0)
343 static pa_hook_result_t
source_unlink_hook_callback(pa_core
*c
, pa_source
*source
, struct userdata
*u
) {
344 pa_source_output
*so
;
351 pa_assert(u
->on_rescue
);
353 /* There's no point in doing anything if the core is shut down anyway */
354 if (c
->state
== PA_CORE_SHUTDOWN
)
357 /* If there not default source, then there is no source at all */
358 if (!(def
= pa_namereg_get_default_source(c
)))
361 PA_IDXSET_FOREACH(so
, source
->outputs
, idx
) {
366 if (so
->direct_on_input
)
372 if (!(role
= pa_proplist_gets(so
->proplist
, PA_PROP_MEDIA_ROLE
)))
375 /* Would the default source fit? If so, let's use it */
376 if (def
!= source
&& role_match(def
->proplist
, role
) && !source
->monitor_of
== !def
->monitor_of
) {
377 pa_source_output_move_to(so
, def
, FALSE
);
381 /* Try to find some other fitting source */
382 /* @todo: favour the highest priority device, not the first one we find? */
383 PA_IDXSET_FOREACH(d
, c
->sources
, jdx
) {
384 if (d
== def
|| d
== source
)
387 if (!PA_SOURCE_IS_LINKED(pa_source_get_state(d
)))
390 /* If moving from a monitor, move to another monitor */
391 if (!source
->monitor_of
== !d
->monitor_of
&& role_match(d
->proplist
, role
)) {
392 pa_source_output_move_to(so
, d
, FALSE
);
401 int pa__init(pa_module
*m
) {
402 pa_modargs
*ma
= NULL
;
404 pa_bool_t on_hotplug
= TRUE
, on_rescue
= TRUE
;
408 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
409 pa_log("Failed to parse module arguments");
413 if (pa_modargs_get_value_boolean(ma
, "on_hotplug", &on_hotplug
) < 0 ||
414 pa_modargs_get_value_boolean(ma
, "on_rescue", &on_rescue
) < 0) {
415 pa_log("on_hotplug= and on_rescue= expect boolean arguments");
419 m
->userdata
= u
= pa_xnew0(struct userdata
, 1);
422 u
->on_hotplug
= on_hotplug
;
423 u
->on_rescue
= on_rescue
;
425 /* A little bit later than module-stream-restore */
426 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
);
427 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
);
430 /* A little bit later than module-stream-restore */
431 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
);
432 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
);
436 /* A little bit later than module-stream-restore, a little bit earlier than module-rescue-streams, ... */
437 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
);
438 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
);
453 void pa__done(pa_module
*m
) {
458 if (!(u
= m
->userdata
))
461 if (u
->sink_input_new_hook_slot
)
462 pa_hook_slot_free(u
->sink_input_new_hook_slot
);
463 if (u
->source_output_new_hook_slot
)
464 pa_hook_slot_free(u
->source_output_new_hook_slot
);
466 if (u
->sink_put_hook_slot
)
467 pa_hook_slot_free(u
->sink_put_hook_slot
);
468 if (u
->source_put_hook_slot
)
469 pa_hook_slot_free(u
->source_put_hook_slot
);
471 if (u
->sink_unlink_hook_slot
)
472 pa_hook_slot_free(u
->sink_unlink_hook_slot
);
473 if (u
->source_unlink_hook_slot
)
474 pa_hook_slot_free(u
->source_unlink_hook_slot
);