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