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 "libavutil/opt.h"
28 #include "avfilter.h"
29 #include "dnn_filter_common.h"
30 #include "internal.h"
31 #include "video.h"
32 
33 typedef struct DRContext {
34  const AVClass *class;
37 } DRContext;
38 
39 #define OFFSET(x) offsetof(DRContext, x)
40 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM | AV_OPT_FLAG_VIDEO_PARAM
41 static const AVOption derain_options[] = {
42  { "filter_type", "filter type(derain/dehaze)", OFFSET(filter_type), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, FLAGS, .unit = "type" },
43  { "derain", "derain filter flag", 0, AV_OPT_TYPE_CONST, { .i64 = 0 }, 0, 0, FLAGS, .unit = "type" },
44  { "dehaze", "dehaze filter flag", 0, AV_OPT_TYPE_CONST, { .i64 = 1 }, 0, 0, FLAGS, .unit = "type" },
45  { "dnn_backend", "DNN backend", OFFSET(dnnctx.backend_type), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, FLAGS, .unit = "backend" },
46 #if (CONFIG_LIBTENSORFLOW == 1)
47  { "tensorflow", "tensorflow backend flag", 0, AV_OPT_TYPE_CONST, { .i64 = 1 }, 0, 0, FLAGS, .unit = "backend" },
48 #endif
49  { NULL }
50 };
51 
53 
55 {
56  DNNAsyncStatusType async_state = 0;
57  AVFilterContext *ctx = inlink->dst;
58  AVFilterLink *outlink = ctx->outputs[0];
59  DRContext *dr_context = ctx->priv;
60  int dnn_result;
61  AVFrame *out;
62 
63  out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
64  if (!out) {
65  av_log(ctx, AV_LOG_ERROR, "could not allocate memory for output frame\n");
66  av_frame_free(&in);
67  return AVERROR(ENOMEM);
68  }
70 
71  dnn_result = ff_dnn_execute_model(&dr_context->dnnctx, in, out);
72  if (dnn_result != 0){
73  av_log(ctx, AV_LOG_ERROR, "failed to execute model\n");
74  av_frame_free(&in);
75  return dnn_result;
76  }
77  do {
78  async_state = ff_dnn_get_result(&dr_context->dnnctx, &in, &out);
79  } while (async_state == DAST_NOT_READY);
80 
81  if (async_state != DAST_SUCCESS)
82  return AVERROR(EINVAL);
83 
84  av_frame_free(&in);
85 
86  return ff_filter_frame(outlink, out);
87 }
88 
90 {
91  DRContext *dr_context = ctx->priv;
92  return ff_dnn_init(&dr_context->dnnctx, DFT_PROCESS_FRAME, ctx);
93 }
94 
96 {
97  DRContext *dr_context = ctx->priv;
98  ff_dnn_uninit(&dr_context->dnnctx);
99 }
100 
101 static const AVFilterPad derain_inputs[] = {
102  {
103  .name = "default",
104  .type = AVMEDIA_TYPE_VIDEO,
105  .filter_frame = filter_frame,
106  },
107 };
108 
110  .name = "derain",
111  .description = NULL_IF_CONFIG_SMALL("Apply derain filter to the input."),
112  .priv_size = sizeof(DRContext),
114  .init = init,
115  .uninit = uninit,
119  .priv_class = &derain_class,
121 };
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:112
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:55
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1015
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
AVFILTER_DNN_DEFINE_CLASS
AVFILTER_DNN_DEFINE_CLASS(derain, DNN_TF)
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:160
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:374
DRContext::filter_type
int filter_type
Definition: vf_derain.c:36
AVOption
AVOption.
Definition: opt.h:357
DRContext
Definition: vf_derain.c:33
init
static av_cold int init(AVFilterContext *ctx)
Definition: vf_derain.c:89
preinit
static av_cold int preinit(AVFilterContext *ctx)
Definition: af_aresample.c:49
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:170
dnn_filter_common.h
video.h
DnnContext
Definition: dnn_interface.h:143
ff_dnn_filter_init_child_class
int ff_dnn_filter_init_child_class(AVFilterContext *filter)
Definition: dnn_filter_common.c:61
derain_inputs
static const AVFilterPad derain_inputs[]
Definition: vf_derain.c:101
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:33
DNN_TF
@ DNN_TF
Definition: dnn_interface.h:36
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_video_default_filterpad
const AVFilterPad ff_video_default_filterpad[1]
An AVFilterPad array whose only entry has name "default" and is of type AVMEDIA_TYPE_VIDEO.
Definition: video.c:37
ff_dnn_get_result
DNNAsyncStatusType ff_dnn_get_result(DnnContext *ctx, AVFrame **in_frame, AVFrame **out_frame)
Definition: dnn_filter_common.c:198
ctx
AVFormatContext * ctx
Definition: movenc.c:49
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: internal.h:182
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:709
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Definition: vf_derain.c:54
derain_options
static const AVOption derain_options[]
Definition: vf_derain.c:41
FLAGS
#define FLAGS
Definition: vf_derain.c:40
AV_PIX_FMT_RGB24
@ AV_PIX_FMT_RGB24
packed RGB 8:8:8, 24bpp, RGBRGB...
Definition: pixfmt.h:75
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:94
DAST_SUCCESS
@ DAST_SUCCESS
Definition: dnn_interface.h:53
ff_vf_derain
const AVFilter ff_vf_derain
Definition: vf_derain.c:109
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:147
FILTER_SINGLE_PIXFMT
#define FILTER_SINGLE_PIXFMT(pix_fmt_)
Definition: internal.h:172
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:39
AVFilter
Filter definition.
Definition: avfilter.h:166
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:245
avfilter.h
AVFilterContext
An instance of a filter.
Definition: avfilter.h:407
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
DRContext::dnnctx
DnnContext dnnctx
Definition: vf_derain.c:35
OFFSET
#define OFFSET(x)
Definition: vf_derain.c:39
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:183
ff_dnn_init
int ff_dnn_init(DnnContext *ctx, DNNFunctionType func_type, AVFilterContext *filter_ctx)
Definition: dnn_filter_common.c:73
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
ff_dnn_uninit
void ff_dnn_uninit(DnnContext *ctx)
Definition: dnn_filter_common.c:208
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_derain.c:95
ff_dnn_execute_model
int ff_dnn_execute_model(DnnContext *ctx, AVFrame *in_frame, AVFrame *out_frame)
Definition: dnn_filter_common.c:171
DAST_NOT_READY
@ DAST_NOT_READY
Definition: dnn_interface.h:52
DNNAsyncStatusType
DNNAsyncStatusType
Definition: dnn_interface.h:49
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Definition: opt.h:254
DFT_PROCESS_FRAME
@ DFT_PROCESS_FRAME
Definition: dnn_interface.h:58