Skip to main content

Bokeh Reactive Audio Library

Project description

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.

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

boreal-0.8.5.tar.gz (2.4 MB view details)

Uploaded Source

Built Distribution

boreal-0.8.5-py2.py3-none-any.whl (2.4 MB view details)

Uploaded Python 2 Python 3

File details

Details for the file boreal-0.8.5.tar.gz.

File metadata

  • Download URL: boreal-0.8.5.tar.gz
  • Upload date:
  • Size: 2.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for boreal-0.8.5.tar.gz
Algorithm Hash digest
SHA256 677fed8227c4d4a18b1ddd2ffce69fc4c6357f7321a577ddec61672fd08b4dec
MD5 1db98aae54552a7ec650f31fb3b929d8
BLAKE2b-256 5f4cbe2c751f96b729b85781794f0660da8f0b26077663c6d915c3fc1419f0ed

See more details on using hashes here.

File details

Details for the file boreal-0.8.5-py2.py3-none-any.whl.

File metadata

  • Download URL: boreal-0.8.5-py2.py3-none-any.whl
  • Upload date:
  • Size: 2.4 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for boreal-0.8.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f24f7ebf57bda0b8d0dd42da142dd708ad4e35b8080cc62bfbc24aed3ee3a795
MD5 f8b68f38c9b57825d6b6a37ec0747f15
BLAKE2b-256 39a856b8c63e6ea2088430bf43e0da3c021f035e3b98992998c7f8e31dff9ab4

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