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>
37 #include "module-suspend-on-idle-symdef.h"
39 PA_MODULE_AUTHOR("Lennart Poettering");
40 PA_MODULE_DESCRIPTION("When a sink/source is idle for too long, suspend it");
41 PA_MODULE_VERSION(PACKAGE_VERSION);
42 PA_MODULE_LOAD_ONCE(true);
43 PA_MODULE_USAGE("timeout=<timeout>");
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;
84 static void timeout_cb(pa_mainloop_api*a, pa_time_event* e, const struct timeval *t, void *userdata) {
85 struct device_info *d = userdata;
89 d->userdata->core->mainloop->time_restart(d->time_event, NULL);
91 if (d->sink && pa_sink_check_suspend(d->sink) <= 0 && !(d->sink->suspend_cause & PA_SUSPEND_IDLE)) {
92 pa_log_info("Sink %s idle for too long, suspending ...", d->sink->name);
93 pa_sink_suspend(d->sink, true, PA_SUSPEND_IDLE);
94 pa_core_maybe_vacuum(d->userdata->core);
97 if (d->source && pa_source_check_suspend(d->source) <= 0 && !(d->source->suspend_cause & PA_SUSPEND_IDLE)) {
98 pa_log_info("Source %s idle for too long, suspending ...", d->source->name);
99 pa_source_suspend(d->source, true, PA_SUSPEND_IDLE);
100 pa_core_maybe_vacuum(d->userdata->core);
104 static void restart(struct device_info *d) {
108 pa_assert(d->sink || d->source);
110 d->last_use = now = pa_rtclock_now();
111 pa_core_rttime_restart(d->userdata->core, d->time_event, now + d->timeout);
114 pa_log_debug("Sink %s becomes idle, timeout in %" PRIu64 " seconds.", d->sink->name, d->timeout / PA_USEC_PER_SEC);
116 pa_log_debug("Source %s becomes idle, timeout in %" PRIu64 " seconds.", d->source->name, d->timeout / PA_USEC_PER_SEC);
119 static void resume(struct device_info *d) {
122 d->userdata->core->mainloop->time_restart(d->time_event, NULL);
125 pa_log_debug("Sink %s becomes busy, resuming.", d->sink->name);
126 pa_sink_suspend(d->sink, false, PA_SUSPEND_IDLE);
130 pa_log_debug("Source %s becomes busy, resuming.", d->source->name);
131 pa_source_suspend(d->source, false, PA_SUSPEND_IDLE);
135 static pa_hook_result_t sink_input_fixate_hook_cb(pa_core *c, pa_sink_input_new_data *data, struct userdata *u) {
136 struct device_info *d;
142 /* We need to resume the audio device here even for
143 * PA_SINK_INPUT_START_CORKED, since we need the device parameters
144 * to be fully available while the stream is set up. */
146 if ((d = pa_hashmap_get(u->device_infos, data->sink)))
152 static pa_hook_result_t source_output_fixate_hook_cb(pa_core *c, pa_source_output_new_data *data, struct userdata *u) {
153 struct device_info *d;
159 if (data->source->monitor_of)
160 d = pa_hashmap_get(u->device_infos, data->source->monitor_of);
162 d = pa_hashmap_get(u->device_infos, data->source);
170 static pa_hook_result_t sink_input_unlink_hook_cb(pa_core *c, pa_sink_input *s, struct userdata *u) {
172 pa_sink_input_assert_ref(s);
178 if (pa_sink_check_suspend(s->sink) <= 0) {
179 struct device_info *d;
180 if ((d = pa_hashmap_get(u->device_infos, s->sink)))
187 static pa_hook_result_t source_output_unlink_hook_cb(pa_core *c, pa_source_output *s, struct userdata *u) {
188 struct device_info *d = NULL;
191 pa_source_output_assert_ref(s);
197 if (s->source->monitor_of) {
198 if (pa_sink_check_suspend(s->source->monitor_of) <= 0)
199 d = pa_hashmap_get(u->device_infos, s->source->monitor_of);
201 if (pa_source_check_suspend(s->source) <= 0)
202 d = pa_hashmap_get(u->device_infos, s->source);
211 static pa_hook_result_t sink_input_move_start_hook_cb(pa_core *c, pa_sink_input *s, struct userdata *u) {
212 struct device_info *d;
215 pa_sink_input_assert_ref(s);
218 if (pa_sink_check_suspend(s->sink) <= 1)
219 if ((d = pa_hashmap_get(u->device_infos, s->sink)))
225 static pa_hook_result_t sink_input_move_finish_hook_cb(pa_core *c, pa_sink_input *s, struct userdata *u) {
226 struct device_info *d;
227 pa_sink_input_state_t state;
230 pa_sink_input_assert_ref(s);
233 state = pa_sink_input_get_state(s);
234 if (state != PA_SINK_INPUT_RUNNING && state != PA_SINK_INPUT_DRAINED)
237 if ((d = pa_hashmap_get(u->device_infos, s->sink)))
243 static pa_hook_result_t source_output_move_start_hook_cb(pa_core *c, pa_source_output *s, struct userdata *u) {
244 struct device_info *d = NULL;
247 pa_source_output_assert_ref(s);
250 if (s->source->monitor_of) {
251 if (pa_sink_check_suspend(s->source->monitor_of) <= 1)
252 d = pa_hashmap_get(u->device_infos, s->source->monitor_of);
254 if (pa_source_check_suspend(s->source) <= 1)
255 d = pa_hashmap_get(u->device_infos, s->source);
264 static pa_hook_result_t source_output_move_finish_hook_cb(pa_core *c, pa_source_output *s, struct userdata *u) {
265 struct device_info *d;
268 pa_source_output_assert_ref(s);
271 if (pa_source_output_get_state(s) != PA_SOURCE_OUTPUT_RUNNING)
274 if (s->source->monitor_of)
275 d = pa_hashmap_get(u->device_infos, s->source->monitor_of);
277 d = pa_hashmap_get(u->device_infos, s->source);
285 static pa_hook_result_t sink_input_state_changed_hook_cb(pa_core *c, pa_sink_input *s, struct userdata *u) {
286 struct device_info *d;
287 pa_sink_input_state_t state;
290 pa_sink_input_assert_ref(s);
293 state = pa_sink_input_get_state(s);
294 if (state == PA_SINK_INPUT_RUNNING || state == PA_SINK_INPUT_DRAINED)
295 if ((d = pa_hashmap_get(u->device_infos, s->sink)))
301 static pa_hook_result_t source_output_state_changed_hook_cb(pa_core *c, pa_source_output *s, struct userdata *u) {
303 pa_source_output_assert_ref(s);
306 if (pa_source_output_get_state(s) == PA_SOURCE_OUTPUT_RUNNING) {
307 struct device_info *d;
309 if (s->source->monitor_of)
310 d = pa_hashmap_get(u->device_infos, s->source->monitor_of);
312 d = pa_hashmap_get(u->device_infos, s->source);
321 static pa_hook_result_t device_new_hook_cb(pa_core *c, pa_object *o, struct userdata *u) {
322 struct device_info *d;
325 const char *timeout_str;
330 pa_object_assert_ref(o);
333 source = pa_source_isinstance(o) ? PA_SOURCE(o) : NULL;
334 sink = pa_sink_isinstance(o) ? PA_SINK(o) : NULL;
336 /* Never suspend monitors */
337 if (source && source->monitor_of)
340 pa_assert(source || sink);
342 timeout_str = pa_proplist_gets(sink ? sink->proplist : source->proplist, "module-suspend-on-idle.timeout");
343 if (timeout_str && pa_atoi(timeout_str, &timeout) >= 0)
344 timeout_valid = true;
346 timeout_valid = false;
348 if (timeout_valid && timeout < 0)
351 d = pa_xnew(struct device_info, 1);
353 d->source = source ? pa_source_ref(source) : NULL;
354 d->sink = sink ? pa_sink_ref(sink) : NULL;
355 d->time_event = pa_core_rttime_new(c, PA_USEC_INVALID, timeout_cb, d);
358 d->timeout = timeout * PA_USEC_PER_SEC;
360 d->timeout = d->userdata->timeout;
362 pa_hashmap_put(u->device_infos, o, d);
364 if ((d->sink && pa_sink_check_suspend(d->sink) <= 0) ||
365 (d->source && pa_source_check_suspend(d->source) <= 0))
371 static void device_info_free(struct device_info *d) {
375 pa_source_unref(d->source);
377 pa_sink_unref(d->sink);
379 d->userdata->core->mainloop->time_free(d->time_event);
384 static pa_hook_result_t device_unlink_hook_cb(pa_core *c, pa_object *o, struct userdata *u) {
385 struct device_info *d;
388 pa_object_assert_ref(o);
391 if ((d = pa_hashmap_remove(u->device_infos, o)))
397 static pa_hook_result_t device_state_changed_hook_cb(pa_core *c, pa_object *o, struct userdata *u) {
398 struct device_info *d;
401 pa_object_assert_ref(o);
404 if (!(d = pa_hashmap_get(u->device_infos, o)))
407 if (pa_sink_isinstance(o)) {
408 pa_sink *s = PA_SINK(o);
409 pa_sink_state_t state = pa_sink_get_state(s);
411 if (pa_sink_check_suspend(s) <= 0)
412 if (PA_SINK_IS_OPENED(state))
415 } else if (pa_source_isinstance(o)) {
416 pa_source *s = PA_SOURCE(o);
417 pa_source_state_t state = pa_source_get_state(s);
419 if (pa_source_check_suspend(s) <= 0)
420 if (PA_SOURCE_IS_OPENED(state))
427 int pa__init(pa_module*m) {
428 pa_modargs *ma = NULL;
430 uint32_t timeout = 5;
437 if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
438 pa_log("Failed to parse module arguments.");
442 if (pa_modargs_get_value_u32(ma, "timeout", &timeout) < 0) {
443 pa_log("Failed to parse timeout value.");
447 m->userdata = u = pa_xnew(struct userdata, 1);
449 u->timeout = timeout * PA_USEC_PER_SEC;
450 u->device_infos = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
452 PA_IDXSET_FOREACH(sink, m->core->sinks, idx)
453 device_new_hook_cb(m->core, PA_OBJECT(sink), u);
455 PA_IDXSET_FOREACH(source, m->core->sources, idx)
456 device_new_hook_cb(m->core, PA_OBJECT(source), u);
458 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);
459 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);
460 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);
461 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);
462 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);
463 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);
465 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);
466 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);
467 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);
468 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);
469 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);
470 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);
471 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);
472 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);
473 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);
474 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);
487 void pa__done(pa_module*m) {
497 if (u->sink_new_slot)
498 pa_hook_slot_free(u->sink_new_slot);
499 if (u->sink_unlink_slot)
500 pa_hook_slot_free(u->sink_unlink_slot);
501 if (u->sink_state_changed_slot)
502 pa_hook_slot_free(u->sink_state_changed_slot);
504 if (u->source_new_slot)
505 pa_hook_slot_free(u->source_new_slot);
506 if (u->source_unlink_slot)
507 pa_hook_slot_free(u->source_unlink_slot);
508 if (u->source_state_changed_slot)
509 pa_hook_slot_free(u->source_state_changed_slot);
511 if (u->sink_input_new_slot)
512 pa_hook_slot_free(u->sink_input_new_slot);
513 if (u->sink_input_unlink_slot)
514 pa_hook_slot_free(u->sink_input_unlink_slot);
515 if (u->sink_input_move_start_slot)
516 pa_hook_slot_free(u->sink_input_move_start_slot);
517 if (u->sink_input_move_finish_slot)
518 pa_hook_slot_free(u->sink_input_move_finish_slot);
519 if (u->sink_input_state_changed_slot)
520 pa_hook_slot_free(u->sink_input_state_changed_slot);
522 if (u->source_output_new_slot)
523 pa_hook_slot_free(u->source_output_new_slot);
524 if (u->source_output_unlink_slot)
525 pa_hook_slot_free(u->source_output_unlink_slot);
526 if (u->source_output_move_start_slot)
527 pa_hook_slot_free(u->source_output_move_start_slot);
528 if (u->source_output_move_finish_slot)
529 pa_hook_slot_free(u->source_output_move_finish_slot);
530 if (u->source_output_state_changed_slot)
531 pa_hook_slot_free(u->source_output_state_changed_slot);
533 pa_hashmap_free(u->device_infos, (pa_free_cb_t) device_info_free);