CV180x/CV181x MEDIA PROCESSING SOFTWARE DEVELOPMENT REFERENCE

Revision History

Revision	Date	Description
v0.01	2019/10/12	Draft
v0.02	2020/2/5	Updated Chapter 9 Audio content
v0.03	2020/06/09	Audio sample rate does not support 96k
v0.04	2020/09/09	Updated Chapter 10 GDC content
v0.05	2020/10/22	Update Chapter 9 VQE Algorithm Parameter Definition
V0.2.1.2	2020/11/03	Update Chapter 6 VENC API Update Chapter 7 VDEC API
V0.2.1.3	2020/12/06	Update Chapter 6 VENC-related APIs: RequestIDR, ROIAttr, RefParam, FrameLostStrategy
V0.2.1.4	2021/01/11	Update Chapter 1 LDC_ATTR_S Update Chapter 3 VI_LDC_ATTR_S, CVI_VI_SetChnLDCAttr, CVI_VI_GetChnLDCAttr Update Chapter 5 LDC/ProcAmp related: CVI_VPSS_GetGrpProcAmpCtrl, CVI_VPSS_GetGrpProcAmp, CVI_VPSS_GetGrpProcAmpCtrl, CVI_VPSS_GetGrpProcAmp, CVI_VPSS_SetGrpProcAmp, CVI_VPSS_SetGrpParamfromBin CVI_VPSS_SetGrpProcAmp, CVI_VPSS_SetGrpParamfromBin
V0.2.1.5	2021/01/26	Update related APIs in Chapter 6: CVI_VENC_GetModParam CVI_VENC_ResetChn CVI_VENC_AttachVbPool CVI_VENC_DetachVbPool Chapter 9 Related Audio API Errata
V0.2.1.5	2021/02/02	Chapter 9 Audio API Errata/Additions
V0.2.1.5	2021/03/25	Chapter 9 Audio API Errata
V1.0.1.4	2023/07/18	Update for dual OS

Contents

• 1. Disclaimer
• 2. System Overview
  • 2.1. Function Overview
    • 2.1.1. Objective
    • 2.1.2. Definitions and Abbreviations
  • 2.2. Design Overview
    • 2.2.1. System Architecture
• 3. System Control
  • 3.1. Function Overview
    • 3.1.1. Objective
    • 3.1.2. Definitions and Abbreviations
  • 3.2. Design Overview
    • 3.2.1. Video Memory Block Pool
    • 3.2.2. System Binding
    • 3.2.3. The Working Mode of VI and VPSS
    • 3.2.4. The Working Mode of VPSS
    • 3.2.5. Alignment Requirements For The Video Pipeline
    • 3.2.6. Dual OS Communication
  • 3.3. API Reference
    • 3.3.1. CVI_MSG_Init
    • 3.3.2. CVI_MSG_Deinit
    • 3.3.3. CVI_SYS_Init
    • 3.3.4. CVI_SYS_Exit
    • 3.3.5. CVI_SYS_Bind
    • 3.3.6. CVI_SYS_UnBind
    • 3.3.7. CVI_SYS_GetBindbyDest
    • 3.3.8. CVI_SYS_GetBindbySrc
    • 3.3.9. CVI_SYS_GetVersion
    • 3.3.10. CVI_SYS_GetChipId
    • 3.3.11. CVI_SYS_Mmap
    • 3.3.12. CVI_SYS_MmapCache
    • 3.3.13. CVI_SYS_Munmap
    • 3.3.14. CVI_SYS_IonAlloc
    • 3.3.15. CVI_SYS_IonAlloc_Cached
    • 3.3.16. CVI_SYS_IonFlushCache
    • 3.3.17. CVI_SYS_IonInvalidateCache
    • 3.3.18. CVI_SYS_IonFree
    • 3.3.19. CVI_SYS_SetVIVPSSMode
    • 3.3.20. CVI_SYS_GetVIVPSSMode
    • 3.3.21. CVI_SYS_SetVPSSMode
    • 3.3.22. CVI_SYS_GetVPSSMode
    • 3.3.23. CVI_SYS_GetModName
    • 3.3.24. CVI_VB_SetConfig
    • 3.3.25. CVI_VB_GetConfig
    • 3.3.26. CVI_VB_Init
    • 3.3.27. CVI_VB_Exit
    • 3.3.28. CVI_VB_GetBlock
    • 3.3.29. CVI_VB_ReleaseBlock
    • 3.3.30. CVI_VB_CreatePool
    • 3.3.31. CVI_VB_DestroyPool
    • 3.3.32. CVI_VB_PhysAddr2Handle
    • 3.3.33. CVI_VB_Handle2PhysAddr
    • 3.3.34. CVI_VB_Handle2PoolId
    • 3.3.35. CVI_VB_InquireUserCnt
    • 3.3.36. CVI_VB_MmapPool
    • 3.3.37. CVI_VB_MunmapPool
    • 3.3.38. CVI_VB_GetBlockVirAddr
    • 3.3.39. CVI_LOG_SetLevelConf
    • 3.3.40. CVI_LOG_GetLevelConf
  • 3.4. Data Types
    • 3.4.1. Base Type
    • 3.4.2. MOD_ID_E
    • 3.4.3. VB_SOURCE_E
    • 3.4.4. ROTATION_E
    • 3.4.5. POINT_S
    • 3.4.6. SIZE_S
    • 3.4.7. RECT_S
    • 3.4.8. LDC_ATTR_S
    • 3.4.9. MMF_CHN_S
    • 3.4.10. MMF_BIND_DEST_S
    • 3.4.11. MMF_VERSION_S
    • 3.4.12. VB_CONFIG_S
    • 3.4.13. VB_POOL_CONFIG_S
    • 3.4.14. VI_VPSS_MODE_E
    • 3.4.15. VPSS_MODE_E
    • 3.4.16. ASPECT_RATIO_E
    • 3.4.17. ASPECT_RATIO_S
    • 3.4.18. PIXEL_FORMAT_E
    • 3.4.19. VIDEO_FRAME_S
    • 3.4.20. VIDEO_FRAME_INFO_S
    • 3.4.21. BITMAP_S
  • 3.5. Error Codes
