#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;
};
while (!*fn->fc->input_eof && 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;