FFmpeg
vf_lagfun.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019 Paul B Mahol
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 #include "libavutil/imgutils.h"
22 #include "libavutil/intreadwrite.h"
23 #include "libavutil/opt.h"
24 #include "libavutil/pixdesc.h"
25 
26 #include "avfilter.h"
27 #include "formats.h"
28 #include "internal.h"
29 #include "video.h"
30 
31 typedef struct LagfunContext {
32  const AVClass *class;
33  float decay;
34  int planes;
35 
36  int depth;
37  int nb_planes;
38  int linesize[4];
39  int planewidth[4];
40  int planeheight[4];
41 
42  float *old[4];
43 
44  int (*lagfun)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
46 
47 static const enum AVPixelFormat pixel_fmts[] = {
67 };
68 
69 typedef struct ThreadData {
70  AVFrame *in, *out;
71 } ThreadData;
72 
73 #define LAGFUN(name, type) \
74 static int lagfun_frame##name(AVFilterContext *ctx, void *arg, \
75  int jobnr, int nb_jobs) \
76 { \
77  LagfunContext *s = ctx->priv; \
78  const float decay = s->decay; \
79  ThreadData *td = arg; \
80  AVFrame *in = td->in; \
81  AVFrame *out = td->out; \
82  \
83  for (int p = 0; p < s->nb_planes; p++) { \
84  const int slice_start = (s->planeheight[p] * jobnr) / nb_jobs; \
85  const int slice_end = (s->planeheight[p] * (jobnr+1)) / nb_jobs; \
86  const type *src = (const type *)in->data[p] + \
87  slice_start * in->linesize[p] / sizeof(type); \
88  float *osrc = s->old[p] + slice_start * s->planewidth[p]; \
89  type *dst = (type *)out->data[p] + \
90  slice_start * out->linesize[p] / sizeof(type); \
91  \
92  if (!((1 << p) & s->planes)) { \
93  av_image_copy_plane((uint8_t *)dst, out->linesize[p], \
94  (const uint8_t *)src, in->linesize[p], \
95  s->linesize[p], slice_end - slice_start); \
96  continue; \
97  } \
98  \
99  for (int y = slice_start; y < slice_end; y++) { \
100  for (int x = 0; x < s->planewidth[p]; x++) { \
101  float v = FFMAX(src[x], osrc[x] * decay); \
102  \
103  osrc[x] = v; \
104  if (ctx->is_disabled) { \
105  dst[x] = src[x]; \
106  } else { \
107  dst[x] = lrintf(v); \
108  } \
109  } \
110  \
111  src += in->linesize[p] / sizeof(type); \
112  osrc += s->planewidth[p]; \
113  dst += out->linesize[p] / sizeof(type); \
114  } \
115  } \
116  \
117  return 0; \
118 }
119 
120 LAGFUN(8, uint8_t)
121 LAGFUN(16, uint16_t)
122 
123 static int config_output(AVFilterLink *outlink)
124 {
125  AVFilterContext *ctx = outlink->src;
126  LagfunContext *s = ctx->priv;
127  AVFilterLink *inlink = ctx->inputs[0];
128  const AVPixFmtDescriptor *desc;
129  int ret;
130 
131  desc = av_pix_fmt_desc_get(outlink->format);
132  if (!desc)
133  return AVERROR_BUG;
134  s->nb_planes = av_pix_fmt_count_planes(outlink->format);
135  s->depth = desc->comp[0].depth;
136  s->lagfun = s->depth <= 8 ? lagfun_frame8 : lagfun_frame16;
137 
138  if ((ret = av_image_fill_linesizes(s->linesize, inlink->format, inlink->w)) < 0)
139  return ret;
140 
141  s->planewidth[1] = s->planewidth[2] = AV_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
142  s->planewidth[0] = s->planewidth[3] = inlink->w;
143  s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
144  s->planeheight[0] = s->planeheight[3] = inlink->h;
145 
146  for (int p = 0; p < s->nb_planes; p++) {
147  s->old[p] = av_calloc(s->planewidth[p] * s->planeheight[p], sizeof(*s->old[0]));
148  if (!s->old[p])
149  return AVERROR(ENOMEM);
150  }
151 
152  return 0;
153 }
154 
156 {
157  AVFilterContext *ctx = inlink->dst;
158  AVFilterLink *outlink = ctx->outputs[0];
159  LagfunContext *s = ctx->priv;
160  ThreadData td;
161  AVFrame *out;
162 
163  out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
164  if (!out) {
165  av_frame_free(&in);
166  return AVERROR(ENOMEM);
167  }
168  out->pts = in->pts;
169 
170  td.out = out;
171  td.in = in;
172  ff_filter_execute(ctx, s->lagfun, &td, NULL,
173  FFMIN(s->planeheight[1], ff_filter_get_nb_threads(ctx)));
174 
175  av_frame_free(&in);
176  return ff_filter_frame(outlink, out);
177 }
178 
180 {
181  LagfunContext *s = ctx->priv;
182 
183  for (int p = 0; p < s->nb_planes; p++)
184  av_freep(&s->old[p]);
185 }
186 
187 #define OFFSET(x) offsetof(LagfunContext, x)
188 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_FILTERING_PARAM | AV_OPT_FLAG_RUNTIME_PARAM
189 
190 static const AVOption lagfun_options[] = {
191  { "decay", "set decay", OFFSET(decay), AV_OPT_TYPE_FLOAT, {.dbl=.95}, 0, 1, FLAGS },
192  { "planes", "set what planes to filter", OFFSET(planes), AV_OPT_TYPE_FLAGS, {.i64=15}, 0, 15, FLAGS },
193  { NULL },
194 };
195 
196 static const AVFilterPad inputs[] = {
197  {
198  .name = "default",
199  .type = AVMEDIA_TYPE_VIDEO,
200  .filter_frame = filter_frame,
201  },
202 };
203 
204 static const AVFilterPad outputs[] = {
205  {
206  .name = "default",
207  .type = AVMEDIA_TYPE_VIDEO,
208  .config_props = config_output,
209  },
210 };
211 
212 AVFILTER_DEFINE_CLASS(lagfun);
213 
215  .name = "lagfun",
216  .description = NULL_IF_CONFIG_SMALL("Slowly update darker pixels."),
217  .priv_size = sizeof(LagfunContext),
218  .priv_class = &lagfun_class,
219  .uninit = uninit,
224  .process_command = ff_filter_process_command,
225 };
ff_get_video_buffer
AVFrame * ff_get_video_buffer(AVFilterLink *link, int w, int h)
Request a picture buffer with a specific set of permissions.
Definition: video.c:98
td
#define td
Definition: regdef.h:70
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(lagfun)
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
opt.h
out
FILE * out
Definition: movenc.c:54
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1018
av_pix_fmt_desc_get
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2564
FILTER_PIXFMTS_ARRAY
#define FILTER_PIXFMTS_ARRAY(array)
Definition: internal.h:171
inlink
The exact code depends on how similar the blocks are and how related they are to the and needs to apply these operations to the correct inlink or outlink if there are several Macros are available to factor that when no extra processing is inlink
Definition: filter_design.txt:212
LagfunContext::lagfun
int(* lagfun)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
Definition: vf_lagfun.c:44
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:112
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
pixdesc.h
AVFrame::pts
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:396
AVOption
AVOption.
Definition: opt.h:247
config_output
static int config_output(AVFilterLink *outlink)
Definition: vf_lagfun.c:123
AV_PIX_FMT_YUV420P10
#define AV_PIX_FMT_YUV420P10
Definition: pixfmt.h:391
LagfunContext
Definition: vf_lagfun.c:31
AV_PIX_FMT_YUV440P
@ AV_PIX_FMT_YUV440P
planar YUV 4:4:0 (1 Cr & Cb sample per 1x2 Y samples)
Definition: pixfmt.h:99
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:153
pixel_fmts
static enum AVPixelFormat pixel_fmts[]
Definition: vf_lagfun.c:47
ThreadData::out
AVFrame * out
Definition: af_adeclick.c:473
video.h
AV_PIX_FMT_GRAY9
#define AV_PIX_FMT_GRAY9
Definition: pixfmt.h:371
planes
static const struct @320 planes[]
formats.h
av_pix_fmt_count_planes
int av_pix_fmt_count_planes(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2604
AV_PIX_FMT_GBRP14
#define AV_PIX_FMT_GBRP14
Definition: pixfmt.h:409
AV_PIX_FMT_GBRP10
#define AV_PIX_FMT_GBRP10
Definition: pixfmt.h:407
AV_PIX_FMT_YUV422P9
#define AV_PIX_FMT_YUV422P9
Definition: pixfmt.h:389
LagfunContext::planeheight
int planeheight[4]
Definition: vf_lagfun.c:40
AV_PIX_FMT_GRAY16
#define AV_PIX_FMT_GRAY16
Definition: pixfmt.h:375
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:50
AV_PIX_FMT_YUV444P10
#define AV_PIX_FMT_YUV444P10
Definition: pixfmt.h:394
AV_PIX_FMT_YUVJ411P
@ AV_PIX_FMT_YUVJ411P
planar YUV 4:1:1, 12bpp, (1 Cr & Cb sample per 4x1 Y samples) full scale (JPEG), deprecated in favor ...
Definition: pixfmt.h:248
inputs
static const AVFilterPad inputs[]
Definition: vf_lagfun.c:196
av_cold
#define av_cold
Definition: attributes.h:90
AV_PIX_FMT_YUV422P16
#define AV_PIX_FMT_YUV422P16
Definition: pixfmt.h:403
AV_PIX_FMT_YUVJ422P
@ AV_PIX_FMT_YUVJ422P
planar YUV 4:2:2, 16bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV422P and setting col...
Definition: pixfmt.h:79
av_image_fill_linesizes
int av_image_fill_linesizes(int linesizes[4], enum AVPixelFormat pix_fmt, int width)
Fill plane linesizes for an image with pixel format pix_fmt and width width.
Definition: imgutils.c:89
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:257
ff_vf_lagfun
const AVFilter ff_vf_lagfun
Definition: vf_lagfun.c:214
AV_PIX_FMT_YUV444P16
#define AV_PIX_FMT_YUV444P16
Definition: pixfmt.h:404
AV_CEIL_RSHIFT
#define AV_CEIL_RSHIFT(a, b)
Definition: common.h:51
LagfunContext::nb_planes
int nb_planes
Definition: vf_lagfun.c:37
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_lagfun.c:179
AV_PIX_FMT_YUV420P9
#define AV_PIX_FMT_YUV420P9
Definition: pixfmt.h:388
AV_PIX_FMT_YUV420P16
#define AV_PIX_FMT_YUV420P16
Definition: pixfmt.h:402
ctx
AVFormatContext * ctx
Definition: movenc.c:48
AV_PIX_FMT_GRAY14
#define AV_PIX_FMT_GRAY14
Definition: pixfmt.h:374
LagfunContext::planes
int planes
Definition: vf_lagfun.c:34
AV_PIX_FMT_YUV420P
@ AV_PIX_FMT_YUV420P
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:66
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: internal.h:191
AV_PIX_FMT_YUVJ444P
@ AV_PIX_FMT_YUVJ444P
planar YUV 4:4:4, 24bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV444P and setting col...
Definition: pixfmt.h:80
arg
const char * arg
Definition: jacosubdec.c:67
AV_PIX_FMT_GRAY10
#define AV_PIX_FMT_GRAY10
Definition: pixfmt.h:372
AV_PIX_FMT_GBRP16
#define AV_PIX_FMT_GBRP16
Definition: pixfmt.h:410
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
NULL
#define NULL
Definition: coverity.c:32
LagfunContext::old
float * old[4]
Definition: vf_lagfun.c:42
AV_PIX_FMT_YUVJ420P
@ AV_PIX_FMT_YUVJ420P
planar YUV 4:2:0, 12bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV420P and setting col...
Definition: pixfmt.h:78
LagfunContext::planewidth
int planewidth[4]
Definition: vf_lagfun.c:39
AV_PIX_FMT_YUV440P10
#define AV_PIX_FMT_YUV440P10
Definition: pixfmt.h:393
AV_PIX_FMT_YUV422P10
#define AV_PIX_FMT_YUV422P10
Definition: pixfmt.h:392
AV_PIX_FMT_GRAY8
@ AV_PIX_FMT_GRAY8
Y , 8bpp.
Definition: pixfmt.h:74
AV_PIX_FMT_GBRP9
#define AV_PIX_FMT_GBRP9
Definition: pixfmt.h:406
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:117
AV_PIX_FMT_YUV422P12
#define AV_PIX_FMT_YUV422P12
Definition: pixfmt.h:396
AV_PIX_FMT_YUV444P12
#define AV_PIX_FMT_YUV444P12
Definition: pixfmt.h:398
LagfunContext::decay
float decay
Definition: vf_lagfun.c:33
ff_filter_process_command
int ff_filter_process_command(AVFilterContext *ctx, const char *cmd, const char *arg, char *res, int res_len, int flags)
Generic processing of user supplied commands that are set in the same way as the filter options.
Definition: avfilter.c:882
FLAGS
#define FLAGS
Definition: vf_lagfun.c:188
internal.h
AV_OPT_TYPE_FLOAT
@ AV_OPT_TYPE_FLOAT
Definition: opt.h:227
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Definition: vf_lagfun.c:155
AV_PIX_FMT_GBRP12
#define AV_PIX_FMT_GBRP12
Definition: pixfmt.h:408
ff_filter_get_nb_threads
int ff_filter_get_nb_threads(AVFilterContext *ctx)
Get number of threads for current filter instance.
Definition: avfilter.c:803
ThreadData
Used for passing data between threads.
Definition: dsddec.c:67
FFMIN
#define FFMIN(a, b)
Definition: macros.h:49
AV_PIX_FMT_YUVJ440P
@ AV_PIX_FMT_YUVJ440P
planar YUV 4:4:0 full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV440P and setting color_range
Definition: pixfmt.h:100
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:56
av_calloc
void * av_calloc(size_t nmemb, size_t size)
Definition: mem.c:271
AV_PIX_FMT_YUV444P9
#define AV_PIX_FMT_YUV444P9
Definition: pixfmt.h:390
AVFilter
Filter definition.
Definition: avfilter.h:149
ret
ret
Definition: filter_design.txt:187
AV_PIX_FMT_YUV420P12
#define AV_PIX_FMT_YUV420P12
Definition: pixfmt.h:395
AV_PIX_FMT_YUV422P14
#define AV_PIX_FMT_YUV422P14
Definition: pixfmt.h:400
outputs
static const AVFilterPad outputs[]
Definition: vf_lagfun.c:204
AV_PIX_FMT_NONE
@ AV_PIX_FMT_NONE
Definition: pixfmt.h:65
avfilter.h
AV_PIX_FMT_YUV444P
@ AV_PIX_FMT_YUV444P
planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
Definition: pixfmt.h:71
AVFilterContext
An instance of a filter.
Definition: avfilter.h:386
AV_PIX_FMT_GBRP
@ AV_PIX_FMT_GBRP
planar GBR 4:4:4 24bpp
Definition: pixfmt.h:158
AVFILTER_FLAG_SLICE_THREADS
#define AVFILTER_FLAG_SLICE_THREADS
The filter supports multithreading by splitting frames into multiple parts and processing them concur...
Definition: avfilter.h:121
desc
const char * desc
Definition: libsvtav1.c:79
lagfun_options
static const AVOption lagfun_options[]
Definition: vf_lagfun.c:190
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
AV_PIX_FMT_YUV422P
@ AV_PIX_FMT_YUV422P
planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
Definition: pixfmt.h:70
LAGFUN
#define LAGFUN(name, type)
Definition: vf_lagfun.c:73
ThreadData::in
AVFrame * in
Definition: af_adecorrelate.c:154
AVPixFmtDescriptor
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
Definition: pixdesc.h:69
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:192
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:35
AV_PIX_FMT_YUV411P
@ AV_PIX_FMT_YUV411P
planar YUV 4:1:1, 12bpp, (1 Cr & Cb sample per 4x1 Y samples)
Definition: pixfmt.h:73
AV_OPT_TYPE_FLAGS
@ AV_OPT_TYPE_FLAGS
Definition: opt.h:223
AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL
#define AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL
Same as AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC, except that the filter will have its filter_frame() c...
Definition: avfilter.h:138
imgutils.h
AVERROR_BUG
#define AVERROR_BUG
Internal bug, also see AVERROR_BUG2.
Definition: error.h:52
AV_PIX_FMT_YUV410P
@ AV_PIX_FMT_YUV410P
planar YUV 4:1:0, 9bpp, (1 Cr & Cb sample per 4x4 Y samples)
Definition: pixfmt.h:72
OFFSET
#define OFFSET(x)
Definition: vf_lagfun.c:187
AV_PIX_FMT_YUV440P12
#define AV_PIX_FMT_YUV440P12
Definition: pixfmt.h:397
AV_PIX_FMT_YUV444P14
#define AV_PIX_FMT_YUV444P14
Definition: pixfmt.h:401
AV_PIX_FMT_GRAY12
#define AV_PIX_FMT_GRAY12
Definition: pixfmt.h:373
LagfunContext::linesize
int linesize[4]
Definition: vf_lagfun.c:38
ff_filter_execute
static av_always_inline int ff_filter_execute(AVFilterContext *ctx, avfilter_action_func *func, void *arg, int *ret, int nb_jobs)
Definition: internal.h:143
int
int
Definition: ffmpeg_filter.c:156
LagfunContext::depth
int depth
Definition: vf_lagfun.c:36
AV_PIX_FMT_YUV420P14
#define AV_PIX_FMT_YUV420P14
Definition: pixfmt.h:399