Decode a frame
decoder Handle of the decoder
in, nbytes Input bitstream, and size in bytes, NULL performs PLC
fmt PCM output format
pcm, stride Output PCM samples, and count between two consecutives
return 0: On success 1: PLC operated -1: Wrong parameters
Encode a frame
encoder Handle of the encoder
fmt PCM input format
pcm, stride Input PCM samples, and count between two consecutives
nbytes Target size, in bytes, of the frame
out Output buffer of nbytes size
return 0: On success -1: Wrong parameters
Return size needed for an decoder
hrmode Enable High-Resolution mode (48000 and 96000 sample rates)
dt_us Frame duration in us, 2500, 5000, 7500 or 10000
sr_hz Sample rate in Hz, 8000, 16000, 24000, 32000, 48000 or 96000
return Size of then decoder in bytes, 0 on bad parameters
Return algorithmic delay, as a number of samples
hrmode Enable High-Resolution mode (48000 and 96000 sample rates)
dt_us Frame duration in us, 2500, 5000, 7500 or 10000
sr_hz Sample rate in Hz, 8000, 16000, 24000, 32000, 48000 or 96000
return Number of algorithmic delay samples, -1 on bad parameters
Return size needed for an encoder
hrmode Enable High-Resolution mode (48000 and 96000 sample rates)
dt_us Frame duration in us, 2500, 5000, 7500 or 10000
sr_hz Sample rate in Hz, 8000, 16000, 24000, 32000, 48000 or 96000
return Size of then encoder in bytes, 0 on bad parameters
Return the size of frames, from bitrate
hrmode Enable High-Resolution mode (48000 and 96000 sample rates)
dt_us Frame duration in us, 2500, 5000, 7500 or 10000
sr_hz Sample rate in Hz, 8000, 16000, 24000, 32000, 48000 or 96000
bitrate Target bitrate in bit per second, 0 or INT_MAX returns
respectively the minimum and maximum allowed size.
return The floor size in bytes of the frames, -1 on bad parameters
Return the number of PCM samples in a frame
hrmode Enable High-Resolution mode (48000 and 96000 sample rates)
dt_us Frame duration in us, 2500, 5000, 7500 or 10000
sr_hz Sample rate in Hz, 8000, 16000, 24000, 32000, 48000 or 96000
return Number of PCM samples, -1 on bad parameters
Resolve the bitrate, from the size of frames
hrmode Enable High-Resolution mode (48000 and 96000 sample rates)
dt_us Frame duration in us, 2500, 5000, 7500 or 10000
sr_hz Sample rate in Hz, 8000, 16000, 24000, 32000, 48000 or 96000
nbytes Size in bytes of the frames, 0 or INT_MAX returns
respectively the minimum and maximum allowed bitrate.
return The according bitrate in bps, -1 on bad parameters
Setup decoder
hrmode Enable High-Resolution mode (48000 and 96000 sample rates)
dt_us Frame duration in us, 2500, 5000, 7500 or 10000
sr_hz Sample rate in Hz, 8000, 16000, 24000, 32000, 48000 or 96000
sr_pcm_hz Output sample rate, upsampling option of output (or 0)
mem Decoder memory space, aligned to pointer type
return Decoder as an handle, NULL on bad parameters
Setup encoder
hrmode Enable High-Resolution mode (48000 and 96000 sample rates)
dt_us Frame duration in us, 2500, 5000, 7500 or 10000
sr_hz Sample rate in Hz, 8000, 16000, 24000, 32000, 48000 or 96000
sr_pcm_hz Input sample rate, downsampling option of input, or 0
mem Encoder memory space, aligned to pointer type
return Encoder as an handle, NULL on bad parameters
PCM Sample Format
S16 Signed 16 bits, in 16 bits words (int16_t)
S24 Signed 24 bits, using low three bytes of 32 bits words (int32_t).
The high byte sign extends (bits 31..24 set to b23).
S24_3LE Signed 24 bits packed in 3 bytes little endian
FLOAT Floating point 32 bits (float type), in range -1 to 1