fc03077bf4fc65505affd7db301f0b3dae4fd67c
[paraslash.git] / oggdec_filter.c
1 /*
2 * Copyright (C) 2005-2009 Andre Noll <maan@systemlinux.org>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6
7 /** \file oggdec_filter.c Paraslash's ogg vorbis decoder. */
8
9 #include <regex.h>
10 #include <vorbis/vorbisfile.h>
11 #include <stdbool.h>
12
13 #include "para.h"
14 #include "oggdec_filter.cmdline.h"
15 #include "list.h"
16 #include "sched.h"
17 #include "ggo.h"
18 #include "buffer_tree.h"
19 #include "filter.h"
20 #include "error.h"
21 #include "string.h"
22
23 /** Determine byte sex. */
24 #ifdef WORDS_BIGENDIAN
25 #define ENDIAN 1
26 #else
27 #define ENDIAN 0
28 #endif
29
30 /** Data specific to the oggdec filter. */
31 struct private_oggdec_data {
32 /** Describes an ogg vorbis file. */
33 OggVorbis_File *vf;
34 /** The input buffer. */
35 char *inbuf;
36 /** The length of \a inbuf. */
37 size_t inbuf_len;
38 /** The number of bytes consumed from the input buffer. */
39 size_t converted;
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;
46 };
47
48 static size_t cb_read_nobtr(void *buf, size_t size, size_t nmemb, void *datasource)
49 {
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;
54
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)
59 return 0;
60 errno = EAGAIN;
61 return (size_t)-1;
62 }
63 ret = PARA_MIN(nmemb, have / size) * size;
64 memcpy(buf, p, ret);
65 pod->converted += ret;
66 return ret;
67 }
68
69 static size_t cb_read_btr(void *buf, size_t size, size_t nmemb, void *datasource)
70 {
71 struct filter_node *fn = datasource;
72 struct btr_node *btrn = fn->btrn;
73 size_t copied;
74
75 /**
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.
78 */
79 assert(size == 1);
80 //PARA_DEBUG_LOG("vorbis requests %zu x %zu = %zu bytes\n", size, nmemb, size * nmemb);
81 copied = 0;
82 for (;;) {
83 char *btr_buf;
84 size_t nbytes = btr_next_buffer(btrn, &btr_buf);
85 if (nbytes == 0)
86 break;
87 nbytes = PARA_MIN(nmemb - copied, nbytes);
88 memcpy(buf + copied, btr_buf, nbytes);
89 copied += nbytes;
90 btr_consume(btrn, nbytes);
91 if (copied == nmemb)
92 break;
93 }
94 return copied;
95 }
96
97 static size_t cb_read(void *buf, size_t size, size_t nmemb, void *datasource)
98 {
99 struct filter_node *fn = datasource;
100
101 if (fn->btrn)
102 return cb_read_btr(buf, size, nmemb, datasource);
103 else
104 return cb_read_nobtr(buf, size, nmemb, datasource);
105 }
106
107 /*
108 * Custom data seeking function.
109 *
110 * Since we want the data source to be treated as unseekable at all
111 * times, the provided seek callback always returns -1 (failure).
112 */
113 static int cb_seek(__a_unused void *datasource, __a_unused ogg_int64_t offset,
114 __a_unused int whence)
115 {
116 return -1;
117 }
118
119 static int cb_close(__a_unused void *datasource)
120 {
121 return 0;
122 }
123
124 static const ov_callbacks ovc = {
125 .read_func = cb_read,
126 .seek_func = cb_seek,
127 .close_func = cb_close,
128 /*
129 * The tell function need not be provided if the data IO abstraction is
130 * not seekable
131 */
132 .tell_func = NULL
133 };
134
135 static void ogg_open(struct filter_node *fn)
136 {
137 struct private_oggdec_data *pod = para_calloc(
138 sizeof(struct private_oggdec_data));
139 struct oggdec_filter_args_info *conf = fn->conf;
140
141 fn->private_data = pod;
142 fn->bufsize = conf->bufsize_arg * 1024;
143 fn->buf = para_malloc(fn->bufsize);
144 }
145
146 static void ogg_close(struct filter_node *fn)
147 {
148 struct private_oggdec_data *pod = fn->private_data;
149 if (pod->vf) {
150 PARA_DEBUG_LOG("ov_clearing %p, pod = %p\n", pod->vf, pod);
151 ov_clear(pod->vf);
152 free(pod->vf);
153 pod->vf = NULL;
154 } else
155 PARA_DEBUG_LOG("nothing to close in fc %p, pod = %p\n", pod->vf, pod);
156 free(fn->buf);
157 fn->buf = NULL;
158 free(fn->private_data);
159 fn->private_data = NULL;
160 }
161
162 #define OGGDEC_MAX_PENDING (640 * 1024)
163 #define OGGDEC_OUTPUT_CHUNK_SIZE (64 * 1024)
164
165
166 static int oggdec_execute(struct btr_node *btrn, const char *cmd, char **result)
167 {
168 struct filter_node *fn = btr_context(btrn);
169 struct private_oggdec_data *pod = fn->private_data;
170
171 if (!strcmp(cmd, "samplerate")) {
172 if (pod->samplerate == 0)
173 return -ERRNO_TO_PARA_ERROR(ENAVAIL);
174 *result = make_message("%u", pod->samplerate);
175 return 1;
176 }
177 if (!strcmp(cmd, "channels")) {
178 if (pod->channels == 0)
179 return -ERRNO_TO_PARA_ERROR(ENAVAIL);
180 *result = make_message("%u", pod->channels);
181 return 1;
182 }
183 return -ERRNO_TO_PARA_ERROR(ENOTSUP);
184 }
185
186 static void ogg_pre_select(struct sched *s, struct task *t)
187 {
188 struct filter_node *fn = container_of(t, struct filter_node, task);
189 size_t iqs = btr_get_input_queue_size(fn->btrn);
190
191 t->error = 0;
192 if (iqs == 0)
193 return;
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;
198 }
199
200 static void ogg_post_select(__a_unused struct sched *s, struct task *t)
201 {
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;
205 size_t iqs = btr_get_input_queue_size(btrn);
206 int ret;
207
208 t->error = 0;
209 if (!pod->vf && iqs) {
210 struct oggdec_filter_args_info *conf = fn->conf;
211 int oret;
212
213 pod->vf = para_malloc(sizeof(struct OggVorbis_File));
214 PARA_NOTICE_LOG("input queue: %zu, opening ov callbacks\n", iqs);
215 oret = ov_open_callbacks(fn, pod->vf,
216 NULL, /* no initial buffer */
217 0, /* no initial bytes */
218 ovc); /* the ov_open_callbacks */
219 if (oret == OV_ENOTVORBIS || oret == OV_EBADHEADER) {
220 /* this might be due to the input buffer being too small */
221 int ib = 1024 * conf->initial_buffer_arg; /* initial buffer */
222 if (iqs < ib) {
223 free(pod->vf);
224 pod->vf = NULL;
225 return;
226 }
227 ret = (oret == OV_ENOTVORBIS)?
228 -E_OGGDEC_NOTVORBIS : -E_OGGDEC_BADHEADER;
229 goto err;
230 }
231 ret = -E_OGGDEC_READ;
232 if (oret == OV_EREAD)
233 goto err;
234 ret = -E_OGGDEC_VERSION;
235 if (oret == OV_EVERSION)
236 goto err;
237 ret = -E_OGGDEC_FAULT;
238 if (oret < 0)
239 goto err;
240 pod->channels = ov_info(pod->vf, 0)->channels;
241 pod->samplerate = ov_info(pod->vf, 0)->rate;
242 PARA_NOTICE_LOG("%d channels, %d Hz\n", pod->channels,
243 pod->samplerate);
244 ///* wait a bit to avoid buffer underruns */
245 //tv_add(now, &(struct timeval){0, 500 * 1000}, &pod->stream_start);
246 return;
247 }
248 for (;;) {
249 char *out = para_malloc(OGGDEC_OUTPUT_CHUNK_SIZE);
250 ssize_t read_ret = ov_read(pod->vf, out, OGGDEC_OUTPUT_CHUNK_SIZE,
251 ENDIAN, 2 /* 16 bit */, 1 /* signed */, NULL);
252 if (read_ret <= 0)
253 free(out);
254 if (read_ret == 0) {
255 ret = -E_OGGDEC_EOF;
256 if (btr_no_parent(btrn))
257 goto err;
258 return;
259 }
260 if (read_ret == OV_HOLE)
261 return;
262 if (read_ret < 0) {
263 ret = -E_OGGDEC_BADLINK;
264 goto err;
265 }
266 btr_add_output(out, read_ret, btrn);
267 }
268
269 err:
270 assert(ret < 0);
271 ogg_close(fn);
272 t->error = ret;
273 btr_del_node(btrn);
274 }
275
276 static ssize_t ogg_convert(char *inbuffer, size_t len, struct filter_node *fn)
277 {
278 ssize_t ret;
279 struct private_oggdec_data *pod = fn->private_data;
280 struct oggdec_filter_args_info *conf = fn->conf;
281 /* make the buffer known to the read callback cb_read() */
282 pod->inbuf = inbuffer;
283 pod->inbuf_len = len;
284 pod->converted = 0;
285
286 if (!pod->vf) {
287 if (*fn->fc->input_error < 0)
288 return *fn->fc->input_error;
289 if (!len)
290 return 0;
291 pod->vf = para_malloc(sizeof(struct OggVorbis_File));
292 PARA_NOTICE_LOG("input buffer: %zd, opening ov callbacks\n", len);
293 ret = ov_open_callbacks(fn, pod->vf,
294 NULL, /* no initial buffer */
295 0, /* no initial bytes */
296 ovc); /* the ov_open_callbacks */
297 if (ret == OV_ENOTVORBIS || ret == OV_EBADHEADER) {
298 /* this might be due to the input buffer being too small */
299 int ib = 1024 * conf->initial_buffer_arg; /* initial buffer */
300 if (len < ib) {
301 PARA_INFO_LOG("initial input buffer %zd/%d, "
302 "waiting for more data\n", len, ib);
303 free(pod->vf);
304 pod->vf = NULL;
305 return 0;
306 }
307 return ret == OV_ENOTVORBIS?
308 -E_OGGDEC_NOTVORBIS : -E_OGGDEC_BADHEADER;
309 }
310 if (ret == OV_EREAD)
311 return -E_OGGDEC_READ;
312 if (ret == OV_EVERSION)
313 return -E_OGGDEC_VERSION;
314 if (ret < 0)
315 return -E_OGGDEC_FAULT;
316 fn->fc->channels = ov_info(pod->vf, 0)->channels;
317 fn->fc->samplerate = ov_info(pod->vf, 0)->rate;
318 PARA_NOTICE_LOG("%d channels, %d Hz\n", fn->fc->channels,
319 fn->fc->samplerate);
320 /* wait a bit to avoid buffer underruns */
321 tv_add(now, &(struct timeval){0, 500 * 1000}, &pod->stream_start);
322 return pod->converted;
323 }
324 if (tv_diff(now, &pod->stream_start, NULL) < 0) {
325 PARA_DEBUG_LOG("initial delay..\n");
326 return 0;
327 }
328 while (fn->loaded < fn->bufsize) {
329 int length = fn->bufsize - fn->loaded;
330 long read_ret = ov_read(pod->vf, fn->buf + fn->loaded, length,
331 ENDIAN, 2 /* 16 bit */, 1 /* signed */, NULL);
332 if (read_ret == 0)
333 return pod->converted;
334 if (read_ret == OV_HOLE) {
335 if (!fn->loaded) {
336 PARA_INFO_LOG("hole, delaying playback\n");
337 tv_add(now, &(struct timeval){0, 500 * 1000}, &pod->stream_start);
338 }
339 return pod->converted;
340 }
341 if (read_ret < 0)
342 return -E_OGGDEC_BADLINK;
343 fn->loaded += read_ret;
344 }
345 return pod->converted;
346 }
347
348 static int oggdec_parse_config(int argc, char **argv, void **config)
349 {
350 int ret;
351 struct oggdec_filter_args_info *ogg_conf;
352
353 ogg_conf = para_calloc(sizeof(*ogg_conf));
354 ret = -E_OGGDEC_SYNTAX;
355 if (oggdec_cmdline_parser(argc, argv, ogg_conf))
356 goto err;
357 ret = -ERRNO_TO_PARA_ERROR(EINVAL);
358 if (ogg_conf->bufsize_arg < 0)
359 goto err;
360 if (ogg_conf->bufsize_arg >= INT_MAX / 1024)
361 goto err;
362 if (ogg_conf->initial_buffer_arg < 0)
363 goto err;
364 if (ogg_conf->initial_buffer_arg >= INT_MAX / 1024)
365 goto err;
366 *config = ogg_conf;
367 return 1;
368 err:
369 free(ogg_conf);
370 return ret;
371 }
372
373 /**
374 * The init function of the ogg vorbis decoder.
375 *
376 * \param f Its fields are filled in by the function.
377 */
378 void oggdec_filter_init(struct filter *f)
379 {
380 struct oggdec_filter_args_info dummy;
381
382 oggdec_cmdline_parser_init(&dummy);
383 f->open = ogg_open;
384 f->close = ogg_close;
385 f->convert = ogg_convert;
386 f->pre_select = ogg_pre_select;
387 f->post_select = ogg_post_select;
388 f->parse_config = oggdec_parse_config;
389 f->execute = oggdec_execute;
390 f->help = (struct ggo_help) {
391 .short_help = oggdec_filter_args_info_help,
392 .detailed_help = oggdec_filter_args_info_detailed_help
393 };
394 }