git.sesse.net Git - ffmpeg/blob - libavfilter/vf_remap.c

   1 /*
   2  * Copyright (c) 2016 Floris Sluiter
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * FFmpeg is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with FFmpeg; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 /**
  22  * @file
  23  * Pixel remap filter
  24  * This filter copies pixel by pixel a source frame to a target frame.
  25  * It remaps the pixels to a new x,y destination based on two files ymap/xmap.
  26  * Map files are passed as a parameter and are in PGM format (P2 or P5),
  27  * where the values are y(rows)/x(cols) coordinates of the source_frame.
  28  * The *target* frame dimension is based on mapfile dimensions: specified in the
  29  * header of the mapfile and reflected in the number of datavalues.
  30  * Dimensions of ymap and xmap must be equal. Datavalues must be positive or zero.
  31  * Any datavalue in the ymap or xmap which value is higher
  32  * then the *source* frame height or width is silently ignored, leaving a
  33  * blank/chromakey pixel. This can safely be used as a feature to create overlays.
  34  *
  35  * Algorithm digest:
  36  * Target_frame[y][x] = Source_frame[ ymap[y][x] ][ [xmap[y][x] ];
  37  */
  38
  39 #include "libavutil/imgutils.h"
  40 #include "libavutil/pixdesc.h"
  41 #include "libavutil/opt.h"
  42 #include "avfilter.h"
  43 #include "formats.h"
  44 #include "framesync.h"
  45 #include "internal.h"
  46 #include "video.h"
  47
  48 typedef struct RemapContext {
  49     const AVClass *class;
  50     int format;
  51
  52     int nb_planes;
  53     int nb_components;
  54     int step;
  55
  56     FFFrameSync fs;
  57
  58     int (*remap_slice)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
  59 } RemapContext;
  60
  61 #define OFFSET(x) offsetof(RemapContext, x)
  62 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
  63
  64 static const AVOption remap_options[] = {
  65     { "format", "set output format", OFFSET(format), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS, "format" },
  66         { "color",  "", 0, AV_OPT_TYPE_CONST, {.i64=0},   .flags = FLAGS, .unit = "format" },
  67         { "gray",   "", 0, AV_OPT_TYPE_CONST, {.i64=1},   .flags = FLAGS, .unit = "format" },
  68     { NULL }
  69 };
  70
  71 AVFILTER_DEFINE_CLASS(remap);
  72
  73 typedef struct ThreadData {
  74     AVFrame *in, *xin, *yin, *out;
  75     int nb_planes;
  76     int nb_components;
  77     int step;
  78 } ThreadData;
  79
  80 static int query_formats(AVFilterContext *ctx)
  81 {
  82     RemapContext *s = ctx->priv;
  83     static const enum AVPixelFormat pix_fmts[] = {
  84         AV_PIX_FMT_YUVA444P,
  85         AV_PIX_FMT_YUV444P,
  86         AV_PIX_FMT_YUVJ444P,
  87         AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24,
  88         AV_PIX_FMT_ARGB, AV_PIX_FMT_ABGR, AV_PIX_FMT_RGBA, AV_PIX_FMT_BGRA,
  89         AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP,
  90         AV_PIX_FMT_YUV444P9, AV_PIX_FMT_YUV444P10, AV_PIX_FMT_YUV444P12,
  91         AV_PIX_FMT_YUV444P14, AV_PIX_FMT_YUV444P16,
  92         AV_PIX_FMT_YUVA444P9, AV_PIX_FMT_YUVA444P10, AV_PIX_FMT_YUVA444P16,
  93         AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10, AV_PIX_FMT_GBRP12,
  94         AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
  95         AV_PIX_FMT_GBRAP10, AV_PIX_FMT_GBRAP12, AV_PIX_FMT_GBRAP16,
  96         AV_PIX_FMT_RGB48, AV_PIX_FMT_BGR48,
  97         AV_PIX_FMT_RGBA64, AV_PIX_FMT_BGRA64,
  98         AV_PIX_FMT_NONE
  99     };
 100     static const enum AVPixelFormat gray_pix_fmts[] = {
 101         AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY9,
 102         AV_PIX_FMT_GRAY10, AV_PIX_FMT_GRAY12,
 103         AV_PIX_FMT_GRAY14, AV_PIX_FMT_GRAY16,
 104         AV_PIX_FMT_NONE
 105     };
 106     static const enum AVPixelFormat map_fmts[] = {
 107         AV_PIX_FMT_GRAY16,
 108         AV_PIX_FMT_NONE
 109     };
 110     AVFilterFormats *pix_formats = NULL, *map_formats = NULL;
 111     int ret;
 112
 113     if (!(pix_formats = ff_make_format_list(s->format ? gray_pix_fmts : pix_fmts)) ||
 114         !(map_formats = ff_make_format_list(map_fmts))) {
 115         ret = AVERROR(ENOMEM);
 116         goto fail;
 117     }
 118     if ((ret = ff_formats_ref(pix_formats, &ctx->inputs[0]->out_formats)) < 0 ||
 119         (ret = ff_formats_ref(map_formats, &ctx->inputs[1]->out_formats)) < 0 ||
 120         (ret = ff_formats_ref(map_formats, &ctx->inputs[2]->out_formats)) < 0 ||
 121         (ret = ff_formats_ref(pix_formats, &ctx->outputs[0]->in_formats)) < 0)
 122         goto fail;
 123     return 0;
 124 fail:
 125     if (pix_formats)
 126         av_freep(&pix_formats->formats);
 127     av_freep(&pix_formats);
 128     if (map_formats)
 129         av_freep(&map_formats->formats);
 130     av_freep(&map_formats);
 131     return ret;
 132 }
 133
 134 /**
 135  * remap_planar algorithm expects planes of same size
 136  * pixels are copied from source to target using :
 137  * Target_frame[y][x] = Source_frame[ ymap[y][x] ][ [xmap[y][x] ];
 138  */
 139 #define DEFINE_REMAP_PLANAR_FUNC(name, bits, div)                                           \
 140 static int remap_planar##bits##_##name##_slice(AVFilterContext *ctx, void *arg,             \
 141                                                int jobnr, int nb_jobs)                      \
 142 {                                                                                           \
 143     const ThreadData *td = (ThreadData*)arg;                                                \
 144     const AVFrame *in  = td->in;                                                            \
 145     const AVFrame *xin = td->xin;                                                           \
 146     const AVFrame *yin = td->yin;                                                           \
 147     const AVFrame *out = td->out;                                                           \
 148     const int slice_start = (out->height *  jobnr   ) / nb_jobs;                            \
 149     const int slice_end   = (out->height * (jobnr+1)) / nb_jobs;                            \
 150     const int xlinesize = xin->linesize[0] / 2;                                             \
 151     const int ylinesize = yin->linesize[0] / 2;                                             \
 152     int x , y, plane;                                                                       \
 153                                                                                             \
 154     for (plane = 0; plane < td->nb_planes ; plane++) {                                      \
 155         const int dlinesize  = out->linesize[plane] / div;                                  \
 156         const uint##bits##_t *src = (const uint##bits##_t *)in->data[plane];                \
 157         uint##bits##_t *dst = (uint##bits##_t *)out->data[plane] + slice_start * dlinesize; \
 158         const int slinesize  = in->linesize[plane] / div;                                   \
 159         const uint16_t *xmap = (const uint16_t *)xin->data[0] + slice_start * xlinesize;    \
 160         const uint16_t *ymap = (const uint16_t *)yin->data[0] + slice_start * ylinesize;    \
 161                                                                                             \
 162         for (y = slice_start; y < slice_end; y++) {                                         \
 163             for (x = 0; x < out->width; x++) {                                              \
 164                 if (ymap[x] < in->height && xmap[x] < in->width) {                          \
 165                     dst[x] = src[ymap[x] * slinesize + xmap[x]];                            \
 166                 } else {                                                                    \
 167                     dst[x] = 0;                                                             \
 168                 }                                                                           \
 169             }                                                                               \
 170             dst  += dlinesize;                                                              \
 171             xmap += xlinesize;                                                              \
 172             ymap += ylinesize;                                                              \
 173         }                                                                                   \
 174     }                                                                                       \
 175                                                                                             \
 176     return 0;                                                                               \
 177 }
 178
 179 DEFINE_REMAP_PLANAR_FUNC(nearest, 8, 1)
 180 DEFINE_REMAP_PLANAR_FUNC(nearest, 16, 2)
 181
 182 /**
 183  * remap_packed algorithm expects pixels with both padded bits (step) and
 184  * number of components correctly set.
 185  * pixels are copied from source to target using :
 186  * Target_frame[y][x] = Source_frame[ ymap[y][x] ][ [xmap[y][x] ];
 187  */
 188 #define DEFINE_REMAP_PACKED_FUNC(name, bits, div)                                           \
 189 static int remap_packed##bits##_##name##_slice(AVFilterContext *ctx, void *arg,             \
 190                                                int jobnr, int nb_jobs)                      \
 191 {                                                                                           \
 192     const ThreadData *td = (ThreadData*)arg;                                                \
 193     const AVFrame *in  = td->in;                                                            \
 194     const AVFrame *xin = td->xin;                                                           \
 195     const AVFrame *yin = td->yin;                                                           \
 196     const AVFrame *out = td->out;                                                           \
 197     const int slice_start = (out->height *  jobnr   ) / nb_jobs;                            \
 198     const int slice_end   = (out->height * (jobnr+1)) / nb_jobs;                            \
 199     const int dlinesize  = out->linesize[0] / div;                                          \
 200     const int slinesize  = in->linesize[0] / div;                                           \
 201     const int xlinesize  = xin->linesize[0] / 2;                                            \
 202     const int ylinesize  = yin->linesize[0] / 2;                                            \
 203     const uint##bits##_t *src = (const uint##bits##_t *)in->data[0];                        \
 204     uint##bits##_t *dst = (uint##bits##_t *)out->data[0] + slice_start * dlinesize;         \
 205     const uint16_t *xmap = (const uint16_t *)xin->data[0] + slice_start * xlinesize;        \
 206     const uint16_t *ymap = (const uint16_t *)yin->data[0] + slice_start * ylinesize;        \
 207     const int step       = td->step / div;                                                  \
 208     int c, x, y;                                                                            \
 209                                                                                             \
 210     for (y = slice_start; y < slice_end; y++) {                                             \
 211         for (x = 0; x < out->width; x++) {                                                  \
 212             for (c = 0; c < td->nb_components; c++) {                                       \
 213                 if (ymap[x] < in->height && xmap[x] < in->width) {                          \
 214                     dst[x * step + c] = src[ymap[x] * slinesize + xmap[x] * step + c];      \
 215                 } else {                                                                    \
 216                     dst[x * step + c] = 0;                                                  \
 217                 }                                                                           \
 218             }                                                                               \
 219         }                                                                                   \
 220         dst  += dlinesize;                                                                  \
 221         xmap += xlinesize;                                                                  \
 222         ymap += ylinesize;                                                                  \
 223     }                                                                                       \
 224                                                                                             \
 225     return 0;                                                                               \
 226 }
 227
 228 DEFINE_REMAP_PACKED_FUNC(nearest, 8, 1)
 229 DEFINE_REMAP_PACKED_FUNC(nearest, 16, 2)
 230
 231 static int config_input(AVFilterLink *inlink)
 232 {
 233     AVFilterContext *ctx = inlink->dst;
 234     RemapContext *s = ctx->priv;
 235     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
 236
 237     s->nb_planes = av_pix_fmt_count_planes(inlink->format);
 238     s->nb_components = desc->nb_components;
 239
 240     if (desc->comp[0].depth == 8) {
 241         if (s->nb_planes > 1 || s->nb_components == 1) {
 242             s->remap_slice = remap_planar8_nearest_slice;
 243         } else {
 244             s->remap_slice = remap_packed8_nearest_slice;
 245         }
 246     } else {
 247         if (s->nb_planes > 1 || s->nb_components == 1) {
 248             s->remap_slice = remap_planar16_nearest_slice;
 249         } else {
 250             s->remap_slice = remap_packed16_nearest_slice;
 251         }
 252     }
 253
 254     s->step = av_get_padded_bits_per_pixel(desc) >> 3;
 255     return 0;
 256 }
 257
 258 static int process_frame(FFFrameSync *fs)
 259 {
 260     AVFilterContext *ctx = fs->parent;
 261     RemapContext *s = fs->opaque;
 262     AVFilterLink *outlink = ctx->outputs[0];
 263     AVFrame *out, *in, *xpic, *ypic;
 264     int ret;
 265
 266     if ((ret = ff_framesync_get_frame(&s->fs, 0, &in,   0)) < 0 ||
 267         (ret = ff_framesync_get_frame(&s->fs, 1, &xpic, 0)) < 0 ||
 268         (ret = ff_framesync_get_frame(&s->fs, 2, &ypic, 0)) < 0)
 269         return ret;
 270
 271     if (ctx->is_disabled) {
 272         out = av_frame_clone(in);
 273         if (!out)
 274             return AVERROR(ENOMEM);
 275     } else {
 276         ThreadData td;
 277
 278         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
 279         if (!out)
 280             return AVERROR(ENOMEM);
 281         av_frame_copy_props(out, in);
 282
 283         td.in  = in;
 284         td.xin = xpic;
 285         td.yin = ypic;
 286         td.out = out;
 287         td.nb_planes = s->nb_planes;
 288         td.nb_components = s->nb_components;
 289         td.step = s->step;
 290         ctx->internal->execute(ctx, s->remap_slice, &td, NULL, FFMIN(outlink->h, ff_filter_get_nb_threads(ctx)));
 291     }
 292     out->pts = av_rescale_q(s->fs.pts, s->fs.time_base, outlink->time_base);
 293
 294     return ff_filter_frame(outlink, out);
 295 }
 296
 297 static int config_output(AVFilterLink *outlink)
 298 {
 299     AVFilterContext *ctx = outlink->src;
 300     RemapContext *s = ctx->priv;
 301     AVFilterLink *srclink = ctx->inputs[0];
 302     AVFilterLink *xlink = ctx->inputs[1];
 303     AVFilterLink *ylink = ctx->inputs[2];
 304     FFFrameSyncIn *in;
 305     int ret;
 306
 307     if (xlink->w != ylink->w || xlink->h != ylink->h) {
 308         av_log(ctx, AV_LOG_ERROR, "Second input link %s parameters "
 309                "(size %dx%d) do not match the corresponding "
 310                "third input link %s parameters (%dx%d)\n",
 311                ctx->input_pads[1].name, xlink->w, xlink->h,
 312                ctx->input_pads[2].name, ylink->w, ylink->h);
 313         return AVERROR(EINVAL);
 314     }
 315
 316     outlink->w = xlink->w;
 317     outlink->h = xlink->h;
 318     outlink->sample_aspect_ratio = srclink->sample_aspect_ratio;
 319     outlink->frame_rate = srclink->frame_rate;
 320
 321     ret = ff_framesync_init(&s->fs, ctx, 3);
 322     if (ret < 0)
 323         return ret;
 324
 325     in = s->fs.in;
 326     in[0].time_base = srclink->time_base;
 327     in[1].time_base = xlink->time_base;
 328     in[2].time_base = ylink->time_base;
 329     in[0].sync   = 2;
 330     in[0].before = EXT_STOP;
 331     in[0].after  = EXT_STOP;
 332     in[1].sync   = 1;
 333     in[1].before = EXT_NULL;
 334     in[1].after  = EXT_INFINITY;
 335     in[2].sync   = 1;
 336     in[2].before = EXT_NULL;
 337     in[2].after  = EXT_INFINITY;
 338     s->fs.opaque   = s;
 339     s->fs.on_event = process_frame;
 340
 341     ret = ff_framesync_configure(&s->fs);
 342     outlink->time_base = s->fs.time_base;
 343
 344     return ret;
 345 }
 346
 347 static int activate(AVFilterContext *ctx)
 348 {
 349     RemapContext *s = ctx->priv;
 350     return ff_framesync_activate(&s->fs);
 351 }
 352
 353 static av_cold void uninit(AVFilterContext *ctx)
 354 {
 355     RemapContext *s = ctx->priv;
 356
 357     ff_framesync_uninit(&s->fs);
 358 }
 359
 360 static const AVFilterPad remap_inputs[] = {
 361     {
 362         .name         = "source",
 363         .type         = AVMEDIA_TYPE_VIDEO,
 364         .config_props = config_input,
 365     },
 366     {
 367         .name         = "xmap",
 368         .type         = AVMEDIA_TYPE_VIDEO,
 369     },
 370     {
 371         .name         = "ymap",
 372         .type         = AVMEDIA_TYPE_VIDEO,
 373     },
 374     { NULL }
 375 };
 376
 377 static const AVFilterPad remap_outputs[] = {
 378     {
 379         .name          = "default",
 380         .type          = AVMEDIA_TYPE_VIDEO,
 381         .config_props  = config_output,
 382     },
 383     { NULL }
 384 };
 385
 386 AVFilter ff_vf_remap = {
 387     .name          = "remap",
 388     .description   = NULL_IF_CONFIG_SMALL("Remap pixels."),
 389     .priv_size     = sizeof(RemapContext),
 390     .uninit        = uninit,
 391     .query_formats = query_formats,
 392     .activate      = activate,
 393     .inputs        = remap_inputs,
 394     .outputs       = remap_outputs,
 395     .priv_class    = &remap_class,
 396     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SLICE_THREADS,
 397 };