yatesdr / dazzle

Self-contained song trigger & player for Presentation & Sports walk-on music, based on Launchpad Mini MK3 and Raspberry Pi 4b

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Dazzle Player

A simple, self-contained audio sample player consisting of a LaunchPad Mini and a Raspberry Pi 4b.

About

There are lots of great utilities to play samples and triggers from a laptop or PC using MIDI triggers or a Streamdeck - Ableton, reaper, or other DAWs can easily do this. Even a VLC playlist. But I wasn't able to find something that met my needs for a durable, self-contained, configurable and portable music player which requires no screen and let the kids easily run their sound from a dugout or other location.

This project was created for that purpose - to allow for self-service playing of "walk-on" music for Softball games from the dugout. The basic idea is that each player gets a button, and when they're going up to bat it's easy to start and stop their song with minimal distraction from the game or having to mess with phones and playlists and bluetooth connections.

Dazzle is designed to directly drive a single powered PA speaker with a mono mix, but could also be patched into a local stadium sound board or other sound system for sound effects and sample playback.

BOM

You need the following:

  1. Raspberry Pi 4b (4GB) and a Novation Launchpad Mini mk3.
  2. XLR panel-mount pass through
  3. USB-c panel-mount pass thorugh
  4. RJ-45 Panel-mount pass through
  5. 40mm x 10mm fan
  6. Two 470 ohm resistors
  7. One 22k ohm resistor
  8. One TRS 1/8 audio plug
  9. m3 and m4 socket head screws for assembling the case.
  10. Various wire, heat-shrink, solder, and hot glue.
  11. Cables to connect everything - in particular a right-angle USB-c to USB-a cable for the Launchpad Mini MK3.

Building it

  1. Print the files from STL's - modify if desired in the Fusion 360 files provided. Install the Pi4.
  2. Install the panel mounts in the print for XLR, USB-C, and RJ-45 jacks. Wire them into the Pi4 as appropriate. The USB-C passthrough is intended for powering the Pi.
  3. Build the audio output mono mix circuit. The Pi4 has a TRRS output built in, and we want to sum that to mono at the XLR output so we can use normal WAV files in stereo or mono. I used an inexpensive headphone cable to plug into the Pi4 (TRS 1/8) together with two 470 ohm resistors to sum L/R, and a 22k ground impedance resistor, all installed right at the XLR patch point. If you skip this step and try to wire it directly you'll probably get hum and a poor audio output, but you can experiment with other output strategies if you want.
  4. Install the LaunchPad Mini and clamp it down - There are two 4mm bolts to hold the launchpad in the case.
  5. Power it up - It's designed to be powered over usb-c, so you can use a power bank or just plug it into 120v power using a Pi4 power addapter and the passthrough.

Install Dazzle

Dazzle is intended to be used with a vanilla raspberry pi 4b / 4GB, but may work on other systems also if you're adventurous. It should also run on a 2GB Pi-4B but is untested. You do need your Pi connected to the internet to do the installation, as it needs many docker and python bits to work that are not packaged here to complete the build.

  1. Use Raspberry Pi Imager to burn a basic installation of Raspbian 64-bit server. Set up your credentials and SSH access here so you don't need to mess with a monitor.
  2. Boot and login to the pi via ssh.
  3. Install Git and Docker: sudo apt install git docker.io
  4. Clone the project into your home folder
cd ~/
git clone https://github.com/yatesdr/dazzle
  1. Install it
cd ~/dazzle
./install.sh

Install will build the local docker image, map the drive and config, and then start it with a restart policy of always. By default, the media directory is set to ~/dazzle/media/wav, and the config file is ~/dazzle/config/config.json. The build will take a while. Once it's stable and all the bugs are out I'll release or pre-package the docker image here to avoid the build process on standard hardware.

If you want to see the running container, try sudo docker ps

If you need to change things, a cleaning script is provided: ./clean.sh. This removes the containers but not the images, so if you want to remove those do it manually.

How to use

  1. Upload your Media to the Pi's media folder using scp, rsync, or some other method. By default install this folder is in ~/dazzle/media/wav/ but you can move it before running install.sh if you prefer.

First, prepare your WAV files from whatever legal sources you have. Boot the pi and assuming you've used the standard pi user, do the following:

