2 * Copyright (C) 2005-2011 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>
17 #include "buffer_tree.h"
22 /** Determine byte sex. */
23 #ifdef WORDS_BIGENDIAN
29 /** Data specific to the oggdec filter. */
30 struct private_oggdec_data {
31 /** Describes an ogg vorbis file. */
33 /** The number of bytes consumed from the input buffer. */
35 /** The number of channels of the current stream. */
36 unsigned int channels;
37 /** Current sample rate in Hz. */
38 unsigned int sample_rate;
41 static size_t cb_read(void *buf, size_t size, size_t nmemb, void *datasource)
43 struct filter_node *fn = datasource;
44 struct private_oggdec_data *pod = fn->private_data;
45 struct btr_node *btrn = fn->btrn;
47 size_t nbytes = btr_next_buffer(btrn, &btr_buf), tmp;
50 * oggvorbis always uses size == 1. Other sizes would complicate the code
51 * for no real gain. So we simply don't support size != 1.
54 assert(pod->converted <= nbytes);
55 tmp = nbytes - pod->converted;
56 PARA_DEBUG_LOG("vorbis requests %zu bytes have %zu\n", nmemb, tmp);
57 tmp = PARA_MIN(tmp, nmemb);
60 memcpy(buf, btr_buf + pod->converted, tmp);
61 pod->converted += tmp;
66 * Custom data seeking function.
68 * Since we want the data source to be treated as unseekable at all
69 * times, the provided seek callback always returns -1 (failure).
71 static int cb_seek(__a_unused void *datasource, __a_unused ogg_int64_t offset,
72 __a_unused int whence)
77 static int cb_close(__a_unused void *datasource)
82 static const ov_callbacks ovc = {
85 .close_func = cb_close,
87 * The tell function need not be provided if the data IO abstraction is
93 static void ogg_open(struct filter_node *fn)
95 struct private_oggdec_data *pod = para_calloc(
96 sizeof(struct private_oggdec_data));
98 fn->private_data = pod;
102 static void ogg_close(struct filter_node *fn)
104 struct private_oggdec_data *pod = fn->private_data;
106 PARA_DEBUG_LOG("ov_clearing %p, pod = %p\n", pod->vf, pod);
111 PARA_DEBUG_LOG("nothing to close\n");
112 free(fn->private_data);
113 fn->private_data = NULL;
116 #define OGGDEC_OUTPUT_CHUNK_SIZE (640 * 1024)
118 static int oggdec_execute(struct btr_node *btrn, const char *cmd, char **result)
120 struct filter_node *fn = btr_context(btrn);
121 struct private_oggdec_data *pod = fn->private_data;
123 return decoder_execute(cmd, pod->sample_rate, pod->channels, result);
126 static int ogg_init(struct filter_node *fn)
128 struct private_oggdec_data *pod = fn->private_data;
129 struct btr_node *btrn = fn->btrn;
132 struct OggVorbis_File *vf = para_malloc(sizeof(*vf));
134 PARA_NOTICE_LOG("iqs: %zu, min_iqs: %zu, opening ov callbacks\n",
135 btr_get_input_queue_size(btrn), fn->min_iqs);
137 oret = ov_open_callbacks(fn, vf,
138 NULL, /* no initial buffer */
139 0, /* no initial bytes */
140 ovc); /* the ov_open_callbacks */
141 if (oret == OV_ENOTVORBIS || oret == OV_EBADHEADER) {
142 /* this might be due to the input buffer being too small */
143 if (!btr_no_parent(btrn)) {
145 iqs = btr_get_input_queue_size(btrn);
147 if (iqs < fn->min_iqs)
149 PARA_CRIT_LOG("iqs: %zu\n", iqs);
150 btr_merge(btrn, fn->min_iqs);
154 ret = (oret == OV_ENOTVORBIS)?
155 -E_OGGDEC_NOTVORBIS : -E_OGGDEC_BADHEADER;
158 ret = -E_OGGDEC_READ;
159 if (oret == OV_EREAD)
161 ret = -E_OGGDEC_VERSION;
162 if (oret == OV_EVERSION)
164 ret = -E_OGGDEC_FAULT;
167 pod->channels = ov_info(vf, 0)->channels;
168 pod->sample_rate = ov_info(vf, 0)->rate;
169 PARA_NOTICE_LOG("%d channels, %d Hz\n", pod->channels,
176 btr_consume(btrn, pod->converted);
184 static void ogg_pre_select(__a_unused struct sched *s, struct task *t)
186 struct filter_node *fn = container_of(t, struct filter_node, task);
190 ret = btr_node_status(fn->btrn, fn->min_iqs, BTR_NT_INTERNAL);
194 sched_request_timeout_ms(100, s);
197 static void ogg_post_select(__a_unused struct sched *s, struct task *t)
199 struct filter_node *fn = container_of(t, struct filter_node, task);
200 struct private_oggdec_data *pod = fn->private_data;
201 struct btr_node *btrn = fn->btrn;
204 ssize_t read_ret, have;
208 ret = ns = btr_node_status(btrn, fn->min_iqs, BTR_NT_INTERNAL);
214 btr_merge(btrn, fn->min_iqs);
219 out = para_malloc(OGGDEC_OUTPUT_CHUNK_SIZE);
221 read_ret = ov_read(pod->vf, out + have,
222 OGGDEC_OUTPUT_CHUNK_SIZE - have,
223 ENDIAN, 2 /* 16 bit */, 1 /* signed */, NULL);
224 btr_consume(btrn, pod->converted);
229 if (have >= OGGDEC_OUTPUT_CHUNK_SIZE)
234 else if (have < OGGDEC_OUTPUT_CHUNK_SIZE)
235 out = para_realloc(out, have);
237 btr_add_output(out, have, btrn);
241 if (read_ret == OV_HOLE) /* avoid buffer underruns */
243 if (read_ret == 0 || read_ret == OV_HOLE)
245 ret = -E_OGGDEC_BADLINK;
252 btr_remove_node(btrn);
257 * The init function of the ogg vorbis decoder.
259 * \param f Its fields are filled in by the function.
261 void oggdec_filter_init(struct filter *f)
264 f->close = ogg_close;
265 f->pre_select = ogg_pre_select;
266 f->post_select = ogg_post_select;
267 f->execute = oggdec_execute;