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, len;
 206         int ret;
 207         char *in;
 208
 209         t->error = 0;
 210         ret = prepare_filter_node(fn);
 211         if (ret < 0)
 212                 goto err;
 213         if (ret == 0)
 214                 return;
 215         len = btr_next_buffer(btrn, &in);
 216         iqs = btr_get_input_queue_size(btrn);
 217         if (!pod->vf) {
 218                 int oret;
 219
 220                 pod->vf = para_malloc(sizeof(struct OggVorbis_File));
 221                 PARA_NOTICE_LOG("input queue: %zu, opening ov callbacks\n", iqs);
 222                 oret = ov_open_callbacks(fn, pod->vf,
 223                         NULL, /* no initial buffer */
 224                         0, /* no initial bytes */
 225                         ovc); /* the ov_open_callbacks */
 226                 if (oret == OV_ENOTVORBIS || oret == OV_EBADHEADER) {
 227                         /* this might be due to the input buffer being too small */
 228                         if (!btr_no_parent(btrn)) {
 229                                 free(pod->vf);
 230                                 pod->vf = NULL;
 231                                 fn->min_iqs = iqs + 1;
 232                                 return;
 233                         }
 234                         ret = (oret == OV_ENOTVORBIS)?
 235                                 -E_OGGDEC_NOTVORBIS : -E_OGGDEC_BADHEADER;
 236                         goto err;
 237                 }
 238                 ret = -E_OGGDEC_READ;
 239                 if (oret == OV_EREAD)
 240                         goto err;
 241                 ret = -E_OGGDEC_VERSION;
 242                 if (oret == OV_EVERSION)
 243                         goto err;
 244                 ret = -E_OGGDEC_FAULT;
 245                 if (oret < 0)
 246                         goto err;
 247                 pod->channels = ov_info(pod->vf, 0)->channels;
 248                 pod->samplerate = ov_info(pod->vf, 0)->rate;
 249                 PARA_NOTICE_LOG("%d channels, %d Hz\n", pod->channels,
 250                         pod->samplerate);
 251                 ///* wait a bit to avoid buffer underruns */
 252                 //tv_add(now, &(struct timeval){0, 500 * 1000}, &pod->stream_start);
 253                 return;
 254         }
 255         for (;;) {
 256                 char *out = para_malloc(OGGDEC_OUTPUT_CHUNK_SIZE);
 257                 ssize_t read_ret = ov_read(pod->vf, out, OGGDEC_OUTPUT_CHUNK_SIZE,
 258                         ENDIAN, 2 /* 16 bit */, 1 /* signed */, NULL);
 259                 if (read_ret <= 0)
 260                         free(out);
 261                 if (read_ret == 0) {
 262                         ret = -E_OGGDEC_EOF;
 263                         if (btr_no_parent(btrn))
 264                                 goto err;
 265                         return;
 266                 }
 267                 if (read_ret == OV_HOLE)
 268                         return;
 269                 if (read_ret < 0) {
 270                         ret = -E_OGGDEC_BADLINK;
 271                         goto err;
 272                 }
 273                 btr_add_output(out, read_ret, btrn);
 274         }
 275
 276 err:
 277         assert(ret < 0);
 278         ogg_close(fn);
 279         t->error = ret;
 280         btr_del_node(btrn);
 281 }
 282
 283 static ssize_t ogg_convert(char *inbuffer, size_t len, struct filter_node *fn)
 284 {
 285         ssize_t ret;
 286         struct private_oggdec_data *pod = fn->private_data;
 287         struct oggdec_filter_args_info *conf = fn->conf;
 288         /* make the buffer known to the read callback cb_read() */
 289         pod->inbuf = inbuffer;
 290         pod->inbuf_len = len;
 291         pod->converted = 0;
 292
 293         if (!pod->vf) {
 294                 if (*fn->fc->input_error < 0)
 295                         return *fn->fc->input_error;
 296                 if (!len)
 297                         return 0;
 298                 pod->vf = para_malloc(sizeof(struct OggVorbis_File));
 299                 PARA_NOTICE_LOG("input buffer: %zd, opening ov callbacks\n", len);
 300                 ret = ov_open_callbacks(fn, pod->vf,
 301                         NULL, /* no initial buffer */
 302                         0, /* no initial bytes */
 303                         ovc); /* the ov_open_callbacks */
 304                 if (ret == OV_ENOTVORBIS || ret == OV_EBADHEADER) {
 305                         /* this might be due to the input buffer being too small */
 306                         int ib = 1024 * conf->initial_buffer_arg; /* initial buffer */
 307                         if (len < ib) {
 308                                 PARA_INFO_LOG("initial input buffer %zd/%d, "
 309                                         "waiting for more data\n", len, ib);
 310                                 free(pod->vf);
 311                                 pod->vf = NULL;
 312                                 return 0;
 313                         }
 314                         return ret == OV_ENOTVORBIS?
 315                                 -E_OGGDEC_NOTVORBIS : -E_OGGDEC_BADHEADER;
 316                 }
 317                 if (ret == OV_EREAD)
 318                         return -E_OGGDEC_READ;
 319                 if (ret == OV_EVERSION)
 320                         return -E_OGGDEC_VERSION;
 321                 if (ret < 0)
 322                         return -E_OGGDEC_FAULT;
 323                 fn->fc->channels = ov_info(pod->vf, 0)->channels;
 324                 fn->fc->samplerate = ov_info(pod->vf, 0)->rate;
 325                 PARA_NOTICE_LOG("%d channels, %d Hz\n", fn->fc->channels,
 326                         fn->fc->samplerate);
 327                 /* wait a bit to avoid buffer underruns */
 328                 tv_add(now, &(struct timeval){0, 500 * 1000}, &pod->stream_start);
 329                 return pod->converted;
 330         }
 331         if (tv_diff(now, &pod->stream_start, NULL) < 0) {
 332                 PARA_DEBUG_LOG("initial delay..\n");
 333                 return 0;
 334         }
 335         while (fn->loaded < fn->bufsize) {
 336                 int length = fn->bufsize - fn->loaded;
 337                 long read_ret = ov_read(pod->vf, fn->buf + fn->loaded, length,
 338                         ENDIAN, 2 /* 16 bit */, 1 /* signed */, NULL);
 339                 if (read_ret == 0)
 340                         return pod->converted;
 341                 if (read_ret == OV_HOLE) {
 342                         if (!fn->loaded) {
 343                                 PARA_INFO_LOG("hole, delaying playback\n");
 344                                 tv_add(now, &(struct timeval){0, 500 * 1000}, &pod->stream_start);
 345                         }
 346                         return pod->converted;
 347                 }
 348                 if (read_ret < 0)
 349                         return -E_OGGDEC_BADLINK;
 350                 fn->loaded += read_ret;
 351         }
 352         return pod->converted;
 353 }
 354
 355 static int oggdec_parse_config(int argc, char **argv, void **config)
 356 {
 357         int ret;
 358         struct oggdec_filter_args_info *ogg_conf;
 359
 360         ogg_conf = para_calloc(sizeof(*ogg_conf));
 361         ret = -E_OGGDEC_SYNTAX;
 362         if (oggdec_cmdline_parser(argc, argv, ogg_conf))
 363                 goto err;
 364         ret = -ERRNO_TO_PARA_ERROR(EINVAL);
 365         if (ogg_conf->bufsize_arg < 0)
 366                 goto err;
 367         if (ogg_conf->bufsize_arg >= INT_MAX / 1024)
 368                 goto err;
 369         if (ogg_conf->initial_buffer_arg < 0)
 370                 goto err;
 371         if (ogg_conf->initial_buffer_arg >= INT_MAX / 1024)
 372                 goto err;
 373         *config = ogg_conf;
 374         return 1;
 375 err:
 376         free(ogg_conf);
 377         return ret;
 378 }
 379
 380 /**
 381  * The init function of the ogg vorbis decoder.
 382  *
 383  * \param f Its fields are filled in by the function.
 384  */
 385 void oggdec_filter_init(struct filter *f)
 386 {
 387         struct oggdec_filter_args_info dummy;
 388
 389         oggdec_cmdline_parser_init(&dummy);
 390         f->open = ogg_open;
 391         f->close = ogg_close;
 392         f->convert = ogg_convert;
 393         f->pre_select = ogg_pre_select;
 394         f->post_select = ogg_post_select;
 395         f->parse_config = oggdec_parse_config;
 396         f->execute = oggdec_execute;
 397         f->help = (struct ggo_help) {
 398                 .short_help = oggdec_filter_args_info_help,
 399                 .detailed_help = oggdec_filter_args_info_detailed_help
 400         };
 401 }