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;
39 /** Whether everything was decoded during the previous iteration. */
43 static size_t cb_read(void *buf, size_t size, size_t nmemb, void *datasource)
45 struct filter_node *fn = datasource;
46 struct private_oggdec_data *pod = fn->private_data;
47 struct btr_node *btrn = fn->btrn;
49 size_t nbytes = btr_next_buffer(btrn, &btr_buf), tmp;
52 * oggvorbis always uses size == 1. Other sizes would complicate the code
53 * for no real gain. So we simply don't support size != 1.
56 assert(pod->converted <= nbytes);
57 tmp = nbytes - pod->converted;
58 PARA_DEBUG_LOG("vorbis requests %zu bytes have %zu\n", nmemb, tmp);
59 tmp = PARA_MIN(tmp, nmemb);
62 memcpy(buf, btr_buf + pod->converted, tmp);
63 pod->converted += tmp;
68 * Custom data seeking function.
70 * Since we want the data source to be treated as unseekable at all
71 * times, the provided seek callback always returns -1 (failure).
73 static int cb_seek(__a_unused void *datasource, __a_unused ogg_int64_t offset,
74 __a_unused int whence)
79 static int cb_close(__a_unused void *datasource)
84 static const ov_callbacks ovc = {
87 .close_func = cb_close,
89 * The tell function need not be provided if the data IO abstraction is
95 static void ogg_open(struct filter_node *fn)
97 fn->private_data = para_calloc(sizeof(struct private_oggdec_data));
101 static void ogg_close(struct filter_node *fn)
103 struct private_oggdec_data *pod = fn->private_data;
105 if (pod && pod->vf) {
106 PARA_DEBUG_LOG("ov_clearing %p, pod = %p\n", pod->vf, pod);
111 PARA_DEBUG_LOG("nothing to close\n");
113 fn->private_data = NULL;
116 static int oggdec_execute(struct btr_node *btrn, const char *cmd, char **result)
118 struct filter_node *fn = btr_context(btrn);
119 struct private_oggdec_data *pod = fn->private_data;
121 return decoder_execute(cmd, pod->sample_rate, pod->channels, result);
124 static int ogg_init(struct filter_node *fn)
126 struct private_oggdec_data *pod = fn->private_data;
127 struct btr_node *btrn = fn->btrn;
130 struct OggVorbis_File *vf = para_malloc(sizeof(*vf));
132 PARA_NOTICE_LOG("iqs: %zu, min_iqs: %zu, opening ov callbacks\n",
133 btr_get_input_queue_size(btrn), fn->min_iqs);
135 oret = ov_open_callbacks(fn, vf,
136 NULL, /* no initial buffer */
137 0, /* no initial bytes */
138 ovc); /* the ov_open_callbacks */
139 if (oret == OV_ENOTVORBIS || oret == OV_EBADHEADER) {
140 /* this might be due to the input buffer being too small */
141 if (!btr_no_parent(btrn)) {
143 iqs = btr_get_input_queue_size(btrn);
145 if (iqs < fn->min_iqs)
147 PARA_CRIT_LOG("iqs: %zu\n", iqs);
148 btr_merge(btrn, fn->min_iqs);
152 ret = (oret == OV_ENOTVORBIS)?
153 -E_OGGDEC_NOTVORBIS : -E_OGGDEC_BADHEADER;
156 ret = -E_OGGDEC_READ;
157 if (oret == OV_EREAD)
159 ret = -E_OGGDEC_VERSION;
160 if (oret == OV_EVERSION)
162 ret = -E_OGGDEC_FAULT;
165 pod->channels = ov_info(vf, 0)->channels;
166 pod->sample_rate = ov_info(vf, 0)->rate;
167 PARA_NOTICE_LOG("%d channels, %d Hz\n", pod->channels,
174 btr_consume(btrn, pod->converted);
182 #define OGGDEC_MAX_OUTPUT_SIZE (96 * 1024)
183 #define OGGDEC_OUTPUT_CHUNK_SIZE (32 * 1024)
185 static void ogg_pre_select(struct sched *s, struct task *t)
187 struct filter_node *fn = container_of(t, struct filter_node, task);
188 struct private_oggdec_data *pod = fn->private_data;
189 struct btr_node *btrn = fn->btrn;
192 ret = btr_node_status(btrn, fn->min_iqs, BTR_NT_INTERNAL);
194 return sched_min_delay(s);
197 if (btr_get_output_queue_size(btrn) > OGGDEC_MAX_OUTPUT_SIZE)
202 static void ogg_post_select(__a_unused struct sched *s, struct task *t)
204 struct filter_node *fn = container_of(t, struct filter_node, task);
205 struct private_oggdec_data *pod = fn->private_data;
206 struct btr_node *btrn = fn->btrn;
210 ret = btr_node_status(btrn, fn->min_iqs, BTR_NT_INTERNAL);
211 if (ret < 0 && ret != -E_BTR_EOF) /* fatal error */
213 if (ret <= 0 && !pod->have_more) /* nothing to do */
218 btr_merge(btrn, fn->min_iqs);
223 buf = para_malloc(OGGDEC_OUTPUT_CHUNK_SIZE);
225 ret = ov_read(pod->vf, buf + have, OGGDEC_OUTPUT_CHUNK_SIZE - have,
226 ENDIAN, 2 /* 16 bit */, 1 /* signed */, NULL);
227 btr_consume(btrn, pod->converted);
233 if (have < OGGDEC_OUTPUT_CHUNK_SIZE)
235 if (btr_get_output_queue_size(btrn) > OGGDEC_MAX_OUTPUT_SIZE)
237 btr_add_output(buf, have, btrn);
238 buf = para_malloc(OGGDEC_OUTPUT_CHUNK_SIZE);
241 pod->have_more = (ret > 0);
243 btr_add_output(buf, have, btrn);
246 if (ret == OV_HOLE) /* avoid buffer underruns */
248 if (ret >= 0 || ret == OV_HOLE)
250 ret = -E_OGGDEC_BADLINK;
254 btr_remove_node(btrn);
258 * The init function of the ogg vorbis decoder.
260 * \param f Its fields are filled in by the function.
262 void oggdec_filter_init(struct filter *f)
265 f->close = ogg_close;
266 f->pre_select = ogg_pre_select;
267 f->post_select = ogg_post_select;
268 f->execute = oggdec_execute;