FFmpeg
dnn_filter_common.c
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 #include "dnn_filter_common.h"
20 #include "libavutil/avstring.h"
21 #include "libavutil/mem.h"
22 #include "libavutil/opt.h"
23 
24 #define MAX_SUPPORTED_OUTPUTS_NB 4
25 
26 static char **separate_output_names(const char *expr, const char *val_sep, int *separated_nb)
27 {
28  char *val, **parsed_vals = NULL;
29  int val_num = 0;
30  if (!expr || !val_sep || !separated_nb) {
31  return NULL;
32  }
33 
34  parsed_vals = av_calloc(MAX_SUPPORTED_OUTPUTS_NB, sizeof(*parsed_vals));
35  if (!parsed_vals) {
36  return NULL;
37  }
38 
39  do {
40  val = av_get_token(&expr, val_sep);
41  if(val) {
42  parsed_vals[val_num] = val;
43  val_num++;
44  }
45  if (*expr) {
46  expr++;
47  }
48  } while(*expr);
49 
50  parsed_vals[val_num] = NULL;
51  *separated_nb = val_num;
52 
53  return parsed_vals;
54 }
55 
56 typedef struct DnnFilterBase {
57  const AVClass *class;
60 
62  DnnFilterBase *base = filter->priv;
63  ff_dnn_init_child_class(&base->dnnctx);
64  return 0;
65 }
66 
67 void *ff_dnn_filter_child_next(void *obj, void *prev)
68 {
69  DnnFilterBase *base = obj;
70  return ff_dnn_child_next(&base->dnnctx, prev);
71 }
72 
74 {
75  DNNBackendType backend = ctx->backend_type;
76 
77  if (!ctx->model_filename) {
78  av_log(filter_ctx, AV_LOG_ERROR, "model file for network is not specified\n");
79  return AVERROR(EINVAL);
80  }
81 
82  if (backend == DNN_TH) {
83  if (ctx->model_inputname)
84  av_log(filter_ctx, AV_LOG_WARNING, "LibTorch backend do not require inputname, "\
85  "inputname will be ignored.\n");
86  if (ctx->model_outputnames)
87  av_log(filter_ctx, AV_LOG_WARNING, "LibTorch backend do not require outputname(s), "\
88  "all outputname(s) will be ignored.\n");
89  ctx->nb_outputs = 1;
90  } else if (backend == DNN_TF) {
91  if (!ctx->model_inputname) {
92  av_log(filter_ctx, AV_LOG_ERROR, "input name of the model network is not specified\n");
93  return AVERROR(EINVAL);
94  }
95  ctx->model_outputnames = separate_output_names(ctx->model_outputnames_string, "&", &ctx->nb_outputs);
96  if (!ctx->model_outputnames) {
97  av_log(filter_ctx, AV_LOG_ERROR, "could not parse model output names\n");
98  return AVERROR(EINVAL);
99  }
100  }
101 
102  ctx->dnn_module = ff_get_dnn_module(ctx->backend_type, filter_ctx);
103  if (!ctx->dnn_module) {
104  av_log(filter_ctx, AV_LOG_ERROR, "could not create DNN module for requested backend\n");
105  return AVERROR(ENOMEM);
106  }
107  if (!ctx->dnn_module->load_model) {
108  av_log(filter_ctx, AV_LOG_ERROR, "load_model for network is not specified\n");
109  return AVERROR(EINVAL);
110  }
111 
112  if (ctx->backend_options) {
113  void *child = NULL;
114 
116  "backend_configs is deprecated, please set backend options directly\n");
117  while (child = ff_dnn_child_next(ctx, child)) {
118  if (*(const AVClass **)child == &ctx->dnn_module->clazz) {
119  int ret = av_opt_set_from_string(child, ctx->backend_options,
120  NULL, "=", "&");
121  if (ret < 0) {
122  av_log(filter_ctx, AV_LOG_ERROR, "failed to parse options \"%s\"\n",
123  ctx->backend_options);
124  return ret;
125  }
126  }
127  }
128  }
129 
130  ctx->model = (ctx->dnn_module->load_model)(ctx, func_type, filter_ctx);
131  if (!ctx->model) {
132  av_log(filter_ctx, AV_LOG_ERROR, "could not load DNN model\n");
133  return AVERROR(EINVAL);
134  }
135 
136  return 0;
137 }
138 
140 {
141  ctx->model->frame_pre_proc = pre_proc;
142  ctx->model->frame_post_proc = post_proc;
143  return 0;
144 }
145 
147 {
148  ctx->model->detect_post_proc = post_proc;
149  return 0;
150 }
151 
153 {
154  ctx->model->classify_post_proc = post_proc;
155  return 0;
156 }
157 
159 {
160  return ctx->model->get_input(ctx->model->model, input, ctx->model_inputname);
161 }
162 
163 int ff_dnn_get_output(DnnContext *ctx, int input_width, int input_height, int *output_width, int *output_height)
164 {
165  char * output_name = ctx->model_outputnames && ctx->backend_type != DNN_TH ?
166  ctx->model_outputnames[0] : NULL;
167  return ctx->model->get_output(ctx->model->model, ctx->model_inputname, input_width, input_height,
168  (const char *)output_name, output_width, output_height);
169 }
170 
171 int ff_dnn_execute_model(DnnContext *ctx, AVFrame *in_frame, AVFrame *out_frame)
172 {
173  DNNExecBaseParams exec_params = {
174  .input_name = ctx->model_inputname,
175  .output_names = (const char **)ctx->model_outputnames,
176  .nb_output = ctx->nb_outputs,
177  .in_frame = in_frame,
178  .out_frame = out_frame,
179  };
180  return (ctx->dnn_module->execute_model)(ctx->model, &exec_params);
181 }
182 
183 int ff_dnn_execute_model_classification(DnnContext *ctx, AVFrame *in_frame, AVFrame *out_frame, const char *target)
184 {
185  DNNExecClassificationParams class_params = {
186  {
187  .input_name = ctx->model_inputname,
188  .output_names = (const char **)ctx->model_outputnames,
189  .nb_output = ctx->nb_outputs,
190  .in_frame = in_frame,
191  .out_frame = out_frame,
192  },
193  .target = target,
194  };
195  return (ctx->dnn_module->execute_model)(ctx->model, &class_params.base);
196 }
197 
199 {
200  return (ctx->dnn_module->get_result)(ctx->model, in_frame, out_frame);
201 }
202 
204 {
205  return (ctx->dnn_module->flush)(ctx->model);
206 }
207 
209 {
210  if (ctx->dnn_module) {
211  (ctx->dnn_module->free_model)(&ctx->model);
212  }
213  if (ctx->model_outputnames) {
214  for (int i = 0; i < ctx->nb_outputs; i++)
215  av_free(ctx->model_outputnames[i]);
216 
217  av_freep(&ctx->model_outputnames);
218  }
219 }
AV_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:186
MAX_SUPPORTED_OUTPUTS_NB
#define MAX_SUPPORTED_OUTPUTS_NB
Definition: dnn_filter_common.c:24
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
opt.h
DNNFunctionType
DNNFunctionType
Definition: dnn_interface.h:52
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:374
av_opt_set_from_string
int av_opt_set_from_string(void *ctx, const char *opts, const char *const *shorthand, const char *key_val_sep, const char *pairs_sep)
Parse the key-value pairs list in opts.
Definition: opt.c:1873
DetectPostProc
int(* DetectPostProc)(AVFrame *frame, DNNData *output, uint32_t nb, AVFilterContext *filter_ctx)
Definition: dnn_interface.h:90
separate_output_names
static char ** separate_output_names(const char *expr, const char *val_sep, int *separated_nb)
Definition: dnn_filter_common.c:26
base
uint8_t base
Definition: vp3data.h:128
DNNExecBaseParams::input_name
const char * input_name
Definition: dnn_interface.h:77
filter
filter_frame For filters that do not use the this method is called when a frame is pushed to the filter s input It can be called at any time except in a reentrant way If the input frame is enough to produce then the filter should push the output frames on the output link immediately As an exception to the previous rule if the input frame is enough to produce several output frames then the filter needs output only at least one per link The additional frames can be left buffered in the filter
Definition: filter_design.txt:228
dnn_filter_common.h
DnnContext
Definition: dnn_interface.h:141
filter_ctx
static FilteringContext * filter_ctx
Definition: transcode.c:52
ff_dnn_filter_init_child_class
int ff_dnn_filter_init_child_class(AVFilterContext *filter)
Definition: dnn_filter_common.c:61
val
static double val(void *priv, double ch)
Definition: aeval.c:78
DNN_TF
@ DNN_TF
Definition: dnn_interface.h:35
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
DNNExecClassificationParams
Definition: dnn_interface.h:84
ff_dnn_set_detect_post_proc
int ff_dnn_set_detect_post_proc(DnnContext *ctx, DetectPostProc post_proc)
Definition: dnn_filter_common.c:146
DNNData
Definition: dnn_interface.h:65
ff_dnn_get_result
DNNAsyncStatusType ff_dnn_get_result(DnnContext *ctx, AVFrame **in_frame, AVFrame **out_frame)
Definition: dnn_filter_common.c:198
ff_dnn_init_child_class
void ff_dnn_init_child_class(DnnContext *ctx)
Definition: dnn_interface.c:105
ctx
AVFormatContext * ctx
Definition: movenc.c:49
ff_dnn_get_input
int ff_dnn_get_input(DnnContext *ctx, DNNData *input)
Definition: dnn_filter_common.c:158
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
DNNExecClassificationParams::base
DNNExecBaseParams base
Definition: dnn_interface.h:85
NULL
#define NULL
Definition: coverity.c:32
ff_dnn_filter_child_next
void * ff_dnn_filter_child_next(void *obj, void *prev)
Definition: dnn_filter_common.c:67
ff_dnn_execute_model_classification
int ff_dnn_execute_model_classification(DnnContext *ctx, AVFrame *in_frame, AVFrame *out_frame, const char *target)
Definition: dnn_filter_common.c:183
ff_dnn_flush
int ff_dnn_flush(DnnContext *ctx)
Definition: dnn_filter_common.c:203
ClassifyPostProc
int(* ClassifyPostProc)(AVFrame *frame, DNNData *output, uint32_t bbox_index, AVFilterContext *filter_ctx)
Definition: dnn_interface.h:91
DNNBackendType
DNNBackendType
Definition: dnn_interface.h:35
ff_get_dnn_module
const DNNModule * ff_get_dnn_module(DNNBackendType backend_type, void *log_ctx)
Definition: dnn_interface.c:82
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
ff_dnn_child_next
void * ff_dnn_child_next(DnnContext *obj, void *prev)
Definition: dnn_interface.c:113
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:256
ff_dnn_set_frame_proc
int ff_dnn_set_frame_proc(DnnContext *ctx, FramePrePostProc pre_proc, FramePrePostProc post_proc)
Definition: dnn_filter_common.c:139
av_calloc
void * av_calloc(size_t nmemb, size_t size)
Definition: mem.c:264
DnnFilterBase::dnnctx
DnnContext dnnctx
Definition: dnn_filter_common.c:58
ret
ret
Definition: filter_design.txt:187
DnnFilterBase
Definition: dnn_filter_common.c:56
ff_dnn_get_output
int ff_dnn_get_output(DnnContext *ctx, int input_width, int input_height, int *output_width, int *output_height)
Definition: dnn_filter_common.c:163
av_get_token
char * av_get_token(const char **buf, const char *term)
Unescape the given string until a non escaped terminating char, and return the token corresponding to...
Definition: avstring.c:143
FramePrePostProc
int(* FramePrePostProc)(AVFrame *frame, DNNData *model, AVFilterContext *filter_ctx)
Definition: dnn_interface.h:89
AVFilterContext
An instance of a filter.
Definition: avfilter.h:407
DNN_TH
@ DNN_TH
Definition: dnn_interface.h:35
mem.h
av_free
#define av_free(p)
Definition: tableprint_vlc.h:33
ff_dnn_init
int ff_dnn_init(DnnContext *ctx, DNNFunctionType func_type, AVFilterContext *filter_ctx)
Definition: dnn_filter_common.c:73
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
DNNExecBaseParams
Definition: dnn_interface.h:76
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
ff_dnn_uninit
void ff_dnn_uninit(DnnContext *ctx)
Definition: dnn_filter_common.c:208
ff_dnn_execute_model
int ff_dnn_execute_model(DnnContext *ctx, AVFrame *in_frame, AVFrame *out_frame)
Definition: dnn_filter_common.c:171
avstring.h
DNNAsyncStatusType
DNNAsyncStatusType
Definition: dnn_interface.h:45
ff_dnn_set_classify_post_proc
int ff_dnn_set_classify_post_proc(DnnContext *ctx, ClassifyPostProc post_proc)
Definition: dnn_filter_common.c:152