source: src/io/ioutils.h @ 025d8cd

feature/autosinkfeature/constantqfeature/pitchshiftfeature/pydocstringsfeature/timestretchsampleryinfft+
Last change on this file since 025d8cd was 025d8cd, checked in by Paul Brossier <piem@piem.org>, 3 years ago

src/io/ioutils.h: add basic documentation

  • Property mode set to 100644
File size: 1.6 KB
Line 
1/*
2  Copyright (C) 2016 Paul Brossier <piem@aubio.org>
3
4  This file is part of aubio.
5
6  aubio is free software: you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10
11  aubio is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  GNU General Public License for more details.
15
16  You should have received a copy of the GNU General Public License
17  along with aubio.  If not, see <http://www.gnu.org/licenses/>.
18
19*/
20
21#ifndef AUBIO_IOUTILS_H
22#define AUBIO_IOUTILS_H
23
24/** \file
25
26  Simple utility functions to validate input parameters.
27
28*/
29
30#ifdef __cplusplus
31extern "C" {
32#endif
33
34/** validate samplerate
35
36  \param kind       the object kind to report on
37  \param path       the object properties to report on
38  \param samplerate the object properties to report on
39  \return  0 if ok, non-zero if validation failed
40
41 */
42uint_t aubio_io_validate_samplerate(const char_t *kind, const char_t *path,
43    uint_t samplerate);
44
45/** validate number of channels
46
47  \param kind       the object kind to report on
48  \param path       the object properties to report on
49  \param channels   the object properties to report on
50  \return  0 if ok, non-zero if validation failed
51
52 */
53uint_t aubio_io_validate_channels(const char_t *kind, const char_t *path,
54    uint_t channels);
55
56#ifdef __cplusplus
57}
58#endif
59
60#endif /* AUBIO_IOUTILS_H */
Note: See TracBrowser for help on using the repository browser.