• 4. Video Input
  • 4.1. Function Overview
    • 4.1.1. Objective
    • 4.1.2. Definitions and Abbreviations
  • 4.2. Design Overview
    • 4.2.1. System Architecture
    • 4.2.2. Video Input PIPE
    • 4.2.3. Video Physical Channel
    • 4.2.4. Binding Relationship
  • 4.3. API Reference
    • 4.3.1. CVI_VI_SetDevAttr
    • 4.3.2. CVI_VI_GetDevAttr
    • 4.3.3. CVI_VI_SetDevAttrEx
    • 4.3.4. CVI_VI_GetDevAttrEx
    • 4.3.5. CVI_VI_EnableDev
    • 4.3.6. CVI_VI_DisableDev
    • 4.3.7. CVI_VI_SetDevBindPipe
    • 4.3.8. CVI_VI_GetDevBindPipe
    • 4.3.9. CVI_VI_SetDevTimingAttr
    • 4.3.10. CVI_VI_GetDevTimingAttr
    • 4.3.11. CVI_VI_CreatePipe
    • 4.3.12. CVI_VI_DestroyPipe
    • 4.3.13. CVI_VI_SetPipeAttr
    • 4.3.14. CVI_VI_GetPipeAttr
    • 4.3.15. CVI_VI_StartPipe
    • 4.3.16. CVI_VI_StopPipe
    • 4.3.17. CVI_VI_SetPipeCrop
    • 4.3.18. CVI_VI_GetPipeCrop
    • 4.3.19. CVI_VI_SetPipeDumpAttr
    • 4.3.20. CVI_VI_GetPipeDumpAttr
    • 4.3.21. CVI_VI_SetPipeFrameSource
    • 4.3.22. CVI_VI_GetPipeFrameSource
    • 4.3.23. CVI_VI_GetPipeFrame
    • 4.3.24. CVI_VI_ReleasePipeFrame
    • 4.3.25. CVI_VI_SendPipeRaw
    • 4.3.26. CVI_VI_QueryPipeStatus
    • 4.3.27. CVI_VI_GetPipeFd
    • 4.3.28. CVI_VI_CloseFd
    • 4.3.29. CVI_VI_AttachVbPool
    • 4.3.30. CVI_VI_DetachVbPool
    • 4.3.31. CVI_VI_SetChnAttr
    • 4.3.32. CVI_VI_GetChnAttr
    • 4.3.33. CVI_VI_EnableChn
    • 4.3.34. CVI_VI_DisableChn
    • 4.3.35. CVI_VI_SetChnCrop
    • 4.3.36. CVI_VI_GetChnCrop
    • 4.3.37. CVI_VI_GetChnFrame
    • 4.3.38. CVI_VI_ReleaseChnFrame
    • 4.3.39. CVI_VI_SetChnRotation
    • 4.3.40. CVI_VI_GetChnRotation
    • 4.3.41. CVI_VI_SetChnLDCAttr
    • 4.3.42. CVI_VI_GetChnLDCAttr
    • 4.3.43. CVI_VI_RegChnFlipMirrorCallBack
    • 4.3.44. CVI_VI_UnRegChnFlipMirrorCallBack
    • 4.3.45. CVI_VI_SetChnFlipMirror
    • 4.3.46. CVI_VI_GetChnFlipMirror
    • 4.3.47. CVI_VI_Suspend
    • 4.3.48. CVI_VI_Resume
    • 4.3.49. CVI_VI_SetDevNum
    • 4.3.50. CVI_VI_GetDevNum
    • 4.3.51. CVI_VI_EnablePatt
    • 4.3.52. CVI_VI_StartSmoothRawDump
    • 4.3.53. CVI_VI_StopSmoothRawDump
    • 4.3.54. CVI_VI_GetSmoothRawDump
    • 4.3.55. CVI_VI_PutSmoothRawDump
    • 4.3.56. CVI_VI_GetRgbMapLeBuf
    • 4.3.57. CVI_VI_GetRgbMapSeBuf
    • 4.3.58. CVI_VI_DumpHwRegisterToFile
    • 4.3.59. CVI_VI_QueryChnStatus
    • 4.3.60. CVI_VI_GetChnFd
    • 4.3.61. CVI_VI_SetChnAlign
    • 4.3.62. CVI_VI_GetChnAlign
    • 4.3.63. CVI_VI_RegPmCallBack
    • 4.3.64. CVI_VI_UnRegPmCallBack
    • 4.3.65. CVI_VI_SetTuningDis
  • 4.4. Data Types
    • 4.4.1. VI_MAX_DEV_NUM
    • 4.4.2. VI_MAX_PHY_PIPE_NUM
    • 4.4.3. VI_MAX_VIR_PIPE_NUM
    • 4.4.4. VI_MAX_PIPE_NUM
    • 4.4.5. VI_MAX_PHY_CHN_NUM
    • 4.4.6. VI_MAX_CHN_NUM
    • 4.4.7. VI_DEV_MIN_WIDTH
    • 4.4.8. VI_DEV_MIN_HEIGHT
    • 4.4.9. VI_DEV_MAX_WIDTH
    • 4.4.10. VI_DEV_MAX_HEIGHT
    • 4.4.11. VI_PIPE_OFFLINE_MIN_WIDTH
    • 4.4.12. VI_PIPE_OFFLINE_MIN_HEIGHT
    • 4.4.13. VI_PIPE_OFFLINE_MAX_WIDTH
    • 4.4.14. VI_PIPE_OFFLINE_MAX_HEIGHT
    • 4.4.15. VI_PIPE_ONLINE_MIN_WIDTH
    • 4.4.16. VI_PIPE_ONLINE_MIN_HEIGHT
    • 4.4.17. VI_PIPE_ONLINE_MAX_WIDTH
    • 4.4.18. VI_PIPE_ONLINE_MAX_HEIGHT
    • 4.4.19. VI_PIPE0_MAX_WIDTH
    • 4.4.20. VI_PIPE0_MAX_HEIGHT
    • 4.4.21. VI_PIPE1_MAX_WIDTH
    • 4.4.22. VI_PIPE1_MAX_HEIGHT
    • 4.4.23. VI_PIPE2_MAX_WIDTH
    • 4.4.24. VI_PIPE2_MAX_HEIGHT
    • 4.4.25. VI_PIPE3_MAX_WIDTH
    • 4.4.26. VI_PIPE3_MAX_HEIGHT
    • 4.4.27. VI_PIPE4_MAX_WIDTH
    • 4.4.28. VI_PIPE4_MAX_HEIGHT
    • 4.4.29. VI_DATA_TYPE_E
    • 4.4.30. VI_DEV_ATTR_S
    • 4.4.31. VI_DEV_BIND_PIPE_S
    • 4.4.32. VI_PIPE_ATTR_S
    • 4.4.33. VI_DUMP_TYPE_E
    • 4.4.34. VI_DUMP_ATTR_S
    • 4.4.35. VI_CHN_ATTR_S
    • 4.4.36. VI_CROP_INFO_S
    • 4.4.37. VI_DEV_TIMING_ATTR_S
    • 4.4.38. VI_PIPE_STATUS_S
    • 4.4.39. VI_CHN_STATUS_S
    • 4.4.40. VI_PIPE_FRAME_SOURCE_E
    • 4.4.41. VI_LDC_ATTR_S
    • 4.4.42. ROTATION_E
  • 4.5. Error Codes
