TDL SDK Software Development Guide

Revision History

Revision	Date	Description
1.0.0	2021/6/30	Draft
1.0.1	2022/2/11	Update API Example description
1.1.0	2022/6/15	Update API
1.2.0	2022/7/27	Update API
1.2.1	2025/1/21	Rectify API and Data Types

Contents

• 1. Disclaimer
• 2. Function Overview
  • 2.1. Objective
• 3. Design Overview
  • 3.1. System Architecture
  • 3.2. Directory Structure
• 4. API Reference
  • 4.1. Handle
  • 4.2. CVI_TDL_Core
    • 4.2.1. Common
      • 4.2.1.1. CVI_TDL_CreateHandle
      • 4.2.1.2. CVI_TDL_CreateHandle2
      • 4.2.1.3. CVI_TDL_DestroyHandle
      • 4.2.1.4. CVI_TDL_GetModelPath
      • 4.2.1.5. CVI_TDL_OpenModel
      • 4.2.1.6. CVI_TDL_SetSkipVpssPreprocess
      • 4.2.1.7. CVI_TDL_GetSkipVpssPreprocess
      • 4.2.1.8. CVI_TDL_SetVpssThread
      • 4.2.1.9. CVI_TDL_SetVpssThread2
      • 4.2.1.10. CVI_TDL_GetVpssThread
      • 4.2.1.11. CVI_TDL_GetVpssGrpIds
      • 4.2.1.12. CVI_TDL_SetVpssTimeout
      • 4.2.1.13. CVI_TDL_SetVBPool
      • 4.2.1.14. CVI_TDL_GetVBPool
      • 4.2.1.15. CVI_TDL_CloseAllModel
      • 4.2.1.16. CVI_TDL_CloseModel
      • 4.2.1.17. CVI_TDL_Dequantize
      • 4.2.1.18. CVI_TDL_ObjectNMS
      • 4.2.1.19. CVI_TDL_FaceNMS
      • 4.2.1.20. CVI_TDL_FaceAlignment
      • 4.2.1.21. CVI_TDL_CropImage
      • 4.2.1.22. CVI_TDL_CropImage_Face
      • 4.2.1.23. CVI_TDL_SoftMax
      • 4.2.1.24. CVI_TDL_GetVpssChnConfig
      • 4.2.1.25. CVI_TDL_Free
      • 4.2.1.26. CVI_TDL_CopyInfo
      • 4.2.1.27. CVI_TDL_RescaleMetaCenter
      • 4.2.1.28. CVI_TDL_RescaleMetaRB
      • 4.2.1.29. getFeatureTypeSize
      • 4.2.1.30. CVI_TDL_SetModelThreshold
      • 4.2.1.31. CVI_TDL_GetModelThreshold
    • 4.2.2. Object Detection
      • 4.2.2.1. CVI_TDL_Detection
    • 4.2.3. Face detection
      • 4.2.3.1. CVI_TDL_FaceDetection
      • 4.2.3.2. CVI_TDL_FaceLandmarkerDet2
      • 4.2.3.3. CVI_TDL_FaceQuality
      • 4.2.3.4. CVI_TDL_MaskClassification
    • 4.2.4. Face Recognition.
      • 4.2.4.1. CVI_TDL_FaceRecognition
      • 4.2.4.2. CVI_TDL_FaceAttribute_cls
    • 4.2.5. Gesture Recognition
      • 4.2.5.1. CVI_TDL_HandClassification
      • 4.2.5.2. CVI_TDL_HandKeypoint
      • 4.2.5.3. CVI_TDL_HandKeypointClassification
    • 4.2.6. Object Tracking
      • 4.2.6.1. CVI_TDL_DeepSORT_Init
      • 4.2.6.2. CVI_TDL_DeepSORT_GetDefaultConfig
      • 4.2.6.3. CVI_TDL_DeepSORT_SetConfig
      • 4.2.6.4. CVI_TDL_DeepSORT_GetConfig
      • 4.2.6.5. CVI_TDL_DeepSORT_CleanCounter
      • 4.2.6.6. CVI_TDL_DeepSORT_Obj
      • 4.2.6.7. CVI_TDL_DeepSORT_Face
    • 4.2.7. Motion Detection
      • 4.2.7.1. CVI_TDL_Set_MotionDetection_Background
      • 4.2.7.2. CVI_TDL_MotionDetection
      • 4.2.7.3. CVI_TDL_Set_MotionDetection_ROI
    • 4.2.8. License Plate Recognition
      • 4.2.8.1. CVI_TDL_LicensePlateDetection
      • 4.2.8.2. CVI_TDL_LicensePlateRecognition_TW
      • 4.2.8.3. CVI_TDL_LicensePlateRecognition_CN
    • 4.2.9. Liveness Detection
      • 4.2.9.1. CVI_TDL_IrLiveness
    • 4.2.10. Pose Estimation
      • 4.2.10.1. CVI_TDL_PoseDetection
    • 4.2.11. Semantic Segmentation
      • 4.2.11.1. CVI_TDL_YoloV8_Seg
      • 4.2.11.2. CVI_TDL_Topformer_Seg
    • 4.2.12. Fall Detection
      • 4.2.12.1. CVI_TDL_Fall_Monitor
    • 4.2.13. Driver Fatigue Detection
      • 4.2.13.1. CVI_TDL_FaceLandmarker
      • 4.2.13.2. CVI_TDL_EyeClassification
      • 4.2.13.3. CVI_TDL_YawnClassification
    • 4.2.14. Sound Classification
      • 4.2.14.1. CVI_TDL_SoundClassification
      • 4.2.14.2. CVI_TDL_Get_SoundClassification_ClassesNum
      • 4.2.14.3. CVI_TDL_Set_SoundClassification_Threshold
  • 4.3. CVI_TDL_Service
    • 4.3.1. Common
      • 4.3.1.1. CVI_TDL_Service_CreateHandle
      • 4.3.1.2. CVI_TDL_Service_DestroyHandle
      • 4.3.1.3. CVI_TDL_Service_Polygon_SetTarget
      • 4.3.1.4. CVI_TDL_Service_Polygon_Intersect
      • 4.3.1.5. CVI_TDL_Service_RegisterFeatureArray
      • 4.3.1.6. CVI_TDL_Service_CalculateSimilarity
      • 4.3.1.7. CVI_TDL_Service_ObjectInfoMatching
      • 4.3.1.8. CVI_TDL_Service_FaceInfoMatching
      • 4.3.1.9. CVI_TDL_Service_RawMatching
      • 4.3.1.10. CVI_TDL_Service_FaceAngle
      • 4.3.1.11. CVI_TDL_Service_FaceAngleForAll
    • 4.3.2. Image Scaling
      • 4.3.2.1. CVI_TDL_Service_FaceDigitalZoom
      • 4.3.2.2. CVI_TDL_Service_ObjectDigitalZoom
      • 4.3.2.3. CVI_TDL_Service_ObjectDitgitalZoomExt
    • 4.3.3. Image drawing
      • 4.3.3.1. CVI_TDL_Service_FaceDrawPts
      • 4.3.3.2. CVI_TDL_Service_FaceDrawRect
      • 4.3.3.3. CVI_TDL_Service_ObjectDrawPose
      • 4.3.3.4. CVI_TDL_Service_ObjectDrawRect
      • 4.3.3.5. CVI_TDL_Service_ObjectWriteText
      • 4.3.3.6. CVI_TDL_Service_Incar_ObjectDrawRect
