Doxygen Book
tensor_filter_custom.h
Go to the documentation of this file.
1 
34 #ifndef __NNS_TENSOR_FILTER_CUSTOM_H__
35 #define __NNS_TENSOR_FILTER_CUSTOM_H__
36 
37 #include <stdint.h>
38 #include "tensor_typedef.h"
39 #include "nnstreamer_plugin_api_filter.h"
40 
46 typedef void *(*NNS_custom_init_func) (const GstTensorFilterProperties * prop);
47 
53 typedef void (*NNS_custom_exit_func) (void *private_data,
54  const GstTensorFilterProperties * prop);
55 
63 typedef int (*NNS_custom_get_input_dimension) (void *private_data,
64  const GstTensorFilterProperties * prop, GstTensorsInfo * info);
65 
73 typedef int (*NNS_custom_get_output_dimension) (void *private_data,
74  const GstTensorFilterProperties * prop, GstTensorsInfo * info);
75 
87 typedef int (*NNS_custom_set_input_dimension) (void *private_data,
88  const GstTensorFilterProperties * prop, const GstTensorsInfo * in_info, GstTensorsInfo * out_info);
89 
99 typedef int (*NNS_custom_invoke) (void *private_data,
100  const GstTensorFilterProperties * prop, const GstTensorMemory * input, GstTensorMemory * output);
101 
111 typedef int (*NNS_custom_allocate_invoke) (void *private_data,
112  const GstTensorFilterProperties * prop, const GstTensorMemory * input, GstTensorMemory * output);
113 
118 typedef void (*NNS_custom_destroy_notify) (void *data);
119 
125 struct _NNStreamer_custom_class
126 {
127  NNS_custom_init_func initfunc;
128  NNS_custom_exit_func exitfunc;
129  NNS_custom_get_input_dimension getInputDim;
130  NNS_custom_get_output_dimension getOutputDim;
131  NNS_custom_set_input_dimension setInputDim;
132  NNS_custom_invoke invoke;
133  NNS_custom_allocate_invoke allocate_invoke;
134  NNS_custom_destroy_notify destroy_notify;
135 };
136 typedef struct _NNStreamer_custom_class NNStreamer_custom_class;
137 
141 extern NNStreamer_custom_class *NNStreamer_custom;
142 
143 #endif /*__NNS_TENSOR_FILTER_CUSTOM_H__*/
_NNStreamer_custom_class::exitfunc
NNS_custom_exit_func exitfunc
Definition: tensor_filter_custom.h:128
data
svtc_1 data
Definition: gsttensor_if.c:844
NNS_custom_set_input_dimension
int(* NNS_custom_set_input_dimension)(void *private_data, const GstTensorFilterProperties *prop, const GstTensorsInfo *in_info, GstTensorsInfo *out_info)
Set input dim by framework. Let custom plugin set output dim accordingly.
Definition: tensor_filter_custom.h:87
GstTensorsInfo
Internal meta data exchange format for a other/tensors instance.
Definition: tensor_typedef.h:273
_NNStreamer_custom_class::getInputDim
NNS_custom_get_input_dimension getInputDim
Definition: tensor_filter_custom.h:129
prop
GstTensorSrcIIOChannelProperties * prop
DTYPE_UNSIGNED ( .
Definition: gsttensor_srciio.c:110
GstTensorMemory
The unit of each data tensors. It will be used as an input/output tensor of other/tensors.
Definition: tensor_typedef.h:252
NNS_custom_exit_func
void(* NNS_custom_exit_func)(void *private_data, const GstTensorFilterProperties *prop)
A function that is called after calling other functions, when it's ready to close.
Definition: tensor_filter_custom.h:53
_NNStreamer_custom_class
Custom Filter Class.
Definition: tensor_filter_custom.h:125
_NNStreamer_custom_class::initfunc
NNS_custom_init_func initfunc
Definition: tensor_filter_custom.h:127
NNS_custom_get_input_dimension
int(* NNS_custom_get_input_dimension)(void *private_data, const GstTensorFilterProperties *prop, GstTensorsInfo *info)
Get input tensor type.
Definition: tensor_filter_custom.h:63
NNS_custom_allocate_invoke
int(* NNS_custom_allocate_invoke)(void *private_data, const GstTensorFilterProperties *prop, const GstTensorMemory *input, GstTensorMemory *output)
Invoke the "main function". Without allocating output buffer. (fill in the given output buffer)
Definition: tensor_filter_custom.h:111
NNS_custom_get_output_dimension
int(* NNS_custom_get_output_dimension)(void *private_data, const GstTensorFilterProperties *prop, GstTensorsInfo *info)
Get output tensor type.
Definition: tensor_filter_custom.h:73
NNStreamer_custom
NNStreamer_custom_class * NNStreamer_custom
A custom filter MUST define NNStreamer_custom. This object represents the custom filter itself.
nnstreamer_plugin_api_filter.h
Mandatory APIs for NNStreamer Filter sub-plugins (No External Dependencies)
tensor_typedef.h
Common header file for NNStreamer, the GStreamer plugin for neural networks.
_GstTensorFilterProperties
GstTensorFilter's properties for NN framework (internal data structure)
Definition: nnstreamer_plugin_api_filter.h:112
NNS_custom_invoke
int(* NNS_custom_invoke)(void *private_data, const GstTensorFilterProperties *prop, const GstTensorMemory *input, GstTensorMemory *output)
Invoke the "main function". Without allocating output buffer. (fill in the given output buffer)
Definition: tensor_filter_custom.h:99
_NNStreamer_custom_class::getOutputDim
NNS_custom_get_output_dimension getOutputDim
Definition: tensor_filter_custom.h:130
_NNStreamer_custom_class::allocate_invoke
NNS_custom_allocate_invoke allocate_invoke
Definition: tensor_filter_custom.h:133
NNS_custom_init_func
void *(* NNS_custom_init_func)(const GstTensorFilterProperties *prop)
A function that is called before calling other functions.
Definition: tensor_filter_custom.h:46
_NNStreamer_custom_class::destroy_notify
NNS_custom_destroy_notify destroy_notify
Definition: tensor_filter_custom.h:134
NNS_custom_destroy_notify
void(* NNS_custom_destroy_notify)(void *data)
It's a post-processing method about the used data pointer if it has been allocated at custom filter.
Definition: tensor_filter_custom.h:118
_NNStreamer_custom_class::invoke
NNS_custom_invoke invoke
Definition: tensor_filter_custom.h:132
_NNStreamer_custom_class::setInputDim
NNS_custom_set_input_dimension setInputDim
Definition: tensor_filter_custom.h:131