FFmpeg
vf_feedback.c
Go to the documentation of this file.
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * FFmpeg is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with FFmpeg; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 
19 /**
20  * @file
21  * feedback video filter
22  */
23 
24 #include "libavutil/fifo.h"
25 #include "libavutil/imgutils.h"
26 #include "libavutil/opt.h"
27 #include "libavutil/internal.h"
28 #include "avfilter.h"
29 #include "filters.h"
30 #include "internal.h"
31 #include "video.h"
32 
33 typedef struct FeedbackContext {
34  const AVClass *class;
35 
36  int x, y;
37  int w, h;
38 
39  int max_step[4];
40  int hsub, vsub;
41 
43 
46 
48 {
49  if (s->x + s->w > ctx->inputs[0]->w)
50  s->x = ctx->inputs[0]->w - s->w;
51  if (s->y + s->h > ctx->inputs[0]->h)
52  s->y = ctx->inputs[0]->h - s->h;
53 }
54 
56 {
57  if (s->x >= ctx->inputs[0]->w)
58  s->x = 0;
59  if (s->y >= ctx->inputs[0]->h)
60  s->y = 0;
61 
62  if (s->w <= 0)
63  s->w = ctx->inputs[0]->w - s->x;
64  if (s->h <= 0)
65  s->h = ctx->inputs[0]->h - s->y;
66 
67  if (s->w > ctx->inputs[0]->w)
68  s->w = ctx->inputs[0]->w;
69  if (s->h > ctx->inputs[0]->h)
70  s->h = ctx->inputs[0]->h;
71 
72  adjust_pos(ctx, s);
73 }
74 
76 {
77  AVFilterContext *ctx = inlink->dst;
78  const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(inlink->format);
79  FeedbackContext *s = ctx->priv;
80 
81  s->hsub = pix_desc->log2_chroma_w;
82  s->vsub = pix_desc->log2_chroma_h;
83 
84  av_image_fill_max_pixsteps(s->max_step, NULL, pix_desc);
85 
87 
88  ctx->inputs[1]->w = s->w;
89  ctx->inputs[1]->h = s->h;
90 
91  return 0;
92 }
93 
94 static int config_output(AVFilterLink *outlink)
95 {
96  AVFilterContext *ctx = outlink->src;
97  FeedbackContext *s = ctx->priv;
98 
100 
101  ctx->outputs[0]->w = ctx->inputs[0]->w;
102  ctx->outputs[0]->h = ctx->inputs[0]->h;
103  ctx->outputs[1]->w = s->w;
104  ctx->outputs[1]->h = s->h;
105 
106  return 0;
107 }
108 
110 {
114 }
115 
117 {
118  FeedbackContext *s = ctx->priv;
119  int status, ret;
120  int64_t pts;
121 
122  adjust_pos(ctx, s);
123 
124  for (int i = 0; i < ctx->nb_outputs; i++)
126 
127  if (!s->feed) {
128  ret = ff_inlink_consume_frame(ctx->inputs[1], &s->feed);
129  if (ret < 0)
130  return ret;
131  }
132 
133  if (s->feed && av_fifo_can_read(s->fifo)) {
134  AVFrame *src = s->feed;
135  AVFrame *dst = NULL;
136 
137  av_fifo_read(s->fifo, &dst, 1);
138  if (!dst)
139  return AVERROR_BUG;
140 
141  if (!av_frame_is_writable(dst)) {
142  AVFrame *tmp = ff_get_video_buffer(ctx->outputs[0], ctx->outputs[0]->w, ctx->outputs[0]->h);
143 
144  if (!tmp) {
145  av_frame_free(&dst);
146  return AVERROR(ENOMEM);
147  }
148 
149  ret = av_frame_copy(tmp, dst);
150  if (ret < 0) {
151  av_frame_free(&dst);
152  av_frame_free(&tmp);
153  return ret;
154  }
155 
156  av_frame_copy_props(tmp, dst);
157  av_frame_free(&dst);
158  dst = tmp;
159  }
160 
161  for (int y = 0; y < src->height; y++) {
162  memmove(dst->data[0] + (s->y + y) * dst->linesize[0] + s->x * s->max_step[0],
163  src->data[0] + y * src->linesize[0], src->width * s->max_step[0]);
164  }
165 
166  for (int i = 1; i < 3; i ++) {
167  if (dst->data[i]) {
168  for (int y = 0; y < src->height; y++) {
169  memmove(dst->data[i] + ((s->y + y) >> s->vsub) * dst->linesize[i] + ((s->x * s->max_step[i]) >> s->hsub),
170  src->data[i] + (y >> s->vsub) * src->linesize[i], (src->width * s->max_step[i]) >> s->hsub);
171  }
172  }
173  }
174 
175  if (dst->data[3]) {
176  for (int y = 0; y < src->height; y++) {
177  memmove(dst->data[3] + (s->y + y) * dst->linesize[3] + s->x * s->max_step[3],
178  src->data[3] + y * src->linesize[3], src->width * s->max_step[3]);
179  }
180  }
181 
182  ret = ff_filter_frame(ctx->outputs[0], dst);
183  av_frame_free(&s->feed);
184  return ret;
185  }
186 
187  if (!s->feed) {
188  AVFrame *in = NULL;
189 
190  ret = ff_inlink_consume_frame(ctx->inputs[0], &in);
191  if (ret < 0)
192  return ret;
193 
194  if (ret > 0) {
195  AVFrame *frame;
196 
197  ret = av_fifo_write(s->fifo, &in, 1);
198  if (ret < 0) {
199  av_frame_free(&in);
200  return ret;
201  }
202 
203  frame = av_frame_clone(in);
204  if (!frame)
205  return AVERROR(ENOMEM);
206 
207  frame->width = s->w;
208  frame->height = s->h;
209 
210  frame->data[0] += s->y * frame->linesize[0];
211  frame->data[0] += s->x * s->max_step[0];
212 
213  for (int i = 1; i < 3; i ++) {
214  if (frame->data[i]) {
215  frame->data[i] += (s->y >> s->vsub) * frame->linesize[i];
216  frame->data[i] += (s->x * s->max_step[i]) >> s->hsub;
217  }
218  }
219 
220  if (frame->data[3]) {
221  frame->data[3] += s->y * frame->linesize[3];
222  frame->data[3] += s->x * s->max_step[3];
223  }
224 
225  return ff_filter_frame(ctx->outputs[1], frame);
226  }
227  }
228 
229  if (ff_inlink_acknowledge_status(ctx->inputs[0], &status, &pts)) {
230  ff_outlink_set_status(ctx->outputs[0], status, pts);
231  ff_outlink_set_status(ctx->outputs[1], status, pts);
232  return 0;
233  }
234 
235  if (ff_inlink_acknowledge_status(ctx->inputs[1], &status, &pts)) {
236  ff_outlink_set_status(ctx->outputs[0], status, pts);
237  ff_outlink_set_status(ctx->outputs[1], status, pts);
238  return 0;
239  }
240 
241  if (!s->feed) {
242  if (ff_outlink_frame_wanted(ctx->outputs[0])) {
243  ff_inlink_request_frame(ctx->inputs[0]);
244  ff_inlink_request_frame(ctx->inputs[1]);
245  return 0;
246  }
247  }
248 
249  return FFERROR_NOT_READY;
250 }
251 
253 {
254  FeedbackContext *s = ctx->priv;
255 
256  s->fifo = av_fifo_alloc2(8, sizeof(AVFrame *), AV_FIFO_FLAG_AUTO_GROW);
257  if (!s->fifo)
258  return AVERROR(ENOMEM);
259 
260  return 0;
261 }
262 
264 {
265  FeedbackContext *s = ctx->priv;
266  if (s->fifo) {
267  size_t size = av_fifo_can_read(s->fifo);
268 
269  for (size_t n = 0; n < size; n++) {
270  AVFrame *frame = NULL;
271 
272  av_fifo_read(s->fifo, &frame, 1);
273 
275  }
276 
277  av_fifo_freep2(&s->fifo);
278  }
279 }
280 
281 static const AVFilterPad inputs[] = {
282  {
283  .name = "default",
284  .type = AVMEDIA_TYPE_VIDEO,
285  .config_props = config_input,
286  },
287  {
288  .name = "feedin",
289  .type = AVMEDIA_TYPE_VIDEO,
290  .config_props = config_input,
291  },
292 };
293 
294 static const AVFilterPad outputs[] = {
295  {
296  .name = "default",
297  .type = AVMEDIA_TYPE_VIDEO,
298  .config_props = config_output,
299  },
300  {
301  .name = "feedout",
302  .type = AVMEDIA_TYPE_VIDEO,
303  .config_props = config_output,
304  },
305 };
306 
307 #define OFFSET(x) offsetof(FeedbackContext, x)
308 #define FLAGS (AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_FILTERING_PARAM)
309 #define TFLAGS (AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_FILTERING_PARAM | AV_OPT_FLAG_RUNTIME_PARAM)
310 
311 static const AVOption feedback_options[] = {
312  { "x", "set top left crop position", OFFSET(x), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, TFLAGS },
313  { "y", "set top left crop position", OFFSET(y), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, TFLAGS },
314  { "w", "set crop size", OFFSET(w), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, FLAGS },
315  { "h", "set crop size", OFFSET(h), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, FLAGS },
316  { NULL }
317 };
318 
319 AVFILTER_DEFINE_CLASS(feedback);
320 
322  .name = "feedback",
323  .description = NULL_IF_CONFIG_SMALL("Apply feedback video filter."),
324  .priv_class = &feedback_class,
325  .priv_size = sizeof(FeedbackContext),
326  .activate = activate,
327  .init = init,
328  .uninit = uninit,
332  .process_command = ff_filter_process_command,
333 };
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:101
config_input
static int config_input(AVFilterLink *inlink)
Definition: vf_feedback.c:75
FeedbackContext::h
int h
Definition: vf_feedback.c:37
status
they must not be accessed directly The fifo field contains the frames that are queued in the input for processing by the filter The status_in and status_out fields contains the queued status(EOF or error) of the link
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
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:999
av_pix_fmt_desc_get
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2703
FFERROR_NOT_READY
return FFERROR_NOT_READY
Definition: filter_design.txt:204
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
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:116
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:325
tmp
static uint8_t tmp[11]
Definition: aes_ctr.c:28
w
uint8_t w
Definition: llviddspenc.c:38
av_fifo_can_read
size_t av_fifo_can_read(const AVFifo *f)
Definition: fifo.c:87
AV_FIFO_FLAG_AUTO_GROW
#define AV_FIFO_FLAG_AUTO_GROW
Automatically resize the FIFO on writes, so that the data fits.
Definition: fifo.h:58
AVOption
AVOption.
Definition: opt.h:251
FILTER_QUERY_FUNC
#define FILTER_QUERY_FUNC(func)
Definition: internal.h:167
query_formats
static int query_formats(AVFilterContext *ctx)
Definition: vf_feedback.c:109
av_fifo_read
int av_fifo_read(AVFifo *f, void *buf, size_t nb_elems)
Read data from a FIFO.
Definition: fifo.c:240
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:175
video.h
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:346
FeedbackContext::hsub
int hsub
Definition: vf_feedback.c:40
ff_inlink_consume_frame
int ff_inlink_consume_frame(AVFilterLink *link, AVFrame **rframe)
Take a frame from the link's FIFO and update the link's stats.
Definition: avfilter.c:1394
FF_FILTER_FORWARD_STATUS_BACK_ALL
#define FF_FILTER_FORWARD_STATUS_BACK_ALL(outlink, filter)
Forward the status on an output link to all input links.
Definition: filters.h:212
fifo.h
AV_PIX_FMT_FLAG_HWACCEL
#define AV_PIX_FMT_FLAG_HWACCEL
Pixel format is an HW accelerated format.
Definition: pixdesc.h:128
activate
static int activate(AVFilterContext *ctx)
Definition: vf_feedback.c:116
TFLAGS
#define TFLAGS
Definition: vf_feedback.c:309
pts
static int64_t pts
Definition: transcode_aac.c:654
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:49
adjust_parameters
static void adjust_parameters(AVFilterContext *ctx, FeedbackContext *s)
Definition: vf_feedback.c:55
av_cold
#define av_cold
Definition: attributes.h:90
ff_set_common_formats
int ff_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats)
A helper for query_formats() which sets all links to the same list of formats.
Definition: formats.c:749
ff_outlink_set_status
static void ff_outlink_set_status(AVFilterLink *link, int status, int64_t pts)
Set the status field of a link from the source filter.
Definition: filters.h:189
ff_inlink_request_frame
void ff_inlink_request_frame(AVFilterLink *link)
Mark that a frame is wanted on the link.
Definition: avfilter.c:1511
s
#define s(width, name)
Definition: cbs_vp9.c:256
filters.h
ctx
AVFormatContext * ctx
Definition: movenc.c:48
av_frame_clone
AVFrame * av_frame_clone(const AVFrame *src)
Create a new frame that references the same data as src.
Definition: frame.c:474
AVPixFmtDescriptor::log2_chroma_w
uint8_t log2_chroma_w
Amount to shift the luma width right to find the chroma width.
Definition: pixdesc.h:80
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: internal.h:190
ff_vf_feedback
const AVFilter ff_vf_feedback
Definition: vf_feedback.c:321
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
FeedbackContext::y
int y
Definition: vf_feedback.c:36
NULL
#define NULL
Definition: coverity.c:32
av_frame_copy_props
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:603
FeedbackContext::x
int x
Definition: vf_feedback.c:36
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(feedback)
ff_inlink_acknowledge_status
int ff_inlink_acknowledge_status(AVFilterLink *link, int *rstatus, int64_t *rpts)
Test and acknowledge the change of status on the link.
Definition: avfilter.c:1348
feedback_options
static const AVOption feedback_options[]
Definition: vf_feedback.c:311
config_output
static int config_output(AVFilterLink *outlink)
Definition: vf_feedback.c:94
AVFifo
Definition: fifo.c:35
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_frame_copy
int av_frame_copy(AVFrame *dst, const AVFrame *src)
Copy the frame data from src to dst.
Definition: frame.c:771
size
int size
Definition: twinvq_data.h:10344
AV_PIX_FMT_FLAG_BITSTREAM
#define AV_PIX_FMT_FLAG_BITSTREAM
All values of a component are bit-wise packed end to end.
Definition: pixdesc.h:124
av_frame_is_writable
int av_frame_is_writable(AVFrame *frame)
Check if the frame data is writable.
Definition: frame.c:533
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:863
FeedbackContext
Definition: vf_feedback.c:33
OFFSET
#define OFFSET(x)
Definition: vf_feedback.c:307
internal.h
FeedbackContext::feed
AVFrame * feed
Definition: vf_feedback.c:42
ff_formats_pixdesc_filter
AVFilterFormats * ff_formats_pixdesc_filter(unsigned want, unsigned rej)
Construct a formats list containing all pixel formats with certain properties.
Definition: formats.c:498
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:269
internal.h
av_fifo_alloc2
AVFifo * av_fifo_alloc2(size_t nb_elems, size_t elem_size, unsigned int flags)
Allocate and initialize an AVFifo with a given element size.
Definition: fifo.c:47
inputs
static const AVFilterPad inputs[]
Definition: vf_feedback.c:281
av_fifo_freep2
void av_fifo_freep2(AVFifo **f)
Free an AVFifo and reset pointer to NULL.
Definition: fifo.c:286
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:55
FeedbackContext::max_step
int max_step[4]
Definition: vf_feedback.c:39
FLAGS
#define FLAGS
Definition: vf_feedback.c:308
AVFilter
Filter definition.
Definition: avfilter.h:171
ret
ret
Definition: filter_design.txt:187
frame
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:264
av_fifo_write
int av_fifo_write(AVFifo *f, const void *buf, size_t nb_elems)
Write data into a FIFO.
Definition: fifo.c:188
init
static av_cold int init(AVFilterContext *ctx)
Definition: vf_feedback.c:252
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:225
avfilter.h
FeedbackContext::fifo
AVFifo * fifo
Definition: vf_feedback.c:44
FeedbackContext::w
int w
Definition: vf_feedback.c:37
av_image_fill_max_pixsteps
void av_image_fill_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4], const AVPixFmtDescriptor *pixdesc)
Compute the max pixel step for each plane of an image with a format described by pixdesc.
Definition: imgutils.c:35
AVFilterContext
An instance of a filter.
Definition: avfilter.h:408
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
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:191
src
INIT_CLIP pixel * src
Definition: h264pred_template.c:418
imgutils.h
AVERROR_BUG
#define AVERROR_BUG
Internal bug, also see AVERROR_BUG2.
Definition: error.h:52
AVFrame::linesize
int linesize[AV_NUM_DATA_POINTERS]
For video, a positive or negative value, which is typically indicating the size in bytes of each pict...
Definition: frame.h:370
h
h
Definition: vp9dsp_template.c:2038
ff_outlink_frame_wanted
the definition of that something depends on the semantic of the filter The callback must examine the status of the filter s links and proceed accordingly The status of output links is stored in the status_in and status_out fields and tested by the ff_outlink_frame_wanted() function. If this function returns true
outputs
static const AVFilterPad outputs[]
Definition: vf_feedback.c:294
adjust_pos
static void adjust_pos(AVFilterContext *ctx, FeedbackContext *s)
Definition: vf_feedback.c:47
AV_PIX_FMT_FLAG_PAL
#define AV_PIX_FMT_FLAG_PAL
Pixel format has a palette in data[1], values are indexes in this palette.
Definition: pixdesc.h:120
AVPixFmtDescriptor::log2_chroma_h
uint8_t log2_chroma_h
Amount to shift the luma height right to find the chroma height.
Definition: pixdesc.h:89
FeedbackContext::vsub
int vsub
Definition: vf_feedback.c:40
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_feedback.c:263