Skip to main content

A simple framework for room acoustics and audio processing in Python.

Project description

Pyroomacoustics logo
Documentation Status Test on mybinder Pyroomacoustics discord server

Summary

Pyroomacoustics is a software package aimed at the rapid development and testing of audio array processing algorithms. The content of the package can be divided into three main components:

  1. Intuitive Python object-oriented interface to quickly construct different simulation scenarios involving multiple sound sources and microphones in 2D and 3D rooms;

  2. Fast C++ implementation of the image source model and ray tracing for general polyhedral rooms to efficiently generate room impulse responses and simulate the propagation between sources and receivers;

  3. Reference implementations of popular algorithms for STFT, beamforming, direction finding, adaptive filtering, source separation, and single channel denoising.

Together, these components form a package with the potential to speed up the time to market of new algorithms by significantly reducing the implementation overhead in the performance evaluation step. Please refer to this notebook for a demonstration of the different components of this package.

Room Acoustics Simulation

Consider the following scenario.

Suppose, for example, you wanted to produce a radio crime drama, and it so happens that, according to the scriptwriter, the story line absolutely must culminate in a satanic mass that quickly degenerates into a violent shootout, all taking place right around the altar of the highly reverberant acoustic environment of Oxford’s Christ Church cathedral. To ensure that it sounds authentic, you asked the Dean of Christ Church for permission to record the final scene inside the cathedral, but somehow he fails to be convinced of the artistic merit of your production, and declines to give you permission. But recorded in a conventional studio, the scene sounds flat. So what do you do?

—Schnupp, Nelken, and King, Auditory Neuroscience, 2010

Faced with this difficult situation, pyroomacoustics can save the day by simulating the environment of the Christ Church cathedral!

At the core of the package is a room impulse response (RIR) generator based on the image source model that can handle

  • Convex and non-convex rooms

  • 2D/3D rooms

The core image source model and ray tracing modules are written in C++ for better performance.

The philosophy of the package is to abstract all necessary elements of an experiment using an object-oriented programming approach. Each of these elements is represented using a class and an experiment can be designed by combining these elements just as one would do in a real experiment.

Let’s imagine we want to simulate a delay-and-sum beamformer that uses a linear array with four microphones in a shoe box shaped room that contains only one source of sound. First, we create a room object, to which we add a microphone array object, and a sound source object. Then, the room object has methods to compute the RIR between source and receiver. The beamformer object then extends the microphone array class and has different methods to compute the weights, for example delay-and-sum weights. See the example below to get an idea of what the code looks like.

The Room class also allows one to process sound samples emitted by sources, effectively simulating the propagation of sound between sources and microphones. At the input of the microphones composing the beamformer, an STFT (short time Fourier transform) engine allows to quickly process the signals through the beamformer and evaluate the output.

Reference Implementations

In addition to its core image source model simulation, pyroomacoustics also contains a number of reference implementations of popular audio processing algorithms for

We use an object-oriented approach to abstract the details of specific algorithms, making them easy to compare. Each algorithm can be tuned through optional parameters. We have tried to pre-set values for the tuning parameters so that a run with the default values will in general produce reasonable results.

Datasets

In an effort to simplify the use of datasets, we provide a few wrappers that allow to quickly load and sort through some popular speech corpora. At the moment we support the following.

For more details, see the doc.

Quick Install

Install the package with pip:

pip install pyroomacoustics

A cookiecutter is available that generates a working simulation script for a few 2D/3D scenarios:

# if necessary install cookiecutter
pip install cookiecutter

# create the simulation script
cookiecutter gh:fakufaku/cookiecutter-pyroomacoustics-sim

# run the newly created script
python <chosen_script_name>.py

We have also provided a minimal Dockerfile example in order to install and run the package within a Docker container. Note that you should increase the memory of your containers to 4 GB. Less may also be sufficient, but this is necessary for building the C++ code extension. You can build the container with:

docker build -t pyroom_container .

And enter the container with:

docker run -it pyroom_container:latest /bin/bash

Dependencies

The minimal dependencies are:

numpy
scipy>=0.18.0
Cython
pybind11

