2 This file is part of PulseAudio.
4 Copyright 2006 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/timeval.h>
28 #include <pulse/rtclock.h>
30 #include <pulsecore/core.h>
31 #include <pulsecore/core-util.h>
32 #include <pulsecore/sink-input.h>
33 #include <pulsecore/source-output.h>
34 #include <pulsecore/modargs.h>
35 #include <pulsecore/log.h>
36 #include <pulsecore/namereg.h>
38 #include "module-suspend-on-idle-symdef.h"
40 PA_MODULE_AUTHOR("Lennart Poettering");
41 PA_MODULE_DESCRIPTION("When a sink/source is idle for too long, suspend it");
42 PA_MODULE_VERSION(PACKAGE_VERSION
);
43 PA_MODULE_LOAD_ONCE(TRUE
);
45 static const char* const valid_modargs
[] = {
53 pa_hashmap
*device_infos
;
59 *sink_state_changed_slot
,
60 *source_state_changed_slot
;
64 *source_output_new_slot
,
65 *sink_input_unlink_slot
,
66 *source_output_unlink_slot
,
67 *sink_input_move_start_slot
,
68 *source_output_move_start_slot
,
69 *sink_input_move_finish_slot
,
70 *source_output_move_finish_slot
,
71 *sink_input_state_changed_slot
,
72 *source_output_state_changed_slot
;
76 struct userdata
*userdata
;
80 pa_time_event
*time_event
;
83 static void timeout_cb(pa_mainloop_api
*a
, pa_time_event
* e
, const struct timeval
*t
, void *userdata
) {
84 struct device_info
*d
= userdata
;
88 d
->userdata
->core
->mainloop
->time_restart(d
->time_event
, NULL
);
90 if (d
->sink
&& pa_sink_check_suspend(d
->sink
) <= 0 && !(d
->sink
->suspend_cause
& PA_SUSPEND_IDLE
)) {
91 pa_log_info("Sink %s idle for too long, suspending ...", d
->sink
->name
);
92 pa_sink_suspend(d
->sink
, TRUE
, PA_SUSPEND_IDLE
);
95 if (d
->source
&& pa_source_check_suspend(d
->source
) <= 0 && !(d
->source
->suspend_cause
& PA_SUSPEND_IDLE
)) {
96 pa_log_info("Source %s idle for too long, suspending ...", d
->source
->name
);
97 pa_source_suspend(d
->source
, TRUE
, PA_SUSPEND_IDLE
);
101 static void restart(struct device_info
*d
) {
107 pa_assert(d
->sink
|| d
->source
);
109 d
->last_use
= now
= pa_rtclock_now();
111 s
= pa_proplist_gets(d
->sink
? d
->sink
->proplist
: d
->source
->proplist
, "module-suspend-on-idle.timeout");
112 if (!s
|| pa_atou(s
, &timeout
) < 0)
113 timeout
= d
->userdata
->timeout
;
115 pa_core_rttime_restart(d
->userdata
->core
, d
->time_event
, now
+ timeout
* PA_USEC_PER_SEC
);
118 pa_log_debug("Sink %s becomes idle, timeout in %u seconds.", d
->sink
->name
, timeout
);
120 pa_log_debug("Source %s becomes idle, timeout in %u seconds.", d
->source
->name
, timeout
);
123 static void resume(struct device_info
*d
) {
126 d
->userdata
->core
->mainloop
->time_restart(d
->time_event
, NULL
);
129 pa_sink_suspend(d
->sink
, FALSE
, PA_SUSPEND_IDLE
);
131 pa_log_debug("Sink %s becomes busy.", d
->sink
->name
);
135 pa_source_suspend(d
->source
, FALSE
, PA_SUSPEND_IDLE
);
137 pa_log_debug("Source %s becomes busy.", d
->source
->name
);
141 static pa_hook_result_t
sink_input_fixate_hook_cb(pa_core
*c
, pa_sink_input_new_data
*data
, struct userdata
*u
) {
142 struct device_info
*d
;
148 if (data
->flags
& PA_SINK_INPUT_START_CORKED
)
151 if ((d
= pa_hashmap_get(u
->device_infos
, data
->sink
)))
157 static pa_hook_result_t
source_output_fixate_hook_cb(pa_core
*c
, pa_source_output_new_data
*data
, struct userdata
*u
) {
158 struct device_info
*d
;
164 if (data
->flags
& PA_SOURCE_OUTPUT_START_CORKED
)
167 if (data
->source
->monitor_of
)
168 d
= pa_hashmap_get(u
->device_infos
, data
->source
->monitor_of
);
170 d
= pa_hashmap_get(u
->device_infos
, data
->source
);
178 static pa_hook_result_t
sink_input_unlink_hook_cb(pa_core
*c
, pa_sink_input
*s
, struct userdata
*u
) {
180 pa_sink_input_assert_ref(s
);
186 if (pa_sink_check_suspend(s
->sink
) <= 0) {
187 struct device_info
*d
;
188 if ((d
= pa_hashmap_get(u
->device_infos
, s
->sink
)))
195 static pa_hook_result_t
source_output_unlink_hook_cb(pa_core
*c
, pa_source_output
*s
, struct userdata
*u
) {
196 struct device_info
*d
= NULL
;
199 pa_source_output_assert_ref(s
);
205 if (s
->source
->monitor_of
) {
206 if (pa_sink_check_suspend(s
->source
->monitor_of
) <= 0)
207 d
= pa_hashmap_get(u
->device_infos
, s
->source
->monitor_of
);
209 if (pa_source_check_suspend(s
->source
) <= 0)
210 d
= pa_hashmap_get(u
->device_infos
, s
->source
);
219 static pa_hook_result_t
sink_input_move_start_hook_cb(pa_core
*c
, pa_sink_input
*s
, struct userdata
*u
) {
220 struct device_info
*d
;
223 pa_sink_input_assert_ref(s
);
226 if (pa_sink_check_suspend(s
->sink
) <= 1)
227 if ((d
= pa_hashmap_get(u
->device_infos
, s
->sink
)))
233 static pa_hook_result_t
sink_input_move_finish_hook_cb(pa_core
*c
, pa_sink_input
*s
, struct userdata
*u
) {
234 struct device_info
*d
;
235 pa_sink_input_state_t state
;
238 pa_sink_input_assert_ref(s
);
241 state
= pa_sink_input_get_state(s
);
242 if (state
!= PA_SINK_INPUT_RUNNING
&& state
!= PA_SINK_INPUT_DRAINED
)
245 if ((d
= pa_hashmap_get(u
->device_infos
, s
->sink
)))
251 static pa_hook_result_t
source_output_move_start_hook_cb(pa_core
*c
, pa_source_output
*s
, struct userdata
*u
) {
252 struct device_info
*d
= NULL
;
255 pa_source_output_assert_ref(s
);
258 if (s
->source
->monitor_of
) {
259 if (pa_sink_check_suspend(s
->source
->monitor_of
) <= 1)
260 d
= pa_hashmap_get(u
->device_infos
, s
->source
->monitor_of
);
262 if (pa_source_check_suspend(s
->source
) <= 1)
263 d
= pa_hashmap_get(u
->device_infos
, s
->source
);
272 static pa_hook_result_t
source_output_move_finish_hook_cb(pa_core
*c
, pa_source_output
*s
, struct userdata
*u
) {
273 struct device_info
*d
;
276 pa_source_output_assert_ref(s
);
279 if (pa_source_output_get_state(s
) != PA_SOURCE_OUTPUT_RUNNING
)
282 if (s
->source
->monitor_of
)
283 d
= pa_hashmap_get(u
->device_infos
, s
->source
->monitor_of
);
285 d
= pa_hashmap_get(u
->device_infos
, s
->source
);
293 static pa_hook_result_t
sink_input_state_changed_hook_cb(pa_core
*c
, pa_sink_input
*s
, struct userdata
*u
) {
294 struct device_info
*d
;
295 pa_sink_input_state_t state
;
298 pa_sink_input_assert_ref(s
);
301 state
= pa_sink_input_get_state(s
);
302 if (state
== PA_SINK_INPUT_RUNNING
|| state
== PA_SINK_INPUT_DRAINED
)
303 if ((d
= pa_hashmap_get(u
->device_infos
, s
->sink
)))
309 static pa_hook_result_t
source_output_state_changed_hook_cb(pa_core
*c
, pa_source_output
*s
, struct userdata
*u
) {
311 pa_source_output_assert_ref(s
);
314 if (pa_source_output_get_state(s
) == PA_SOURCE_OUTPUT_RUNNING
) {
315 struct device_info
*d
;
317 if (s
->source
->monitor_of
)
318 d
= pa_hashmap_get(u
->device_infos
, s
->source
->monitor_of
);
320 d
= pa_hashmap_get(u
->device_infos
, s
->source
);
329 static pa_hook_result_t
device_new_hook_cb(pa_core
*c
, pa_object
*o
, struct userdata
*u
) {
330 struct device_info
*d
;
335 pa_object_assert_ref(o
);
338 source
= pa_source_isinstance(o
) ? PA_SOURCE(o
) : NULL
;
339 sink
= pa_sink_isinstance(o
) ? PA_SINK(o
) : NULL
;
341 /* Never suspend monitors */
342 if (source
&& source
->monitor_of
)
345 pa_assert(source
|| sink
);
347 d
= pa_xnew(struct device_info
, 1);
349 d
->source
= source
? pa_source_ref(source
) : NULL
;
350 d
->sink
= sink
? pa_sink_ref(sink
) : NULL
;
351 d
->time_event
= pa_core_rttime_new(c
, PA_USEC_INVALID
, timeout_cb
, d
);
352 pa_hashmap_put(u
->device_infos
, o
, d
);
354 if ((d
->sink
&& pa_sink_check_suspend(d
->sink
) <= 0) ||
355 (d
->source
&& pa_source_check_suspend(d
->source
) <= 0))
361 static void device_info_free(struct device_info
*d
) {
365 pa_source_unref(d
->source
);
367 pa_sink_unref(d
->sink
);
369 d
->userdata
->core
->mainloop
->time_free(d
->time_event
);
374 static pa_hook_result_t
device_unlink_hook_cb(pa_core
*c
, pa_object
*o
, struct userdata
*u
) {
375 struct device_info
*d
;
378 pa_object_assert_ref(o
);
381 if ((d
= pa_hashmap_remove(u
->device_infos
, o
)))
387 static pa_hook_result_t
device_state_changed_hook_cb(pa_core
*c
, pa_object
*o
, struct userdata
*u
) {
388 struct device_info
*d
;
391 pa_object_assert_ref(o
);
394 if (!(d
= pa_hashmap_get(u
->device_infos
, o
)))
397 if (pa_sink_isinstance(o
)) {
398 pa_sink
*s
= PA_SINK(o
);
399 pa_sink_state_t state
= pa_sink_get_state(s
);
401 if (pa_sink_check_suspend(s
) <= 0)
402 if (PA_SINK_IS_OPENED(state
))
405 } else if (pa_source_isinstance(o
)) {
406 pa_source
*s
= PA_SOURCE(o
);
407 pa_source_state_t state
= pa_source_get_state(s
);
409 if (pa_source_check_suspend(s
) <= 0)
410 if (PA_SOURCE_IS_OPENED(state
))
417 int pa__init(pa_module
*m
) {
418 pa_modargs
*ma
= NULL
;
420 uint32_t timeout
= 5;
427 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
428 pa_log("Failed to parse module arguments.");
432 if (pa_modargs_get_value_u32(ma
, "timeout", &timeout
) < 0) {
433 pa_log("Failed to parse timeout value.");
437 m
->userdata
= u
= pa_xnew(struct userdata
, 1);
439 u
->timeout
= timeout
;
440 u
->device_infos
= pa_hashmap_new(pa_idxset_trivial_hash_func
, pa_idxset_trivial_compare_func
);
442 for (sink
= pa_idxset_first(m
->core
->sinks
, &idx
); sink
; sink
= pa_idxset_next(m
->core
->sinks
, &idx
))
443 device_new_hook_cb(m
->core
, PA_OBJECT(sink
), u
);
445 for (source
= pa_idxset_first(m
->core
->sources
, &idx
); source
; source
= pa_idxset_next(m
->core
->sources
, &idx
))
446 device_new_hook_cb(m
->core
, PA_OBJECT(source
), u
);
448 u
->sink_new_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SINK_PUT
], PA_HOOK_NORMAL
, (pa_hook_cb_t
) device_new_hook_cb
, u
);
449 u
->source_new_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SOURCE_PUT
], PA_HOOK_NORMAL
, (pa_hook_cb_t
) device_new_hook_cb
, u
);
450 u
->sink_unlink_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SINK_UNLINK_POST
], PA_HOOK_NORMAL
, (pa_hook_cb_t
) device_unlink_hook_cb
, u
);
451 u
->source_unlink_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SOURCE_UNLINK_POST
], PA_HOOK_NORMAL
, (pa_hook_cb_t
) device_unlink_hook_cb
, u
);
452 u
->sink_state_changed_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SINK_STATE_CHANGED
], PA_HOOK_NORMAL
, (pa_hook_cb_t
) device_state_changed_hook_cb
, u
);
453 u
->source_state_changed_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SOURCE_STATE_CHANGED
], PA_HOOK_NORMAL
, (pa_hook_cb_t
) device_state_changed_hook_cb
, u
);
455 u
->sink_input_new_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_FIXATE
], PA_HOOK_NORMAL
, (pa_hook_cb_t
) sink_input_fixate_hook_cb
, u
);
456 u
->source_output_new_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SOURCE_OUTPUT_FIXATE
], PA_HOOK_NORMAL
, (pa_hook_cb_t
) source_output_fixate_hook_cb
, u
);
457 u
->sink_input_unlink_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_UNLINK_POST
], PA_HOOK_NORMAL
, (pa_hook_cb_t
) sink_input_unlink_hook_cb
, u
);
458 u
->source_output_unlink_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK_POST
], PA_HOOK_NORMAL
, (pa_hook_cb_t
) source_output_unlink_hook_cb
, u
);
459 u
->sink_input_move_start_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_MOVE_START
], PA_HOOK_NORMAL
, (pa_hook_cb_t
) sink_input_move_start_hook_cb
, u
);
460 u
->source_output_move_start_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_START
], PA_HOOK_NORMAL
, (pa_hook_cb_t
) source_output_move_start_hook_cb
, u
);
461 u
->sink_input_move_finish_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_MOVE_FINISH
], PA_HOOK_NORMAL
, (pa_hook_cb_t
) sink_input_move_finish_hook_cb
, u
);
462 u
->source_output_move_finish_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_FINISH
], PA_HOOK_NORMAL
, (pa_hook_cb_t
) source_output_move_finish_hook_cb
, u
);
463 u
->sink_input_state_changed_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED
], PA_HOOK_NORMAL
, (pa_hook_cb_t
) sink_input_state_changed_hook_cb
, u
);
464 u
->source_output_state_changed_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SOURCE_OUTPUT_STATE_CHANGED
], PA_HOOK_NORMAL
, (pa_hook_cb_t
) source_output_state_changed_hook_cb
, u
);
477 void pa__done(pa_module
*m
) {
479 struct device_info
*d
;
488 if (u
->sink_new_slot
)
489 pa_hook_slot_free(u
->sink_new_slot
);
490 if (u
->sink_unlink_slot
)
491 pa_hook_slot_free(u
->sink_unlink_slot
);
492 if (u
->sink_state_changed_slot
)
493 pa_hook_slot_free(u
->sink_state_changed_slot
);
495 if (u
->source_new_slot
)
496 pa_hook_slot_free(u
->source_new_slot
);
497 if (u
->source_unlink_slot
)
498 pa_hook_slot_free(u
->source_unlink_slot
);
499 if (u
->source_state_changed_slot
)
500 pa_hook_slot_free(u
->source_state_changed_slot
);
502 if (u
->sink_input_new_slot
)
503 pa_hook_slot_free(u
->sink_input_new_slot
);
504 if (u
->sink_input_unlink_slot
)
505 pa_hook_slot_free(u
->sink_input_unlink_slot
);
506 if (u
->sink_input_move_start_slot
)
507 pa_hook_slot_free(u
->sink_input_move_start_slot
);
508 if (u
->sink_input_move_finish_slot
)
509 pa_hook_slot_free(u
->sink_input_move_finish_slot
);
510 if (u
->sink_input_state_changed_slot
)
511 pa_hook_slot_free(u
->sink_input_state_changed_slot
);
513 if (u
->source_output_new_slot
)
514 pa_hook_slot_free(u
->source_output_new_slot
);
515 if (u
->source_output_unlink_slot
)
516 pa_hook_slot_free(u
->source_output_unlink_slot
);
517 if (u
->source_output_move_start_slot
)
518 pa_hook_slot_free(u
->source_output_move_start_slot
);
519 if (u
->source_output_move_finish_slot
)
520 pa_hook_slot_free(u
->source_output_move_finish_slot
);
521 if (u
->source_output_state_changed_slot
)
522 pa_hook_slot_free(u
->source_output_state_changed_slot
);
524 while ((d
= pa_hashmap_steal_first(u
->device_infos
)))
527 pa_hashmap_free(u
->device_infos
, NULL
, NULL
);