Getting Started

• Download the Audio Effects Microservice Reference Client in the following way:

  1. Select CLI Command to copy the download command.

  2. Ensure you have installed the NGC CLI tool.

  3. After you install the tool, to start the download, paste the copied command in a Command Prompt window.

Prerequisites

Ensure the following prerequisites are available:

• This client uses bazel for build. Please ensure you install bazel before building the client. Instructions for installing bazel can be found here. Note: This code build is validated with bazel version 4.2.2. Please use sudo apt-get update && sudo apt-get install bazel=4.2.2 at step:3 of this section.

• Audio Effects Microservice deployed with sample-rate=16kHz, chunk-duration=10ms, denoiser and dereverb audio effects must be accessible to client host system.

About Audio Effects Microservice Reference Client

• This is sample client for Audio Effects Microservice. src/audio_effects_sample_client.cpp contains the code for this reference application. It provides below features:

  • Accepts .raw 16kHz 32-bit float input audio.

    • Audacity (software) can be used to export any audio as uncompressed RAW 32-bit float.

  • Invokes Audio Effects Microservice gRPC bi-directional RPC to run "Background Noise Removal" and "Room Echo Cancellation" audio-effects. It sends configuration packet over gRPC channel and uses same gRPC channel for data streaming.

  • Stores processed output as .raw 16kHz 32-bit float audio. You can use Audacity to import output file and check impact of audio effects.

Build and launch sample client

Build:

On downloading the resource, a directory is created containing the components of the resource. cd into this directory and then build the client as follows

    bazel build src:audio_effects_sample_client

Launch:

    ./bazel-bin/src/audio_effects_sample_client \
    --audio_effects_service_uri="127.0.0.1:50051" \
    --input_audio_file=samples/16k/1min_noisy_Echo_16k.raw \
    --output_audio_file=audio_effects_output.raw

parameters:

• --audio_effects_service_uri: URI of deployed Audio Effects Microservice. Service needs to be deployed with sample-rate=16kHz, chunk-duration=10ms, denoiser and dereverb audio effects.
• --input_audio_file: Input audio file with .raw 16kHz 32-bit float audio. You can use Audacity to export any audio as uncompressed RAW 32-bit float.
• --output_audio_file: The .raw file where 16kHz 32-bit float output audio to be stored. You can use Audacity to import output file and check impact of audio effects.

Suggested Reading

Please refer Audio Effects User Guide (Under Resources) for a more detailed documentation.

License

By pulling and using Audio Effects software, you accept the terms and conditions of the corresponding license.