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