FFmpeg
vf_derain.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019 Xuewei Meng
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 /**
22  * @file
23  * Filter implementing image derain filter using deep convolutional networks.
24  * http://openaccess.thecvf.com/content_ECCV_2018/html/Xia_Li_Recurrent_Squeeze-and-Excitation_Context_ECCV_2018_paper.html
25  */
26 
27 #include "libavformat/avio.h"
28 #include "libavutil/opt.h"
29 #include "avfilter.h"
30 #include "dnn_filter_common.h"
31 #include "formats.h"
32 #include "internal.h"
33 
34 typedef struct DRContext {
35  const AVClass *class;
38 } DRContext;
39 
40 #define OFFSET(x) offsetof(DRContext, x)
41 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM | AV_OPT_FLAG_VIDEO_PARAM
42 static const AVOption derain_options[] = {
43  { "filter_type", "filter type(derain/dehaze)", OFFSET(filter_type), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, FLAGS, "type" },
44  { "derain", "derain filter flag", 0, AV_OPT_TYPE_CONST, { .i64 = 0 }, 0, 0, FLAGS, "type" },
45  { "dehaze", "dehaze filter flag", 0, AV_OPT_TYPE_CONST, { .i64 = 1 }, 0, 0, FLAGS, "type" },
46  { "dnn_backend", "DNN backend", OFFSET(dnnctx.backend_type), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, FLAGS, "backend" },
47  { "native", "native backend flag", 0, AV_OPT_TYPE_CONST, { .i64 = 0 }, 0, 0, FLAGS, "backend" },
48 #if (CONFIG_LIBTENSORFLOW == 1)
49  { "tensorflow", "tensorflow backend flag", 0, AV_OPT_TYPE_CONST, { .i64 = 1 }, 0, 0, FLAGS, "backend" },
50 #endif
51  { "model", "path to model file", OFFSET(dnnctx.model_filename), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, FLAGS },
52  { "input", "input name of the model", OFFSET(dnnctx.model_inputname), AV_OPT_TYPE_STRING, { .str = "x" }, 0, 0, FLAGS },
53  { "output", "output name of the model", OFFSET(dnnctx.model_outputnames_string), AV_OPT_TYPE_STRING, { .str = "y" }, 0, 0, FLAGS },
54  { NULL }
55 };
56 
57 AVFILTER_DEFINE_CLASS(derain);
58 
60 {
62  const enum AVPixelFormat pixel_fmts[] = {
65  };
66 
67  formats = ff_make_format_list(pixel_fmts);
68 
70 }
71 
73 {
74  AVFilterContext *ctx = inlink->dst;
75  AVFilterLink *outlink = ctx->outputs[0];
76  DRContext *dr_context = ctx->priv;
77  DNNReturnType dnn_result;
78  AVFrame *out;
79 
80  out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
81  if (!out) {
82  av_log(ctx, AV_LOG_ERROR, "could not allocate memory for output frame\n");
83  av_frame_free(&in);
84  return AVERROR(ENOMEM);
85  }
87 
88  dnn_result = ff_dnn_execute_model(&dr_context->dnnctx, in, out);
89  if (dnn_result != DNN_SUCCESS){
90  av_log(ctx, AV_LOG_ERROR, "failed to execute model\n");
91  av_frame_free(&in);
92  return AVERROR(EIO);
93  }
94 
95  av_frame_free(&in);
96 
97  return ff_filter_frame(outlink, out);
98 }
99 
101 {
102  DRContext *dr_context = ctx->priv;
103  return ff_dnn_init(&dr_context->dnnctx, DFT_PROCESS_FRAME, ctx);
104 }
105 
107 {
108  DRContext *dr_context = ctx->priv;
109  ff_dnn_uninit(&dr_context->dnnctx);
110 }
111 
112 static const AVFilterPad derain_inputs[] = {
113  {
114  .name = "default",
115  .type = AVMEDIA_TYPE_VIDEO,
116  .filter_frame = filter_frame,
117  },
118  { NULL }
119 };
120 
121 static const AVFilterPad derain_outputs[] = {
122  {
123  .name = "default",
124  .type = AVMEDIA_TYPE_VIDEO,
125  },
126  { NULL }
127 };
128 
130  .name = "derain",
131  .description = NULL_IF_CONFIG_SMALL("Apply derain filter to the input."),
132  .priv_size = sizeof(DRContext),
133  .init = init,
134  .uninit = uninit,
138  .priv_class = &derain_class,
140 };
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
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
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_make_format_list
AVFilterFormats * ff_make_format_list(const int *fmts)
Create a list of supported formats.
Definition: formats.c:286
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
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
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
DRContext::filter_type
int filter_type
Definition: vf_derain.c:37
AVOption
AVOption.
Definition: opt.h:247
DRContext
Definition: vf_derain.c:34
init
static av_cold int init(AVFilterContext *ctx)
Definition: vf_derain.c:100
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:149
dnn_filter_common.h
AVFilterFormats
A list of supported formats for one end of a filter link.
Definition: formats.h:64
formats.h
DnnContext
Definition: dnn_filter_common.h:29
DNN_SUCCESS
@ DNN_SUCCESS
Definition: dnn_interface.h:33
derain_inputs
static const AVFilterPad derain_inputs[]
Definition: vf_derain.c:112
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:54
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
inputs
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 inputs
Definition: filter_design.txt:243
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
query_formats
static int query_formats(AVFilterContext *ctx)
Definition: vf_derain.c:59
DNNReturnType
DNNReturnType
Definition: dnn_interface.h:33
outputs
static const AVFilterPad outputs[]
Definition: af_acontrast.c:203
ctx
AVFormatContext * ctx
Definition: movenc.c:48
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
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:537
derain_outputs
static const AVFilterPad derain_outputs[]
Definition: vf_derain.c:121
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Definition: vf_derain.c:72
derain_options
static const AVOption derain_options[]
Definition: vf_derain.c:42
FLAGS
#define FLAGS
Definition: vf_derain.c:41
AV_PIX_FMT_RGB24
@ AV_PIX_FMT_RGB24
packed RGB 8:8:8, 24bpp, RGBRGB...
Definition: pixfmt.h:68
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
ff_vf_derain
const AVFilter ff_vf_derain
Definition: vf_derain.c:129
avio.h
internal.h
AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC
#define AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC
Some filters support a generic "enable" expression option that can be used to enable or disable a fil...
Definition: avfilter.h:126
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:60
AVFilter
Filter definition.
Definition: avfilter.h:145
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(derain)
AV_PIX_FMT_NONE
@ AV_PIX_FMT_NONE
Definition: pixfmt.h:65
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:224
avfilter.h
AVFilterContext
An instance of a filter.
Definition: avfilter.h:333
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
DRContext::dnnctx
DnnContext dnnctx
Definition: vf_derain.c:36
ff_dnn_execute_model
DNNReturnType ff_dnn_execute_model(DnnContext *ctx, AVFrame *in_frame, AVFrame *out_frame)
Definition: dnn_filter_common.c:132
OFFSET
#define OFFSET(x)
Definition: vf_derain.c:40
ff_dnn_init
int ff_dnn_init(DnnContext *ctx, DNNFunctionType func_type, AVFilterContext *filter_ctx)
Definition: dnn_filter_common.c:54
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:561
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
ff_dnn_uninit
void ff_dnn_uninit(DnnContext *ctx)
Definition: dnn_filter_common.c:181
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_derain.c:106
AV_OPT_TYPE_STRING
@ AV_OPT_TYPE_STRING
Definition: opt.h:228
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Definition: opt.h:233
DFT_PROCESS_FRAME
@ DFT_PROCESS_FRAME
Definition: dnn_interface.h:54