nnstreamer_plugin_api_filter.h

Go to the documentation of this file.

/* SPDX-License-Identifier: LGPL-2.1-only */
#ifndef __NNS_PLUGIN_API_FILTER_H__
#define __NNS_PLUGIN_API_FILTER_H__
 
#include "tensor_typedef.h"
 
#define ACCL_NONE_STR "none"
#define ACCL_DEFAULT_STR  "default"
#define ACCL_AUTO_STR "auto"
#define ACCL_CPU_STR  "cpu"
#define ACCL_CPU_SIMD_STR  "cpu.simd"
#define ACCL_CPU_NEON_STR  "cpu.neon"
#define ACCL_GPU_STR  "gpu"
 
#define ACCL_NPU_STR  "npu"
#define ACCL_NPU_MOVIDIUS_STR  "npu.movidius"
#define ACCL_NPU_EDGE_TPU_STR  "npu.edgetpu"
#define ACCL_NPU_VIVANTE_STR  "npu.vivante"
#define ACCL_NPU_SRCN_STR  "npu.srcn" 
#define ACCL_NPU_SLSI_STR  "npu.slsi"
#define ACCL_NPU_SR_STR  "npu.sr"
 
#define GST_TENSOR_FILTER_FRAMEWORK_BASE (0xDEAFDEAD00000000ULL)
#define GST_TENSOR_FILTER_FRAMEWORK_V0 (GST_TENSOR_FILTER_FRAMEWORK_BASE)
#define GST_TENSOR_FILTER_FRAMEWORK_V1 (GST_TENSOR_FILTER_FRAMEWORK_BASE | 0x10000ULL)
 
#define GST_TENSOR_FILTER_API_VERSION_DEFINED (1)
#define GST_TENSOR_FILTER_API_VERSION_MIN (0)   /* The minimum API version supported (could be obsolete) */
#define GST_TENSOR_FILTER_API_VERSION_MAX (1)   /* The maximum API version supported (recommended) */
 
#define checkGstTensorFilterFrameworkVersion(value, version) \
  ((GST_TENSOR_FILTER_FRAMEWORK_BASE | ((version) << 16)) == (value & 0xFFFFFFFFFFFF0000ULL))
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum
{
  ACCL_NONE    = 0,          
  ACCL_AUTO    = 0x1,        
  ACCL_DEFAULT = 0x2,        
  ACCL_CPU          = 0x1000,     
  ACCL_CPU_SIMD     = 0x1100,     
  ACCL_CPU_NEON     = 0x1100,     
  ACCL_GPU          = 0x2000,     
  ACCL_NPU          = 0x4000,     
  ACCL_NPU_MOVIDIUS = 0x4001,     
  ACCL_NPU_EDGE_TPU = 0x4002,     
  ACCL_NPU_VIVANTE  = 0x4003,     
  ACCL_NPU_SRCN     = 0x4004,     
  ACCL_NPU_SLSI     = 0x4005,     
  ACCL_NPU_SR       = 0x4100,     
} accl_hw;
 
typedef tensor_layout tensors_layout[NNS_TENSOR_SIZE_LIMIT];
 
typedef struct _GstTensorFilterProperties
{
  const char *fwname; 
  int fw_opened; 
  const char **model_files; 
  int num_models; 
  int input_configured; 
  GstTensorsInfo input_meta; 
  tensors_layout input_layout; 
  unsigned int input_ranks[NNS_TENSOR_SIZE_LIMIT];  
  int output_configured; 
  GstTensorsInfo output_meta; 
  tensors_layout output_layout; 
  unsigned int output_ranks[NNS_TENSOR_SIZE_LIMIT];  
  const char *custom_properties; 
  accl_hw *hw_list; 
  int num_hw;       
  const char *accl_str; 
  char *shared_tensor_filter_key; 
  int latency; 
  int throughput; 
  int invoke_dynamic; 
  uint32_t suspend; 
} GstTensorFilterProperties;
 
typedef struct _GstTensorFilterFrameworkStatistics
{
  int64_t total_invoke_num;      
  int64_t total_invoke_latency;  
  int64_t total_overhead_latency;    
} GstTensorFilterFrameworkStatistics;
 
typedef struct _GstTensorFilterFrameworkInfo
{
  const char *name; 
  int allow_in_place; 
  int allocate_in_invoke; 
  int run_without_model; 
  int verify_model_path; 
  const accl_hw *hw_list; 
  int num_hw; 
  accl_hw accl_auto;  
  accl_hw accl_default;   
  const GstTensorFilterFrameworkStatistics *statistics;  
} GstTensorFilterFrameworkInfo;
 
typedef enum
{
  DESTROY_NOTIFY,   
  RELOAD_MODEL,     
  CUSTOM_PROP,      
  SET_INPUT_PROP,   
  SET_OUTPUT_PROP,  
  SET_ACCELERATOR,  
  CHECK_HW_AVAILABILITY, 
} event_ops;
 
