2 * Copyright (c) 2018 Sergey Lavrushkin
4 * This file is part of FFmpeg.
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.
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.
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
23 * DNN inference engine interface.
26 #ifndef AVFILTER_DNN_INTERFACE_H
27 #define AVFILTER_DNN_INTERFACE_H
29 typedef enum {DNN_SUCCESS, DNN_ERROR} DNNReturnType;
31 typedef enum {DNN_NATIVE, DNN_TF} DNNBackendType;
33 typedef enum {DNN_SRCNN, DNN_ESPCN} DNNDefaultModel;
35 typedef struct DNNData{
37 int width, height, channels;
40 typedef struct DNNModel{
41 // Stores model that can be different for different backends.
43 // Sets model input and output, while allocating additional memory for intermediate calculations.
44 // Should be called at least once before model execution.
45 DNNReturnType (*set_input_output)(void *model, DNNData *input, DNNData *output);
48 // Stores pointers to functions for loading, executing, freeing DNN models for one of the backends.
49 typedef struct DNNModule{
50 // Loads model and parameters from given file. Returns NULL if it is not possible.
51 DNNModel *(*load_model)(const char *model_filename);
52 // Loads one of the default models
53 DNNModel *(*load_default_model)(DNNDefaultModel model_type);
54 // Executes model with specified input and output. Returns DNN_ERROR otherwise.
55 DNNReturnType (*execute_model)(const DNNModel *model);
56 // Frees memory allocated for model.
57 void (*free_model)(DNNModel **model);
60 // Initializes DNNModule depending on chosen backend.
61 DNNModule *ff_get_dnn_module(DNNBackendType backend_type);