where Cython is only needed to benefit from the compiled accelerated simulator. The simulator itself has a pure Python counterpart, so that this requirement could be ignored, but is much slower.

On top of that, some functionalities of the package depend on extra packages:

samplerate   # for resampling signals
matplotlib   # to create graphs and plots
sounddevice  # to play sound samples
mir_eval     # to evaluate performance of source separation in examples

The requirements.txt file lists all packages necessary to run all of the scripts in the examples folder.

This package is mainly developed under Python 3.6. The last supported version for Python 2.7 is 0.4.3.

Under Linux and Mac OS, the compiled accelerators require a valid compiler to be installed, typically this is GCC. When no compiler is present, the package will still install but default to the pure Python implementation which is much slower. On Windows, we provide pre-compiled Python Wheels for Python 3.5 and 3.6.

Example

Here is a quick example of how to create and visualize the response of a beamformer in a room.

import numpy as np
import matplotlib.pyplot as plt
import pyroomacoustics as pra

# Create a 4 by 6 metres shoe box room
room = pra.ShoeBox([4,6])

# Add a source somewhere in the room
room.add_source([2.5, 4.5])

# Create a linear array beamformer with 4 microphones
# with angle 0 degrees and inter mic distance 10 cm
R = pra.linear_2D_array([2, 1.5], 4, 0, 0.1)
room.add_microphone_array(pra.Beamformer(R, room.fs))

# Now compute the delay and sum weights for the beamformer
room.mic_array.rake_delay_and_sum_weights(room.sources[0][:1])

# plot the room and resulting beamformer
room.plot(freq=[1000, 2000, 4000, 8000], img_order=0)
plt.show()

More examples

A couple of detailed demos with illustrations are available.

A comprehensive set of examples covering most of the functionalities of the package can be found in the examples folder of the GitHub repository.

A video introduction to pyroomacoustics.

A video tutorial series on using pyroomacoustics covering many advanced topics.

Authors

  • Robin Scheibler

  • Ivan Dokmanić

  • Sidney Barthe

  • Eric Bezzam

  • Hanjie Pan

How to contribute

If you would like to contribute, please clone the repository and send a pull request.

For more details, see our CONTRIBUTING page.

Academic publications

This package was developed to support academic publications. The package contains implementations for DOA algorithms and acoustic beamformers introduced in the following papers.

  • H. Pan, R. Scheibler, I. Dokmanic, E. Bezzam and M. Vetterli. FRIDA: FRI-based DOA estimation for arbitrary array layout, ICASSP 2017, New Orleans, USA, 2017.

  • I. Dokmanić, R. Scheibler and M. Vetterli. Raking the Cocktail Party, in IEEE Journal of Selected Topics in Signal Processing, vol. 9, num. 5, p. 825 - 836, 2015.

  • R. Scheibler, I. Dokmanić and M. Vetterli. Raking Echoes in the Time Domain, ICASSP 2015, Brisbane, Australia, 2015.

If you use this package in your own research, please cite our paper describing it.

R. Scheibler, E. Bezzam, I. Dokmanić, Pyroomacoustics: A Python package for audio room simulations and array processing algorithms, Proc. IEEE ICASSP, Calgary, CA, 2018.

License

Copyright (c) 2014-2021 EPFL-LCAV

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.

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

pyroomacoustics-0.8.3.tar.gz (35.1 MB view details)

Uploaded Source

Built Distributions

pyroomacoustics-0.8.3-cp312-cp312-win_amd64.whl (34.4 MB view details)

Uploaded CPython 3.12 Windows x86-64

pyroomacoustics-0.8.3-cp312-cp312-macosx_10_13_universal2.whl (34.9 MB view details)

Uploaded CPython 3.12 macOS 10.13+ universal2 (ARM64, x86-64)

pyroomacoustics-0.8.3-cp311-cp311-win_amd64.whl (34.4 MB view details)

Uploaded CPython 3.11 Windows x86-64

pyroomacoustics-0.8.3-cp311-cp311-macosx_10_9_universal2.whl (34.9 MB view details)

