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