Changeset 85e20fa for src/io/ioutils.h


Ignore:
Timestamp:
Dec 20, 2018, 5:21:19 PM (2 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/timestretch, master
Children:
14a5b9a
Parents:
b2e1740
Message:

[io] add helpers to check source output sizes

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/io/ioutils.h

    rb2e1740 r85e20fa  
    5454    uint_t channels);
    5555
    56 /** validate length of input
     56/** validate length of source output
     57
     58  \param kind       the object kind to report on
     59  \param path       the path to report on
     60  \param hop_size   number of frames to be read
     61  \param read_data_length actual length of input
     62
     63  \return hop_size or the maximum number of frames that can be written
     64*/
     65uint_t
     66aubio_source_validate_input_length(const char_t *kind, const char_t *path,
     67    uint_t hop_size, uint_t read_data_length);
     68
     69/** validate height of source output
     70
     71  \param kind       the object kind to report on
     72  \param path       the path to report on
     73  \param source_channels maximum number of channels that can be written
     74  \param read_data_height actual height of input
     75
     76  \return write_data_height or the maximum number of channels
     77*/
     78uint_t
     79aubio_source_validate_input_channels(const char_t *kind, const char_t *path,
     80    uint_t source_channels, uint_t read_data_height);
     81
     82/** validate length of sink input
    5783
    5884  \param kind       the object kind to report on
    5985  \param path       the path to report on
    6086  \param max_size   maximum number of frames that can be written
    61   \param write_data_length actual length of input vector/matrix
     87  \param write_data_length actual length of input
    6288  \param write number of samples asked
    6389
     
    6894    uint_t max_size, uint_t write_data_length, uint_t write);
    6995
    70 /** validate height of input
     96/** validate height of sink input
    7197
    7298  \param kind       the object kind to report on
    7399  \param path       the path to report on
    74   \param max_size  maximum number of channels that can be written
     100  \param sink_channels maximum number of channels that can be written
    75101  \param write_data_height actual height of input matrix
    76102
Note: See TracChangeset for help on using the changeset viewer.