Changes in src/io/source.h [de5d3f1:ac20c85]

File:

• src/io/source.h (modified) (5 diffs)

src/io/source.h

@@ -1 +1 @@
 /*
-  Copyright (C) 2012 Paul Brossier <piem@aubio.org>
+  Copyright (C) 2012-2013 Paul Brossier <piem@aubio.org>
 
   This file is part of aubio.
@@ -24 +24 @@
 /** \file
 
-  Media source object
+  Media source to read blocks of consecutive audio samples from file
 
   \example io/test-source.c
@@ -34 +34 @@
 #endif
 
-/** source object structure */
+/** media source object */
 typedef struct _aubio_source_t aubio_source_t;
 
@@ -42 +42 @@
 
   \param uri the file path or uri to read from
-  \param samplerate the sample rate to read the file at
-  \param hop_size the size of the blocks to read from
+  \param samplerate sampling rate to view the fie at
+  \param block_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 the current source can be obtained with
+  The samplerate of newly created source can be obtained using
   ::aubio_source_get_samplerate.
 
 */
-aubio_source_t * new_aubio_source(char_t * uri, uint_t samplerate, uint_t hop_size);
+aubio_source_t * new_aubio_source(char_t * uri, uint_t samplerate, uint_t block_size);
 
 /**
 
-  read monophonic vector of length hop_size from source object
+  read monophonic vector of length block_size from source object
 
   \param s source object, created with ::new_aubio_source
-  \param read_data ::fvec_t of data to read to
-  \param read number of frames actually read
+  \param read_to ::fvec_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.
+  source. `block_size` if enough frames could be read, less otherwise.
 
 */
-void aubio_source_do(aubio_source_t * s, fvec_t * read_data, uint_t * read);
+void aubio_source_do(aubio_source_t * s, fvec_t * read_to, uint_t * read);
 
 /**
@@ -80 +80 @@
 /**
 
-  destroy source object
+  close source and cleanup memory
 
   \param s source object, created with ::new_aubio_source