code.delx.au - pulseaudio/blob - src/modules/module-suspend-on-idle.c

   1 /* $Id$ */
   2
   3 /***
   4   This file is part of PulseAudio.
   5
   6   Copyright 2006 Lennart Poettering
   7
   8   PulseAudio is free software; you can redistribute it and/or modify
   9   it under the terms of the GNU Lesser General Public License as published
  10   by the Free Software Foundation; either version 2 of the License,
  11   or (at your option) any later version.
  12
  13   PulseAudio is distributed in the hope that it will be useful, but
  14   WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16   General Public License for more details.
  17
  18   You should have received a copy of the GNU Lesser General Public License
  19   along with PulseAudio; if not, write to the Free Software
  20   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  21   USA.
  22 ***/
  23
  24 #ifdef HAVE_CONFIG_H
  25 #include <config.h>
  26 #endif
  27
  28 #include <pulse/xmalloc.h>
  29 #include <pulse/timeval.h>
  30
  31 #include <pulsecore/core.h>
  32 #include <pulsecore/sink-input.h>
  33 #include <pulsecore/source-output.h>
  34 #include <pulsecore/modargs.h>
  35 #include <pulsecore/log.h>
  36 #include <pulsecore/namereg.h>
  37
  38 #include "module-suspend-on-idle-symdef.h"
  39
  40 PA_MODULE_AUTHOR("Lennart Poettering")
  41 PA_MODULE_DESCRIPTION("When a sink/source is idle for too long, suspend it")
  42 PA_MODULE_VERSION(PACKAGE_VERSION)
  43
  44 static const char* const valid_modargs[] = {
  45     "timeout",
  46     NULL,
  47 };
  48
  49 struct userdata {
  50     pa_core *core;
  51     pa_usec_t timeout;
  52     pa_hashmap *device_infos;
  53     pa_hook_slot
  54         *sink_new_slot,
  55         *source_new_slot,
  56         *sink_disconnect_slot,
  57         *source_disconnect_slot,
  58         *sink_state_changed_slot,
  59         *source_state_changed_slot;
  60
  61     pa_hook_slot
  62         *sink_input_new_slot,
  63         *source_output_new_slot,
  64         *sink_input_disconnect_slot,
  65         *source_output_disconnect_slot,
  66         *sink_input_move_slot,
  67         *source_output_move_slot,
  68         *sink_input_move_post_slot,
  69         *source_output_move_post_slot;
  70 };
  71
  72 struct device_info {
  73     struct userdata *userdata;
  74     pa_sink *sink;
  75     pa_source *source;
  76     struct timeval last_use;
  77     pa_time_event *time_event;
  78 };
  79
  80 static void timeout_cb(pa_mainloop_api*a, pa_time_event* e, const struct timeval *tv, void *userdata) {
  81     struct device_info *d = userdata;
  82
  83     pa_assert(d);
  84
  85     d->userdata->core->mainloop->time_restart(d->time_event, NULL);
  86
  87     if (d->sink && pa_sink_used_by(d->sink) <= 0 && pa_sink_get_state(d->sink) != PA_SINK_SUSPENDED) {
  88         pa_log_info("Sink %s idle for too long, suspending ...", d->sink->name);
  89         pa_sink_suspend(d->sink, 1);
  90         pa_source_suspend(d->sink->monitor_source, 1);
  91     }
  92
  93     if (d->source && pa_source_used_by(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, 1);
  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, 0);
 121         pa_source_suspend(d->sink->monitor_source, 0);
 122
 123         pa_log_debug("Sink %s becomes busy.", d->sink->name);
 124     }
 125
 126     if (d->source) {
 127         pa_source_suspend(d->source, 0);
 128         if (d->source->monitor_of)
 129             pa_sink_suspend(d->source->monitor_of, 0);
 130
 131         pa_log_debug("Source %s becomes busy.", d->source->name);
 132     }
 133 }
 134
 135 static pa_hook_result_t sink_input_new_hook_cb(pa_core *c, pa_sink_input *s, struct userdata *u) {
 136     struct device_info *d;
 137
 138     pa_assert(c);
 139     pa_sink_input_assert_ref(s);
 140     pa_assert(u);
 141
 142     pa_assert_se((d = pa_hashmap_get(u->device_infos, s->sink)));
 143     resume(d);
 144
 145     return PA_HOOK_OK;
 146 }
 147
 148 static pa_hook_result_t source_output_new_hook_cb(pa_core *c, pa_source_output *s, struct userdata *u) {
 149     struct device_info *d;
 150
 151     pa_assert(c);
 152     pa_source_output_assert_ref(s);
 153     pa_assert(u);
 154
 155     pa_assert_se((d = pa_hashmap_get(u->device_infos, s->source)));
 156     resume(d);
 157
 158     return PA_HOOK_OK;
 159 }
 160
 161 static pa_hook_result_t sink_input_disconnect_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 (pa_sink_used_by(s->sink) <= 0) {
 167         struct device_info *d;
 168         pa_assert_se((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_disconnect_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 (pa_source_used_by(s->source) <= 0) {
 181         struct device_info *d;
 182         pa_assert_se((d = pa_hashmap_get(u->device_infos, s->source)));
 183         restart(d);
 184     }
 185
 186     return PA_HOOK_OK;
 187 }
 188
 189 static pa_hook_result_t sink_input_move_hook_cb(pa_core *c, pa_sink_input *s, struct userdata *u) {
 190     pa_assert(c);
 191     pa_sink_input_assert_ref(s);
 192     pa_assert(u);
 193
 194     if (pa_sink_used_by(s->sink) <= 1) {
 195         struct device_info *d;
 196         pa_assert_se((d = pa_hashmap_get(u->device_infos, s->sink)));
 197         restart(d);
 198     }
 199
 200     return PA_HOOK_OK;
 201 }
 202
 203 static pa_hook_result_t sink_input_move_post_hook_cb(pa_core *c, pa_sink_input *s, struct userdata *u) {
 204     struct device_info *d;
 205     pa_assert(c);
 206     pa_sink_input_assert_ref(s);
 207     pa_assert(u);
 208
 209     pa_assert_se((d = pa_hashmap_get(u->device_infos, s->sink)));
 210     resume(d);
 211
 212     return PA_HOOK_OK;
 213 }
 214
 215 static pa_hook_result_t source_output_move_hook_cb(pa_core *c, pa_source_output *s, struct userdata *u) {
 216     pa_assert(c);
 217     pa_source_output_assert_ref(s);
 218     pa_assert(u);
 219
 220     if (pa_source_used_by(s->source) <= 1) {
 221         struct device_info *d;
 222         pa_assert_se((d = pa_hashmap_get(u->device_infos, s->source)));
 223         restart(d);
 224     }
 225
 226     return PA_HOOK_OK;
 227 }
 228
 229 static pa_hook_result_t source_output_move_post_hook_cb(pa_core *c, pa_source_output *s, struct userdata *u) {
 230     struct device_info *d;
 231     pa_assert(c);
 232     pa_source_output_assert_ref(s);
 233     pa_assert(u);
 234
 235     pa_assert_se((d = pa_hashmap_get(u->device_infos, s->source)));
 236     resume(d);
 237
 238     return PA_HOOK_OK;
 239 }
 240
 241 static pa_hook_result_t device_new_hook_cb(pa_core *c, pa_object *o, struct userdata *u) {
 242     struct device_info *d;
 243
 244     pa_assert(c);
 245     pa_object_assert_ref(o);
 246     pa_assert(u);
 247
 248     d = pa_xnew(struct device_info, 1);
 249     d->userdata = u;
 250     d->source = pa_source_isinstance(o) ? pa_source_ref(PA_SOURCE(o)) : NULL;
 251     d->sink = pa_sink_isinstance(o) ? pa_sink_ref(PA_SINK(o)) : NULL;
 252     pa_assert(d->source || d->sink);
 253     d->time_event = c->mainloop->time_new(c->mainloop, NULL, timeout_cb, d);
 254     pa_hashmap_put(u->device_infos, o, d);
 255
 256     if ((d->sink && pa_sink_used_by(d->sink) <= 0) ||
 257         (d->source && pa_source_used_by(d->source) <= 0))
 258         restart(d);
 259
 260     return PA_HOOK_OK;
 261 }
 262
 263 static void device_info_free(struct device_info *d) {
 264     pa_assert(d);
 265
 266     if (d->source)
 267         pa_source_unref(d->source);
 268     if (d->sink)
 269         pa_sink_unref(d->sink);
 270
 271     d->userdata->core->mainloop->time_free(d->time_event);
 272
 273     pa_xfree(d);
 274 }
 275
 276 static pa_hook_result_t device_disconnect_hook_cb(pa_core *c, pa_object *o, struct userdata *u) {
 277     struct device_info *d;
 278
 279     pa_assert(c);
 280     pa_object_assert_ref(o);
 281     pa_assert(u);
 282
 283     pa_assert_se((d = pa_hashmap_remove(u->device_infos, o)));
 284     device_info_free(d);
 285
 286     return PA_HOOK_OK;
 287 }
 288
 289 static pa_hook_result_t device_state_changed_hook_cb(pa_core *c, pa_object *o, struct userdata *u) {
 290     struct device_info *d;
 291
 292     pa_assert(c);
 293     pa_object_assert_ref(o);
 294     pa_assert(u);
 295
 296     if (!(d = pa_hashmap_get(u->device_infos, o)))
 297         return PA_HOOK_OK;
 298
 299     if (pa_sink_isinstance(o)) {
 300         pa_sink *s = PA_SINK(o);
 301
 302         if (pa_sink_used_by(s) <= 0) {
 303             pa_sink_state_t state = pa_sink_get_state(s);
 304
 305             if (state == PA_SINK_RUNNING || state == PA_SINK_IDLE)
 306                 restart(d);
 307         }
 308
 309     } else if (pa_source_isinstance(o)) {
 310         pa_source *s = PA_SOURCE(o);
 311
 312         if (pa_source_used_by(s) <= 0) {
 313             pa_sink_state_t state = pa_source_get_state(s);
 314
 315             if (state == PA_SINK_RUNNING || state == PA_SINK_IDLE)
 316                 restart(d);
 317         }
 318     }
 319
 320     return PA_HOOK_OK;
 321 }
 322
 323 int pa__init(pa_module*m) {
 324     pa_modargs *ma = NULL;
 325     struct userdata *u;
 326     uint32_t timeout = 1;
 327     uint32_t idx;
 328     pa_sink *sink;
 329     pa_source *source;
 330
 331     pa_assert(m);
 332
 333     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 334         pa_log("Failed to parse module arguments.");
 335         goto fail;
 336     }
 337
 338     if (pa_modargs_get_value_u32(ma, "timeout", &timeout) < 0) {
 339         pa_log("Failed to parse timeout value.");
 340         goto fail;
 341     }
 342
 343     m->userdata = u = pa_xnew(struct userdata, 1);
 344     u->core = m->core;
 345     u->timeout = timeout;
 346     u->device_infos = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
 347
 348     for (sink = pa_idxset_first(m->core->sinks, &idx); sink; sink = pa_idxset_next(m->core->sinks, &idx))
 349         device_new_hook_cb(m->core, PA_OBJECT(sink), u);
 350
 351     for (source = pa_idxset_first(m->core->sources, &idx); source; source = pa_idxset_next(m->core->sources, &idx))
 352         device_new_hook_cb(m->core, PA_OBJECT(source), u);
 353
 354     u->sink_new_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_NEW_POST], (pa_hook_cb_t) device_new_hook_cb, u);
 355     u->source_new_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SOURCE_NEW_POST], (pa_hook_cb_t) device_new_hook_cb, u);
 356     u->sink_disconnect_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_DISCONNECT_POST], (pa_hook_cb_t) device_disconnect_hook_cb, u);
 357     u->source_disconnect_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SOURCE_DISCONNECT_POST], (pa_hook_cb_t) device_disconnect_hook_cb, u);
 358     u->sink_state_changed_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_STATE_CHANGED], (pa_hook_cb_t) device_state_changed_hook_cb, u);
 359     u->source_state_changed_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SOURCE_STATE_CHANGED], (pa_hook_cb_t) device_state_changed_hook_cb, u);
 360
 361     u->sink_input_new_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_INPUT_PUT], (pa_hook_cb_t) sink_input_new_hook_cb, u);
 362     u->source_output_new_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_PUT], (pa_hook_cb_t) source_output_new_hook_cb, u);
 363     u->sink_input_disconnect_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_INPUT_DISCONNECT_POST], (pa_hook_cb_t) sink_input_disconnect_hook_cb, u);
 364     u->source_output_disconnect_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_DISCONNECT_POST], (pa_hook_cb_t) source_output_disconnect_hook_cb, u);
 365     u->sink_input_move_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_INPUT_MOVE], (pa_hook_cb_t) sink_input_move_hook_cb, u);
 366     u->source_output_move_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE], (pa_hook_cb_t) source_output_move_hook_cb, u);
 367     u->sink_input_move_post_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_INPUT_MOVE_POST], (pa_hook_cb_t) sink_input_move_post_hook_cb, u);
 368     u->source_output_move_post_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_POST], (pa_hook_cb_t) source_output_move_post_hook_cb, u);
 369
 370
 371     pa_modargs_free(ma);
 372     return 0;
 373
 374 fail:
 375
 376     if (ma)
 377         pa_modargs_free(ma);
 378
 379     return -1;
 380 }
 381
 382 void pa__done(pa_module*m) {
 383     struct userdata *u;
 384     struct device_info *d;
 385
 386     pa_assert(m);
 387
 388     if (!m->userdata)
 389         return;
 390
 391     u = m->userdata;
 392
 393     if (u->sink_new_slot)
 394         pa_hook_slot_free(u->sink_new_slot);
 395     if (u->sink_disconnect_slot)
 396         pa_hook_slot_free(u->sink_disconnect_slot);
 397     if (u->sink_state_changed_slot)
 398         pa_hook_slot_free(u->sink_state_changed_slot);
 399
 400     if (u->source_new_slot)
 401         pa_hook_slot_free(u->source_new_slot);
 402     if (u->source_disconnect_slot)
 403         pa_hook_slot_free(u->source_disconnect_slot);
 404     if (u->source_state_changed_slot)
 405         pa_hook_slot_free(u->source_state_changed_slot);
 406
 407     if (u->sink_input_new_slot)
 408         pa_hook_slot_free(u->sink_input_new_slot);
 409     if (u->sink_input_disconnect_slot)
 410         pa_hook_slot_free(u->sink_input_disconnect_slot);
 411     if (u->sink_input_move_slot)
 412         pa_hook_slot_free(u->sink_input_move_slot);
 413     if (u->sink_input_move_post_slot)
 414         pa_hook_slot_free(u->sink_input_move_post_slot);
 415
 416     if (u->source_output_new_slot)
 417         pa_hook_slot_free(u->source_output_new_slot);
 418     if (u->source_output_disconnect_slot)
 419         pa_hook_slot_free(u->source_output_disconnect_slot);
 420     if (u->source_output_move_slot)
 421         pa_hook_slot_free(u->source_output_move_slot);
 422     if (u->source_output_move_post_slot)
 423         pa_hook_slot_free(u->source_output_move_post_slot);
 424
 425     while ((d = pa_hashmap_steal_first(u->device_infos)))
 426         device_info_free(d);
 427
 428     pa_hashmap_free(u->device_infos, NULL, NULL);
 429
 430     pa_xfree(u);
 431 }