Uploaded CPython 3.11 macOS 10.9+ universal2 (ARM64, x86-64)

pyroomacoustics-0.8.3-cp310-cp310-win_amd64.whl (34.4 MB view details)

Uploaded CPython 3.10 Windows x86-64

pyroomacoustics-0.8.3-cp310-cp310-macosx_12_0_x86_64.whl (34.5 MB view details)

Uploaded CPython 3.10 macOS 12.0+ x86-64

pyroomacoustics-0.8.3-cp310-cp310-macosx_10_9_universal2.whl (34.9 MB view details)

Uploaded CPython 3.10 macOS 10.9+ universal2 (ARM64, x86-64)

pyroomacoustics-0.8.3-cp39-cp39-win_amd64.whl (34.4 MB view details)

Uploaded CPython 3.9 Windows x86-64

pyroomacoustics-0.8.3-cp39-cp39-macosx_12_0_x86_64.whl (34.5 MB view details)

Uploaded CPython 3.9 macOS 12.0+ x86-64

pyroomacoustics-0.8.3-cp38-cp38-win_amd64.whl (34.4 MB view details)

Uploaded CPython 3.8 Windows x86-64

pyroomacoustics-0.8.3-cp38-cp38-macosx_12_0_x86_64.whl (34.5 MB view details)

Uploaded CPython 3.8 macOS 12.0+ x86-64

File details

Details for the file pyroomacoustics-0.8.3.tar.gz.

File metadata

  • Download URL: pyroomacoustics-0.8.3.tar.gz
  • Upload date:
  • Size: 35.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.9.20

File hashes

Hashes for pyroomacoustics-0.8.3.tar.gz
Algorithm Hash digest
SHA256 5619bcab3d03ffa4221383cf1ebaa2f078335c08d45601e10864612c8cbbc7d3
MD5 5ae8dfa801e4026eb006aba5bed2ecf8
BLAKE2b-256 76ac03d42807e0b7fb725b870865adc377ee925e31489dcfe3601daf3bf501c1

See more details on using hashes here.

File details

Details for the file pyroomacoustics-0.8.3-cp312-cp312-win_amd64.whl.

File metadata

File hashes

Hashes for pyroomacoustics-0.8.3-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 d70a4f0a6830349584fb68237d885208d9faa8561dc4c91359ee0929e6249970
MD5 6b8724957d7b20f0c357edb126494775
BLAKE2b-256 1af67d3f409f023b117217ade2043963424cbe6309faa56d93164100e41105cd

See more details on using hashes here.

File details

Details for the file pyroomacoustics-0.8.3-cp312-cp312-macosx_10_13_universal2.whl.

File metadata

File hashes

Hashes for pyroomacoustics-0.8.3-cp312-cp312-macosx_10_13_universal2.whl
Algorithm Hash digest
SHA256 0627edade4c0c329c7388c7b34923895052d9a01bfc62df8255940425be8d163
MD5 5d5600c1b12d3ed79e76ec181a1c0dd6
BLAKE2b-256 7a5a74ebe0c84251bbd7342ec7523e67e77f1259873ff9cceca82b07d3af8148

See more details on using hashes here.

File details

Details for the file pyroomacoustics-0.8.3-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for pyroomacoustics-0.8.3-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 ce58356662be13b560e8b6ab7bc68f221a7e3cec513d6a1949083250ff130eaf
MD5 20563b5de34fcecf5ccc11e87761ead0
BLAKE2b-256 fd1329aaea1044f9cba5949383475ddfd1a22b5b61b229b25cd3e1e5f518ff26

See more details on using hashes here.

File details

Details for the file pyroomacoustics-0.8.3-cp311-cp311-macosx_10_9_universal2.whl.

File metadata

File hashes

Hashes for pyroomacoustics-0.8.3-cp311-cp311-macosx_10_9_universal2.whl
Algorithm Hash digest
SHA256 81cbc0c215c3d170023df79855cd0fb0066146fcf323c0c9351b65e3a53aea69
MD5 28f90a5876509a8be785a95f8933cf12
BLAKE2b-256 19feb088e25607d3178dd456320b8bc785e740a982d205fee539dc3b097e90d3

