Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/m-yuhas/musical_hash
Like random art, but with sound
https://github.com/m-yuhas/musical_hash
Last synced: about 2 months ago
JSON representation
Like random art, but with sound
- Host: GitHub
- URL: https://github.com/m-yuhas/musical_hash
- Owner: m-yuhas
- License: mit
- Created: 2020-02-04T05:16:01.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-06-17T11:05:31.000Z (over 1 year ago)
- Last Synced: 2024-07-02T07:09:49.631Z (3 months ago)
- Language: Python
- Size: 2.12 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Musical Hash
[中文指南](https://github.com/m-yuhas/musical_hash/blob/master/doc/读我档案.md)
[Documentación en español](https://github.com/m-yuhas/musical_hash/blob/master/doc/LÉAME.md)
[Documentation en français](https://github.com/m-yuhas/musical_hash/blob/master/doc/LISEZ-MOI.md)
## Introduction
Just as [Random Art](https://github.com/calmh/randomart) provides a method to
visualize RSA keys, Musical Hash provides a method to "visualize" the output of
a hash function as audio. It generates a unique melody for each hash value that
can be exported as a wave file, a midi file, or a list of notes in ABC
notation.
## Quick Start
* Install the package:
```
pip install musical_hash
```
* In a Python console, import the package:
```python
>>> import musical_hash
```
* Construct the musical hash object:
```python
>>> hash = musical_hash.MusicalHash(b'Hello World!', 'md5')
```
* Export the hash as a wave file in the key of A pentatonic minor:
```python
>>> hash.wave('hash.wav', key=musical_hash.A_PENTATONIC_MINOR)
```
* Or, export as a midi file:
```python
>>> hash.midi('hash.mid', key=musical_hash.A_PENTATONIC_MINOR)
```
## API Documentation
For the complete API documentation, [click here](https://github.com/m-yuhas/musical_hash/blob/master/doc/api_documentation.md).
## Theory of Operation
In western classical music there are twelve semitones in an octave. The first
note of the subsequent octave is the first harmonic of the first note of the
previous octave. Thus we will consider a single octave as the universe of all
notes available to "visualize" a sequence of bytes. Most pieces of music are
written in a specific key, which is a subset of all available notes. Within a
single octave, each key has a finite number of notes, so if we consider the
sequence of bytes as an integer, we can find that integer's representation in a
base equal to the number of notes in a key. We then assign each digit of this
representation a musical note. This package comes with many diatonic and
pentatonic keys as constants.
## Dependencies
Only Python version 3.5 and greater are supported. This package should run on
any POSIX system as well as Windows 7 and greater.
The following Pypi packages are required:
* mido
* numpy
* wavio
## Contributing
Suggestions and pull requests are welcome. If you find a bug and don't have
time to fix it yourself, feel free to open an issue. Also, I am not an expert
at Music Theory; if you find an error with the way a scale or musical term is
named, please call it out so that I can learn.
## Future Tasks
- TODO: Make a hash that includes chords to decrease the tune length and
increase the perceived uniqueness of each hash.
## See Also
Originally I thought I was the only one with this idea, but after I implemented
it I found this guy's [repository](https://github.com/jmaclean/musical-hash),
so check it out if you want to see another take on the concept.