FFmpeg
dnn_filter_common.h
Go to the documentation of this file.
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * FFmpeg is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with FFmpeg; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 
19 /**
20  * @file
21  * common functions for the dnn based filters
22  */
23 
24 #ifndef AVFILTER_DNN_FILTER_COMMON_H
25 #define AVFILTER_DNN_FILTER_COMMON_H
26 
27 #include "dnn_interface.h"
28 
29 typedef struct DnnContext {
35  int async;
36 
38  uint32_t nb_outputs;
41 } DnnContext;
42 
43 #define DNN_COMMON_OPTIONS \
44  { "model", "path to model file", OFFSET(model_filename), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, FLAGS },\
45  { "input", "input name of the model", OFFSET(model_inputname), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, FLAGS },\
46  { "output", "output name of the model", OFFSET(model_outputnames_string), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, FLAGS },\
47  { "backend_configs", "backend configs", OFFSET(backend_options), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, FLAGS },\
48  { "options", "backend configs (deprecated, use backend_configs)", OFFSET(backend_options), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, FLAGS | AV_OPT_FLAG_DEPRECATED},\
49  { "async", "use DNN async inference (ignored, use backend_configs='async=1')", OFFSET(async), AV_OPT_TYPE_BOOL, { .i64 = 1}, 0, 1, FLAGS},
50 
51 
57 DNNReturnType ff_dnn_get_output(DnnContext *ctx, int input_width, int input_height, int *output_width, int *output_height);
59 DNNReturnType ff_dnn_execute_model_classification(DnnContext *ctx, AVFrame *in_frame, AVFrame *out_frame, const char *target);
63 
64 #endif
filter_ctx
static FilteringContext * filter_ctx
Definition: transcoding.c:49
DnnContext::dnn_module
DNNModule * dnn_module
Definition: dnn_filter_common.h:39
DNNFunctionType
DNNFunctionType
Definition: dnn_interface.h:52
DnnContext::model
DNNModel * model
Definition: dnn_filter_common.h:40
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:317
ff_dnn_set_detect_post_proc
int ff_dnn_set_detect_post_proc(DnnContext *ctx, DetectPostProc post_proc)
Definition: dnn_filter_common.c:97
ff_dnn_init
int ff_dnn_init(DnnContext *ctx, DNNFunctionType func_type, AVFilterContext *filter_ctx)
Definition: dnn_filter_common.c:54
DetectPostProc
int(* DetectPostProc)(AVFrame *frame, DNNData *output, uint32_t nb, AVFilterContext *filter_ctx)
Definition: dnn_interface.h:81
ff_dnn_uninit
void ff_dnn_uninit(DnnContext *ctx)
Definition: dnn_filter_common.c:157
DnnContext
Definition: dnn_filter_common.h:29
ff_dnn_get_output
DNNReturnType ff_dnn_get_output(DnnContext *ctx, int input_width, int input_height, int *output_width, int *output_height)
Definition: dnn_filter_common.c:114
ff_dnn_execute_model
DNNReturnType ff_dnn_execute_model(DnnContext *ctx, AVFrame *in_frame, AVFrame *out_frame)
Definition: dnn_filter_common.c:120
DnnContext::async
int async
Definition: dnn_filter_common.h:35
DnnContext::model_filename
char * model_filename
Definition: dnn_filter_common.h:30
DnnContext::model_outputnames
char ** model_outputnames
Definition: dnn_filter_common.h:37
DNNReturnType
DNNReturnType
Definition: dnn_interface.h:33
DNNData
Definition: dnn_interface.h:59
ctx
AVFormatContext * ctx
Definition: movenc.c:48
ff_dnn_set_classify_post_proc
int ff_dnn_set_classify_post_proc(DnnContext *ctx, ClassifyPostProc post_proc)
Definition: dnn_filter_common.c:103
ff_dnn_execute_model_classification
DNNReturnType ff_dnn_execute_model_classification(DnnContext *ctx, AVFrame *in_frame, AVFrame *out_frame, const char *target)
Definition: dnn_filter_common.c:132
DnnContext::backend_options
char * backend_options
Definition: dnn_filter_common.h:34
ff_dnn_flush
DNNReturnType ff_dnn_flush(DnnContext *ctx)
Definition: dnn_filter_common.c:152
DnnContext::backend_type
DNNBackendType backend_type
Definition: dnn_filter_common.h:31
ClassifyPostProc
int(* ClassifyPostProc)(AVFrame *frame, DNNData *output, uint32_t bbox_index, AVFilterContext *filter_ctx)
Definition: dnn_interface.h:82
DnnContext::model_inputname
char * model_inputname
Definition: dnn_filter_common.h:32
DNNBackendType
DNNBackendType
Definition: dnn_interface.h:35
DnnContext::nb_outputs
uint32_t nb_outputs
Definition: dnn_filter_common.h:38
ff_dnn_get_result
DNNAsyncStatusType ff_dnn_get_result(DnnContext *ctx, AVFrame **in_frame, AVFrame **out_frame)
Definition: dnn_filter_common.c:147
input
and forward the test the status of outputs and forward it to the corresponding return FFERROR_NOT_READY If the filters stores internally one or a few frame for some input
Definition: filter_design.txt:172
dnn_interface.h
FramePrePostProc
int(* FramePrePostProc)(AVFrame *frame, DNNData *model, AVFilterContext *filter_ctx)
Definition: dnn_interface.h:80
AVFilterContext
An instance of a filter.
Definition: avfilter.h:402
DNNModel
Definition: dnn_interface.h:84
ff_dnn_set_frame_proc
int ff_dnn_set_frame_proc(DnnContext *ctx, FramePrePostProc pre_proc, FramePrePostProc post_proc)
Definition: dnn_filter_common.c:90
ff_dnn_get_input
DNNReturnType ff_dnn_get_input(DnnContext *ctx, DNNData *input)
Definition: dnn_filter_common.c:109
DNNAsyncStatusType
DNNAsyncStatusType
Definition: dnn_interface.h:45
DNNModule
Definition: dnn_interface.h:112
DnnContext::model_outputnames_string
char * model_outputnames_string
Definition: dnn_filter_common.h:33