Merge remote-tracking branch 'qatar/master'
[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     int refcount;
35     int draining;
36 } AVFilterPool;
37
38 typedef struct AVFilterCommand {
39     double time;                ///< time expressed in seconds
40     char *command;              ///< command
41     char *arg;                  ///< optional argument for the command
42     int flags;
43     struct AVFilterCommand *next;
44 } AVFilterCommand;
45
46 /**
47  * Check for the validity of graph.
48  *
49  * A graph is considered valid if all its input and output pads are
50  * connected.
51  *
52  * @return 0 in case of success, a negative value otherwise
53  */
54 int ff_avfilter_graph_check_validity(AVFilterGraph *graphctx, AVClass *log_ctx);
55
56 /**
57  * Configure all the links of graphctx.
58  *
59  * @return 0 in case of success, a negative value otherwise
60  */
61 int ff_avfilter_graph_config_links(AVFilterGraph *graphctx, AVClass *log_ctx);
62
63 /**
64  * Configure the formats of all the links in the graph.
65  */
66 int ff_avfilter_graph_config_formats(AVFilterGraph *graphctx, AVClass *log_ctx);
67
68 /**
69  * Update the position of a link in the age heap.
70  */
71 void ff_avfilter_graph_update_heap(AVFilterGraph *graph, AVFilterLink *link);
72
73 /** default handler for freeing audio/video buffer when there are no references left */
74 void ff_avfilter_default_free_buffer(AVFilterBuffer *buf);
75
76 /** Tell is a format is contained in the provided list terminated by -1. */
77 int ff_fmt_is_in(int fmt, const int *fmts);
78
79 /**
80  * Return a copy of a list of integers terminated by -1, or NULL in
81  * case of copy failure.
82  */
83 int *ff_copy_int_list(const int * const list);
84
85 /**
86  * Return a copy of a list of 64-bit integers, or NULL in case of
87  * copy failure.
88  */
89 int64_t *ff_copy_int64_list(const int64_t * const list);
90
91 /* Functions to parse audio format arguments */
92
93 /**
94  * Parse a pixel format.
95  *
96  * @param ret pixel format 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_pixel_format(enum PixelFormat *ret, const char *arg, void *log_ctx);
102
103 /**
104  * Parse a sample rate.
105  *
106  * @param ret unsigned 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_sample_rate(int *ret, const char *arg, void *log_ctx);
112
113 /**
114  * Parse a sample format name 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_sample_format(int *ret, const char *arg, void *log_ctx);
122
123 /**
124  * Parse a channel layout or a corresponding integer representation.
125  *
126  * @param ret 64bit integer pointer to where the value should be written.
127  * @param arg string to parse
128  * @param log_ctx log context
129  * @return 0 in case of success, a negative AVERROR code on error
130  */
131 int ff_parse_channel_layout(int64_t *ret, const char *arg, void *log_ctx);
132
133 /**
134  * Parse a packing format or a corresponding integer representation.
135  *
136  * @param ret integer pointer to where the value should be written
137  * @param arg string to parse
138  * @param log_ctx log context
139  * @return 0 in case of success, a negative AVERROR code on error
140  */
141 int ff_parse_packing_format(int *ret, const char *arg, void *log_ctx);
142
143 /**
144  * Pass video frame along and keep an internal reference for later use.
145  */
146 static inline void ff_null_start_frame_keep_ref(AVFilterLink *inlink,
147                                                 AVFilterBufferRef *picref)
148 {
149     avfilter_start_frame(inlink->dst->outputs[0], avfilter_ref_buffer(picref, ~0));
150 }
151
152 void ff_update_link_current_pts(AVFilterLink *link, int64_t pts);
153
154 #define FF_DPRINTF_START(ctx, func) av_dlog(NULL, "%-16s: ", #func)
155
156 void ff_dlog_link(void *ctx, AVFilterLink *link, int end);
157
158 #endif /* AVFILTER_INTERNAL_H */