Giter VIP home page Giter VIP logo

punchline's Introduction

punchline

CLI tool to generate SVG punch cards (stripes with melodies) for a DIY music box from MIDI melodies.

Some basics:

  • SVG is a vector format of images, meaning that you can scale the image as much as you want and print it on any printer, pen plotter, or laser cutter.
  • MIDI is a sound format that instead of exact sounds describes which musical instruments should play which note at which moment. You can find a free MIDI file for any popular melody online.
  • DIY music box is a type of music box which instead of playing a predefined melody can play any melody from a paper stripe with holes in it. You can buy one online for a pretty low price.

Features:

  • Written on modern Python.
  • Has friendly CLI.
  • Well documented source code (if you really want to tweak something).
  • Highly configurable.
  • Has only necessary dependencies.
  • Automatically finds the best transposition.
  • Finds the best fit for notes that aren't present on the music box.
  • Supports all kinds of music boxes.
  • Works offline.
  • Detects notes that might be silent.
  • Laser cutter friendly output.

Installation

You'll need:

  1. Python version 3.9 or later
  2. pip
  3. Knowledge of how to use terminal.
python3.9 -m pip install punchline

Usage

Get help:

python3.9 -m punchline --help

Generate punch cards from 3rd track in SevenNationArmy.mid for 20-notes music box that supports sharp notes and save the result into "7nation" directory:

python3.9 -m punchline --input SevenNationArmy.mid --tracks 3 --sharps --notes-count 20 --output 7nation

The only required argument is --input. By default, it will generate stripes from all tracks for 15-notes non-sharp music box and store the result in the "output" directory.

You can find a few more examples in presets.md.

Editing tips

  1. You can use Inkscape to edit generated SVG images. It's free and powerful.
  2. To mass-edit a specific type of element:
    1. Select an element of this type
    2. Right-click on it.
    3. Open "Select same" menu.
    4. Select "Fill and stroke"
  3. Red circles indicate sounds that aren't perfectly fit on the music box. They are either in a different octave comparing to most of the other sounds or they are semitones (sharp notes) when your music box doesn't support semitones. Punchline tries its best to place them where it will sound OK but you may want to edit them or remove altogether.
  4. Pay attention to the outlined circles (filled with white instead of a color). They indicate sounds that are too close to the previous one on the same line. They might be silent because of limitations of the music box. You may want to decrease the --speed for the whole melody or manually move (or remove) colliding sounds. The minimal distance between circles (their centers) is configured by --min-distance.

Acknowledgments

  1. The initial implementation is based on punchbox.
  2. mido is used to read MIDI files.
  3. svg.py is used to generate SVG files.

punchline's People

Contributors

orsinium avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.