Koala Noise Suppression
C API
API Reference for the Koala C SDK .
pv_koala_t
Container representing the Koala Noise Suppression engine.
pv_koala_init()
Creates a Koala instance. Resources should be cleaned when you are done using the pv_koala_delete() function.
Parameters
access_key
const char * : AccessKey obtained from Picovoice Console .model_path
const char * : Absolute path to the file containing model parameters (.pv
).object
pv_koala_t * * : Constructed instance of Koala.
Returns
- pv_status_t : Status code.
pv_koala_delete()
Releases resources acquired by Koala.
Parameters
object
pv_koala_t * : Koala object.
pv_koala_process()
Processes a frame of the incoming audio stream and returns a frame of enhanced audio.
The output is not necessarily in sync with the input frame; instead, the output audio will contain the enhancement
result for audio that has been passed to previous calls of this function.
The total delay in samples can be obtained by pv_koala_delay_sample()
.
The number of samples per frame can be attained by calling pv_koala_frame_length()
.
The incoming audio needs to have a sample rate equal to pv_sample_rate()
and be 16-bit
linearly-encoded.
Koala operates on single-channel audio.
Parameters
object
pv_koala_t * : Koala object.pcm
int16_t : A frame of audio samples.enhanced_pcm
int16_t : A frame of enhanced audio samples. Needs to point to an allocated block of memory of the same size as thepcm
input argument.
Returns
- pv_status_t : Status code.
pv_koala_reset()
Finalizes the enhancement process and resets the internal state of the Koala object. Subsequent calls to
pv_koala_process()
will not return any delayed samples from previous calls; that data will be
lost.
Instead, the result will be the same as if the Koala object were newly created.
Parameters
object
pv_koala_t * : Koala object.
Returns
- pv_status_t : Status code.
pv_koala_delay_sample()
Getter for the delay in samples. If the input and output of sequential calls to pv_koala_process
are viewed as
two contiguous streams of audio data, this delay specifies the time shift between the input and output stream.
Parameters
object
pv_koala_t * : Koala object.delay_sample
int32_t * : Delay in samples.
Returns
- pv_status_t : Status code.
pv_koala_frame_length()
Getter for number of audio samples per frame.
Returns
- int32_t : Frame length.
pv_koala_version()
Getter for version.
Returns
- const char * : Koala version.
pv_sample_rate()
Audio sample rate accepted by Koala.
Returns
- int32_t : Sample rate.
pv_status_t
Status code enum.
pv_status_to_string()
Parameters
status
int32_t : Status code.
Returns
- const char * : String representation of status code.