doxygen: clean up function documentation.
[disorder] / lib / resample.h
1 /*
2 * This file is part of DisOrder.
3 * Copyright (C) 2009 Richard Kettlewell
4 *
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 */
18
19 /** @file lib/resample.h
20 * @brief Audio resampling
21 */
22
23 #ifndef RESAMPLE_H
24 #define RESAMPLE_H
25
26 #if HAVE_SAMPLERATE_H
27 #include <samplerate.h>
28 #endif
29
30 #include "byte-order.h"
31
32 struct resampler {
33 int input_bits, input_channels, input_rate, input_signed, input_endian;
34 int output_bits, output_channels, output_rate, output_signed, output_endian;
35 int input_bytes_per_sample;
36 int input_bytes_per_frame;
37 #if HAVE_SAMPLERATE_H
38 SRC_STATE *state;
39 #endif
40 };
41
42 void resample_init(struct resampler *rs,
43 int input_bits, int input_channels,
44 int input_rate, int input_signed,
45 int input_endian,
46 int output_bits, int output_channels,
47 int output_rate, int output_signed,
48 int output_endian);
49 size_t resample_convert(const struct resampler *rs,
50 const uint8_t *bytes,
51 size_t nbytes,
52 int eof,
53 void (*converted)(uint8_t *bytes,
54 size_t nbytes,
55 void *cd),
56 void *cd);
57 void resample_close(struct resampler *rs);
58
59 #endif /* RESAMPLE_H */
60
61 /*
62 Local Variables:
63 c-basic-offset:2
64 comment-column:40
65 fill-column:79
66 indent-tabs-mode:nil
67 End:
68 */