1 /***
2 This file is part of PulseAudio.
3
4 Copyright 2006 Lennart Poettering
5
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.
10
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.
15
16 You should have received a copy of the GNU Lesser General Public License
17 along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
18 ***/
19
20 #ifdef HAVE_CONFIG_H
21 #include <config.h>
22 #endif
23
24 #include <pulse/xmalloc.h>
25 #include <pulse/timeval.h>
26 #include <pulse/rtclock.h>
27
28 #include <pulsecore/core.h>
29 #include <pulsecore/core-util.h>
30 #include <pulsecore/sink-input.h>
31 #include <pulsecore/source-output.h>
32 #include <pulsecore/modargs.h>
33 #include <pulsecore/log.h>
34
35 PA_MODULE_AUTHOR("Lennart Poettering");
36 PA_MODULE_DESCRIPTION("When a sink/source is idle for too long, suspend it");
37 PA_MODULE_VERSION(PACKAGE_VERSION);
38 PA_MODULE_LOAD_ONCE(true);
39 PA_MODULE_USAGE("timeout=<timeout>");
40
41 static const char* const valid_modargs[] = {
42 "timeout",
43 NULL,
44 };
45
46 struct userdata {
47 pa_core *core;
48 pa_usec_t timeout;
49 pa_hashmap *device_infos;
50 };
51
52 struct device_info {
53 struct userdata *userdata;
54 pa_sink *sink;
55 pa_source *source;
56 pa_usec_t last_use;
57 pa_time_event *time_event;
58 pa_usec_t timeout;
59 };
60
timeout_cb(pa_mainloop_api * a,pa_time_event * e,const struct timeval * t,void * userdata)61 static void timeout_cb(pa_mainloop_api*a, pa_time_event* e, const struct timeval *t, void *userdata) {
62 struct device_info *d = userdata;
63
64 pa_assert(d);
65
66 d->userdata->core->mainloop->time_restart(d->time_event, NULL);
67
68 if (d->sink && pa_sink_check_suspend(d->sink, NULL, NULL) <= 0 && !(d->sink->suspend_cause & PA_SUSPEND_IDLE)) {
69 pa_log_info("Sink %s idle for too long, suspending ...", d->sink->name);
70 pa_sink_suspend(d->sink, true, PA_SUSPEND_IDLE);
71 pa_core_maybe_vacuum(d->userdata->core);
72 }
73
74 if (d->source && pa_source_check_suspend(d->source, NULL) <= 0 && !(d->source->suspend_cause & PA_SUSPEND_IDLE)) {
75 pa_log_info("Source %s idle for too long, suspending ...", d->source->name);
76 pa_source_suspend(d->source, true, PA_SUSPEND_IDLE);
77 pa_core_maybe_vacuum(d->userdata->core);
78 }
79 }
80
restart(struct device_info * d)81 static void restart(struct device_info *d) {
82 pa_usec_t now;
83
84 pa_assert(d);
85 pa_assert(d->sink || d->source);
86
87 d->last_use = now = pa_rtclock_now();
88 pa_core_rttime_restart(d->userdata->core, d->time_event, now + d->timeout);
89
90 if (d->sink)
91 pa_log_debug("Sink %s becomes idle, timeout in %" PRIu64 " seconds.", d->sink->name, d->timeout / PA_USEC_PER_SEC);
92 if (d->source)
93 pa_log_debug("Source %s becomes idle, timeout in %" PRIu64 " seconds.", d->source->name, d->timeout / PA_USEC_PER_SEC);
94 }
95
resume(struct device_info * d)96 static void resume(struct device_info *d) {
97 pa_assert(d);
98
99 d->userdata->core->mainloop->time_restart(d->time_event, NULL);
100
101 if (d->sink) {
102 pa_log_debug("Sink %s becomes busy, resuming.", d->sink->name);
103 pa_sink_suspend(d->sink, false, PA_SUSPEND_IDLE);
104 }
105
106 if (d->source) {
107 pa_log_debug("Source %s becomes busy, resuming.", d->source->name);
108 pa_source_suspend(d->source, false, PA_SUSPEND_IDLE);
109 }
110 }
111
sink_input_fixate_hook_cb(pa_core * c,pa_sink_input_new_data * data,struct userdata * u)112 static pa_hook_result_t sink_input_fixate_hook_cb(pa_core *c, pa_sink_input_new_data *data, struct userdata *u) {
113 struct device_info *d;
114
115 pa_assert(c);
116 pa_assert(data);
117 pa_assert(u);
118
119 /* We need to resume the audio device here even for
120 * PA_SINK_INPUT_START_CORKED, since we need the device parameters
121 * to be fully available while the stream is set up. In that case,
122 * make sure we close the sink again after the timeout interval. */
123
124 if ((d = pa_hashmap_get(u->device_infos, data->sink))) {
125 resume(d);
126 if (pa_sink_check_suspend(d->sink, NULL, NULL) <= 0)
127 restart(d);
128 }
129
130 return PA_HOOK_OK;
131 }
132
source_output_fixate_hook_cb(pa_core * c,pa_source_output_new_data * data,struct userdata * u)133 static pa_hook_result_t source_output_fixate_hook_cb(pa_core *c, pa_source_output_new_data *data, struct userdata *u) {
134 struct device_info *d;
135
136 pa_assert(c);
137 pa_assert(data);
138 pa_assert(u);
139
140 if (data->source->monitor_of)
141 d = pa_hashmap_get(u->device_infos, data->source->monitor_of);
142 else
143 d = pa_hashmap_get(u->device_infos, data->source);
144
145 if (d) {
146 resume(d);
147 if (d->source) {
148 if (pa_source_check_suspend(d->source, NULL) <= 0)
149 restart(d);
150 } else {
151 /* The source output is connected to a monitor source. */
152 pa_assert(d->sink);
153 if (pa_sink_check_suspend(d->sink, NULL, NULL) <= 0)
154 restart(d);
155 }
156 }
157
158 return PA_HOOK_OK;
159 }
160
sink_input_unlink_hook_cb(pa_core * c,pa_sink_input * s,struct userdata * u)161 static pa_hook_result_t sink_input_unlink_hook_cb(pa_core *c, pa_sink_input *s, struct userdata *u) {
162 pa_assert(c);
163 pa_sink_input_assert_ref(s);
164 pa_assert(u);
165
166 if (!s->sink)
167 return PA_HOOK_OK;
168
169 if (pa_sink_check_suspend(s->sink, s, NULL) <= 0) {
170 struct device_info *d;
171 if ((d = pa_hashmap_get(u->device_infos, s->sink)))
172 restart(d);
173 }
174
175 return PA_HOOK_OK;
176 }
177
source_output_unlink_hook_cb(pa_core * c,pa_source_output * s,struct userdata * u)178 static pa_hook_result_t source_output_unlink_hook_cb(pa_core *c, pa_source_output *s, struct userdata *u) {
179 struct device_info *d = NULL;
180
181 pa_assert(c);
182 pa_source_output_assert_ref(s);
183 pa_assert(u);
184
185 if (!s->source)
186 return PA_HOOK_OK;
187
188 if (s->source->monitor_of) {
189 if (pa_sink_check_suspend(s->source->monitor_of, NULL, s) <= 0)
190 d = pa_hashmap_get(u->device_infos, s->source->monitor_of);
191 } else {
192 if (pa_source_check_suspend(s->source, s) <= 0)
193 d = pa_hashmap_get(u->device_infos, s->source);
194 }
195
196 if (d)
197 restart(d);
198
199 return PA_HOOK_OK;
200 }
201
sink_input_move_start_hook_cb(pa_core * c,pa_sink_input * s,struct userdata * u)202 static pa_hook_result_t sink_input_move_start_hook_cb(pa_core *c, pa_sink_input *s, struct userdata *u) {
203 struct device_info *d;
204
205 pa_assert(c);
206 pa_sink_input_assert_ref(s);
207 pa_assert(u);
208
209 if (pa_sink_check_suspend(s->sink, s, NULL) <= 0)
210 if ((d = pa_hashmap_get(u->device_infos, s->sink)))
211 restart(d);
212
213 return PA_HOOK_OK;
214 }
215
sink_input_move_finish_hook_cb(pa_core * c,pa_sink_input * s,struct userdata * u)216 static pa_hook_result_t sink_input_move_finish_hook_cb(pa_core *c, pa_sink_input *s, struct userdata *u) {
217 struct device_info *d;
218
219 pa_assert(c);
220 pa_sink_input_assert_ref(s);
221 pa_assert(u);
222
223 if (s->state != PA_SINK_INPUT_RUNNING)
224 return PA_HOOK_OK;
225
226 if ((d = pa_hashmap_get(u->device_infos, s->sink)))
227 resume(d);
228
229 return PA_HOOK_OK;
230 }
231
source_output_move_start_hook_cb(pa_core * c,pa_source_output * s,struct userdata * u)232 static pa_hook_result_t source_output_move_start_hook_cb(pa_core *c, pa_source_output *s, struct userdata *u) {
233 struct device_info *d = NULL;
234
235 pa_assert(c);
236 pa_source_output_assert_ref(s);
237 pa_assert(u);
238
239 if (s->source->monitor_of) {
240 if (pa_sink_check_suspend(s->source->monitor_of, NULL, s) <= 0)
241 d = pa_hashmap_get(u->device_infos, s->source->monitor_of);
242 } else {
243 if (pa_source_check_suspend(s->source, s) <= 0)
244 d = pa_hashmap_get(u->device_infos, s->source);
245 }
246
247 if (d)
248 restart(d);
249
250 return PA_HOOK_OK;
251 }
252
source_output_move_finish_hook_cb(pa_core * c,pa_source_output * s,struct userdata * u)253 static pa_hook_result_t source_output_move_finish_hook_cb(pa_core *c, pa_source_output *s, struct userdata *u) {
254 struct device_info *d;
255
256 pa_assert(c);
257 pa_source_output_assert_ref(s);
258 pa_assert(u);
259
260 if (s->state != PA_SOURCE_OUTPUT_RUNNING)
261 return PA_HOOK_OK;
262
263 if (s->source->monitor_of)
264 d = pa_hashmap_get(u->device_infos, s->source->monitor_of);
265 else
266 d = pa_hashmap_get(u->device_infos, s->source);
267
268 if (d)
269 resume(d);
270
271 return PA_HOOK_OK;
272 }
273
sink_input_state_changed_hook_cb(pa_core * c,pa_sink_input * s,struct userdata * u)274 static pa_hook_result_t sink_input_state_changed_hook_cb(pa_core *c, pa_sink_input *s, struct userdata *u) {
275 struct device_info *d;
276
277 pa_assert(c);
278 pa_sink_input_assert_ref(s);
279 pa_assert(u);
280
281 if (s->state == PA_SINK_INPUT_RUNNING && s->sink)
282 if ((d = pa_hashmap_get(u->device_infos, s->sink)))
283 resume(d);
284
285 return PA_HOOK_OK;
286 }
287
source_output_state_changed_hook_cb(pa_core * c,pa_source_output * s,struct userdata * u)288 static pa_hook_result_t source_output_state_changed_hook_cb(pa_core *c, pa_source_output *s, struct userdata *u) {
289 pa_assert(c);
290 pa_source_output_assert_ref(s);
291 pa_assert(u);
292
293 if (s->state == PA_SOURCE_OUTPUT_RUNNING && s->source) {
294 struct device_info *d;
295
296 if (s->source->monitor_of)
297 d = pa_hashmap_get(u->device_infos, s->source->monitor_of);
298 else
299 d = pa_hashmap_get(u->device_infos, s->source);
300
301 if (d)
302 resume(d);
303 }
304
305 return PA_HOOK_OK;
306 }
307
device_new_hook_cb(pa_core * c,pa_object * o,struct userdata * u)308 static pa_hook_result_t device_new_hook_cb(pa_core *c, pa_object *o, struct userdata *u) {
309 struct device_info *d;
310 pa_source *source;
311 pa_sink *sink;
312 const char *timeout_str;
313 int32_t timeout;
314 bool timeout_valid;
315
316 pa_assert(c);
317 pa_object_assert_ref(o);
318 pa_assert(u);
319
320 source = pa_source_isinstance(o) ? PA_SOURCE(o) : NULL;
321 sink = pa_sink_isinstance(o) ? PA_SINK(o) : NULL;
322
323 /* Never suspend monitors */
324 if (source && source->monitor_of)
325 return PA_HOOK_OK;
326
327 pa_assert(source || sink);
328
329 timeout_str = pa_proplist_gets(sink ? sink->proplist : source->proplist, "module-suspend-on-idle.timeout");
330 if (timeout_str && pa_atoi(timeout_str, &timeout) >= 0)
331 timeout_valid = true;
332 else
333 timeout_valid = false;
334
335 if (timeout_valid && timeout < 0)
336 return PA_HOOK_OK;
337
338 d = pa_xnew(struct device_info, 1);
339 d->userdata = u;
340 d->source = source ? pa_source_ref(source) : NULL;
341 d->sink = sink ? pa_sink_ref(sink) : NULL;
342 d->time_event = pa_core_rttime_new(c, PA_USEC_INVALID, timeout_cb, d);
343
344 if (timeout_valid)
345 d->timeout = timeout * PA_USEC_PER_SEC;
346 else
347 d->timeout = d->userdata->timeout;
348
349 pa_hashmap_put(u->device_infos, o, d);
350
351 if ((d->sink && pa_sink_check_suspend(d->sink, NULL, NULL) <= 0) ||
352 (d->source && pa_source_check_suspend(d->source, NULL) <= 0))
353 restart(d);
354
355 return PA_HOOK_OK;
356 }
357
device_info_free(struct device_info * d)358 static void device_info_free(struct device_info *d) {
359 pa_assert(d);
360
361 if (d->source)
362 pa_source_unref(d->source);
363 if (d->sink)
364 pa_sink_unref(d->sink);
365
366 d->userdata->core->mainloop->time_free(d->time_event);
367
368 pa_xfree(d);
369 }
370
device_unlink_hook_cb(pa_core * c,pa_object * o,struct userdata * u)371 static pa_hook_result_t device_unlink_hook_cb(pa_core *c, pa_object *o, struct userdata *u) {
372 pa_assert(c);
373 pa_object_assert_ref(o);
374 pa_assert(u);
375
376 pa_hashmap_remove_and_free(u->device_infos, o);
377
378 return PA_HOOK_OK;
379 }
380
device_state_changed_hook_cb(pa_core * c,pa_object * o,struct userdata * u)381 static pa_hook_result_t device_state_changed_hook_cb(pa_core *c, pa_object *o, struct userdata *u) {
382 struct device_info *d;
383
384 pa_assert(c);
385 pa_object_assert_ref(o);
386 pa_assert(u);
387
388 if (!(d = pa_hashmap_get(u->device_infos, o))) {
389 /* We never suspend monitor sources, therefore they are not in the map.
390 * Still, when monitor source becomes idle it may happen that monitored
391 * sink has no uncorked inputs anymore and can now be suspended.
392 */
393 if (pa_source_isinstance(o) && PA_SOURCE(o)->monitor_of) {
394 pa_log_debug("State of monitor source '%s' has changed, checking state of monitored sink", PA_SOURCE(o)->name);
395 return device_state_changed_hook_cb(c, PA_OBJECT(PA_SOURCE(o)->monitor_of), u);
396 } else
397 return PA_HOOK_OK;
398 }
399
400 if (pa_sink_isinstance(o)) {
401 pa_sink *s = PA_SINK(o);
402
403 if (pa_sink_check_suspend(s, NULL, NULL) <= 0)
404 if (PA_SINK_IS_OPENED(s->state))
405 restart(d);
406
407 } else if (pa_source_isinstance(o)) {
408 pa_source *s = PA_SOURCE(o);
409
410 if (pa_source_check_suspend(s, NULL) <= 0)
411 if (PA_SOURCE_IS_OPENED(s->state))
412 restart(d);
413 }
414
415 return PA_HOOK_OK;
416 }
417
pa__init(pa_module * m)418 int pa__init(pa_module*m) {
419 pa_modargs *ma = NULL;
420 struct userdata *u;
421 uint32_t timeout = 5;
422 uint32_t idx;
423 pa_sink *sink;
424 pa_source *source;
425
426 pa_assert(m);
427
428 if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
429 pa_log("Failed to parse module arguments.");
430 goto fail;
431 }
432
433 if (pa_modargs_get_value_u32(ma, "timeout", &timeout) < 0) {
434 pa_log("Failed to parse timeout value.");
435 goto fail;
436 }
437
438 m->userdata = u = pa_xnew(struct userdata, 1);
439 u->core = m->core;
440 u->timeout = timeout * PA_USEC_PER_SEC;
441 u->device_infos = pa_hashmap_new_full(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func, NULL, (pa_free_cb_t) device_info_free);
442
443 PA_IDXSET_FOREACH(sink, m->core->sinks, idx)
444 device_new_hook_cb(m->core, PA_OBJECT(sink), u);
445
446 PA_IDXSET_FOREACH(source, m->core->sources, idx)
447 device_new_hook_cb(m->core, PA_OBJECT(source), u);
448
449 pa_module_hook_connect(m, &m->core->hooks[PA_CORE_HOOK_SINK_PUT], PA_HOOK_NORMAL, (pa_hook_cb_t) device_new_hook_cb, u);
450 pa_module_hook_connect(m, &m->core->hooks[PA_CORE_HOOK_SOURCE_PUT], PA_HOOK_NORMAL, (pa_hook_cb_t) device_new_hook_cb, u);
451 pa_module_hook_connect(m, &m->core->hooks[PA_CORE_HOOK_SINK_UNLINK_POST], PA_HOOK_NORMAL, (pa_hook_cb_t) device_unlink_hook_cb, u);
452 pa_module_hook_connect(m, &m->core->hooks[PA_CORE_HOOK_SOURCE_UNLINK_POST], PA_HOOK_NORMAL, (pa_hook_cb_t) device_unlink_hook_cb, u);
453 pa_module_hook_connect(m, &m->core->hooks[PA_CORE_HOOK_SINK_STATE_CHANGED], PA_HOOK_NORMAL, (pa_hook_cb_t) device_state_changed_hook_cb, u);
454 pa_module_hook_connect(m, &m->core->hooks[PA_CORE_HOOK_SOURCE_STATE_CHANGED], PA_HOOK_NORMAL, (pa_hook_cb_t) device_state_changed_hook_cb, u);
455
456 pa_module_hook_connect(m, &m->core->hooks[PA_CORE_HOOK_SINK_INPUT_FIXATE], PA_HOOK_NORMAL, (pa_hook_cb_t) sink_input_fixate_hook_cb, u);
457 pa_module_hook_connect(m, &m->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_FIXATE], PA_HOOK_NORMAL, (pa_hook_cb_t) source_output_fixate_hook_cb, u);
458 pa_module_hook_connect(m, &m->core->hooks[PA_CORE_HOOK_SINK_INPUT_UNLINK], PA_HOOK_NORMAL, (pa_hook_cb_t) sink_input_unlink_hook_cb, u);
459 pa_module_hook_connect(m, &m->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK], PA_HOOK_NORMAL, (pa_hook_cb_t) source_output_unlink_hook_cb, u);
460 pa_module_hook_connect(m, &m->core->hooks[PA_CORE_HOOK_SINK_INPUT_MOVE_START], PA_HOOK_NORMAL, (pa_hook_cb_t) sink_input_move_start_hook_cb, u);
461 pa_module_hook_connect(m, &m->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_START], PA_HOOK_NORMAL, (pa_hook_cb_t) source_output_move_start_hook_cb, u);
462 pa_module_hook_connect(m, &m->core->hooks[PA_CORE_HOOK_SINK_INPUT_MOVE_FINISH], PA_HOOK_NORMAL, (pa_hook_cb_t) sink_input_move_finish_hook_cb, u);
463 pa_module_hook_connect(m, &m->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_FINISH], PA_HOOK_NORMAL, (pa_hook_cb_t) source_output_move_finish_hook_cb, u);
464 pa_module_hook_connect(m, &m->core->hooks[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED], PA_HOOK_NORMAL, (pa_hook_cb_t) sink_input_state_changed_hook_cb, u);
465 pa_module_hook_connect(m, &m->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_STATE_CHANGED], PA_HOOK_NORMAL, (pa_hook_cb_t) source_output_state_changed_hook_cb, u);
466
467 pa_modargs_free(ma);
468 return 0;
469
470 fail:
471
472 if (ma)
473 pa_modargs_free(ma);
474
475 return -1;
476 }
477
pa__done(pa_module * m)478 void pa__done(pa_module*m) {
479 struct userdata *u;
480 struct device_info *d;
481 void *state;
482
483 pa_assert(m);
484
485 if (!m->userdata)
486 return;
487
488 u = m->userdata;
489
490 PA_HASHMAP_FOREACH(d, u->device_infos, state) {
491 if (d->sink && d->sink->state == PA_SINK_SUSPENDED) {
492 pa_log_debug("Resuming sink %s on module unload.", d->sink->name);
493 pa_sink_suspend(d->sink, false, PA_SUSPEND_IDLE);
494 }
495
496 if (d->source && d->source->state == PA_SOURCE_SUSPENDED) {
497 pa_log_debug("Resuming source %s on module unload.", d->source->name);
498 pa_source_suspend(d->source, false, PA_SUSPEND_IDLE);
499 }
500 }
501
502 pa_hashmap_free(u->device_infos);
503
504 pa_xfree(u);
505 }
506