code.delx.au - pulseaudio/blob - 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
  29 #include <pulsecore/core.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 <pulsecore/namereg.h>
  35
  36 #include "module-suspend-on-idle-symdef.h"
  37
  38 PA_MODULE_AUTHOR("Lennart Poettering");
  39 PA_MODULE_DESCRIPTION("When a sink/source is idle for too long, suspend it");
  40 PA_MODULE_VERSION(PACKAGE_VERSION);
  41 PA_MODULE_LOAD_ONCE(TRUE);
  42
  43 static const char* const valid_modargs[] = {
  44     "timeout",
  45     NULL,
  46 };
  47
  48 struct userdata {
  49     pa_core *core;
  50     pa_usec_t timeout;
  51     pa_hashmap *device_infos;
  52     pa_hook_slot
  53         *sink_new_slot,
  54         *source_new_slot,
  55         *sink_unlink_slot,
  56         *source_unlink_slot,
  57         *sink_state_changed_slot,
  58         *source_state_changed_slot;
  59
  60     pa_hook_slot
  61         *sink_input_new_slot,
  62         *source_output_new_slot,
  63         *sink_input_unlink_slot,
  64         *source_output_unlink_slot,
  65         *sink_input_move_start_slot,
  66         *source_output_move_start_slot,
  67         *sink_input_move_finish_slot,
  68         *source_output_move_finish_slot,
  69         *sink_input_state_changed_slot,
  70         *source_output_state_changed_slot;
  71 };
  72
  73 struct device_info {
  74     struct userdata *userdata;
  75     pa_sink *sink;
  76     pa_source *source;
  77     struct timeval last_use;
  78     pa_time_event *time_event;
  79 };
  80
  81 static void timeout_cb(pa_mainloop_api*a, pa_time_event* e, const struct timeval *tv, void *userdata) {
  82     struct device_info *d = userdata;
  83
  84     pa_assert(d);
  85
  86     d->userdata->core->mainloop->time_restart(d->time_event, NULL);
  87
  88     if (d->sink && pa_sink_check_suspend(d->sink) <= 0 && pa_sink_get_state(d->sink) != PA_SINK_SUSPENDED) {
  89         pa_log_info("Sink %s idle for too long, suspending ...", d->sink->name);
  90         pa_sink_suspend(d->sink, TRUE);
  91     }
  92
  93     if (d->source && pa_source_check_suspend(d->source) <= 0 && pa_source_get_state(d->source) != PA_SOURCE_SUSPENDED) {
  94         pa_log_info("Source %s idle for too long, suspending ...", d->source->name);
  95         pa_source_suspend(d->source, TRUE);
  96     }
  97 }
  98
  99 static void restart(struct device_info *d) {
 100     struct timeval tv;
 101     pa_assert(d);
 102
 103     pa_gettimeofday(&tv);
 104     d->last_use = tv;
 105     pa_timeval_add(&tv, d->userdata->timeout*1000000);
 106     d->userdata->core->mainloop->time_restart(d->time_event, &tv);
 107
 108     if (d->sink)
 109         pa_log_debug("Sink %s becomes idle.", d->sink->name);
 110     if (d->source)
 111         pa_log_debug("Source %s becomes idle.", d->source->name);
 112 }
 113
 114 static void resume(struct device_info *d) {
 115     pa_assert(d);
 116
 117     d->userdata->core->mainloop->time_restart(d->time_event, NULL);
 118
 119     if (d->sink) {
 120         pa_sink_suspend(d->sink, FALSE);
 121
 122         pa_log_debug("Sink %s becomes busy.", d->sink->name);
 123     }
 124
 125     if (d->source) {
 126         pa_source_suspend(d->source, FALSE);
 127
 128         pa_log_debug("Source %s becomes busy.", d->source->name);
 129     }
 130 }
 131
 132 static pa_hook_result_t sink_input_fixate_hook_cb(pa_core *c, pa_sink_input_new_data *data, struct userdata *u) {
 133     struct device_info *d;
 134
 135     pa_assert(c);
 136     pa_assert(data);
 137     pa_assert(u);
 138
 139     if ((d = pa_hashmap_get(u->device_infos, data->sink)))
 140         resume(d);
 141
 142     return PA_HOOK_OK;
 143 }
 144
 145 static pa_hook_result_t source_output_fixate_hook_cb(pa_core *c, pa_source_output_new_data *data, struct userdata *u) {
 146     struct device_info *d;
 147
 148     pa_assert(c);
 149     pa_assert(data);
 150     pa_assert(u);
 151
 152     if ((d = pa_hashmap_get(u->device_infos, data->source)))
 153         resume(d);
 154
 155     return PA_HOOK_OK;
 156 }
 157
 158 static pa_hook_result_t sink_input_unlink_hook_cb(pa_core *c, pa_sink_input *s, struct userdata *u) {
 159     pa_assert(c);
 160     pa_sink_input_assert_ref(s);
 161     pa_assert(u);
 162
 163     if (!s->sink)
 164         return PA_HOOK_OK;
 165
 166     if (pa_sink_check_suspend(s->sink) <= 0) {
 167         struct device_info *d;
 168         if ((d = pa_hashmap_get(u->device_infos, s->sink)))
 169             restart(d);
 170     }
 171
 172     return PA_HOOK_OK;
 173 }
 174
 175 static pa_hook_result_t source_output_unlink_hook_cb(pa_core *c, pa_source_output *s, struct userdata *u) {
 176     pa_assert(c);
 177     pa_source_output_assert_ref(s);
 178     pa_assert(u);
 179
 180     if (!s->source)
 181         return PA_HOOK_OK;
 182
 183     if (pa_source_check_suspend(s->source) <= 0) {
 184         struct device_info *d;
 185         if ((d = pa_hashmap_get(u->device_infos, s->source)))
 186             restart(d);
 187     }
 188
 189     return PA_HOOK_OK;
 190 }
 191
 192 static pa_hook_result_t sink_input_move_start_hook_cb(pa_core *c, pa_sink_input *s, struct userdata *u) {
 193     struct device_info *d;
 194
 195     pa_assert(c);
 196     pa_sink_input_assert_ref(s);
 197     pa_assert(u);
 198
 199     if (pa_sink_check_suspend(s->sink) <= 1)
 200         if ((d = pa_hashmap_get(u->device_infos, s->sink)))
 201             restart(d);
 202
 203     return PA_HOOK_OK;
 204 }
 205
 206 static pa_hook_result_t sink_input_move_finish_hook_cb(pa_core *c, pa_sink_input *s, struct userdata *u) {
 207     struct device_info *d;
 208
 209     pa_assert(c);
 210     pa_sink_input_assert_ref(s);
 211     pa_assert(u);
 212
 213     if ((d = pa_hashmap_get(u->device_infos, s->sink)))
 214         resume(d);
 215
 216     return PA_HOOK_OK;
 217 }
 218
 219 static pa_hook_result_t source_output_move_start_hook_cb(pa_core *c, pa_source_output *s, struct userdata *u) {
 220     struct device_info *d;
 221
 222     pa_assert(c);
 223     pa_source_output_assert_ref(s);
 224     pa_assert(u);
 225
 226     if (pa_source_check_suspend(s->source) <= 1)
 227         if ((d = pa_hashmap_get(u->device_infos, s->source)))
 228             restart(d);
 229
 230     return PA_HOOK_OK;
 231 }
 232
 233 static pa_hook_result_t source_output_move_finish_hook_cb(pa_core *c, pa_source_output *s, struct userdata *u) {
 234     struct device_info *d;
 235
 236     pa_assert(c);
 237     pa_source_output_assert_ref(s);
 238     pa_assert(u);
 239
 240     if ((d = pa_hashmap_get(u->device_infos, s->source)))
 241         resume(d);
 242
 243     return PA_HOOK_OK;
 244 }
 245
 246 static pa_hook_result_t sink_input_state_changed_hook_cb(pa_core *c, pa_sink_input *s, struct userdata *u) {
 247     struct device_info *d;
 248     pa_sink_input_state_t state;
 249     pa_assert(c);
 250     pa_sink_input_assert_ref(s);
 251     pa_assert(u);
 252
 253     state = pa_sink_input_get_state(s);
 254     if (state == PA_SINK_INPUT_RUNNING || state == PA_SINK_INPUT_DRAINED)
 255         if ((d = pa_hashmap_get(u->device_infos, s->sink)))
 256             resume(d);
 257
 258     return PA_HOOK_OK;
 259 }
 260
 261 static pa_hook_result_t source_output_state_changed_hook_cb(pa_core *c, pa_source_output *s, struct userdata *u) {
 262     struct device_info *d;
 263     pa_source_output_state_t state;
 264     pa_assert(c);
 265     pa_source_output_assert_ref(s);
 266     pa_assert(u);
 267
 268     state = pa_source_output_get_state(s);
 269     if (state == PA_SOURCE_OUTPUT_RUNNING)
 270         if ((d = pa_hashmap_get(u->device_infos, s->source)))
 271             resume(d);
 272
 273     return PA_HOOK_OK;
 274 }
 275
 276 static pa_hook_result_t device_new_hook_cb(pa_core *c, pa_object *o, struct userdata *u) {
 277     struct device_info *d;
 278     pa_source *source;
 279     pa_sink *sink;
 280
 281     pa_assert(c);
 282     pa_object_assert_ref(o);
 283     pa_assert(u);
 284
 285     source = pa_source_isinstance(o) ? PA_SOURCE(o) : NULL;
 286     sink = pa_sink_isinstance(o) ? PA_SINK(o) : NULL;
 287
 288     pa_assert(source || sink);
 289
 290     d = pa_xnew(struct device_info, 1);
 291     d->userdata = u;
 292     d->source = source ? pa_source_ref(source) : NULL;
 293     d->sink = sink ? pa_sink_ref(sink) : NULL;
 294     d->time_event = c->mainloop->time_new(c->mainloop, NULL, timeout_cb, d);
 295     pa_hashmap_put(u->device_infos, o, d);
 296
 297     if ((d->sink && pa_sink_check_suspend(d->sink) <= 0) ||
 298         (d->source && pa_source_check_suspend(d->source) <= 0))
 299         restart(d);
 300
 301     return PA_HOOK_OK;
 302 }
 303
 304 static void device_info_free(struct device_info *d) {
 305     pa_assert(d);
 306
 307     if (d->source)
 308         pa_source_unref(d->source);
 309     if (d->sink)
 310         pa_sink_unref(d->sink);
 311
 312     d->userdata->core->mainloop->time_free(d->time_event);
 313
 314     pa_xfree(d);
 315 }
 316
 317 static pa_hook_result_t device_unlink_hook_cb(pa_core *c, pa_object *o, struct userdata *u) {
 318     struct device_info *d;
 319
 320     pa_assert(c);
 321     pa_object_assert_ref(o);
 322     pa_assert(u);
 323
 324     if ((d = pa_hashmap_remove(u->device_infos, o)))
 325         device_info_free(d);
 326
 327     return PA_HOOK_OK;
 328 }
 329
 330 static pa_hook_result_t device_state_changed_hook_cb(pa_core *c, pa_object *o, struct userdata *u) {
 331     struct device_info *d;
 332
 333     pa_assert(c);
 334     pa_object_assert_ref(o);
 335     pa_assert(u);
 336
 337     if (!(d = pa_hashmap_get(u->device_infos, o)))
 338         return PA_HOOK_OK;
 339
 340     if (pa_sink_isinstance(o)) {
 341         pa_sink *s = PA_SINK(o);
 342         pa_sink_state_t state = pa_sink_get_state(s);
 343
 344         if (pa_sink_check_suspend(s) <= 0) {
 345
 346             if (PA_SINK_IS_OPENED(state))
 347                 restart(d);
 348
 349         }
 350
 351     } else if (pa_source_isinstance(o)) {
 352         pa_source *s = PA_SOURCE(o);
 353         pa_source_state_t state = pa_source_get_state(s);
 354
 355         if (pa_source_check_suspend(s) <= 0) {
 356
 357             if (PA_SOURCE_IS_OPENED(state))
 358                 restart(d);
 359         }
 360     }
 361
 362     return PA_HOOK_OK;
 363 }
 364
 365 int pa__init(pa_module*m) {
 366     pa_modargs *ma = NULL;
 367     struct userdata *u;
 368     uint32_t timeout = 5;
 369     uint32_t idx;
 370     pa_sink *sink;
 371     pa_source *source;
 372
 373     pa_assert(m);
 374
 375     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 376         pa_log("Failed to parse module arguments.");
 377         goto fail;
 378     }
 379
 380     if (pa_modargs_get_value_u32(ma, "timeout", &timeout) < 0) {
 381         pa_log("Failed to parse timeout value.");
 382         goto fail;
 383     }
 384
 385     m->userdata = u = pa_xnew(struct userdata, 1);
 386     u->core = m->core;
 387     u->timeout = timeout;
 388     u->device_infos = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
 389
 390     for (sink = pa_idxset_first(m->core->sinks, &idx); sink; sink = pa_idxset_next(m->core->sinks, &idx))
 391         device_new_hook_cb(m->core, PA_OBJECT(sink), u);
 392
 393     for (source = pa_idxset_first(m->core->sources, &idx); source; source = pa_idxset_next(m->core->sources, &idx))
 394         device_new_hook_cb(m->core, PA_OBJECT(source), u);
 395
 396     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);
 397     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);
 398     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);
 399     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);
 400     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);
 401     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);
 402
 403     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);
 404     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);
 405     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);
 406     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);
 407     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);
 408     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);
 409     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);
 410     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);
 411     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);
 412     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);
 413
 414     pa_modargs_free(ma);
 415     return 0;
 416
 417 fail:
 418
 419     if (ma)
 420         pa_modargs_free(ma);
 421
 422     return -1;
 423 }
 424
 425 void pa__done(pa_module*m) {
 426     struct userdata *u;
 427     struct device_info *d;
 428
 429     pa_assert(m);
 430
 431     if (!m->userdata)
 432         return;
 433
 434     u = m->userdata;
 435
 436     if (u->sink_new_slot)
 437         pa_hook_slot_free(u->sink_new_slot);
 438     if (u->sink_unlink_slot)
 439         pa_hook_slot_free(u->sink_unlink_slot);
 440     if (u->sink_state_changed_slot)
 441         pa_hook_slot_free(u->sink_state_changed_slot);
 442
 443     if (u->source_new_slot)
 444         pa_hook_slot_free(u->source_new_slot);
 445     if (u->source_unlink_slot)
 446         pa_hook_slot_free(u->source_unlink_slot);
 447     if (u->source_state_changed_slot)
 448         pa_hook_slot_free(u->source_state_changed_slot);
 449
 450     if (u->sink_input_new_slot)
 451         pa_hook_slot_free(u->sink_input_new_slot);
 452     if (u->sink_input_unlink_slot)
 453         pa_hook_slot_free(u->sink_input_unlink_slot);
 454     if (u->sink_input_move_start_slot)
 455         pa_hook_slot_free(u->sink_input_move_start_slot);
 456     if (u->sink_input_move_finish_slot)
 457         pa_hook_slot_free(u->sink_input_move_finish_slot);
 458     if (u->sink_input_state_changed_slot)
 459         pa_hook_slot_free(u->sink_input_state_changed_slot);
 460
 461     if (u->source_output_new_slot)
 462         pa_hook_slot_free(u->source_output_new_slot);
 463     if (u->source_output_unlink_slot)
 464         pa_hook_slot_free(u->source_output_unlink_slot);
 465     if (u->source_output_move_start_slot)
 466         pa_hook_slot_free(u->source_output_move_start_slot);
 467     if (u->source_output_move_finish_slot)
 468         pa_hook_slot_free(u->source_output_move_finish_slot);
 469     if (u->source_output_state_changed_slot)
 470         pa_hook_slot_free(u->source_output_state_changed_slot);
 471
 472     while ((d = pa_hashmap_steal_first(u->device_infos)))
 473         device_info_free(d);
 474
 475     pa_hashmap_free(u->device_infos, NULL, NULL);
 476
 477     pa_xfree(u);
 478 }