• 5. Video Output
  • 5.1. Function overview
    • 5.1.1. Objective
    • 5.1.2. Definitions and Abbreviations
  • 5.2. Design Overview
    • 5.2.1. System Architecture
  • 5.3. API Reference
    • 5.3.1. CVI_VO_Enable
    • 5.3.2. CVI_VO_Disable
    • 5.3.3. CVI_VO_SetPubAttr
    • 5.3.4. CVI_VO_GetPubAttr
    • 5.3.5. CVI_VO_EnableVideoLayer
    • 5.3.6. CVI_VO_DisableVideoLayer
    • 5.3.7. CVI_VO_SetVideoLayerAttr
    • 5.3.8. CVI_VO_GetVideoLayerAttr
    • 5.3.9. CVI_VO_EnableChn
    • 5.3.10. CVI_VO_DisableChn
    • 5.3.11. CVI_VO_SetChnAttr
    • 5.3.12. CVI_VO_GetChnAttr
    • 5.3.13. CVI_VO_ShowChn
    • 5.3.14. CVI_VO_HideChn
    • 5.3.15. CVI_VO_SetChnRotation
    • 5.3.16. CVI_VO_GetChnRotation
    • 5.3.17. CVI_VO_PauseChn
    • 5.3.18. CVI_VO_ResumeChn
    • 5.3.19. CVI_VO_CloseFd
  • 5.4. Data Types
    • 5.4.1. VO_DEV
    • 5.4.2. VO_LAYER
    • 5.4.3. VO_INTF_TYPE
    • 5.4.4. VO_INTF_SYNC_E
    • 5.4.5. VO_SYNC_INFO_S
    • 5.4.6. VO_PUB_ATTR_S
    • 5.4.7. VO_VIDEO_LAYER_ATTR_S
    • 5.4.8. VO_CHN_ATTR_S
  • 5.5. Error Codes
