ruopus 0.1.2

A pure-Rust implementation of the Opus audio codec (RFC 6716). No FFI; unsafe confined to documented SIMD kernels.
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

//! Python bindings for `ruopus`, built with [PyO3].
//!
//! Compiled only under the `python` feature (a plain `cargo build`/`cargo test`
//! stays zero-dependency and pure Rust); `maturin build` links it into the
//! `ruopus` extension module. Every item is declared so PyO3's
//! `experimental-inspect` pass can emit a complete, docstring-carrying `.pyi`.
//!
//! [PyO3]: https://pyo3.rs

use pyo3::prelude::*;

mod decoder;
mod encoder;
mod enums;
mod errors;
mod lowlevel;
mod multistream;
mod numpy_io;
mod ogg;
mod packet;

/// Returns the `ruopus` crate version (the Rust ``CARGO_PKG_VERSION``).
///
/// Examples
/// --------
/// >>> import ruopus
/// >>> ruopus.version()
/// '0.1.0'
#[pyfunction]
#[must_use]
pub fn version() -> &'static str {
    env!("CARGO_PKG_VERSION")
}

/// A pure-Rust implementation of the Opus audio codec (RFC 6716).
///
/// The Python API mirrors the crate's Rust public interface: a stateful
/// :class:`OpusDecoder`, the packet enums (:class:`Mode`, :class:`Bandwidth`,
/// :class:`FrameSize`), and an exception hierarchy rooted at
/// :class:`OpusError`. PCM crosses the boundary as NumPy ``float32``/``int16``
/// arrays shaped ``(frames, channels)``, moved (not copied) out of Rust.
///
/// Compiled as the private extension ``ruopus._ruopus``; the public
/// ``ruopus`` package (``python/ruopus/__init__.py``) re-exports everything
/// from here, so this name is never imported directly by users.
#[pymodule(name = "_ruopus")]
mod ruopus {
    #[pymodule_export]
    use super::decoder::OpusDecoder;
    #[pymodule_export]
    use super::encoder::OpusEncoder;
    #[pymodule_export]
    use super::enums::{Application, Bandwidth, FrameSize, Mode, Signal};
    #[pymodule_export]
    use super::errors::{EncodeError, OggError, OpusError, PacketError};
    // The `lowlevel` submodule (declared as a sibling pymodule below, the form
    // PyO3's declarative macros and introspection support).
    #[pymodule_export]
    use super::lowlevel_module;
    #[pymodule_export]
    use super::multistream::MultistreamDecoder;
    #[pymodule_export]
    use super::ogg::{OpusHead, decode_ogg_opus, encode_ogg_opus};
    #[pymodule_export]
    use super::packet::{Packet, Toc};
    #[pymodule_export]
    use super::version;
}

/// Direct access to the SILK, LPC, and CELT layers beneath the Opus packet
/// codec. Advanced building blocks; ordinary use should prefer the top-level
/// :class:`OpusEncoder` / :class:`OpusDecoder`.
#[pymodule(name = "lowlevel")]
mod lowlevel_module {
    #[pymodule_export]
    use super::lowlevel::celt::{CeltDecoder, CeltEncoder};
    #[pymodule_export]
    use super::lowlevel::lpc::{
        LpcCoefficients, compute_autocorrelation, estimate_pitch, levinson_durbin, lpc_analysis, lpc_residual,
        lpc_residual_stateful, lpc_synthesis, lpc_synthesis_stateful, ltp_residual, ltp_synthesis,
    };
    #[pymodule_export]
    use super::lowlevel::silk::{DecControl, SilkDecoder, SilkEncoder, SilkStereoEncoder};
}