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