• 6. Video Processing Subsystem
  • 6.1. Function Overview
    • 6.1.1. Objective
    • 6.1.2. Definitions and Abbreviations
  • 6.2. Design Overview
    • 6.2.1. System Architecture
    • 6.2.2. Note
  • 6.3. API Reference
    • 6.3.1. CVI_VPSS_CreateGrp
    • 6.3.2. CVI_VPSS_DestroyGrp
    • 6.3.3. CVI_VPSS_GetGrpAttr
    • 6.3.4. CVI_VPSS_SetGrpAttr
    • 6.3.5. CVI_VPSS_StartGrp
    • 6.3.6. CVI_VPSS_StopGrp
    • 6.3.7. CVI_VPSS_ResetGrp
    • 6.3.8. CVI_VPSS_GetGrpProcAmpCtrl
    • 6.3.9. CVI_VPSS_GetGrpProcAmp
    • 6.3.10. CVI_VPSS_SetGrpProcAmp
    • 6.3.11. CVI_VPSS_SetGrpParamfromBin
    • 6.3.12. CVI_VPSS_GetChnAttr
    • 6.3.13. CVI_VPSS_SetChnAttr
    • 6.3.14. CVI_VPSS_EnableChn
    • 6.3.15. CVI_VPSS_DisableChn
    • 6.3.16. CVI_VPSS_SetGrpCrop
    • 6.3.17. CVI_VPSS_GetGrpCrop
    • 6.3.18. CVI_VPSS_SendFrame
    • 6.3.19. CVI_VPSS_GetChnFrame
    • 6.3.20. CVI_VPSS_SendChnFrame
    • 6.3.21. CVI_VPSS_ReleaseChnFrame
    • 6.3.22. CVI_VPSS_GetGrpFrame
    • 6.3.23. CVI_VPSS_ReleaseGrpFrame
    • 6.3.24. CVI_VPSS_SetChnCrop
    • 6.3.25. CVI_VPSS_GetChnCrop
    • 6.3.26. CVI_VPSS_SetChnRotation
    • 6.3.27. CVI_VPSS_GetChnRotation
    • 6.3.28. CVI_VPSS_SetChnLDCAttr
    • 6.3.29. CVI_VPSS_GetChnLDCAttr
    • 6.3.30. CVI_VPSS_GetChnFd
    • 6.3.31. CVI_VPSS_CloseFd
    • 6.3.32. CVI_VPSS_AttachVbPool
    • 6.3.33. CVI_VPSS_DetachVbPool
    • 6.3.34. CVI_VPSS_SetChnBufWrapAttr
    • 6.3.35. CVI_VPSS_GetChnBufWrapAttr
    • 6.3.36. CVI_VPSS_GetWrapBufferSize
  • 6.4. Data Types
    • 6.4.1. VPSS_MAX_GRP_NUM
    • 6.4.2. VPSS_MAX_CHN_NUM
    • 6.4.3. VPSS_MAX_PHY_CHN_NUM
    • 6.4.4. VPSS_MIN_IMAGE_WIDTH
    • 6.4.5. VPSS_MIN_IMAGE_HEIGHT
    • 6.4.6. VPSS_MAX_IMAGE_WIDTH
    • 6.4.7. VPSS_MAX_IMAGE_HEIGHT
    • 6.4.8. VPSS_MAX_ZOOMIN
    • 6.4.9. VPSS_MAX_ZOOMOUT
    • 6.4.10. VPSS_GRP
    • 6.4.11. VPSS_CHN
    • 6.4.12. VPSS_ROUNDING_E
    • 6.4.13. VPSS_CROP_COORDINATE_E
    • 6.4.14. VPSS_NORMALIZE_S
    • 6.4.15. VPSS_CROP_INFO_S
    • 6.4.16. VPSS_GRP_ATTR_S
    • 6.4.17. VPSS_CHN_ATTR_S
    • 6.4.18. VPSS_MOD_PARAM_S
    • 6.4.19. PROC_AMP_E
    • 6.4.20. PROC_AMP_CTRL_S
    • 6.4.21. VPSS_LDC_ATTR_S
  • 6.5. Error Codes
• 7. Video Encoding
  • 7.1. Function Overview
    • 7.1.1. Objective
    • 7.1.2. Definitions and Abbreviations
  • 7.2. Design Overview
    • 7.2.1. Flowchart of Video Encoding Data
    • 7.2.2. VENC Channels
    • 7.2.3. Rate Control
    • 7.2.4. Fixed QP
    • 7.2.5. CBR
    • 7.2.6. VBR
    • 7.2.7. AVBR
    • 7.2.8. GOP Structure
    • 7.2.9. Advanced Frame Skipping
    • 7.2.10. Cropping Encoding
    • 7.2.11. ROI
    • 7.2.12. Coding Unit (CU) Slice Mode
    • 7.2.13. Multi-Encoder Parallel Encoding
    • 7.2.14. The Encoding Frame Buffer Calculation
  • 7.3. API Reference
    • 7.3.1. CVI_VENC_CreateChn
    • 7.3.2. CVI_VENC_DestroyChn
    • 7.3.3. CVI_VENC_ResetChn
    • 7.3.4. CVI_VENC_StartRecvFrame
    • 7.3.5. CVI_VENC_StopRecvFrame
    • 7.3.6. CVI_VENC_QueryStatus
    • 7.3.7. CVI_VENC_SetChnAttr
    • 7.3.8. CVI_VENC_GetChnAttr
    • 7.3.9. CVI_VENC_GetStream
    • 7.3.10. CVI_VENC_ReleaseStream
    • 7.3.11. CVI_VENC_SendFrame
    • 7.3.12. CVI_VENC_GetFd
    • 7.3.13. CVI_VENC_CloseFd
    • 7.3.14. CVI_VENC_SetJpegParam
    • 7.3.15. CVI_VENC_GetJpegParam
    • 7.3.16. CVI_VENC_SetRcParam
    • 7.3.17. CVI_VENC_GetRcParam
    • 7.3.18. CVI_VENC_SetChnParam
    • 7.3.19. CVI_VENC_GetChnParam
    • 7.3.20. CVI_VENC_RequestIDR
    • 7.3.21. CVI_VENC_SetRoiAttr
    • 7.3.22. CVI_VENC_GetRoiAttr
    • 7.3.23. CVI_VENC_SetRefParam
    • 7.3.24. CVI_VENC_GetRefParam
    • 7.3.25. CVI_VENC_SetFrameLostStrategy
    • 7.3.26. CVI_VENC_GetFrameLostStrategy
    • 7.3.27. CVI_VENC_SetModParam
    • 7.3.28. CVI_VENC_GetModParam
    • 7.3.29. CVI_VENC_AttachVbPool
    • 7.3.30. CVI_VENC_DetachVbPool
    • 7.3.31. CVI_VENC_GetH264Entropy
    • 7.3.32. CVI_VENC_SetH264Entropy
    • 7.3.33. CVI_VENC_InsertUserData
    • 7.3.34. CVI_VENC_GetCuPrediction
    • 7.3.35. CVI_VENC_SetCuPrediction
    • 7.3.36. CVI_VENC_GetH264Trans
    • 7.3.37. CVI_VENC_SetH264Trans
    • 7.3.38. CVI_VENC_SetH265Trans
    • 7.3.39. CVI_VENC_GetH265Trans
  • 7.4. Data Types
    • 7.4.1. VENC_MAX_CHN_NUM
    • 7.4.2. VENC_CHN_PARAM_S
    • 7.4.3. VENC_PACK_S
    • 7.4.4. VENC_STREAM_S
    • 7.4.5. VENC_GOP_ATTR_S
    • 7.4.6. VENC_GOP_NORMALP_S
    • 7.4.7. VENC_GOP_SMARTP_S
    • 7.4.8. VENC_RECV_PIC_PARAM_S
    • 7.4.9. VENC_CHN_ATTR_S
    • 7.4.10. VENC_ATTR_S
    • 7.4.11. VENC_ATTR_H264_S
    • 7.4.12. VENC_ATTR_H265_S
    • 7.4.13. VENC_STREAM_INFO_S
    • 7.4.14. VENC_CHN_STATUS_S
    • 7.4.15. VENC_JPEG_PARAM_S
    • 7.4.16. VENC_RC_ATTR_S
    • 7.4.17. VENC_H264_CBR_S
    • 7.4.18. VENC_H264_VBR_S
    • 7.4.19. VENC_H264_AVBR_S
    • 7.4.20. VENC_H264_FIXQP_S
    • 7.4.21. VENC_H264_QPMAP_S
    • 7.4.22. VENC_MJPEG_FIXQP_S
    • 7.4.23. VENC_MJPEG_CBR_S
    • 7.4.24. VENC_H265_CBR_S
    • 7.4.25. VENC_H265_VBR_S
    • 7.4.26. VENC_H265_AVBR_S
    • 7.4.27. VENC_H265_FIXQP_S
    • 7.4.28. VENC_H265_QPMAP_S
    • 7.4.29. VENC_RC_PARAM_S
    • 7.4.30. VENC_PARAM_H264_CBR_S
    • 7.4.31. VENC_PARAM_H264_VBR_S
    • 7.4.32. VENC_PARAM_H264_AVBR_S
    • 7.4.33. VENC_PARAM_H265_CBR_S
    • 7.4.34. VENC_PARAM_H265_VBR_S
    • 7.4.35. VENC_PARAM_H265_AVBR_S
    • 7.4.36. VENC_PARAM_MOD_S
    • 7.4.37. VENC_MOD_H264E_S
    • 7.4.38. VENC_MOD_H265E_S
    • 7.4.39. VENC_MOD_JPEGE_S
    • 7.4.40. VENC_CHN_POOL_S
    • 7.4.41. VENC_FRAMELOST_S
    • 7.4.42. VENC_H264_ENTROPY_S
    • 7.4.43. VENC_CU_PREDICTION_S
    • 7.4.44. VENC_H264_TRANS_S
    • 7.4.45. VENC_H265_TRANS_S
  • 7.5. Error Codes
