Spafe

Spafe: Simplified python audio features extraction - Published in JOSS (2023)

https://github.com/superkogito/spafe

Science Score: 93.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 17 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

audio audio-analysis beat dsp features-extraction filterbank frequencies frequency frequency-analysis gammatone-filterbanks mfcc music music-information-retrieval pitch python signal-processing sound speech-processing time-frequency-analysis voice

Keywords from Contributors

annotations mesh

Scientific Fields

Mathematics Computer Science - 84% confidence
Last synced: 4 months ago · JSON representation

Repository

:sound: spafe: Simplified Python Audio Features Extraction

Basic Info
Statistics
  • Stars: 477
  • Watchers: 11
  • Forks: 79
  • Open Issues: 0
  • Releases: 8
Topics
audio audio-analysis beat dsp features-extraction filterbank frequencies frequency frequency-analysis gammatone-filterbanks mfcc music music-information-retrieval pitch python signal-processing sound speech-processing time-frequency-analysis voice
Created over 6 years ago · Last pushed 9 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct

README.md

Spafe

Simplified Python Audio Features Extraction

Build Status docs.rs License Python codecov codebeat badge PyPI version anaconda Downloads DOI DOI

Table of Contents

Structure

spafe aims to simplify feature extractions from mono audio files. Spafe includes various computations related to filter banks, spectrograms, frequencies and cepstral features . The library has the following structure:

Filter banks

- Bark filter banks - Gammatone filter banks - Linear filter banks - Mel filter banks

Spectrograms


- Bark spectrogram - CQT spectrogram - Erb spectrogram - Mel spectrogram

Features

- Bark Frequency Cepstral Coefficients (BFCCs) - Constant Q-transform Cepstral Coefficients (CQCCs) - Gammatone Frequency Cepstral Coefficients (GFCCs) - Linear Frequency Cepstral Coefficients (LFCCs) - Linear Prediction Components (LPCs) - Mel Frequency Cepstral Coefficients (MFCCs) - Inverse Mel Frequency Cepstral Coefficients (IMFCCs) - Magnitude based Spectral Root Cepstral Coefficients (MSRCCs) - Normalized Gammachirp Cepstral Coefficients (NGCCs) - Power-Normalized Cepstral Coefficients (PNCCs) - Phase based Spectral Root Cepstral Coefficients (PSRCCs) - Perceptual Linear Prediction Coefficents (PLPs) - Rasta Perceptual Linear Prediction Coefficents (RPLPs)

The theory behind features computed using spafe can be summmarized in the following graph:

Frequencies

- Dominant frequencies - Fundamental frequencies

Installation

Dependencies

spafe requires:

if you want to use the visualization module/ functions of spafe, you will need to install:

Installation guide

Once you have the Dependencies installed, use one of the following install options.

Install from PyPI

  • To freshly install spafe: pip install spafe
  • To update an existing installation: pip install -U spafe

Install from Anaconda

  • Spafe is also available on anaconda: conda install spafe

Install from source

  • You can build spafe from source, by following: git clone git@github.com:SuperKogito/spafe.git cd spafe python setup.py install

Why use Spafe?

Unlike most existing audio feature extraction libraries (pythonspeechfeatures, SpeechPy, surfboard and Bob), Spafe provides more options for spectral features extraction algorithms, notably: - Bark Frequency Cepstral Coefficients (BFCCs) - Constant Q-transform Cepstral Coefficients (CQCCs) - Gammatone Frequency Cepstral Coefficients (GFCCs) - Power-Normalized Cepstral Coefficients (PNCCs) - Phase based Spectral Root Cepstral Coefficients (PSRCCs)

Most existing libraries and to their credits provide great implementations for features extraction but are unfortunately limited to the Mel Frequency Features (MFCC) and at best have Bark frequency and linear predictive coefficients additionally. Librosa for example includes great implementation of various algorithms (only MFCC and LPC are included), based on the Short Time Fourrier Transform (STFT), which is theoretically more accurate but slower than the Discret Fourrier Transform used in Spafe's implementation.

How to use

Various examples on how to use spafe are present in the documentation https://superkogito.github.io/spafe.

!Please make sure you are referring to the correct documentation version.

Contributing

Contributions are welcome and encouraged. To learn more about how to contribute to spafe please refer to the Contributing guidelines

Citing

  • If you want to cite spafe as a software, please cite the version used as indexed in Zenodo:

Ayoub Malek, Hadrien Titeux, Stefano Borzì, Christian Heider Nielsen, Fabian-Robert Stöter, Hervé Bredin, Eryk Urbański & Kevin Mattheus Moerman. (2023). SuperKogito/spafe: v0.3.3 (v0.3.3). Zenodo. https://doi.org/10.5281/zenodo.11396240

DOI

  • You can also cite spafe's paper as follows:

Malek, A., (2023). Spafe: Simplified python audio features extraction. Journal of Open Source Software, 8(81), 4739, https://doi.org/10.21105/joss.04739

DOI

Owner

  • Name: Ayoub Malek
  • Login: SuperKogito
  • Kind: user
  • Location: Munich
  • Company: @Huawei

MSc. in EE & IT from TUM, ML engineer, programming enthusiast and coffee addict.

JOSS Publication

Spafe: Simplified python audio features extraction
Published
January 27, 2023
Volume 8, Issue 81, Page 4739
Authors
Ayoub Malek ORCID
Yoummday GmbH
Editor
Fabian-Robert Stöter ORCID
Tags
Signal processing time-frequency analysis audio features extraction

GitHub Events

Total
  • Watch event: 24
  • Push event: 2
  • Pull request review event: 2
  • Pull request event: 2
  • Fork event: 1
Last Year
  • Watch event: 24
  • Push event: 2
  • Pull request review event: 2
  • Pull request event: 2
  • Fork event: 1

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 343
  • Total Committers: 12
  • Avg Commits per committer: 28.583
  • Development Distribution Score (DDS): 0.07
Past Year
  • Commits: 3
  • Committers: 2
  • Avg Commits per committer: 1.5
  • Development Distribution Score (DDS): 0.333
Top Committers
Name Email Commits
SuperKogito k****o@h****r 319
hadware h****z@g****m 11
Stefano Borzì s****2@g****m 3
Ayoub a****b@a****x 2
eryk-urbanski e****4@g****m 1
dependabot[bot] 4****] 1
chomoska d****n@g****m 1
Kevin Mattheus Moerman K****n 1
Hervé BREDIN h****n 1
Fabian-Robert Stöter f****t 1
Christian Heider Nielsen 5****r 1
Jan Reimes j****s@h****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 46
  • Total pull requests: 24
  • Average time to close issues: 11 months
  • Average time to close pull requests: 22 days
  • Total issue authors: 28
  • Total pull request authors: 11
  • Average comments per issue: 1.72
  • Average comments per pull request: 0.71
  • Merged pull requests: 22
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 5 days
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • SuperKogito (11)
  • Helias (3)
  • JJun-Guo (3)
  • kabrate (2)
  • ngragaei (2)
  • shakeel608 (2)
  • hadware (2)
  • chmod740 (1)
  • ruaruaruabick (1)
  • rbsingh13 (1)
  • xuke57 (1)
  • weixiu00 (1)
  • www516717402 (1)
  • 0viAB (1)
  • Cybernorse (1)
Pull Request Authors
  • SuperKogito (11)
  • Helias (7)
  • hadware (2)
  • chomoska (2)
  • eryk-urbanski (2)
  • jr2804 (1)
  • dependabot[bot] (1)
  • hbredin (1)
  • Kevin-Mattheus-Moerman (1)
  • cnheider (1)
  • faroit (1)
Top Labels
Issue Labels
bug (12) good first issue (8) question (6) spafe.features (6) spafe.utils (6) enhancement (5) documentation (4) help wanted (4) spafe.frequencies (2)
Pull Request Labels
bug (1) documentation (1) dependencies (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 10,074 last-month
  • Total dependent packages: 1
    (may contain duplicates)
  • Total dependent repositories: 9
    (may contain duplicates)
  • Total versions: 16
  • Total maintainers: 1
pypi.org: spafe

Simplified Python Audio-Features Extraction.

  • Versions: 8
  • Dependent Packages: 1
  • Dependent Repositories: 9
  • Downloads: 10,074 Last month
Rankings
Stargazers count: 3.3%
Dependent repos count: 4.9%
Forks count: 5.2%
Average: 6.2%
Downloads: 7.4%
Dependent packages count: 10.1%
Maintainers (1)
Last synced: 4 months ago
proxy.golang.org: github.com/superkogito/spafe
  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 7.0%
Average: 8.2%
Dependent repos count: 9.3%
Last synced: 4 months ago

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • actions/upload-artifact v1 composite
  • openjournals/openjournals-draft-action master composite
requirements.txt pypi
  • numpy >=1.21
  • scipy >=1.7.3
  • typing_extensions *
setup.py pypi