Skip to main content

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.

Metadata

Release files for herakoi 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for herakoi 0.2.0
File Size Uploaded Provenance Actions
herakoi-0.2.0.tar.gz 7.6 kB Without provenance Details for herakoi-0.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for herakoi 0.2.0
File Interpreter ABI Platform Actions
herakoi-0.2.0-py3-none-any.whl Python 3 none any Details for herakoi-0.2.0-py3-none-any.whl

Total release size: 15.7 kB

Release files / herakoi-0.2.0.tar.gz

Download URL herakoi-0.2.0.tar.gz
Size 7.6 kB
Tags Source
SHA-256 checksum
How to use checksums
0a75c90f1f57759bf852f530e7df2d37a5f9be5761deb16fd2ec1d00f95fcb58
BLAKE2b-256 checksum
How to use checksums
468691104f3180eb16fb4162b8a8355298269d3264c08b351033e4fdc9d8ee96
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.11

Release files / herakoi-0.2.0-py3-none-any.whl

Download URL herakoi-0.2.0-py3-none-any.whl
Size 8.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c5f5cade8260b7b9b75117fbbec7dc85fbe7a85678ba4ea18c1b7327afc03d40
BLAKE2b-256 checksum
How to use checksums
6f1a1a04d6108e41529213dd42ea56fc814e2495ebb0441828192909566720ec
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.11

Security for herakoi 0.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page