• 5. Application（APP）
  • 5.1. Objective
  • 5.2. API
    • 5.2.1. Handle
      • 5.2.1.1. CVI_TDL_APP_CreateHandle
      • 5.2.1.2. CVI_TDL_APP_DestroyHandle
    • 5.2.2. Face Capture
      • 5.2.2.1. CVI_TDL_APP_FaceCapture_Init
      • 5.2.2.2. CVI_TDL_APP_FaceCapture_QuickSetUp
      • 5.2.2.3. CVI_TDL_APP_FaceCapture_FusePedSetup
      • 5.2.2.4. CVI_TDL_APP_FaceCapture_GetDefaultConfig
      • 5.2.2.5. CVI_TDL_APP_FaceCapture_SetConfig
      • 5.2.2.6. CVI_TDL_APP_FaceCapture_FDFR
      • 5.2.2.7. CVI_TDL_APP_FaceCapture_SetMode
      • 5.2.2.8. CVI_TDL_APP_FaceCapture_Run
      • 5.2.2.9. CVI_TDL_APP_FaceCapture_CleanAll
    • 5.2.3. Humanoid Capture
      • 5.2.3.1. CVI_TDL_APP_PersonCapture_Init
      • 5.2.3.2. CVI_TDL_APP_PersonCapture_QuickSetUp
      • 5.2.3.3. CVI_TDL_APP_FaceCapture_GetDefaultConfig
      • 5.2.3.4. CVI_TDL_APP_PersonCapture_SetConfig
      • 5.2.3.5. CVI_TDL_APP_PersonCapture_SetMode
      • 5.2.3.6. CVI_TDL_APP_PersonCapture_Run
      • 5.2.3.7. CVI_TDL_APP_ConsumerCounting_Run
      • 5.2.3.8. CVI_TDL_APP_PersonCapture_CleanAll
