ailia_tflite.h

[詳解]

 
#if       !defined(INCLUDED_AILIA_TFLITE)
#define            INCLUDED_AILIA_TFLITE
 
#include <stdint.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
    /****************************************************************
    * ailia TFLite runtime のインスタンス
    **/
 
    struct AILIATFLiteInstance;
 
    /****************************************************************
    * サブコア制御用の変数を指定する構造体
    **/
 
    struct AILIATFLiteSubCoreControlVariables;
 
    /****************************************************************
    * Tensorのデータ タイプ
    **/
 
    #define AILIA_TFLITE_TENSOR_TYPE_FLOAT32   (0)
    #define AILIA_TFLITE_TENSOR_TYPE_FLOAT16   (1)
    #define AILIA_TFLITE_TENSOR_TYPE_INT32     (2)
    #define AILIA_TFLITE_TENSOR_TYPE_UINT8     (3)
    #define AILIA_TFLITE_TENSOR_TYPE_INT64     (4)
    #define AILIA_TFLITE_TENSOR_TYPE_STRING    (5)
    #define AILIA_TFLITE_TENSOR_TYPE_BOOL      (6)
    #define AILIA_TFLITE_TENSOR_TYPE_INT16     (7)
    #define AILIA_TFLITE_TENSOR_TYPE_COMPLEX64 (8)
    #define AILIA_TFLITE_TENSOR_TYPE_INT8      (9)
    typedef int8_t AILIATFLiteTensorType;
 
    /****************************************************************
    * ステータスコード
    **/
 
    #define AILIA_TFLITE_STATUS_SUCCESS                 (   0)
    #define AILIA_TFLITE_STATUS_INVALID_ARGUMENT         (  -1)
    #define AILIA_TFLITE_STATUS_OUT_OF_RANGE            (  -2)
    #define AILIA_TFLITE_STATUS_MEMORY_INSUFFICIENT     (  -3)
    #define AILIA_TFLITE_STATUS_BROKEN_MODEL            (  -4)
    #define AILIA_TFLITE_STATUS_INVALID_PARAMETER       (  -5)
    #define AILIA_TFLITE_STATUS_PARAMETER_NOT_FOUND     (  -6)
    #define AILIA_TFLITE_STATUS_UNSUPPORTED_OPCODE      (  -7)
    #define AILIA_TFLITE_STATUS_LICENSE_NOT_FOUND       (  -8)
    #define AILIA_TFLITE_STATUS_LICENSE_BROKEN          (  -9)
    #define AILIA_TFLITE_STATUS_LICENSE_EXPIRED         ( -10)
    #define AILIA_TFLITE_STATUS_INVALID_STATE           ( -11)
    #define AILIA_TFLITE_STATUS_OTHER_ERROR             (-128)
    typedef int32_t AILIATFLiteStatus;
 
    /****************************************************************
    * バックエンドAPI
    **/
 
    #define AILIA_TFLITE_ENV_REFERENCE              (0)
    #define AILIA_TFLITE_ENV_NNAPI                  (1)
    #define AILIA_TFLITE_ENV_MMALIB                 (2)
    #define AILIA_TFLITE_ENV_MMALIB_COMPATIBLE       (3)
    typedef int32_t AILIATFLiteEnvironment;
    #define AILIA_TFLITE_ENV_QNN                     (4)
 
    /****************************************************************
    * メモリモード
    **/
 
    #define AILIA_TFLITE_MEMORY_MODE_DEFAULT           (0)
    #define AILIA_TFLITE_MEMORY_MODE_REDUCE_INTERSTAGE (1)
    typedef int32_t AILIATFLiteMemoryMode;
 
    /****************************************************************
    * プロファイルモード
    **/
 
    #define AILIA_TFLITE_PROFILE_MODE_DISABLE (0)
 
    #define AILIA_TFLITE_PROFILE_MODE_ENABLE (1)
 
    #define AILIA_TFLITE_PROFILE_MODE_TRACE (2)
 
    #define AILIA_TFLITE_PROFILE_MODE_MEMORY (4)
 
    #define AILIA_TFLITE_PROFILE_MODE_SUB_CORE (8)
 
    #define AILIA_TFLITE_PROFILE_MODE_ALLOCATION (16)
 
    /****************************************************************
    * フラグ
    **/
 
    #define AILIA_TFLITE_FLAG_NONE           (0)
 
    #define AILIA_TFLITE_FLAG_INPUT_AND_OUTPUT_TENSORS_USE_SCRATCH           (1)
 
    #define AILIA_TFLITE_FLAG_DSA_FAST_MEMORY_ALLOCATION           (2)
 
    typedef int32_t AILIATFLiteFlags;
 
    /****************************************************************
    * CPU拡張命令情報
    **/
 
    #define AILIA_TFLITE_CPU_FEATURES_NONE   (0x00000000)
    #define AILIA_TFLITE_CPU_FEATURES_NEON   (0x00000001)
    #define AILIA_TFLITE_CPU_FEATURES_SSE2   (0x00000002)
    #define AILIA_TFLITE_CPU_FEATURES_SSE4_2 (0x00000004)
    #define AILIA_TFLITE_CPU_FEATURES_AVX    (0x00000008)
    #define AILIA_TFLITE_CPU_FEATURES_AVX2   (0x00000010)
    #define AILIA_TFLITE_CPU_FEATURES_VNNI   (0x00000020)
    #define AILIA_TFLITE_CPU_FEATURES_AVX512 (0x00000040)
    #define AILIA_TFLITE_CPU_FEATURES_I8MM   (0x00000080)
 
    #define AILIA_TFLITE_SUB_CORE_COUNT_MAX (8)
 
    typedef int32_t AILIATFLiteCpuFeatures;
 
    /****************************************************************
    * 推論環境列挙API
    **/
 
    AILIATFLiteStatus
    ailiaTFLiteGetEnvironmentCount(size_t *env_count);
 
    AILIATFLiteStatus
    ailiaTFLiteGetEnvironment(AILIATFLiteEnvironment *env);
 
    /****************************************************************
    * インスタンス生成・破棄API
    **/
 
    AILIATFLiteStatus
    ailiaTFLiteCreate(struct AILIATFLiteInstance **instance, const void * tflite, const size_t tflite_length, void *(*pmalloc)(size_t, const void *, void *), void *(*pmemcpy)(void *, const void *, size_t, void *), void (*pfree)(void *, void *), void *phandle, AILIATFLiteEnvironment env_id, AILIATFLiteMemoryMode memory_mode, AILIATFLiteFlags flags);
 
    void
    ailiaTFLiteDestroy(struct AILIATFLiteInstance *instance);
 
    /****************************************************************
    * CPU命令設定系API
    **/
 
    AILIATFLiteStatus
    ailiaTFLiteGetCpuFeatures(struct AILIATFLiteInstance * instance, int32_t *cpu_features);
 
    AILIATFLiteStatus
    ailiaTFLiteSetCpuFeatures(struct AILIATFLiteInstance * instance, int32_t cpu_features);
 
    /****************************************************************
    * 確保系API
    **/
 
    AILIATFLiteStatus
    ailiaTFLiteAllocateTensors(struct AILIATFLiteInstance * instance);
 
    /****************************************************************
    * Tensor設定系API
    **/
 
    AILIATFLiteStatus
    ailiaTFLiteResizeInputTensor(struct AILIATFLiteInstance * instance, const int32_t input_index, const int32_t* shape, const int32_t dim);
 
    /****************************************************************
    * Tensor取得系API
    **/
 
    AILIATFLiteStatus
    ailiaTFLiteGetNumberOfInputs(const struct AILIATFLiteInstance *instance, int32_t* num_of_input_tensor);
 
    AILIATFLiteStatus
    ailiaTFLiteGetInputTensorIndex(const struct AILIATFLiteInstance *instance, int32_t* tensor_index, const int32_t input_index);
 
    AILIATFLiteStatus
    ailiaTFLiteGetNumberOfOutputs(const struct AILIATFLiteInstance *instance, int32_t* num_of_output_tensor);
 
    AILIATFLiteStatus
    ailiaTFLiteGetOutputTensorIndex(const struct AILIATFLiteInstance *instance, int32_t* tensor_index, const int32_t output_index);
 
    AILIATFLiteStatus
    ailiaTFLiteGetTensorDimension(const struct AILIATFLiteInstance *instance, int32_t* tensor_dim, const int32_t tensor_index);
 
    AILIATFLiteStatus
    ailiaTFLiteGetTensorShape(const struct AILIATFLiteInstance *instance, int32_t *shape, const int32_t tensor_index);
 
    AILIATFLiteStatus
    ailiaTFLiteGetTensorShapeSignature(const struct AILIATFLiteInstance *instance, int32_t *shape, const int32_t tensor_index);
 
    AILIATFLiteStatus
    ailiaTFLiteGetTensorType(const struct AILIATFLiteInstance *instance, AILIATFLiteTensorType* tensor_type, const int32_t tensor_index);
 
    AILIATFLiteStatus
    ailiaTFLiteGetTensorBuffer(struct AILIATFLiteInstance *instance, void** buffer, const int32_t tensor_index);
 
    AILIATFLiteStatus
    ailiaTFLiteGetTensorName(const struct AILIATFLiteInstance *instance, const char** name, const int32_t tensor_index);
 
    AILIATFLiteStatus
    ailiaTFLiteGetTensorQuantizationCount(const struct AILIATFLiteInstance *instance, int32_t* count, const int32_t tensor_index);
 
    AILIATFLiteStatus
    ailiaTFLiteGetTensorQuantizationScale(const struct AILIATFLiteInstance *instance, float *scale, const int32_t tensor_index);
 
    AILIATFLiteStatus
    ailiaTFLiteGetTensorQuantizationZeroPoint(const struct AILIATFLiteInstance *instance, int64_t *zero_point, const int32_t tensor_index);
 
    AILIATFLiteStatus
    ailiaTFLiteGetTensorQuantizationQuantizedDimension(const struct AILIATFLiteInstance *instance, int32_t* axis, const int32_t tensor_index);
 
    /****************************************************************
    * Tensor推論系API
    **/
 
    AILIATFLiteStatus
    ailiaTFLitePredict(struct AILIATFLiteInstance *instance);
 
    /****************************************************************
    * ノード情報取得API
    **/
 
    AILIATFLiteStatus
    ailiaTFLiteGetNodeCount(const struct AILIATFLiteInstance *instance, int32_t *count);
 
    AILIATFLiteStatus
    ailiaTFLiteGetNodeOperator(const struct AILIATFLiteInstance *instance, int32_t *op, const int32_t node_index);
 
    AILIATFLiteStatus
    ailiaTFLiteGetNodeInputCount(const struct AILIATFLiteInstance *instance, int32_t *count, const int32_t node_index);
 
    AILIATFLiteStatus
    ailiaTFLiteGetNodeInputTensorIndex(const struct AILIATFLiteInstance *instance, int32_t *tensor_index, const int32_t node_index, const int32_t input_index);
 
    AILIATFLiteStatus
    ailiaTFLiteGetNodeOutputCount(const struct AILIATFLiteInstance *instance, int32_t *count, const int32_t node_index);
 
    AILIATFLiteStatus
    ailiaTFLiteGetNodeOutputTensorIndex(const struct AILIATFLiteInstance *instance, int32_t *tensor_index, const int32_t node_index, const int32_t output_index);
 
    AILIATFLiteStatus
    ailiaTFLiteGetNodeOption(const struct AILIATFLiteInstance *instance, void *value, const int32_t node_index, const char *key);
 
    AILIATFLiteStatus
    ailiaTFLiteGetOperatorName(const char **name, const int32_t op);
 
    /****************************************************************
    * プロファイルAPI
    **/
 
    AILIATFLiteStatus
    ailiaTFLiteSetProfileMode(struct AILIATFLiteInstance *instance, int mode);
 
    AILIATFLiteStatus
    ailiaTFLiteGetSummaryLength(struct AILIATFLiteInstance *instance, size_t *buffer_size);
 
    AILIATFLiteStatus
    ailiaTFLiteGetSummary(struct AILIATFLiteInstance *instance, char *buffer, size_t buffer_size);
 
    /****************************************************************
    * エラー詳細取得API
    **/
 
    AILIATFLiteStatus
    ailiaTFLiteGetErrorDetail(struct AILIATFLiteInstance *instance, char **buffer);
 
    /****************************************************************
    * バージョン情報取得API
    **/
 
    const char* ailiaTFLiteGetVersion(void);
 
    /****************************************************************
    * スクラッチバッファ設定API
    **/
 
    AILIATFLiteStatus
    ailiaTFLiteSetScratchBuffer(struct AILIATFLiteInstance *instance, void *int_buffer, size_t int_buffer_size, void *mid_buffer, size_t mid_buffer_size, void *ext_buffer, size_t ext_buffer_size);
 
    AILIATFLiteStatus
    ailiaTFLiteSetScratchBufferEx(struct AILIATFLiteInstance* instance, void* int_buffer, size_t int_buffer_size, void* mid_buffer, size_t mid_buffer_size, void* ext_buffer, size_t ext_buffer_size, void* global_buffer, size_t global_buffer_size);
 
    AILIATFLiteStatus
    ailiaTFLiteGetScratchBufferUsage(struct AILIATFLiteInstance *instance, size_t *int_buffer_size, size_t *mid_buffer_size, size_t *ext_buffer_size);
 
    AILIATFLiteStatus
    ailiaTFLiteGetScratchBufferUsageEx(struct AILIATFLiteInstance* instance, size_t* int_buffer_size, size_t* mid_buffer_size, size_t* ext_buffer_size, size_t* global_buffer_size);
 
 
    /****************************************************************
    * MKL設定API
    **/
 
    AILIATFLiteStatus
    ailiaTFLiteMklSetNumThreads(const int32_t num_threads);
 
    AILIATFLiteStatus
    ailiaTFLiteMklDisableFastMM(void);
 
    AILIATFLiteStatus
    ailiaTFLiteSetSynchronizeFunctions(struct AILIATFLiteInstance* instance,
        int (*pmain_after_command_store)(void*), int (*pmain_before_state_load)(void*));
 
    AILIATFLiteStatus
    alilaTFLiteSetSubCoreControlVariables(struct AILIATFLiteInstance* instance, const struct AILIATFLiteSubCoreControlVariables* control_variables, int32_t sub_core_count);
 
    /****************************************************************
    * DSA結果の保存と復元のAPI
    **/
 
    AILIATFLiteStatus
    ailiaTFLiteGetContext(struct AILIATFLiteInstance* instance, void *buf, size_t buf_size);
 
    AILIATFLiteStatus
    ailiaTFLiteGetContextSize(struct AILIATFLiteInstance *instance, size_t *buf_size);
 
    AILIATFLiteStatus
    ailiaTFLiteRestoreContext(struct AILIATFLiteInstance* instance, const void *buf, size_t buf_size);
 
#ifdef __cplusplus
}
#endif
#endif /* !defined(INCLUDED_AILIA_TFLITE) */