See more details on using hashes here.

File details

Details for the file pyroomacoustics-0.8.3-cp310-cp310-win_amd64.whl.

File metadata

File hashes

Hashes for pyroomacoustics-0.8.3-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 ff5b561af2b79d88e001e85dd6ef5db7a44fee7ea1b7387b945875c2096500d9
MD5 8a07b571d6d16cb00c42c4e862220634
BLAKE2b-256 20ab7325ff4d878c6a9c9def066adb7c37da919605ce6abe74aa98589d9d328b

See more details on using hashes here.

File details

Details for the file pyroomacoustics-0.8.3-cp310-cp310-macosx_12_0_x86_64.whl.

File metadata

File hashes

Hashes for pyroomacoustics-0.8.3-cp310-cp310-macosx_12_0_x86_64.whl
Algorithm Hash digest
SHA256 8fb00326fa9a0cb5ab4e81ee67269de9713511faeffc0568eb479e0357de9607
MD5 d6a1261d1216476c8298647ac28e18ed
BLAKE2b-256 fd76d7c270a3c5d36fa0b711b562b12bb1b8011106e994ef3a833c4b43d9dbcf

See more details on using hashes here.

File details

Details for the file pyroomacoustics-0.8.3-cp310-cp310-macosx_10_9_universal2.whl.

File metadata

File hashes

Hashes for pyroomacoustics-0.8.3-cp310-cp310-macosx_10_9_universal2.whl
Algorithm Hash digest
SHA256 caefad4afd13e2cadbe5336405875db8de45d979de31741be2548732be2074d4
MD5 6c0b96f94b95a86d8ffff98a702f0bde
BLAKE2b-256 d7483532718665f060be2fa1266b5699da312244fe320d8f36b24734f8523483

See more details on using hashes here.

File details

Details for the file pyroomacoustics-0.8.3-cp39-cp39-win_amd64.whl.

File metadata

File hashes

Hashes for pyroomacoustics-0.8.3-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 f1ea6d020f448bab4a709812e45b85eb82da5abbe4598d9d6c62c13c25bb4070
MD5 9f621839715bd02d6c2845f7ae844729
BLAKE2b-256 c3f1d69eb323208f125d8e064acdac48852dbd9cf65e892cfe068583a89d3301

See more details on using hashes here.

File details

Details for the file pyroomacoustics-0.8.3-cp39-cp39-macosx_12_0_x86_64.whl.

File metadata

File hashes

Hashes for pyroomacoustics-0.8.3-cp39-cp39-macosx_12_0_x86_64.whl
Algorithm Hash digest
SHA256 05f907fdadb8831349502df717acabd7795d9717003941735732df257e7a9b59
MD5 300b31e3ae36e0dd122bb34245223cfb
BLAKE2b-256 1b79ca4a9ccefe56496e968f63e5071ddf44c686288ac9b052c766790dea4f36

See more details on using hashes here.

File details

Details for the file pyroomacoustics-0.8.3-cp38-cp38-win_amd64.whl.

File metadata

File hashes

Hashes for pyroomacoustics-0.8.3-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 8cb66d22fcb6b55ec4fd26a3af3d584dcad768b1cd8a21110d11960b20805dcf
MD5 70ca177bbfe5f2cd7cba812d712f9e6c
BLAKE2b-256 4fba3c04c449acd286cf5c980ce05d890977e75b2f809f5b901575e66f6323a1

See more details on using hashes here.

File details

Details for the file pyroomacoustics-0.8.3-cp38-cp38-macosx_12_0_x86_64.whl.

File metadata

File hashes

Hashes for pyroomacoustics-0.8.3-cp38-cp38-macosx_12_0_x86_64.whl
Algorithm Hash digest
SHA256 e9afe6b7f8e06a015a17131dbed265bb389f3deb08758a8415ff8ddd4e4002f5
MD5 2c3b4e7b305b24074636a50c8a31895c
BLAKE2b-256 abfa38a23c7a9e077826ce99bd3a071572dda5cb5e70778b74f7d153f94e7fa9

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 Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page