Bat Spoken Language Identification
C Quick Start

Platforms

• Linux (x86_64)
• macOS (x86_64, arm64)
• Windows (x86_64, arm64)
• Raspberry Pi (3, 4, 5)

Requirements

• C99-compatible compiler
• CMake (3.13+)
• For Windows Only: MinGW is required to build the demo

Picovoice Account & AccessKey

Signup or Login to Picovoice Console to get your AccessKey. Make sure to keep your AccessKey secret.

Quick Start

Setup

1. Clone the repository:

git clone --recurse-submodules https://github.com/Picovoice/bat.git

Usage

1. Include the public header files (picovoice.h and pv_bat.h).
2. Link the project to an appropriate precompiled library for the target platform and load it.
3. Select the default model file.
4. Construct the Bat Spoken Language Identification object:

static const char* ACCESS_KEY = "${ACCESS_KEY}";

const char *model_file_path = "${MODEL_FILE_PATH}";
const char *device = "best";
const float voice_threshold = 0.4f;

pv_bat_t *bat;

const pv_status_t status = pv_bat_init(
    ACCESS_KEY
    model_file_path,
    device,
    voice_threshold,
    &bat);

if (status != PV_STATUS_SUCCESS) {
    // error handling logic
}

5. Pass in audio to the pv_bat_process function:

extern const int16_t *get_next_audio_frame(void);

while (true) {
    const int16_t *pcm = get_next_audio_frame();

    float *language_scores = NULL;
    const pv_status_t status = pv_bat_process(bat, pcm, &language_scores);
    if (status != PV_STATUS_SUCCESS) {
        // error handling logic
    }

    if (language_scores != NULL) {
        // do something with language_scores
    }

    pv_bat_scores_delete(language_scores);
}

6. Release resources explicitly when done with Bat Spoken Language Identification:

pv_bat_delete(bat);

Demo

For the Bat Spoken Language Identification C SDK, we offer demo applications that demonstrate how to use the engine on real-time audio streams (i.e. microphone input) and audio files.

Setup

1. Clone the Bat Spoken Language Identification repository from GitHub using HTTPS:

git clone --recurse-submodules https://github.com/Picovoice/bat.git

2. Build the demo:

cd bat
cmake -S demo/c/. -B demo/c/build
cmake --build demo/c/build --target bat_demo_mic

Usage

To see the usage options for the demo:

./demo/c/build/bat_demo_mic

Run the command corresponding to your platform from the root of the repository:

./demo/c/build/bat_demo_mic \
-a ${ACCESS_KEY} \
-m lib/common/bat_params.pv \
-l lib/${PLATFORM}/${ARCH}/libpv_bat.${LIB_EXTENSION} \
-d ${AUDIO_DEVICE_INDEX}

For more information on our Bat Spoken Language Identification demos for C, head over to our GitHub repository.

Resources