lavfi/frei0r: correctly handle paths longer than 1023 chars
[ffmpeg.git] / libavfilter / vf_frei0r.c
1 /*
2  * Copyright (c) 2010 Stefano Sabatini
3  * This file is part of FFmpeg.
4  *
5  * FFmpeg is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * FFmpeg is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with FFmpeg; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18  */
19
20 /**
21  * @file
22  * frei0r wrapper
23  */
24
25 /* #define DEBUG */
26
27 #include <dlfcn.h>
28 #include <frei0r.h>
29 #include <stdio.h>
30 #include <string.h>
31 #include <stdlib.h>
32 #include "config.h"
33 #include "libavutil/avstring.h"
34 #include "libavutil/imgutils.h"
35 #include "libavutil/internal.h"
36 #include "libavutil/mathematics.h"
37 #include "libavutil/mem.h"
38 #include "libavutil/parseutils.h"
39 #include "avfilter.h"
40 #include "formats.h"
41 #include "internal.h"
42 #include "video.h"
43
44 typedef f0r_instance_t (*f0r_construct_f)(unsigned int width, unsigned int height);
45 typedef void (*f0r_destruct_f)(f0r_instance_t instance);
46 typedef void (*f0r_deinit_f)(void);
47 typedef int (*f0r_init_f)(void);
48 typedef void (*f0r_get_plugin_info_f)(f0r_plugin_info_t *info);
49 typedef void (*f0r_get_param_info_f)(f0r_param_info_t *info, int param_index);
50 typedef void (*f0r_update_f)(f0r_instance_t instance, double time, const uint32_t *inframe, uint32_t *outframe);
51 typedef void (*f0r_update2_f)(f0r_instance_t instance, double time, const uint32_t *inframe1, const uint32_t *inframe2, const uint32_t *inframe3, uint32_t *outframe);
52 typedef void (*f0r_set_param_value_f)(f0r_instance_t instance, f0r_param_t param, int param_index);
53 typedef void (*f0r_get_param_value_f)(f0r_instance_t instance, f0r_param_t param, int param_index);
54
55 typedef struct Frei0rContext {
56     f0r_update_f update;
57     void *dl_handle;            /* dynamic library handle   */
58     f0r_instance_t instance;
59     f0r_plugin_info_t plugin_info;
60
61     f0r_get_param_info_f  get_param_info;
62     f0r_get_param_value_f get_param_value;
63     f0r_set_param_value_f set_param_value;
64     f0r_construct_f       construct;
65     f0r_destruct_f        destruct;
66     f0r_deinit_f          deinit;
67     char params[256];
68
69     /* only used by the source */
70     int w, h;
71     AVRational time_base;
72     uint64_t pts;
73 } Frei0rContext;
74
75 static void *load_sym(AVFilterContext *ctx, const char *sym_name)
76 {
77     Frei0rContext *frei0r = ctx->priv;
78     void *sym = dlsym(frei0r->dl_handle, sym_name);
79     if (!sym)
80         av_log(ctx, AV_LOG_ERROR, "Could not find symbol '%s' in loaded module\n", sym_name);
81     return sym;
82 }
83
84 static int set_param(AVFilterContext *ctx, f0r_param_info_t info, int index, char *param)
85 {
86     Frei0rContext *frei0r = ctx->priv;
87     union {
88         double d;
89         f0r_param_color_t col;
90         f0r_param_position_t pos;
91     } val;
92     char *tail;
93     uint8_t rgba[4];
94
95     switch (info.type) {
96     case F0R_PARAM_BOOL:
97         if      (!strcmp(param, "y")) val.d = 1.0;
98         else if (!strcmp(param, "n")) val.d = 0.0;
99         else goto fail;
100         break;
101
102     case F0R_PARAM_DOUBLE:
103         val.d = strtod(param, &tail);
104         if (*tail || val.d == HUGE_VAL)
105             goto fail;
106         break;
107
108     case F0R_PARAM_COLOR:
109         if (sscanf(param, "%f/%f/%f", &val.col.r, &val.col.g, &val.col.b) != 3) {
110             if (av_parse_color(rgba, param, -1, ctx) < 0)
111                 goto fail;
112             val.col.r = rgba[0] / 255.0;
113             val.col.g = rgba[1] / 255.0;
114             val.col.b = rgba[2] / 255.0;
115         }
116         break;
117
118     case F0R_PARAM_POSITION:
119         if (sscanf(param, "%lf/%lf", &val.pos.x, &val.pos.y) != 2)
120             goto fail;
121         break;
122     }
123
124     frei0r->set_param_value(frei0r->instance, &val, index);
125     return 0;
126
127 fail:
128     av_log(ctx, AV_LOG_ERROR, "Invalid value '%s' for parameter '%s'\n",
129            param, info.name);
130     return AVERROR(EINVAL);
131 }
132
133 static int set_params(AVFilterContext *ctx, const char *params)
134 {
135     Frei0rContext *frei0r = ctx->priv;
136     int i;
137
138     for (i = 0; i < frei0r->plugin_info.num_params; i++) {
139         f0r_param_info_t info;
140         char *param;
141         int ret;
142
143         frei0r->get_param_info(&info, i);
144
145         if (*params) {
146             if (!(param = av_get_token(&params, ":")))
147                 return AVERROR(ENOMEM);
148             params++;               /* skip ':' */
149             ret = set_param(ctx, info, i, param);
150             av_free(param);
151             if (ret < 0)
152                 return ret;
153         }
154
155         av_log(ctx, AV_LOG_VERBOSE,
156                "idx:%d name:'%s' type:%s explanation:'%s' ",
157                i, info.name,
158                info.type == F0R_PARAM_BOOL     ? "bool"     :
159                info.type == F0R_PARAM_DOUBLE   ? "double"   :
160                info.type == F0R_PARAM_COLOR    ? "color"    :
161                info.type == F0R_PARAM_POSITION ? "position" :
162                info.type == F0R_PARAM_STRING   ? "string"   : "unknown",
163                info.explanation);
164
165 #ifdef DEBUG
166         av_log(ctx, AV_LOG_DEBUG, "value:");
167         switch (info.type) {
168             void *v;
169             double d;
170             char s[128];
171             f0r_param_color_t col;
172             f0r_param_position_t pos;
173
174         case F0R_PARAM_BOOL:
175             v = &d;
176             frei0r->get_param_value(frei0r->instance, v, i);
177             av_log(ctx, AV_LOG_DEBUG, "%s", d >= 0.5 && d <= 1.0 ? "y" : "n");
178             break;
179         case F0R_PARAM_DOUBLE:
180             v = &d;
181             frei0r->get_param_value(frei0r->instance, v, i);
182             av_log(ctx, AV_LOG_DEBUG, "%f", d);
183             break;
184         case F0R_PARAM_COLOR:
185             v = &col;
186             frei0r->get_param_value(frei0r->instance, v, i);
187             av_log(ctx, AV_LOG_DEBUG, "%f/%f/%f", col.r, col.g, col.b);
188             break;
189         case F0R_PARAM_POSITION:
190             v = &pos;
191             frei0r->get_param_value(frei0r->instance, v, i);
192             av_log(ctx, AV_LOG_DEBUG, "%lf/%lf", pos.x, pos.y);
193             break;
194         default: /* F0R_PARAM_STRING */
195             v = s;
196             frei0r->get_param_value(frei0r->instance, v, i);
197             av_log(ctx, AV_LOG_DEBUG, "'%s'\n", s);
198             break;
199         }
200 #endif
201         av_log(ctx, AV_LOG_VERBOSE, "\n");
202     }
203
204     return 0;
205 }
206
207 static void *load_path(AVFilterContext *ctx, const char *prefix, const char *name)
208 {
209     char path[1024];
210
211     snprintf(path, sizeof(path), "%s%s%s", prefix, name, SLIBSUF);
212     av_log(ctx, AV_LOG_DEBUG, "Looking for frei0r effect in '%s'\n", path);
213     return dlopen(path, RTLD_NOW|RTLD_LOCAL);
214 }
215
216 static av_cold int frei0r_init(AVFilterContext *ctx,
217                                const char *dl_name, int type)
218 {
219     Frei0rContext *frei0r = ctx->priv;
220     f0r_init_f            f0r_init;
221     f0r_get_plugin_info_f f0r_get_plugin_info;
222     f0r_plugin_info_t *pi;
223     char *path;
224
225     /* see: http://frei0r.dyne.org/codedoc/html/group__pluglocations.html */
226     if ((path = av_strdup(getenv("FREI0R_PATH")))) {
227 #ifdef _WIN32
228         const char *separator = ";";
229 #else
230         const char *separator = ":";
231 #endif
232         char *p, *ptr = NULL;
233         for (p = path; p = av_strtok(p, separator, &ptr); p = NULL)
234             if (frei0r->dl_handle = load_path(ctx, p, dl_name))
235                 break;
236         av_free(path);
237     }
238     if (!frei0r->dl_handle && (path = getenv("HOME"))) {
239         char *prefix = av_asprintf("%s/.frei0r-1/lib/", path);
240         if (!prefix)
241             return AVERROR(ENOMEM);
242         frei0r->dl_handle = load_path(ctx, prefix, dl_name);
243         av_free(prefix);
244     }
245     if (!frei0r->dl_handle)
246         frei0r->dl_handle = load_path(ctx, "/usr/local/lib/frei0r-1/", dl_name);
247     if (!frei0r->dl_handle)
248         frei0r->dl_handle = load_path(ctx, "/usr/lib/frei0r-1/", dl_name);
249     if (!frei0r->dl_handle) {
250         av_log(ctx, AV_LOG_ERROR, "Could not find module '%s'\n", dl_name);
251         return AVERROR(EINVAL);
252     }
253
254     if (!(f0r_init                = load_sym(ctx, "f0r_init"           )) ||
255         !(f0r_get_plugin_info     = load_sym(ctx, "f0r_get_plugin_info")) ||
256         !(frei0r->get_param_info  = load_sym(ctx, "f0r_get_param_info" )) ||
257         !(frei0r->get_param_value = load_sym(ctx, "f0r_get_param_value")) ||
258         !(frei0r->set_param_value = load_sym(ctx, "f0r_set_param_value")) ||
259         !(frei0r->update          = load_sym(ctx, "f0r_update"         )) ||
260         !(frei0r->construct       = load_sym(ctx, "f0r_construct"      )) ||
261         !(frei0r->destruct        = load_sym(ctx, "f0r_destruct"       )) ||
262         !(frei0r->deinit          = load_sym(ctx, "f0r_deinit"         )))
263         return AVERROR(EINVAL);
264
265     if (f0r_init() < 0) {
266         av_log(ctx, AV_LOG_ERROR, "Could not init the frei0r module\n");
267         return AVERROR(EINVAL);
268     }
269
270     f0r_get_plugin_info(&frei0r->plugin_info);
271     pi = &frei0r->plugin_info;
272     if (pi->plugin_type != type) {
273         av_log(ctx, AV_LOG_ERROR,
274                "Invalid type '%s' for the plugin\n",
275                pi->plugin_type == F0R_PLUGIN_TYPE_FILTER ? "filter" :
276                pi->plugin_type == F0R_PLUGIN_TYPE_SOURCE ? "source" :
277                pi->plugin_type == F0R_PLUGIN_TYPE_MIXER2 ? "mixer2" :
278                pi->plugin_type == F0R_PLUGIN_TYPE_MIXER3 ? "mixer3" : "unknown");
279         return AVERROR(EINVAL);
280     }
281
282     av_log(ctx, AV_LOG_VERBOSE,
283            "name:%s author:'%s' explanation:'%s' color_model:%s "
284            "frei0r_version:%d version:%d.%d num_params:%d\n",
285            pi->name, pi->author, pi->explanation,
286            pi->color_model == F0R_COLOR_MODEL_BGRA8888 ? "bgra8888" :
287            pi->color_model == F0R_COLOR_MODEL_RGBA8888 ? "rgba8888" :
288            pi->color_model == F0R_COLOR_MODEL_PACKED32 ? "packed32" : "unknown",
289            pi->frei0r_version, pi->major_version, pi->minor_version, pi->num_params);
290
291     return 0;
292 }
293
294 static av_cold int filter_init(AVFilterContext *ctx, const char *args)
295 {
296     Frei0rContext *frei0r = ctx->priv;
297     char dl_name[1024], c;
298     *frei0r->params = 0;
299
300     if (args)
301         sscanf(args, "%1023[^:=]%c%255c", dl_name, &c, frei0r->params);
302
303     return frei0r_init(ctx, dl_name, F0R_PLUGIN_TYPE_FILTER);
304 }
305
306 static av_cold void uninit(AVFilterContext *ctx)
307 {
308     Frei0rContext *frei0r = ctx->priv;
309
310     if (frei0r->destruct && frei0r->instance)
311         frei0r->destruct(frei0r->instance);
312     if (frei0r->deinit)
313         frei0r->deinit();
314     if (frei0r->dl_handle)
315         dlclose(frei0r->dl_handle);
316
317     memset(frei0r, 0, sizeof(*frei0r));
318 }
319
320 static int config_input_props(AVFilterLink *inlink)
321 {
322     AVFilterContext *ctx = inlink->dst;
323     Frei0rContext *frei0r = ctx->priv;
324
325     if (!(frei0r->instance = frei0r->construct(inlink->w, inlink->h))) {
326         av_log(ctx, AV_LOG_ERROR, "Impossible to load frei0r instance\n");
327         return AVERROR(EINVAL);
328     }
329
330     return set_params(ctx, frei0r->params);
331 }
332
333 static int query_formats(AVFilterContext *ctx)
334 {
335     Frei0rContext *frei0r = ctx->priv;
336     AVFilterFormats *formats = NULL;
337
338     if        (frei0r->plugin_info.color_model == F0R_COLOR_MODEL_BGRA8888) {
339         ff_add_format(&formats, AV_PIX_FMT_BGRA);
340     } else if (frei0r->plugin_info.color_model == F0R_COLOR_MODEL_RGBA8888) {
341         ff_add_format(&formats, AV_PIX_FMT_RGBA);
342     } else {                                   /* F0R_COLOR_MODEL_PACKED32 */
343         static const enum AVPixelFormat pix_fmts[] = {
344             AV_PIX_FMT_BGRA, AV_PIX_FMT_ARGB, AV_PIX_FMT_ABGR, AV_PIX_FMT_ARGB, AV_PIX_FMT_NONE
345         };
346         formats = ff_make_format_list(pix_fmts);
347     }
348
349     if (!formats)
350         return AVERROR(ENOMEM);
351
352     ff_set_common_formats(ctx, formats);
353     return 0;
354 }
355
356 static int null_draw_slice(AVFilterLink *inlink, int y, int h, int slice_dir)
357 {
358     return 0;
359 }
360
361 static int end_frame(AVFilterLink *inlink)
362 {
363     Frei0rContext *frei0r = inlink->dst->priv;
364     AVFilterLink *outlink = inlink->dst->outputs[0];
365     AVFilterBufferRef  *inpicref =  inlink->cur_buf;
366     AVFilterBufferRef *outpicref = outlink->out_buf;
367     int ret;
368
369     frei0r->update(frei0r->instance, inpicref->pts * av_q2d(inlink->time_base) * 1000,
370                    (const uint32_t *)inpicref->data[0],
371                    (uint32_t *)outpicref->data[0]);
372     if ((ret = ff_draw_slice(outlink, 0, outlink->h, 1)) ||
373         (ret = ff_end_frame(outlink)) < 0)
374         return ret;
375     return 0;
376 }
377
378 static const AVFilterPad avfilter_vf_frei0r_inputs[] = {
379     {
380         .name         = "default",
381         .type         = AVMEDIA_TYPE_VIDEO,
382         .draw_slice   = null_draw_slice,
383         .config_props = config_input_props,
384         .end_frame    = end_frame,
385         .min_perms    = AV_PERM_READ
386     },
387     { NULL }
388 };
389
390 static const AVFilterPad avfilter_vf_frei0r_outputs[] = {
391     {
392         .name = "default",
393         .type = AVMEDIA_TYPE_VIDEO,
394     },
395     { NULL }
396 };
397
398 AVFilter avfilter_vf_frei0r = {
399     .name      = "frei0r",
400     .description = NULL_IF_CONFIG_SMALL("Apply a frei0r effect."),
401
402     .query_formats = query_formats,
403     .init = filter_init,
404     .uninit = uninit,
405
406     .priv_size = sizeof(Frei0rContext),
407
408     .inputs    = avfilter_vf_frei0r_inputs,
409
410     .outputs   = avfilter_vf_frei0r_outputs,
411 };
412
413 static av_cold int source_init(AVFilterContext *ctx, const char *args)
414 {
415     Frei0rContext *frei0r = ctx->priv;
416     char dl_name[1024], c;
417     char frame_size[128] = "";
418     char frame_rate[128] = "";
419     AVRational frame_rate_q;
420
421     memset(frei0r->params, 0, sizeof(frei0r->params));
422
423     if (args)
424         sscanf(args, "%127[^:]:%127[^:]:%1023[^:=]%c%255c",
425                frame_size, frame_rate, dl_name, &c, frei0r->params);
426
427     if (av_parse_video_size(&frei0r->w, &frei0r->h, frame_size) < 0) {
428         av_log(ctx, AV_LOG_ERROR, "Invalid frame size: '%s'\n", frame_size);
429         return AVERROR(EINVAL);
430     }
431
432     if (av_parse_video_rate(&frame_rate_q, frame_rate) < 0) {
433         av_log(ctx, AV_LOG_ERROR, "Invalid frame rate: '%s'\n", frame_rate);
434         return AVERROR(EINVAL);
435     }
436     frei0r->time_base.num = frame_rate_q.den;
437     frei0r->time_base.den = frame_rate_q.num;
438
439     return frei0r_init(ctx, dl_name, F0R_PLUGIN_TYPE_SOURCE);
440 }
441
442 static int source_config_props(AVFilterLink *outlink)
443 {
444     AVFilterContext *ctx = outlink->src;
445     Frei0rContext *frei0r = ctx->priv;
446
447     if (av_image_check_size(frei0r->w, frei0r->h, 0, ctx) < 0)
448         return AVERROR(EINVAL);
449     outlink->w = frei0r->w;
450     outlink->h = frei0r->h;
451     outlink->time_base = frei0r->time_base;
452     outlink->sample_aspect_ratio = (AVRational){1,1};
453
454     if (!(frei0r->instance = frei0r->construct(outlink->w, outlink->h))) {
455         av_log(ctx, AV_LOG_ERROR, "Impossible to load frei0r instance\n");
456         return AVERROR(EINVAL);
457     }
458
459     return set_params(ctx, frei0r->params);
460 }
461
462 static int source_request_frame(AVFilterLink *outlink)
463 {
464     Frei0rContext *frei0r = outlink->src->priv;
465     AVFilterBufferRef *picref = ff_get_video_buffer(outlink, AV_PERM_WRITE, outlink->w, outlink->h);
466     AVFilterBufferRef *buf_out;
467     int ret;
468
469     if (!picref)
470         return AVERROR(ENOMEM);
471
472     picref->video->sample_aspect_ratio = (AVRational) {1, 1};
473     picref->pts = frei0r->pts++;
474     picref->pos = -1;
475
476     buf_out = avfilter_ref_buffer(picref, ~0);
477     if (!buf_out) {
478         ret = AVERROR(ENOMEM);
479         goto fail;
480     }
481
482     ret = ff_start_frame(outlink, buf_out);
483     if (ret < 0)
484         goto fail;
485
486     frei0r->update(frei0r->instance, av_rescale_q(picref->pts, frei0r->time_base, (AVRational){1,1000}),
487                    NULL, (uint32_t *)picref->data[0]);
488     ret = ff_draw_slice(outlink, 0, outlink->h, 1);
489     if (ret < 0)
490         goto fail;
491
492     ret = ff_end_frame(outlink);
493
494 fail:
495     avfilter_unref_buffer(picref);
496
497     return ret;
498 }
499
500 static const AVFilterPad avfilter_vsrc_frei0r_src_outputs[] = {
501     {
502         .name          = "default",
503         .type          = AVMEDIA_TYPE_VIDEO,
504         .request_frame = source_request_frame,
505         .config_props  = source_config_props
506     },
507     { NULL }
508 };
509
510 AVFilter avfilter_vsrc_frei0r_src = {
511     .name        = "frei0r_src",
512     .description = NULL_IF_CONFIG_SMALL("Generate a frei0r source."),
513
514     .priv_size = sizeof(Frei0rContext),
515     .init      = source_init,
516     .uninit    = uninit,
517
518     .query_formats = query_formats,
519
520     .inputs    = NULL,
521
522     .outputs   = avfilter_vsrc_frei0r_src_outputs,
523 };