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