oggdec_filter.c

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