2 * Copyright (c) 2016 Floris Sluiter
4 * This file is part of FFmpeg.
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.
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.
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
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.
36 * Target_frame[y][x] = Source_frame[ ymap[y][x] ][ [xmap[y][x] ];
39 #include "libavutil/imgutils.h"
40 #include "libavutil/pixdesc.h"
41 #include "libavutil/opt.h"
44 #include "framesync.h"
48 typedef struct RemapContext {
55 int (*remap_slice)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
58 #define OFFSET(x) offsetof(RemapContext, x)
59 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
61 static const AVOption remap_options[] = {
65 AVFILTER_DEFINE_CLASS(remap);
67 typedef struct ThreadData {
68 AVFrame *in, *xin, *yin, *out;
74 static int query_formats(AVFilterContext *ctx)
76 static const enum AVPixelFormat pix_fmts[] = {
80 AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24,
81 AV_PIX_FMT_ARGB, AV_PIX_FMT_ABGR, AV_PIX_FMT_RGBA, AV_PIX_FMT_BGRA,
82 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP,
83 AV_PIX_FMT_YUV444P9, AV_PIX_FMT_YUV444P10, AV_PIX_FMT_YUV444P12,
84 AV_PIX_FMT_YUV444P14, AV_PIX_FMT_YUV444P16,
85 AV_PIX_FMT_YUVA444P9, AV_PIX_FMT_YUVA444P10, AV_PIX_FMT_YUVA444P16,
86 AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10, AV_PIX_FMT_GBRP12,
87 AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
88 AV_PIX_FMT_GBRAP10, AV_PIX_FMT_GBRAP12, AV_PIX_FMT_GBRAP16,
89 AV_PIX_FMT_RGB48, AV_PIX_FMT_BGR48,
90 AV_PIX_FMT_RGBA64, AV_PIX_FMT_BGRA64,
91 AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY9,
92 AV_PIX_FMT_GRAY10, AV_PIX_FMT_GRAY12,
93 AV_PIX_FMT_GRAY14, AV_PIX_FMT_GRAY16,
96 static const enum AVPixelFormat map_fmts[] = {
100 AVFilterFormats *pix_formats = NULL, *map_formats = NULL;
103 if (!(pix_formats = ff_make_format_list(pix_fmts)) ||
104 !(map_formats = ff_make_format_list(map_fmts))) {
105 ret = AVERROR(ENOMEM);
108 if ((ret = ff_formats_ref(pix_formats, &ctx->inputs[0]->out_formats)) < 0 ||
109 (ret = ff_formats_ref(map_formats, &ctx->inputs[1]->out_formats)) < 0 ||
110 (ret = ff_formats_ref(map_formats, &ctx->inputs[2]->out_formats)) < 0 ||
111 (ret = ff_formats_ref(pix_formats, &ctx->outputs[0]->in_formats)) < 0)
116 av_freep(&pix_formats->formats);
117 av_freep(&pix_formats);
119 av_freep(&map_formats->formats);
120 av_freep(&map_formats);
125 * remap_planar algorithm expects planes of same size
126 * pixels are copied from source to target using :
127 * Target_frame[y][x] = Source_frame[ ymap[y][x] ][ [xmap[y][x] ];
129 #define DEFINE_REMAP_PLANAR_FUNC(name, bits, div) \
130 static int remap_planar##bits##_##name##_slice(AVFilterContext *ctx, void *arg, \
131 int jobnr, int nb_jobs) \
133 const ThreadData *td = (ThreadData*)arg; \
134 const AVFrame *in = td->in; \
135 const AVFrame *xin = td->xin; \
136 const AVFrame *yin = td->yin; \
137 const AVFrame *out = td->out; \
138 const int slice_start = (out->height * jobnr ) / nb_jobs; \
139 const int slice_end = (out->height * (jobnr+1)) / nb_jobs; \
140 const int xlinesize = xin->linesize[0] / 2; \
141 const int ylinesize = yin->linesize[0] / 2; \
144 for (plane = 0; plane < td->nb_planes ; plane++) { \
145 const int dlinesize = out->linesize[plane] / div; \
146 const uint##bits##_t *src = (const uint##bits##_t *)in->data[plane]; \
147 uint##bits##_t *dst = (uint##bits##_t *)out->data[plane] + slice_start * dlinesize; \
148 const int slinesize = in->linesize[plane] / div; \
149 const uint16_t *xmap = (const uint16_t *)xin->data[0] + slice_start * xlinesize; \
150 const uint16_t *ymap = (const uint16_t *)yin->data[0] + slice_start * ylinesize; \
152 for (y = slice_start; y < slice_end; y++) { \
153 for (x = 0; x < out->width; x++) { \
154 if (ymap[x] < in->height && xmap[x] < in->width) { \
155 dst[x] = src[ymap[x] * slinesize + xmap[x]]; \
169 DEFINE_REMAP_PLANAR_FUNC(nearest, 8, 1)
170 DEFINE_REMAP_PLANAR_FUNC(nearest, 16, 2)
173 * remap_packed algorithm expects pixels with both padded bits (step) and
174 * number of components correctly set.
175 * pixels are copied from source to target using :
176 * Target_frame[y][x] = Source_frame[ ymap[y][x] ][ [xmap[y][x] ];
178 #define DEFINE_REMAP_PACKED_FUNC(name, bits, div) \
179 static int remap_packed##bits##_##name##_slice(AVFilterContext *ctx, void *arg, \
180 int jobnr, int nb_jobs) \
182 const ThreadData *td = (ThreadData*)arg; \
183 const AVFrame *in = td->in; \
184 const AVFrame *xin = td->xin; \
185 const AVFrame *yin = td->yin; \
186 const AVFrame *out = td->out; \
187 const int slice_start = (out->height * jobnr ) / nb_jobs; \
188 const int slice_end = (out->height * (jobnr+1)) / nb_jobs; \
189 const int dlinesize = out->linesize[0] / div; \
190 const int slinesize = in->linesize[0] / div; \
191 const int xlinesize = xin->linesize[0] / 2; \
192 const int ylinesize = yin->linesize[0] / 2; \
193 const uint##bits##_t *src = (const uint##bits##_t *)in->data[0]; \
194 uint##bits##_t *dst = (uint##bits##_t *)out->data[0] + slice_start * dlinesize; \
195 const uint16_t *xmap = (const uint16_t *)xin->data[0] + slice_start * xlinesize; \
196 const uint16_t *ymap = (const uint16_t *)yin->data[0] + slice_start * ylinesize; \
197 const int step = td->step / div; \
200 for (y = slice_start; y < slice_end; y++) { \
201 for (x = 0; x < out->width; x++) { \
202 for (c = 0; c < td->nb_components; c++) { \
203 if (ymap[x] < in->height && xmap[x] < in->width) { \
204 dst[x * step + c] = src[ymap[x] * slinesize + xmap[x] * step + c]; \
206 dst[x * step + c] = 0; \
218 DEFINE_REMAP_PACKED_FUNC(nearest, 8, 1)
219 DEFINE_REMAP_PACKED_FUNC(nearest, 16, 2)
221 static int config_input(AVFilterLink *inlink)
223 AVFilterContext *ctx = inlink->dst;
224 RemapContext *s = ctx->priv;
225 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
227 s->nb_planes = av_pix_fmt_count_planes(inlink->format);
228 s->nb_components = desc->nb_components;
230 if (desc->comp[0].depth == 8) {
231 if (s->nb_planes > 1 || s->nb_components == 1) {
232 s->remap_slice = remap_planar8_nearest_slice;
234 s->remap_slice = remap_packed8_nearest_slice;
237 if (s->nb_planes > 1 || s->nb_components == 1) {
238 s->remap_slice = remap_planar16_nearest_slice;
240 s->remap_slice = remap_packed16_nearest_slice;
244 s->step = av_get_padded_bits_per_pixel(desc) >> 3;
248 static int process_frame(FFFrameSync *fs)
250 AVFilterContext *ctx = fs->parent;
251 RemapContext *s = fs->opaque;
252 AVFilterLink *outlink = ctx->outputs[0];
253 AVFrame *out, *in, *xpic, *ypic;
256 if ((ret = ff_framesync_get_frame(&s->fs, 0, &in, 0)) < 0 ||
257 (ret = ff_framesync_get_frame(&s->fs, 1, &xpic, 0)) < 0 ||
258 (ret = ff_framesync_get_frame(&s->fs, 2, &ypic, 0)) < 0)
261 if (ctx->is_disabled) {
262 out = av_frame_clone(in);
264 return AVERROR(ENOMEM);
268 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
270 return AVERROR(ENOMEM);
271 av_frame_copy_props(out, in);
277 td.nb_planes = s->nb_planes;
278 td.nb_components = s->nb_components;
280 ctx->internal->execute(ctx, s->remap_slice, &td, NULL, FFMIN(outlink->h, ff_filter_get_nb_threads(ctx)));
282 out->pts = av_rescale_q(s->fs.pts, s->fs.time_base, outlink->time_base);
284 return ff_filter_frame(outlink, out);
287 static int config_output(AVFilterLink *outlink)
289 AVFilterContext *ctx = outlink->src;
290 RemapContext *s = ctx->priv;
291 AVFilterLink *srclink = ctx->inputs[0];
292 AVFilterLink *xlink = ctx->inputs[1];
293 AVFilterLink *ylink = ctx->inputs[2];
297 if (xlink->w != ylink->w || xlink->h != ylink->h) {
298 av_log(ctx, AV_LOG_ERROR, "Second input link %s parameters "
299 "(size %dx%d) do not match the corresponding "
300 "third input link %s parameters (%dx%d)\n",
301 ctx->input_pads[1].name, xlink->w, xlink->h,
302 ctx->input_pads[2].name, ylink->w, ylink->h);
303 return AVERROR(EINVAL);
306 outlink->w = xlink->w;
307 outlink->h = xlink->h;
308 outlink->sample_aspect_ratio = srclink->sample_aspect_ratio;
309 outlink->frame_rate = srclink->frame_rate;
311 ret = ff_framesync_init(&s->fs, ctx, 3);
316 in[0].time_base = srclink->time_base;
317 in[1].time_base = xlink->time_base;
318 in[2].time_base = ylink->time_base;
320 in[0].before = EXT_STOP;
321 in[0].after = EXT_STOP;
323 in[1].before = EXT_NULL;
324 in[1].after = EXT_INFINITY;
326 in[2].before = EXT_NULL;
327 in[2].after = EXT_INFINITY;
329 s->fs.on_event = process_frame;
331 ret = ff_framesync_configure(&s->fs);
332 outlink->time_base = s->fs.time_base;
337 static int activate(AVFilterContext *ctx)
339 RemapContext *s = ctx->priv;
340 return ff_framesync_activate(&s->fs);
343 static av_cold void uninit(AVFilterContext *ctx)
345 RemapContext *s = ctx->priv;
347 ff_framesync_uninit(&s->fs);
350 static const AVFilterPad remap_inputs[] = {
353 .type = AVMEDIA_TYPE_VIDEO,
354 .config_props = config_input,
358 .type = AVMEDIA_TYPE_VIDEO,
362 .type = AVMEDIA_TYPE_VIDEO,
367 static const AVFilterPad remap_outputs[] = {
370 .type = AVMEDIA_TYPE_VIDEO,
371 .config_props = config_output,
376 AVFilter ff_vf_remap = {
378 .description = NULL_IF_CONFIG_SMALL("Remap pixels."),
379 .priv_size = sizeof(RemapContext),
381 .query_formats = query_formats,
382 .activate = activate,
383 .inputs = remap_inputs,
384 .outputs = remap_outputs,
385 .priv_class = &remap_class,
386 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SLICE_THREADS,