[btr] Add the node type parameter to btr_node_status().
[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_OUTPUT_CHUNK_SIZE (64 * 1024)
163
164 static int oggdec_execute(struct btr_node *btrn, const char *cmd, char **result)
165 {
166 struct filter_node *fn = btr_context(btrn);
167 struct private_oggdec_data *pod = fn->private_data;
168
169 if (!strcmp(cmd, "samplerate")) {
170 if (pod->samplerate == 0)
171 return -ERRNO_TO_PARA_ERROR(ENAVAIL);
172 *result = make_message("%u", pod->samplerate);
173 return 1;
174 }
175 if (!strcmp(cmd, "channels")) {
176 if (pod->channels == 0)
177 return -ERRNO_TO_PARA_ERROR(ENAVAIL);
178 *result = make_message("%u", pod->channels);
179 return 1;
180 }
181 return -ERRNO_TO_PARA_ERROR(ENOTSUP);
182 }
183
184 static void ogg_post_select(__a_unused struct sched *s, struct task *t)
185 {
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;
189 size_t iqs, len;
190 int ret;
191 char *in;
192
193 t->error = 0;
194 ret = btr_node_status(btrn, fn->min_iqs, BTR_NT_INTERNAL);
195 if (ret < 0)
196 goto err;
197 if (ret == 0)
198 return;
199 btr_merge(btrn, fn->min_iqs);
200 len = btr_next_buffer(btrn, &in);
201 iqs = btr_get_input_queue_size(btrn);
202 if (!pod->vf) {
203 int oret;
204
205 pod->vf = para_malloc(sizeof(struct OggVorbis_File));
206 PARA_NOTICE_LOG("input queue: %zu, opening ov callbacks\n", iqs);
207 oret = ov_open_callbacks(fn, pod->vf,
208 NULL, /* no initial buffer */
209 0, /* no initial bytes */
210 ovc); /* the ov_open_callbacks */
211 if (oret == OV_ENOTVORBIS || oret == OV_EBADHEADER) {
212 /* this might be due to the input buffer being too small */
213 if (!btr_no_parent(btrn)) {
214 free(pod->vf);
215 pod->vf = NULL;
216 fn->min_iqs = iqs + 1;
217 return;
218 }
219 ret = (oret == OV_ENOTVORBIS)?
220 -E_OGGDEC_NOTVORBIS : -E_OGGDEC_BADHEADER;
221 goto err;
222 }
223 ret = -E_OGGDEC_READ;
224 if (oret == OV_EREAD)
225 goto err;
226 ret = -E_OGGDEC_VERSION;
227 if (oret == OV_EVERSION)
228 goto err;
229 ret = -E_OGGDEC_FAULT;
230 if (oret < 0)
231 goto err;
232 pod->channels = ov_info(pod->vf, 0)->channels;
233 pod->samplerate = ov_info(pod->vf, 0)->rate;
234 PARA_NOTICE_LOG("%d channels, %d Hz\n", pod->channels,
235 pod->samplerate);
236 ///* wait a bit to avoid buffer underruns */
237 //tv_add(now, &(struct timeval){0, 500 * 1000}, &pod->stream_start);
238 return;
239 }
240 for (;;) {
241 char *out = para_malloc(OGGDEC_OUTPUT_CHUNK_SIZE);
242 ssize_t read_ret = ov_read(pod->vf, out, OGGDEC_OUTPUT_CHUNK_SIZE,
243 ENDIAN, 2 /* 16 bit */, 1 /* signed */, NULL);
244 if (read_ret <= 0)
245 free(out);
246 if (read_ret == 0) {
247 ret = -E_OGGDEC_EOF;
248 if (btr_no_parent(btrn))
249 goto err;
250 return;
251 }
252 if (read_ret == OV_HOLE)
253 return;
254 if (read_ret < 0) {
255 ret = -E_OGGDEC_BADLINK;
256 goto err;
257 }
258 btr_add_output(out, read_ret, btrn);
259 }
260
261 err:
262 assert(ret < 0);
263 t->error = ret;
264 btr_remove_node(btrn);
265 }
266
267 static ssize_t ogg_convert(char *inbuffer, size_t len, struct filter_node *fn)
268 {
269 ssize_t ret;
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;
275 pod->converted = 0;
276
277 if (!pod->vf) {
278 if (*fn->fc->input_error < 0)
279 return *fn->fc->input_error;
280 if (!len)
281 return 0;
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 */
291 if (len < ib) {
292 PARA_INFO_LOG("initial input buffer %zd/%d, "
293 "waiting for more data\n", len, ib);
294 free(pod->vf);
295 pod->vf = NULL;
296 return 0;
297 }
298 return ret == OV_ENOTVORBIS?
299 -E_OGGDEC_NOTVORBIS : -E_OGGDEC_BADHEADER;
300 }
301 if (ret == OV_EREAD)
302 return -E_OGGDEC_READ;
303 if (ret == OV_EVERSION)
304 return -E_OGGDEC_VERSION;
305 if (ret < 0)
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,
310 fn->fc->samplerate);
311 /* wait a bit to avoid buffer underruns */
312 tv_add(now, &(struct timeval){0, 500 * 1000}, &pod->stream_start);
313 return pod->converted;
314 }
315 if (tv_diff(now, &pod->stream_start, NULL) < 0) {
316 PARA_DEBUG_LOG("initial delay..\n");
317 return 0;
318 }
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);
323 if (read_ret == 0)
324 return pod->converted;
325 if (read_ret == OV_HOLE) {
326 if (!fn->loaded) {
327 PARA_INFO_LOG("hole, delaying playback\n");
328 tv_add(now, &(struct timeval){0, 500 * 1000}, &pod->stream_start);
329 }
330 return pod->converted;
331 }
332 if (read_ret < 0)
333 return -E_OGGDEC_BADLINK;
334 fn->loaded += read_ret;
335 }
336 return pod->converted;
337 }
338
339 static int oggdec_parse_config(int argc, char **argv, void **config)
340 {
341 int ret;
342 struct oggdec_filter_args_info *ogg_conf;
343
344 ogg_conf = para_calloc(sizeof(*ogg_conf));
345 ret = -E_OGGDEC_SYNTAX;
346 if (oggdec_cmdline_parser(argc, argv, ogg_conf))
347 goto err;
348 ret = -ERRNO_TO_PARA_ERROR(EINVAL);
349 if (ogg_conf->bufsize_arg < 0)
350 goto err;
351 if (ogg_conf->bufsize_arg >= INT_MAX / 1024)
352 goto err;
353 if (ogg_conf->initial_buffer_arg < 0)
354 goto err;
355 if (ogg_conf->initial_buffer_arg >= INT_MAX / 1024)
356 goto err;
357 *config = ogg_conf;
358 return 1;
359 err:
360 free(ogg_conf);
361 return ret;
362 }
363
364 /**
365 * The init function of the ogg vorbis decoder.
366 *
367 * \param f Its fields are filled in by the function.
368 */
369 void oggdec_filter_init(struct filter *f)
370 {
371 struct oggdec_filter_args_info dummy;
372
373 oggdec_cmdline_parser_init(&dummy);
374 f->open = ogg_open;
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
384 };
385 }