• 8. Video Decoding
  • 8.1. Function Overview
    • 8.1.1. Objective
    • 8.1.2. Definitions and Abbreviations
  • 8.2. Design Overview
    • 8.2.1. Bitstream Delievry Method
    • 8.2.2. Image Output Format
    • 8.2.3. Timestamp (PTS) Processing
    • 8.2.4. Decoding Frame Buffer Allocation Mode
  • 8.3. API Reference
    • 8.3.1. CVI_VDEC_CreateChn
    • 8.3.2. CVI_VDEC_DestroyChn
    • 8.3.3. CVI_VDEC_ResetChn
    • 8.3.4. CVI_VDEC_GetChnAttr
    • 8.3.5. CVI_VDEC_SetChnAttr
    • 8.3.6. CVI_VDEC_StartRecvStream
    • 8.3.7. CVI_VDEC_StopRecvStream
    • 8.3.8. CVI_VDEC_QueryStatus
    • 8.3.9. CVI_VDEC_SetChnParam
    • 8.3.10. CVI_VDEC_GetChnParam
    • 8.3.11. CVI_VDEC_SendStream
    • 8.3.12. CVI_VDEC_GetFrame
    • 8.3.13. CVI_VDEC_ReleaseFrame
    • 8.3.14. CVI_VDEC_SetModParam
    • 8.3.15. CVI_VDEC_GetModParam
    • 8.3.16. CVI_VDEC_AttachVbPool
    • 8.3.17. CVI_VDEC_DetachVbPool
  • 8.4. Data Types
    • 8.4.1. VDEC_CHN_ATTR_S
    • 8.4.2. VDEC_ATTR_VIDEO_S
    • 8.4.3. VIDEO_MODE_E
    • 8.4.4. VDEC_CHN_STATUS_S
    • 8.4.5. VDEC_DECODE_ERROR_S
    • 8.4.6. VDEC_CHN_PARAM_S
    • 8.4.7. VDEC_PARAM_VIDEO_S
    • 8.4.8. VDEC_PARAM_PICTURE_S
    • 8.4.9. VIDEO_DEC_MODE_E
    • 8.4.10. VIDEO_OUTPUT_ORDER_E
    • 8.4.11. COMPRESS_MODE_E
    • 8.4.12. H264_PRTCL_PARAM_S
    • 8.4.13. H265_PRTCL_PARAM_S
    • 8.4.14. VDEC_PRTCL_PARAM_S
    • 8.4.15. VDEC_STREAM_S
    • 8.4.16. VDEC_USERDATA_S
    • 8.4.17. VIDEO_DISPLAY_MODE_E
    • 8.4.18. VDEC_PARAM_MOD_S
    • 8.4.19. VDEC_VIDEO_MOD_PARAM_S
    • 8.4.20. VDEC_PICTURE_MOD_PARAM_S
    • 8.4.21. VDEC_CHN_POOL_S
  • 8.5. Error Codes
