Change avfilter_open() signature, from:
[ffmpeg.git] / libavfilter / avfilter.c
1 /*
2  * filter layer
3  * copyright (c) 2007 Bobby Bingham
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 /* #define DEBUG */
23
24 #include "libavcodec/imgconvert.h"
25 #include "libavutil/pixdesc.h"
26 #include "avfilter.h"
27 #include "internal.h"
28
29 unsigned avfilter_version(void) {
30     return LIBAVFILTER_VERSION_INT;
31 }
32
33 const char *avfilter_configuration(void)
34 {
35     return FFMPEG_CONFIGURATION;
36 }
37
38 const char *avfilter_license(void)
39 {
40 #define LICENSE_PREFIX "libavfilter license: "
41     return LICENSE_PREFIX FFMPEG_LICENSE + sizeof(LICENSE_PREFIX) - 1;
42 }
43
44 /** helper macros to get the in/out pad on the dst/src filter */
45 #define link_dpad(link)     link->dst-> input_pads[link->dstpad]
46 #define link_spad(link)     link->src->output_pads[link->srcpad]
47
48 AVFilterBufferRef *avfilter_ref_buffer(AVFilterBufferRef *ref, int pmask)
49 {
50     AVFilterBufferRef *ret = av_malloc(sizeof(AVFilterBufferRef));
51     *ret = *ref;
52     if (ref->type == AVMEDIA_TYPE_VIDEO) {
53         ret->video = av_malloc(sizeof(AVFilterBufferRefVideoProps));
54         *ret->video = *ref->video;
55     }
56     ret->perms &= pmask;
57     ret->buf->refcount ++;
58     return ret;
59 }
60
61 void avfilter_unref_buffer(AVFilterBufferRef *ref)
62 {
63     if(!(--ref->buf->refcount))
64         ref->buf->free(ref->buf);
65     av_free(ref->video);
66     av_free(ref);
67 }
68
69 void avfilter_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
70                          AVFilterPad **pads, AVFilterLink ***links,
71                          AVFilterPad *newpad)
72 {
73     unsigned i;
74
75     idx = FFMIN(idx, *count);
76
77     *pads  = av_realloc(*pads,  sizeof(AVFilterPad)   * (*count + 1));
78     *links = av_realloc(*links, sizeof(AVFilterLink*) * (*count + 1));
79     memmove(*pads +idx+1, *pads +idx, sizeof(AVFilterPad)   * (*count-idx));
80     memmove(*links+idx+1, *links+idx, sizeof(AVFilterLink*) * (*count-idx));
81     memcpy(*pads+idx, newpad, sizeof(AVFilterPad));
82     (*links)[idx] = NULL;
83
84     (*count) ++;
85     for(i = idx+1; i < *count; i ++)
86         if(*links[i])
87             (*(unsigned *)((uint8_t *) *links[i] + padidx_off)) ++;
88 }
89
90 int avfilter_link(AVFilterContext *src, unsigned srcpad,
91                   AVFilterContext *dst, unsigned dstpad)
92 {
93     AVFilterLink *link;
94
95     if(src->output_count <= srcpad || dst->input_count <= dstpad ||
96        src->outputs[srcpad]        || dst->inputs[dstpad])
97         return -1;
98
99     src->outputs[srcpad] =
100     dst-> inputs[dstpad] = link = av_mallocz(sizeof(AVFilterLink));
101
102     link->src     = src;
103     link->dst     = dst;
104     link->srcpad  = srcpad;
105     link->dstpad  = dstpad;
106     link->type    = src->output_pads[srcpad].type;
107     assert(PIX_FMT_NONE == -1 && SAMPLE_FMT_NONE == -1);
108     link->format  = -1;
109
110     return 0;
111 }
112
113 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
114                            unsigned in, unsigned out)
115 {
116     av_log(link->dst, AV_LOG_INFO, "auto-inserting filter '%s' "
117            "between the filter '%s' and the filter '%s'\n",
118            filt->name, link->src->name, link->dst->name);
119
120     link->dst->inputs[link->dstpad] = NULL;
121     if(avfilter_link(filt, out, link->dst, link->dstpad)) {
122         /* failed to link output filter to new filter */
123         link->dst->inputs[link->dstpad] = link;
124         return -1;
125     }
126
127     /* re-hookup the link to the new destination filter we inserted */
128     link->dst = filt;
129     link->dstpad = in;
130     filt->inputs[in] = link;
131
132     /* if any information on supported media formats already exists on the
133      * link, we need to preserve that */
134     if(link->out_formats)
135         avfilter_formats_changeref(&link->out_formats,
136                                    &filt->outputs[out]->out_formats);
137
138     return 0;
139 }
140
141 int avfilter_config_links(AVFilterContext *filter)
142 {
143     int (*config_link)(AVFilterLink *);
144     unsigned i;
145
146     for(i = 0; i < filter->input_count; i ++) {
147         AVFilterLink *link = filter->inputs[i];
148
149         if(!link) continue;
150
151         switch(link->init_state) {
152         case AVLINK_INIT:
153             continue;
154         case AVLINK_STARTINIT:
155             av_log(filter, AV_LOG_INFO, "circular filter chain detected\n");
156             return 0;
157         case AVLINK_UNINIT:
158             link->init_state = AVLINK_STARTINIT;
159
160             if(avfilter_config_links(link->src))
161                 return -1;
162
163             if(!(config_link = link_spad(link).config_props))
164                 config_link  = avfilter_default_config_output_link;
165             if(config_link(link))
166                 return -1;
167
168             if((config_link = link_dpad(link).config_props))
169                 if(config_link(link))
170                     return -1;
171
172             link->init_state = AVLINK_INIT;
173         }
174     }
175
176     return 0;
177 }
178
179 void ff_dprintf_picref(void *ctx, AVFilterBufferRef *picref, int end)
180 {
181     dprintf(ctx,
182             "picref[%p data[%p, %p, %p, %p] linesize[%d, %d, %d, %d] pts:%"PRId64" pos:%"PRId64" a:%d/%d s:%dx%d]%s",
183             picref,
184             picref->data    [0], picref->data    [1], picref->data    [2], picref->data    [3],
185             picref->linesize[0], picref->linesize[1], picref->linesize[2], picref->linesize[3],
186             picref->pts, picref->pos,
187             picref->video->pixel_aspect.num, picref->video->pixel_aspect.den, picref->video->w, picref->video->h,
188             end ? "\n" : "");
189 }
190
191 void ff_dprintf_link(void *ctx, AVFilterLink *link, int end)
192 {
193     dprintf(ctx,
194             "link[%p s:%dx%d fmt:%-16s %-16s->%-16s]%s",
195             link, link->w, link->h,
196             av_pix_fmt_descriptors[link->format].name,
197             link->src ? link->src->filter->name : "",
198             link->dst ? link->dst->filter->name : "",
199             end ? "\n" : "");
200 }
201
202 AVFilterBufferRef *avfilter_get_video_buffer(AVFilterLink *link, int perms, int w, int h)
203 {
204     AVFilterBufferRef *ret = NULL;
205
206     FF_DPRINTF_START(NULL, get_video_buffer); ff_dprintf_link(NULL, link, 0); dprintf(NULL, " perms:%d w:%d h:%d\n", perms, w, h);
207
208     if(link_dpad(link).get_video_buffer)
209         ret = link_dpad(link).get_video_buffer(link, perms, w, h);
210
211     if(!ret)
212         ret = avfilter_default_get_video_buffer(link, perms, w, h);
213
214     FF_DPRINTF_START(NULL, get_video_buffer); ff_dprintf_link(NULL, link, 0); dprintf(NULL, " returning "); ff_dprintf_picref(NULL, ret, 1);
215
216     return ret;
217 }
218
219 int avfilter_request_frame(AVFilterLink *link)
220 {
221     FF_DPRINTF_START(NULL, request_frame); ff_dprintf_link(NULL, link, 1);
222
223     if(link_spad(link).request_frame)
224         return link_spad(link).request_frame(link);
225     else if(link->src->inputs[0])
226         return avfilter_request_frame(link->src->inputs[0]);
227     else return -1;
228 }
229
230 int avfilter_poll_frame(AVFilterLink *link)
231 {
232     int i, min=INT_MAX;
233
234     if(link_spad(link).poll_frame)
235         return link_spad(link).poll_frame(link);
236
237     for (i=0; i<link->src->input_count; i++) {
238         int val;
239         if(!link->src->inputs[i])
240             return -1;
241         val = avfilter_poll_frame(link->src->inputs[i]);
242         min = FFMIN(min, val);
243     }
244
245     return min;
246 }
247
248 /* XXX: should we do the duplicating of the picture ref here, instead of
249  * forcing the source filter to do it? */
250 void avfilter_start_frame(AVFilterLink *link, AVFilterBufferRef *picref)
251 {
252     void (*start_frame)(AVFilterLink *, AVFilterBufferRef *);
253     AVFilterPad *dst = &link_dpad(link);
254
255     FF_DPRINTF_START(NULL, start_frame); ff_dprintf_link(NULL, link, 0); dprintf(NULL, " "); ff_dprintf_picref(NULL, picref, 1);
256
257     if(!(start_frame = dst->start_frame))
258         start_frame = avfilter_default_start_frame;
259
260     /* prepare to copy the picture if it has insufficient permissions */
261     if((dst->min_perms & picref->perms) != dst->min_perms ||
262         dst->rej_perms & picref->perms) {
263         /*
264         av_log(link->dst, AV_LOG_INFO,
265                 "frame copy needed (have perms %x, need %x, reject %x)\n",
266                 picref->perms,
267                 link_dpad(link).min_perms, link_dpad(link).rej_perms);
268         */
269
270         link->cur_buf = avfilter_default_get_video_buffer(link, dst->min_perms, link->w, link->h);
271         link->src_buf = picref;
272         avfilter_copy_buffer_ref_props(link->cur_buf, link->src_buf);
273     }
274     else
275         link->cur_buf = picref;
276
277     start_frame(link, link->cur_buf);
278 }
279
280 void avfilter_end_frame(AVFilterLink *link)
281 {
282     void (*end_frame)(AVFilterLink *);
283
284     if(!(end_frame = link_dpad(link).end_frame))
285         end_frame = avfilter_default_end_frame;
286
287     end_frame(link);
288
289     /* unreference the source picture if we're feeding the destination filter
290      * a copied version dues to permission issues */
291     if(link->src_buf) {
292         avfilter_unref_buffer(link->src_buf);
293         link->src_buf = NULL;
294     }
295
296 }
297
298 void avfilter_draw_slice(AVFilterLink *link, int y, int h, int slice_dir)
299 {
300     uint8_t *src[4], *dst[4];
301     int i, j, vsub;
302     void (*draw_slice)(AVFilterLink *, int, int, int);
303
304     FF_DPRINTF_START(NULL, draw_slice); ff_dprintf_link(NULL, link, 0); dprintf(NULL, " y:%d h:%d dir:%d\n", y, h, slice_dir);
305
306     /* copy the slice if needed for permission reasons */
307     if(link->src_buf) {
308         vsub = av_pix_fmt_descriptors[link->format].log2_chroma_h;
309
310         for(i = 0; i < 4; i ++) {
311             if(link->src_buf->data[i]) {
312                 src[i] = link->src_buf-> data[i] +
313                     (y >> (i==0 ? 0 : vsub)) * link->src_buf-> linesize[i];
314                 dst[i] = link->cur_buf->data[i] +
315                     (y >> (i==0 ? 0 : vsub)) * link->cur_buf->linesize[i];
316             } else
317                 src[i] = dst[i] = NULL;
318         }
319
320         for(i = 0; i < 4; i ++) {
321             int planew =
322                 ff_get_plane_bytewidth(link->format, link->cur_buf->video->w, i);
323
324             if(!src[i]) continue;
325
326             for(j = 0; j < h >> (i==0 ? 0 : vsub); j ++) {
327                 memcpy(dst[i], src[i], planew);
328                 src[i] += link->src_buf ->linesize[i];
329                 dst[i] += link->cur_buf->linesize[i];
330             }
331         }
332     }
333
334     if(!(draw_slice = link_dpad(link).draw_slice))
335         draw_slice = avfilter_default_draw_slice;
336     draw_slice(link, y, h, slice_dir);
337 }
338
339 #define MAX_REGISTERED_AVFILTERS_NB 64
340
341 static AVFilter *registered_avfilters[MAX_REGISTERED_AVFILTERS_NB + 1];
342
343 static int next_registered_avfilter_idx = 0;
344
345 AVFilter *avfilter_get_by_name(const char *name)
346 {
347     int i;
348
349     for (i = 0; registered_avfilters[i]; i++)
350         if (!strcmp(registered_avfilters[i]->name, name))
351             return registered_avfilters[i];
352
353     return NULL;
354 }
355
356 int avfilter_register(AVFilter *filter)
357 {
358     if (next_registered_avfilter_idx == MAX_REGISTERED_AVFILTERS_NB)
359         return -1;
360
361     registered_avfilters[next_registered_avfilter_idx++] = filter;
362     return 0;
363 }
364
365 AVFilter **av_filter_next(AVFilter **filter)
366 {
367     return filter ? ++filter : &registered_avfilters[0];
368 }
369
370 void avfilter_uninit(void)
371 {
372     memset(registered_avfilters, 0, sizeof(registered_avfilters));
373     next_registered_avfilter_idx = 0;
374 }
375
376 static int pad_count(const AVFilterPad *pads)
377 {
378     int count;
379
380     for(count = 0; pads->name; count ++) pads ++;
381     return count;
382 }
383
384 static const char *filter_name(void *p)
385 {
386     AVFilterContext *filter = p;
387     return filter->filter->name;
388 }
389
390 static const AVClass avfilter_class = {
391     "AVFilter",
392     filter_name,
393     NULL,
394     LIBAVUTIL_VERSION_INT,
395 };
396
397 int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name)
398 {
399     AVFilterContext *ret;
400     *filter_ctx = NULL;
401
402     if (!filter)
403         return AVERROR(EINVAL);
404
405     ret = av_mallocz(sizeof(AVFilterContext));
406
407     ret->av_class = &avfilter_class;
408     ret->filter   = filter;
409     ret->name     = inst_name ? av_strdup(inst_name) : NULL;
410     ret->priv     = av_mallocz(filter->priv_size);
411
412     ret->input_count  = pad_count(filter->inputs);
413     if (ret->input_count) {
414         ret->input_pads   = av_malloc(sizeof(AVFilterPad) * ret->input_count);
415         memcpy(ret->input_pads, filter->inputs, sizeof(AVFilterPad) * ret->input_count);
416         ret->inputs       = av_mallocz(sizeof(AVFilterLink*) * ret->input_count);
417     }
418
419     ret->output_count = pad_count(filter->outputs);
420     if (ret->output_count) {
421         ret->output_pads  = av_malloc(sizeof(AVFilterPad) * ret->output_count);
422         memcpy(ret->output_pads, filter->outputs, sizeof(AVFilterPad) * ret->output_count);
423         ret->outputs      = av_mallocz(sizeof(AVFilterLink*) * ret->output_count);
424     }
425
426     *filter_ctx = ret;
427     return 0;
428 }
429
430 void avfilter_destroy(AVFilterContext *filter)
431 {
432     int i;
433
434     if(filter->filter->uninit)
435         filter->filter->uninit(filter);
436
437     for(i = 0; i < filter->input_count; i ++) {
438         if(filter->inputs[i]) {
439             if (filter->inputs[i]->src)
440                 filter->inputs[i]->src->outputs[filter->inputs[i]->srcpad] = NULL;
441             avfilter_formats_unref(&filter->inputs[i]->in_formats);
442             avfilter_formats_unref(&filter->inputs[i]->out_formats);
443         }
444         av_freep(&filter->inputs[i]);
445     }
446     for(i = 0; i < filter->output_count; i ++) {
447         if(filter->outputs[i]) {
448             if (filter->outputs[i]->dst)
449                 filter->outputs[i]->dst->inputs[filter->outputs[i]->dstpad] = NULL;
450             avfilter_formats_unref(&filter->outputs[i]->in_formats);
451             avfilter_formats_unref(&filter->outputs[i]->out_formats);
452         }
453         av_freep(&filter->outputs[i]);
454     }
455
456     av_freep(&filter->name);
457     av_freep(&filter->input_pads);
458     av_freep(&filter->output_pads);
459     av_freep(&filter->inputs);
460     av_freep(&filter->outputs);
461     av_freep(&filter->priv);
462     av_free(filter);
463 }
464
465 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque)
466 {
467     int ret=0;
468
469     if(filter->filter->init)
470         ret = filter->filter->init(filter, args, opaque);
471     return ret;
472 }
473