boomwhacker: Convert MIDI file to play-along boomwhacker animation

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Convert MIDI file to play-along boomwhacker animation:

Run it like so:

boomwhacker song.mid song.pdf

song.mid is the input file that must be a MIDI file. song.pdf is the output file, a PDF file. You can convert the PDF to a series of PNG files using ghostscript and this one to a video using ffmpeg. See Makefile for example command calls.


[Skip to Readme]

Properties

Versions 0.0, 0.0.1, 0.0.2, 0.0.2.1, 0.0.3
Change log None available
Dependencies array (>=0.4 && <0.6), base (>=4.5 && <5), comfort-array (>=0.5 && <0.6), containers (>=0.4 && <0.9), directory (>=1.2.5 && <1.4), event-list (>=0.1.3 && <0.2), filepath (>=1.3 && <1.6), HPDF (>=1.7 && <1.9), midi (>=0.2.2 && <0.3), non-empty (>=0.3.4 && <0.4), non-negative (>=0.1.2 && <0.2), optparse-applicative (>=0.11 && <0.20), shell-utility (>=0.1 && <0.2), time (>=1.8 && <1.16), transformers (>=0.3 && <0.7), utility-ht (>=0.0.10 && <0.1), vector (>=0.12 && <0.14) [details]
License BSD-3-Clause
Author Henning Thielemann
Maintainer haskell@henning-thielemann.de
Category Music, Sound
Home page https://hub.darcs.net/thielema/boomwhacker
Source repo this: darcs get https://hub.darcs.net/thielema/boomwhacker --tag 0.0.3
head: darcs get https://hub.darcs.net/thielema/boomwhacker
Uploaded by HenningThielemann at 2026-04-21T16:40:53Z

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees


Readme for boomwhacker-0.0.3

[back to package description]

% boomwhacker(1) | Special Applications Manual

NAME

boomwhacker - Convert MIDI file to play-along boomwhacker animation

SYNOPSIS

boomwhacker [OPTIONS..] song.mid song.pdf

DESCRIPTION

Convert MIDI file to play-along boomwhacker animation as PDF document. For conversion to an actual video format we recommend rendering pages to PNG or JPEG using ghostscript and merge frames and audio using FFmpeg.

OPTIONS

-h, --help

: Show all options with a short description and quit immediately.

--rate FPS

: Number of frames per second.

--background JPEG

: Use the according image as background. The image extent is also used as size of the video frames.

--background-frames JPEG-DIR

: Use all files found in directory as a sequence of background frames. Use this to use a background video instead of a still image. Files are included in lexicographic order and are expected to be in JPEG format and to all have the same size and the frame rate by default is expected to match the one specified with the --rate option. If there are less frames than required for the duration of the MIDI track, the frames are cycled. Also see --background-loop-overlap option.

This is our poor man's way to support background videos
without the need to handle video formats.
However it requires (lossy) conversion of the input video
to a sequence of JPEG files (e.g. using ffmpeg),
which also requires a lot of disk space.
Caution: This creates huge PDF files
because there is no inter-frame compression.
You can reduce memory consumption using cycles of short video clips.

--background-frames-rate

: Actual frame rate of the background video.

--background-loop-overlap SECONDS

: Blend loop end and loop start for the given number or fraction of seconds. Overlap duration must be shorter than half of the duration of the background video loop.