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 typedef struct FieldHintContext {
31  const AVClass *class;
32 
34  FILE *hint;
35  int mode;
36 
38 
39  int64_t line;
40  int nb_planes;
41  int eof;
42  int planewidth[4];
43  int planeheight[4];
45 
46 #define OFFSET(x) offsetof(FieldHintContext, x)
47 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
48 
49 static const AVOption fieldhint_options[] = {
50  { "hint", "set hint file", OFFSET(hint_file_str), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS },
51  { "mode", "set hint mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS, "mode" },
52  { "absolute", 0, 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, FLAGS, "mode" },
53  { "relative", 0, 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, FLAGS, "mode" },
54  { NULL }
55 };
56 
57 AVFILTER_DEFINE_CLASS(fieldhint);
58 
60 {
61  FieldHintContext *s = ctx->priv;
62  int ret;
63 
64  if (!s->hint_file_str) {
65  av_log(ctx, AV_LOG_ERROR, "Hint file must be set.\n");
66  return AVERROR(EINVAL);
67  }
68  s->hint = av_fopen_utf8(s->hint_file_str, "r");
69  if (!s->hint) {
70  ret = AVERROR(errno);
71  av_log(ctx, AV_LOG_ERROR, "%s: %s\n", s->hint_file_str, av_err2str(ret));
72  return ret;
73  }
74 
75  return 0;
76 }
77 
79 {
80  int reject_flags = AV_PIX_FMT_FLAG_BITSTREAM |
83 
84  return ff_set_common_formats(ctx, ff_formats_pixdesc_filter(0, reject_flags));
85 }
86 
88 {
89  FieldHintContext *s = inlink->dst->priv;
91  int ret;
92 
93  if ((ret = av_image_fill_linesizes(s->planewidth, inlink->format, inlink->w)) < 0)
94  return ret;
95 
96  s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
97  s->planeheight[0] = s->planeheight[3] = inlink->h;
98 
99  s->nb_planes = av_pix_fmt_count_planes(inlink->format);
100 
101  return 0;
102 }
103 
105 {
106  AVFilterContext *ctx = inlink->dst;
107  AVFilterLink *outlink = ctx->outputs[0];
108  FieldHintContext *s = ctx->priv;
109  AVFrame *out, *top, *bottom;
110  char buf[1024] = { 0 };
111  int64_t tf, bf;
112  int tfactor = 0, bfactor = 1;
113  char hint = '=', field = '=';
114  int p;
115 
116  av_frame_free(&s->frame[0]);
117  s->frame[0] = s->frame[1];
118  s->frame[1] = s->frame[2];
119  s->frame[2] = in;
120  if (!s->frame[1])
121  return 0;
122  else if (!s->frame[0]) {
123  s->frame[0] = av_frame_clone(s->frame[1]);
124  if (!s->frame[0])
125  return AVERROR(ENOMEM);
126  }
127 
128  while (1) {
129  if (fgets(buf, sizeof(buf)-1, s->hint)) {
130  s->line++;
131  if (buf[0] == '#' || buf[0] == ';') {
132  continue;
133  } else if (sscanf(buf, "%"PRId64",%"PRId64" %c %c", &tf, &bf, &hint, &field) == 4) {
134  ;
135  } else if (sscanf(buf, "%"PRId64",%"PRId64" %c", &tf, &bf, &hint) == 3) {
136  ;
137  } else if (sscanf(buf, "%"PRId64",%"PRId64"", &tf, &bf) == 2) {
138  ;
139  } else {
140  av_log(ctx, AV_LOG_ERROR, "Invalid entry at line %"PRId64".\n", s->line);
141  return AVERROR_INVALIDDATA;
142  }
143  switch (s->mode) {
144  case 0:
145  if (tf > outlink->frame_count_in + 1 || tf < FFMAX(0, outlink->frame_count_in - 1) ||
146  bf > outlink->frame_count_in + 1 || bf < FFMAX(0, outlink->frame_count_in - 1)) {
147  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);
148  return AVERROR_INVALIDDATA;
149  }
150  break;
151  case 1:
152  if (tf > 1 || tf < -1 ||
153  bf > 1 || bf < -1) {
154  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);
155  return AVERROR_INVALIDDATA;
156  }
157  };
158  break;
159  } else {
160  av_log(ctx, AV_LOG_ERROR, "Missing entry for %"PRId64". input frame.\n", inlink->frame_count_out);
161  return AVERROR_INVALIDDATA;
162  }
163  }
164 
165  out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
166  if (!out)
167  return AVERROR(ENOMEM);
168  av_frame_copy_props(out, s->frame[1]);
169 
170  switch (s->mode) {
171  case 0:
172  top = s->frame[tf - outlink->frame_count_in + 1];
173  bottom = s->frame[bf - outlink->frame_count_in + 1];
174  break;
175  case 1:
176  top = s->frame[1 + tf];
177  bottom = s->frame[1 + bf];
178  break;
179  default:
180  av_assert0(0);
181  }
182 
183  switch (field) {
184  case 'b':
185  tfactor = 1;
186  top = bottom;
187  break;
188  case 't':
189  bfactor = 0;
190  bottom = top;
191  break;
192  case '=':
193  break;
194  default:
195  av_log(ctx, AV_LOG_ERROR, "Invalid field: %c.\n", field);
196  av_frame_free(&out);
197  return AVERROR(EINVAL);
198  }
199 
200  switch (hint) {
201  case '+':
202  out->interlaced_frame = 1;
203  break;
204  case '-':
205  out->interlaced_frame = 0;
206  break;
207  case '=':
208  break;
209  case 'b':
210  tfactor = 1;
211  top = bottom;
212  break;
213  case 't':
214  bfactor = 0;
215  bottom = top;
216  break;
217  default:
218  av_log(ctx, AV_LOG_ERROR, "Invalid hint: %c.\n", hint);
219  av_frame_free(&out);
220  return AVERROR(EINVAL);
221  }
222 
223  for (p = 0; p < s->nb_planes; p++) {
224  av_image_copy_plane(out->data[p],
225  out->linesize[p] * 2,
226  top->data[p] + tfactor * top->linesize[p],
227  top->linesize[p] * 2,
228  s->planewidth[p],
229  (s->planeheight[p] + 1) / 2);
230  av_image_copy_plane(out->data[p] + out->linesize[p],
231  out->linesize[p] * 2,
232  bottom->data[p] + bfactor * bottom->linesize[p],
233  bottom->linesize[p] * 2,
234  s->planewidth[p],
235  (s->planeheight[p] + 1) / 2);
236  }
237 
238  return ff_filter_frame(outlink, out);
239 }
240 
241 static int request_frame(AVFilterLink *outlink)
242 {
243  AVFilterContext *ctx = outlink->src;
244  FieldHintContext *s = ctx->priv;
245  int ret;
246 
247  if (s->eof)
248  return AVERROR_EOF;
249 
250  ret = ff_request_frame(ctx->inputs[0]);
251  if (ret == AVERROR_EOF && s->frame[2]) {
252  AVFrame *next = av_frame_clone(s->frame[2]);
253  if (!next)
254  return AVERROR(ENOMEM);
255  ret = filter_frame(ctx->inputs[0], next);
256  s->eof = 1;
257  }
258 
259  return ret;
260 }
261 
263 {
264  FieldHintContext *s = ctx->priv;
265 
266  if (s->hint)
267  fclose(s->hint);
268  s->hint = NULL;
269 
270  av_frame_free(&s->frame[0]);
271  av_frame_free(&s->frame[1]);
272  av_frame_free(&s->frame[2]);
273 }
274 
275 static const AVFilterPad inputs[] = {
276  {
277  .name = "default",
278  .type = AVMEDIA_TYPE_VIDEO,
279  .config_props = config_input,
280  .filter_frame = filter_frame,
281  },
282 };
283 
284 static const AVFilterPad outputs[] = {
285  {
286  .name = "default",
287  .type = AVMEDIA_TYPE_VIDEO,
288  .request_frame = request_frame,
289  },
290 };
291 
293  .name = "fieldhint",
294  .description = NULL_IF_CONFIG_SMALL("Field matching using hints."),
295  .priv_size = sizeof(FieldHintContext),
296  .priv_class = &fieldhint_class,
297  .init = init,
298  .uninit = uninit,
302 };
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
FieldHintContext
Definition: vf_fieldhint.c:30
inputs
static const AVFilterPad inputs[]
Definition: vf_fieldhint.c:275
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
AVERROR_EOF
#define AVERROR_EOF
End of file.
Definition: error.h:57
FieldHintContext::hint
FILE * hint
Definition: vf_fieldhint.c:34
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:112
FieldHintContext::nb_planes
int nb_planes
Definition: vf_fieldhint.c:40
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
pixdesc.h
FLAGS
#define FLAGS
Definition: vf_fieldhint.c:47
ff_vf_fieldhint
const AVFilter ff_vf_fieldhint
Definition: vf_fieldhint.c:292
AVOption
AVOption.
Definition: opt.h:247
FILTER_QUERY_FUNC
#define FILTER_QUERY_FUNC(func)
Definition: internal.h:168
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:420
init
static av_cold int init(AVFilterContext *ctx)
Definition: vf_fieldhint.c:59
FFMAX
#define FFMAX(a, b)
Definition: macros.h:47
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:153
video.h
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:317
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:46
av_pix_fmt_count_planes
int av_pix_fmt_count_planes(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2604
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:43
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:50
request_frame
static int request_frame(AVFilterLink *outlink)
Definition: vf_fieldhint.c:241
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:699
av_fopen_utf8
FILE * av_fopen_utf8(const char *path, const char *mode)
Open a file using a UTF-8 filename.
Definition: file_open.c:158
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:257
AV_CEIL_RSHIFT
#define AV_CEIL_RSHIFT(a, b)
Definition: common.h:51
query_formats
static int query_formats(AVFilterContext *ctx)
Definition: vf_fieldhint.c:78
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:424
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:191
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:35
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:537
FieldHintContext::hint_file_str
char * hint_file_str
Definition: vf_fieldhint.c:33
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(fieldhint)
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:37
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:457
internal.h
fieldhint_options
static const AVOption fieldhint_options[]
Definition: vf_fieldhint.c:49
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:56
FieldHintContext::planewidth
int planewidth[4]
Definition: vf_fieldhint.c:42
config_input
static int config_input(AVFilterLink *inlink)
Definition: vf_fieldhint.c:87
AVFilter
Filter definition.
Definition: avfilter.h:149
ret
ret
Definition: filter_design.txt:187
mode
mode
Definition: ebur128.h:83
FieldHintContext::line
int64_t line
Definition: vf_fieldhint.c:39
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:224
avfilter.h
outputs
static const AVFilterPad outputs[]
Definition: vf_fieldhint.c:284
tf
#define tf
Definition: regdef.h:73
AVFilterContext
An instance of a filter.
Definition: avfilter.h:386
desc
const char * desc
Definition: libsvtav1.c:79
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_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Definition: vf_fieldhint.c:104
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:192
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_fieldhint.c:262
imgutils.h
AVFrame::linesize
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:334
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
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:228
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:233
FieldHintContext::eof
int eof
Definition: vf_fieldhint.c:41