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_OUTPUT_CHUNK_SIZE (64 * 1024)
164 static int oggdec_execute(struct btr_node *btrn, const char *cmd, char **result)
166 struct filter_node *fn = btr_context(btrn);
167 struct private_oggdec_data *pod = fn->private_data;
169 if (!strcmp(cmd, "samplerate")) {
170 if (pod->samplerate == 0)
171 return -ERRNO_TO_PARA_ERROR(ENAVAIL);
172 *result = make_message("%u", pod->samplerate);
175 if (!strcmp(cmd, "channels")) {
176 if (pod->channels == 0)
177 return -ERRNO_TO_PARA_ERROR(ENAVAIL);
178 *result = make_message("%u", pod->channels);
181 return -ERRNO_TO_PARA_ERROR(ENOTSUP);
184 static void ogg_post_select(__a_unused struct sched *s, struct task *t)
186 struct filter_node *fn = container_of(t, struct filter_node, task);
187 struct private_oggdec_data *pod = fn->private_data;
188 struct btr_node *btrn = fn->btrn;
194 ret = prepare_filter_node(fn);
199 len = btr_next_buffer(btrn, &in);
200 iqs = btr_get_input_queue_size(btrn);
204 pod->vf = para_malloc(sizeof(struct OggVorbis_File));
205 PARA_NOTICE_LOG("input queue: %zu, opening ov callbacks\n", iqs);
206 oret = ov_open_callbacks(fn, pod->vf,
207 NULL, /* no initial buffer */
208 0, /* no initial bytes */
209 ovc); /* the ov_open_callbacks */
210 if (oret == OV_ENOTVORBIS || oret == OV_EBADHEADER) {
211 /* this might be due to the input buffer being too small */
212 if (!btr_no_parent(btrn)) {
215 fn->min_iqs = iqs + 1;
218 ret = (oret == OV_ENOTVORBIS)?
219 -E_OGGDEC_NOTVORBIS : -E_OGGDEC_BADHEADER;
222 ret = -E_OGGDEC_READ;
223 if (oret == OV_EREAD)
225 ret = -E_OGGDEC_VERSION;
226 if (oret == OV_EVERSION)
228 ret = -E_OGGDEC_FAULT;
231 pod->channels = ov_info(pod->vf, 0)->channels;
232 pod->samplerate = ov_info(pod->vf, 0)->rate;
233 PARA_NOTICE_LOG("%d channels, %d Hz\n", pod->channels,
235 ///* wait a bit to avoid buffer underruns */
236 //tv_add(now, &(struct timeval){0, 500 * 1000}, &pod->stream_start);
240 char *out = para_malloc(OGGDEC_OUTPUT_CHUNK_SIZE);
241 ssize_t read_ret = ov_read(pod->vf, out, OGGDEC_OUTPUT_CHUNK_SIZE,
242 ENDIAN, 2 /* 16 bit */, 1 /* signed */, NULL);
247 if (btr_no_parent(btrn))
251 if (read_ret == OV_HOLE)
254 ret = -E_OGGDEC_BADLINK;
257 btr_add_output(out, read_ret, btrn);
267 static ssize_t ogg_convert(char *inbuffer, size_t len, struct filter_node *fn)
270 struct private_oggdec_data *pod = fn->private_data;
271 struct oggdec_filter_args_info *conf = fn->conf;
272 /* make the buffer known to the read callback cb_read() */
273 pod->inbuf = inbuffer;
274 pod->inbuf_len = len;
278 if (*fn->fc->input_error < 0)
279 return *fn->fc->input_error;
282 pod->vf = para_malloc(sizeof(struct OggVorbis_File));
283 PARA_NOTICE_LOG("input buffer: %zd, opening ov callbacks\n", len);
284 ret = ov_open_callbacks(fn, pod->vf,
285 NULL, /* no initial buffer */
286 0, /* no initial bytes */
287 ovc); /* the ov_open_callbacks */
288 if (ret == OV_ENOTVORBIS || ret == OV_EBADHEADER) {
289 /* this might be due to the input buffer being too small */
290 int ib = 1024 * conf->initial_buffer_arg; /* initial buffer */
292 PARA_INFO_LOG("initial input buffer %zd/%d, "
293 "waiting for more data\n", len, ib);
298 return ret == OV_ENOTVORBIS?
299 -E_OGGDEC_NOTVORBIS : -E_OGGDEC_BADHEADER;
302 return -E_OGGDEC_READ;
303 if (ret == OV_EVERSION)
304 return -E_OGGDEC_VERSION;
306 return -E_OGGDEC_FAULT;
307 fn->fc->channels = ov_info(pod->vf, 0)->channels;
308 fn->fc->samplerate = ov_info(pod->vf, 0)->rate;
309 PARA_NOTICE_LOG("%d channels, %d Hz\n", fn->fc->channels,
311 /* wait a bit to avoid buffer underruns */
312 tv_add(now, &(struct timeval){0, 500 * 1000}, &pod->stream_start);
313 return pod->converted;
315 if (tv_diff(now, &pod->stream_start, NULL) < 0) {
316 PARA_DEBUG_LOG("initial delay..\n");
319 while (fn->loaded < fn->bufsize) {
320 int length = fn->bufsize - fn->loaded;
321 long read_ret = ov_read(pod->vf, fn->buf + fn->loaded, length,
322 ENDIAN, 2 /* 16 bit */, 1 /* signed */, NULL);
324 return pod->converted;
325 if (read_ret == OV_HOLE) {
327 PARA_INFO_LOG("hole, delaying playback\n");
328 tv_add(now, &(struct timeval){0, 500 * 1000}, &pod->stream_start);
330 return pod->converted;
333 return -E_OGGDEC_BADLINK;
334 fn->loaded += read_ret;
336 return pod->converted;
339 static int oggdec_parse_config(int argc, char **argv, void **config)
342 struct oggdec_filter_args_info *ogg_conf;
344 ogg_conf = para_calloc(sizeof(*ogg_conf));
345 ret = -E_OGGDEC_SYNTAX;
346 if (oggdec_cmdline_parser(argc, argv, ogg_conf))
348 ret = -ERRNO_TO_PARA_ERROR(EINVAL);
349 if (ogg_conf->bufsize_arg < 0)
351 if (ogg_conf->bufsize_arg >= INT_MAX / 1024)
353 if (ogg_conf->initial_buffer_arg < 0)
355 if (ogg_conf->initial_buffer_arg >= INT_MAX / 1024)
365 * The init function of the ogg vorbis decoder.
367 * \param f Its fields are filled in by the function.
369 void oggdec_filter_init(struct filter *f)
371 struct oggdec_filter_args_info dummy;
373 oggdec_cmdline_parser_init(&dummy);
375 f->close = ogg_close;
376 f->convert = ogg_convert;
377 f->pre_select = generic_filter_pre_select;
378 f->post_select = ogg_post_select;
379 f->parse_config = oggdec_parse_config;
380 f->execute = oggdec_execute;
381 f->help = (struct ggo_help) {
382 .short_help = oggdec_filter_args_info_help,
383 .detailed_help = oggdec_filter_args_info_detailed_help