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 {
81  int ret;
82 
87  if (ret < 0)
88  return ret;
90 }
91 
93 {
94  FieldHintContext *s = inlink->dst->priv;
96  int ret;
97 
98  if ((ret = av_image_fill_linesizes(s->planewidth, inlink->format, inlink->w)) < 0)
99  return ret;
100 
101  s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
102  s->planeheight[0] = s->planeheight[3] = inlink->h;
103 
104  s->nb_planes = av_pix_fmt_count_planes(inlink->format);
105 
106  return 0;
107 }
108 
110 {
111  AVFilterContext *ctx = inlink->dst;
112  AVFilterLink *outlink = ctx->outputs[0];
113  FieldHintContext *s = ctx->priv;
114  AVFrame *out, *top, *bottom;
115  char buf[1024] = { 0 };
116  int64_t tf, bf;
117  int tfactor = 0, bfactor = 1;
118  char hint = '=', field = '=';
119  int p;
120 
121  av_frame_free(&s->frame[0]);
122  s->frame[0] = s->frame[1];
123  s->frame[1] = s->frame[2];
124  s->frame[2] = in;
125  if (!s->frame[1])
126  return 0;
127  else if (!s->frame[0]) {
128  s->frame[0] = av_frame_clone(s->frame[1]);
129  if (!s->frame[0])
130  return AVERROR(ENOMEM);
131  }
132 
133  while (1) {
134  if (fgets(buf, sizeof(buf)-1, s->hint)) {
135  s->line++;
136  if (buf[0] == '#' || buf[0] == ';') {
137  continue;
138  } else if (sscanf(buf, "%"PRId64",%"PRId64" %c %c", &tf, &bf, &hint, &field) == 4) {
139  ;
140  } else if (sscanf(buf, "%"PRId64",%"PRId64" %c", &tf, &bf, &hint) == 3) {
141  ;
142  } else if (sscanf(buf, "%"PRId64",%"PRId64"", &tf, &bf) == 2) {
143  ;
144  } else {
145  av_log(ctx, AV_LOG_ERROR, "Invalid entry at line %"PRId64".\n", s->line);
146  return AVERROR_INVALIDDATA;
147  }
148  switch (s->mode) {
149  case 0:
150  if (tf > outlink->frame_count_in + 1 || tf < FFMAX(0, outlink->frame_count_in - 1) ||
151  bf > outlink->frame_count_in + 1 || bf < FFMAX(0, outlink->frame_count_in - 1)) {
152  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);
153  return AVERROR_INVALIDDATA;
154  }
155  break;
156  case 1:
157  if (tf > 1 || tf < -1 ||
158  bf > 1 || bf < -1) {
159  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);
160  return AVERROR_INVALIDDATA;
161  }
162  };
163  break;
164  } else {
165  av_log(ctx, AV_LOG_ERROR, "Missing entry for %"PRId64". input frame.\n", inlink->frame_count_out);
166  return AVERROR_INVALIDDATA;
167  }
168  }
169 
170  out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
171  if (!out)
172  return AVERROR(ENOMEM);
173  av_frame_copy_props(out, s->frame[1]);
174 
175  switch (s->mode) {
176  case 0:
177  top = s->frame[tf - outlink->frame_count_in + 1];
178  bottom = s->frame[bf - outlink->frame_count_in + 1];
179  break;
180  case 1:
181  top = s->frame[1 + tf];
182  bottom = s->frame[1 + bf];
183  break;
184  default:
185  av_assert0(0);
186  }
187 
188  switch (field) {
189  case 'b':
190  tfactor = 1;
191  top = bottom;
192  break;
193  case 't':
194  bfactor = 0;
195  bottom = top;
196  break;
197  case '=':
198  break;
199  default:
200  av_log(ctx, AV_LOG_ERROR, "Invalid field: %c.\n", field);
201  av_frame_free(&out);
202  return AVERROR(EINVAL);
203  }
204 
205  switch (hint) {
206  case '+':
207  out->interlaced_frame = 1;
208  break;
209  case '-':
210  out->interlaced_frame = 0;
211  break;
212  case '=':
213  break;
214  case 'b':
215  tfactor = 1;
216  top = bottom;
217  break;
218  case 't':
219  bfactor = 0;
220  bottom = top;
221  break;
222  default:
223  av_log(ctx, AV_LOG_ERROR, "Invalid hint: %c.\n", hint);
224  av_frame_free(&out);
225  return AVERROR(EINVAL);
226  }
227 
228  for (p = 0; p < s->nb_planes; p++) {
229  av_image_copy_plane(out->data[p],
230  out->linesize[p] * 2,
231  top->data[p] + tfactor * top->linesize[p],
232  top->linesize[p] * 2,
233  s->planewidth[p],
234  (s->planeheight[p] + 1) / 2);
235  av_image_copy_plane(out->data[p] + out->linesize[p],
236  out->linesize[p] * 2,
237  bottom->data[p] + bfactor * bottom->linesize[p],
238  bottom->linesize[p] * 2,
239  s->planewidth[p],
240  (s->planeheight[p] + 1) / 2);
241  }
242 
243  return ff_filter_frame(outlink, out);
244 }
245 
246 static int request_frame(AVFilterLink *outlink)
247 {
248  AVFilterContext *ctx = outlink->src;
249  FieldHintContext *s = ctx->priv;
250  int ret;
251 
252  if (s->eof)
253  return AVERROR_EOF;
254 
255  ret = ff_request_frame(ctx->inputs[0]);
256  if (ret == AVERROR_EOF && s->frame[2]) {
257  AVFrame *next = av_frame_clone(s->frame[2]);
258  if (!next)
259  return AVERROR(ENOMEM);
260  ret = filter_frame(ctx->inputs[0], next);
261  s->eof = 1;
262  }
263 
264  return ret;
265 }
266 
268 {
269  FieldHintContext *s = ctx->priv;
270 
271  if (s->hint)
272  fclose(s->hint);
273  s->hint = NULL;
274 
275  av_frame_free(&s->frame[0]);
276  av_frame_free(&s->frame[1]);
277  av_frame_free(&s->frame[2]);
278 }
279 
280 static const AVFilterPad inputs[] = {
281  {
282  .name = "default",
283  .type = AVMEDIA_TYPE_VIDEO,
284  .config_props = config_input,
285  .filter_frame = filter_frame,
286  },
287  { NULL }
288 };
289 
290 static const AVFilterPad outputs[] = {
291  {
292  .name = "default",
293  .type = AVMEDIA_TYPE_VIDEO,
294  .request_frame = request_frame,
295  },
296  { NULL }
297 };
298 
300  .name = "fieldhint",
301  .description = NULL_IF_CONFIG_SMALL("Field matching using hints."),
302  .priv_size = sizeof(FieldHintContext),
303  .priv_class = &fieldhint_class,
304  .init = init,
305  .uninit = uninit,
307  .inputs = inputs,
308  .outputs = outputs,
309 };
formats
formats
Definition: signature.h:48
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:97
FieldHintContext
Definition: vf_fieldhint.c:30
inputs
static const AVFilterPad inputs[]
Definition: vf_fieldhint.c:280
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:978
av_pix_fmt_desc_get
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2540
AVERROR_EOF
#define AVERROR_EOF
End of file.
Definition: error.h:55
ff_formats_pixdesc_filter
int ff_formats_pixdesc_filter(AVFilterFormats **rfmts, unsigned want, unsigned rej)
Construct a formats list containing all pixel formats with certain properties.
Definition: formats.c:360
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:299
AVOption
AVOption.
Definition: opt.h:247
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:395
init
static av_cold int init(AVFilterContext *ctx)
Definition: vf_fieldhint.c:59
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:149
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
AVFilterFormats
A list of supported formats for one end of a filter link.
Definition: formats.h:64
av_pix_fmt_count_planes
int av_pix_fmt_count_planes(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2580
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:54
request_frame
static int request_frame(AVFilterLink *outlink)
Definition: vf_fieldhint.c:246
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:580
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:58
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
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:116
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:119
FFMAX
#define FFMAX(a, b)
Definition: common.h:103
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
internal.h
fieldhint_options
static const AVOption fieldhint_options[]
Definition: vf_fieldhint.c:49
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:60
FieldHintContext::planewidth
int planewidth[4]
Definition: vf_fieldhint.c:42
config_input
static int config_input(AVFilterLink *inlink)
Definition: vf_fieldhint.c:92
AVFilter
Filter definition.
Definition: avfilter.h:145
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:290
tf
#define tf
Definition: regdef.h:73
AVFilterContext
An instance of a filter.
Definition: avfilter.h:333
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:109
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_fieldhint.c:267
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:59
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