562b03069b2a1bd89b71fb3ab408a6c09952b23e
[ffmpeg.git] / libavfilter / vf_sr.c
1 /*
2  * Copyright (c) 2018 Sergey Lavrushkin
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 super-resolution using deep convolutional networks.
24  * https://arxiv.org/abs/1501.00092
25  * https://arxiv.org/abs/1609.05158
26  */
27
28 #include "avfilter.h"
29 #include "formats.h"
30 #include "internal.h"
31 #include "libavutil/opt.h"
32 #include "libavutil/pixdesc.h"
33 #include "libavformat/avio.h"
34 #include "libswscale/swscale.h"
35 #include "dnn_interface.h"
36
37 typedef struct SRContext {
38     const AVClass *class;
39
40     char *model_filename;
41     DNNBackendType backend_type;
42     DNNModule *dnn_module;
43     DNNModel *model;
44     DNNData input;
45     DNNData output;
46     int scale_factor;
47     struct SwsContext *sws_contexts[3];
48     int sws_slice_h, sws_input_linesize, sws_output_linesize;
49 } SRContext;
50
51 #define OFFSET(x) offsetof(SRContext, x)
52 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM | AV_OPT_FLAG_VIDEO_PARAM
53 static const AVOption sr_options[] = {
54     { "dnn_backend", "DNN backend used for model execution", OFFSET(backend_type), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, FLAGS, "backend" },
55     { "native", "native backend flag", 0, AV_OPT_TYPE_CONST, { .i64 = 0 }, 0, 0, FLAGS, "backend" },
56 #if (CONFIG_LIBTENSORFLOW == 1)
57     { "tensorflow", "tensorflow backend flag", 0, AV_OPT_TYPE_CONST, { .i64 = 1 }, 0, 0, FLAGS, "backend" },
58 #endif
59     { "scale_factor", "scale factor for SRCNN model", OFFSET(scale_factor), AV_OPT_TYPE_INT, { .i64 = 2 }, 2, 4, FLAGS },
60     { "model", "path to model file specifying network architecture and its parameters", OFFSET(model_filename), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS },
61     { NULL }
62 };
63
64 AVFILTER_DEFINE_CLASS(sr);
65
66 static av_cold int init(AVFilterContext *context)
67 {
68     SRContext *sr_context = context->priv;
69
70     sr_context->dnn_module = ff_get_dnn_module(sr_context->backend_type);
71     if (!sr_context->dnn_module){
72         av_log(context, AV_LOG_ERROR, "could not create DNN module for requested backend\n");
73         return AVERROR(ENOMEM);
74     }
75
76     if (!sr_context->model_filename){
77         av_log(context, AV_LOG_ERROR, "model file for network was not specified\n");
78         return AVERROR(EIO);
79     }
80     if (!sr_context->dnn_module->load_model) {
81         av_log(context, AV_LOG_ERROR, "load_model for network was not specified\n");
82         return AVERROR(EIO);
83     }
84     sr_context->model = (sr_context->dnn_module->load_model)(sr_context->model_filename);
85     if (!sr_context->model){
86         av_log(context, AV_LOG_ERROR, "could not load DNN model\n");
87         return AVERROR(EIO);
88     }
89
90     sr_context->input.dt = DNN_FLOAT;
91     sr_context->sws_contexts[0] = NULL;
92     sr_context->sws_contexts[1] = NULL;
93     sr_context->sws_contexts[2] = NULL;
94
95     return 0;
96 }
97
98 static int query_formats(AVFilterContext *context)
99 {
100     const enum AVPixelFormat pixel_formats[] = {AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV444P,
101                                                 AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_GRAY8,
102                                                 AV_PIX_FMT_NONE};
103     AVFilterFormats *formats_list;
104
105     formats_list = ff_make_format_list(pixel_formats);
106     if (!formats_list){
107         av_log(context, AV_LOG_ERROR, "could not create formats list\n");
108         return AVERROR(ENOMEM);
109     }
110
111     return ff_set_common_formats(context, formats_list);
112 }
113
114 static int config_props(AVFilterLink *inlink)
115 {
116     AVFilterContext *context = inlink->dst;
117     SRContext *sr_context = context->priv;
118     AVFilterLink *outlink = context->outputs[0];
119     DNNReturnType result;
120     int sws_src_h, sws_src_w, sws_dst_h, sws_dst_w;
121     const char *model_output_name = "y";
122
123     sr_context->input.width = inlink->w * sr_context->scale_factor;
124     sr_context->input.height = inlink->h * sr_context->scale_factor;
125     sr_context->input.channels = 1;
126
127     result = (sr_context->model->set_input_output)(sr_context->model->model, &sr_context->input, "x", &model_output_name, 1);
128     if (result != DNN_SUCCESS){
129         av_log(context, AV_LOG_ERROR, "could not set input and output for the model\n");
130         return AVERROR(EIO);
131     }
132
133     result = (sr_context->dnn_module->execute_model)(sr_context->model, &sr_context->output, 1);
134     if (result != DNN_SUCCESS){
135         av_log(context, AV_LOG_ERROR, "failed to execute loaded model\n");
136         return AVERROR(EIO);
137     }
138
139     if (sr_context->input.height != sr_context->output.height || sr_context->input.width != sr_context->output.width){
140         sr_context->input.width = inlink->w;
141         sr_context->input.height = inlink->h;
142         result = (sr_context->model->set_input_output)(sr_context->model->model, &sr_context->input, "x", &model_output_name, 1);
143         if (result != DNN_SUCCESS){
144             av_log(context, AV_LOG_ERROR, "could not set input and output for the model\n");
145             return AVERROR(EIO);
146         }
147         result = (sr_context->dnn_module->execute_model)(sr_context->model, &sr_context->output, 1);
148         if (result != DNN_SUCCESS){
149             av_log(context, AV_LOG_ERROR, "failed to execute loaded model\n");
150             return AVERROR(EIO);
151         }
152         sr_context->scale_factor = 0;
153     }
154     outlink->h = sr_context->output.height;
155     outlink->w = sr_context->output.width;
156     sr_context->sws_contexts[1] = sws_getContext(sr_context->input.width, sr_context->input.height, AV_PIX_FMT_GRAY8,
157                                                  sr_context->input.width, sr_context->input.height, AV_PIX_FMT_GRAYF32,
158                                                  0, NULL, NULL, NULL);
159     sr_context->sws_input_linesize = sr_context->input.width << 2;
160     sr_context->sws_contexts[2] = sws_getContext(sr_context->output.width, sr_context->output.height, AV_PIX_FMT_GRAYF32,
161                                                  sr_context->output.width, sr_context->output.height, AV_PIX_FMT_GRAY8,
162                                                  0, NULL, NULL, NULL);
163     sr_context->sws_output_linesize = sr_context->output.width << 2;
164     if (!sr_context->sws_contexts[1] || !sr_context->sws_contexts[2]){
165         av_log(context, AV_LOG_ERROR, "could not create SwsContext for conversions\n");
166         return AVERROR(ENOMEM);
167     }
168     if (sr_context->scale_factor){
169         sr_context->sws_contexts[0] = sws_getContext(inlink->w, inlink->h, inlink->format,
170                                                      outlink->w, outlink->h, outlink->format,
171                                                      SWS_BICUBIC, NULL, NULL, NULL);
172         if (!sr_context->sws_contexts[0]){
173             av_log(context, AV_LOG_ERROR, "could not create SwsContext for scaling\n");
174             return AVERROR(ENOMEM);
175         }
176         sr_context->sws_slice_h = inlink->h;
177     } else {
178         if (inlink->format != AV_PIX_FMT_GRAY8){
179             sws_src_h = sr_context->input.height;
180             sws_src_w = sr_context->input.width;
181             sws_dst_h = sr_context->output.height;
182             sws_dst_w = sr_context->output.width;
183
184             switch (inlink->format){
185             case AV_PIX_FMT_YUV420P:
186                 sws_src_h = AV_CEIL_RSHIFT(sws_src_h, 1);
187                 sws_src_w = AV_CEIL_RSHIFT(sws_src_w, 1);
188                 sws_dst_h = AV_CEIL_RSHIFT(sws_dst_h, 1);
189                 sws_dst_w = AV_CEIL_RSHIFT(sws_dst_w, 1);
190                 break;
191             case AV_PIX_FMT_YUV422P:
192                 sws_src_w = AV_CEIL_RSHIFT(sws_src_w, 1);
193                 sws_dst_w = AV_CEIL_RSHIFT(sws_dst_w, 1);
194                 break;
195             case AV_PIX_FMT_YUV444P:
196                 break;
197             case AV_PIX_FMT_YUV410P:
198                 sws_src_h = AV_CEIL_RSHIFT(sws_src_h, 2);
199                 sws_src_w = AV_CEIL_RSHIFT(sws_src_w, 2);
200                 sws_dst_h = AV_CEIL_RSHIFT(sws_dst_h, 2);
201                 sws_dst_w = AV_CEIL_RSHIFT(sws_dst_w, 2);
202                 break;
203             case AV_PIX_FMT_YUV411P:
204                 sws_src_w = AV_CEIL_RSHIFT(sws_src_w, 2);
205                 sws_dst_w = AV_CEIL_RSHIFT(sws_dst_w, 2);
206                 break;
207             default:
208                 av_log(context, AV_LOG_ERROR,
209                        "could not create SwsContext for scaling for given input pixel format: %s\n",
210                        av_get_pix_fmt_name(inlink->format));
211                 return AVERROR(EIO);
212             }
213             sr_context->sws_contexts[0] = sws_getContext(sws_src_w, sws_src_h, AV_PIX_FMT_GRAY8,
214                                                          sws_dst_w, sws_dst_h, AV_PIX_FMT_GRAY8,
215                                                          SWS_BICUBIC, NULL, NULL, NULL);
216             if (!sr_context->sws_contexts[0]){
217                 av_log(context, AV_LOG_ERROR, "could not create SwsContext for scaling\n");
218                 return AVERROR(ENOMEM);
219             }
220             sr_context->sws_slice_h = sws_src_h;
221         }
222     }
223
224     return 0;
225 }
226
227 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
228 {
229     AVFilterContext *context = inlink->dst;
230     SRContext *sr_context = context->priv;
231     AVFilterLink *outlink = context->outputs[0];
232     AVFrame *out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
233     DNNReturnType dnn_result;
234
235     if (!out){
236         av_log(context, AV_LOG_ERROR, "could not allocate memory for output frame\n");
237         av_frame_free(&in);
238         return AVERROR(ENOMEM);
239     }
240     av_frame_copy_props(out, in);
241     out->height = sr_context->output.height;
242     out->width = sr_context->output.width;
243     if (sr_context->scale_factor){
244         sws_scale(sr_context->sws_contexts[0], (const uint8_t **)in->data, in->linesize,
245                   0, sr_context->sws_slice_h, out->data, out->linesize);
246
247         sws_scale(sr_context->sws_contexts[1], (const uint8_t **)out->data, out->linesize,
248                   0, out->height, (uint8_t * const*)(&sr_context->input.data),
249                   (const int [4]){sr_context->sws_input_linesize, 0, 0, 0});
250     } else {
251         if (sr_context->sws_contexts[0]){
252             sws_scale(sr_context->sws_contexts[0], (const uint8_t **)(in->data + 1), in->linesize + 1,
253                       0, sr_context->sws_slice_h, out->data + 1, out->linesize + 1);
254             sws_scale(sr_context->sws_contexts[0], (const uint8_t **)(in->data + 2), in->linesize + 2,
255                       0, sr_context->sws_slice_h, out->data + 2, out->linesize + 2);
256         }
257
258         sws_scale(sr_context->sws_contexts[1], (const uint8_t **)in->data, in->linesize,
259                   0, in->height, (uint8_t * const*)(&sr_context->input.data),
260                   (const int [4]){sr_context->sws_input_linesize, 0, 0, 0});
261     }
262     av_frame_free(&in);
263
264     dnn_result = (sr_context->dnn_module->execute_model)(sr_context->model, &sr_context->output, 1);
265     if (dnn_result != DNN_SUCCESS){
266         av_log(context, AV_LOG_ERROR, "failed to execute loaded model\n");
267         return AVERROR(EIO);
268     }
269
270     sws_scale(sr_context->sws_contexts[2], (const uint8_t *[4]){(const uint8_t *)sr_context->output.data, 0, 0, 0},
271               (const int[4]){sr_context->sws_output_linesize, 0, 0, 0},
272               0, out->height, (uint8_t * const*)out->data, out->linesize);
273
274     return ff_filter_frame(outlink, out);
275 }
276
277 static av_cold void uninit(AVFilterContext *context)
278 {
279     int i;
280     SRContext *sr_context = context->priv;
281
282     if (sr_context->dnn_module){
283         (sr_context->dnn_module->free_model)(&sr_context->model);
284         av_freep(&sr_context->dnn_module);
285     }
286
287     for (i = 0; i < 3; ++i){
288         sws_freeContext(sr_context->sws_contexts[i]);
289     }
290 }
291
292 static const AVFilterPad sr_inputs[] = {
293     {
294         .name         = "default",
295         .type         = AVMEDIA_TYPE_VIDEO,
296         .config_props = config_props,
297         .filter_frame = filter_frame,
298     },
299     { NULL }
300 };
301
302 static const AVFilterPad sr_outputs[] = {
303     {
304         .name = "default",
305         .type = AVMEDIA_TYPE_VIDEO,
306     },
307     { NULL }
308 };
309
310 AVFilter ff_vf_sr = {
311     .name          = "sr",
312     .description   = NULL_IF_CONFIG_SMALL("Apply DNN-based image super resolution to the input."),
313     .priv_size     = sizeof(SRContext),
314     .init          = init,
315     .uninit        = uninit,
316     .query_formats = query_formats,
317     .inputs        = sr_inputs,
318     .outputs       = sr_outputs,
319     .priv_class    = &sr_class,
320 };