CELT
0.8.1
|
Functions | |
EXPORT CELTMode * | celt_mode_create (celt_int32 Fs, int frame_size, int *error) |
EXPORT void | celt_mode_destroy (CELTMode *mode) |
EXPORT int | celt_mode_info (const CELTMode *mode, int request, celt_int32 *value) |
EXPORT CELTEncoder * | celt_encoder_create (const CELTMode *mode, int channels, int *error) |
EXPORT void | celt_encoder_destroy (CELTEncoder *st) |
EXPORT int | celt_encode_resynthesis_float (CELTEncoder *st, const float *pcm, float *optional_resynthesis, int frame_size, unsigned char *compressed, int nbCompressedBytes) |
EXPORT int | celt_encode_float (CELTEncoder *st, const float *pcm, int frame_size, unsigned char *compressed, int nbCompressedBytes) |
EXPORT int | celt_encode_resynthesis (CELTEncoder *st, const celt_int16 *pcm, celt_int16 *optional_resynthesis, int frame_size, unsigned char *compressed, int nbCompressedBytes) |
EXPORT int | celt_encode (CELTEncoder *st, const celt_int16 *pcm, int frame_size, unsigned char *compressed, int nbCompressedBytes) |
EXPORT int | celt_encoder_ctl (CELTEncoder *st, int request,...) |
EXPORT CELTDecoder * | celt_decoder_create (const CELTMode *mode, int channels, int *error) |
EXPORT void | celt_decoder_destroy (CELTDecoder *st) |
EXPORT int | celt_decode_float (CELTDecoder *st, const unsigned char *data, int len, float *pcm, int frame_size) |
EXPORT int | celt_decode (CELTDecoder *st, const unsigned char *data, int len, celt_int16 *pcm, int frame_size) |
EXPORT int | celt_decoder_ctl (CELTDecoder *st, int request,...) |
EXPORT const char * | celt_strerror (int error) |
EXPORT int celt_decode | ( | CELTDecoder * | st, |
const unsigned char * | data, | ||
int | len, | ||
celt_int16 * | pcm, | ||
int | frame_size | ||
) |
Decodes a frame of audio.
st | Decoder state |
data | Compressed data produced by an encoder |
len | Number of bytes to read from "data". This MUST be exactly the number of bytes returned by the encoder. Using a larger value WILL NOT WORK. |
pcm | One frame (frame_size samples per channel) of decoded PCM will be returned here in 16-bit PCM format (native endian). |
EXPORT int celt_decode_float | ( | CELTDecoder * | st, |
const unsigned char * | data, | ||
int | len, | ||
float * | pcm, | ||
int | frame_size | ||
) |
Decodes a frame of audio.
st | Decoder state |
data | Compressed data produced by an encoder |
len | Number of bytes to read from "data". This MUST be exactly the number of bytes returned by the encoder. Using a larger value WILL NOT WORK. |
pcm | One frame (frame_size samples per channel) of decoded PCM will be returned here in float format. |
EXPORT CELTDecoder* celt_decoder_create | ( | const CELTMode * | mode, |
int | channels, | ||
int * | error | ||
) |
Creates a new decoder state. Each stream needs its own decoder state (can't be shared across simultaneous streams).
mode | Contains all the information about the characteristics of the stream (must be the same characteristics as used for the encoder) |
channels | Number of channels |
error | Returns an error code |
EXPORT int celt_decoder_ctl | ( | CELTDecoder * | st, |
int | request, | ||
... | |||
) |
Query and set decoder parameters
st | Decoder state |
request | Parameter to change or query |
value | Pointer to a 32-bit int value |
EXPORT void celt_decoder_destroy | ( | CELTDecoder * | st | ) |
Destroys a a decoder state.
st | Decoder state to be destroyed |
EXPORT int celt_encode | ( | CELTEncoder * | st, |
const celt_int16 * | pcm, | ||
int | frame_size, | ||
unsigned char * | compressed, | ||
int | nbCompressedBytes | ||
) |
Encodes a frame of audio.
st | Encoder state |
pcm | PCM audio in signed 16-bit format (native endian). There must be exactly frame_size samples per channel. |
compressed | The compressed data is written here. This may not alias pcm or optional_synthesis. |
nbCompressedBytes | Maximum number of bytes to use for compressing the frame (can change from one frame to another) |
EXPORT int celt_encode_float | ( | CELTEncoder * | st, |
const float * | pcm, | ||
int | frame_size, | ||
unsigned char * | compressed, | ||
int | nbCompressedBytes | ||
) |
Encodes a frame of audio.
st | Encoder state |
pcm | PCM audio in float format, with a normal range of ±1.0. Samples with a range beyond ±1.0 are supported but will be clipped by decoders using the integer API and should only be used if it is known that the far end supports extended dynmaic range. There must be exactly frame_size samples per channel. |
compressed | The compressed data is written here. This may not alias pcm or optional_synthesis. |
nbCompressedBytes | Maximum number of bytes to use for compressing the frame (can change from one frame to another) |
EXPORT int celt_encode_resynthesis | ( | CELTEncoder * | st, |
const celt_int16 * | pcm, | ||
celt_int16 * | optional_resynthesis, | ||
int | frame_size, | ||
unsigned char * | compressed, | ||
int | nbCompressedBytes | ||
) |
Encodes a frame of audio.
st | Encoder state |
pcm | PCM audio in signed 16-bit format (native endian). There must be exactly frame_size samples per channel. |
optional_resynthesis | If not NULL, the encoder copies the audio signal that the decoder would decode. It is the same as calling the decoder on the compressed data, just faster. This may alias pcm. |
compressed | The compressed data is written here. This may not alias pcm or optional_synthesis. |
nbCompressedBytes | Maximum number of bytes to use for compressing the frame (can change from one frame to another) |
EXPORT int celt_encode_resynthesis_float | ( | CELTEncoder * | st, |
const float * | pcm, | ||
float * | optional_resynthesis, | ||
int | frame_size, | ||
unsigned char * | compressed, | ||
int | nbCompressedBytes | ||
) |
Encodes a frame of audio.
st | Encoder state |
pcm | PCM audio in float format, with a normal range of ±1.0. Samples with a range beyond ±1.0 are supported but will be clipped by decoders using the integer API and should only be used if it is known that the far end supports extended dynmaic range. There must be exactly frame_size samples per channel. |
optional_resynthesis | If not NULL, the encoder copies the audio signal that the decoder would decode. It is the same as calling the decoder on the compressed data, just faster. This may alias pcm. |
compressed | The compressed data is written here. This may not alias pcm or optional_synthesis. |
nbCompressedBytes | Maximum number of bytes to use for compressing the frame (can change from one frame to another) |
EXPORT CELTEncoder* celt_encoder_create | ( | const CELTMode * | mode, |
int | channels, | ||
int * | error | ||
) |
Creates a new encoder state. Each stream needs its own encoder state (can't be shared across simultaneous streams).
mode | Contains all the information about the characteristics of the stream (must be the same characteristics as used for the decoder) |
channels | Number of channels |
error | Returns an error code |
EXPORT int celt_encoder_ctl | ( | CELTEncoder * | st, |
int | request, | ||
... | |||
) |
Query and set encoder parameters
st | Encoder state |
request | Parameter to change or query |
value | Pointer to a 32-bit int value |
EXPORT void celt_encoder_destroy | ( | CELTEncoder * | st | ) |
Destroys a an encoder state.
st | Encoder state to be destroyed |
EXPORT CELTMode* celt_mode_create | ( | celt_int32 | Fs, |
int | frame_size, | ||
int * | error | ||
) |
Creates a new mode struct. This will be passed to an encoder or decoder. The mode MUST NOT BE DESTROYED until the encoders and decoders that use it are destroyed as well.
Fs | Sampling rate (32000 to 96000 Hz) |
frame_size | Number of samples (per channel) to encode in each packet (even values; 64 - 512) |
error | Returned error code (if NULL, no error will be returned) |
EXPORT void celt_mode_destroy | ( | CELTMode * | mode | ) |
Destroys a mode struct. Only call this after all encoders and decoders using this mode are destroyed as well.
mode | Mode to be destroyed |
EXPORT int celt_mode_info | ( | const CELTMode * | mode, |
int | request, | ||
celt_int32 * | value | ||
) |
Query information from a mode
EXPORT const char* celt_strerror | ( | int | error | ) |
Returns the English string that corresponds to an error code
error | Error code (negative for an error, 0 for success |