2 * Copyright (C) 2005-2009 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file oggdec_filter.c Paraslash's ogg vorbis decoder. */
10 #include <vorbis/vorbisfile.h>
14 #include "oggdec_filter.cmdline.h"
18 #include "buffer_tree.h"
23 /** Determine byte sex. */
24 #ifdef WORDS_BIGENDIAN
30 /** Data specific to the oggdec filter. */
31 struct private_oggdec_data {
32 /** Describes an ogg vorbis file. */
34 /** The input buffer. */
36 /** The length of \a inbuf. */
38 /** The number of bytes consumed from the input buffer. */
40 /** When to start producing output. */
41 struct timeval stream_start;
42 /** The number of channels of the current stream. */
43 unsigned int channels;
44 /** Current sample rate in Hz. */
45 unsigned int samplerate;
48 static size_t cb_read_nobtr(void *buf, size_t size, size_t nmemb, void *datasource)
50 struct filter_node *fn = datasource;
51 struct private_oggdec_data *pod = fn->private_data;
52 size_t ret, have = pod->inbuf_len - pod->converted;
53 char *p = pod->inbuf + pod->converted;
55 // PARA_DEBUG_LOG("pod = %p\n", pod);
56 // PARA_DEBUG_LOG("vorbis requests %d bytes, have %d\n", size * nmemb, have);
57 if (pod->inbuf_len < size) {
58 if (*fn->fc->input_error)
63 ret = PARA_MIN(nmemb, have / size) * size;
65 pod->converted += ret;
69 static size_t cb_read_btr(void *buf, size_t size, size_t nmemb, void *datasource)
71 struct filter_node *fn = datasource;
72 struct btr_node *btrn = fn->btrn;
76 * oggvorbis always uses size == 1. Other sizes would complicate the code
77 * for no real gain. So we simply don't support size != 1.
80 //PARA_DEBUG_LOG("vorbis requests %zu x %zu = %zu bytes\n", size, nmemb, size * nmemb);
84 size_t nbytes = btr_next_buffer(btrn, &btr_buf);
87 nbytes = PARA_MIN(nmemb - copied, nbytes);
88 memcpy(buf + copied, btr_buf, nbytes);
90 btr_consume(btrn, nbytes);
97 static size_t cb_read(void *buf, size_t size, size_t nmemb, void *datasource)
99 struct filter_node *fn = datasource;
102 return cb_read_btr(buf, size, nmemb, datasource);
104 return cb_read_nobtr(buf, size, nmemb, datasource);
108 * Custom data seeking function.
110 * Since we want the data source to be treated as unseekable at all
111 * times, the provided seek callback always returns -1 (failure).
113 static int cb_seek(__a_unused void *datasource, __a_unused ogg_int64_t offset,
114 __a_unused int whence)
119 static int cb_close(__a_unused void *datasource)
124 static const ov_callbacks ovc = {
125 .read_func = cb_read,
126 .seek_func = cb_seek,
127 .close_func = cb_close,
129 * The tell function need not be provided if the data IO abstraction is
135 static void ogg_open(struct filter_node *fn)
137 struct private_oggdec_data *pod = para_calloc(
138 sizeof(struct private_oggdec_data));
139 struct oggdec_filter_args_info *conf = fn->conf;
141 fn->private_data = pod;
142 fn->bufsize = conf->bufsize_arg * 1024;
143 fn->buf = para_malloc(fn->bufsize);
146 static void ogg_close(struct filter_node *fn)
148 struct private_oggdec_data *pod = fn->private_data;
150 PARA_DEBUG_LOG("ov_clearing %p, pod = %p\n", pod->vf, pod);
155 PARA_DEBUG_LOG("nothing to close in fc %p, pod = %p\n", pod->vf, pod);
158 free(fn->private_data);
159 fn->private_data = NULL;
162 #define OGGDEC_MAX_PENDING (640 * 1024)
163 #define OGGDEC_OUTPUT_CHUNK_SIZE (64 * 1024)
166 static int oggdec_execute(struct btr_node *btrn, const char *cmd, char **result)
168 struct filter_node *fn = btr_context(btrn);
169 struct private_oggdec_data *pod = fn->private_data;
171 if (!strcmp(cmd, "samplerate")) {
172 if (pod->samplerate == 0)
173 return -ERRNO_TO_PARA_ERROR(ENAVAIL);
174 *result = make_message("%u", pod->samplerate);
177 if (!strcmp(cmd, "channels")) {
178 if (pod->channels == 0)
179 return -ERRNO_TO_PARA_ERROR(ENAVAIL);
180 *result = make_message("%u", pod->channels);
183 return -ERRNO_TO_PARA_ERROR(ENOTSUP);
186 static void ogg_pre_select(struct sched *s, struct task *t)
188 struct filter_node *fn = container_of(t, struct filter_node, task);
189 size_t iqs = btr_get_input_queue_size(fn->btrn);
194 if (btr_bytes_pending(fn->btrn) > OGGDEC_MAX_PENDING)
195 return; /* FIXME, should use reasonable bound on timeout */
196 s->timeout.tv_sec = 0;
197 s->timeout.tv_usec = 1;
200 static void ogg_post_select(__a_unused struct sched *s, struct task *t)
202 struct filter_node *fn = container_of(t, struct filter_node, task);
203 struct private_oggdec_data *pod = fn->private_data;
204 struct btr_node *btrn = fn->btrn;
210 ret = prepare_filter_node(fn);
215 len = btr_next_buffer(btrn, &in);
216 iqs = btr_get_input_queue_size(btrn);
220 pod->vf = para_malloc(sizeof(struct OggVorbis_File));
221 PARA_NOTICE_LOG("input queue: %zu, opening ov callbacks\n", iqs);
222 oret = ov_open_callbacks(fn, pod->vf,
223 NULL, /* no initial buffer */
224 0, /* no initial bytes */
225 ovc); /* the ov_open_callbacks */
226 if (oret == OV_ENOTVORBIS || oret == OV_EBADHEADER) {
227 /* this might be due to the input buffer being too small */
228 if (!btr_no_parent(btrn)) {
231 fn->min_iqs = iqs + 1;
234 ret = (oret == OV_ENOTVORBIS)?
235 -E_OGGDEC_NOTVORBIS : -E_OGGDEC_BADHEADER;
238 ret = -E_OGGDEC_READ;
239 if (oret == OV_EREAD)
241 ret = -E_OGGDEC_VERSION;
242 if (oret == OV_EVERSION)
244 ret = -E_OGGDEC_FAULT;
247 pod->channels = ov_info(pod->vf, 0)->channels;
248 pod->samplerate = ov_info(pod->vf, 0)->rate;
249 PARA_NOTICE_LOG("%d channels, %d Hz\n", pod->channels,
251 ///* wait a bit to avoid buffer underruns */
252 //tv_add(now, &(struct timeval){0, 500 * 1000}, &pod->stream_start);
256 char *out = para_malloc(OGGDEC_OUTPUT_CHUNK_SIZE);
257 ssize_t read_ret = ov_read(pod->vf, out, OGGDEC_OUTPUT_CHUNK_SIZE,
258 ENDIAN, 2 /* 16 bit */, 1 /* signed */, NULL);
263 if (btr_no_parent(btrn))
267 if (read_ret == OV_HOLE)
270 ret = -E_OGGDEC_BADLINK;
273 btr_add_output(out, read_ret, btrn);
283 static ssize_t ogg_convert(char *inbuffer, size_t len, struct filter_node *fn)
286 struct private_oggdec_data *pod = fn->private_data;
287 struct oggdec_filter_args_info *conf = fn->conf;
288 /* make the buffer known to the read callback cb_read() */
289 pod->inbuf = inbuffer;
290 pod->inbuf_len = len;
294 if (*fn->fc->input_error < 0)
295 return *fn->fc->input_error;
298 pod->vf = para_malloc(sizeof(struct OggVorbis_File));
299 PARA_NOTICE_LOG("input buffer: %zd, opening ov callbacks\n", len);
300 ret = ov_open_callbacks(fn, pod->vf,
301 NULL, /* no initial buffer */
302 0, /* no initial bytes */
303 ovc); /* the ov_open_callbacks */
304 if (ret == OV_ENOTVORBIS || ret == OV_EBADHEADER) {
305 /* this might be due to the input buffer being too small */
306 int ib = 1024 * conf->initial_buffer_arg; /* initial buffer */
308 PARA_INFO_LOG("initial input buffer %zd/%d, "
309 "waiting for more data\n", len, ib);
314 return ret == OV_ENOTVORBIS?
315 -E_OGGDEC_NOTVORBIS : -E_OGGDEC_BADHEADER;
318 return -E_OGGDEC_READ;
319 if (ret == OV_EVERSION)
320 return -E_OGGDEC_VERSION;
322 return -E_OGGDEC_FAULT;
323 fn->fc->channels = ov_info(pod->vf, 0)->channels;
324 fn->fc->samplerate = ov_info(pod->vf, 0)->rate;
325 PARA_NOTICE_LOG("%d channels, %d Hz\n", fn->fc->channels,
327 /* wait a bit to avoid buffer underruns */
328 tv_add(now, &(struct timeval){0, 500 * 1000}, &pod->stream_start);
329 return pod->converted;
331 if (tv_diff(now, &pod->stream_start, NULL) < 0) {
332 PARA_DEBUG_LOG("initial delay..\n");
335 while (fn->loaded < fn->bufsize) {
336 int length = fn->bufsize - fn->loaded;
337 long read_ret = ov_read(pod->vf, fn->buf + fn->loaded, length,
338 ENDIAN, 2 /* 16 bit */, 1 /* signed */, NULL);
340 return pod->converted;
341 if (read_ret == OV_HOLE) {
343 PARA_INFO_LOG("hole, delaying playback\n");
344 tv_add(now, &(struct timeval){0, 500 * 1000}, &pod->stream_start);
346 return pod->converted;
349 return -E_OGGDEC_BADLINK;
350 fn->loaded += read_ret;
352 return pod->converted;
355 static int oggdec_parse_config(int argc, char **argv, void **config)
358 struct oggdec_filter_args_info *ogg_conf;
360 ogg_conf = para_calloc(sizeof(*ogg_conf));
361 ret = -E_OGGDEC_SYNTAX;
362 if (oggdec_cmdline_parser(argc, argv, ogg_conf))
364 ret = -ERRNO_TO_PARA_ERROR(EINVAL);
365 if (ogg_conf->bufsize_arg < 0)
367 if (ogg_conf->bufsize_arg >= INT_MAX / 1024)
369 if (ogg_conf->initial_buffer_arg < 0)
371 if (ogg_conf->initial_buffer_arg >= INT_MAX / 1024)
381 * The init function of the ogg vorbis decoder.
383 * \param f Its fields are filled in by the function.
385 void oggdec_filter_init(struct filter *f)
387 struct oggdec_filter_args_info dummy;
389 oggdec_cmdline_parser_init(&dummy);
391 f->close = ogg_close;
392 f->convert = ogg_convert;
393 f->pre_select = ogg_pre_select;
394 f->post_select = ogg_post_select;
395 f->parse_config = oggdec_parse_config;
396 f->execute = oggdec_execute;
397 f->help = (struct ggo_help) {
398 .short_help = oggdec_filter_args_info_help,
399 .detailed_help = oggdec_filter_args_info_detailed_help