Skip to main content

Audio kit for Volux

Project description

Volux Audio

PyPI PyPI - Downloads PyPI - License

☠️ EXPERIMENTAL: - Beware all ye who enter here ☠️

Table of Contents


pip install voluxaudio


VoluxAudioStream - Source

Non-buffered Example

This Python code uses the voluxaudio library to open a new audio stream and calls the on_data function every time it gets a new chunk of audio data. The on_data function simply prints a message indicating that a new chunk of audio data has been received, along with the current timestamp.

The CHUNK_SIZE variable defines the size of each chunk of audio data in bytes, and the CHANNEL_COUNT variable defines the number of audio channels.

The code creates a VoluxAudioStream object with the on_data function, chunk_size, and channels as arguments. It then enters an infinite loop that keeps the audio stream open and calls sleep(1) to wait for one second before checking for new audio data again.

from voluxaudio import VoluxAudioStream
from time import sleep, perf_counter


def on_data(
    in_data, # audio data from this chunk
    frame_count, # number of samples chunk
    buffer_read_dtype, # buffer's datatype
    channel_count, # number of channels
    sample_rate, # number of samples collected per second
    """Do this every time we get a new chunk of data."""
    print(f"got a new chunk of audio data! (seconds: {perf_counter()})")

with VoluxAudioStream(
) as audio_stream:
    # keep stream open until script closed
    while True:

Buffered Example

This Python code continuously prints the current buffer of audio data being read from an audio stream at a specified rate.

from voluxaudio import VoluxAudioStream
from time import sleep


with VoluxAudioStream(
) as audio_stream:
    while True:
        print(f"buffer: {audio_stream.buffer}")

Audio-visualization Example

This Python code opens an audio stream using the voluxaudio library with buffering enabled. It defines a function on_data() that does nothing and is called every time new samples are gathered. Within the while loop, it calculates the weakly approximated amplitude of the audio stream by taking the last 2048 samples of the left and right channels and averaging their absolute values. It then prints a bar representing the amplitude by printing a number followed by a horizontal bar, where the length of the bar is proportional to the amplitude. The script waits for approximately 50 milliseconds before repeating the loop.

This audio stream comes from your system's default recording device, which could either be a microphone or your computer/desktop audio.

Voluxaudio Amplitude Example

from voluxaudio import VoluxAudioStream
import numpy as np
from time import sleep

# call this every time new samples gathered
def on_data(*args, **kwargs):

# open an audio stream with buffering enabled
with VoluxAudioStream(
) as audio_stream:

    # repeat until script stopped
    while True:

        # weakly approximate amplitude
        samples = audio_stream.buffer
        sample_count = len(samples)
        samples_per_channel = np.swapaxes(samples, 0, 1)
        L_channel_e = np.average(np.abs(samples_per_channel[0][-2048:])) / sample_count
        R_channel_e = np.average(np.abs(samples_per_channel[1][-2048:])) / sample_count
        e = (L_channel_e + R_channel_e) / 2

        # print bar
        print(f"{e:<3.3f} " + int(e*100) * '|')

        # wait ~50ms
        sleep(1 / 20)
  • This is a simple example, but more complex audio processing is possible.
  • A bar is printed every 50ms, changing length based on the approximated amplitude.
  • The system volume may affect results, to test this dramatically increase/decrease your system volume to see if the bar length is affected. This applies to computer/desktop audio, not microphones.
  • Buffering is used as buffer_size_in_seconds is specified.

Todo List

  • Get simple VoluxAudioStream class working
  • Make VoluxAudioStream class highly configurable
  • Add basic example to documentation
  • Add basic documentation
  • Add more examples to documentation
  • Add links
  • Add more detailed documentation


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

voluxaudio-0.9.0.tar.gz (5.9 kB view hashes)

Uploaded source

Built Distribution

voluxaudio-0.9.0-py3-none-any.whl (6.5 kB view hashes)

Uploaded py3

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