Files
beatglow/README.md

169 lines
5.1 KiB
Markdown

# BeatGlow
Visualizer for audiophile streamers (or enthousiasts alike).
## State of the project
Work in progress!
## Features
### Main display
Showing what track is currently playing.
Features:
- Audio format, bitrate and output sample rate display
- Track elapsed and duration
- Track album art
- Spectrum analyzer / Waterfall display of the track playing
Mono spectrum analyzer (also supports stereo):
![BeatGlow main display](asset/image/beatglow-playing.gif)
Stereo spectrum waterfall display (also supports mono):
![BeatGlow main display with waterfall](asset/image/beatglow-playing-waterfall.gif)
### Settings
Live adjust settings from the rotary dail.
![BeatGlow settings display](asset/image/beatglow-settings.gif)
### Spectrum analyzer
![BeatGlow spectrum analyzer](asset/image/beatglow-spectrum-analyzer.gif)
![BeatGlow spectrum waterfall](asset/image/beatglow-spectrum-waterfall.gif)
### Shader
![BeatGlow shader audio intensity bars](asset/image/beatglow-shader-audio-intensity-bars.gif)
![BeatGlow shader etc.](asset/image/beatglow-shader-etc.gif)
## Performance
Tests have been performed on a Raspberry Pi 4B+ with 4GB RAM, with a 256x64x4 pixel display running at 25 frames per second. Lowering the frame rate also lowers resource
utilisation at the expensive of less fluid animations.
### CPU usage
During the main display with stereo spectrum analyzer, running 44.1kHz stereo audio: 9% CPU, 20MB RAM.
During the full screen stereo spectrum analyzer, running 44.1kHz stereo audio: 10% CPU, 20MB RAM.
During the shader, running various shader effects, running 44.1kHz stereo audio: 40-50% CPU, 21MB RAM.
## Setup
When the audio source uses `type = "fifo"`, MPD-based players check the output
status after connecting and every 15 seconds. BeatGlow logs a warning if the
matching output is disabled or missing, and reports when it becomes enabled.
It does not enable outputs automatically. A single FIFO output is selected
automatically. If MPD has multiple FIFO outputs, set `output = "BeatGlow"` in
the `audio` block, using the name of the MPD output that writes to your FIFO.
Older MPD versions that omit the output plugin also require this name.
MPD does not expose FIFO paths through its output status, so the configured
output must write to the same path as the audio source.
Minimal requirements:
- Linux Computer (Raspberry Pi 3B+)
- Supported display
### Setup Raspberry Pi & SSD1322 256x64 OLED display
Requirements:
- Raspberry Pi 3B+/4B+
- SSD1322 OLED Display 3.12" 256x64
- Display purchase options:
- [AliExpress](https://s.click.aliexpress.com/e/_onJsYxJ) [^1]
- [AudioPhonics.fr](https://www.audiophonics.fr/en/screens-vu-meters/white-spi-iic-256x64-oled-312-screen-p-14604.html)
#### Wiring
Wiring the display is as follows, looking at the OLED display connector from the back (pin 1 on the top left, pin 16 on the bottom right):
![SSD1322 setup](asset/image/setup-ssd1322.png)
| Wire | Function | Raspberry Pi | Display |
| -------------------------------- | --------- | --------------- | ------- |
| ![](asset/image/wire-black.png) | Ground | Pin 20 (GND) | Pin 1 |
| ![](asset/image/wire-yellow.png) | 3.3V | Pin 17 (3.3V) | Pin 2 |
| ![](asset/image/wire-orange.png) | SPI Clock | Pin 23 (GPIO11) | Pin 4 |
| ![](asset/image/wire-blue.png) | SPI Data | Pin 19 (GPIO10) | Pin 5 |
| ![](asset/image/wire-white.png) | SPI D/C | Pin 18 (GPIO24) | Pin 14 |
| ![](asset/image/wire-brown.png) | SPI Reset | Pin 22 (GPIO25) | Pin 15 |
| ![](asset/image/wire-red.png) | SPI C/E | Pin 24 (GPIO8) | Pin 16 |
#### Configuration
The display configuration in `beatglow.conf` is as follows:
```ini
# Display hardware configuration.
display {
# Target frame rate, actual frame rate depends on hardware options.
fps = 25
# Main display is where all the magic happens.
main {
# Type of display
type = "ssd1322"
size = "256x64"
# Mode (spi or i2c)
mode = "spi"
# SPI settings
port = "spi0.0"
reset = "GPIO25"
dc = "GPIO24"
bl = "GPIO23"
}
}
```
### Setup Raspberry Pi & ST7789 170x320 IPS display
Requirements:
- Raspberry Pi 3B+/4B+
- ST7735/ST8889 IPS display
- Display purchase options:
- [AliExpress](https://s.click.aliexpress.com/e/_onuTZPb) [^1]
- [Waveshare](https://www.waveshare.com/1.9inch-lcd-module.htm)
#### Configuration
The display configuration in `beatglow.conf` is as follows:
```ini
display {
# Target frame rate, actual frame rate depends on hardware options.
fps = 25
# Main display is where all the magic happens.
main {
# Type of display
type = "st7789" # or st7735
size = "320x130"
rotate = "left"
# Mode (spi or i2c)
mode = "spi"
# SPI settings
port = "spi0.0"
reset = "GPIO25"
dc = "GPIO24"
bl = "GPIO23"
}
}
```
[^1]: Affiliate links, by clicking them and making an order there is a small kick back for me, which allows me to order parts for testing. There is usually no additional costs for the purchaser.