.\" Automatically generated by Pandoc 3.7.0.2
.\"
.TH "boomwhacker" "1" "" "" "Special Applications Manual"
.SH NAME
boomwhacker \- Convert MIDI file to play\-along boomwhacker animation
.SH SYNOPSIS
\f[CR]boomwhacker [OPTIONS..] song.mid song.pdf\f[R]
.SH 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.
.SH OPTIONS
.TP
\f[CR]\-h, \-\-help\f[R]
Show all options with a short description and quit immediately.
.TP
\f[CR]\-\-rate FPS\f[R]
Number of frames per second.
.TP
\f[CR]\-\-background JPEG\f[R]
Use the according image as background.
The image extent is also used as size of the video frames.
.TP
\f[CR]\-\-background\-frames JPEG\-DIR\f[R]
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 \f[CR]\-\-rate\f[R] option.
If there are less frames than required for the duration of the MIDI
track, the frames are cycled.
Also see \f[CR]\-\-background\-loop\-overlap\f[R] option.
.RS
.PP
This is our poor man\(cqs 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.
.RE
.TP
\f[CR]\-\-background\-frames\-rate\f[R]
Actual frame rate of the background video.
.TP
\f[CR]\-\-background\-loop\-overlap SECONDS\f[R]
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.