source: src/io/sink_sndfile.h @ a9fd272

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

src/io/sink*: add _close function, improve error messages

  • Property mode set to 100644
File size: 2.1 KB
Line 
1/*
2  Copyright (C) 2012-2013 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_SNDFILE_H
22#define _AUBIO_SINK_SNDFILE_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_sndfile.c
34
35*/
36
37#ifdef __cplusplus
38extern "C" {
39#endif
40
41typedef struct _aubio_sink_sndfile_t aubio_sink_sndfile_t;
42
43/**
44
45  create new ::aubio_sink_sndfile_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_sndfile_t
51
52  Creates a new sink object.
53
54*/
55aubio_sink_sndfile_t * new_aubio_sink_sndfile(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_sndfile
62  \param write_data ::fvec_t samples to write to sink
63  \param write number of frames to write
64
65*/
66void aubio_sink_sndfile_do(aubio_sink_sndfile_t * s, fvec_t * write_data, uint_t write);
67
68/**
69
70  close sink
71
72  \param s sink_sndfile object, created with ::new_aubio_sink_sndfile
73
74  \return 0 on success, non-zero on failure
75
76*/
77uint_t aubio_sink_sndfile_close(aubio_sink_sndfile_t * s);
78
79/**
80
81  close sink and cleanup memory
82
83  \param s sink, created with ::new_aubio_sink_sndfile
84
85*/
86void del_aubio_sink_sndfile(aubio_sink_sndfile_t * s);
87
88#ifdef __cplusplus
89}
90#endif
91
92#endif /* _AUBIO_SINK_SNDFILE_H */
Note: See TracBrowser for help on using the repository browser.