spafe-rs 0.1.1__tar.gz

spafe_rs-0.1.1/Cargo.lock

@@ -0,0 +1,268 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "autocfg"
+version = "1.5.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f2032f911046de80f0a198e0901378627c33f59ea0ac00e363d481118bd70a53"
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "libc"
+version = "0.2.186"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "68ab91017fe16c622486840e4c83c9a37afeff978bd239b5293d61ece587de66"
+
+[[package]]
+name = "matrixmultiply"
+version = "0.3.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a06de3016e9fae57a36fd14dba131fccf49f74b40b7fbdb472f96e361ec71a08"
+dependencies = [
+ "autocfg",
+ "rawpointer",
+]
+
+[[package]]
+name = "ndarray"
+version = "0.17.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "520080814a7a6b4a6e9070823bb24b4531daac8c4627e08ba5de8c5ef2f2752d"
+dependencies = [
+ "matrixmultiply",
+ "num-complex",
+ "num-integer",
+ "num-traits",
+ "portable-atomic",
+ "portable-atomic-util",
+ "rawpointer",
+]
+
+[[package]]
+name = "num-complex"
+version = "0.4.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "73f88a1307638156682bada9d7604135552957b7818057dcef22705b4d509495"
+dependencies = [
+ "num-traits",
+]
+
+[[package]]
+name = "num-integer"
+version = "0.1.46"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7969661fd2958a5cb096e56c8e1ad0444ac2bbcd0061bd28660485a44879858f"
+dependencies = [
+ "num-traits",
+]
+
+[[package]]
+name = "num-traits"
+version = "0.2.19"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "071dfc062690e90b734c0b2273ce72ad0ffa95f0c74596bc250dcfd960262841"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.21.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
+
+[[package]]
+name = "portable-atomic"
+version = "1.13.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c33a9471896f1c69cecef8d20cbe2f7accd12527ce60845ff44c153bb2a21b49"
+
+[[package]]
+name = "portable-atomic-util"
+version = "0.2.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c2a106d1259c23fac8e543272398ae0e3c0b8d33c88ed73d0cc71b0f1d902618"
+dependencies = [
+ "portable-atomic",
+]
+
+[[package]]
+name = "primal-check"
+version = "0.3.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dc0d895b311e3af9902528fbb8f928688abbd95872819320517cc24ca6b2bd08"
+dependencies = [
+ "num-integer",
+]
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.106"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "pyo3"
+version = "0.29.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cd274650b21d4bfc26a0a47587962c1edb425f69287324355cd040c3ea66071c"
+dependencies = [
+ "libc",
+ "once_cell",
+ "portable-atomic",
+ "pyo3-build-config",
+ "pyo3-ffi",
+ "pyo3-macros",
+]
+
+[[package]]
+name = "pyo3-build-config"
+version = "0.29.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c5e2a7d2f0d013342f295c048ad19237add5154a55b1c5a254c0ec93d4109078"
+dependencies = [
+ "target-lexicon",
+]
+
+[[package]]
+name = "pyo3-ffi"
+version = "0.29.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ca85c467da1bbc8d866eea5deff9cf29ea5f7785054a17da36e65bda9c05845b"
+dependencies = [
+ "libc",
+ "pyo3-build-config",
+]
+
+[[package]]
+name = "pyo3-macros"
+version = "0.29.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9ac53762fd065daa3194dd09337a38bd793a188100fd1a9304c4ab312d901771"
+dependencies = [
+ "proc-macro2",
+ "pyo3-macros-backend",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "pyo3-macros-backend"
+version = "0.29.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4ca3a1557399783172dc5bf39cfca835157732532cba56b71d2292161e53b362"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.45"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "41f2619966050689382d2b44f664f4bc593e129785a36d6ee376ddf37259b924"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "rawpointer"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "60a357793950651c4ed0f3f52338f53b2f809f32d83a07f72909fa13e4c6c1e3"
+
+[[package]]
+name = "rustfft"
+version = "6.4.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "21db5f9893e91f41798c88680037dba611ca6674703c1a18601b01a72c8adb89"
+dependencies = [
+ "num-complex",
+ "num-integer",
+ "num-traits",
+ "primal-check",
+ "strength_reduce",
+ "transpose",
+]
+
+[[package]]
+name = "spafe"
+version = "0.1.1"
+dependencies = [
+ "ndarray",
+ "num-complex",
+ "pyo3",
+ "rustfft",
+ "thiserror",
+]
+
+[[package]]
+name = "strength_reduce"
+version = "0.2.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fe895eb47f22e2ddd4dabc02bce419d2e643c8e3b585c78158b349195bc24d82"
+
+[[package]]
+name = "syn"
+version = "2.0.118"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1b9ae57f904213ebb649ce6895b8a66c66f0203b9319718f69a5612a065b1422"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "target-lexicon"
+version = "0.13.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "adb6935a6f5c20170eeceb1a3835a49e12e19d792f6dd344ccc76a985ca5a6ca"
+
+[[package]]
+name = "thiserror"
+version = "2.0.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4288b5bcbc7920c07a1149a35cf9590a2aa808e0bc1eafaade0b80947865fbc4"
+dependencies = [
+ "thiserror-impl",
+]
+
+[[package]]
+name = "thiserror-impl"
+version = "2.0.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ebc4ee7f67670e9b64d05fa4253e753e016c6c95ff35b89b7941d6b856dec1d5"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "transpose"
+version = "0.2.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1ad61aed86bc3faea4300c7aee358b4c6d0c8d6ccc36524c96e4c92ccf26e77e"
+dependencies = [
+ "num-integer",
+ "strength_reduce",
+]
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.24"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"

spafe_rs-0.1.1/Cargo.toml

@@ -0,0 +1,41 @@
+[package]
+name = "spafe"
+version = "0.1.1"
+edition = "2024"
+description = "Rust port of the spafe audio feature extraction library and jenellefeather/chcochleagram"
+authors = ["Yehor Smoliakov <egorsmkv@gmail.com>"]
+license = "BSD-3-Clause"
+repository = "https://github.com/RustedBytes/spafe"
+homepage = "https://github.com/RustedBytes/spafe"
+documentation = "https://docs.rs/spafe"
+readme = "README.md"
+keywords = ["audio", "speech", "features", "mfcc", "cochleagram"]
+categories = ["multimedia::audio", "science"]
+exclude = [
+    ".github/",
+    ".gitignore",
+    "examples/python/",
+    "notebooks/",
+    "py.typed",
+    "pyproject.toml",
+    "spafe.pyi",
+    "uv.lock",
+]
+
+[lib]
+crate-type = ["rlib", "cdylib"]
+
+[dependencies]
+ndarray = "0.17"
+num-complex = "0.4"
+pyo3 = { version = "0.29", optional = true }
+rustfft = "6"
+thiserror = "2"
+
+[features]
+default = []
+# Enables Rust's portable SIMD API for hot numeric kernels. This currently
+# requires a nightly compiler because `std::simd` is still feature-gated.
+portable-simd = []
+python = ["dep:pyo3"]
+python-extension = ["python", "pyo3/extension-module"]

spafe_rs-0.1.1/LICENSE-CHCOCHLEGRAM

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Jenelle Feather
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

spafe_rs-0.1.1/LICENSE-SPAFE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2019, Ayoub Malek
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

spafe_rs-0.1.1/PKG-INFO

@@ -0,0 +1,162 @@
+Metadata-Version: 2.4
+Name: spafe-rs
+Version: 0.1.1
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
+Classifier: Topic :: Scientific/Engineering
+Requires-Dist: matplotlib>=3.8 ; extra == 'examples'
+Requires-Dist: numpy>=2 ; extra == 'examples'
+Provides-Extra: examples
+License-File: LICENSE-CHCOCHLEGRAM
+License-File: LICENSE-SPAFE
+Summary: Rust port of the spafe audio feature extraction library and jenellefeather/chcochleagram
+Keywords: audio,speech,features,mfcc,cochleagram
+Home-Page: https://github.com/RustedBytes/spafe
+Author-email: Yehor Smoliakov <egorsmkv@gmail.com>
+License-Expression: BSD-3-Clause
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Documentation, https://docs.rs/spafe
+Project-URL: Homepage, https://github.com/RustedBytes/spafe
+Project-URL: Repository, https://github.com/RustedBytes/spafe
+
+# Spafe
+
+Native Rust implementation of the core
+[`spafe`](https://pypi.org/project/spafe/) audio feature extraction APIs and
+[`jenellefeather/chcochleagram`](https://github.com/jenellefeather/chcochleagram)
+cochleagram routines.
+
+The crate provides filter banks, spectrograms, cepstral features, spectral
+descriptors, frequency estimators, cochleagram generation, preprocessing helpers,
+and deterministic SVG visualization helpers.
+
+## Build
+
+```bash
+cargo build
+```
+
+The crate also has an opt-in portable SIMD path for hot numeric kernels. Because
+`std::simd` is still unstable, this feature currently requires nightly Rust:
+
+```bash
+cargo +nightly build --features portable-simd
+```
+
+## Python Bindings
+
+The crate exposes a PyO3 extension module through maturin. The Python package is
+published as `spafe-rs` and imports as `spafe`. Python functions use plain
+Python lists for one-dimensional signals and nested lists for matrices.
+
+Install locally in a virtual environment:
+
+```bash
+python -m pip install maturin
+maturin develop
+```
+
+Build a wheel:
+
+```bash
+python -m pip install build
+python -m build --wheel
+```
+
+Basic Python usage:
+
+```python
+import math
+import spafe
+
+fs = 16_000
+sig = [math.sin(2.0 * math.pi * 440.0 * n / fs) for n in range(fs)]
+opts = spafe.FeatureOptions(fs=fs, nfft=256, nfilts=24)
+
+ceps = spafe.mfcc(sig, opts)
+fbanks, centers = spafe.mel_filter_banks(spafe.FilterBankOptions(nfft=256))
+
+print(len(ceps), len(ceps[0]))
+print(len(fbanks), len(centers))
+```
+
+## Test
+
+```bash
+cargo test --all-targets
+cargo clippy --all-targets -- -D warnings
+RUSTDOCFLAGS="-D warnings -D missing_docs" cargo doc --no-deps
+```
+
+## Examples
+
+Generate a filter-bank SVG:
+
+```bash
+cargo run --example fbanks
+open target/fbanks.svg
+```
+
+Generate a cochleagram SVG:
+
+```bash
+cargo run --example cochleagram
+open target/cochleagram.svg
+```
+
+Python examples live in `examples/python`, use matplotlib, and write outputs to
+`target/python-examples`:
+
+```bash
+python -m pip install matplotlib
+python examples/python/features.py
+python examples/python/fbanks.py
+python examples/python/pitch.py
+python examples/python/cochleagram.py
+```
+
+Interactive notebooks live in `notebooks`:
+
+```bash
+python -m pip install notebook matplotlib numpy
+jupyter notebook notebooks
+```
+
+They cover feature extraction, filter banks, pitch tracking, cochleagrams,
+spectrogram variants, conversion helpers, parameter sensitivity, option tuning,
+performance, and visualization/export/classification recipes.
+The real-audio notebook uses `notebooks/sample_uk.opus` and requires `ffmpeg`.
+
+## Basic Usage
+
+```rust
+use spafe::prelude::*;
+
+fn main() -> spafe::Result<()> {
+    let fs = 16_000;
+    let signal = vec![0.0; fs];
+    let opts = FeatureOptions {
+        fs,
+        ..Default::default()
+    };
+
+    let coeffs = mfcc(&signal, &opts)?;
+    println!("frames={}, coeffs={}", coeffs.nrows(), coeffs.ncols());
+
+    let coch = cochleagram(&signal, &CochleagramOptions {
+        signal_size: signal.len(),
+        sr: fs,
+        env_sr: 400,
+        ..Default::default()
+    })?;
+    println!("filters={}, samples={}", coch.cochleagram.nrows(), coch.cochleagram.ncols());
+    Ok(())
+}
+```
+

spafe_rs-0.1.1/README.md

@@ -0,0 +1,134 @@
+# Spafe
+
+Native Rust implementation of the core
+[`spafe`](https://pypi.org/project/spafe/) audio feature extraction APIs and
+[`jenellefeather/chcochleagram`](https://github.com/jenellefeather/chcochleagram)
+cochleagram routines.
+
+The crate provides filter banks, spectrograms, cepstral features, spectral
+descriptors, frequency estimators, cochleagram generation, preprocessing helpers,
+and deterministic SVG visualization helpers.
+
+## Build
+
+```bash
+cargo build
+```
+
+The crate also has an opt-in portable SIMD path for hot numeric kernels. Because
+`std::simd` is still unstable, this feature currently requires nightly Rust:
+
+```bash
+cargo +nightly build --features portable-simd
+```
+
+## Python Bindings
+
+The crate exposes a PyO3 extension module through maturin. The Python package is
+published as `spafe-rs` and imports as `spafe`. Python functions use plain
+Python lists for one-dimensional signals and nested lists for matrices.
+
+Install locally in a virtual environment:
+
+```bash
+python -m pip install maturin
+maturin develop
+```
+
+Build a wheel:
+
+```bash
+python -m pip install build
+python -m build --wheel
+```
+
+Basic Python usage:
+
+```python
+import math
+import spafe
+
+fs = 16_000
+sig = [math.sin(2.0 * math.pi * 440.0 * n / fs) for n in range(fs)]
+opts = spafe.FeatureOptions(fs=fs, nfft=256, nfilts=24)
+
+ceps = spafe.mfcc(sig, opts)
+fbanks, centers = spafe.mel_filter_banks(spafe.FilterBankOptions(nfft=256))
+
+print(len(ceps), len(ceps[0]))
+print(len(fbanks), len(centers))
+```
+
+## Test
+
+```bash
+cargo test --all-targets
+cargo clippy --all-targets -- -D warnings
+RUSTDOCFLAGS="-D warnings -D missing_docs" cargo doc --no-deps
+```
+
+## Examples
+
+Generate a filter-bank SVG:
+
+```bash
+cargo run --example fbanks
+open target/fbanks.svg
+```
+
+Generate a cochleagram SVG:
+
+```bash
+cargo run --example cochleagram
+open target/cochleagram.svg
+```
+
+Python examples live in `examples/python`, use matplotlib, and write outputs to
+`target/python-examples`:
+
+```bash
+python -m pip install matplotlib
+python examples/python/features.py
+python examples/python/fbanks.py
+python examples/python/pitch.py
+python examples/python/cochleagram.py
+```
+
+Interactive notebooks live in `notebooks`:
+
+```bash
+python -m pip install notebook matplotlib numpy
+jupyter notebook notebooks
+```
+
+They cover feature extraction, filter banks, pitch tracking, cochleagrams,
+spectrogram variants, conversion helpers, parameter sensitivity, option tuning,
+performance, and visualization/export/classification recipes.
+The real-audio notebook uses `notebooks/sample_uk.opus` and requires `ffmpeg`.
+
+## Basic Usage
+
+```rust
+use spafe::prelude::*;
+
+fn main() -> spafe::Result<()> {
+    let fs = 16_000;
+    let signal = vec![0.0; fs];
+    let opts = FeatureOptions {
+        fs,
+        ..Default::default()
+    };
+
+    let coeffs = mfcc(&signal, &opts)?;
+    println!("frames={}, coeffs={}", coeffs.nrows(), coeffs.ncols());
+
+    let coch = cochleagram(&signal, &CochleagramOptions {
+        signal_size: signal.len(),
+        sr: fs,
+        env_sr: 400,
+        ..Default::default()
+    })?;
+    println!("filters={}, samples={}", coch.cochleagram.nrows(), coch.cochleagram.ncols());
+    Ok(())
+}
+```

spafe_rs-0.1.1/py.typed

@@ -0,0 +1 @@
+

spafe_rs-0.1.1/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["maturin>=1.8,<2"]
+build-backend = "maturin"
+
+[project]
+name = "spafe-rs"
+version = "0.1.1"
+description = "Rust port of the spafe audio feature extraction library and jenellefeather/chcochleagram"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "BSD-3-Clause"
+authors = [
+    { name = "Yehor Smoliakov", email = "egorsmkv@gmail.com" },
+]
+keywords = ["audio", "speech", "features", "mfcc", "cochleagram"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: BSD License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Rust",
+    "Topic :: Multimedia :: Sound/Audio :: Analysis",
+    "Topic :: Scientific/Engineering",
+]
+
+[project.urls]
+Homepage = "https://github.com/RustedBytes/spafe"
+Repository = "https://github.com/RustedBytes/spafe"
+Documentation = "https://docs.rs/spafe"
+
+[project.optional-dependencies]
+examples = ["matplotlib>=3.8", "numpy>=2"]
+
+[tool.maturin]
+features = ["python-extension"]
+module-name = "spafe"
+include = ["spafe.pyi", "py.typed"]
+exclude = [
+    ".github/**/*",
+    ".gitignore",
+    "examples/**/*",
+    "notebooks/**/*",
+    "uv.lock",
+]