Opusic Sys

https://docs.rs/opusic-sys/latest/
Admin
Opusic Sys is a Rust crate providing low-level system bindings for the Opus audio codec, enabling...
Tokens:2,527
Snippets:18
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Opus Repacketizer Output

Source: https://docs.rs/opusic-sys/latest/opusic-sys/0.5.5/opusic_sys/index

Functions to retrieve the repacketized Opus data. Allows getting the entire repacketized packet or a specific range of frames.

```Rust
opus_repacketizer_out⚠
opus_repacketizer_out_range⚠
```

--------------------------------

### Opus Surround Encoder

Source: https://docs.rs/opusic-sys/latest/opusic-sys/0.5.5/opusic_sys/index

Functions for creating and managing Opus surround sound encoders. These are specialized encoders for multi-channel audio setups.

```Rust
opus_multistream_surround_encoder_create⚠
opus_multistream_surround_encoder_get_size⚠
opus_multistream_surround_encoder_init⚠
```

--------------------------------

### Opus Repacketizer Management

Source: https://docs.rs/opusic-sys/latest/opusic-sys/0.5.5/opusic_sys/index

Functions for creating, initializing, controlling, and destroying Opus repacketizers. Repacketizers are used to combine multiple Opus packets into a single larger packet.

```Rust
opus_repacketizer_cat⚠
opus_repacketizer_create⚠
opus_repacketizer_destroy⚠
opus_repacketizer_get_nb_frames⚠
opus_repacketizer_get_size⚠
opus_repacketizer_init⚠
```

--------------------------------

### Opus Encoder Management

Source: https://docs.rs/opusic-sys/latest/opusic-sys/0.5.5/opusic_sys/index

Functions for creating, initializing, controlling, and destroying Opus encoders. These manage the lifecycle of an Opus encoding instance.

```Rust
opus_encoder_create⚠
opus_encoder_ctl⚠
opus_encoder_destroy⚠
opus_encoder_get_size⚠
opus_encoder_init⚠
```

--------------------------------

### Opus Version Information

Source: https://docs.rs/opusic-sys/latest/opusic-sys/0.5.5/opusic_sys/index

Retrieves the version string of the Opus library. This is useful for checking compatibility or logging purposes.

```Rust
opus_get_version_string⚠
```

--------------------------------

### Opus Multistream Packet Handling

Source: https://docs.rs/opusic-sys/latest/opusic-sys/0.5.5/opusic_sys/index

Utilities for padding and unpadding Opus packets, specifically for multistream configurations. These functions help in managing packet integrity and size.

```Rust
opus_multistream_packet_pad⚠
opus_multistream_packet_unpad⚠
```

--------------------------------

### Opus Decoder Management

Source: https://docs.rs/opusic-sys/latest/opusic-sys/0.5.5/opusic_sys/index

Functions for creating, initializing, controlling, and destroying Opus decoders. These are crucial for managing the lifecycle of an Opus decoding instance.

```Rust
opus_decoder_create⚠
opus_decoder_ctl⚠
opus_decoder_destroy⚠
opus_decoder_get_nb_samples⚠
opus_decoder_get_size⚠
opus_decoder_init⚠
```

--------------------------------

### Opus Multistream Encoder Management

Source: https://docs.rs/opusic-sys/latest/opusic-sys/0.5.5/opusic_sys/index

Functions for creating, initializing, controlling, and destroying Opus multistream encoders. These manage the lifecycle of an encoder for multi-channel audio.

```Rust
opus_multistream_encoder_create⚠
opus_multistream_encoder_ctl⚠
opus_multistream_encoder_destroy⚠
opus_multistream_encoder_get_size⚠
opus_multistream_encoder_init⚠
```

--------------------------------

### Opus Decoding Functions

Source: https://docs.rs/opusic-sys/latest/opusic-sys/0.5.5/opusic_sys/index

Provides functions for decoding Opus audio streams. Supports both raw integer and floating-point audio samples. These functions are essential for converting Opus-encoded data back into playable audio.

```Rust
opus_decode⚠
opus_decode_float⚠
```

--------------------------------

### Opus Encoding Functions