typedef enum
{
  GET_IN_OUT_INFO,   
  SET_INPUT_INFO,   
} model_info_ops;
 
typedef struct _GstTensorFilterFrameworkEventData
{
  union {
    struct {
      void * data;  
    };
 
    struct {
      const char **model_files;  
      int num_models;   
    };
 
    struct {
      const char *custom_properties; 
    };
 
    struct {
      const GstTensorsInfo * info;  
      tensors_layout layout;        
    };
 
    struct {
      accl_hw *hw_list;   
      int num_hw;         
    };
 
    struct {
      accl_hw hw; 
      const char *custom; 
    };
  };
} GstTensorFilterFrameworkEventData;
 
typedef struct _GstTensorFilterFramework GstTensorFilterFramework;
 
struct _GstTensorFilterFramework
{
  uint64_t version;
  int (*open) (const GstTensorFilterProperties * prop, void **private_data);
  void (*close) (const GstTensorFilterProperties * prop, void **private_data);
  union
  {
    struct 
    {
      char *name; 
      int allow_in_place; 
      int allocate_in_invoke; 
      int run_without_model; 
      int verify_model_path; 
      const GstTensorFilterFrameworkStatistics *statistics;  
      int (*invoke_NN) (const GstTensorFilterProperties * prop, void **private_data,
          const GstTensorMemory * input, GstTensorMemory * output);
      int (*getInputDimension) (const GstTensorFilterProperties * prop,
          void **private_data, GstTensorsInfo * info);
      int (*getOutputDimension) (const GstTensorFilterProperties * prop,
          void **private_data, GstTensorsInfo * info);
      int (*setInputDimension) (const GstTensorFilterProperties * prop,
          void **private_data, const GstTensorsInfo * in_info,
          GstTensorsInfo * out_info);
      void (*destroyNotify) (void **private_data, void * data);
      int (*reloadModel) (const GstTensorFilterProperties * prop, void **private_data);
      int (*handleEvent) (event_ops ops, GstTensorFilterFrameworkEventData * data);
      int (*checkAvailability) (accl_hw hw);
      int (*allocateInInvoke) (void **private_data);
    }
#ifdef NO_ANONYMOUS_NESTED_STRUCT
        v0
#endif
    ;
 
    struct 
    {
      int (*invoke) (const GstTensorFilterFramework * self,
          GstTensorFilterProperties * prop, void *private_data,
          const GstTensorMemory * input, GstTensorMemory * output);
      int (*getFrameworkInfo) (const GstTensorFilterFramework * self,
          const GstTensorFilterProperties * prop, void *private_data,
          GstTensorFilterFrameworkInfo *fw_info);
      int (*getModelInfo) (const GstTensorFilterFramework * self,
          const GstTensorFilterProperties * prop,
          void *private_data, model_info_ops ops,
          GstTensorsInfo *in_info, GstTensorsInfo *out_info);
      int (*eventHandler) (const GstTensorFilterFramework * self,
          const GstTensorFilterProperties * prop,
          void *private_data, event_ops ops, GstTensorFilterFrameworkEventData * data);
      void *subplugin_data; 
    }
#ifdef NO_ANONYMOUS_NESTED_STRUCT
        v1
#endif
    ;
  };
};
 
/* extern functions for subplugin management, exist in tensor_filter_common.c */
extern int
nnstreamer_filter_probe (GstTensorFilterFramework * tfsp);
 
extern void
nnstreamer_filter_exit (const char *name);
 
extern const GstTensorFilterFramework *
nnstreamer_filter_find (const char *name);
 
extern void
nnstreamer_filter_set_custom_property_desc (const char *name, const char *prop, ...);
 
extern accl_hw
get_accl_hw_type (const char * str);
 
extern const char *
get_accl_hw_str (const accl_hw key);
 
typedef struct {
  const char *in_accl;       
  const char **sup_accl;     
  const char *auto_accl;     
  const char *def_accl;      
} parse_accl_args;
 
extern accl_hw parse_accl_hw_fill (parse_accl_args accl_args);
 
#define parse_accl_hw(...) parse_accl_hw_fill((parse_accl_args){__VA_ARGS__})
 
/* extern functions for shared model representation */
void *
nnstreamer_filter_shared_model_get (void *instance, const char *key);
 
/* extern functions for shared model representation */
extern void *
nnstreamer_filter_shared_model_insert_and_get (void *instance, char *key, void *interpreter);
 
/* extern functions for shared model representation */
extern int
nnstreamer_filter_shared_model_remove (void *instance, const char *key,
    void (*free_callback) (void *));
 
/* extern functions for shared model representation */
extern void
nnstreamer_filter_shared_model_replace (void *instance, const char *key,
    void *new_interpreter, void (*replace_callback) (void *, void *), void (*free_callback) (void*));
 
#ifdef __cplusplus
}
#endif
 
#endif /* __NNS_PLUGIN_API_FILTER_H__ */