01008cd319d2338344b999ea013caa9645b48cb9
[aubio.git] / src / io / sink_wavwrite.h
1 /*
2   Copyright (C) 2014 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_SINK_WAVWRITE_H
22 #define _AUBIO_SINK_WAVWRITE_H
23
24 /** \file
25
26   Write to file using [libsndfile](http://www.mega-nerd.com/libsndfile/)
27
28   Avoid including this file directly! Prefer using ::aubio_sink_t instead to
29   make your code portable.
30
31   To read from file, use ::aubio_source_t.
32
33   \example io/test-sink_wavwrite.c
34
35 */
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 typedef struct _aubio_sink_wavwrite_t aubio_sink_wavwrite_t;
42
43 /**
44
45   create new ::aubio_sink_wavwrite_t
46
47   \param uri the file path or uri to write to
48   \param samplerate sample rate to write the file at
49
50   \return newly created ::aubio_sink_wavwrite_t
51
52   Creates a new sink object.
53
54 */
55 aubio_sink_wavwrite_t * new_aubio_sink_wavwrite(char_t * uri, uint_t samplerate);
56
57 /**
58
59   write monophonic vector of length hop_size to sink
60
61   \param s sink, created with ::new_aubio_sink_wavwrite
62   \param write_data ::fvec_t samples to write to sink
63   \param write number of frames to write
64
65 */
66 void aubio_sink_wavwrite_do(aubio_sink_wavwrite_t * s, fvec_t * write_data, uint_t write);
67
68 /**
69
70   close sink
71
72   \param s sink_wavwrite object, create with ::new_aubio_sink_wavwrite
73
74   \return 0 on success, non-zero on failure
75
76 */
77 uint_t aubio_sink_wavwrite_close(aubio_sink_wavwrite_t * s);
78
79 /**
80
81   close sink and cleanup memory
82
83   \param s sink, created with ::new_aubio_sink_wavwrite
84
85 */
86 void del_aubio_sink_wavwrite(aubio_sink_wavwrite_t * s);
87
88 #ifdef __cplusplus
89 }
90 #endif
91
92 #endif /* _AUBIO_SINK_WAVWRITE_H */