/*
- * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2008 Andre Noll <maan@systemlinux.org>
*
* Licensed under the GPL v2. For licencing details see COPYING.
*/
-/** \file oggdec.c paraslash's ogg vorbis decoder */
+/** \file oggdec.c Paraslash's ogg vorbis decoder. */
#include "para.h"
#include <vorbis/vorbisfile.h>
-/** \cond some internal constants */
-#define BITS 16
+/** Determine byte sex. */
#ifdef WORDS_BIGENDIAN
#define ENDIAN 1
#else
#define ENDIAN 0
#endif
-#define SIGN 1
-/** \endcond */
-/** data specific to the oggdec filter */
+/** Data specific to the oggdec filter. */
struct private_oggdec_data {
- /** describes an ogg vorbis file */
+ /** Describes an ogg vorbis file. */
OggVorbis_File *vf;
- /** the input buffer */
+ /** The input buffer. */
char *inbuf;
- /** the length of \a inbuf */
+ /** The length of \a inbuf. */
size_t inbuf_len;
- /** the number of bytes consumed from the input buffer */
+ /** The number of bytes consumed from the input buffer. */
size_t converted;
};
// PARA_DEBUG_LOG("pod = %p\n", pod);
// PARA_DEBUG_LOG("vorbis requests %d bytes, have %d\n", size * nmemb, have);
if (pod->inbuf_len < size) {
- if (*fn->fc->input_eof)
+ if (*fn->fc->input_error)
return 0;
errno = EAGAIN;
return (size_t)-1;
}
/*
- * cb_seek -- custom data seeking function
+ * Custom data seeking function.
+ *
* Since we want the data source to be treated as unseekable at all
* times, the provided seek callback always returns -1 (failure).
*/
.seek_func = cb_seek,
.close_func = cb_close,
/*
- * The tell function need not be provided if
- * the data IO abstraction is not seekable
+ * The tell function need not be provided if the data IO abstraction is
+ * not seekable
*/
.tell_func = NULL
};
if (!pod->vf) {
int ib = 1024 * conf->initial_buffer_arg; /* initial buffer */
- if (len <ib && !*fn->fc->input_eof) {
+ if (len <ib && !*fn->fc->input_error) {
PARA_DEBUG_LOG("initial input buffer %zd/%d, "
"waiting for more data\n", len, ib);
return 0;
PARA_NOTICE_LOG("%d channels, %d Hz\n", fn->fc->channels,
fn->fc->samplerate);
}
- while (!*fn->fc->input_eof && fn->loaded < fn->bufsize) {
+ while (!*fn->fc->input_error && fn->loaded < fn->bufsize) {
int length = fn->bufsize - fn->loaded;
long read_ret = ov_read(pod->vf, fn->buf + fn->loaded, length,
- ENDIAN, BITS / 8, SIGN, NULL);
+ ENDIAN, 2 /* 16 bit */, 1 /* signed */, NULL);
if (read_ret == OV_HOLE || !read_ret)
return pod->converted;
if (read_ret < 0)
return NULL;
}
-/** the init function of the ogg vorbis decoder */
+/**
+ * The init function of the ogg vorbis decoder.
+ *
+ * \param f Its fields are filled in by the function.
+ */
void oggdec_init(struct filter *f)
{
f->open = ogg_open;