• 9. Regional Management
  • 9.1. Function Overview
    • 9.1.1. Objective
    • 9.1.2. Definitions and Abbreviations
  • 9.2. Design Overview
    • 9.2.1. System Architecture
    • 9.2.2. Note
  • 9.3. API Reference
    • 9.3.1. CVI_RGN_Create
    • 9.3.2. CVI_RGN_Destroy
    • 9.3.3. CVI_RGN_GetAttr
    • 9.3.4. CVI_RGN_SetAttr
    • 9.3.5. CVI_RGN_SetBitMap
    • 9.3.6. CVI_RGN_AttachToChn
    • 9.3.7. CVI_RGN_DetachFromChn
    • 9.3.8. CVI_RGN_SetDisplayAttr
    • 9.3.9. CVI_RGN_GetDisplayAttr
    • 9.3.10. CVI_RGN_GetCanvasInfo
    • 9.3.11. CVI_RGN_UpdateCanvas
    • 9.3.12. CVI_RGN_SetChnPalette
  • 9.4. Data Types
    • 9.4.1. RGN_TYPE_E
    • 9.4.2. RGN_AREA_TYPE_E
    • 9.4.3. OSD_COMPRESS_MODE_E
    • 9.4.4. OSD_COMPRESS_INFO_S
    • 9.4.5. COVER_CHN_ATTR_S
    • 9.4.6. COVEREX_CHN_ATTR_S
    • 9.4.7. OVERLAY_ATTR_S
    • 9.4.8. OVERLAY_CHN_ATTR_S
    • 9.4.9. OVERLAYEX_ATTR_S
    • 9.4.10. OVERLAYEX_CHN_ATTR_S
    • 9.4.11. RGN_ATTR_U
    • 9.4.12. RGN_CHN_ATTR_U
    • 9.4.13. RGN_ATTR_S
    • 9.4.14. RGN_CHN_ATTR_S
  • 9.5. Error Codes