Source: https://docs.rs/opusic-sys/latest/opusic-sys/0.5.5/opusic_sys/index

Provides functions for encoding audio data into the Opus format. Supports both raw integer and floating-point audio samples. These are used to compress audio for storage or transmission.

```Rust
opus_encode⚠
opus_encode_float⚠
```

--------------------------------

### Opus Multistream Decoder Management

Source: https://docs.rs/opusic-sys/latest/opusic-sys/0.5.5/opusic_sys/index

Functions for creating, initializing, controlling, and destroying Opus multistream decoders. These manage the lifecycle of a decoder handling multiple audio channels.

```Rust
opus_multistream_decoder_create⚠
opus_multistream_decoder_ctl⚠
opus_multistream_decoder_destroy⚠
opus_multistream_decoder_get_size⚠
opus_multistream_decoder_init⚠
```

--------------------------------

### Opus Multistream Encoding

Source: https://docs.rs/opusic-sys/latest/opusic-sys/0.5.5/opusic_sys/index

Functions for encoding audio data into the Opus multistream format. Supports both raw integer and floating-point audio samples. Used for encoding multi-channel audio efficiently.

```Rust
opus_multistream_encode⚠
opus_multistream_encode_float⚠
```

--------------------------------

### Opus Multistream Decoding

Source: https://docs.rs/opusic-sys/latest/opusic-sys/0.5.5/opusic_sys/index

Functions for decoding Opus audio streams that contain multiple channels or substreams. Supports both raw integer and floating-point audio samples.

```Rust
opus_multistream_decode⚠
opus_multistream_decode_float⚠
```

--------------------------------

### Opus Packet Manipulation

Source: https://docs.rs/opusic-sys/latest/opusic-sys/0.5.5/opusic_sys/index

Utilities for padding, unpadding, and parsing Opus packets. These functions are essential for correctly handling Opus data at the packet level.

```Rust
opus_packet_pad⚠
opus_packet_unpad⚠
opus_packet_parse⚠
```

--------------------------------

### Opus Packet Information Extraction

Source: https://docs.rs/opusic-sys/latest/opusic-sys/0.5.5/opusic_sys/index

Functions to extract metadata from Opus packets, such as bandwidth, number of channels, frames, and samples. Also includes functions to check for LBRR (Low Bandwidth Robust Redundancy).

```Rust
opus_packet_get_bandwidth⚠
opus_packet_get_nb_channels⚠
opus_packet_get_nb_frames⚠
opus_packet_get_nb_samples⚠
opus_packet_get_samples_per_frame⚠
opus_packet_has_lbrr⚠
```

--------------------------------

### Opus DRED (Direct Room Echo Delay) Functions

Source: https://docs.rs/opusic-sys/latest/opusic-sys/0.5.5/opusic_sys/index

Handles DRED functionality for Opus, likely related to echo cancellation or room acoustics. Includes functions for decoding, creating, controlling, and destroying DRED decoders, as well as memory management and processing.

```Rust
opus_decoder_dred_decode⚠
opus_decoder_dred_decode_float⚠
opus_dred_alloc⚠
opus_dred_decoder_create⚠
opus_dred_decoder_ctl⚠
opus_dred_decoder_destroy⚠
opus_dred_decoder_get_size⚠
opus_dred_decoder_init⚠
opus_dred_free⚠
opus_dred_get_size⚠
opus_dred_parse⚠
opus_dred_process⚠
```

--------------------------------

### Opus Error String Conversion

Source: https://docs.rs/opusic-sys/latest/opusic-sys/0.5.5/opusic_sys/index

Converts Opus error codes into human-readable error strings. This is useful for debugging and providing meaningful error messages to users.

```Rust
opus_strerror⚠
```

--------------------------------

### Opus PCM Soft Clipping

Source: https://docs.rs/opusic-sys/latest/opusic-sys/0.5.5/opusic_sys/index

Applies soft clipping to Pulse-Code Modulation (PCM) audio data. This is a technique to prevent audio distortion when signal levels exceed the maximum representable value.

```Rust
opus_pcm_soft_clip⚠
```
Tokens:
Raw