Add copyright notices to all relevant files. (based on svn log)
[profile/ivi/pulseaudio.git] / src / pulsecore / core-scache.h
1 #ifndef foocorescachehfoo
2 #define foocorescachehfoo
3
4 /* $Id$ */
5
6 /***
7   This file is part of PulseAudio.
8
9   Copyright 2004-2006 Lennart Poettering
10   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
11
12   PulseAudio is free software; you can redistribute it and/or modify
13   it under the terms of the GNU Lesser General Public License as published
14   by the Free Software Foundation; either version 2 of the License,
15   or (at your option) any later version.
16
17   PulseAudio is distributed in the hope that it will be useful, but
18   WITHOUT ANY WARRANTY; without even the implied warranty of
19   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20   General Public License for more details.
21
22   You should have received a copy of the GNU Lesser General Public License
23   along with PulseAudio; if not, write to the Free Software
24   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
25   USA.
26 ***/
27
28 #include <pulsecore/core.h>
29 #include <pulsecore/memchunk.h>
30 #include <pulsecore/sink.h>
31
32 #define PA_SCACHE_ENTRY_SIZE_MAX (1024*1024*2)
33
34 typedef struct pa_scache_entry {
35     pa_core *core;
36     uint32_t index;
37     char *name;
38
39     pa_cvolume volume;
40     pa_sample_spec sample_spec;
41     pa_channel_map channel_map;
42     pa_memchunk memchunk;
43
44     char *filename;
45
46     int lazy;
47     time_t last_used_time;
48 } pa_scache_entry;
49
50 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);
51 int pa_scache_add_file(pa_core *c, const char *name, const char *filename, uint32_t *idx);
52 int pa_scache_add_file_lazy(pa_core *c, const char *name, const char *filename, uint32_t *idx);
53
54 int pa_scache_add_directory_lazy(pa_core *c, const char *pathname);
55
56 int pa_scache_remove_item(pa_core *c, const char *name);
57 int pa_scache_play_item(pa_core *c, const char *name, pa_sink *sink, pa_volume_t volume);
58 void pa_scache_free(pa_core *c);
59
60 const char *pa_scache_get_name_by_id(pa_core *c, uint32_t id);
61 uint32_t pa_scache_get_id_by_name(pa_core *c, const char *name);
62
63 uint32_t pa_scache_total_size(pa_core *c);
64
65 void pa_scache_unload_unused(pa_core *c);
66
67 #endif