• 10. Audio Frequency
  • 10.1. Function Overview
    • 10.1.1. Objective
    • 10.1.2. Definitions and Abbreviations
  • 10.2. Design Overview
    • 10.2.1. System Architecture
    • 10.2.2. Audio Input and Output
      • 10.2.2.1. Audio Interface and Audio Input/Output Device
      • 10.2.2.2. Principle of Recording and Playing
      • 10.2.2.3. Audio Interface Timing
      • 10.2.2.4. Resample
      • 10.2.2.5. Voice Quality Enhancement (VQE)
    • 10.2.3. Audio Enoding and Decoding
      • 10.2.3.1. Audio Codec Process
      • 10.2.3.2. Audio Codec Protocol
      • 10.2.3.3. Speech Frame Structure
    • 10.2.4. Built-in Codec
      • 10.2.4.1. Overview
      • 10.2.4.2. ioctl Function
  • 10.3. API Reference
    • 10.3.1. Module Properties API:
      • 10.3.1.1. CVI_AUDIO_INIT
      • 10.3.1.2. CVI_AUDIO_DEINIT
      • 10.3.1.3. CVI_AUDIO_SetModParam
      • 10.3.1.4. CVI_AUD_SYS_Bind
      • 10.3.1.5. CVI_AUDIO_GetModParam
      • 10.3.1.6. CVI_AUDIO_RegisterVQEModule
      • 10.3.1.7. CVI_AENC_RegisterExternalEncoder
      • 10.3.1.8. CVI_AENC_UnRegisterExternalEncoder
      • 10.3.1.9. CVI_ADEC_RegisterExternalDecoder
      • 10.3.1.10. CVI_ADEC_UnRegisterExternalDecoder
    • 10.3.2. Audio Input
      • 10.3.2.1. CVI_AI_SetPubAttr
      • 10.3.2.2. CVI_AI_GetPubAttr
      • 10.3.2.3. CVI_AI_Enable
      • 10.3.2.4. CVI_AI_Disable
      • 10.3.2.5. CVI_AI_EnableChn
      • 10.3.2.6. CVI_AI_DisableChn
      • 10.3.2.7. CVI_AI_GetFrame
      • 10.3.2.8. CVI_AI_ReleaseFrame
      • 10.3.2.9. CVI_AI_SetChnParam
      • 10.3.2.10. CVI_AI_GetChnParam
      • 10.3.2.11. CVI_AI_EnableReSmp
      • 10.3.2.12. CVI_AI_DisableReSmp
      • 10.3.2.13. CVI_AI_ClrPubAttr
      • 10.3.2.14. CVI_AI_SaveFile
      • 10.3.2.15. CVI_AI_QueryFileStatus
      • 10.3.2.16. CVI_AI_EnableAecRefFrame
      • 10.3.2.17. CVI_AI_DisableAecRefFrame
      • 10.3.2.18. CVI_AI_SetVolume
      • 10.3.2.19. CVI_AI_GetVolume
    • 10.3.3. Voice Quality Enhancement API
      • 10.3.3.1. CVI_AI_SetVqeAttr
      • 10.3.3.2. CVI_AI_SetTalkVqeAttr
      • 10.3.3.3. CVI_AI_GetTalkVqeAttr
      • 10.3.3.4. CVI_AI_SetRecordVqeAttr
      • 10.3.3.5. CVI_AI_GetRecordVqeAttr
      • 10.3.3.6. CVI_AI_EnableVqe
      • 10.3.3.7. CVI_AI_DisableVqe
      • 10.3.3.8. CVI_AI_SetTrackMode
      • 10.3.3.9. CVI_AI_GetTrackMode
      • 10.3.3.10. CVI_AO_SetVqeAttr
      • 10.3.3.11. CVI_AO_GetVqeAttr
      • 10.3.3.12. CVI_AO_EnableVqe
      • 10.3.3.13. CVI_VQE_PathSelect
    • 10.3.4. Audio Output
      • 10.3.4.1. CVI_AO_SetPubAttr
      • 10.3.4.2. CVI_AO_GetPubAttr
      • 10.3.4.3. CVI_AO_Enable
      • 10.3.4.4. CVI_AO_Disable
      • 10.3.4.5. CVI_AO_EnableChn
      • 10.3.4.6. CVI_AO_DisableChn
      • 10.3.4.7. CVI_AO_SendFrame
      • 10.3.4.8. CVI_AO_EnableReSmp
      • 10.3.4.9. CVI_AO_DisableReSmp
      • 10.3.4.10. CVI_AO_PauseChn
      • 10.3.4.11. CVI_AO_ResumeChn
      • 10.3.4.12. CVI_AO_ClearChnBuf
      • 10.3.4.13. CVI_AO_QueryChnStat
      • 10.3.4.14. CVI_AO_SetTrackMode
      • 10.3.4.15. CVI_AO_GetTrackMode
      • 10.3.4.16. CVI_AO_SetVolume
      • 10.3.4.17. CVI_AO_GetVolume
      • 10.3.4.18. CVI_AO_SetMute
      • 10.3.4.19. CVI_AO_GetMute
      • 10.3.4.20. CVI_AO_SaveFile
      • 10.3.4.21. CVI_AO_ClrPubAttr
    • 10.3.5. Audio Encoding
      • 10.3.5.1. CVI_AENC_CreateChn
      • 10.3.5.2. CVI_AENC_DestroyChn
      • 10.3.5.3. CVI_AENC_SendFrame
      • 10.3.5.4. CVI_AENC_GetStream
      • 10.3.5.5. CVI_AENC_ReleaseStream
      • 10.3.5.6. CVI_AENC_SaveFile
      • 10.3.5.7. CVI_AENC_QueryFileStatus
      • 10.3.5.8. CVI_AENC_GetStreamBufInfo
      • 10.3.5.9. CVI_AENC_SetMute
      • 10.3.5.10. CVI_AENC_GetMute
    • 10.3.6. Audio Decoding
      • 10.3.6.1. CVI_ADEC_CreateChn
      • 10.3.6.2. CVI_ADEC_DestroyChn
      • 10.3.6.3. CVI_ADEC_SendStream
      • 10.3.6.4. CVI_ADEC_ClearChnBuf
      • 10.3.6.5. CVI_ADEC_GetFrame
      • 10.3.6.6. CVI_ADEC_ReleaseFrame
      • 10.3.6.7. CVI_ADEC_SendEndOfStream
    • 10.3.7. Built-in Codec
      • 10.3.7.1. ACODEC_SOFT_RESET_CTRL
      • 10.3.7.2. ACODEC_SET_INPUT_VOL
      • 10.3.7.3. ACODEC_GET_INPUT_VOL
      • 10.3.7.4. ACODEC_SET_OUTPUT_VOL
      • 10.3.7.5. ACODEC_GET_OUTPUT_VOL
      • 10.3.7.6. ACODEC_SET_GAIN_MICL
      • 10.3.7.7. ACODEC_SET_GAIN_MICR
      • 10.3.7.8. ACODEC_SET_DACL_VOL
      • 10.3.7.9. ACODEC_SET_DACR_VOL
      • 10.3.7.10. ACODEC_SET_ADCL_VOL
      • 10.3.7.11. ACODEC_SET_ADCR_VOL
      • 10.3.7.12. ACODEC_SET_MICL_MUTE
      • 10.3.7.13. ACODEC_SET_MICR_MUTE
      • 10.3.7.14. ACODEC_SET_DACL_MUTE
      • 10.3.7.15. ACODEC_SET_DACR_MUTE
      • 10.3.7.16. ACODEC_GET_GAIN_MICL
      • 10.3.7.17. ACODEC_GET_GAIN_MICR
      • 10.3.7.18. ACODEC_GET_DACL_VOL
      • 10.3.7.19. ACODEC_GET_DACR_VOL
      • 10.3.7.20. ACODEC_GET_ADCL_VOL
      • 10.3.7.21. ACODEC_GET_ADCR_VOL
      • 10.3.7.22. ACODEC_SET_PD_DACL
      • 10.3.7.23. ACODEC_SET_PD_DACR
      • 10.3.7.24. ACODEC_SET_PD_ADCL
      • 10.3.7.25. ACODEC_SET_PD_ADCR
      • 10.3.7.26. ACODEC_SET_PD_LINEINL
      • 10.3.7.27. ACODEC_SET_PD_LINEINR
    • 10.3.8. Resampling
      • 10.3.8.1. CVI_Resampler_Create
      • 10.3.8.2. CVI_Resampler_Process
      • 10.3.8.3. CVI_Resampler_Destroy
      • 10.3.8.4. CVI_Resampler_GetMaxOutputNum
  • 10.4. Data Types
    • 10.4.1. Audio Input / Output
      • 10.4.1.1. AIO_MAX_NUM
      • 10.4.1.2. AI_DEV_MAX_NUM
      • 10.4.1.3. AO_DEV_MAX_NUM
      • 10.4.1.4. AI_MAX_CHN_NUM
      • 10.4.1.5. AO_MAX_CHN_NUM
      • 10.4.1.6. CVI_AUD_MAX_CHANNEL_NUM
      • 10.4.1.7. AI_TALKVQE_MASK_AEC
      • 10.4.1.8. AI_TALKVQE_MASK_AGC
      • 10.4.1.9. AI_TALKVQE_MASK_ANR
      • 10.4.1.10. AI_RECORDVQE_MASK_AGC
      • 10.4.1.11. MAX_AUDIO_FILE_PATH_LEN
      • 10.4.1.12. MAX_AUDIO_FILE_NAME_LEN
      • 10.4.1.13. AUDIO_CLKSEL_E
      • 10.4.1.14. AUDIO_SAMPLE_RATE_E
      • 10.4.1.15. AUDIO_BIT_WIDTH_E
      • 10.4.1.16. AIO_MODE_E
      • 10.4.1.17. AIO_I2STYPE_E
      • 10.4.1.18. AUDIO_SOUND_MODE_E
      • 10.4.1.19. AUDIO_MOD_PARAM_S
      • 10.4.1.20. AIO_ATTR_S
      • 10.4.1.21. AI_CHN_PARAM_S
      • 10.4.1.22. AUDIO_FRAME_S
      • 10.4.1.23. AEC_FRAME_S
      • 10.4.1.24. AUDIO_AGC_CONFIG_S
      • 10.4.1.25. AI_AEC_CONFIG_S
      • 10.4.1.26. AUDIO_ANR_CONFIG_S
      • 10.4.1.27. AUDIO_DELAY_CONFIG_S
      • 10.4.1.28. AO_VQE_CONFIG_S
      • 10.4.1.29. VQE_WORKSTATE_E
      • 10.4.1.30. VQE_RECORD_TYPE
      • 10.4.1.31. AI_TALKVQE_CONFIG_S
      • 10.4.1.32. AI_RECORDVQE_CONFIG_S
      • 10.4.1.33. AUDIO_STREAM_S
      • 10.4.1.34. AO_CHN_STATE_S
      • 10.4.1.35. AUDIO_TRACK_MODE_E
      • 10.4.1.36. AUDIO_FADE_RATE_E
      • 10.4.1.37. AUDIO_FADE_S
      • 10.4.1.38. G726_BPS_E
      • 10.4.1.39. ADPCM_TYPE_E
      • 10.4.1.40. ST_CVI_WAV_HEADER
      • 10.4.1.41. AUDIO_FILE_STATUS_S
      • 10.4.1.42. VQE_MODULE_CONFIG_S
      • 10.4.1.43. AUDIO_VQE_REGISTER_S
    • 10.4.2. Audio Encoding
      • 10.4.2.1. AENC_MAX_CHN_NUM
      • 10.4.2.2. AENC_ATTR_G711_S
      • 10.4.2.3. AENC_ATTR_G726_S
      • 10.4.2.4. AENC_ATTR_ADPCM_S
      • 10.4.2.5. AENC_ATTR_LPCM_S
      • 10.4.2.6. AENC_CHN_ATTR_S
      • 10.4.2.7. AAC_AENC_ENCODER_S
    • 10.4.3. Audio Decoding
      • 10.4.3.1. MAX_AUDIO_FRAME_NUM
      • 10.4.3.2. ADEC_MAX_CHN_NUM
      • 10.4.3.3. ADEC_ATTR_G711_S
      • 10.4.3.4. ADEC_ATTR_G726_S
      • 10.4.3.5. ADEC_ATTR_ADPCM_S
      • 10.4.3.6. ADEC_ATTR_LPCM_S
      • 10.4.3.7. ADEC_MODE_E
      • 10.4.3.8. ADEC_CHN_ATTR_S
      • 10.4.3.9. AUDIO_FRAME_INFO_S
      • 10.4.3.10. ADEC_CHN_STATE_S
      • 10.4.3.11. ADEC_DECODER_S
    • 10.4.4. Built-in Codec
      • 10.4.4.1. ACODEC_VOL_CTRL
  • 10.5. Error Codes
    • 10.5.1. Audio Basic Attribute Error CodeS
    • 10.5.2. Audio Input Error Codes
    • 10.5.3. Audio Output Error Codes
    • 10.5.4. Audio Encoding Error Codes
    • 10.5.5. Audio Decoding Error Codes
  • 10.6. Related Tests
    • 10.6.1. Unit Test
    • 10.6.2. Functional Test
    • 10.6.3. Performance Test
  • 10.7. Sample Code and Board-side Component Preliminary Testing
    • 10.7.1. Description of the Sample Code
    • 10.7.2. Preliminary Testing of the Board-side Component
