2 * Copyright (c) 2010 Stefano Sabatini
3 * This file is part of Libav.
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.
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.
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
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;
73 /* only used by the source */
79 static void *load_sym(AVFilterContext *ctx, const char *sym_name)
81 Frei0rContext *s = ctx->priv;
82 void *sym = dlsym(s->dl_handle, sym_name);
84 av_log(ctx, AV_LOG_ERROR, "Could not find symbol '%s' in loaded module.\n", sym_name);
88 static int set_param(AVFilterContext *ctx, f0r_param_info_t info, int index, char *param)
90 Frei0rContext *s = ctx->priv;
93 f0r_param_color_t col;
94 f0r_param_position_t pos;
101 if (!strcmp(param, "y")) val.d = 1.0;
102 else if (!strcmp(param, "n")) val.d = 0.0;
106 case F0R_PARAM_DOUBLE:
107 val.d = strtod(param, &tail);
108 if (*tail || val.d == HUGE_VAL)
112 case F0R_PARAM_COLOR:
113 if (sscanf(param, "%f/%f/%f", &val.col.r, &val.col.g, &val.col.b) != 3) {
114 if (av_parse_color(rgba, param, -1, ctx) < 0)
116 val.col.r = rgba[0] / 255.0;
117 val.col.g = rgba[1] / 255.0;
118 val.col.b = rgba[2] / 255.0;
122 case F0R_PARAM_POSITION:
123 if (sscanf(param, "%lf/%lf", &val.pos.x, &val.pos.y) != 2)
128 s->set_param_value(s->instance, &val, index);
132 av_log(ctx, AV_LOG_ERROR, "Invalid value '%s' for parameter '%s'.\n",
134 return AVERROR(EINVAL);
137 static int set_params(AVFilterContext *ctx, const char *params)
139 Frei0rContext *s = ctx->priv;
142 for (i = 0; i < s->plugin_info.num_params; i++) {
143 f0r_param_info_t info;
147 s->get_param_info(&info, i);
150 if (!(param = av_get_token(¶ms, "|")))
151 return AVERROR(ENOMEM);
152 params++; /* skip ':' */
153 ret = set_param(ctx, info, i, param);
159 av_log(ctx, AV_LOG_VERBOSE,
160 "idx:%d name:'%s' type:%s explanation:'%s' ",
162 info.type == F0R_PARAM_BOOL ? "bool" :
163 info.type == F0R_PARAM_DOUBLE ? "double" :
164 info.type == F0R_PARAM_COLOR ? "color" :
165 info.type == F0R_PARAM_POSITION ? "position" :
166 info.type == F0R_PARAM_STRING ? "string" : "unknown",
170 av_log(ctx, AV_LOG_DEBUG, "value:");
175 f0r_param_color_t col;
176 f0r_param_position_t pos;
180 s->get_param_value(s->instance, v, i);
181 av_log(ctx, AV_LOG_DEBUG, "%s", d >= 0.5 && d <= 1.0 ? "y" : "n");
183 case F0R_PARAM_DOUBLE:
185 s->get_param_value(s->instance, v, i);
186 av_log(ctx, AV_LOG_DEBUG, "%f", d);
188 case F0R_PARAM_COLOR:
190 s->get_param_value(s->instance, v, i);
191 av_log(ctx, AV_LOG_DEBUG, "%f/%f/%f", col.r, col.g, col.b);
193 case F0R_PARAM_POSITION:
195 s->get_param_value(s->instance, v, i);
196 av_log(ctx, AV_LOG_DEBUG, "%f/%f", pos.x, pos.y);
198 default: /* F0R_PARAM_STRING */
200 s->get_param_value(s->instance, v, i);
201 av_log(ctx, AV_LOG_DEBUG, "'%s'", s);
205 av_log(ctx, AV_LOG_VERBOSE, ".\n");
211 static void *load_path(AVFilterContext *ctx, const char *prefix, const char *name)
215 snprintf(path, sizeof(path), "%s%s%s", prefix, name, SLIBSUF);
216 av_log(ctx, AV_LOG_DEBUG, "Looking for frei0r effect in '%s'.\n", path);
217 return dlopen(path, RTLD_NOW|RTLD_LOCAL);
220 static av_cold int frei0r_init(AVFilterContext *ctx,
221 const char *dl_name, int type)
223 Frei0rContext *s = ctx->priv;
225 f0r_get_plugin_info_f f0r_get_plugin_info;
226 f0r_plugin_info_t *pi;
230 av_log(ctx, AV_LOG_ERROR, "No filter name provided.\n");
231 return AVERROR(EINVAL);
234 /* see: http://piksel.org/frei0r/1.2/spec/1.2/spec/group__pluglocations.html */
235 if (path = getenv("FREI0R_PATH")) {
237 char *ptr = av_get_token((const char **)&path, ":");
239 return AVERROR(ENOMEM);
240 s->dl_handle = load_path(ctx, ptr, dl_name);
245 path++; /* skip ':' */
248 if (!s->dl_handle && (path = getenv("HOME"))) {
250 snprintf(prefix, sizeof(prefix), "%s/.frei0r-1/lib/", path);
251 s->dl_handle = load_path(ctx, prefix, dl_name);
254 s->dl_handle = load_path(ctx, "/usr/local/lib/frei0r-1/", dl_name);
256 s->dl_handle = load_path(ctx, "/usr/lib/frei0r-1/", dl_name);
258 av_log(ctx, AV_LOG_ERROR, "Could not find module '%s'.\n", dl_name);
259 return AVERROR(EINVAL);
262 if (!(f0r_init = load_sym(ctx, "f0r_init" )) ||
263 !(f0r_get_plugin_info = load_sym(ctx, "f0r_get_plugin_info")) ||
264 !(s->get_param_info = load_sym(ctx, "f0r_get_param_info" )) ||
265 !(s->get_param_value = load_sym(ctx, "f0r_get_param_value")) ||
266 !(s->set_param_value = load_sym(ctx, "f0r_set_param_value")) ||
267 !(s->update = load_sym(ctx, "f0r_update" )) ||
268 !(s->construct = load_sym(ctx, "f0r_construct" )) ||
269 !(s->destruct = load_sym(ctx, "f0r_destruct" )) ||
270 !(s->deinit = load_sym(ctx, "f0r_deinit" )))
271 return AVERROR(EINVAL);
273 if (f0r_init() < 0) {
274 av_log(ctx, AV_LOG_ERROR, "Could not init the frei0r module.\n");
275 return AVERROR(EINVAL);
278 f0r_get_plugin_info(&s->plugin_info);
279 pi = &s->plugin_info;
280 if (pi->plugin_type != type) {
281 av_log(ctx, AV_LOG_ERROR,
282 "Invalid type '%s' for this plugin\n",
283 pi->plugin_type == F0R_PLUGIN_TYPE_FILTER ? "filter" :
284 pi->plugin_type == F0R_PLUGIN_TYPE_SOURCE ? "source" :
285 pi->plugin_type == F0R_PLUGIN_TYPE_MIXER2 ? "mixer2" :
286 pi->plugin_type == F0R_PLUGIN_TYPE_MIXER3 ? "mixer3" : "unknown");
287 return AVERROR(EINVAL);
290 av_log(ctx, AV_LOG_VERBOSE,
291 "name:%s author:'%s' explanation:'%s' color_model:%s "
292 "frei0r_version:%d version:%d.%d num_params:%d\n",
293 pi->name, pi->author, pi->explanation,
294 pi->color_model == F0R_COLOR_MODEL_BGRA8888 ? "bgra8888" :
295 pi->color_model == F0R_COLOR_MODEL_RGBA8888 ? "rgba8888" :
296 pi->color_model == F0R_COLOR_MODEL_PACKED32 ? "packed32" : "unknown",
297 pi->frei0r_version, pi->major_version, pi->minor_version, pi->num_params);
302 static av_cold int filter_init(AVFilterContext *ctx)
304 Frei0rContext *s = ctx->priv;
306 return frei0r_init(ctx, s->dl_name, F0R_PLUGIN_TYPE_FILTER);
309 static av_cold void uninit(AVFilterContext *ctx)
311 Frei0rContext *s = ctx->priv;
313 if (s->destruct && s->instance)
314 s->destruct(s->instance);
318 dlclose(s->dl_handle);
321 static int config_input_props(AVFilterLink *inlink)
323 AVFilterContext *ctx = inlink->dst;
324 Frei0rContext *s = ctx->priv;
326 if (s->destruct && s->instance)
327 s->destruct(s->instance);
328 if (!(s->instance = s->construct(inlink->w, inlink->h))) {
329 av_log(ctx, AV_LOG_ERROR, "Impossible to load frei0r instance.\n");
330 return AVERROR(EINVAL);
333 return set_params(ctx, s->params);
336 static int query_formats(AVFilterContext *ctx)
338 Frei0rContext *s = ctx->priv;
339 AVFilterFormats *formats = NULL;
341 if (s->plugin_info.color_model == F0R_COLOR_MODEL_BGRA8888) {
342 ff_add_format(&formats, AV_PIX_FMT_BGRA);
343 } else if (s->plugin_info.color_model == F0R_COLOR_MODEL_RGBA8888) {
344 ff_add_format(&formats, AV_PIX_FMT_RGBA);
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_ARGB, AV_PIX_FMT_NONE
349 formats = ff_make_format_list(pix_fmts);
353 return AVERROR(ENOMEM);
355 ff_set_common_formats(ctx, formats);
359 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
361 Frei0rContext *s = inlink->dst->priv;
362 AVFilterLink *outlink = inlink->dst->outputs[0];
365 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
368 return AVERROR(ENOMEM);
370 av_frame_copy_props(out, in);
372 s->update(s->instance, in->pts * av_q2d(inlink->time_base) * 1000,
373 (const uint32_t *)in->data[0],
374 (uint32_t *)out->data[0]);
378 return ff_filter_frame(outlink, out);
381 #define OFFSET(x) offsetof(Frei0rContext, x)
382 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM
383 static const AVOption filter_options[] = {
384 { "filter_name", NULL, OFFSET(dl_name), AV_OPT_TYPE_STRING, .flags = FLAGS },
385 { "filter_params", NULL, OFFSET(params), AV_OPT_TYPE_STRING, .flags = FLAGS },
389 static const AVClass filter_class = {
390 .class_name = "frei0r",
391 .item_name = av_default_item_name,
392 .option = filter_options,
393 .version = LIBAVUTIL_VERSION_INT,
396 static const AVFilterPad avfilter_vf_frei0r_inputs[] = {
399 .type = AVMEDIA_TYPE_VIDEO,
400 .config_props = config_input_props,
401 .filter_frame = filter_frame,
406 static const AVFilterPad avfilter_vf_frei0r_outputs[] = {
409 .type = AVMEDIA_TYPE_VIDEO,
414 AVFilter ff_vf_frei0r = {
416 .description = NULL_IF_CONFIG_SMALL("Apply a frei0r effect."),
418 .query_formats = query_formats,
422 .priv_size = sizeof(Frei0rContext),
423 .priv_class = &filter_class,
425 .inputs = avfilter_vf_frei0r_inputs,
427 .outputs = avfilter_vf_frei0r_outputs,
430 static av_cold int source_init(AVFilterContext *ctx)
432 Frei0rContext *s = ctx->priv;
433 AVRational frame_rate_q;
435 if (av_parse_video_size(&s->w, &s->h, s->size) < 0) {
436 av_log(ctx, AV_LOG_ERROR, "Invalid frame size: '%s'.\n", s->size);
437 return AVERROR(EINVAL);
440 if (av_parse_video_rate(&frame_rate_q, s->framerate) < 0 ||
441 frame_rate_q.den <= 0 || frame_rate_q.num <= 0) {
442 av_log(ctx, AV_LOG_ERROR, "Invalid frame rate: '%s'.\n", s->framerate);
443 return AVERROR(EINVAL);
445 s->time_base.num = frame_rate_q.den;
446 s->time_base.den = frame_rate_q.num;
448 return frei0r_init(ctx, s->dl_name, F0R_PLUGIN_TYPE_SOURCE);
451 static int source_config_props(AVFilterLink *outlink)
453 AVFilterContext *ctx = outlink->src;
454 Frei0rContext *s = ctx->priv;
456 if (av_image_check_size(s->w, s->h, 0, ctx) < 0)
457 return AVERROR(EINVAL);
460 outlink->time_base = s->time_base;
462 if (s->destruct && s->instance)
463 s->destruct(s->instance);
464 if (!(s->instance = s->construct(outlink->w, outlink->h))) {
465 av_log(ctx, AV_LOG_ERROR, "Impossible to load frei0r instance.\n");
466 return AVERROR(EINVAL);
469 av_log(ctx, AV_LOG_ERROR, "frei0r filter parameters not set.\n");
470 return AVERROR(EINVAL);
473 return set_params(ctx, s->params);
476 static int source_request_frame(AVFilterLink *outlink)
478 Frei0rContext *s = outlink->src->priv;
479 AVFrame *frame = ff_get_video_buffer(outlink, outlink->w, outlink->h);
482 return AVERROR(ENOMEM);
484 frame->sample_aspect_ratio = (AVRational) {1, 1};
485 frame->pts = s->pts++;
487 s->update(s->instance, av_rescale_q(frame->pts, s->time_base, (AVRational){1,1000}),
488 NULL, (uint32_t *)frame->data[0]);
490 return ff_filter_frame(outlink, frame);
493 static const AVOption src_options[] = {
494 { "size", "Dimensions of the generated video.", OFFSET(size), AV_OPT_TYPE_STRING, { .str = "" }, .flags = FLAGS },
495 { "framerate", NULL, OFFSET(framerate), AV_OPT_TYPE_STRING, { .str = "25" }, .flags = FLAGS },
496 { "filter_name", NULL, OFFSET(dl_name), AV_OPT_TYPE_STRING, .flags = FLAGS },
497 { "filter_params", NULL, OFFSET(params), AV_OPT_TYPE_STRING, .flags = FLAGS },
501 static const AVClass src_class = {
502 .class_name = "frei0r_src",
503 .item_name = av_default_item_name,
504 .option = src_options,
505 .version = LIBAVUTIL_VERSION_INT,
508 static const AVFilterPad avfilter_vsrc_frei0r_src_outputs[] = {
511 .type = AVMEDIA_TYPE_VIDEO,
512 .request_frame = source_request_frame,
513 .config_props = source_config_props
518 AVFilter ff_vsrc_frei0r_src = {
519 .name = "frei0r_src",
520 .description = NULL_IF_CONFIG_SMALL("Generate a frei0r source."),
522 .priv_size = sizeof(Frei0rContext),
523 .priv_class = &src_class,
527 .query_formats = query_formats,
531 .outputs = avfilter_vsrc_frei0r_src_outputs,