10. Audio

• 10.1. Function Overview
  • 10.1.1. Purpose
  • 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 Interfaces and Audio Input, Audio OutputDevice
    • 10.2.2.2. Recording and Playback Principles
    • 10.2.2.3. Audio Interface Timing
    • 10.2.2.4. resampling
    • 10.2.2.5. Voice Quality Enhancement (VQE)
  • 10.2.3. Audio Encoding and Decoding
    • 10.2.3.1. Audio Codec Flow
    • 10.2.3.2. Audio Codec Protocols
    • 10.2.3.3. Voice Frame Structure
• 10.3. API Reference
  • 10.3.1. Module Attribute APIs
    • 10.3.1.1. CVI_AUDIO_INIT
    • 10.3.1.2. CVI_AUDIO_DEINIT
    • 10.3.1.3. CVI_AUD_SYS_Bind
    • 10.3.1.4. CVI_AUD_SYS_UnBind
  • 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.2.20. CVI_AI_SetStereoVolume
    • 10.3.2.21. CVI_AI_GetStereoVolume
  • 10.3.3. Voice Quality EnhancementAPI
    • 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_AO_DisableVqe
    • 10.3.3.14. CVI_AI_SetVqeVolume
    • 10.3.3.15. CVI_AI_GetVqeVolume
    • 10.3.3.16. CVI_AI_VqeFunConfig
    • 10.3.3.17. 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_SetStereoVolume
    • 10.3.4.9. CVI_AO_GetStereoVolume
    • 10.3.4.10. CVI_AO_EnableReSmp
    • 10.3.4.11. CVI_AO_DisableReSmp
    • 10.3.4.12. CVI_AO_PauseChn
    • 10.3.4.13. CVI_AO_ResumeChn
    • 10.3.4.14. CVI_AO_ClearChnBuf
    • 10.3.4.15. CVI_AO_QueryChnStat
    • 10.3.4.16. CVI_AO_SetTrackMode
    • 10.3.4.17. CVI_AO_GetTrackMode
    • 10.3.4.18. CVI_AO_SetVolume
    • 10.3.4.19. CVI_AO_GetVolume
    • 10.3.4.20. CVI_AO_SetMute
    • 10.3.4.21. CVI_AO_GetMute
    • 10.3.4.22. CVI_AO_SaveFile
    • 10.3.4.23. 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_GetStreamBufInfo
    • 10.3.5.8. CVI_AENC_SetMute
    • 10.3.5.9. 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. resampling
    • 10.3.7.1. CVI_Resampler_Create
    • 10.3.7.2. CVI_Resampler_Process
    • 10.3.7.3. CVI_Resampler_Destroy
    • 10.3.7.4. CVI_Resampler_GetMaxOutputNum
• 10.4. Data Types
  • 10.4.1. AudioInput/Output
    • 10.4.1.1. AI_DEV_MAX_NUM
    • 10.4.1.2. AO_DEV_MAX_NUM
    • 10.4.1.3. CVI_AUD_MAX_CHANNEL_NUM
    • 10.4.1.4. AI_TALKVQE_MASK_AEC
    • 10.4.1.5. AI_TALKVQE_MASK_AGC
    • 10.4.1.6. AI_TALKVQE_MASK_ANR
    • 10.4.1.7. AI_RECORDVQE_MASK_AGC
    • 10.4.1.8. MAX_AUDIO_FILE_PATH_LEN
    • 10.4.1.9. MAX_AUDIO_FILE_NAME_LEN
    • 10.4.1.10. CVI_MAX_AI_DEVICE_ID_NUM
    • 10.4.1.11. CVI_MAX_AI_CARD_ID_NUM
    • 10.4.1.12. CVI_MAX_AO_DEVICE_ID_NUM
    • 10.4.1.13. CVI_MAX_AO_CARD_ID_NUM
    • 10.4.1.14. CVI_MAX_AUDIO_FRAME_NUM
    • 10.4.1.15. CVI_AUD_MAX_VOICE_POINT_NUM
    • 10.4.1.16. CVI_AUD_MAX_AUDIO_POINT_NUM
    • 10.4.1.17. CVI_MAX_AUDIO_STREAM_LEN
    • 10.4.1.18. MAX_AUDIO_VQE_CUSTOMIZE_NAME
    • 10.4.1.19. AUDIO_CLKSEL_E
    • 10.4.1.20. AUDIO_SAMPLE_RATE_E
    • 10.4.1.21. AUDIO_BIT_WIDTH_E
    • 10.4.1.22. AIO_MODE_E
    • 10.4.1.23. AIO_I2STYPE_E
    • 10.4.1.24. AUDIO_SOUND_MODE_E
    • 10.4.1.25. AUDIO_MOD_PARAM_S
    • 10.4.1.26. AIO_ATTR_S
    • 10.4.1.27. AI_CHN_PARAM_S
    • 10.4.1.28. AUDIO_FRAME_S
    • 10.4.1.29. AEC_FRAME_S
    • 10.4.1.30. AUDIO_AGC_CONFIG_S
    • 10.4.1.31. AI_AEC_CONFIG_S
    • 10.4.1.32. AUDIO_ANR_CONFIG_S
    • 10.4.1.33. AUDIO_DELAY_CONFIG_S
    • 10.4.1.34. VQE_WORKSTATE_E
    • 10.4.1.35. VQE_RECORD_TYPE
    • 10.4.1.36. AI_TALKVQE_CONFIG_S
    • 10.4.1.37. AI_RECORDVQE_CONFIG_S
    • 10.4.1.38. AUDIO_STREAM_S
    • 10.4.1.39. AO_CHN_STATE_S
    • 10.4.1.40. AUDIO_TRACK_MODE_E
    • 10.4.1.41. AUDIO_FADE_RATE_E
    • 10.4.1.42. AUDIO_FADE_S
    • 10.4.1.43. G726_BPS_E
    • 10.4.1.44. ADPCM_TYPE_E
    • 10.4.1.45. AUDIO_SAVE_FILE_INFO_S
    • 10.4.1.46. CVI_HPF_CONFIG_S
    • 10.4.1.47. CVI_EQ_CONFIG_S
    • 10.4.1.48. CVI_DRC_LIMITER_PARAM
    • 10.4.1.49. CVI_DRC_EXPANDER_PARAM
    • 10.4.1.50. CVI_DRC_COMPRESSOR_PARAM
    • 10.4.1.51. AUDIO_SPK_EQ_CONFIG_S
    • 10.4.1.52. AO_VQE_CONFIG_S
    • 10.4.1.53. HPF_FILTER_TYPE
    • 10.4.1.54. AUDIO_SPK_AGC_CONFIG_S
    • 10.4.1.55. AUDIO_FILE_STATUS_S
    • 10.4.1.56. VQE_MODULE_CONFIG_S
    • 10.4.1.57. 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_DECODER_S
• 10.5. Error Codes
  • 10.5.1. Basic Audio Attribute Error Codes
  • 10.5.2. Audio inputError Codes
  • 10.5.3. Audio outputError Codes
  • 10.5.4. Audio encodingError Codes
  • 10.5.5. Audio decodingError Codes
• 10.6. Related Tests
  • 10.6.1. Unit Testing
  • 10.6.2. FunctionTest
  • 10.6.3. Performance Testing
• 10.7. Sample Code and Preliminary Board-side Testing
  • 10.7.1. Sample Code Description
  • 10.7.2. Preliminary Board-side Testing