https://github.com/cedargrovestudios/circuitpython_waveviz

A CircuitPython class to create a positionable displayio.TileGrid object from a synthio.waveform wave table or synthio.Envelope object.
https://github.com/cedargrovestudios/circuitpython_waveviz

circuitpython circuitpython-community-bundle synthesizer wavetable wavetable-visualizer

Last synced: 20 days ago
JSON representation

A CircuitPython class to create a positionable displayio.TileGrid object from a synthio.waveform wave table or synthio.Envelope object.

• Host: GitHub
• URL: https://github.com/cedargrovestudios/circuitpython_waveviz
• Owner: CedarGroveStudios
• License: mit
• Created: 2024-01-09T03:06:21.000Z (almost 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-17T19:52:43.000Z (11 months ago)
• Last Synced: 2024-12-20T01:44:17.192Z (20 days ago)
• Topics: circuitpython, circuitpython-community-bundle, synthesizer, wavetable, wavetable-visualizer
• Language: Python
• Homepage:
• Size: 4.08 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Introduction

============

.. image:: https://github.com/CedarGroveStudios/CircuitPython_WaveViz/blob/main/media/harmonica_wave_TFT.jpeg

    :width: 400

.. image:: https://img.shields.io/discord/327254708534116352.svg

    :target: https://adafru.it/discord

    :alt: Discord

.. image:: https://github.com/CedarGroveStudios/Cedargrove_CircuitPython_WaveViz/workflows/Build%20CI/badge.svg

    :target: https://github.com/CedarGroveStudios/Cedargrove_CircuitPython_WaveViz/actions

    :alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/psf/black

    :alt: Code Style: Black

A CircuitPython class to create a positionable ``displayio.TileGrid`` object

from a ``synthio.waveform`` wave table or ``synthio.Envelope`` object.

The class inherits the properties of a ``TileGrid`` object including ``bitmap``,

``pixel_shader``, ``width``, ``height``, ``x``, ``y``.

Dependencies

=============

This driver depends on:

* `Adafruit CircuitPython `_

Please ensure all dependencies are available on the CircuitPython filesystem.

This is easily achieved by downloading

`the Adafruit library and driver bundle `_

or individual libraries can be installed using

`circup `_.

Installing to a Connected CircuitPython Device with Circup

==========================================================

Make sure that you have ``circup`` installed in your Python environment.

Install it with the following command if necessary:

.. code-block:: shell

    pip3 install circup

With ``circup`` installed and your CircuitPython device connected use the

following command to install:

.. code-block:: shell

    circup install cedargrove_waveviz

Or the following command to update an existing version:

.. code-block:: shell

    circup update

Usage Example

=============

.. image:: https://github.com/CedarGroveStudios/CircuitPython_WaveViz/blob/main/media/waveviz_simpletest.jpeg

    :width: 400

.. code-block:: python

    import board

    import displayio

    import synthio

    import adafruit_ili9341

    from cedargrove_wavebuilder import WaveBuilder, WaveShape

    from cedargrove_waveviz import WaveViz

    # Define wave table parameters

    WAVE_TABLE_LENGTH = 512  # The wave table length in samples

    SAMPLE_MAXIMUM = 32700  # The maximum value of a sample

    # Instantiate a built-in display

    # display = board.DISPLAY

    # Instantiate the FeatherS2 with 2.4-inch TFT FeatherWing display

    displayio.release_displays()  # Release display resources

    display_bus = displayio.FourWire(

        board.SPI(), command=board.D6, chip_select=board.D5, reset=None

    )

    display = adafruit_ili9341.ILI9341(display_bus, width=320, height=240)

    display.rotation = 0

    splash = displayio.Group()

    display.root_group = splash

    # Define the Harmonica wave shape, overtone ratio, and amplitude

    tone = [

        (WaveShape.Sine, 1.00, 0.10),

        (WaveShape.Sine, 2.00, 0.48),

        (WaveShape.Sine, 3.00, 0.28),

        (WaveShape.Sine, 4.00, 0.02),

        (WaveShape.Sine, 5.00, 0.12),

    ]

    # Create the wave table (wave.wave_table)

    wave = WaveBuilder(

        oscillators=tone,

        table_length=WAVE_TABLE_LENGTH,

        sample_max=SAMPLE_MAXIMUM,

        lambda_factor=1.0,

        loop_smoothing=True,

        debug=False,

    )

    # Create a synthio.Envelope object

    env = synthio.Envelope(

        attack_time=0.05,

        attack_level=1.0,

        decay_time=0.1,

        release_time=0.1,

        sustain_level=0.5,

    )

    # Display a small version on the bottom layer

    splash.append(

        WaveViz(wave.wave_table, x=20, y=80, width=25, height=25, back_color=0x0000A0)

    )

    # Display a full-sized version on the middle layer

    splash.append(

        WaveViz(wave.wave_table, x=0, y=0, width=300, height=240, back_color=None)

    )

    # Display the envelope object on the top layer

    splash.append(

        WaveViz(

            env,

            x=150,

            y=170,

            width=80,

            height=40,

            plot_color=0xFFFFFF,

            back_color=0x800080,

        )

    )

    while True:

        pass

Documentation

=============

API documentation for this library can be found in `Cedargrove_WaveViz `_.

.. image:: https://github.com/CedarGroveStudios/CircuitPython_WaveViz/blob/main/media/waveviz_api_page1a.png

For additional detail about ``WaveViz``, see `WaveViz: Plot a synthio Wave Table or Envelope `_

Planned Updates

===============

* Use a .wav file as input.

* Design a scrolling window for visualizing long waveform arrays and files.