lavfi: consistently use int for sample_rate in AVFilterLink and AVFilterBufferRefAudi...
[ffmpeg.git] / libavfilter / internal.h
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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_INTERNAL_H
20 #define AVFILTER_INTERNAL_H
21
22 /**
23  * @file
24  * internal API functions
25  */
26
27 #include "avfilter.h"
28 #include "avfiltergraph.h"
29
30 #define POOL_SIZE 32
31 typedef struct AVFilterPool {
32     AVFilterBufferRef *pic[POOL_SIZE];
33     int count;
34 } AVFilterPool;
35
36 typedef struct AVFilterCommand {
37     double time;
38     char *command, *arg;
39     int flags;
40     struct AVFilterCommand *next;
41 } AVFilterCommand;
42
43 /**
44  * Check for the validity of graph.
45  *
46  * A graph is considered valid if all its input and output pads are
47  * connected.
48  *
49  * @return 0 in case of success, a negative value otherwise
50  */
51 int ff_avfilter_graph_check_validity(AVFilterGraph *graphctx, AVClass *log_ctx);
52
53 /**
54  * Configure all the links of graphctx.
55  *
56  * @return 0 in case of success, a negative value otherwise
57  */
58 int ff_avfilter_graph_config_links(AVFilterGraph *graphctx, AVClass *log_ctx);
59
60 /**
61  * Configure the formats of all the links in the graph.
62  */
63 int ff_avfilter_graph_config_formats(AVFilterGraph *graphctx, AVClass *log_ctx);
64
65 /** default handler for freeing audio/video buffer when there are no references left */
66 void ff_avfilter_default_free_buffer(AVFilterBuffer *buf);
67
68 /** Tell is a format is contained in the provided list terminated by -1. */
69 int ff_fmt_is_in(int fmt, const int *fmts);
70
71 /* Functions to parse audio format arguments */
72
73 /**
74  * Parse a pixel format.
75  *
76  * @param ret pixel format pointer to where the value should be written
77  * @param arg string to parse
78  * @param log_ctx log context
79  * @return 0 in case of success, a negative AVERROR code on error
80  */
81 int ff_parse_pixel_format(enum PixelFormat *ret, const char *arg, void *log_ctx);
82
83 /**
84  * Parse a sample rate.
85  *
86  * @param ret unsigned integer pointer to where the value should be written
87  * @param arg string to parse
88  * @param log_ctx log context
89  * @return 0 in case of success, a negative AVERROR code on error
90  */
91 int ff_parse_sample_rate(int *ret, const char *arg, void *log_ctx);
92
93 /**
94  * Parse a sample format name or a corresponding integer representation.
95  *
96  * @param ret integer pointer to where the value should be written
97  * @param arg string to parse
98  * @param log_ctx log context
99  * @return 0 in case of success, a negative AVERROR code on error
100  */
101 int ff_parse_sample_format(int *ret, const char *arg, void *log_ctx);
102
103 /**
104  * Parse a channel layout or a corresponding integer representation.
105  *
106  * @param ret 64bit integer pointer to where the value should be written.
107  * @param arg string to parse
108  * @param log_ctx log context
109  * @return 0 in case of success, a negative AVERROR code on error
110  */
111 int ff_parse_channel_layout(int64_t *ret, const char *arg, void *log_ctx);
112
113 /**
114  * Parse a packing format or a corresponding integer representation.
115  *
116  * @param ret integer pointer to where the value should be written
117  * @param arg string to parse
118  * @param log_ctx log context
119  * @return 0 in case of success, a negative AVERROR code on error
120  */
121 int ff_parse_packing_format(int *ret, const char *arg, void *log_ctx);
122
123 #endif /* AVFILTER_INTERNAL_H */