• 6. Data Types
  • 6.1. CVI_TDL_Core
    • 6.1.1. CVI_TDL_SUPPORTED_MODEL_E
    • 6.1.2. cvtdl_obj_class_id_e
    • 6.1.3. cvtdl_obj_det_group_type_e
    • 6.1.4. feature_type_e
    • 6.1.5. meta_rescale_type_e
    • 6.1.6. cvtdl_bbox_t
    • 6.1.7. cvtdl_feature_t
    • 6.1.8. cvtdl_pts_t
    • 6.1.9. cvtdl_4_pts_t
    • 6.1.10. cvtdl_vpssconfig_t
    • 6.1.11. cvtdl_tracker_t
    • 6.1.12. cvtdl_tracker_info_t
    • 6.1.13. cvtdl_trk_state_type_t
    • 6.1.14. cvtdl_deepsort_config_t
    • 6.1.15. cvtdl_kalman_filter_config_t
    • 6.1.16. cvtdl_kalman_tracker_config_t
    • 6.1.17. cvtdl_liveness_ir_position_e
    • 6.1.18. cvtdl_head_pose_t
    • 6.1.19. cvtdl_face_info_t
    • 6.1.20. cvtdl_face_t
    • 6.1.21. cvtdl_pose17_meta_t
    • 6.1.22. cvtdl_vehicle_meta
    • 6.1.23. cvtdl_class_filter_t
    • 6.1.24. cvtdl_dms_t
    • 6.1.25. cvtdl_dms_od_t
    • 6.1.26. cvtdl_dms_od_info_t
    • 6.1.27. cvtdl_face_emotion_e
    • 6.1.28. cvtdl_face_race_e
    • 6.1.29. cvtdl_adas_meta
    • 6.1.30. cvtdl_mask_meta
    • 6.1.31. cvtdl_pedestrian_meta
    • 6.1.32. cvtdl_object_info_t
    • 6.1.33. cvtdl_object_t
    • 6.1.34. cvtdl_handpose21_meta_t
    • 6.1.35. cvtdl_handpose21_meta_ts
    • 6.1.36. cvtdl_seg_t
    • 6.1.37. Yolov5PreParam
    • 6.1.38. YOLOV5AlgParam
  • 6.2. CVI_TDL_Service
    • 6.2.1. cvtdl_service_feature_matching_e
    • 6.2.2. cvtdl_service_feature_array_t
    • 6.2.3. cvtdl_service_brush_t
    • 6.2.4. cvtdl_area_detect_e
• 7. Error Codes