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