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