FFmpeg
vf_fieldhint.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016 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/avassert.h"
22 #include "libavutil/imgutils.h"
23 #include "libavutil/internal.h"
24 #include "libavutil/opt.h"
25 #include "libavutil/pixdesc.h"
26 #include "avfilter.h"
27 #include "internal.h"
28 #include "video.h"
29 
30 enum HintModes {
35 };
36 
37 typedef struct FieldHintContext {
38  const AVClass *class;
39 
41  FILE *hint;
42  int mode;
43 
45 
46  int64_t line;
47  int nb_planes;
48  int eof;
49  int planewidth[4];
50  int planeheight[4];
52 
53 #define OFFSET(x) offsetof(FieldHintContext, x)
54 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
55 
56 static const AVOption fieldhint_options[] = {
57  { "hint", "set hint file", OFFSET(hint_file_str), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS },
58  { "mode", "set hint mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=0}, 0, NB_HINTS-1, FLAGS, "mode" },
59  { "absolute", 0, 0, AV_OPT_TYPE_CONST, {.i64=ABSOLUTE_HINT}, 0, 0, FLAGS, "mode" },
60  { "relative", 0, 0, AV_OPT_TYPE_CONST, {.i64=RELATIVE_HINT}, 0, 0, FLAGS, "mode" },
61  { "pattern", 0, 0, AV_OPT_TYPE_CONST, {.i64=PATTERN_HINT}, 0, 0, FLAGS, "mode" },
62  { NULL }
63 };
64 
65 AVFILTER_DEFINE_CLASS(fieldhint);
66 
68 {
69  FieldHintContext *s = ctx->priv;
70  int ret;
71 
72  if (!s->hint_file_str) {
73  av_log(ctx, AV_LOG_ERROR, "Hint file must be set.\n");
74  return AVERROR(EINVAL);
75  }
76  s->hint = avpriv_fopen_utf8(s->hint_file_str, "r");
77  if (!s->hint) {
78  ret = AVERROR(errno);
79  av_log(ctx, AV_LOG_ERROR, "%s: %s\n", s->hint_file_str, av_err2str(ret));
80  return ret;
81  }
82 
83  return 0;
84 }
85 
87 {
88  int reject_flags = AV_PIX_FMT_FLAG_BITSTREAM |
91 
92  return ff_set_common_formats(ctx, ff_formats_pixdesc_filter(0, reject_flags));
93 }
94 
96 {
97  FieldHintContext *s = inlink->dst->priv;
99  int ret;
100 
101  if ((ret = av_image_fill_linesizes(s->planewidth, inlink->format, inlink->w)) < 0)
102  return ret;
103 
104  s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
105  s->planeheight[0] = s->planeheight[3] = inlink->h;
106 
107  s->nb_planes = av_pix_fmt_count_planes(inlink->format);
108 
109  return 0;
110 }
111 
113 {
114  AVFilterContext *ctx = inlink->dst;
115  AVFilterLink *outlink = ctx->outputs[0];
116  FieldHintContext *s = ctx->priv;
117  AVFrame *out, *top, *bottom;
118  char buf[1024] = { 0 };
119  int64_t tf, bf;
120  int tfactor = 0, bfactor = 1;
121  char hint = '=', field = '=';
122  int p;
123 
124  av_frame_free(&s->frame[0]);
125  s->frame[0] = s->frame[1];
126  s->frame[1] = s->frame[2];
127  s->frame[2] = in;
128  if (!s->frame[1])
129  return 0;
130  else if (!s->frame[0]) {
131  s->frame[0] = av_frame_clone(s->frame[1]);
132  if (!s->frame[0])
133  return AVERROR(ENOMEM);
134  }
135 
136  while (1) {
137  if (fgets(buf, sizeof(buf)-1, s->hint)) {
138  s->line++;
139  if (buf[0] == '#' || buf[0] == ';') {
140  continue;
141  } else if (sscanf(buf, "%"PRId64",%"PRId64" %c %c", &tf, &bf, &hint, &field) == 4) {
142  ;
143  } else if (sscanf(buf, "%"PRId64",%"PRId64" %c", &tf, &bf, &hint) == 3) {
144  ;
145  } else if (sscanf(buf, "%"PRId64",%"PRId64"", &tf, &bf) == 2) {
146  ;
147  } else {
148  av_log(ctx, AV_LOG_ERROR, "Invalid entry at line %"PRId64".\n", s->line);
149  return AVERROR_INVALIDDATA;
150  }
151  switch (s->mode) {
152  case ABSOLUTE_HINT:
153  if (tf > outlink->frame_count_in + 1 || tf < FFMAX(0, outlink->frame_count_in - 1) ||
154  bf > outlink->frame_count_in + 1 || bf < FFMAX(0, outlink->frame_count_in - 1)) {
155  av_log(ctx, AV_LOG_ERROR, "Out of range frames %"PRId64" and/or %"PRId64" on line %"PRId64" for %"PRId64". input frame.\n", tf, bf, s->line, inlink->frame_count_out);
156  return AVERROR_INVALIDDATA;
157  }
158  break;
159  case PATTERN_HINT:
160  case RELATIVE_HINT:
161  if (tf > 1 || tf < -1 ||
162  bf > 1 || bf < -1) {
163  av_log(ctx, AV_LOG_ERROR, "Out of range %"PRId64" and/or %"PRId64" on line %"PRId64" for %"PRId64". input frame.\n", tf, bf, s->line, inlink->frame_count_out);
164  return AVERROR_INVALIDDATA;
165  }
166  break;
167  default:
168  return AVERROR_BUG;
169  };
170  break;
171  } else {
172  if (s->mode == PATTERN_HINT) {
173  fseek(s->hint, 0, SEEK_SET);
174  continue;
175  }
176  av_log(ctx, AV_LOG_ERROR, "Missing entry for %"PRId64". input frame.\n", inlink->frame_count_out);
177  return AVERROR_INVALIDDATA;
178  }
179  }
180 
181  out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
182  if (!out)
183  return AVERROR(ENOMEM);
184  av_frame_copy_props(out, s->frame[1]);
185 
186  switch (s->mode) {
187  case ABSOLUTE_HINT:
188  top = s->frame[tf - outlink->frame_count_in + 1];
189  bottom = s->frame[bf - outlink->frame_count_in + 1];
190  break;
191  case PATTERN_HINT:
192  case RELATIVE_HINT:
193  top = s->frame[1 + tf];
194  bottom = s->frame[1 + bf];
195  break;
196  default:
197  av_assert0(0);
198  }
199 
200  switch (field) {
201  case 'b':
202  tfactor = 1;
203  top = bottom;
204  break;
205  case 't':
206  bfactor = 0;
207  bottom = top;
208  break;
209  case '=':
210  break;
211  default:
212  av_log(ctx, AV_LOG_ERROR, "Invalid field: %c.\n", field);
213  av_frame_free(&out);
214  return AVERROR(EINVAL);
215  }
216 
217  switch (hint) {
218  case '+':
219  out->interlaced_frame = 1;
220  break;
221  case '-':
222  out->interlaced_frame = 0;
223  break;
224  case '=':
225  break;
226  case 'b':
227  tfactor = 1;
228  top = bottom;
229  break;
230  case 't':
231  bfactor = 0;
232  bottom = top;
233  break;
234  default:
235  av_log(ctx, AV_LOG_ERROR, "Invalid hint: %c.\n", hint);
236  av_frame_free(&out);
237  return AVERROR(EINVAL);
238  }
239 
240  for (p = 0; p < s->nb_planes; p++) {
241  av_image_copy_plane(out->data[p],
242  out->linesize[p] * 2,
243  top->data[p] + tfactor * top->linesize[p],
244  top->linesize[p] * 2,
245  s->planewidth[p],
246  (s->planeheight[p] + 1) / 2);
247  av_image_copy_plane(out->data[p] + out->linesize[p],
248  out->linesize[p] * 2,
249  bottom->data[p] + bfactor * bottom->linesize[p],
250  bottom->linesize[p] * 2,
251  s->planewidth[p],
252  (s->planeheight[p] + 1) / 2);
253  }
254 
255  return ff_filter_frame(outlink, out);
256 }
257 
258 static int request_frame(AVFilterLink *outlink)
259 {
260  AVFilterContext *ctx = outlink->src;
261  FieldHintContext *s = ctx->priv;
262  int ret;
263 
264  if (s->eof)
265  return AVERROR_EOF;
266 
267  ret = ff_request_frame(ctx->inputs[0]);
268  if (ret == AVERROR_EOF && s->frame[2]) {
269  AVFrame *next = av_frame_clone(s->frame[2]);
270  if (!next)
271  return AVERROR(ENOMEM);
272  ret = filter_frame(ctx->inputs[0], next);
273  s->eof = 1;
274  }
275 
276  return ret;
277 }
278 
280 {
281  FieldHintContext *s = ctx->priv;
282 
283  if (s->hint)
284  fclose(s->hint);
285  s->hint = NULL;
286 
287  av_frame_free(&s->frame[0]);
288  av_frame_free(&s->frame[1]);
289  av_frame_free(&s->frame[2]);
290 }
291 
292 static const AVFilterPad inputs[] = {
293  {
294  .name = "default",
295  .type = AVMEDIA_TYPE_VIDEO,
296  .config_props = config_input,
297  .filter_frame = filter_frame,
298  },
299 };
300 
301 static const AVFilterPad outputs[] = {
302  {
303  .name = "default",
304  .type = AVMEDIA_TYPE_VIDEO,
305  .request_frame = request_frame,
306  },
307 };
308 
310  .name = "fieldhint",
311  .description = NULL_IF_CONFIG_SMALL("Field matching using hints."),
312  .priv_size = sizeof(FieldHintContext),
313  .priv_class = &fieldhint_class,
314  .init = init,
315  .uninit = uninit,
319 };
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
FieldHintContext
Definition: vf_fieldhint.c:37
inputs
static const AVFilterPad inputs[]
Definition: vf_fieldhint.c:292
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:999
av_pix_fmt_desc_get
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2703
AVERROR_EOF
#define AVERROR_EOF
End of file.
Definition: error.h:57
FieldHintContext::hint
FILE * hint
Definition: vf_fieldhint.c:41
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
FieldHintContext::nb_planes
int nb_planes
Definition: vf_fieldhint.c:47
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:325
pixdesc.h
FLAGS
#define FLAGS
Definition: vf_fieldhint.c:54
ff_vf_fieldhint
const AVFilter ff_vf_fieldhint
Definition: vf_fieldhint.c:309
AVOption
AVOption.
Definition: opt.h:251
FILTER_QUERY_FUNC
#define FILTER_QUERY_FUNC(func)
Definition: internal.h:167
ff_request_frame
int ff_request_frame(AVFilterLink *link)
Request an input frame from the filter at the other end of the link.
Definition: avfilter.c:400
init
static av_cold int init(AVFilterContext *ctx)
Definition: vf_fieldhint.c:67
FFMAX
#define FFMAX(a, b)
Definition: macros.h:47
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
av_image_copy_plane
void av_image_copy_plane(uint8_t *dst, int dst_linesize, const uint8_t *src, int src_linesize, int bytewidth, int height)
Copy image plane from src to dst.
Definition: imgutils.c:374
OFFSET
#define OFFSET(x)
Definition: vf_fieldhint.c:53
av_pix_fmt_count_planes
int av_pix_fmt_count_planes(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2743
AV_PIX_FMT_FLAG_HWACCEL
#define AV_PIX_FMT_FLAG_HWACCEL
Pixel format is an HW accelerated format.
Definition: pixdesc.h:128
FieldHintContext::planeheight
int planeheight[4]
Definition: vf_fieldhint.c:50
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:49
request_frame
static int request_frame(AVFilterLink *outlink)
Definition: vf_fieldhint.c:258
avassert.h
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
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
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
s
#define s(width, name)
Definition: cbs_vp9.c:256
AV_CEIL_RSHIFT
#define AV_CEIL_RSHIFT(a, b)
Definition: common.h:50
query_formats
static int query_formats(AVFilterContext *ctx)
Definition: vf_fieldhint.c:86
av_assert0
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:37
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
field
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this field
Definition: writing_filters.txt:78
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: internal.h:190
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
NULL
#define NULL
Definition: coverity.c:32
FieldHintContext::mode
int mode
Definition: vf_fieldhint.c:42
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
FieldHintContext::hint_file_str
char * hint_file_str
Definition: vf_fieldhint.c:40
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(fieldhint)
ABSOLUTE_HINT
@ ABSOLUTE_HINT
Definition: vf_fieldhint.c:31
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
FieldHintContext::frame
AVFrame * frame[3]
Definition: vf_fieldhint.c:44
av_err2str
#define av_err2str(errnum)
Convenience macro, the return value should be used only directly in function arguments but never stan...
Definition: error.h:121
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
internal.h
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
internal.h
fieldhint_options
static const AVOption fieldhint_options[]
Definition: vf_fieldhint.c:56
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:55
avpriv_fopen_utf8
FILE * avpriv_fopen_utf8(const char *path, const char *mode)
Open a file using a UTF-8 filename.
Definition: file_open.c:158
FieldHintContext::planewidth
int planewidth[4]
Definition: vf_fieldhint.c:49
config_input
static int config_input(AVFilterLink *inlink)
Definition: vf_fieldhint.c:95
AVFilter
Filter definition.
Definition: avfilter.h:171
ret
ret
Definition: filter_design.txt:187
PATTERN_HINT
@ PATTERN_HINT
Definition: vf_fieldhint.c:33
NB_HINTS
@ NB_HINTS
Definition: vf_fieldhint.c:34
mode
mode
Definition: ebur128.h:83
FieldHintContext::line
int64_t line
Definition: vf_fieldhint.c:46
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:225
avfilter.h
outputs
static const AVFilterPad outputs[]
Definition: vf_fieldhint.c:301
tf
#define tf
Definition: regdef.h:73
AVFilterContext
An instance of a filter.
Definition: avfilter.h:408
desc
const char * desc
Definition: libsvtav1.c:83
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
RELATIVE_HINT
@ RELATIVE_HINT
Definition: vf_fieldhint.c:32
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_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Definition: vf_fieldhint.c:112
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:191
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_fieldhint.c:279
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
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
AV_OPT_TYPE_STRING
@ AV_OPT_TYPE_STRING
Definition: opt.h:229
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
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Definition: opt.h:234
HintModes
HintModes
Definition: vf_fieldhint.c:30
FieldHintContext::eof
int eof
Definition: vf_fieldhint.c:48