Getting Started

Overview

lib_ns is a library which performs Noise Suppression (NS), by estimating the noise and subtracting it from frame. lib_ns library functions make use of functionality provided in lib_xs3_math to perform DSP operations. For more details, refer to NS Overview.

Repository Structure

  • modules/lib_ns - The actual lib_ns library directory within https://github.com/xmos/sw_avona/. Within lib_ns

    • api/ - Headers containing the public API for lib_ns.

    • doc/ - Library documentation source (for non-embedded documentation) and build directory.

    • src/ - Library source code.

Requirements

lib_ns is included as part of the sw_avona github repository and all requirements for cloning and building sw_avona apply. lib_ns is compiled as a static library as part of the overall sw_avona build. It depends on lib_xs3_math.

Getting and Building

This module is part of the parent sw_avona repo clone. It is compiled as a static library as part of sw_avona compilation process.

To include lib_ns in an application as a static library, the generated lib_ns.a can then be linked into the application. Add lib_ns/api to the include directories when building the application.