From: Paul Brossier <piem@piem.org>
Date: Fri, 3 Jan 2014 22:50:11 +0000 (-0400)
Subject: src/io/source_wavread.h: add native wav reader
X-Git-Tag: 0.4.1~98
X-Git-Url: https://git.aubio.org/?a=commitdiff_plain;h=5158c229289734eef3a32b17c32c535348e2472a;p=aubio.git

src/io/source_wavread.h: add native wav reader
---

diff --git a/src/aubio.h b/src/aubio.h
index a609bdeb..6a5c6ca2 100644
--- a/src/aubio.h
+++ b/src/aubio.h
@@ -193,6 +193,7 @@ extern "C"
 #include "io/source_sndfile.h"
 #include "io/source_apple_audio.h"
 #include "io/source_avcodec.h"
+#include "io/source_wavread.h"
 #include "io/sink_sndfile.h"
 #include "io/sink_apple_audio.h"
 #include "io/audio_unit.h"
diff --git a/src/io/source_wavread.c b/src/io/source_wavread.c
new file mode 100644
index 00000000..a54560b2
--- /dev/null
+++ b/src/io/source_wavread.c
@@ -0,0 +1,357 @@
+/*
+  Copyright (C) 2014 Paul Brossier <piem@aubio.org>
+
+  This file is part of aubio.
+
+  aubio is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  aubio is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with aubio.  If not, see <http://www.gnu.org/licenses/>.
+
+*/
+
+#include "config.h"
+
+#ifdef HAVE_WAVREAD
+
+#include "aubio_priv.h"
+#include "fvec.h"
+#include "fmat.h"
+#include "source_wavread.h"
+
+#include "errno.h"
+
+#define AUBIO_WAVREAD_BUFSIZE 1024
+
+#define SHORT_TO_FLOAT(x) (smpl_t)(x * 3.0517578125e-05)
+
+struct _aubio_source_wavread_t {
+  uint_t hop_size;
+  uint_t samplerate;
+  uint_t channels;
+
+  // some data about the file
+  char_t *path;
+  uint_t input_samplerate;
+  uint_t input_channels;
+
+  // internal stuff
+  FILE *fid;
+
+  uint_t read_samples;
+  uint_t blockalign;
+  uint_t bitspersample;
+  uint_t read_index;
+  uint_t eof;
+
+  unsigned char *short_output;
+  fmat_t *output;
+};
+
+unsigned int read_little_endian (unsigned char *buf, unsigned int length);
+unsigned int read_little_endian (unsigned char *buf, unsigned int length) {
+  uint_t i, ret = 0;
+  for (i = 0; i < length; i++) {
+    ret += buf[i] << (i * 8);
+  }
+  return ret;
+}
+
+aubio_source_wavread_t * new_aubio_source_wavread(char_t * path, uint_t samplerate, uint_t hop_size) {
+  aubio_source_wavread_t * s = AUBIO_NEW(aubio_source_wavread_t);
+  unsigned char buf[5];
+  unsigned int format, channels, sr, byterate, blockalign, bitspersample;//, data_size;
+
+  if (path == NULL) {
+    AUBIO_ERR("source_wavread: Aborted opening null path\n");
+    goto beach;
+  }
+  if ((sint_t)samplerate < 0) {
+    AUBIO_ERR("source_wavread: Can not open %s with samplerate %d\n", path, samplerate);
+    goto beach;
+  }
+  if ((sint_t)hop_size <= 0) {
+    AUBIO_ERR("source_wavread: Can not open %s with hop_size %d\n", path, hop_size);
+    goto beach;
+  }
+
+  s->path = path;
+  s->samplerate = samplerate;
+  s->hop_size = hop_size;
+
+  s->fid = fopen((const char *)path, "r");
+  if (!s->fid) {
+    AUBIO_ERR("source_wavread: could not open %s (%s)\n", s->path, strerror(errno));
+    goto beach;
+  }
+
+  // ChunkID
+  fread(buf, 4, 1, s->fid);
+  buf[4] = '\0';
+  if ( strcmp((const char *)buf, "RIFF") != 0 ) {
+    AUBIO_ERR("source_wavread: could not find RIFF header in %s\n", s->path);
+    goto beach;
+  }
+
+  // ChunkSize
+  fread(buf, 4, 1, s->fid);
+
+  // Format
+  fread(buf, 4, 1, s->fid);
+  buf[4] = '\0';
+  if ( strcmp((const char *)buf, "WAVE") != 0 ) {
+    AUBIO_ERR("source_wavread: wrong format in RIFF header in %s\n", s->path);
+    goto beach;
+  }
+
+  // Subchunk1ID
+  fread(buf, 4, 1, s->fid);
+  buf[4] = '\0';
+  if ( strcmp((const char *)buf, "fmt ") != 0 ) {
+    AUBIO_ERR("source_wavread: fmt RIFF header in %s\n", s->path);
+    goto beach;
+  }
+
+  // Subchunk1Size
+  fread(buf, 4, 1, s->fid);
+  format = read_little_endian(buf, 4);
+  if ( format != 16 ) {
+    // TODO accept format 18
+    AUBIO_ERR("source_wavread: file %s is not encoded with PCM\n", s->path);
+    goto beach;
+  }
+  if ( buf[1] || buf[2] | buf[3] ) {
+    AUBIO_ERR("source_wavread: Subchunk1Size should be 0, in %s\n", s->path);
+    goto beach;
+  }
+
+  // AudioFormat
+  fread(buf, 2, 1, s->fid);
+  if ( buf[0] != 1 || buf[1] != 0) {
+    AUBIO_ERR("source_wavread: AudioFormat should be PCM, in %s\n", s->path);
+    goto beach;
+  }
+
+  // NumChannels
+  fread(buf, 2, 1, s->fid);
+  channels = read_little_endian(buf, 2);
+
+  // SampleRate
+  fread(buf, 4, 1, s->fid);
+  sr = read_little_endian(buf, 4);
+
+  // ByteRate
+  fread(buf, 4, 1, s->fid);
+  byterate = read_little_endian(buf, 4);
+
+  // BlockAlign
+  fread(buf, 2, 1, s->fid);
+  blockalign = read_little_endian(buf, 2);
+
+  // BitsPerSample
+  fread(buf, 2, 1, s->fid);
+  bitspersample = read_little_endian(buf, 2);
+#if 0
+  if ( bitspersample != 16 ) {
+    AUBIO_ERR("source_wavread: can not process %dbit file %s\n",
+        bitspersample, s->path);
+    goto beach;
+  }
+#endif
+
+  if ( byterate * 8 != sr * channels * bitspersample ) {
+    AUBIO_ERR("source_wavread: wrong byterate in %s\n", s->path);
+    goto beach;
+  }
+
+  if ( blockalign * 8 != channels * bitspersample ) {
+    AUBIO_ERR("source_wavread: wrong blockalign in %s\n", s->path);
+    goto beach;
+  }
+
+  s->input_samplerate = sr;
+  s->input_channels = channels;
+
+#if 1
+  AUBIO_DBG("channels %d\n", channels);
+  AUBIO_DBG("sr %d\n", sr);
+  AUBIO_DBG("byterate %d\n", byterate);
+  AUBIO_DBG("blockalign %d\n", blockalign);
+  AUBIO_DBG("bitspersample %d\n", bitspersample);
+
+  AUBIO_DBG("found %d channels in %s\n", s->input_channels, s->path);
+  AUBIO_DBG("found %d samplerate in %s\n", s->input_samplerate, s->path);
+#endif
+
+  if (samplerate == 0) {
+    s->samplerate = s->input_samplerate;
+  } else if (samplerate != s->input_samplerate) {
+    AUBIO_ERR("source_wavread: can not resample %s from %d to %dHz\n",
+        s->path, s->input_samplerate, samplerate);
+    goto beach;
+  }
+
+  // Subchunk2ID
+  fread(buf, 4, 1, s->fid);
+  buf[4] = '\0';
+  if ( strcmp((const char *)buf, "data") != 0 ) {
+    AUBIO_ERR("source_wavread: data RIFF header not found in %s\n", s->path);
+    goto beach;
+  }
+
+  // Subchunk2Size
+  fread(buf, 4, 1, s->fid);
+  //data_size = buf[0] + (buf[1] << 8) + (buf[2] << 16) + (buf[3] << 24);
+  //AUBIO_MSG("found %d frames in %s\n", 8 * data_size / bitspersample / channels, s->path);
+
+  s->output = new_fmat(s->input_channels, AUBIO_WAVREAD_BUFSIZE);
+  s->blockalign= blockalign;
+  s->bitspersample = bitspersample;
+
+  s->short_output = (unsigned char *)calloc(s->blockalign, AUBIO_WAVREAD_BUFSIZE);
+  s->read_index = 0;
+  s->read_samples = 0;
+  s->eof = 0;
+
+  return s;
+
+beach:
+  AUBIO_ERR("source_wavread: can not read %s at samplerate %dHz with a hop_size of %d\n",
+      s->path, s->samplerate, s->hop_size);
+  del_aubio_source_wavread(s);
+  return NULL;
+}
+
+void aubio_source_wavread_readframe(aubio_source_wavread_t *s, uint_t *wavread_read);
+
+void aubio_source_wavread_readframe(aubio_source_wavread_t *s, uint_t *wavread_read) {
+  unsigned char *short_ptr = s->short_output;
+  size_t read = fread(short_ptr, s->blockalign, AUBIO_WAVREAD_BUFSIZE, s->fid);
+  uint_t i, j, b, bitspersample = s->bitspersample;
+  uint_t wrap_at = (1 << ( bitspersample - 1 ) );
+  uint_t wrap_with = (1 << bitspersample);
+  smpl_t scaler = 1. / wrap_at;
+  int signed_val = 0;
+  unsigned int unsigned_val = 0;
+
+  for (j = 0; j < read; j++) {
+    for (i = 0; i < s->input_channels; i++) {
+      unsigned_val = 0;
+      for (b = 0; b < bitspersample; b+=8 ) {
+        unsigned_val += *(short_ptr) << b;
+        short_ptr++;
+      }
+      signed_val = unsigned_val;
+      // FIXME why does 8 bit conversion maps [0;255] to [-128;127]
+      // instead of [0;127] to [0;127] and [128;255] to [-128;-1]
+      if (bitspersample == 8) signed_val -= wrap_at;
+      else if (unsigned_val >= wrap_at) signed_val = unsigned_val - wrap_with;
+      s->output->data[i][j] = signed_val * scaler;
+    }
+  }
+
+  *wavread_read = read;
+
+  if (read == 0) s->eof = 1;
+}
+
+void aubio_source_wavread_do(aubio_source_wavread_t * s, fvec_t * read_data, uint_t * read){
+  uint_t i, j;
+  uint_t end = 0;
+  uint_t total_wrote = 0;
+  while (total_wrote < s->hop_size) {
+    end = MIN(s->read_samples - s->read_index, s->hop_size - total_wrote);
+    for (i = 0; i < end; i++) {
+      read_data->data[i + total_wrote] = 0;
+      for (j = 0; j < s->input_channels; j++ ) {
+        read_data->data[i + total_wrote] += s->output->data[j][i + s->read_index];
+      }
+      read_data->data[i + total_wrote] /= (smpl_t)(s->input_channels);
+    }
+    total_wrote += end;
+    if (total_wrote < s->hop_size) {
+      uint_t wavread_read = 0;
+      aubio_source_wavread_readframe(s, &wavread_read);
+      s->read_samples = wavread_read;
+      s->read_index = 0;
+      if (s->eof) {
+        break;
+      }
+    } else {
+      s->read_index += end;
+    }
+  }
+  if (total_wrote < s->hop_size) {
+    for (i = end; i < s->hop_size; i++) {
+      read_data->data[i] = 0.;
+    }
+  }
+  *read = total_wrote;
+}
+
+void aubio_source_wavread_do_multi(aubio_source_wavread_t * s, fmat_t * read_data, uint_t * read){
+  uint_t i,j;
+  uint_t end = 0;
+  uint_t total_wrote = 0;
+  while (total_wrote < s->hop_size) {
+    end = MIN(s->read_samples - s->read_index, s->hop_size - total_wrote);
+    for (j = 0; j < read_data->height; j++) {
+      for (i = 0; i < end; i++) {
+        read_data->data[j][i + total_wrote] = s->output->data[j][i];
+      }
+    }
+    total_wrote += end;
+    if (total_wrote < s->hop_size) {
+      uint_t wavread_read = 0;
+      aubio_source_wavread_readframe(s, &wavread_read);
+      s->read_samples = wavread_read;
+      s->read_index = 0;
+      if (s->eof) {
+        break;
+      }
+    } else {
+      s->read_index += end;
+    }
+  }
+  if (total_wrote < s->hop_size) {
+    for (j = 0; j < read_data->height; j++) {
+      for (i = end; i < s->hop_size; i++) {
+        read_data->data[j][i] = 0.;
+      }
+    }
+  }
+  *read = total_wrote;
+}
+
+uint_t aubio_source_wavread_get_samplerate(aubio_source_wavread_t * s) {
+  return s->samplerate;
+}
+
+uint_t aubio_source_wavread_get_channels(aubio_source_wavread_t * s) {
+  return s->input_channels;
+}
+
+uint_t aubio_source_wavread_seek (aubio_source_wavread_t * s, uint_t pos) {
+  uint_t ret = fseek(s->fid, 44 + pos * s->blockalign, SEEK_SET);
+  s->eof = 0;
+  s->read_index = 0;
+  return ret;
+}
+
+void del_aubio_source_wavread(aubio_source_wavread_t * s) {
+  if (!s) return;
+  if (s->fid) fclose(s->fid);
+  if (s->short_output) AUBIO_FREE(s->short_output);
+  if (s->output) del_fmat(s->output);
+  AUBIO_FREE(s);
+}
+
+#endif /* HAVE_WAVREAD */
diff --git a/src/io/source_wavread.h b/src/io/source_wavread.h
new file mode 100644
index 00000000..ca2fe53c
--- /dev/null
+++ b/src/io/source_wavread.h
@@ -0,0 +1,139 @@
+/*
+  Copyright (C) 2014 Paul Brossier <piem@aubio.org>
+
+  This file is part of aubio.
+
+  aubio is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  aubio is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with aubio.  If not, see <http://www.gnu.org/licenses/>.
+
+*/
+
+#ifndef _AUBIO_SOURCE_WAVREAD_H
+#define _AUBIO_SOURCE_WAVREAD_H
+
+/** \file
+
+  Read from file using custom wav reading routines.
+
+  Avoid including this file directly! Prefer using ::aubio_source_t instead to
+  make your code portable.
+
+  To write to file, use ::aubio_sink_t.
+
+  References:
+
+    - http://netghost.narod.ru/gff/graphics/summary/micriff.htm
+    - https://ccrma.stanford.edu/courses/422/projects/WaveFormat/
+
+  \example io/test-source_wavread.c
+
+*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/** wavread media source object */
+typedef struct _aubio_source_wavread_t aubio_source_wavread_t;
+
+/**
+
+  create new ::aubio_source_wavread_t
+
+  \param uri the file path or uri to read from
+  \param samplerate sampling rate to view the fie at
+  \param hop_size the size of the blocks to read from
+
+  Creates a new source object. If `0` is passed as `samplerate`, the sample
+  rate of the original file is used.
+
+  The samplerate of newly created source can be obtained using
+  ::aubio_source_wavread_get_samplerate.
+
+*/
+aubio_source_wavread_t * new_aubio_source_wavread(char_t * uri, uint_t samplerate, uint_t hop_size);
+
+/**
+
+  read monophonic vector of length hop_size from source object
+
+  \param s source object, created with ::new_aubio_source_wavread
+  \param read_to ::fvec_t of data to read to
+  \param[out] read upon returns, equals to number of frames actually read
+
+  Upon returns, `read` contains the number of frames actually read from the
+  source. `hop_size` if enough frames could be read, less otherwise.
+
+*/
+void aubio_source_wavread_do(aubio_source_wavread_t * s, fvec_t * read_to, uint_t * read);
+
+/**
+
+  read polyphonic vector of length hop_size from source object
+
+  \param s source object, created with ::new_aubio_source_wavread
+  \param read_to ::fmat_t of data to read to
+  \param read upon returns, equals to number of frames actually read
+
+  Upon returns, `read` contains the number of frames actually read from the
+  source. `hop_size` if enough frames could be read, less otherwise.
+
+*/
+void aubio_source_wavread_do_multi(aubio_source_wavread_t * s, fmat_t * read_to, uint_t * read);
+
+/**
+
+  get samplerate of source object
+
+  \param s source object, created with ::new_aubio_source_wavread
+  \return samplerate, in Hz
+
+*/
+uint_t aubio_source_wavread_get_samplerate(aubio_source_wavread_t * s);
+
+/**
+
+  get number of channels of source object
+
+  \param s source object, created with ::new_aubio_source_wavread
+  \return number of channels
+
+*/
+uint_t aubio_source_wavread_get_channels (aubio_source_wavread_t * s);
+
+/**
+
+  seek source object
+
+  \param s source object, created with ::new_aubio_source_wavread
+  \param pos position to seek to, in frames
+
+  \return 0 if sucessful, non-zero on failure
+
+*/
+uint_t aubio_source_wavread_seek (aubio_source_wavread_t *s, uint_t pos);
+
+/**
+
+  close source and cleanup memory
+
+  \param s source object, created with ::new_aubio_source_wavread
+
+*/
+void del_aubio_source_wavread(aubio_source_wavread_t * s);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _AUBIO_SOURCE_WAVREAD_H */
diff --git a/tests/src/io/test-source_wavread.c b/tests/src/io/test-source_wavread.c
new file mode 100644
index 00000000..50da5894
--- /dev/null
+++ b/tests/src/io/test-source_wavread.c
@@ -0,0 +1,60 @@
+#define AUBIO_UNSTABLE 1
+#include <aubio.h>
+#include "utils_tests.h"
+
+// this file uses the unstable aubio api, please use aubio_source instead
+// see src/io/source.h and tests/src/source/test-source.c
+
+int main (int argc, char **argv)
+{
+  uint_t err = 0;
+  if (argc < 2) {
+    err = 2;
+    PRINT_ERR("not enough arguments\n");
+    PRINT_MSG("read a wave file as a mono vector\n");
+    PRINT_MSG("usage: %s <source_path> [samplerate] [hop_size]\n", argv[0]);
+    PRINT_MSG("examples:\n");
+    PRINT_MSG(" - read file.wav at original samplerate\n");
+    PRINT_MSG("       %s file.wav\n", argv[0]);
+    PRINT_MSG(" - read file.wav at 32000Hz\n");
+    PRINT_MSG("       %s file.aif 32000\n", argv[0]);
+    PRINT_MSG(" - read file.wav at original samplerate with 4096 blocks\n");
+    PRINT_MSG("       %s file.wav 0 4096 \n", argv[0]);
+    return err;
+  }
+
+#ifdef HAVE_WAVREAD
+  uint_t samplerate = 0;
+  uint_t hop_size = 256;
+  uint_t n_frames = 0, read = 0;
+  if ( argc == 3 ) samplerate = atoi(argv[2]);
+  if ( argc == 4 ) hop_size = atoi(argv[3]);
+
+  char_t *source_path = argv[1];
+
+
+  aubio_source_wavread_t * s =
+    new_aubio_source_wavread(source_path, samplerate, hop_size);
+  if (!s) { err = 1; goto beach; }
+  fvec_t *vec = new_fvec(hop_size);
+
+  samplerate = aubio_source_wavread_get_samplerate(s);
+
+  do {
+    aubio_source_wavread_do(s, vec, &read);
+    fvec_print (vec);
+    n_frames += read;
+  } while ( read == hop_size );
+
+  PRINT_MSG("read %d frames at %dHz (%d blocks) from %s\n", n_frames, samplerate,
+    n_frames / hop_size, source_path);
+
+  del_fvec (vec);
+  del_aubio_source_wavread (s);
+beach:
+#else
+  err = 3;
+  PRINT_ERR("aubio was not compiled with aubio_source_wavread\n");
+#endif /* HAVE_WAVREAD */
+  return err;
+}
diff --git a/wscript b/wscript
index 1f54a43f..e9bed7fe 100644
--- a/wscript
+++ b/wscript
@@ -228,6 +228,8 @@ def configure(ctx):
         else:
             ctx.msg('Checking for all libav libraries', 'not found', color = 'YELLOW')
 
+    ctx.define('HAVE_WAVREAD', 1)
+
     # use memcpy hacks
     if (ctx.options.enable_memcpy == True):
         ctx.define('HAVE_MEMCPY_HACKS', 1)