Hide navigation sidebar
Hide table of contents sidebar
XCORE-VOICE SOLUTION v2.3.1
view PDF:

- XCORE-VOICE Quick Start Guide
  Toggle child pages in navigation
  - Product Description
  - Key Features
  - Obtaining the Hardware
  - Obtaining the Software
  - Example Designs
    Toggle child pages in navigation
    - Far-field Voice Local Command
    - Low Power Far-field Voice Local Command
    - Far-field Voice Assistant
  - Licenses
- XCORE-VOICE Programming Guide
  Toggle child pages in navigation
  - Product Description
  - Key Features
  - Obtaining the Hardware
  - Obtaining the Software
  - Prerequisites
  - Example Designs
    Toggle child pages in navigation
    - Automated Speech Recognition Porting
      Toggle child pages in navigation
      - Overview
      - Supported Hardware
      - Deploying the Firmware with Linux or macOS
      - Deploying the Firmware with Native Windows
      - Modifying the Software
      - ASR API
      - Device Memory API
      - Speech Recognition Ports
    - Far-field Voice Local Command
      Toggle child pages in navigation
      - Overview
      - Supported Hardware
      - Configuring the Firmware
      - Deploying the Firmware with Linux or macOS
      - Deploying the Firmware with Native Windows
      - Modifying the Software
        Toggle child pages in navigation
        - Host Integration
        - Audio Pipeline
        - Software Description
          Toggle child pages in navigation
          - Overview
          - examples/ffd/bsp_config
          - examples/ffd/filesystem_support
          - examples/ffd/src
          - modules/asr/intent_engine
          - modules/asr/intent_handler
        - Software Modifications
        - Speech Recognition - Sensory
        - Speech Recognition - Cyberon
    - Low Power Far-field Voice Local Command
      Toggle child pages in navigation
      - Overview
      - Supported Hardware
      - Configuring the Firmware
      - Deploying the Firmware with Linux or macOS
      - Deploying the Firmware with Native Windows
      - Modifying the Software
        Toggle child pages in navigation
        - Host Integration
        - Audio Pipeline
        - Software Description
          Toggle child pages in navigation
          - Overview
          - bsp_config
          - filesystem_support
          - model
          - src
          - src/gpio_ctrl
          - src/intent_engine
          - src/intent_handler
          - src/power
          - src/wakeword
        - Software Modifications
        - Speech Recognition
    - Far-field Voice Assistant
      Toggle child pages in navigation
      - Overview
      - Supported Hardware
      - Deploying the Firmware with Linux or macOS
      - Deploying the Firmware with Native Windows
      - Modifying the Software
        Toggle child pages in navigation
        - Host Integration
        - Design Architecture
        - Device Firmware update (DFU) Design
        - Audio Pipeline
        - Software Description
          Toggle child pages in navigation
          - Overview
          - examples/ffva/bsp_config
          - examples/ffva/filesystem_support
          - Audio Pipelines
          - examples/ffva/src
        - Software Modifications
    - PDM Microphone Aggregator Example
    - ASRC Application
      Toggle child pages in navigation
      - Overview
      - Software Architecture
      - Resource Usage
  - Memory and CPU Requirements
  - How-Tos
  - Frequently Asked Questions
  - Licenses
- Audio Processing
  Toggle child pages in navigation
  - Acoustic Echo Canceller Library
    Toggle child pages in navigation
    - Repository Structure
    - Requirements
    - API Structure
    - Getting and Building
    - AEC Overview
    - API Reference
      Toggle child pages in navigation
      - AEC Data Structure and Enum Definitions
      - AEC #define constants
      - AEC API
        Toggle child pages in navigation
        - AEC High Level API Functions
        - AEC Low Level API Functions (STILL WIP)
      - lib_aec Header Files
  - Noise Suppression Library
    Toggle child pages in navigation
    - Repository Structure
    - Requirements
    - Getting and Building
    - NS Overview
    - API Reference
      Toggle child pages in navigation
      - NS API Functions
      - NS API Structure Definitions
      - NS Header Files
  - Automatic Gain Control Library
    Toggle child pages in navigation
    - Repository Structure
    - Requirements
    - Getting and Building
    - AGC Overview
    - API Reference
      Toggle child pages in navigation
      - AGC API Functions
      - AGC Pre-Defined Profiles
      - AGC API Structure Definitions
      - AGC Header Files
  - Automatic Delay Estimation and Correction Library
    Toggle child pages in navigation
    - Repository Structure
    - Getting and Building
    - ADEC Overview
    - API Reference
      Toggle child pages in navigation
      - ADEC API Functions
      - ADEC #define constants
      - ADEC Data Structure and Enum definitions
      - ADEC Header Files
  - Interference Canceller Library
    Toggle child pages in navigation
    - Repository Structure
    - Requirements
    - API Structure
    - Getting and Building
    - IC Overview
    - API Reference
      Toggle child pages in navigation
      - lib_ic API Functions
      - lib_ic API State Structure
      - lib_ic API Definitions
      - lib_ic Header Files
  - Voice To Noise Ratio Estimator Library
    Toggle child pages in navigation
    - Repository Structure
    - Requirements
    - API Structure
    - Getting and Building
    - VNR Inference Model
    - VNR Overview
    - API Reference
      Toggle child pages in navigation
      - lib_vnr feature extraction API Functions
      - lib_vnr inference engine API Functions
      - lib_vnr #defines common to feature extraction and inference
      - lib_vnr feature extraction #defines and data structure definitions
      - lib_vnr Header Files
