src/modules/module-suspend-on-idle.c

   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, write to the Free Software
  18   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  19   USA.
  20 ***/
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include <config.h>
  24 #endif
  25
  26 #include <pulse/xmalloc.h>
  27 #include <pulse/timeval.h>
  28 #include <pulse/rtclock.h>
  29
  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
  37 #include "module-suspend-on-idle-symdef.h"
  38
  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>");
  44
  45 static const char* const valid_modargs[] = {
  46     "timeout",
  47     NULL,
  48 };
  49
  50 struct userdata {
  51     pa_core *core;
  52     pa_usec_t timeout;
  53     pa_hashmap *device_infos;
  54     pa_hook_slot
  55         *sink_new_slot,
  56         *source_new_slot,
  57         *sink_unlink_slot,
  58         *source_unlink_slot,
  59         *sink_state_changed_slot,
  60         *source_state_changed_slot;
  61
  62     pa_hook_slot
  63         *sink_input_new_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;
  73 };
  74
  75 struct device_info {
  76     struct userdata *userdata;
  77     pa_sink *sink;
  78     pa_source *source;
  79     pa_usec_t last_use;
  80     pa_time_event *time_event;
  81     pa_usec_t timeout;
  82 };
  83
  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;
  86
  87     pa_assert(d);
  88
  89     d->userdata->core->mainloop->time_restart(d->time_event, NULL);
  90
  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);
  95     }
  96
  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);
 101     }
 102 }
 103
 104 static void restart(struct device_info *d) {
 105     pa_usec_t now;
 106
 107     pa_assert(d);
 108     pa_assert(d->sink || d->source);
 109
 110     d->last_use = now = pa_rtclock_now();
 111     pa_core_rttime_restart(d->userdata->core, d->time_event, now + d->timeout);
 112
 113     if (d->sink)
 114         pa_log_debug("Sink %s becomes idle, timeout in %" PRIu64 " seconds.", d->sink->name, d->timeout / PA_USEC_PER_SEC);
 115     if (d->source)
 116         pa_log_debug("Source %s becomes idle, timeout in %" PRIu64 " seconds.", d->source->name, d->timeout / PA_USEC_PER_SEC);
 117 }
 118
 119 static void resume(struct device_info *d) {
 120     pa_assert(d);
 121
 122     d->userdata->core->mainloop->time_restart(d->time_event, NULL);
 123
 124     if (d->sink) {
 125         pa_log_debug("Sink %s becomes busy, resuming.", d->sink->name);
 126         pa_sink_suspend(d->sink, false, PA_SUSPEND_IDLE);
 127     }
 128
 129     if (d->source) {
 130         pa_log_debug("Source %s becomes busy, resuming.", d->source->name);
 131         pa_source_suspend(d->source, false, PA_SUSPEND_IDLE);
 132     }
 133 }
 134
 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;
 137
 138     pa_assert(c);
 139     pa_assert(data);
 140     pa_assert(u);
 141
 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. */
 145
 146     if ((d = pa_hashmap_get(u->device_infos, data->sink)))
 147         resume(d);
 148
 149     return PA_HOOK_OK;
 150 }
 151
 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;
 154
 155     pa_assert(c);
 156     pa_assert(data);
 157     pa_assert(u);
 158
 159     if (data->source->monitor_of)
 160         d = pa_hashmap_get(u->device_infos, data->source->monitor_of);
 161     else
 162         d = pa_hashmap_get(u->device_infos, data->source);
 163
 164     if (d)
 165         resume(d);
 166
 167     return PA_HOOK_OK;
 168 }
 169
 170 static pa_hook_result_t sink_input_unlink_hook_cb(pa_core *c, pa_sink_input *s, struct userdata *u) {
 171     pa_assert(c);
 172     pa_sink_input_assert_ref(s);
 173     pa_assert(u);
 174
 175     if (!s->sink)
 176         return PA_HOOK_OK;
 177
 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)))
 181             restart(d);
 182     }
 183
 184     return PA_HOOK_OK;
 185 }
 186
 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;
 189
 190     pa_assert(c);
 191     pa_source_output_assert_ref(s);
 192     pa_assert(u);
 193
 194     if (!s->source)
 195         return PA_HOOK_OK;
 196
 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);
 200     } else {
 201         if (pa_source_check_suspend(s->source) <= 0)
 202             d = pa_hashmap_get(u->device_infos, s->source);
 203     }
 204
 205     if (d)
 206         restart(d);
 207
 208     return PA_HOOK_OK;
 209 }
 210
 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;
 213
 214     pa_assert(c);
 215     pa_sink_input_assert_ref(s);
 216     pa_assert(u);
 217
 218     if (pa_sink_check_suspend(s->sink) <= 1)
 219         if ((d = pa_hashmap_get(u->device_infos, s->sink)))
 220             restart(d);
 221
 222     return PA_HOOK_OK;
 223 }
 224
 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;
 228
 229     pa_assert(c);
 230     pa_sink_input_assert_ref(s);
 231     pa_assert(u);
 232
 233     state = pa_sink_input_get_state(s);
 234     if (state != PA_SINK_INPUT_RUNNING && state != PA_SINK_INPUT_DRAINED)
 235         return PA_HOOK_OK;
 236
 237     if ((d = pa_hashmap_get(u->device_infos, s->sink)))
 238         resume(d);
 239
 240     return PA_HOOK_OK;
 241 }
 242
 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;
 245
 246     pa_assert(c);
 247     pa_source_output_assert_ref(s);
 248     pa_assert(u);
 249
 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);
 253     } else {
 254         if (pa_source_check_suspend(s->source) <= 1)
 255             d = pa_hashmap_get(u->device_infos, s->source);
 256     }
 257
 258     if (d)
 259         restart(d);
 260
 261     return PA_HOOK_OK;
 262 }
 263
 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;
 266
 267     pa_assert(c);
 268     pa_source_output_assert_ref(s);
 269     pa_assert(u);
 270
 271     if (pa_source_output_get_state(s) != PA_SOURCE_OUTPUT_RUNNING)
 272         return PA_HOOK_OK;
 273
 274     if (s->source->monitor_of)
 275         d = pa_hashmap_get(u->device_infos, s->source->monitor_of);
 276     else
 277         d = pa_hashmap_get(u->device_infos, s->source);
 278
 279     if (d)
 280         resume(d);
 281
 282     return PA_HOOK_OK;
 283 }
 284
 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;
 288
 289     pa_assert(c);
 290     pa_sink_input_assert_ref(s);
 291     pa_assert(u);
 292
 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)))
 296             resume(d);
 297
 298     return PA_HOOK_OK;
 299 }
 300
 301 static pa_hook_result_t source_output_state_changed_hook_cb(pa_core *c, pa_source_output *s, struct userdata *u) {
 302     pa_assert(c);
 303     pa_source_output_assert_ref(s);
 304     pa_assert(u);
 305
 306     if (pa_source_output_get_state(s) == PA_SOURCE_OUTPUT_RUNNING) {
 307         struct device_info *d;
 308
 309         if (s->source->monitor_of)
 310             d = pa_hashmap_get(u->device_infos, s->source->monitor_of);
 311         else
 312             d = pa_hashmap_get(u->device_infos, s->source);
 313
 314         if (d)
 315             resume(d);
 316     }
 317
 318     return PA_HOOK_OK;
 319 }
 320
 321 static pa_hook_result_t device_new_hook_cb(pa_core *c, pa_object *o, struct userdata *u) {
 322     struct device_info *d;
 323     pa_source *source;
 324     pa_sink *sink;
 325     const char *timeout_str;
 326     int32_t timeout;
 327     bool timeout_valid;
 328
 329     pa_assert(c);
 330     pa_object_assert_ref(o);
 331     pa_assert(u);
 332
 333     source = pa_source_isinstance(o) ? PA_SOURCE(o) : NULL;
 334     sink = pa_sink_isinstance(o) ? PA_SINK(o) : NULL;
 335
 336     /* Never suspend monitors */
 337     if (source && source->monitor_of)
 338         return PA_HOOK_OK;
 339
 340     pa_assert(source || sink);
 341
 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;
 345     else
 346         timeout_valid = false;
 347
 348     if (timeout_valid && timeout < 0)
 349         return PA_HOOK_OK;
 350
 351     d = pa_xnew(struct device_info, 1);
 352     d->userdata = u;
 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);
 356
 357     if (timeout_valid)
 358         d->timeout = timeout * PA_USEC_PER_SEC;
 359     else
 360         d->timeout = d->userdata->timeout;
 361
 362     pa_hashmap_put(u->device_infos, o, d);
 363
 364     if ((d->sink && pa_sink_check_suspend(d->sink) <= 0) ||
 365         (d->source && pa_source_check_suspend(d->source) <= 0))
 366         restart(d);
 367
 368     return PA_HOOK_OK;
 369 }
 370
 371 static void device_info_free(struct device_info *d) {
 372     pa_assert(d);
 373
 374     if (d->source)
 375         pa_source_unref(d->source);
 376     if (d->sink)
 377         pa_sink_unref(d->sink);
 378
 379     d->userdata->core->mainloop->time_free(d->time_event);
 380
 381     pa_xfree(d);
 382 }
 383
 384 static pa_hook_result_t device_unlink_hook_cb(pa_core *c, pa_object *o, struct userdata *u) {
 385     struct device_info *d;
 386
 387     pa_assert(c);
 388     pa_object_assert_ref(o);
 389     pa_assert(u);
 390
 391     if ((d = pa_hashmap_remove(u->device_infos, o)))
 392         device_info_free(d);
 393
 394     return PA_HOOK_OK;
 395 }
 396
 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;
 399
 400     pa_assert(c);
 401     pa_object_assert_ref(o);
 402     pa_assert(u);
 403
 404     if (!(d = pa_hashmap_get(u->device_infos, o)))
 405         return PA_HOOK_OK;
 406
 407     if (pa_sink_isinstance(o)) {
 408         pa_sink *s = PA_SINK(o);
 409         pa_sink_state_t state = pa_sink_get_state(s);
 410
 411         if (pa_sink_check_suspend(s) <= 0)
 412             if (PA_SINK_IS_OPENED(state))
 413                 restart(d);
 414
 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);
 418
 419         if (pa_source_check_suspend(s) <= 0)
 420             if (PA_SOURCE_IS_OPENED(state))
 421                 restart(d);
 422     }
 423
 424     return PA_HOOK_OK;
 425 }
 426
 427 int pa__init(pa_module*m) {
 428     pa_modargs *ma = NULL;
 429     struct userdata *u;
 430     uint32_t timeout = 5;
 431     uint32_t idx;
 432     pa_sink *sink;
 433     pa_source *source;
 434
 435     pa_assert(m);
 436
 437     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 438         pa_log("Failed to parse module arguments.");
 439         goto fail;
 440     }
 441
 442     if (pa_modargs_get_value_u32(ma, "timeout", &timeout) < 0) {
 443         pa_log("Failed to parse timeout value.");
 444         goto fail;
 445     }
 446
 447     m->userdata = u = pa_xnew(struct userdata, 1);
 448     u->core = m->core;
 449     u->timeout = timeout * PA_USEC_PER_SEC;
 450     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);
 451
 452     PA_IDXSET_FOREACH(sink, m->core->sinks, idx)
 453         device_new_hook_cb(m->core, PA_OBJECT(sink), u);
 454
 455     PA_IDXSET_FOREACH(source, m->core->sources, idx)
 456         device_new_hook_cb(m->core, PA_OBJECT(source), u);
 457
 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);
 464
 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);
 475
 476     pa_modargs_free(ma);
 477     return 0;
 478
 479 fail:
 480
 481     if (ma)
 482         pa_modargs_free(ma);
 483
 484     return -1;
 485 }
 486
 487 void pa__done(pa_module*m) {
 488     struct userdata *u;
 489
 490     pa_assert(m);
 491
 492     if (!m->userdata)
 493         return;
 494
 495     u = m->userdata;
 496
 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);
 503
 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);
 510
 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);
 521
 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);
 532
 533     pa_hashmap_free(u->device_infos);
 534
 535     pa_xfree(u);
 536 }