2 * Copyright (c) 2010 Stefano Sabatini
3 * This file is part of FFmpeg.
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.
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.
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
31 #include "libavutil/avstring.h"
32 #include "libavutil/imgutils.h"
33 #include "libavutil/internal.h"
34 #include "libavutil/mathematics.h"
35 #include "libavutil/mem.h"
36 #include "libavutil/opt.h"
37 #include "libavutil/parseutils.h"
43 typedef f0r_instance_t (*f0r_construct_f)(unsigned int width, unsigned int height);
44 typedef void (*f0r_destruct_f)(f0r_instance_t instance);
45 typedef void (*f0r_deinit_f)(void);
46 typedef int (*f0r_init_f)(void);
47 typedef void (*f0r_get_plugin_info_f)(f0r_plugin_info_t *info);
48 typedef void (*f0r_get_param_info_f)(f0r_param_info_t *info, int param_index);
49 typedef void (*f0r_update_f)(f0r_instance_t instance, double time, const uint32_t *inframe, uint32_t *outframe);
50 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);
51 typedef void (*f0r_set_param_value_f)(f0r_instance_t instance, f0r_param_t param, int param_index);
52 typedef void (*f0r_get_param_value_f)(f0r_instance_t instance, f0r_param_t param, int param_index);
54 typedef struct Frei0rContext {
57 void *dl_handle; /* dynamic library handle */
58 f0r_instance_t instance;
59 f0r_plugin_info_t plugin_info;
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;
72 /* only used by the source */
78 static void *load_sym(AVFilterContext *ctx, const char *sym_name)
80 Frei0rContext *s = ctx->priv;
81 void *sym = dlsym(s->dl_handle, sym_name);
83 av_log(ctx, AV_LOG_ERROR, "Could not find symbol '%s' in loaded module\n", sym_name);
87 static int set_param(AVFilterContext *ctx, f0r_param_info_t info, int index, char *param)
89 Frei0rContext *s = ctx->priv;
92 f0r_param_color_t col;
93 f0r_param_position_t pos;
100 if (!strcmp(param, "y")) val.d = 1.0;
101 else if (!strcmp(param, "n")) val.d = 0.0;
105 case F0R_PARAM_DOUBLE:
106 val.d = strtod(param, &tail);
107 if (*tail || val.d == HUGE_VAL)
111 case F0R_PARAM_COLOR:
112 if (sscanf(param, "%f/%f/%f", &val.col.r, &val.col.g, &val.col.b) != 3) {
113 if (av_parse_color(rgba, param, -1, ctx) < 0)
115 val.col.r = rgba[0] / 255.0;
116 val.col.g = rgba[1] / 255.0;
117 val.col.b = rgba[2] / 255.0;
121 case F0R_PARAM_POSITION:
122 if (sscanf(param, "%lf/%lf", &val.pos.x, &val.pos.y) != 2)
127 s->set_param_value(s->instance, &val, index);
131 av_log(ctx, AV_LOG_ERROR, "Invalid value '%s' for parameter '%s'\n",
133 return AVERROR(EINVAL);
136 static int set_params(AVFilterContext *ctx, const char *params)
138 Frei0rContext *s = ctx->priv;
144 for (i = 0; i < s->plugin_info.num_params; i++) {
145 f0r_param_info_t info;
149 s->get_param_info(&info, i);
152 if (!(param = av_get_token(¶ms, "|")))
153 return AVERROR(ENOMEM);
155 params++; /* skip ':' */
156 ret = set_param(ctx, info, i, param);
162 av_log(ctx, AV_LOG_VERBOSE,
163 "idx:%d name:'%s' type:%s explanation:'%s' ",
165 info.type == F0R_PARAM_BOOL ? "bool" :
166 info.type == F0R_PARAM_DOUBLE ? "double" :
167 info.type == F0R_PARAM_COLOR ? "color" :
168 info.type == F0R_PARAM_POSITION ? "position" :
169 info.type == F0R_PARAM_STRING ? "string" : "unknown",
173 av_log(ctx, AV_LOG_DEBUG, "value:");
178 f0r_param_color_t col;
179 f0r_param_position_t pos;
183 s->get_param_value(s->instance, v, i);
184 av_log(ctx, AV_LOG_DEBUG, "%s", d >= 0.5 && d <= 1.0 ? "y" : "n");
186 case F0R_PARAM_DOUBLE:
188 s->get_param_value(s->instance, v, i);
189 av_log(ctx, AV_LOG_DEBUG, "%f", d);
191 case F0R_PARAM_COLOR:
193 s->get_param_value(s->instance, v, i);
194 av_log(ctx, AV_LOG_DEBUG, "%f/%f/%f", col.r, col.g, col.b);
196 case F0R_PARAM_POSITION:
198 s->get_param_value(s->instance, v, i);
199 av_log(ctx, AV_LOG_DEBUG, "%f/%f", pos.x, pos.y);
201 default: /* F0R_PARAM_STRING */
203 s->get_param_value(s->instance, v, i);
204 av_log(ctx, AV_LOG_DEBUG, "'%s'\n", s);
208 av_log(ctx, AV_LOG_VERBOSE, "\n");
214 static int load_path(AVFilterContext *ctx, void **handle_ptr, const char *prefix, const char *name)
216 char *path = av_asprintf("%s%s%s", prefix, name, SLIBSUF);
218 return AVERROR(ENOMEM);
219 av_log(ctx, AV_LOG_DEBUG, "Looking for frei0r effect in '%s'\n", path);
220 *handle_ptr = dlopen(path, RTLD_NOW|RTLD_LOCAL);
225 static av_cold int frei0r_init(AVFilterContext *ctx,
226 const char *dl_name, int type)
228 Frei0rContext *s = ctx->priv;
230 f0r_get_plugin_info_f f0r_get_plugin_info;
231 f0r_plugin_info_t *pi;
236 av_log(ctx, AV_LOG_ERROR, "No filter name provided.\n");
237 return AVERROR(EINVAL);
240 /* see: http://frei0r.dyne.org/codedoc/html/group__pluglocations.html */
241 if ((path = av_strdup(getenv("FREI0R_PATH")))) {
243 const char *separator = ";";
245 const char *separator = ":";
247 char *p, *ptr = NULL;
248 for (p = path; p = av_strtok(p, separator, &ptr); p = NULL) {
249 /* add additional trailing slash in case it is missing */
250 char *p1 = av_asprintf("%s/", p);
252 ret = AVERROR(ENOMEM);
255 ret = load_path(ctx, &s->dl_handle, p1, dl_name);
268 if (!s->dl_handle && (path = getenv("HOME"))) {
269 char *prefix = av_asprintf("%s/.frei0r-1/lib/", path);
271 return AVERROR(ENOMEM);
272 ret = load_path(ctx, &s->dl_handle, prefix, dl_name);
278 ret = load_path(ctx, &s->dl_handle, "/usr/local/lib/frei0r-1/", dl_name);
283 ret = load_path(ctx, &s->dl_handle, "/usr/lib/frei0r-1/", dl_name);
288 av_log(ctx, AV_LOG_ERROR, "Could not find module '%s'\n", dl_name);
289 return AVERROR(EINVAL);
292 if (!(f0r_init = load_sym(ctx, "f0r_init" )) ||
293 !(f0r_get_plugin_info = load_sym(ctx, "f0r_get_plugin_info")) ||
294 !(s->get_param_info = load_sym(ctx, "f0r_get_param_info" )) ||
295 !(s->get_param_value = load_sym(ctx, "f0r_get_param_value")) ||
296 !(s->set_param_value = load_sym(ctx, "f0r_set_param_value")) ||
297 !(s->update = load_sym(ctx, "f0r_update" )) ||
298 !(s->construct = load_sym(ctx, "f0r_construct" )) ||
299 !(s->destruct = load_sym(ctx, "f0r_destruct" )) ||
300 !(s->deinit = load_sym(ctx, "f0r_deinit" )))
301 return AVERROR(EINVAL);
303 if (f0r_init() < 0) {
304 av_log(ctx, AV_LOG_ERROR, "Could not init the frei0r module\n");
305 return AVERROR(EINVAL);
308 f0r_get_plugin_info(&s->plugin_info);
309 pi = &s->plugin_info;
310 if (pi->plugin_type != type) {
311 av_log(ctx, AV_LOG_ERROR,
312 "Invalid type '%s' for the plugin\n",
313 pi->plugin_type == F0R_PLUGIN_TYPE_FILTER ? "filter" :
314 pi->plugin_type == F0R_PLUGIN_TYPE_SOURCE ? "source" :
315 pi->plugin_type == F0R_PLUGIN_TYPE_MIXER2 ? "mixer2" :
316 pi->plugin_type == F0R_PLUGIN_TYPE_MIXER3 ? "mixer3" : "unknown");
317 return AVERROR(EINVAL);
320 av_log(ctx, AV_LOG_VERBOSE,
321 "name:%s author:'%s' explanation:'%s' color_model:%s "
322 "frei0r_version:%d version:%d.%d num_params:%d\n",
323 pi->name, pi->author, pi->explanation,
324 pi->color_model == F0R_COLOR_MODEL_BGRA8888 ? "bgra8888" :
325 pi->color_model == F0R_COLOR_MODEL_RGBA8888 ? "rgba8888" :
326 pi->color_model == F0R_COLOR_MODEL_PACKED32 ? "packed32" : "unknown",
327 pi->frei0r_version, pi->major_version, pi->minor_version, pi->num_params);
332 static av_cold int filter_init(AVFilterContext *ctx)
334 Frei0rContext *s = ctx->priv;
336 return frei0r_init(ctx, s->dl_name, F0R_PLUGIN_TYPE_FILTER);
339 static av_cold void uninit(AVFilterContext *ctx)
341 Frei0rContext *s = ctx->priv;
343 if (s->destruct && s->instance)
344 s->destruct(s->instance);
348 dlclose(s->dl_handle);
351 static int config_input_props(AVFilterLink *inlink)
353 AVFilterContext *ctx = inlink->dst;
354 Frei0rContext *s = ctx->priv;
356 if (s->destruct && s->instance)
357 s->destruct(s->instance);
358 if (!(s->instance = s->construct(inlink->w, inlink->h))) {
359 av_log(ctx, AV_LOG_ERROR, "Impossible to load frei0r instance\n");
360 return AVERROR(EINVAL);
363 return set_params(ctx, s->params);
366 static int query_formats(AVFilterContext *ctx)
368 Frei0rContext *s = ctx->priv;
369 AVFilterFormats *formats = NULL;
371 if (s->plugin_info.color_model == F0R_COLOR_MODEL_BGRA8888) {
372 ff_add_format(&formats, AV_PIX_FMT_BGRA);
373 } else if (s->plugin_info.color_model == F0R_COLOR_MODEL_RGBA8888) {
374 ff_add_format(&formats, AV_PIX_FMT_RGBA);
375 } else { /* F0R_COLOR_MODEL_PACKED32 */
376 static const enum AVPixelFormat pix_fmts[] = {
377 AV_PIX_FMT_BGRA, AV_PIX_FMT_ARGB, AV_PIX_FMT_ABGR, AV_PIX_FMT_ARGB, AV_PIX_FMT_NONE
379 formats = ff_make_format_list(pix_fmts);
383 return AVERROR(ENOMEM);
385 ff_set_common_formats(ctx, formats);
389 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
391 Frei0rContext *s = inlink->dst->priv;
392 AVFilterLink *outlink = inlink->dst->outputs[0];
395 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
398 return AVERROR(ENOMEM);
400 av_frame_copy_props(out, in);
402 s->update(s->instance, in->pts * av_q2d(inlink->time_base) * 1000,
403 (const uint32_t *)in->data[0],
404 (uint32_t *)out->data[0]);
408 return ff_filter_frame(outlink, out);
411 #define OFFSET(x) offsetof(Frei0rContext, x)
412 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_FILTERING_PARAM
413 static const AVOption frei0r_options[] = {
414 { "filter_name", NULL, OFFSET(dl_name), AV_OPT_TYPE_STRING, .flags = FLAGS },
415 { "filter_params", NULL, OFFSET(params), AV_OPT_TYPE_STRING, .flags = FLAGS },
419 AVFILTER_DEFINE_CLASS(frei0r);
421 static const AVFilterPad avfilter_vf_frei0r_inputs[] = {
424 .type = AVMEDIA_TYPE_VIDEO,
425 .config_props = config_input_props,
426 .filter_frame = filter_frame,
431 static const AVFilterPad avfilter_vf_frei0r_outputs[] = {
434 .type = AVMEDIA_TYPE_VIDEO,
439 AVFilter avfilter_vf_frei0r = {
441 .description = NULL_IF_CONFIG_SMALL("Apply a frei0r effect."),
442 .query_formats = query_formats,
445 .priv_size = sizeof(Frei0rContext),
446 .priv_class = &frei0r_class,
447 .inputs = avfilter_vf_frei0r_inputs,
448 .outputs = avfilter_vf_frei0r_outputs,
451 static av_cold int source_init(AVFilterContext *ctx)
453 Frei0rContext *s = ctx->priv;
455 s->time_base.num = s->framerate.den;
456 s->time_base.den = s->framerate.num;
458 return frei0r_init(ctx, s->dl_name, F0R_PLUGIN_TYPE_SOURCE);
461 static int source_config_props(AVFilterLink *outlink)
463 AVFilterContext *ctx = outlink->src;
464 Frei0rContext *s = ctx->priv;
466 if (av_image_check_size(s->w, s->h, 0, ctx) < 0)
467 return AVERROR(EINVAL);
470 outlink->time_base = s->time_base;
471 outlink->sample_aspect_ratio = (AVRational){1,1};
473 if (s->destruct && s->instance)
474 s->destruct(s->instance);
475 if (!(s->instance = s->construct(outlink->w, outlink->h))) {
476 av_log(ctx, AV_LOG_ERROR, "Impossible to load frei0r instance\n");
477 return AVERROR(EINVAL);
480 return set_params(ctx, s->params);
483 static int source_request_frame(AVFilterLink *outlink)
485 Frei0rContext *s = outlink->src->priv;
486 AVFrame *frame = ff_get_video_buffer(outlink, outlink->w, outlink->h);
489 return AVERROR(ENOMEM);
491 frame->sample_aspect_ratio = (AVRational) {1, 1};
492 frame->pts = s->pts++;
494 s->update(s->instance, av_rescale_q(frame->pts, s->time_base, (AVRational){1,1000}),
495 NULL, (uint32_t *)frame->data[0]);
497 return ff_filter_frame(outlink, frame);
500 static const AVOption frei0r_src_options[] = {
501 { "size", "Dimensions of the generated video.", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, { .str = "320x240" }, .flags = FLAGS },
502 { "framerate", NULL, OFFSET(framerate), AV_OPT_TYPE_VIDEO_RATE, { .str = "25" }, .flags = FLAGS },
503 { "filter_name", NULL, OFFSET(dl_name), AV_OPT_TYPE_STRING, .flags = FLAGS },
504 { "filter_params", NULL, OFFSET(params), AV_OPT_TYPE_STRING, .flags = FLAGS },
508 AVFILTER_DEFINE_CLASS(frei0r_src);
510 static const AVFilterPad avfilter_vsrc_frei0r_src_outputs[] = {
513 .type = AVMEDIA_TYPE_VIDEO,
514 .request_frame = source_request_frame,
515 .config_props = source_config_props
520 AVFilter avfilter_vsrc_frei0r_src = {
521 .name = "frei0r_src",
522 .description = NULL_IF_CONFIG_SMALL("Generate a frei0r source."),
523 .priv_size = sizeof(Frei0rContext),
524 .priv_class = &frei0r_src_class,
527 .query_formats = query_formats,
529 .outputs = avfilter_vsrc_frei0r_src_outputs,