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
29 #include <sys/types.h>
34 #include <pulse/xmalloc.h>
35 #include <pulse/volume.h>
36 #include <pulse/timeval.h>
37 #include <pulse/util.h>
39 #include <pulsecore/core-error.h>
40 #include <pulsecore/module.h>
41 #include <pulsecore/core-util.h>
42 #include <pulsecore/modargs.h>
43 #include <pulsecore/log.h>
44 #include <pulsecore/core-subscribe.h>
45 #include <pulsecore/sink-input.h>
46 #include <pulsecore/source-output.h>
47 #include <pulsecore/namereg.h>
48 #include <pulsecore/protocol-native.h>
49 #include <pulsecore/pstream.h>
50 #include <pulsecore/pstream-util.h>
51 #include <pulsecore/database.h>
53 #include "module-intended-roles-symdef.h"
55 PA_MODULE_AUTHOR("Lennart Poettering");
56 PA_MODULE_DESCRIPTION("Automatically set device of streams based of intended roles of devices");
57 PA_MODULE_VERSION(PACKAGE_VERSION
);
58 PA_MODULE_LOAD_ONCE(TRUE
);
60 "on_hotplug=<When new device becomes available, recheck streams?> "
61 "on_rescue=<When device becomes unavailable, recheck streams?>");
63 static const char* const valid_modargs
[] = {
73 *sink_input_new_hook_slot
,
74 *source_output_new_hook_slot
,
76 *source_put_hook_slot
,
77 *sink_unlink_hook_slot
,
78 *source_unlink_hook_slot
;
80 pa_bool_t on_hotplug
:1;
81 pa_bool_t on_rescue
:1;
84 static pa_bool_t
role_match(pa_proplist
*proplist
, const char *role
) {
87 const char *state
= NULL
;
89 if (!(ir
= pa_proplist_gets(proplist
, PA_PROP_DEVICE_INTENDED_ROLES
)))
92 while ((r
= pa_split_spaces(ir
, &state
))) {
94 if (pa_streq(role
, r
)) {
105 static pa_hook_result_t
sink_input_new_hook_callback(pa_core
*c
, pa_sink_input_new_data
*new_data
, struct userdata
*u
) {
114 if (!new_data
->proplist
) {
115 pa_log_debug("New stream lacks property data.");
119 if (new_data
->sink
) {
120 pa_log_debug("Not setting device for stream %s, because already set.", pa_strnull(pa_proplist_gets(new_data
->proplist
, PA_PROP_MEDIA_NAME
)));
124 if (!(role
= pa_proplist_gets(new_data
->proplist
, PA_PROP_MEDIA_ROLE
))) {
125 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
)));
129 /* Prefer the default sink over any other sink, just in case... */
130 if ((def
= pa_namereg_get_default_sink(c
)))
131 if (role_match(def
->proplist
, role
)) {
132 new_data
->sink
= def
;
133 new_data
->save_sink
= FALSE
;
137 PA_IDXSET_FOREACH(s
, c
->sinks
, idx
) {
141 if (role_match(s
->proplist
, role
)) {
143 new_data
->save_sink
= FALSE
;
151 static pa_hook_result_t
source_output_new_hook_callback(pa_core
*c
, pa_source_output_new_data
*new_data
, struct userdata
*u
) {
160 if (!new_data
->proplist
) {
161 pa_log_debug("New stream lacks property data.");
165 if (new_data
->source
) {
166 pa_log_debug("Not setting device for stream %s, because already set.", pa_strnull(pa_proplist_gets(new_data
->proplist
, PA_PROP_MEDIA_NAME
)));
170 if (!(role
= pa_proplist_gets(new_data
->proplist
, PA_PROP_MEDIA_ROLE
))) {
171 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
)));
175 /* Prefer the default source over any other source, just in case... */
176 if ((def
= pa_namereg_get_default_source(c
)))
177 if (role_match(def
->proplist
, role
)) {
178 new_data
->source
= def
;
179 new_data
->save_source
= FALSE
;
183 PA_IDXSET_FOREACH(s
, c
->sources
, idx
) {
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 if (!(role
= pa_proplist_gets(si
->proplist
, PA_PROP_MEDIA_ROLE
)))
218 if (role_match(si
->sink
->proplist
, role
))
221 if (!role_match(sink
->proplist
, role
))
224 pa_sink_input_move_to(si
, sink
, FALSE
);
230 static pa_hook_result_t
source_put_hook_callback(pa_core
*c
, pa_source
*source
, struct userdata
*u
) {
231 pa_source_output
*so
;
237 pa_assert(u
->on_hotplug
);
239 PA_IDXSET_FOREACH(so
, c
->source_outputs
, idx
) {
242 if (so
->source
== source
)
248 if (so
->direct_on_input
)
251 if (!(role
= pa_proplist_gets(so
->proplist
, PA_PROP_MEDIA_ROLE
)))
254 if (role_match(so
->source
->proplist
, role
))
257 if (!role_match(source
->proplist
, role
))
260 pa_source_output_move_to(so
, source
, FALSE
);
266 static pa_hook_result_t
sink_unlink_hook_callback(pa_core
*c
, pa_sink
*sink
, struct userdata
*u
) {
274 pa_assert(u
->on_rescue
);
276 /* There's no point in doing anything if the core is shut down anyway */
277 if (c
->state
== PA_CORE_SHUTDOWN
)
280 /* If there not default sink, then there is no sink at all */
281 if (!(def
= pa_namereg_get_default_sink(c
)))
284 PA_IDXSET_FOREACH(si
, sink
->inputs
, idx
) {
289 if (!(role
= pa_proplist_gets(si
->proplist
, PA_PROP_MEDIA_ROLE
)))
292 /* Would the default sink fit? If so, let's use it */
293 if (def
!= sink
&& role_match(def
->proplist
, role
)) {
294 pa_sink_input_move_to(si
, def
, FALSE
);
298 /* Try to find some other fitting sink */
299 PA_IDXSET_FOREACH(d
, c
->sinks
, jdx
) {
300 if (d
== def
|| d
== sink
)
303 if (role_match(d
->proplist
, role
)) {
304 pa_sink_input_move_to(si
, d
, FALSE
);
313 static pa_hook_result_t
source_unlink_hook_callback(pa_core
*c
, pa_source
*source
, struct userdata
*u
) {
314 pa_source_output
*so
;
321 pa_assert(u
->on_rescue
);
323 /* There's no point in doing anything if the core is shut down anyway */
324 if (c
->state
== PA_CORE_SHUTDOWN
)
327 /* If there not default source, then there is no source at all */
328 if (!(def
= pa_namereg_get_default_source(c
)))
331 PA_IDXSET_FOREACH(so
, source
->outputs
, idx
) {
336 if (so
->direct_on_input
)
339 if (!(role
= pa_proplist_gets(so
->proplist
, PA_PROP_MEDIA_ROLE
)))
342 /* Would the default source fit? If so, let's use it */
343 if (def
!= source
&& role_match(def
->proplist
, role
) && !source
->monitor_of
== !def
->monitor_of
) {
344 pa_source_output_move_to(so
, def
, FALSE
);
348 /* Try to find some other fitting source */
349 PA_IDXSET_FOREACH(d
, c
->sources
, jdx
) {
350 if (d
== def
|| d
== source
)
353 if (role_match(d
->proplist
, role
) && !source
->monitor_of
== !d
->monitor_of
) {
354 pa_source_output_move_to(so
, d
, FALSE
);
363 int pa__init(pa_module
*m
) {
364 pa_modargs
*ma
= NULL
;
366 pa_bool_t on_hotplug
= TRUE
, on_rescue
= TRUE
;
370 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
371 pa_log("Failed to parse module arguments");
375 if (pa_modargs_get_value_boolean(ma
, "on_hotplug", &on_hotplug
) < 0 ||
376 pa_modargs_get_value_boolean(ma
, "on_rescue", &on_rescue
) < 0) {
377 pa_log("on_hotplug= and on_rescue= expect boolean arguments");
381 m
->userdata
= u
= pa_xnew0(struct userdata
, 1);
384 u
->on_hotplug
= on_hotplug
;
385 u
->on_rescue
= on_rescue
;
387 /* A little bit later than module-stream-restore */
388 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
);
389 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
);
392 /* A little bit later than module-stream-restore */
393 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
);
394 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
);
398 /* A little bit later than module-stream-restore, a little bit earlier than module-rescue-streams, ... */
399 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
);
400 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
);
415 void pa__done(pa_module
*m
) {
420 if (!(u
= m
->userdata
))
423 if (u
->sink_input_new_hook_slot
)
424 pa_hook_slot_free(u
->sink_input_new_hook_slot
);
425 if (u
->source_output_new_hook_slot
)
426 pa_hook_slot_free(u
->source_output_new_hook_slot
);
428 if (u
->sink_put_hook_slot
)
429 pa_hook_slot_free(u
->sink_put_hook_slot
);
430 if (u
->source_put_hook_slot
)
431 pa_hook_slot_free(u
->source_put_hook_slot
);
433 if (u
->sink_unlink_hook_slot
)
434 pa_hook_slot_free(u
->sink_unlink_hook_slot
);
435 if (u
->source_unlink_hook_slot
)
436 pa_hook_slot_free(u
->source_unlink_hook_slot
);