oggdec_filter.c

   1 /*
   2  * Copyright (C) 2005-2012 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
  12 #include "para.h"
  13 #include "list.h"
  14 #include "sched.h"
  15 #include "ggo.h"
  16 #include "buffer_tree.h"
  17 #include "filter.h"
  18 #include "error.h"
  19 #include "string.h"
  20
  21 /** Determine byte sex. */
  22 #ifdef WORDS_BIGENDIAN
  23 #define ENDIAN 1
  24 #else
  25 #define ENDIAN 0
  26 #endif
  27
  28 /** Data specific to the oggdec filter. */
  29 struct private_oggdec_data {
  30         /** Describes an ogg vorbis file. */
  31         OggVorbis_File *vf;
  32         /** The number of bytes consumed from the input buffer. */
  33         size_t converted;
  34         /** The number of channels of the current stream. */
  35         unsigned int channels;
  36         /** Current sample rate in Hz. */
  37         unsigned int sample_rate;
  38         /** Whether everything was decoded during the previous iteration. */
  39         bool have_more;
  40 };
  41
  42 static size_t cb_read(void *buf, size_t size, size_t nmemb, void *datasource)
  43 {
  44         struct filter_node *fn = datasource;
  45         struct private_oggdec_data *pod = fn->private_data;
  46         struct btr_node *btrn = fn->btrn;
  47         char *btr_buf;
  48         size_t nbytes = btr_next_buffer(btrn, &btr_buf), tmp;
  49
  50         /**
  51          * oggvorbis always uses size == 1. Other sizes would complicate the code
  52          * for no real gain. So we simply don't support size != 1.
  53          */
  54         assert(size == 1);
  55         assert(pod->converted <= nbytes);
  56         tmp = nbytes - pod->converted;
  57         PARA_DEBUG_LOG("vorbis requests %zu bytes have %zu\n", nmemb, tmp);
  58         tmp = PARA_MIN(tmp, nmemb);
  59         if (tmp == 0)
  60                 return 0;
  61         memcpy(buf, btr_buf + pod->converted, tmp);
  62         pod->converted += tmp;
  63         return tmp;
  64 }
  65
  66 /*
  67  * Custom data seeking function.
  68  *
  69  * Since we want the data source to be treated as unseekable at all
  70  * times, the provided seek callback always returns -1 (failure).
  71  */
  72 static int cb_seek(__a_unused void *datasource, __a_unused ogg_int64_t offset,
  73                 __a_unused int whence)
  74 {
  75         return -1;
  76 }
  77
  78 static int cb_close(__a_unused void *datasource)
  79 {
  80         return 0;
  81 }
  82
  83 static const ov_callbacks ovc = {
  84         .read_func = cb_read,
  85         .seek_func = cb_seek,
  86         .close_func = cb_close,
  87         /*
  88          * The tell function need not be provided if the data IO abstraction is
  89          * not seekable
  90          */
  91         .tell_func = NULL
  92 };
  93
  94 static void ogg_open(struct filter_node *fn)
  95 {
  96         fn->private_data = para_calloc(sizeof(struct private_oggdec_data));
  97         fn->min_iqs = 8000;
  98 }
  99
 100 static void ogg_close(struct filter_node *fn)
 101 {
 102         struct private_oggdec_data *pod = fn->private_data;
 103
 104         if (pod && pod->vf) {
 105                 PARA_DEBUG_LOG("ov_clearing %p, pod = %p\n", pod->vf, pod);
 106                 ov_clear(pod->vf);
 107                 free(pod->vf);
 108                 pod->vf = NULL;
 109         } else
 110                 PARA_DEBUG_LOG("nothing to close\n");
 111         free(pod);
 112         fn->private_data = NULL;
 113 }
 114
 115 static int oggdec_execute(struct btr_node *btrn, const char *cmd, char **result)
 116 {
 117         struct filter_node *fn = btr_context(btrn);
 118         struct private_oggdec_data *pod = fn->private_data;
 119
 120         return decoder_execute(cmd, pod->sample_rate, pod->channels, result);
 121 }
 122
 123 static int ogg_init(struct filter_node *fn)
 124 {
 125         struct private_oggdec_data *pod = fn->private_data;
 126         struct btr_node *btrn = fn->btrn;
 127         int ret, oret;
 128         size_t iqs;
 129         struct OggVorbis_File *vf = para_malloc(sizeof(*vf));
 130
 131         PARA_NOTICE_LOG("iqs: %zu, min_iqs: %zu, opening ov callbacks\n",
 132                 btr_get_input_queue_size(btrn), fn->min_iqs);
 133 open:
 134         oret = ov_open_callbacks(fn, vf,
 135                 NULL, /* no initial buffer */
 136                 0, /* no initial bytes */
 137                 ovc); /* the ov_open_callbacks */
 138         if (oret == OV_ENOTVORBIS || oret == OV_EBADHEADER) {
 139                 /* this might be due to the input buffer being too small */
 140                 if (!btr_no_parent(btrn)) {
 141                         fn->min_iqs += 1000;
 142                         iqs = btr_get_input_queue_size(btrn);
 143                         ret = 0;
 144                         if (iqs < fn->min_iqs)
 145                                 goto out;
 146                         PARA_CRIT_LOG("iqs: %zu\n", iqs);
 147                         btr_merge(btrn, fn->min_iqs);
 148                         pod->converted = 0;
 149                         goto open;
 150                 }
 151                 ret = (oret == OV_ENOTVORBIS)?
 152                         -E_OGGDEC_NOTVORBIS : -E_OGGDEC_BADHEADER;
 153                 goto out;
 154         }
 155         ret = -E_OGGDEC_READ;
 156         if (oret == OV_EREAD)
 157                 goto out;
 158         ret = -E_OGGDEC_VERSION;
 159         if (oret == OV_EVERSION)
 160                 goto out;
 161         ret = -E_OGGDEC_FAULT;
 162         if (oret < 0)
 163                 goto out;
 164         pod->channels = ov_info(vf, 0)->channels;
 165         pod->sample_rate = ov_info(vf, 0)->rate;
 166         PARA_NOTICE_LOG("%d channels, %d Hz\n", pod->channels,
 167                 pod->sample_rate);
 168         ret = 1;
 169 out:
 170         if (ret <= 0)
 171                 free(vf);
 172         else {
 173                 btr_consume(btrn, pod->converted);
 174                 pod->converted = 0;
 175                 fn->min_iqs = 0;
 176                 pod->vf = vf;
 177                 pod->have_more = true;
 178         }
 179         return ret;
 180 }
 181
 182 #define OGGDEC_MAX_OUTPUT_SIZE (96 * 1024)
 183 #define OGGDEC_OUTPUT_CHUNK_SIZE (32 * 1024)
 184
 185 static void ogg_pre_select(struct sched *s, struct task *t)
 186 {
 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;
 190         int ret;
 191
 192         ret = btr_node_status(btrn, fn->min_iqs, BTR_NT_INTERNAL);
 193         if (ret != 0)
 194                 return sched_min_delay(s);
 195         if (!pod->have_more)
 196                 return;
 197         if (btr_get_output_queue_size(btrn) > OGGDEC_MAX_OUTPUT_SIZE)
 198                 return;
 199         sched_min_delay(s);
 200 }
 201
 202 static void ogg_post_select(__a_unused struct sched *s, struct task *t)
 203 {
 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;
 207         int ret, have;
 208         char *buf;
 209
 210         ret = btr_node_status(btrn, fn->min_iqs, BTR_NT_INTERNAL);
 211         if (ret < 0) {
 212                 if (ret != -E_BTR_EOF) /* fatal error */
 213                         goto out;
 214                 if (fn->min_iqs == 0 && !pod->have_more) /* EOF */
 215                         goto out;
 216                 /* last ov_read() returned OV_HOLE */
 217         } else if (ret == 0 && !pod->have_more) /* nothing to do */
 218                 goto out;
 219         if (btr_get_output_queue_size(btrn) > OGGDEC_MAX_OUTPUT_SIZE)
 220                 return;
 221         if (!pod->vf) {
 222                 if (ret <= 0)
 223                         goto out;
 224                 btr_merge(btrn, fn->min_iqs);
 225                 ret = ogg_init(fn);
 226                 goto out;
 227         }
 228         have = 0;
 229         buf = para_malloc(OGGDEC_OUTPUT_CHUNK_SIZE);
 230         for (;;) {
 231                 ret = ov_read(pod->vf, buf + have, OGGDEC_OUTPUT_CHUNK_SIZE - have,
 232                         ENDIAN, 2 /* 16 bit */, 1 /* signed */, NULL);
 233                 btr_consume(btrn, pod->converted);
 234                 pod->converted = 0;
 235                 if (ret <= 0)
 236                         break;
 237                 fn->min_iqs = 0;
 238                 have += ret;
 239                 if (have < OGGDEC_OUTPUT_CHUNK_SIZE)
 240                         continue;
 241                 if (btr_get_output_queue_size(btrn) > OGGDEC_MAX_OUTPUT_SIZE)
 242                         break;
 243                 btr_add_output(buf, have, btrn);
 244                 buf = para_malloc(OGGDEC_OUTPUT_CHUNK_SIZE);
 245                 have = 0;
 246         }
 247         pod->have_more = (ret > 0);
 248         if (have > 0) {
 249                 if (have < OGGDEC_OUTPUT_CHUNK_SIZE)
 250                         buf = para_realloc(buf, have);
 251                 btr_add_output(buf, have, btrn);
 252         } else
 253                 free(buf);
 254         if (ret == OV_HOLE) /* avoid buffer underruns */
 255                 fn->min_iqs = 9000;
 256         if (ret >= 0 || ret == OV_HOLE)
 257                 return;
 258         ret = -E_OGGDEC_BADLINK;
 259 out:
 260         t->error = ret;
 261         if (ret < 0)
 262                 btr_remove_node(btrn);
 263 }
 264
 265 /**
 266  * The init function of the ogg vorbis decoder.
 267  *
 268  * \param f Its fields are filled in by the function.
 269  */
 270 void oggdec_filter_init(struct filter *f)
 271 {
 272         f->open = ogg_open;
 273         f->close = ogg_close;
 274         f->pre_select = ogg_pre_select;
 275         f->post_select = ogg_post_select;
 276         f->execute = oggdec_execute;
 277 }