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
30 #include "libavutil/frame.h"
33 typedef enum {DNN_SUCCESS, DNN_ERROR} DNNReturnType;
35 typedef enum {DNN_NATIVE, DNN_TF, DNN_OV} DNNBackendType;
37 typedef enum {DNN_FLOAT = 1, DNN_UINT8 = 4} DNNDataType;
45 DAST_FAIL, // something wrong
46 DAST_EMPTY_QUEUE, // no more inference result to get
47 DAST_NOT_READY, // all queued inferences are not finished
48 DAST_SUCCESS // got a result frame successfully
53 DFT_PROCESS_FRAME, // process the whole frame
54 DFT_ANALYTICS_DETECT, // detect from the whole frame
55 // we can add more such as detect_from_crop, classify_from_bbox, etc.
58 typedef struct DNNData{
60 int width, height, channels;
61 // dt and order together decide the color format
66 typedef int (*FramePrePostProc)(AVFrame *frame, DNNData *model, AVFilterContext *filter_ctx);
67 typedef int (*DetectPostProc)(AVFrame *frame, DNNData *output, uint32_t nb, AVFilterContext *filter_ctx);
69 typedef struct DNNModel{
70 // Stores model that can be different for different backends.
72 // Stores options when the model is executed by the backend
74 // Stores FilterContext used for the interaction between AVFrame and DNNData
75 AVFilterContext *filter_ctx;
76 // Stores function type of the model
77 DNNFunctionType func_type;
78 // Gets model input information
79 // Just reuse struct DNNData here, actually the DNNData.data field is not needed.
80 DNNReturnType (*get_input)(void *model, DNNData *input, const char *input_name);
81 // Gets model output width/height with given input w/h
82 DNNReturnType (*get_output)(void *model, const char *input_name, int input_width, int input_height,
83 const char *output_name, int *output_width, int *output_height);
84 // set the pre process to transfer data from AVFrame to DNNData
85 // the default implementation within DNN is used if it is not provided by the filter
86 FramePrePostProc frame_pre_proc;
87 // set the post process to transfer data from DNNData to AVFrame
88 // the default implementation within DNN is used if it is not provided by the filter
89 FramePrePostProc frame_post_proc;
90 // set the post process to interpret detect result from DNNData
91 DetectPostProc detect_post_proc;
94 // Stores pointers to functions for loading, executing, freeing DNN models for one of the backends.
95 typedef struct DNNModule{
96 // Loads model and parameters from given file. Returns NULL if it is not possible.
97 DNNModel *(*load_model)(const char *model_filename, DNNFunctionType func_type, const char *options, AVFilterContext *filter_ctx);
98 // Executes model with specified input and output. Returns DNN_ERROR otherwise.
99 DNNReturnType (*execute_model)(const DNNModel *model, const char *input_name, AVFrame *in_frame,
100 const char **output_names, uint32_t nb_output, AVFrame *out_frame);
101 // Executes model with specified input and output asynchronously. Returns DNN_ERROR otherwise.
102 DNNReturnType (*execute_model_async)(const DNNModel *model, const char *input_name, AVFrame *in_frame,
103 const char **output_names, uint32_t nb_output, AVFrame *out_frame);
104 // Retrieve inference result.
105 DNNAsyncStatusType (*get_async_result)(const DNNModel *model, AVFrame **in, AVFrame **out);
106 // Flush all the pending tasks.
107 DNNReturnType (*flush)(const DNNModel *model);
108 // Frees memory allocated for model.
109 void (*free_model)(DNNModel **model);
112 // Initializes DNNModule depending on chosen backend.
113 DNNModule *ff_get_dnn_module(DNNBackendType backend_type);