[sink_wavwrite] check fseek and fwrite return values

[aubio.git] / src / io / ioutils.h

diff --git a/src/io/ioutils.h b/src/io/ioutils.h
index 7d716af..995f2d2 100644 (file)
--- a/src/io/ioutils.h
+++ b/src/io/ioutils.h
@@ -21,16 +21,91 @@
 #ifndef AUBIO_IOUTILS_H
 #define AUBIO_IOUTILS_H
 
+/** \file
+
+  Simple utility functions to validate input parameters.
+
+*/
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+/** validate samplerate
+
+  \param kind       the object kind to report on
+  \param path       the object properties to report on
+  \param samplerate the object properties to report on
+  \return  0 if ok, non-zero if validation failed
+
+ */
 uint_t aubio_io_validate_samplerate(const char_t *kind, const char_t *path,
     uint_t samplerate);
 
+/** validate number of channels
+
+  \param kind       the object kind to report on
+  \param path       the object properties to report on
+  \param channels   the object properties to report on
+  \return  0 if ok, non-zero if validation failed
+
+ */
 uint_t aubio_io_validate_channels(const char_t *kind, const char_t *path,
     uint_t channels);
 
+/** validate length of source output
+
+  \param kind       the object kind to report on
+  \param path       the path to report on
+  \param hop_size   number of frames to be read
+  \param read_data_length actual length of input
+
+  \return hop_size or the maximum number of frames that can be written
+*/
+uint_t
+aubio_source_validate_input_length(const char_t *kind, const char_t *path,
+    uint_t hop_size, uint_t read_data_length);
+
+/** validate height of source output
+
+  \param kind       the object kind to report on
+  \param path       the path to report on
+  \param source_channels maximum number of channels that can be written
+  \param read_data_height actual height of input
+
+  \return write_data_height or the maximum number of channels
+*/
+uint_t
+aubio_source_validate_input_channels(const char_t *kind, const char_t *path,
+    uint_t source_channels, uint_t read_data_height);
+
+/** validate length of sink input
+
+  \param kind       the object kind to report on
+  \param path       the path to report on
+  \param max_size   maximum number of frames that can be written
+  \param write_data_length actual length of input
+  \param write number of samples asked
+
+  \return write or the maximum number of frames that can be written
+*/
+uint_t
+aubio_sink_validate_input_length(const char_t *kind, const char_t *path,
+    uint_t max_size, uint_t write_data_length, uint_t write);
+
+/** validate height of sink input
+
+  \param kind       the object kind to report on
+  \param path       the path to report on
+  \param sink_channels maximum number of channels that can be written
+  \param write_data_height actual height of input matrix
+
+  \return write_data_height or the maximum number of channels
+*/
+uint_t
+aubio_sink_validate_input_channels(const char_t *kind, const char_t *path,
+    uint_t sink_channels, uint_t write_data_height);
+
 #ifdef __cplusplus
 }
 #endif