src/pulsecore/core-scache.c

   1 /* $Id$ */
   2
   3 /***
   4   This file is part of PulseAudio.
   5
   6   Copyright 2004-2006 Lennart Poettering
   7   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
   8
   9   PulseAudio is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU Lesser General Public License as published
  11   by the Free Software Foundation; either version 2 of the License,
  12   or (at your option) any later version.
  13
  14   PulseAudio is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with PulseAudio; if not, write to the Free Software
  21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  22   USA.
  23 ***/
  24
  25 #ifdef HAVE_CONFIG_H
  26 #include <config.h>
  27 #endif
  28
  29 #include <assert.h>
  30 #include <stdlib.h>
  31 #include <string.h>
  32 #include <stdio.h>
  33 #include <sys/types.h>
  34 #include <dirent.h>
  35 #include <sys/stat.h>
  36 #include <errno.h>
  37 #include <limits.h>
  38
  39 #ifdef HAVE_GLOB_H
  40 #include <glob.h>
  41 #endif
  42
  43 #ifdef HAVE_WINDOWS_H
  44 #include <windows.h>
  45 #endif
  46
  47 #include <pulse/mainloop.h>
  48 #include <pulse/channelmap.h>
  49 #include <pulse/timeval.h>
  50 #include <pulse/util.h>
  51 #include <pulse/volume.h>
  52 #include <pulse/xmalloc.h>
  53
  54 #include <pulsecore/sink-input.h>
  55 #include <pulsecore/sample-util.h>
  56 #include <pulsecore/play-memchunk.h>
  57 #include <pulsecore/core-subscribe.h>
  58 #include <pulsecore/namereg.h>
  59 #include <pulsecore/sound-file.h>
  60 #include <pulsecore/core-util.h>
  61 #include <pulsecore/log.h>
  62 #include <pulsecore/core-error.h>
  63
  64 #include "core-scache.h"
  65
  66 #define UNLOAD_POLL_TIME 2
  67
  68 static void timeout_callback(pa_mainloop_api *m, pa_time_event*e, PA_GCC_UNUSED const struct timeval *tv, void *userdata) {
  69     pa_core *c = userdata;
  70     struct timeval ntv;
  71     assert(c && c->mainloop == m && c->scache_auto_unload_event == e);
  72
  73     pa_scache_unload_unused(c);
  74
  75     pa_gettimeofday(&ntv);
  76     ntv.tv_sec += UNLOAD_POLL_TIME;
  77     m->time_restart(e, &ntv);
  78 }
  79
  80 static void free_entry(pa_scache_entry *e) {
  81     assert(e);
  82     pa_namereg_unregister(e->core, e->name);
  83     pa_subscription_post(e->core, PA_SUBSCRIPTION_EVENT_SAMPLE_CACHE|PA_SUBSCRIPTION_EVENT_REMOVE, e->index);
  84     pa_xfree(e->name);
  85     pa_xfree(e->filename);
  86     if (e->memchunk.memblock)
  87         pa_memblock_unref(e->memchunk.memblock);
  88     pa_xfree(e);
  89 }
  90
  91 static pa_scache_entry* scache_add_item(pa_core *c, const char *name) {
  92     pa_scache_entry *e;
  93     assert(c && name);
  94
  95     if ((e = pa_namereg_get(c, name, PA_NAMEREG_SAMPLE, 0))) {
  96         if (e->memchunk.memblock)
  97             pa_memblock_unref(e->memchunk.memblock);
  98
  99         pa_xfree(e->filename);
 100
 101         assert(e->core == c);
 102
 103         pa_subscription_post(c, PA_SUBSCRIPTION_EVENT_SAMPLE_CACHE|PA_SUBSCRIPTION_EVENT_CHANGE, e->index);
 104     } else {
 105         e = pa_xmalloc(sizeof(pa_scache_entry));
 106
 107         if (!pa_namereg_register(c, name, PA_NAMEREG_SAMPLE, e, 1)) {
 108             pa_xfree(e);
 109             return NULL;
 110         }
 111
 112         e->name = pa_xstrdup(name);
 113         e->core = c;
 114
 115         if (!c->scache) {
 116             c->scache = pa_idxset_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
 117             assert(c->scache);
 118         }
 119
 120         pa_idxset_put(c->scache, e, &e->index);
 121
 122         pa_subscription_post(c, PA_SUBSCRIPTION_EVENT_SAMPLE_CACHE|PA_SUBSCRIPTION_EVENT_NEW, e->index);
 123     }
 124
 125     e->last_used_time = 0;
 126     e->memchunk.memblock = NULL;
 127     e->memchunk.index = e->memchunk.length = 0;
 128     e->filename = NULL;
 129     e->lazy = 0;
 130     e->last_used_time = 0;
 131
 132     memset(&e->sample_spec, 0, sizeof(e->sample_spec));
 133     pa_channel_map_init(&e->channel_map);
 134     pa_cvolume_reset(&e->volume, PA_CHANNELS_MAX);
 135
 136     return e;
 137 }
 138
 139 int pa_scache_add_item(pa_core *c, const char *name, const pa_sample_spec *ss, const pa_channel_map *map, const pa_memchunk *chunk, uint32_t *idx) {
 140     pa_scache_entry *e;
 141     assert(c && name);
 142
 143     if (chunk && chunk->length > PA_SCACHE_ENTRY_SIZE_MAX)
 144         return -1;
 145
 146     if (!(e = scache_add_item(c, name)))
 147         return -1;
 148
 149     if (ss) {
 150         e->sample_spec = *ss;
 151         pa_channel_map_init_auto(&e->channel_map, ss->channels, PA_CHANNEL_MAP_DEFAULT);
 152         e->volume.channels = e->sample_spec.channels;
 153     }
 154
 155     if (map)
 156         e->channel_map = *map;
 157
 158     if (chunk) {
 159         e->memchunk = *chunk;
 160         pa_memblock_ref(e->memchunk.memblock);
 161     }
 162
 163     if (idx)
 164         *idx = e->index;
 165
 166     return 0;
 167 }
 168
 169 int pa_scache_add_file(pa_core *c, const char *name, const char *filename, uint32_t *idx) {
 170     pa_sample_spec ss;
 171     pa_channel_map map;
 172     pa_memchunk chunk;
 173     int r;
 174
 175 #ifdef OS_IS_WIN32
 176     char buf[MAX_PATH];
 177
 178     if (ExpandEnvironmentStrings(filename, buf, MAX_PATH))
 179         filename = buf;
 180 #endif
 181
 182     if (pa_sound_file_load(c->mempool, filename, &ss, &map, &chunk) < 0)
 183         return -1;
 184
 185     r = pa_scache_add_item(c, name, &ss, &map, &chunk, idx);
 186     pa_memblock_unref(chunk.memblock);
 187
 188     return r;
 189 }
 190
 191 int pa_scache_add_file_lazy(pa_core *c, const char *name, const char *filename, uint32_t *idx) {
 192     pa_scache_entry *e;
 193
 194 #ifdef OS_IS_WIN32
 195     char buf[MAX_PATH];
 196
 197     if (ExpandEnvironmentStrings(filename, buf, MAX_PATH))
 198         filename = buf;
 199 #endif
 200
 201     assert(c && name);
 202
 203     if (!(e = scache_add_item(c, name)))
 204         return -1;
 205
 206     e->lazy = 1;
 207     e->filename = pa_xstrdup(filename);
 208
 209     if (!c->scache_auto_unload_event) {
 210         struct timeval ntv;
 211         pa_gettimeofday(&ntv);
 212         ntv.tv_sec += UNLOAD_POLL_TIME;
 213         c->scache_auto_unload_event = c->mainloop->time_new(c->mainloop, &ntv, timeout_callback, c);
 214     }
 215
 216     if (idx)
 217         *idx = e->index;
 218
 219     return 0;
 220 }
 221
 222 int pa_scache_remove_item(pa_core *c, const char *name) {
 223     pa_scache_entry *e;
 224     assert(c && name);
 225
 226     if (!(e = pa_namereg_get(c, name, PA_NAMEREG_SAMPLE, 0)))
 227         return -1;
 228
 229     if (pa_idxset_remove_by_data(c->scache, e, NULL) != e)
 230         assert(0);
 231
 232     free_entry(e);
 233     return 0;
 234 }
 235
 236 static void free_cb(void *p, PA_GCC_UNUSED void *userdata) {
 237     pa_scache_entry *e = p;
 238     assert(e);
 239     free_entry(e);
 240 }
 241
 242 void pa_scache_free(pa_core *c) {
 243     assert(c);
 244
 245     if (c->scache) {
 246         pa_idxset_free(c->scache, free_cb, NULL);
 247         c->scache = NULL;
 248     }
 249
 250     if (c->scache_auto_unload_event)
 251         c->mainloop->time_free(c->scache_auto_unload_event);
 252 }
 253
 254 int pa_scache_play_item(pa_core *c, const char *name, pa_sink *sink, pa_volume_t volume) {
 255     pa_scache_entry *e;
 256     char *t;
 257     pa_cvolume r;
 258
 259     assert(c);
 260     assert(name);
 261     assert(sink);
 262
 263     if (!(e = pa_namereg_get(c, name, PA_NAMEREG_SAMPLE, 1)))
 264         return -1;
 265
 266     if (e->lazy && !e->memchunk.memblock) {
 267         if (pa_sound_file_load(c->mempool, e->filename, &e->sample_spec, &e->channel_map, &e->memchunk) < 0)
 268             return -1;
 269
 270         pa_subscription_post(c, PA_SUBSCRIPTION_EVENT_SAMPLE_CACHE|PA_SUBSCRIPTION_EVENT_CHANGE, e->index);
 271
 272         if (e->volume.channels > e->sample_spec.channels)
 273             e->volume.channels = e->sample_spec.channels;
 274     }
 275
 276     if (!e->memchunk.memblock)
 277         return -1;
 278
 279     t = pa_sprintf_malloc("sample:%s", name);
 280
 281     pa_cvolume_set(&r, e->volume.channels, volume);
 282     pa_sw_cvolume_multiply(&r, &r, &e->volume);
 283
 284     if (pa_play_memchunk(sink, t, &e->sample_spec, &e->channel_map, &e->memchunk, &r) < 0) {
 285         pa_xfree(t);
 286         return -1;
 287     }
 288
 289     pa_xfree(t);
 290
 291     if (e->lazy)
 292         time(&e->last_used_time);
 293
 294     return 0;
 295 }
 296
 297 const char * pa_scache_get_name_by_id(pa_core *c, uint32_t id) {
 298     pa_scache_entry *e;
 299     assert(c && id != PA_IDXSET_INVALID);
 300
 301     if (!c->scache || !(e = pa_idxset_get_by_index(c->scache, id)))
 302         return NULL;
 303
 304     return e->name;
 305 }
 306
 307 uint32_t pa_scache_get_id_by_name(pa_core *c, const char *name) {
 308     pa_scache_entry *e;
 309     assert(c && name);
 310
 311     if (!(e = pa_namereg_get(c, name, PA_NAMEREG_SAMPLE, 0)))
 312         return PA_IDXSET_INVALID;
 313
 314     return e->index;
 315 }
 316
 317 uint32_t pa_scache_total_size(pa_core *c) {
 318     pa_scache_entry *e;
 319     uint32_t idx, sum = 0;
 320     assert(c);
 321
 322     if (!c->scache || !pa_idxset_size(c->scache))
 323         return 0;
 324
 325     for (e = pa_idxset_first(c->scache, &idx); e; e = pa_idxset_next(c->scache, &idx))
 326         if (e->memchunk.memblock)
 327             sum += e->memchunk.length;
 328
 329     return sum;
 330 }
 331
 332 void pa_scache_unload_unused(pa_core *c) {
 333     pa_scache_entry *e;
 334     time_t now;
 335     uint32_t idx;
 336     assert(c);
 337
 338     if (!c->scache || !pa_idxset_size(c->scache))
 339         return;
 340
 341     time(&now);
 342
 343     for (e = pa_idxset_first(c->scache, &idx); e; e = pa_idxset_next(c->scache, &idx)) {
 344
 345         if (!e->lazy || !e->memchunk.memblock)
 346             continue;
 347
 348         if (e->last_used_time + c->scache_idle_time > now)
 349             continue;
 350
 351         pa_memblock_unref(e->memchunk.memblock);
 352         e->memchunk.memblock = NULL;
 353         e->memchunk.index = e->memchunk.length = 0;
 354
 355         pa_subscription_post(c, PA_SUBSCRIPTION_EVENT_SAMPLE_CACHE|PA_SUBSCRIPTION_EVENT_CHANGE, e->index);
 356     }
 357 }
 358
 359 static void add_file(pa_core *c, const char *pathname) {
 360     struct stat st;
 361     const char *e;
 362
 363     e = pa_path_get_filename(pathname);
 364
 365     if (stat(pathname, &st) < 0) {
 366         pa_log("stat('%s'): %s", pathname, pa_cstrerror(errno));
 367         return;
 368     }
 369
 370 #if defined(S_ISREG) && defined(S_ISLNK)
 371     if (S_ISREG(st.st_mode) || S_ISLNK(st.st_mode))
 372 #endif
 373         pa_scache_add_file_lazy(c, e, pathname, NULL);
 374 }
 375
 376 int pa_scache_add_directory_lazy(pa_core *c, const char *pathname) {
 377     DIR *dir;
 378     assert(c && pathname);
 379
 380     /* First try to open this as directory */
 381     if (!(dir = opendir(pathname))) {
 382 #ifdef HAVE_GLOB_H
 383         glob_t p;
 384         unsigned int i;
 385         /* If that fails, try to open it as shell glob */
 386
 387         if (glob(pathname, GLOB_ERR|GLOB_NOSORT, NULL, &p) < 0) {
 388             pa_log("failed to open directory '%s': %s", pathname, pa_cstrerror(errno));
 389             return -1;
 390         }
 391
 392         for (i = 0; i < p.gl_pathc; i++)
 393             add_file(c, p.gl_pathv[i]);
 394
 395         globfree(&p);
 396 #else
 397         return -1;
 398 #endif
 399     } else {
 400         struct dirent *e;
 401
 402         while ((e = readdir(dir))) {
 403             char p[PATH_MAX];
 404
 405             if (e->d_name[0] == '.')
 406                 continue;
 407
 408             snprintf(p, sizeof(p), "%s/%s", pathname, e->d_name);
 409             add_file(c, p);
 410         }
 411     }
 412
 413     closedir(dir);
 414     return 0;
 415 }