Doxygen Book
_NNStreamer_custom_class Struct Reference

Custom Filter Class. More...

#include <tensor_filter_custom.h>

Collaboration diagram for _NNStreamer_custom_class:

Public Attributes

NNS_custom_init_func initfunc
 
NNS_custom_exit_func exitfunc
 
NNS_custom_get_input_dimension getInputDim
 
NNS_custom_get_output_dimension getOutputDim
 
NNS_custom_set_input_dimension setInputDim
 
NNS_custom_invoke invoke
 
NNS_custom_allocate_invoke allocate_invoke
 
NNS_custom_destroy_notify destroy_notify
 

Detailed Description

Custom Filter Class.

Note that every function pointer is MANDATORY!

Definition at line 125 of file tensor_filter_custom.h.

Member Data Documentation

◆ allocate_invoke

NNS_custom_allocate_invoke _NNStreamer_custom_class::allocate_invoke

the main function, "allocate & invoke", that transforms input to output. allocate_invoke is supposed to allocate output buffer by itself. (invoke) XOR (allocate_invoke) MUST hold.

Definition at line 133 of file tensor_filter_custom.h.

◆ destroy_notify

NNS_custom_destroy_notify _NNStreamer_custom_class::destroy_notify

it handles the data pointer allocated in the custom framework. when the data pointer has been destroyed at the pipeline, this method will be called. the data pointer or an object including data pointer could be deleted safely with this function. this method is only used when allocate_invoke is TRUE

Definition at line 134 of file tensor_filter_custom.h.

◆ exitfunc

NNS_custom_exit_func _NNStreamer_custom_class::exitfunc

will not call other callbacks after this call

Definition at line 128 of file tensor_filter_custom.h.

◆ getInputDim

NNS_custom_get_input_dimension _NNStreamer_custom_class::getInputDim

a custom filter is required to provide input tensor dimension unless setInputdim is defined.

Definition at line 129 of file tensor_filter_custom.h.

◆ getOutputDim

NNS_custom_get_output_dimension _NNStreamer_custom_class::getOutputDim

a custom filter is required to provide output tensor dimension unless setInputDim is defined.

Definition at line 130 of file tensor_filter_custom.h.

◆ initfunc

NNS_custom_init_func _NNStreamer_custom_class::initfunc

called before any other callbacks from tensor_filter_custom.c

Definition at line 127 of file tensor_filter_custom.h.

◆ invoke

NNS_custom_invoke _NNStreamer_custom_class::invoke

the main function, "invoke", that transforms input to output. invoke is supposed to fill in the given output buffer. (invoke) XOR (allocate_invoke) MUST hold.

Definition at line 132 of file tensor_filter_custom.h.

◆ setInputDim

NNS_custom_set_input_dimension _NNStreamer_custom_class::setInputDim

without getI/O-Dim, this allows framework to set input dimension and get output dimension from the custom filter according to the input dimension

Definition at line 131 of file tensor_filter_custom.h.


The documentation for this struct was generated from the following file: