Skip to main content

scripts accompanying the book An Introduction to Audio Content Analysis by Alexander Lerch

Project description

GitHub top language PyPI - Python Version GitHub release (latest SemVer) GitHub issues CodeFactor GitHub last commit GitHub

pyACA

Python scripts accompanying the book "An Introduction to Audio Content Analysis" (www.AudioContentAnalysis.org). The source code shows example implementations of basic approaches, features, and algorithms for music audio content analysis.

functionality

The top-level functions are (alphabetical):

The names of the additional functions follow the following conventions:

design principles

Please note that the provided code examples are only intended to showcase algorithmic principles – they are not entirely suitable for practical usage without parameter optimization and additional algorithmic tuning. Rather, they intend to show how to implement audio analysis solutions and to facilitate algorithmic understanding to enable the reader to design and implement their own analysis approaches.

minimal dependencies

The required dependencies are reduced to a minimum, more specifically to only numpy and scipy, for the following reasons:

  • accessibility, i.e., clear algorithmic implementation from scratch without obfuscation by using 3rd party implementations,
  • maintainability through independence of 3rd party code. This design choice brings, however, some limitations; for instance, reading of non-RIFF audio files is not supported and the machine learning models are very simple.

readability

Consistent variable naming and formatting, as well as the choice for simple implementations allow for easier parsing. The readability of the source code will sometimes come at the cost of lower performance.

cross-language comparability

All code is matched exactly with Matlab implementations and the equations in the book. This also means that the python code might violate typical python style conventions in order to be consistent.

related repositories and links

The python source code in this repository is matched with corresponding source code in the Matlab repository.

Other, related repositories are

  • ACA-Slides: slide decks for teaching and learning audio content analysis
  • ACA-Plots: Matlab scripts for generating all plots in the book and slides

The main entry point to all book-related information is AudioContentAnalysis.org

getting started

installation

pip install pyACA 

code examples

example 1: computation and plot of the Spectral Centroid

import pyACA
import matplotlib.pyplot as plt 

# file to analyze
cPath = "c:/temp/test.wav"

# extract feature
[v, t] = pyACA.computeFeatureCl(cPath, "SpectralCentroid")

# plot feature output
plt.plot(t,np.squeeze(v))

example 2: Computation of two features (here: Spectral Centroid and Spectral Flux)

import pyACA

# read audio file
cPath = "c:/temp/test.wav"
[f_s, afAudioData] = pyACA.ToolReadAudio(cPath)

# compute feature
[vsc, t] = pyACA.computeFeature("SpectralCentroid", afAudioData, f_s)
[vsf, t] = pyACA.computeFeature("SpectralFlux", afAudioData, f_s)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyACA-0.3.1.tar.gz (103.6 kB view details)

Uploaded Source

Built Distribution

pyACA-0.3.1-py3-none-any.whl (57.1 kB view details)

Uploaded Python 3

File details

Details for the file pyACA-0.3.1.tar.gz.

File metadata

  • Download URL: pyACA-0.3.1.tar.gz
  • Upload date:
  • Size: 103.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for pyACA-0.3.1.tar.gz
Algorithm Hash digest
SHA256 ab4240b274e78dd76aaec3e2741992f3ad7d2e4814096cb1a14236b4005f4840
MD5 b836cace6c7d8b0e4626eda6c905c617
BLAKE2b-256 e7ec59d9c127208221f57f2acd9f859f114c56e369649fe019436f00c9610900

See more details on using hashes here.

File details

Details for the file pyACA-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: pyACA-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 57.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for pyACA-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c94b673cf9ff5c6958c5e37e3dffc638f4ccfbbd5841637ce791eb876c44b9ce
MD5 ba0f6327347a23a72b708c7a6b71a48b
BLAKE2b-256 27ef604e8170f50d7a8f21afbd871010d5ac530bc8c7ad767028cb8fcb2e96a7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page