Skip to main content

A sonification tool

Project description

herakoi

DOI PyPI version Documentation Status

herakoi is a motion-sensing sonification experiment.

It uses a Machine Learning (ML)-based algorithm for hand recognition to track in real-time the position of your hands in the scene observed by a webcam connected to your computer. The model landmarks coordinates of your hands are then re-projected onto the pixel coordinates of your favorite image. The visual properties of the "touched" pixels (at the moment, color and saturation) are then converted into sound properties of your favorite instrument, which you can choose from your favorite virtual MIDI keyboard.

In this way, you can hear the sound of any images, for educational, artistic, or just-fun purposes!

Fully written in python, herakoi requires relatively little computational power and can be run on different on the most popular operating systems (macOS, Microsoft Windows, Linux).

Usage

  1. run herakoi path_to_your_favorite_image
  2. open your favorite MIDI player (e.g., if you run herakoi on an Apple computer, GarageBang is a good option)
  3. have fun!

You can customize your herakoi by using the following flags:

  • --notes XX YY, that will allow the pitch to span the range from the note XX and YY (with XX equal to, e.g., C4 for middle C)
  • --volume ZZ, that will set lower threshold for the note volume (with ZZ in percentage)
  • --switch, inverting the color-brightness mapping

FAQs

A list of frequently asked questions.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change, or contact the authors.

License

Copyright 2022 Michele Ginolfi, Luca Di Mascolo, and contributors.

herakoi is a free software made available under the MIT License. For details see the LICENSE file.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

herakoi-0.2.0.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

herakoi-0.2.0-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file herakoi-0.2.0.tar.gz.

File metadata

  • Download URL: herakoi-0.2.0.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for herakoi-0.2.0.tar.gz
Algorithm Hash digest
SHA256 0a75c90f1f57759bf852f530e7df2d37a5f9be5761deb16fd2ec1d00f95fcb58
MD5 8f2e51eb21568afc5e1eb4d0b56659e9
BLAKE2b-256 468691104f3180eb16fb4162b8a8355298269d3264c08b351033e4fdc9d8ee96

See more details on using hashes here.

File details

Details for the file herakoi-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: herakoi-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for herakoi-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c5f5cade8260b7b9b75117fbbec7dc85fbe7a85678ba4ea18c1b7327afc03d40
MD5 60bd9d8b4624067be32c514f96430b69
BLAKE2b-256 6f1a1a04d6108e41529213dd42ea56fc814e2495ebb0441828192909566720ec

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page