libavfilter/opencl: Add macro for setting opencl kernel arguments
[ffmpeg.git] / libavfilter / vf_srcnn.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  */
26
27 #include "avfilter.h"
28 #include "formats.h"
29 #include "internal.h"
30 #include "libavutil/opt.h"
31 #include "libavformat/avio.h"
32 #include "dnn_interface.h"
33
34 typedef struct SRCNNContext {
35     const AVClass *class;
36
37     char* model_filename;
38     float* input_output_buf;
39     DNNBackendType backend_type;
40     DNNModule* dnn_module;
41     DNNModel* model;
42     DNNData input_output;
43 } SRCNNContext;
44
45 #define OFFSET(x) offsetof(SRCNNContext, x)
46 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM | AV_OPT_FLAG_VIDEO_PARAM
47 static const AVOption srcnn_options[] = {
48     { "dnn_backend", "DNN backend used for model execution", OFFSET(backend_type), AV_OPT_TYPE_FLAGS, { .i64 = 0 }, 0, 1, FLAGS, "backend" },
49     { "native", "native backend flag", 0, AV_OPT_TYPE_CONST, { .i64 = 0 }, 0, 0, FLAGS, "backend" },
50 #if (CONFIG_LIBTENSORFLOW == 1)
51     { "tensorflow", "tensorflow backend flag", 0, AV_OPT_TYPE_CONST, { .i64 = 1 }, 0, 0, FLAGS, "backend" },
52 #endif
53     { "model_filename", "path to model file specifying network architecture and its parameters", OFFSET(model_filename), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS },
54     { NULL }
55 };
56
57 AVFILTER_DEFINE_CLASS(srcnn);
58
59 static av_cold int init(AVFilterContext* context)
60 {
61     SRCNNContext* srcnn_context = context->priv;
62
63     srcnn_context->dnn_module = ff_get_dnn_module(srcnn_context->backend_type);
64     if (!srcnn_context->dnn_module){
65         av_log(context, AV_LOG_ERROR, "could not create DNN module for requested backend\n");
66         return AVERROR(ENOMEM);
67     }
68     if (!srcnn_context->model_filename){
69         av_log(context, AV_LOG_VERBOSE, "model file for network was not specified, using default network for x2 upsampling\n");
70         srcnn_context->model = (srcnn_context->dnn_module->load_default_model)(DNN_SRCNN);
71     }
72     else{
73         srcnn_context->model = (srcnn_context->dnn_module->load_model)(srcnn_context->model_filename);
74     }
75     if (!srcnn_context->model){
76         av_log(context, AV_LOG_ERROR, "could not load DNN model\n");
77         return AVERROR(EIO);
78     }
79
80     return 0;
81 }
82
83 static int query_formats(AVFilterContext* context)
84 {
85     const enum AVPixelFormat pixel_formats[] = {AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV444P,
86                                                 AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_GRAY8,
87                                                 AV_PIX_FMT_NONE};
88     AVFilterFormats* formats_list;
89
90     formats_list = ff_make_format_list(pixel_formats);
91     if (!formats_list){
92         av_log(context, AV_LOG_ERROR, "could not create formats list\n");
93         return AVERROR(ENOMEM);
94     }
95     return ff_set_common_formats(context, formats_list);
96 }
97
98 static int config_props(AVFilterLink* inlink)
99 {
100     AVFilterContext* context = inlink->dst;
101     SRCNNContext* srcnn_context = context->priv;
102     DNNReturnType result;
103
104     srcnn_context->input_output_buf = av_malloc(inlink->h * inlink->w * sizeof(float));
105     if (!srcnn_context->input_output_buf){
106         av_log(context, AV_LOG_ERROR, "could not allocate memory for input/output buffer\n");
107         return AVERROR(ENOMEM);
108     }
109
110     srcnn_context->input_output.data = srcnn_context->input_output_buf;
111     srcnn_context->input_output.width = inlink->w;
112     srcnn_context->input_output.height = inlink->h;
113     srcnn_context->input_output.channels = 1;
114
115     result = (srcnn_context->model->set_input_output)(srcnn_context->model->model, &srcnn_context->input_output, &srcnn_context->input_output);
116     if (result != DNN_SUCCESS){
117         av_log(context, AV_LOG_ERROR, "could not set input and output for the model\n");
118         return AVERROR(EIO);
119     }
120     else{
121         return 0;
122     }
123 }
124
125 typedef struct ThreadData{
126     uint8_t* out;
127     int out_linesize, height, width;
128 } ThreadData;
129
130 static int uint8_to_float(AVFilterContext* context, void* arg, int jobnr, int nb_jobs)
131 {
132     SRCNNContext* srcnn_context = context->priv;
133     const ThreadData* td = arg;
134     const int slice_start = (td->height *  jobnr     ) / nb_jobs;
135     const int slice_end   = (td->height * (jobnr + 1)) / nb_jobs;
136     const uint8_t* src = td->out + slice_start * td->out_linesize;
137     float* dst = srcnn_context->input_output_buf + slice_start * td->width;
138     int y, x;
139
140     for (y = slice_start; y < slice_end; ++y){
141         for (x = 0; x < td->width; ++x){
142             dst[x] = (float)src[x] / 255.0f;
143         }
144         src += td->out_linesize;
145         dst += td->width;
146     }
147
148     return 0;
149 }
150
151 static int float_to_uint8(AVFilterContext* context, void* arg, int jobnr, int nb_jobs)
152 {
153     SRCNNContext* srcnn_context = context->priv;
154     const ThreadData* td = arg;
155     const int slice_start = (td->height *  jobnr     ) / nb_jobs;
156     const int slice_end   = (td->height * (jobnr + 1)) / nb_jobs;
157     const float* src = srcnn_context->input_output_buf + slice_start * td->width;
158     uint8_t* dst = td->out + slice_start * td->out_linesize;
159     int y, x;
160
161     for (y = slice_start; y < slice_end; ++y){
162         for (x = 0; x < td->width; ++x){
163             dst[x] = (uint8_t)(255.0f * FFMIN(src[x], 1.0f));
164         }
165         src += td->width;
166         dst += td->out_linesize;
167     }
168
169     return 0;
170 }
171
172 static int filter_frame(AVFilterLink* inlink, AVFrame* in)
173 {
174     AVFilterContext* context = inlink->dst;
175     SRCNNContext* srcnn_context = context->priv;
176     AVFilterLink* outlink = context->outputs[0];
177     AVFrame* out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
178     ThreadData td;
179     int nb_threads;
180     DNNReturnType dnn_result;
181
182     if (!out){
183         av_log(context, AV_LOG_ERROR, "could not allocate memory for output frame\n");
184         av_frame_free(&in);
185         return AVERROR(ENOMEM);
186     }
187     av_frame_copy_props(out, in);
188     av_frame_copy(out, in);
189     av_frame_free(&in);
190     td.out = out->data[0];
191     td.out_linesize = out->linesize[0];
192     td.height = out->height;
193     td.width = out->width;
194
195     nb_threads = ff_filter_get_nb_threads(context);
196     context->internal->execute(context, uint8_to_float, &td, NULL, FFMIN(td.height, nb_threads));
197
198     dnn_result = (srcnn_context->dnn_module->execute_model)(srcnn_context->model);
199     if (dnn_result != DNN_SUCCESS){
200         av_log(context, AV_LOG_ERROR, "failed to execute loaded model\n");
201         return AVERROR(EIO);
202     }
203
204     context->internal->execute(context, float_to_uint8, &td, NULL, FFMIN(td.height, nb_threads));
205
206     return ff_filter_frame(outlink, out);
207 }
208
209 static av_cold void uninit(AVFilterContext* context)
210 {
211     SRCNNContext* srcnn_context = context->priv;
212
213     if (srcnn_context->dnn_module){
214         (srcnn_context->dnn_module->free_model)(&srcnn_context->model);
215         av_freep(&srcnn_context->dnn_module);
216     }
217     av_freep(&srcnn_context->input_output_buf);
218 }
219
220 static const AVFilterPad srcnn_inputs[] = {
221     {
222         .name         = "default",
223         .type         = AVMEDIA_TYPE_VIDEO,
224         .config_props = config_props,
225         .filter_frame = filter_frame,
226     },
227     { NULL }
228 };
229
230 static const AVFilterPad srcnn_outputs[] = {
231     {
232         .name = "default",
233         .type = AVMEDIA_TYPE_VIDEO,
234     },
235     { NULL }
236 };
237
238 AVFilter ff_vf_srcnn = {
239     .name          = "srcnn",
240     .description   = NULL_IF_CONFIG_SMALL("Apply super resolution convolutional neural network to the input. Use bicubic upsamping with corresponding scaling factor before."),
241     .priv_size     = sizeof(SRCNNContext),
242     .init          = init,
243     .uninit        = uninit,
244     .query_formats = query_formats,
245     .inputs        = srcnn_inputs,
246     .outputs       = srcnn_outputs,
247     .priv_class    = &srcnn_class,
248     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SLICE_THREADS,
249 };
250