lavfi: add error handling to filter_samples().
[ffmpeg.git] / libavfilter / audio.h
1 /*
2  * This file is part of Libav.
3  *
4  * Libav is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * Libav is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with Libav; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18
19 #ifndef AVFILTER_AUDIO_H
20 #define AVFILTER_AUDIO_H
21
22 #include "avfilter.h"
23
24 /** default handler for get_audio_buffer() for audio inputs */
25 AVFilterBufferRef *ff_default_get_audio_buffer(AVFilterLink *link, int perms,
26                                                      int nb_samples);
27
28 /** get_audio_buffer() handler for filters which simply pass audio along */
29 AVFilterBufferRef *ff_null_get_audio_buffer(AVFilterLink *link, int perms,
30                                                   int nb_samples);
31
32 /**
33  * Request an audio samples buffer with a specific set of permissions.
34  *
35  * @param link           the output link to the filter from which the buffer will
36  *                       be requested
37  * @param perms          the required access permissions
38  * @param nb_samples     the number of samples per channel
39  * @return               A reference to the samples. This must be unreferenced with
40  *                       avfilter_unref_buffer when you are finished with it.
41  */
42 AVFilterBufferRef *ff_get_audio_buffer(AVFilterLink *link, int perms,
43                                              int nb_samples);
44
45 /**
46  * Send a buffer of audio samples to the next filter.
47  *
48  * @param link       the output link over which the audio samples are being sent
49  * @param samplesref a reference to the buffer of audio samples being sent. The
50  *                   receiving filter will free this reference when it no longer
51  *                   needs it or pass it on to the next filter.
52  *
53  * @return >= 0 on success, a negative AVERROR on error. The receiving filter
54  * is responsible for unreferencing samplesref in case of error.
55  */
56 int ff_filter_samples(AVFilterLink *link, AVFilterBufferRef *samplesref);
57
58 #endif /* AVFILTER_AUDIO_H */