scp -r <your media file directory>/*.wav pi@<ip address of pi>:/home/pi/dazzle/media/wav/

If you're using a playlist for warm-up music, you need to copy your files to the /home/pi/dazzle/media/wav/playlist folder.

scp -r <your playlist wav folder> pi@<ip address of pi>:/home/pi/dazzle/media/wav/playlist/

Media Notes: WAV files work the best and are what you should use with a Pi4b. If you only have MP3's there is a utility provided to convert them to WAV files but you will need ffmpeg and some other dependencies to be installed on the Pi4b. MP3's can also be made to work, but are a bit slow to load on a Pi4, so only use them if you're using this on a laptop or n100 type machine. For testing with media you already own, some utilities are provided to pull in WAV's from Youtube, but if you're using this in public you should of course contact the license holders and do this officially and legally.

  1. Edit ~/dazzle/config/config.json - modify to reflect the board layout and songs you want. To start in the middle of a song, set the enter time in seconds. To play for a specified duration, set the duration time in seconds, or it will play until stopped or the song ends if you leave it at 0. If you have a specific volume to set, you can pass this in the config using dB in a key like "volume": "-12dB".

Note: The config file is reloaded on every keypress, so if you make changes just push the mute button to reload the config. Note: If it's not working, check the logs: sudo docker logs dazzler

  1. If you have a valid config, you'll see the board start working and should be able to play your samples.

Note: If it's not working, check the logs: sudo docker logs dazzler. Usually, it's media not found or a bad config.json.

Configuration - config.json

The board configuration is done by editing config.json. It is loaded at every keypress, so if you make changes they will be reflected if they're valid.

If config.json is not valid JSON, the container will crash and go into reload loop, so just fix it and press any button and it will start working again.

Sample Parameters:

  • row: from 1 to 8 for the white keys on LP Mini. 1 is top row, 8 is bottom row.
  • col: from 0 to 7 for the white keys. 0 is far left, 7 is far right.
  • action: "play" - used for playing a file (requires "file" key) or "stop"
  • file: The file name. File must exist in the media directory.
  • start: The time in seconds of where you want the file to start playing (in point).
  • duration: How long you want the file to play for. Set to 0 if you want it to play the whole file or until stopped.
  • vol (optional): set a custom volume in the format of "-24dB" or "50%". This is passed to amixer, so any valid arguments to amixer will also work here.

Note: By default the output will be set to -3dB level. So if you need the song volumes to match you should specify them in the config file. If no volume is specified, it will be played at -3dB.

Playlists

Dazzle has utility to start / stop and step forward and backward through a playlist, if you use the playlist controls. It essentially plays all the WAV files it finds in media/playlist folder in random order. Shuffle is done at boot or container re-start, so you get a new mix every for every game.

{"row": 8, "col": 0, "action": "playlist-start"},
{"row": 8, "col": 1, "action": "playlist-prev"},
{"row": 8, "col": 2, "action": "playlist-next"}

Pressing playlist-start will play whatever wav files you've loaded into the media/playlist directory, and continue playing them until stopped. There are utilities for trimming silence included in the utils/ folder, edit as needed once you have your songs loaded in wav format. THis requires pydub to work, which is not available by default in the base installation, so you may need to add it or handle this on a more powerful machine. The playlist will loop forever, and restart at the beginning. To skip forward or backwards, you can use the playlist-next or playlist-prev commands and assign them to a button.

The playlists are really intended for warm-up music before games, during intermissions, or the after party.

Note: Playlists are shuffled at container start, so you'll get a random play order without repeats for every game. I like to load lots of songs and the warmup will always have a bit of variation to it based on what the shuffle picks for the first hour or so.

Basic Actions:

  1. Buttons with a song programmed turn white.
  2. Push a white button to start playback, the button turns green for the active song.
  3. Push the green button to stop playback, or use the mute button (red)
  4. Push any other white button to change songs.

Road-Map & Future improvements

These are the things I want to work on when I have time, but may never get to.

  1. Use the Wifi chip to create a local network, with web application to modify the board config from your phone.
  2. A small pop can sometimes be heard when stopping media, I'd like to fix this.
  3. Improve latency between press and play for MP3's. This probably requires using something other than pydub, but it's unclear why mp3's lag so much (5-6 seconds). For now, just use WAV's and the latency is acceptable at about 0.5 seconds for a Pi4.

About

Self-contained song trigger & player for Presentation & Sports walk-on music, based on Launchpad Mini MK3 and Raspberry Pi 4b


Languages

Language:Python 96.4%Language:Dockerfile 1.9%Language:Shell 1.8%