Skip to main content

Boreal

https://img.shields.io/pypi/v/boreal.svg https://img.shields.io/travis/gtzan/boreal.svg Documentation Status https://github.com/gtzan/boreal/blob/main/images/boreal_logo.png

Bokeh Reactive Audio Widget Library

Boreal is a library for creating plots that react to audio while the audio is playing. The reactive audio widgets can be used as part of a stand-alone Bokeh application but the primary goal of the framework is to support the exploratory coding process when using Jupyter notebooks for audio research.

The library is designed to be extensible and supports the addition of new audio reactive widgets as well as audio processors that extract information from the underlying audio signal. Playback controls can be used to play, pause, and seek the underlying audio and associated visuals.

Installation

Building from source

To build boreal from source try:

python setup.py build

Then to install:

python setup.py install

If all went well, you should be able to run the following command in Python:

import boreal

Get started

To see how Boreal works try the following notebook (also part of the package):

https://github.com/gtzan/boreal/blob/main/boreal/audio_widgets_notebook.ipynb

Features

  • Bokeh application for audio reactive plots

  • Example audio widgets: time domain, spectrum, waveform envelope, circularEQ

  • Support for both real-time computation of visuals as well as pre-computation

  • Ability to use html audio for playback on a local machine when notebook is hosted remotely

  • Straighforward to add new audio widgets and audio processors

TODO

Boreal is under development and there is a lot of additinal work planned. Some examples include:

  • More audio widgets

  • Better documentation

  • Support for multi-channel audio

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.1.0 (2022-09-22)

  • First release on PyPI.

Release files for boreal 0.8.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for boreal 0.8.5
File Size Uploaded
boreal-0.8.5.tar.gz 2.4 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for boreal 0.8.5
File Interpreter ABI Platform
boreal-0.8.5-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 4.8 MB

Release files / boreal-0.8.5.tar.gz

Download URL boreal-0.8.5.tar.gz
Size 2.4 MB
Tags Source
SHA-256 checksum
How to use checksums
677fed8227c4d4a18b1ddd2ffce69fc4c6357f7321a577ddec61672fd08b4dec
BLAKE2b-256 checksum
How to use checksums
5f4cbe2c751f96b729b85781794f0660da8f0b26077663c6d915c3fc1419f0ed
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.12

Release files / boreal-0.8.5-py2.py3-none-any.whl

Download URL boreal-0.8.5-py2.py3-none-any.whl
Size 2.4 MB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
f24f7ebf57bda0b8d0dd42da142dd708ad4e35b8080cc62bfbc24aed3ee3a795
BLAKE2b-256 checksum
How to use checksums
39a856b8c63e6ea2088430bf43e0da3c021f035e3b98992998c7f8e31dff9ab4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.12

Release history Release notifications | RSS feed

This release

0.8.5 This release

2 release files

0.8.4

2 release files

0.8.3

2 release files

0.8.2

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page