2 This file is part of PulseAudio.
4 Copyright 2004-2008 Lennart Poettering
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.
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.
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
34 #include <pulse/xmalloc.h>
35 #include <pulse/util.h>
37 #include <pulsecore/core-error.h>
38 #include <pulsecore/sink-input.h>
39 #include <pulsecore/log.h>
40 #include <pulsecore/thread-mq.h>
41 #include <pulsecore/core-util.h>
42 #include <pulsecore/mix.h>
43 #include <pulsecore/sndfile-util.h>
45 #include "sound-file-stream.h"
47 #define MEMBLOCKQ_MAXLENGTH (16*1024*1024)
49 typedef struct file_stream
{
52 pa_sink_input
*sink_input
;
55 sf_count_t (*readf_function
)(SNDFILE
*sndfile
, void *ptr
, sf_count_t frames
);
57 /* We need this memblockq here to easily fulfill rewind requests
58 * (even beyond the file start!) */
59 pa_memblockq
*memblockq
;
63 FILE_STREAM_MESSAGE_UNLINK
66 PA_DEFINE_PRIVATE_CLASS(file_stream
, pa_msgobject
);
67 #define FILE_STREAM(o) (file_stream_cast(o))
69 /* Called from main context */
70 static void file_stream_unlink(file_stream
*u
) {
76 pa_sink_input_unlink(u
->sink_input
);
77 pa_sink_input_unref(u
->sink_input
);
80 /* Make sure we don't decrease the ref count twice. */
84 /* Called from main context */
85 static void file_stream_free(pa_object
*o
) {
86 file_stream
*u
= FILE_STREAM(o
);
90 pa_memblockq_free(u
->memblockq
);
98 /* Called from main context */
99 static int file_stream_process_msg(pa_msgobject
*o
, int code
, void*userdata
, int64_t offset
, pa_memchunk
*chunk
) {
100 file_stream
*u
= FILE_STREAM(o
);
101 file_stream_assert_ref(u
);
104 case FILE_STREAM_MESSAGE_UNLINK
:
105 file_stream_unlink(u
);
112 /* Called from main context */
113 static void sink_input_kill_cb(pa_sink_input
*i
) {
116 pa_sink_input_assert_ref(i
);
117 u
= FILE_STREAM(i
->userdata
);
118 file_stream_assert_ref(u
);
120 file_stream_unlink(u
);
123 /* Called from IO thread context */
124 static void sink_input_state_change_cb(pa_sink_input
*i
, pa_sink_input_state_t state
) {
127 pa_sink_input_assert_ref(i
);
128 u
= FILE_STREAM(i
->userdata
);
129 file_stream_assert_ref(u
);
131 /* If we are added for the first time, ask for a rewinding so that
132 * we are heard right-away. */
133 if (PA_SINK_INPUT_IS_LINKED(state
) &&
134 i
->thread_info
.state
== PA_SINK_INPUT_INIT
)
135 pa_sink_input_request_rewind(i
, 0, false, true, true);
138 /* Called from IO thread context */
139 static int sink_input_pop_cb(pa_sink_input
*i
, size_t length
, pa_memchunk
*chunk
) {
142 pa_sink_input_assert_ref(i
);
144 u
= FILE_STREAM(i
->userdata
);
145 file_stream_assert_ref(u
);
156 if (pa_memblockq_peek(u
->memblockq
, chunk
) >= 0) {
157 chunk
->length
= PA_MIN(chunk
->length
, length
);
158 pa_memblockq_drop(u
->memblockq
, chunk
->length
);
165 tchunk
.memblock
= pa_memblock_new(i
->sink
->core
->mempool
, length
);
168 p
= pa_memblock_acquire(tchunk
.memblock
);
170 if (u
->readf_function
) {
171 fs
= pa_frame_size(&i
->sample_spec
);
172 n
= u
->readf_function(u
->sndfile
, p
, (sf_count_t
) (length
/fs
));
175 n
= sf_read_raw(u
->sndfile
, p
, (sf_count_t
) length
);
178 pa_memblock_release(tchunk
.memblock
);
181 pa_memblock_unref(tchunk
.memblock
);
183 sf_close(u
->sndfile
);
188 tchunk
.length
= (size_t) n
* fs
;
190 pa_memblockq_push(u
->memblockq
, &tchunk
);
191 pa_memblock_unref(tchunk
.memblock
);
194 if (pa_sink_input_safe_to_remove(i
)) {
195 pa_memblockq_free(u
->memblockq
);
198 pa_asyncmsgq_post(pa_thread_mq_get()->outq
, PA_MSGOBJECT(u
), FILE_STREAM_MESSAGE_UNLINK
, NULL
, 0, NULL
, NULL
);
204 static void sink_input_process_rewind_cb(pa_sink_input
*i
, size_t nbytes
) {
207 pa_sink_input_assert_ref(i
);
208 u
= FILE_STREAM(i
->userdata
);
209 file_stream_assert_ref(u
);
214 pa_memblockq_rewind(u
->memblockq
, nbytes
);
217 static void sink_input_update_max_rewind_cb(pa_sink_input
*i
, size_t nbytes
) {
220 pa_sink_input_assert_ref(i
);
221 u
= FILE_STREAM(i
->userdata
);
222 file_stream_assert_ref(u
);
227 pa_memblockq_set_maxrewind(u
->memblockq
, nbytes
);
233 const pa_cvolume
*volume
) {
235 file_stream
*u
= NULL
;
238 pa_sink_input_new_data data
;
246 u
= pa_msgobject_new(file_stream
);
247 u
->parent
.parent
.free
= file_stream_free
;
248 u
->parent
.process_msg
= file_stream_process_msg
;
249 u
->core
= sink
->core
;
250 u
->sink_input
= NULL
;
252 u
->readf_function
= NULL
;
255 if ((fd
= pa_open_cloexec(fname
, O_RDONLY
, 0)) < 0) {
256 pa_log("Failed to open file %s: %s", fname
, pa_cstrerror(errno
));
260 /* FIXME: For now we just use posix_fadvise to avoid page faults
261 * when accessing the file data. Eventually we should move the
262 * file reader into the main event loop and pass the data over the
265 #ifdef HAVE_POSIX_FADVISE
266 if (posix_fadvise(fd
, 0, 0, POSIX_FADV_SEQUENTIAL
) < 0) {
267 pa_log_warn("POSIX_FADV_SEQUENTIAL failed: %s", pa_cstrerror(errno
));
270 pa_log_debug("POSIX_FADV_SEQUENTIAL succeeded.");
272 if (posix_fadvise(fd
, 0, 0, POSIX_FADV_WILLNEED
) < 0) {
273 pa_log_warn("POSIX_FADV_WILLNEED failed: %s", pa_cstrerror(errno
));
276 pa_log_debug("POSIX_FADV_WILLNEED succeeded.");
280 if (!(u
->sndfile
= sf_open_fd(fd
, SFM_READ
, &sfi
, 1))) {
281 pa_log("Failed to open file %s", fname
);
287 if (pa_sndfile_read_sample_spec(u
->sndfile
, &ss
) < 0) {
288 pa_log("Failed to determine file sample format.");
292 if (pa_sndfile_read_channel_map(u
->sndfile
, &cm
) < 0) {
294 pa_log_info("Failed to determine file channel map, synthesizing one.");
295 pa_channel_map_init_extend(&cm
, ss
.channels
, PA_CHANNEL_MAP_DEFAULT
);
298 u
->readf_function
= pa_sndfile_readf_function(&ss
);
300 pa_sink_input_new_data_init(&data
);
301 pa_sink_input_new_data_set_sink(&data
, sink
, false);
302 data
.driver
= __FILE__
;
303 pa_sink_input_new_data_set_sample_spec(&data
, &ss
);
304 pa_sink_input_new_data_set_channel_map(&data
, &cm
);
305 pa_sink_input_new_data_set_volume(&data
, volume
);
306 pa_proplist_sets(data
.proplist
, PA_PROP_MEDIA_NAME
, pa_path_get_filename(fname
));
307 pa_proplist_sets(data
.proplist
, PA_PROP_MEDIA_FILENAME
, fname
);
308 pa_sndfile_init_proplist(u
->sndfile
, data
.proplist
);
310 pa_sink_input_new(&u
->sink_input
, sink
->core
, &data
);
311 pa_sink_input_new_data_done(&data
);
316 u
->sink_input
->pop
= sink_input_pop_cb
;
317 u
->sink_input
->process_rewind
= sink_input_process_rewind_cb
;
318 u
->sink_input
->update_max_rewind
= sink_input_update_max_rewind_cb
;
319 u
->sink_input
->kill
= sink_input_kill_cb
;
320 u
->sink_input
->state_change
= sink_input_state_change_cb
;
321 u
->sink_input
->userdata
= u
;
323 pa_sink_input_get_silence(u
->sink_input
, &silence
);
324 u
->memblockq
= pa_memblockq_new("sound-file-stream memblockq", 0, MEMBLOCKQ_MAXLENGTH
, 0, &ss
, 1, 1, 0, &silence
);
325 pa_memblock_unref(silence
.memblock
);
327 pa_sink_input_put(u
->sink_input
);
329 /* The reference to u is dangling here, because we want to keep
330 * this stream around until it is fully played. */
335 file_stream_unref(u
);