2 This file is part of PulseAudio.
4 Copyright 2006-2008 Lennart Poettering
5 Copyright 2009 Colin Guthrie
7 PulseAudio is free software; you can redistribute it and/or modify
8 it under the terms of the GNU Lesser General Public License as published
9 by the Free Software Foundation; either version 2.1 of the License,
10 or (at your option) any later version.
12 PulseAudio is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 General Public License for more details.
17 You should have received a copy of the GNU Lesser General Public License
18 along with PulseAudio; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
30 #include <sys/types.h>
35 #include <pulse/xmalloc.h>
36 #include <pulse/volume.h>
37 #include <pulse/timeval.h>
38 #include <pulse/util.h>
39 #include <pulse/rtclock.h>
41 #include <pulsecore/core-error.h>
42 #include <pulsecore/module.h>
43 #include <pulsecore/core-util.h>
44 #include <pulsecore/modargs.h>
45 #include <pulsecore/log.h>
46 #include <pulsecore/core-subscribe.h>
47 #include <pulsecore/sink-input.h>
48 #include <pulsecore/source-output.h>
49 #include <pulsecore/namereg.h>
50 #include <pulsecore/protocol-native.h>
51 #include <pulsecore/pstream.h>
52 #include <pulsecore/pstream-util.h>
53 #include <pulsecore/database.h>
55 #include "module-device-manager-symdef.h"
57 PA_MODULE_AUTHOR("Colin Guthrie");
58 PA_MODULE_DESCRIPTION("Keep track of devices (and their descriptions) both past and present");
59 PA_MODULE_VERSION(PACKAGE_VERSION
);
60 PA_MODULE_LOAD_ONCE(TRUE
);
61 PA_MODULE_USAGE("This module does not take any arguments");
63 #define SAVE_INTERVAL (10 * PA_USEC_PER_SEC)
65 static const char* const valid_modargs
[] = {
72 pa_subscription
*subscription
;
75 *source_new_hook_slot
,
76 *connection_unlink_hook_slot
;
77 pa_time_event
*save_time_event
;
78 pa_database
*database
;
80 pa_native_protocol
*protocol
;
81 pa_idxset
*subscribed
;
83 pa_bool_t role_device_priority_routing
;
84 pa_bool_t stream_restore_used
;
85 pa_bool_t checked_stream_restore
;
88 #define ENTRY_VERSION 1
105 char description
[PA_NAME_MAX
];
106 uint32_t priority
[NUM_ROLES
];
114 SUBCOMMAND_ROLE_DEVICE_PRIORITY_ROUTING
,
115 SUBCOMMAND_PREFER_DEVICE
,
116 SUBCOMMAND_DEFER_DEVICE
,
117 SUBCOMMAND_SUBSCRIBE
,
121 static void save_time_callback(pa_mainloop_api
*a
, pa_time_event
* e
, const struct timeval
*t
, void *userdata
) {
122 struct userdata
*u
= userdata
;
128 pa_assert(e
== u
->save_time_event
);
129 u
->core
->mainloop
->time_free(u
->save_time_event
);
130 u
->save_time_event
= NULL
;
132 pa_database_sync(u
->database
);
133 pa_log_info("Synced.");
136 static struct entry
* read_entry(struct userdata
*u
, const char *name
) {
143 key
.data
= (char*) name
;
144 key
.size
= strlen(name
);
148 if (!pa_database_get(u
->database
, &key
, &data
))
151 if (data
.size
!= sizeof(struct entry
)) {
152 pa_log_debug("Database contains entry for device %s of wrong size %lu != %lu. Probably due to upgrade, ignoring.", name
, (unsigned long) data
.size
, (unsigned long) sizeof(struct entry
));
156 e
= (struct entry
*) data
.data
;
158 if (e
->version
!= ENTRY_VERSION
) {
159 pa_log_debug("Version of database entry for device %s doesn't match our version. Probably due to upgrade, ignoring.", name
);
163 if (!memchr(e
->description
, 0, sizeof(e
->description
))) {
164 pa_log_warn("Database contains entry for device %s with missing NUL byte in description", name
);
172 pa_datum_free(&data
);
176 static void trigger_save(struct userdata
*u
) {
177 pa_native_connection
*c
;
180 for (c
= pa_idxset_first(u
->subscribed
, &idx
); c
; c
= pa_idxset_next(u
->subscribed
, &idx
)) {
183 t
= pa_tagstruct_new(NULL
, 0);
184 pa_tagstruct_putu32(t
, PA_COMMAND_EXTENSION
);
185 pa_tagstruct_putu32(t
, 0);
186 pa_tagstruct_putu32(t
, u
->module
->index
);
187 pa_tagstruct_puts(t
, u
->module
->name
);
188 pa_tagstruct_putu32(t
, SUBCOMMAND_EVENT
);
190 pa_pstream_send_tagstruct(pa_native_connection_get_pstream(c
), t
);
193 if (u
->save_time_event
)
196 u
->save_time_event
= pa_core_rttime_new(u
->core
, pa_rtclock_now() + SAVE_INTERVAL
, save_time_callback
, u
);
199 static pa_bool_t
entries_equal(const struct entry
*a
, const struct entry
*b
) {
200 if (strncmp(a
->description
, b
->description
, sizeof(a
->description
)))
206 static inline struct entry
*load_or_initialize_entry(struct userdata
*u
, struct entry
*entry
, const char *name
, const char *prefix
) {
214 if ((old
= read_entry(u
, name
)))
217 /* This is a new device, so make sure we write it's priority list correctly */
218 uint32_t max_priority
[NUM_ROLES
];
222 pa_zero(max_priority
);
223 done
= !pa_database_first(u
->database
, &key
, NULL
);
225 /* Find all existing devices with the same prefix so we calculate the current max priority for each role */
229 done
= !pa_database_next(u
->database
, &key
, &next_key
, NULL
);
231 if (key
.size
> strlen(prefix
) && strncmp(key
.data
, prefix
, strlen(prefix
)) == 0) {
235 name2
= pa_xstrndup(key
.data
, key
.size
);
237 if ((e
= read_entry(u
, name2
))) {
238 for (uint32_t i
= 0; i
< NUM_ROLES
; ++i
) {
239 max_priority
[i
] = PA_MAX(max_priority
[i
], e
->priority
[i
]);
251 /* Actually initialise our entry now we've calculated it */
252 for (uint32_t i
= 0; i
< NUM_ROLES
; ++i
) {
253 entry
->priority
[i
] = max_priority
[i
] + 1;
260 static void subscribe_callback(pa_core
*c
, pa_subscription_event_type_t t
, uint32_t idx
, void *userdata
) {
261 struct userdata
*u
= userdata
;
262 struct entry entry
, *old
= NULL
;
269 if (t
!= (PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_NEW
) &&
270 t
!= (PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
) &&
271 t
!= (PA_SUBSCRIPTION_EVENT_SOURCE
|PA_SUBSCRIPTION_EVENT_NEW
) &&
272 t
!= (PA_SUBSCRIPTION_EVENT_SOURCE
|PA_SUBSCRIPTION_EVENT_CHANGE
))
276 entry
.version
= ENTRY_VERSION
;
278 if ((t
& PA_SUBSCRIPTION_EVENT_FACILITY_MASK
) == PA_SUBSCRIPTION_EVENT_SINK
) {
281 if (!(sink
= pa_idxset_get_by_index(c
->sinks
, idx
)))
284 name
= pa_sprintf_malloc("sink:%s", sink
->name
);
286 old
= load_or_initialize_entry(u
, &entry
, name
, "sink:");
288 pa_strlcpy(entry
.description
, pa_strnull(pa_proplist_gets(sink
->proplist
, PA_PROP_DEVICE_DESCRIPTION
)), sizeof(entry
.description
));
293 pa_assert((t
& PA_SUBSCRIPTION_EVENT_FACILITY_MASK
) == PA_SUBSCRIPTION_EVENT_SOURCE
);
295 if (!(source
= pa_idxset_get_by_index(c
->sources
, idx
)))
298 if (source
->monitor_of
)
301 name
= pa_sprintf_malloc("source:%s", source
->name
);
303 old
= load_or_initialize_entry(u
, &entry
, name
, "source:");
305 pa_strlcpy(entry
.description
, pa_strnull(pa_proplist_gets(source
->proplist
, PA_PROP_DEVICE_DESCRIPTION
)), sizeof(entry
.description
));
310 if (entries_equal(old
, &entry
)) {
320 key
.size
= strlen(name
);
323 data
.size
= sizeof(entry
);
325 pa_log_info("Storing device %s.", name
);
327 pa_database_set(u
->database
, &key
, &data
, TRUE
);
334 static pa_hook_result_t
sink_new_hook_callback(pa_core
*c
, pa_sink_new_data
*new_data
, struct userdata
*u
) {
342 name
= pa_sprintf_malloc("sink:%s", new_data
->name
);
344 if ((e
= read_entry(u
, name
))) {
345 if (strncmp(e
->description
, pa_proplist_gets(new_data
->proplist
, PA_PROP_DEVICE_DESCRIPTION
), sizeof(e
->description
)) != 0) {
346 pa_log_info("Restoring description for sink %s.", new_data
->name
);
347 pa_proplist_sets(new_data
->proplist
, PA_PROP_DEVICE_DESCRIPTION
, e
->description
);
358 static pa_hook_result_t
source_new_hook_callback(pa_core
*c
, pa_source_new_data
*new_data
, struct userdata
*u
) {
366 name
= pa_sprintf_malloc("source:%s", new_data
->name
);
368 if ((e
= read_entry(u
, name
))) {
369 if (strncmp(e
->description
, pa_proplist_gets(new_data
->proplist
, PA_PROP_DEVICE_DESCRIPTION
), sizeof(e
->description
)) != 0) {
370 /* NB, We cannot detect if we are a monitor here... this could mess things up a bit... */
371 pa_log_info("Restoring description for source %s.", new_data
->name
);
372 pa_proplist_sets(new_data
->proplist
, PA_PROP_DEVICE_DESCRIPTION
, e
->description
);
383 static char *get_name(const char *key
, const char *prefix
) {
386 if (strncmp(key
, prefix
, strlen(prefix
)))
389 t
= pa_xstrdup(key
+ strlen(prefix
));
393 static void apply_entry(struct userdata
*u
, const char *name
, struct entry
*e
) {
403 if ((n
= get_name(name
, "sink:"))) {
404 for (sink
= pa_idxset_first(u
->core
->sinks
, &idx
); sink
; sink
= pa_idxset_next(u
->core
->sinks
, &idx
)) {
405 if (!pa_streq(sink
->name
, n
)) {
409 pa_log_info("Setting description for sink %s.", sink
->name
);
410 pa_sink_set_description(sink
, e
->description
);
414 else if ((n
= get_name(name
, "source:"))) {
415 for (source
= pa_idxset_first(u
->core
->sources
, &idx
); source
; source
= pa_idxset_next(u
->core
->sources
, &idx
)) {
416 if (!pa_streq(source
->name
, n
)) {
420 if (source
->monitor_of
) {
421 pa_log_warn("Cowardly refusing to set the description for monitor source %s.", source
->name
);
425 pa_log_info("Setting description for source %s.", source
->name
);
426 pa_source_set_description(source
, e
->description
);
433 static uint32_t get_role_index(const char* role
) {
436 if (strcmp(role
, "") == 0)
438 if (strcmp(role
, "video") == 0)
440 if (strcmp(role
, "music") == 0)
442 if (strcmp(role
, "game") == 0)
444 if (strcmp(role
, "event") == 0)
446 if (strcmp(role
, "phone") == 0)
448 if (strcmp(role
, "animation") == 0)
449 return ROLE_ANIMATION
;
450 if (strcmp(role
, "production") == 0)
451 return ROLE_PRODUCTION
;
452 if (strcmp(role
, "a11y") == 0)
454 return PA_INVALID_INDEX
;
457 #define EXT_VERSION 1
459 static int extension_cb(pa_native_protocol
*p
, pa_module
*m
, pa_native_connection
*c
, uint32_t tag
, pa_tagstruct
*t
) {
462 pa_tagstruct
*reply
= NULL
;
471 if (pa_tagstruct_getu32(t
, &command
) < 0)
474 reply
= pa_tagstruct_new(NULL
, 0);
475 pa_tagstruct_putu32(reply
, PA_COMMAND_REPLY
);
476 pa_tagstruct_putu32(reply
, tag
);
479 case SUBCOMMAND_TEST
: {
480 if (!pa_tagstruct_eof(t
))
483 pa_tagstruct_putu32(reply
, EXT_VERSION
);
487 case SUBCOMMAND_READ
: {
491 if (!pa_tagstruct_eof(t
))
494 done
= !pa_database_first(u
->database
, &key
, NULL
);
501 done
= !pa_database_next(u
->database
, &key
, &next_key
, NULL
);
503 name
= pa_xstrndup(key
.data
, key
.size
);
506 if ((e
= read_entry(u
, name
))) {
507 pa_tagstruct_puts(reply
, name
);
508 pa_tagstruct_puts(reply
, e
->description
);
521 case SUBCOMMAND_RENAME
: {
524 const char *device
, *description
;
526 if (pa_tagstruct_gets(t
, &device
) < 0 ||
527 pa_tagstruct_gets(t
, &description
) < 0)
530 if (!device
|| !*device
|| !description
|| !*description
)
533 if ((e
= read_entry(u
, device
)) && ENTRY_VERSION
== e
->version
) {
536 pa_strlcpy(e
->description
, description
, sizeof(e
->description
));
538 key
.data
= (char *) device
;
539 key
.size
= strlen(device
);
542 data
.size
= sizeof(*e
);
544 if (pa_database_set(u
->database
, &key
, &data
, FALSE
) == 0) {
545 apply_entry(u
, device
, e
);
550 pa_log_warn("Could not save device");
555 pa_log_warn("Could not rename device %s, no entry in database", device
);
560 case SUBCOMMAND_DELETE
:
562 while (!pa_tagstruct_eof(t
)) {
566 if (pa_tagstruct_gets(t
, &name
) < 0)
569 key
.data
= (char*) name
;
570 key
.size
= strlen(name
);
572 /** @todo: Reindex the priorities */
573 pa_database_unset(u
->database
, &key
);
580 case SUBCOMMAND_ROLE_DEVICE_PRIORITY_ROUTING
: {
583 uint32_t sridx
= PA_INVALID_INDEX
;
587 if (pa_tagstruct_get_boolean(t
, &enable
) < 0)
590 /* If this is the first run, check for stream restore module */
591 if (!u
->checked_stream_restore
) {
592 u
->checked_stream_restore
= TRUE
;
594 for (module
= pa_idxset_first(u
->core
->modules
, &idx
); module
; module
= pa_idxset_next(u
->core
->modules
, &idx
)) {
595 if (strcmp(module
->name
, "module-stream-restore") == 0) {
596 pa_log_debug("Detected module-stream-restore is currently in use");
597 u
->stream_restore_used
= TRUE
;
598 sridx
= module
->index
;
603 u
->role_device_priority_routing
= enable
;
605 if (u
->stream_restore_used
) {
606 if (PA_INVALID_INDEX
== sridx
) {
607 /* As a shortcut on first load, we have sridx filled in, but otherwise we search for it. */
608 for (module
= pa_idxset_first(u
->core
->modules
, &idx
); module
; module
= pa_idxset_next(u
->core
->modules
, &idx
)) {
609 if (strcmp(module
->name
, "module-stream-restore") == 0) {
610 sridx
= module
->index
;
614 if (PA_INVALID_INDEX
!= sridx
) {
615 pa_log_debug("Unloading module-stream-restore to enable role-based device-priority routing");
616 pa_module_unload_request_by_index(u
->core
, sridx
, TRUE
);
619 } else if (u
->stream_restore_used
) {
620 /* We want to reload module-stream-restore */
621 if (!pa_module_load(u
->core
, "module-stream-restore", ""))
622 pa_log_warn("Failed to load module-stream-restore while disabling role-based device-priority routing");
628 case SUBCOMMAND_PREFER_DEVICE
:
629 case SUBCOMMAND_DEFER_DEVICE
: {
631 const char *role
, *device
;
635 if (pa_tagstruct_gets(t
, &role
) < 0 ||
636 pa_tagstruct_gets(t
, &device
) < 0)
639 if (!role
|| !device
|| !*device
)
642 role_index
= get_role_index(role
);
643 if (PA_INVALID_INDEX
== role_index
)
646 if ((e
= read_entry(u
, device
)) && ENTRY_VERSION
== e
->version
) {
651 pa_bool_t haschanged
= FALSE
;
653 if (strncmp(device
, "sink:", 5) == 0)
654 prefix
= pa_xstrdup("sink:");
656 prefix
= pa_xstrdup("source:");
658 priority
= e
->priority
[role_index
];
660 /* Now we need to load up all the other entries of this type and shuffle the priroities around */
662 done
= !pa_database_first(u
->database
, &key
, NULL
);
664 while (!done
&& !haschanged
) {
667 done
= !pa_database_next(u
->database
, &key
, &next_key
, NULL
);
669 /* Only read devices with the right prefix */
670 if (key
.size
> strlen(prefix
) && strncmp(key
.data
, prefix
, strlen(prefix
)) == 0) {
674 name
= pa_xstrndup(key
.data
, key
.size
);
676 if ((e2
= read_entry(u
, name
))) {
677 if (SUBCOMMAND_PREFER_DEVICE
== command
) {
679 if (e2
->priority
[role_index
] == (priority
- 1)) {
680 e2
->priority
[role_index
]++;
685 if (e2
->priority
[role_index
] == (priority
+ 1)) {
686 e2
->priority
[role_index
]--;
693 data
.size
= sizeof(*e2
);
695 if (pa_database_set(u
->database
, &key
, &data
, FALSE
))
696 pa_log_warn("Could not save device");
709 /* Now write out our actual entry */
711 if (SUBCOMMAND_PREFER_DEVICE
== command
)
712 e
->priority
[role_index
]--;
714 e
->priority
[role_index
]++;
716 key
.data
= (char *) device
;
717 key
.size
= strlen(device
);
720 data
.size
= sizeof(*e
);
722 if (pa_database_set(u
->database
, &key
, &data
, FALSE
))
723 pa_log_warn("Could not save device");
733 pa_log_warn("Could not reorder device %s, no entry in database", device
);
738 case SUBCOMMAND_SUBSCRIBE
: {
742 if (pa_tagstruct_get_boolean(t
, &enabled
) < 0 ||
743 !pa_tagstruct_eof(t
))
747 pa_idxset_put(u
->subscribed
, c
, NULL
);
749 pa_idxset_remove_by_data(u
->subscribed
, c
, NULL
);
758 pa_pstream_send_tagstruct(pa_native_connection_get_pstream(c
), reply
);
764 pa_tagstruct_free(reply
);
769 static pa_hook_result_t
connection_unlink_hook_cb(pa_native_protocol
*p
, pa_native_connection
*c
, struct userdata
*u
) {
774 pa_idxset_remove_by_data(u
->subscribed
, c
, NULL
);
778 int pa__init(pa_module
*m
) {
779 pa_modargs
*ma
= NULL
;
788 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
789 pa_log("Failed to parse module arguments");
793 m
->userdata
= u
= pa_xnew0(struct userdata
, 1);
796 u
->subscribed
= pa_idxset_new(pa_idxset_trivial_hash_func
, pa_idxset_trivial_compare_func
);
798 u
->protocol
= pa_native_protocol_get(m
->core
);
799 pa_native_protocol_install_ext(u
->protocol
, m
, extension_cb
);
801 u
->connection_unlink_hook_slot
= pa_hook_connect(&pa_native_protocol_hooks(u
->protocol
)[PA_NATIVE_HOOK_CONNECTION_UNLINK
], PA_HOOK_NORMAL
, (pa_hook_cb_t
) connection_unlink_hook_cb
, u
);
803 u
->subscription
= pa_subscription_new(m
->core
, PA_SUBSCRIPTION_MASK_SINK
|PA_SUBSCRIPTION_MASK_SOURCE
, subscribe_callback
, u
);
805 u
->sink_new_hook_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SINK_NEW
], PA_HOOK_EARLY
, (pa_hook_cb_t
) sink_new_hook_callback
, u
);
806 u
->source_new_hook_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SOURCE_NEW
], PA_HOOK_EARLY
, (pa_hook_cb_t
) source_new_hook_callback
, u
);
808 if (!(fname
= pa_state_path("device-manager", TRUE
)))
811 if (!(u
->database
= pa_database_open(fname
, TRUE
))) {
812 pa_log("Failed to open volume database '%s': %s", fname
, pa_cstrerror(errno
));
817 pa_log_info("Sucessfully opened database file '%s'.", fname
);
820 for (sink
= pa_idxset_first(m
->core
->sinks
, &idx
); sink
; sink
= pa_idxset_next(m
->core
->sinks
, &idx
))
821 subscribe_callback(m
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_NEW
, sink
->index
, u
);
823 for (source
= pa_idxset_first(m
->core
->sources
, &idx
); source
; source
= pa_idxset_next(m
->core
->sources
, &idx
))
824 subscribe_callback(m
->core
, PA_SUBSCRIPTION_EVENT_SOURCE
|PA_SUBSCRIPTION_EVENT_NEW
, source
->index
, u
);
838 void pa__done(pa_module
*m
) {
843 if (!(u
= m
->userdata
))
847 pa_subscription_free(u
->subscription
);
849 if (u
->sink_new_hook_slot
)
850 pa_hook_slot_free(u
->sink_new_hook_slot
);
851 if (u
->source_new_hook_slot
)
852 pa_hook_slot_free(u
->source_new_hook_slot
);
854 if (u
->save_time_event
)
855 u
->core
->mainloop
->time_free(u
->save_time_event
);
858 pa_database_close(u
->database
);
861 pa_native_protocol_remove_ext(u
->protocol
, m
);
862 pa_native_protocol_unref(u
->protocol
);
866 pa_idxset_free(u
->subscribed
, NULL
, NULL
);