X-Git-Url: https://git.aubio.org/?p=aubio.git;a=blobdiff_plain;f=src%2Fio%2Fioutils.h;h=995f2d20da3adcaad60073f3d1fc71067f99a666;hp=1db7b19be218f0557f25b542364299b7eb0f11c3;hb=85e20fa6d486910c40c19f2a4b616384f1613d3d;hpb=b2e17402f895d4383d3fb0da3387a5d1417ad244 diff --git a/src/io/ioutils.h b/src/io/ioutils.h index 1db7b19b..995f2d20 100644 --- a/src/io/ioutils.h +++ b/src/io/ioutils.h @@ -53,12 +53,38 @@ uint_t aubio_io_validate_samplerate(const char_t *kind, const char_t *path, uint_t aubio_io_validate_channels(const char_t *kind, const char_t *path, uint_t channels); -/** validate length of input +/** 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 vector/matrix + \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 @@ -67,11 +93,11 @@ 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 input +/** validate height of sink input \param kind the object kind to report on \param path the path to report on - \param max_size maximum number of channels that can be written + \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