• 11. Geometric Distortion Correction Subsystem
  • 11.1. Function Overview
  • 11.2. Design Overview
    • 11.2.1. System Architecture
  • 11.3. API Reference
    • 11.3.1. CVI_GDC_BeginJob
    • 11.3.2. CVI_GDC_EndJob
    • 11.3.3. CVI_GDC_CancelJob
    • 11.3.4. CVI_GDC_AddRotationTask
    • 11.3.5. CVI_GDC_GenLDCMesh
    • 11.3.6. CVI_GDC_AddLDCTask
  • 11.4. Data Types
    • 11.4.1. GDC_TASK_ATTR_S
    • 11.4.2. LDC_ATTR_S
    • 11.4.3. GRID_INFO_ATTR_S
  • 11.5. Error Codes
• 12. Proc Debugging Information Explanation
  • 12.1. Function Overview
  • 12.2. Audio Input
  • 12.3. Aduio Output
  • 12.4. VENC
  • 12.5. H265E
  • 12.6. H264E
  • 12.7. JPEGE
  • 12.8. RC
  • 12.9. VDEC
  • 12.10. LOG
  • 12.11. SYS
  • 12.12. VB
  • 12.13. GDC
  • 12.14. REGION
  • 12.15. VI
  • 12.16. VO
  • 12.17. VPSS