opus-codec 0.1.2

Safe Rust bindings for the Opus audio codec
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

//! Safe, ergonomic wrappers around libopus for encoding/decoding Opus audio.
#![warn(missing_docs)]
#![warn(clippy::all)]
#![warn(clippy::pedantic)]
#![warn(clippy::cargo)]
#![allow(clippy::cast_possible_wrap)]
#![allow(clippy::cast_possible_truncation)]

// Include the generated bindings
#[allow(warnings)]
#[allow(clippy::all)]
mod bindings {
    include!("bindings.rs");
}

mod alloc;
pub mod constants;
pub mod decoder;
#[cfg(feature = "dred")]
/// Deep Redundancy (DRED) decoder support.
pub mod dred;
pub mod encoder;
pub mod error;
pub mod multistream;
pub mod packet;
pub mod projection;
mod raw;
pub mod repacketizer;
pub mod types;

pub use alloc::AlignedBuffer;
pub use constants::{MAX_FRAME_SAMPLES_48KHZ, MAX_PACKET_DURATION_MS, max_frame_samples_for};
pub use decoder::Decoder;
#[cfg(feature = "dred")]
pub use dred::{DredDecoder, DredState};
pub use encoder::Encoder;
pub use error::{Error, Result};
pub use multistream::{Mapping, MultistreamDecoder, MultistreamEncoder};
pub use packet::{
    packet_bandwidth, packet_channels, packet_frame_count, packet_has_lbrr, packet_parse,
    packet_sample_count, packet_samples_per_frame, soft_clip,
};
pub use projection::{ProjectionDecoder, ProjectionEncoder};
pub use repacketizer::Repacketizer;
pub use types::{
    Application, Bandwidth, Bitrate, Channels, Complexity, ExpertFrameDuration, FrameSize,
    SampleRate, Signal,
};

#[doc(hidden)]
pub use bindings::*;

pub(crate) use raw::RawHandle;

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub(crate) enum Ownership {
    Owned,
    Borrowed,
}

#[inline]
pub(crate) fn opus_ptr_is_aligned(ptr: *const u8) -> bool {
    // libopus aligns internal state to pointer-sized alignment (opus_private.h align()).
    (ptr as usize).is_multiple_of(std::mem::align_of::<usize>())
}

/// Returns the bundled libopus version string of this crate.
#[must_use]
pub fn version() -> &'static str {
    "1.5.2"
}

/// Returns the runtime libopus version string from the linked C library.
#[must_use]
pub fn runtime_version() -> &'static str {
    unsafe {
        let ptr = crate::bindings::opus_get_version_string();
        if ptr.is_null() {
            return "";
        }
        std::ffi::CStr::from_ptr(ptr).to_str().unwrap_or("")
    }
}

/// Returns a human-readable string for a libopus error code (via runtime library).
#[must_use]
pub fn strerror(code: i32) -> &'static str {
    unsafe {
        let ptr = crate::bindings::opus_strerror(code);
        if ptr.is_null() {
            return "";
        }
        std::ffi::CStr::from_ptr(ptr).to_str().unwrap_or("")
    }
}