- Build System User Guide
  Toggle child pages in navigation
  - Build System
  - Example CMakeLists.txt
  - Targets
  - Macros
  - Copyright & Disclaimer
  - Licenses
- RTOS Programming Guide
  Toggle child pages in navigation
  - XCORE Platform
  - Tutorials
    Toggle child pages in navigation
    - FreeRTOS Application Programming
    - RTOS Application Design
    - Board Support Configurations
    - RTOS Application DFU
  - API Reference
    Toggle child pages in navigation
    - RTOS Drivers
      Toggle child pages in navigation
      - GPIO RTOS Driver
      - I2C RTOS Driver
        Toggle child pages in navigation
        - I2C Master RTOS Driver
        - I2C Slave RTOS Driver
      - I2S RTOS Driver
        Toggle child pages in navigation
        - I2S Master Initialization API
        - I2S Slave Initialization API
      - Microphone Array RTOS Driver
      - QSPI Flash RTOS Driver
      - SPI RTOS Driver
        Toggle child pages in navigation
        - SPI Master RTOS Driver
        - SPI Slave RTOS Driver
      - UART RTOS Driver
        Toggle child pages in navigation
        - UART Tx RTOS Driver
        - UART Rx RTOS Driver
      - USB RTOS Driver
      - Trace Driver
      - Clock Control RTOS Driver
      - Device Firmware Update RTOS Driver
      - Intertile RTOS Driver
      - L2 Cache RTOS Driver
      - Software Memory RTOS Driver
    - RTOS Services
      Toggle child pages in navigation
      - Device Control
        Toggle child pages in navigation
        - Device Control Shared API
        - Device Control XCORE API
        - Device Control Host API
        - Command Transport Protocol
      - Concurrency Support
        Toggle child pages in navigation
        - Concurrency Support API
      - Generic Pipeline
        Toggle child pages in navigation
        - Generic Pipeline Example
        - Generic Pipeline API
  - FAQs
  - Common Issues
  - Copyright & Disclaimer
  - Licenses
- Peripheral IO Programming Guide
  Toggle child pages in navigation
  - Overview
  - API Reference
    Toggle child pages in navigation
    - UART Library
      Toggle child pages in navigation
      - UART Tx
      - UART Rx
    - I2C Library
      Toggle child pages in navigation
      - I2C Master
      - I2C Slave
      - I2C Registers
    - I2S Library
      Toggle child pages in navigation
      - I2S Common API
      - I2S Master
      - I2S Slave
      - TDM Slave
    - SPI Library
      Toggle child pages in navigation
      - SPI Master
      - SPI Slave
  - Licenses
- lib_mic_array: PDM microphone array library
  Toggle child pages in navigation
  - Introduction
  - Overview
  - Getting Started
  - Decimator Stages
  - Sample Filters
  - Software Structure
  - Mic Array Resource Usage
  - Vanilla API
  - API Reference
    Toggle child pages in navigation
    - C++ API Reference
    - C API Reference
      Toggle child pages in navigation
      - filters_default.h
      - Stage 2 - PCM Decimating FIR Filter
      - pdm_resources.h
      - setup.h
      - frame_transfer.h
      - dc_elimination.h
      - util.h
      - mic_array_vanilla.h
- lib_xcore_math: xcore optimised math
  Toggle child pages in navigation
  - Introduction
  - Getting Started
  - Block Floating-Point background
  - API Reference
    Toggle child pages in navigation
    - XMath Types
    - Block Floating-Point API
      Toggle child pages in navigation
      - BFP API quick reference
      - 16-bit Block Floating-Point API
      - 32-bit Block Floating-Point API
      - Complex 16-bit Block Floating-Point API
      - Complex 32-bit Block Floating-Point API
    - Discrete Cosine Transform API
    - Fast Fourier Transform API
    - Filtering API
    - Scalar API
      Toggle child pages in navigation
      - Scalar API quick reference
      - 16-bit scalar API
      - 32-bit scalar API
      - Scalar IEEE 754 float API
      - 32-bit scalar float API
      - 16-bit complex scalar floating-point API
      - 32-bit complex scalar floating-point API
      - Miscellaneous scalar API
    - Vector API
      Toggle child pages in navigation
      - Vector API quick reference
      - 8-bit vector API
      - 16-bit vector API
      - 32-bit vector API
      - 32-bit IEEE 754 float API
      - Complex 16-bit vector API
      - Complex 32-bit vector API
      - Mixed-precision vector API
      - 16-bit vector prepare functions
      - 32-bit vector prepare functions
      - 16-Bit vomplex vector prepare functions
      - 32-Bit complex vector prepare functions
      - 32-Bit Vector Chunk (8-Element) API
    - Q-format macros
    - Util functions and macros
    - Library Configuration
    - Library Notes
  - Example Applications
  - Unit tests

Back to top
Toggle table of contents sidebar

# API Reference

- NS API Functions
- NS API Structure Definitions
- NS Header Files