2 This file is part of PulseAudio.
4 Copyright 2004-2008 Lennart Poettering
5 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
7 PulseAudio is free software; you can redistribute it and/or modify
8 it under the terms of the GNU Lesser General Public License as published
9 by the Free Software Foundation; either version 2.1 of the License,
10 or (at your option) any later version.
12 PulseAudio is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 General Public License for more details.
17 You should have received a copy of the GNU Lesser General Public License
18 along with PulseAudio; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
30 #include <sys/types.h>
44 #include <pulse/mainloop.h>
45 #include <pulse/channelmap.h>
46 #include <pulse/timeval.h>
47 #include <pulse/util.h>
48 #include <pulse/volume.h>
49 #include <pulse/xmalloc.h>
50 #include <pulse/rtclock.h>
52 #include <pulsecore/sink-input.h>
53 #include <pulsecore/sample-util.h>
54 #include <pulsecore/play-memchunk.h>
55 #include <pulsecore/core-subscribe.h>
56 #include <pulsecore/namereg.h>
57 #include <pulsecore/sound-file.h>
58 #include <pulsecore/core-rtclock.h>
59 #include <pulsecore/core-util.h>
60 #include <pulsecore/log.h>
61 #include <pulsecore/core-error.h>
62 #include <pulsecore/macro.h>
64 #include "core-scache.h"
66 #define UNLOAD_POLL_TIME (60 * PA_USEC_PER_SEC)
68 static void timeout_callback(pa_mainloop_api
*m
, pa_time_event
*e
, const struct timeval
*t
, void *userdata
) {
69 pa_core
*c
= userdata
;
72 pa_assert(c
->mainloop
== m
);
73 pa_assert(c
->scache_auto_unload_event
== e
);
75 pa_scache_unload_unused(c
);
77 pa_core_rttime_restart(c
, e
, pa_rtclock_now() + UNLOAD_POLL_TIME
);
80 static void free_entry(pa_scache_entry
*e
) {
83 pa_namereg_unregister(e
->core
, e
->name
);
84 pa_subscription_post(e
->core
, PA_SUBSCRIPTION_EVENT_SAMPLE_CACHE
|PA_SUBSCRIPTION_EVENT_REMOVE
, e
->index
);
86 pa_xfree(e
->filename
);
87 if (e
->memchunk
.memblock
)
88 pa_memblock_unref(e
->memchunk
.memblock
);
90 pa_proplist_free(e
->proplist
);
94 static pa_scache_entry
* scache_add_item(pa_core
*c
, const char *name
) {
100 if ((e
= pa_namereg_get(c
, name
, PA_NAMEREG_SAMPLE
))) {
101 if (e
->memchunk
.memblock
)
102 pa_memblock_unref(e
->memchunk
.memblock
);
104 pa_xfree(e
->filename
);
105 pa_proplist_clear(e
->proplist
);
107 pa_assert(e
->core
== c
);
109 pa_subscription_post(c
, PA_SUBSCRIPTION_EVENT_SAMPLE_CACHE
|PA_SUBSCRIPTION_EVENT_CHANGE
, e
->index
);
111 e
= pa_xnew(pa_scache_entry
, 1);
113 if (!pa_namereg_register(c
, name
, PA_NAMEREG_SAMPLE
, e
, TRUE
)) {
118 e
->name
= pa_xstrdup(name
);
120 e
->proplist
= pa_proplist_new();
122 pa_idxset_put(c
->scache
, e
, &e
->index
);
124 pa_subscription_post(c
, PA_SUBSCRIPTION_EVENT_SAMPLE_CACHE
|PA_SUBSCRIPTION_EVENT_NEW
, e
->index
);
127 e
->last_used_time
= 0;
128 pa_memchunk_reset(&e
->memchunk
);
131 e
->last_used_time
= 0;
133 pa_sample_spec_init(&e
->sample_spec
);
134 pa_channel_map_init(&e
->channel_map
);
135 pa_cvolume_init(&e
->volume
);
136 e
->volume_is_set
= FALSE
;
138 pa_proplist_sets(e
->proplist
, PA_PROP_MEDIA_ROLE
, "event");
143 int pa_scache_add_item(
146 const pa_sample_spec
*ss
,
147 const pa_channel_map
*map
,
148 const pa_memchunk
*chunk
,
153 char st
[PA_SAMPLE_SPEC_SNPRINT_MAX
];
158 pa_assert(!ss
|| pa_sample_spec_valid(ss
));
159 pa_assert(!map
|| (pa_channel_map_valid(map
) && ss
&& pa_channel_map_compatible(map
, ss
)));
162 pa_channel_map_init_extend(&tmap
, ss
->channels
, PA_CHANNEL_MAP_DEFAULT
);
166 if (chunk
&& chunk
->length
> PA_SCACHE_ENTRY_SIZE_MAX
)
169 if (!(e
= scache_add_item(c
, name
)))
172 pa_sample_spec_init(&e
->sample_spec
);
173 pa_channel_map_init(&e
->channel_map
);
174 pa_cvolume_init(&e
->volume
);
175 e
->volume_is_set
= FALSE
;
178 e
->sample_spec
= *ss
;
179 pa_cvolume_reset(&e
->volume
, ss
->channels
);
183 e
->channel_map
= *map
;
186 e
->memchunk
= *chunk
;
187 pa_memblock_ref(e
->memchunk
.memblock
);
191 pa_proplist_update(e
->proplist
, PA_UPDATE_REPLACE
, p
);
196 pa_log_debug("Created sample \"%s\" (#%d), %lu bytes with sample spec %s",
197 name
, e
->index
, (unsigned long) e
->memchunk
.length
,
198 pa_sample_spec_snprint(st
, sizeof(st
), &e
->sample_spec
));
203 int pa_scache_add_file(pa_core
*c
, const char *name
, const char *filename
, uint32_t *idx
) {
213 if (ExpandEnvironmentStrings(filename
, buf
, MAX_PATH
))
221 p
= pa_proplist_new();
222 pa_proplist_sets(p
, PA_PROP_MEDIA_FILENAME
, filename
);
224 if (pa_sound_file_load(c
->mempool
, filename
, &ss
, &map
, &chunk
, p
) < 0) {
229 r
= pa_scache_add_item(c
, name
, &ss
, &map
, &chunk
, p
, idx
);
230 pa_memblock_unref(chunk
.memblock
);
236 int pa_scache_add_file_lazy(pa_core
*c
, const char *name
, const char *filename
, uint32_t *idx
) {
242 if (ExpandEnvironmentStrings(filename
, buf
, MAX_PATH
))
250 if (!(e
= scache_add_item(c
, name
)))
254 e
->filename
= pa_xstrdup(filename
);
256 pa_proplist_sets(e
->proplist
, PA_PROP_MEDIA_FILENAME
, filename
);
258 if (!c
->scache_auto_unload_event
)
259 c
->scache_auto_unload_event
= pa_core_rttime_new(c
, pa_rtclock_now() + UNLOAD_POLL_TIME
, timeout_callback
, c
);
267 int pa_scache_remove_item(pa_core
*c
, const char *name
) {
273 if (!(e
= pa_namereg_get(c
, name
, PA_NAMEREG_SAMPLE
)))
276 pa_assert_se(pa_idxset_remove_by_data(c
->scache
, e
, NULL
) == e
);
278 pa_log_debug("Removed sample \"%s\"", name
);
285 void pa_scache_free_all(pa_core
*c
) {
290 while ((e
= pa_idxset_steal_first(c
->scache
, NULL
)))
293 if (c
->scache_auto_unload_event
) {
294 c
->mainloop
->time_free(c
->scache_auto_unload_event
);
295 c
->scache_auto_unload_event
= NULL
;
299 int pa_scache_play_item(pa_core
*c
, const char *name
, pa_sink
*sink
, pa_volume_t volume
, pa_proplist
*p
, uint32_t *sink_input_idx
) {
303 pa_bool_t pass_volume
;
309 if (!(e
= pa_namereg_get(c
, name
, PA_NAMEREG_SAMPLE
)))
312 merged
= pa_proplist_new();
313 pa_proplist_sets(merged
, PA_PROP_MEDIA_NAME
, name
);
314 pa_proplist_sets(merged
, PA_PROP_EVENT_ID
, name
);
316 if (e
->lazy
&& !e
->memchunk
.memblock
) {
317 pa_channel_map old_channel_map
= e
->channel_map
;
319 if (pa_sound_file_load(c
->mempool
, e
->filename
, &e
->sample_spec
, &e
->channel_map
, &e
->memchunk
, merged
) < 0)
322 pa_subscription_post(c
, PA_SUBSCRIPTION_EVENT_SAMPLE_CACHE
|PA_SUBSCRIPTION_EVENT_CHANGE
, e
->index
);
324 if (e
->volume_is_set
) {
325 if (pa_cvolume_valid(&e
->volume
))
326 pa_cvolume_remap(&e
->volume
, &old_channel_map
, &e
->channel_map
);
328 pa_cvolume_reset(&e
->volume
, e
->sample_spec
.channels
);
332 if (!e
->memchunk
.memblock
)
335 pa_log_debug("Playing sample \"%s\" on \"%s\"", name
, sink
->name
);
339 if (e
->volume_is_set
&& volume
!= PA_VOLUME_INVALID
) {
340 pa_cvolume_set(&r
, e
->sample_spec
.channels
, volume
);
341 pa_sw_cvolume_multiply(&r
, &r
, &e
->volume
);
342 } else if (e
->volume_is_set
)
344 else if (volume
!= PA_VOLUME_INVALID
)
345 pa_cvolume_set(&r
, e
->sample_spec
.channels
, volume
);
349 pa_proplist_update(merged
, PA_UPDATE_REPLACE
, e
->proplist
);
352 pa_proplist_update(merged
, PA_UPDATE_REPLACE
, p
);
354 if (pa_play_memchunk(sink
,
355 &e
->sample_spec
, &e
->channel_map
,
357 pass_volume
? &r
: NULL
,
359 PA_SINK_INPUT_NO_CREATE_ON_SUSPEND
|PA_SINK_INPUT_KILL_ON_SUSPEND
, sink_input_idx
) < 0)
362 pa_proplist_free(merged
);
365 time(&e
->last_used_time
);
370 pa_proplist_free(merged
);
374 int pa_scache_play_item_by_name(pa_core
*c
, const char *name
, const char*sink_name
, pa_volume_t volume
, pa_proplist
*p
, uint32_t *sink_input_idx
) {
380 if (!(sink
= pa_namereg_get(c
, sink_name
, PA_NAMEREG_SINK
)))
383 return pa_scache_play_item(c
, name
, sink
, volume
, p
, sink_input_idx
);
386 const char *pa_scache_get_name_by_id(pa_core
*c
, uint32_t id
) {
390 pa_assert(id
!= PA_IDXSET_INVALID
);
392 if (!c
->scache
|| !(e
= pa_idxset_get_by_index(c
->scache
, id
)))
398 uint32_t pa_scache_get_id_by_name(pa_core
*c
, const char *name
) {
404 if (!(e
= pa_namereg_get(c
, name
, PA_NAMEREG_SAMPLE
)))
405 return PA_IDXSET_INVALID
;
410 size_t pa_scache_total_size(pa_core
*c
) {
417 if (!c
->scache
|| !pa_idxset_size(c
->scache
))
420 for (e
= pa_idxset_first(c
->scache
, &idx
); e
; e
= pa_idxset_next(c
->scache
, &idx
))
421 if (e
->memchunk
.memblock
)
422 sum
+= e
->memchunk
.length
;
427 void pa_scache_unload_unused(pa_core
*c
) {
434 if (!c
->scache
|| !pa_idxset_size(c
->scache
))
439 for (e
= pa_idxset_first(c
->scache
, &idx
); e
; e
= pa_idxset_next(c
->scache
, &idx
)) {
441 if (!e
->lazy
|| !e
->memchunk
.memblock
)
444 if (e
->last_used_time
+ c
->scache_idle_time
> now
)
447 pa_memblock_unref(e
->memchunk
.memblock
);
448 pa_memchunk_reset(&e
->memchunk
);
450 pa_subscription_post(c
, PA_SUBSCRIPTION_EVENT_SAMPLE_CACHE
|PA_SUBSCRIPTION_EVENT_CHANGE
, e
->index
);
454 static void add_file(pa_core
*c
, const char *pathname
) {
458 pa_core_assert_ref(c
);
461 e
= pa_path_get_filename(pathname
);
463 if (stat(pathname
, &st
) < 0) {
464 pa_log("stat('%s'): %s", pathname
, pa_cstrerror(errno
));
468 #if defined(S_ISREG) && defined(S_ISLNK)
469 if (S_ISREG(st
.st_mode
) || S_ISLNK(st
.st_mode
))
471 pa_scache_add_file_lazy(c
, e
, pathname
, NULL
);
474 int pa_scache_add_directory_lazy(pa_core
*c
, const char *pathname
) {
477 pa_core_assert_ref(c
);
480 /* First try to open this as directory */
481 if (!(dir
= opendir(pathname
))) {
485 /* If that fails, try to open it as shell glob */
487 if (glob(pathname
, GLOB_ERR
|GLOB_NOSORT
, NULL
, &p
) < 0) {
488 pa_log("failed to open directory '%s': %s", pathname
, pa_cstrerror(errno
));
492 for (i
= 0; i
< p
.gl_pathc
; i
++)
493 add_file(c
, p
.gl_pathv
[i
]);
502 while ((e
= readdir(dir
))) {
505 if (e
->d_name
[0] == '.')
508 p
= pa_sprintf_malloc("%s" PA_PATH_SEP
"%s", pathname
, e
->d_name
);