git.sesse.net Git - ffmpeg/blob - 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[1024];
 240         snprintf(prefix, sizeof(prefix), "%s/.frei0r-1/lib/", path);
 241         frei0r->dl_handle = load_path(ctx, prefix, dl_name);
 242     }
 243     if (!frei0r->dl_handle)
 244         frei0r->dl_handle = load_path(ctx, "/usr/local/lib/frei0r-1/", dl_name);
 245     if (!frei0r->dl_handle)
 246         frei0r->dl_handle = load_path(ctx, "/usr/lib/frei0r-1/", dl_name);
 247     if (!frei0r->dl_handle) {
 248         av_log(ctx, AV_LOG_ERROR, "Could not find module '%s'\n", dl_name);
 249         return AVERROR(EINVAL);
 250     }
 251
 252     if (!(f0r_init                = load_sym(ctx, "f0r_init"           )) ||
 253         !(f0r_get_plugin_info     = load_sym(ctx, "f0r_get_plugin_info")) ||
 254         !(frei0r->get_param_info  = load_sym(ctx, "f0r_get_param_info" )) ||
 255         !(frei0r->get_param_value = load_sym(ctx, "f0r_get_param_value")) ||
 256         !(frei0r->set_param_value = load_sym(ctx, "f0r_set_param_value")) ||
 257         !(frei0r->update          = load_sym(ctx, "f0r_update"         )) ||
 258         !(frei0r->construct       = load_sym(ctx, "f0r_construct"      )) ||
 259         !(frei0r->destruct        = load_sym(ctx, "f0r_destruct"       )) ||
 260         !(frei0r->deinit          = load_sym(ctx, "f0r_deinit"         )))
 261         return AVERROR(EINVAL);
 262
 263     if (f0r_init() < 0) {
 264         av_log(ctx, AV_LOG_ERROR, "Could not init the frei0r module\n");
 265         return AVERROR(EINVAL);
 266     }
 267
 268     f0r_get_plugin_info(&frei0r->plugin_info);
 269     pi = &frei0r->plugin_info;
 270     if (pi->plugin_type != type) {
 271         av_log(ctx, AV_LOG_ERROR,
 272                "Invalid type '%s' for the plugin\n",
 273                pi->plugin_type == F0R_PLUGIN_TYPE_FILTER ? "filter" :
 274                pi->plugin_type == F0R_PLUGIN_TYPE_SOURCE ? "source" :
 275                pi->plugin_type == F0R_PLUGIN_TYPE_MIXER2 ? "mixer2" :
 276                pi->plugin_type == F0R_PLUGIN_TYPE_MIXER3 ? "mixer3" : "unknown");
 277         return AVERROR(EINVAL);
 278     }
 279
 280     av_log(ctx, AV_LOG_VERBOSE,
 281            "name:%s author:'%s' explanation:'%s' color_model:%s "
 282            "frei0r_version:%d version:%d.%d num_params:%d\n",
 283            pi->name, pi->author, pi->explanation,
 284            pi->color_model == F0R_COLOR_MODEL_BGRA8888 ? "bgra8888" :
 285            pi->color_model == F0R_COLOR_MODEL_RGBA8888 ? "rgba8888" :
 286            pi->color_model == F0R_COLOR_MODEL_PACKED32 ? "packed32" : "unknown",
 287            pi->frei0r_version, pi->major_version, pi->minor_version, pi->num_params);
 288
 289     return 0;
 290 }
 291
 292 static av_cold int filter_init(AVFilterContext *ctx, const char *args)
 293 {
 294     Frei0rContext *frei0r = ctx->priv;
 295     char dl_name[1024], c;
 296     *frei0r->params = 0;
 297
 298     if (args)
 299         sscanf(args, "%1023[^:=]%c%255c", dl_name, &c, frei0r->params);
 300
 301     return frei0r_init(ctx, dl_name, F0R_PLUGIN_TYPE_FILTER);
 302 }
 303
 304 static av_cold void uninit(AVFilterContext *ctx)
 305 {
 306     Frei0rContext *frei0r = ctx->priv;
 307
 308     if (frei0r->destruct && frei0r->instance)
 309         frei0r->destruct(frei0r->instance);
 310     if (frei0r->deinit)
 311         frei0r->deinit();
 312     if (frei0r->dl_handle)
 313         dlclose(frei0r->dl_handle);
 314
 315     memset(frei0r, 0, sizeof(*frei0r));
 316 }
 317
 318 static int config_input_props(AVFilterLink *inlink)
 319 {
 320     AVFilterContext *ctx = inlink->dst;
 321     Frei0rContext *frei0r = ctx->priv;
 322
 323     if (!(frei0r->instance = frei0r->construct(inlink->w, inlink->h))) {
 324         av_log(ctx, AV_LOG_ERROR, "Impossible to load frei0r instance\n");
 325         return AVERROR(EINVAL);
 326     }
 327
 328     return set_params(ctx, frei0r->params);
 329 }
 330
 331 static int query_formats(AVFilterContext *ctx)
 332 {
 333     Frei0rContext *frei0r = ctx->priv;
 334     AVFilterFormats *formats = NULL;
 335
 336     if        (frei0r->plugin_info.color_model == F0R_COLOR_MODEL_BGRA8888) {
 337         ff_add_format(&formats, AV_PIX_FMT_BGRA);
 338     } else if (frei0r->plugin_info.color_model == F0R_COLOR_MODEL_RGBA8888) {
 339         ff_add_format(&formats, AV_PIX_FMT_RGBA);
 340     } else {                                   /* F0R_COLOR_MODEL_PACKED32 */
 341         static const enum AVPixelFormat pix_fmts[] = {
 342             AV_PIX_FMT_BGRA, AV_PIX_FMT_ARGB, AV_PIX_FMT_ABGR, AV_PIX_FMT_ARGB, AV_PIX_FMT_NONE
 343         };
 344         formats = ff_make_format_list(pix_fmts);
 345     }
 346
 347     if (!formats)
 348         return AVERROR(ENOMEM);
 349
 350     ff_set_common_formats(ctx, formats);
 351     return 0;
 352 }
 353
 354 static int null_draw_slice(AVFilterLink *inlink, int y, int h, int slice_dir)
 355 {
 356     return 0;
 357 }
 358
 359 static int end_frame(AVFilterLink *inlink)
 360 {
 361     Frei0rContext *frei0r = inlink->dst->priv;
 362     AVFilterLink *outlink = inlink->dst->outputs[0];
 363     AVFilterBufferRef  *inpicref =  inlink->cur_buf;
 364     AVFilterBufferRef *outpicref = outlink->out_buf;
 365     int ret;
 366
 367     frei0r->update(frei0r->instance, inpicref->pts * av_q2d(inlink->time_base) * 1000,
 368                    (const uint32_t *)inpicref->data[0],
 369                    (uint32_t *)outpicref->data[0]);
 370     if ((ret = ff_draw_slice(outlink, 0, outlink->h, 1)) ||
 371         (ret = ff_end_frame(outlink)) < 0)
 372         return ret;
 373     return 0;
 374 }
 375
 376 static const AVFilterPad avfilter_vf_frei0r_inputs[] = {
 377     {
 378         .name         = "default",
 379         .type         = AVMEDIA_TYPE_VIDEO,
 380         .draw_slice   = null_draw_slice,
 381         .config_props = config_input_props,
 382         .end_frame    = end_frame,
 383         .min_perms    = AV_PERM_READ
 384     },
 385     { NULL }
 386 };
 387
 388 static const AVFilterPad avfilter_vf_frei0r_outputs[] = {
 389     {
 390         .name = "default",
 391         .type = AVMEDIA_TYPE_VIDEO,
 392     },
 393     { NULL }
 394 };
 395
 396 AVFilter avfilter_vf_frei0r = {
 397     .name      = "frei0r",
 398     .description = NULL_IF_CONFIG_SMALL("Apply a frei0r effect."),
 399
 400     .query_formats = query_formats,
 401     .init = filter_init,
 402     .uninit = uninit,
 403
 404     .priv_size = sizeof(Frei0rContext),
 405
 406     .inputs    = avfilter_vf_frei0r_inputs,
 407
 408     .outputs   = avfilter_vf_frei0r_outputs,
 409 };
 410
 411 static av_cold int source_init(AVFilterContext *ctx, const char *args)
 412 {
 413     Frei0rContext *frei0r = ctx->priv;
 414     char dl_name[1024], c;
 415     char frame_size[128] = "";
 416     char frame_rate[128] = "";
 417     AVRational frame_rate_q;
 418
 419     memset(frei0r->params, 0, sizeof(frei0r->params));
 420
 421     if (args)
 422         sscanf(args, "%127[^:]:%127[^:]:%1023[^:=]%c%255c",
 423                frame_size, frame_rate, dl_name, &c, frei0r->params);
 424
 425     if (av_parse_video_size(&frei0r->w, &frei0r->h, frame_size) < 0) {
 426         av_log(ctx, AV_LOG_ERROR, "Invalid frame size: '%s'\n", frame_size);
 427         return AVERROR(EINVAL);
 428     }
 429
 430     if (av_parse_video_rate(&frame_rate_q, frame_rate) < 0) {
 431         av_log(ctx, AV_LOG_ERROR, "Invalid frame rate: '%s'\n", frame_rate);
 432         return AVERROR(EINVAL);
 433     }
 434     frei0r->time_base.num = frame_rate_q.den;
 435     frei0r->time_base.den = frame_rate_q.num;
 436
 437     return frei0r_init(ctx, dl_name, F0R_PLUGIN_TYPE_SOURCE);
 438 }
 439
 440 static int source_config_props(AVFilterLink *outlink)
 441 {
 442     AVFilterContext *ctx = outlink->src;
 443     Frei0rContext *frei0r = ctx->priv;
 444
 445     if (av_image_check_size(frei0r->w, frei0r->h, 0, ctx) < 0)
 446         return AVERROR(EINVAL);
 447     outlink->w = frei0r->w;
 448     outlink->h = frei0r->h;
 449     outlink->time_base = frei0r->time_base;
 450     outlink->sample_aspect_ratio = (AVRational){1,1};
 451
 452     if (!(frei0r->instance = frei0r->construct(outlink->w, outlink->h))) {
 453         av_log(ctx, AV_LOG_ERROR, "Impossible to load frei0r instance\n");
 454         return AVERROR(EINVAL);
 455     }
 456
 457     return set_params(ctx, frei0r->params);
 458 }
 459
 460 static int source_request_frame(AVFilterLink *outlink)
 461 {
 462     Frei0rContext *frei0r = outlink->src->priv;
 463     AVFilterBufferRef *picref = ff_get_video_buffer(outlink, AV_PERM_WRITE, outlink->w, outlink->h);
 464     AVFilterBufferRef *buf_out;
 465     int ret;
 466
 467     if (!picref)
 468         return AVERROR(ENOMEM);
 469
 470     picref->video->sample_aspect_ratio = (AVRational) {1, 1};
 471     picref->pts = frei0r->pts++;
 472     picref->pos = -1;
 473
 474     buf_out = avfilter_ref_buffer(picref, ~0);
 475     if (!buf_out) {
 476         ret = AVERROR(ENOMEM);
 477         goto fail;
 478     }
 479
 480     ret = ff_start_frame(outlink, buf_out);
 481     if (ret < 0)
 482         goto fail;
 483
 484     frei0r->update(frei0r->instance, av_rescale_q(picref->pts, frei0r->time_base, (AVRational){1,1000}),
 485                    NULL, (uint32_t *)picref->data[0]);
 486     ret = ff_draw_slice(outlink, 0, outlink->h, 1);
 487     if (ret < 0)
 488         goto fail;
 489
 490     ret = ff_end_frame(outlink);
 491
 492 fail:
 493     avfilter_unref_buffer(picref);
 494
 495     return ret;
 496 }
 497
 498 static const AVFilterPad avfilter_vsrc_frei0r_src_outputs[] = {
 499     {
 500         .name          = "default",
 501         .type          = AVMEDIA_TYPE_VIDEO,
 502         .request_frame = source_request_frame,
 503         .config_props  = source_config_props
 504     },
 505     { NULL }
 506 };
 507
 508 AVFilter avfilter_vsrc_frei0r_src = {
 509     .name        = "frei0r_src",
 510     .description = NULL_IF_CONFIG_SMALL("Generate a frei0r source."),
 511
 512     .priv_size = sizeof(Frei0rContext),
 513     .init      = source_init,
 514     .uninit    = uninit,
 515
 516     .query_formats = query_formats,
 517
 518     .inputs    = NULL,
 519
 520     .outputs   = avfilter_vsrc_frei0r_src_outputs,
 521 };