Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unclechu/midihaskey
MIDIHasKey — Virtual MIDI keyboard suitable for microtonal music
https://github.com/unclechu/midihaskey
audio audio-processing cplusplus cpp haskell jack jackaudio keyboard microtonal midi midi-keyboard wxwidgets
Last synced: 27 days ago
JSON representation
MIDIHasKey — Virtual MIDI keyboard suitable for microtonal music
- Host: GitHub
- URL: https://github.com/unclechu/midihaskey
- Owner: unclechu
- License: gpl-3.0
- Created: 2018-01-04T20:47:42.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-07-18T00:41:04.000Z (over 2 years ago)
- Last Synced: 2023-04-09T05:11:42.112Z (over 1 year ago)
- Topics: audio, audio-processing, cplusplus, cpp, haskell, jack, jackaudio, keyboard, microtonal, midi, midi-keyboard, wxwidgets
- Language: Haskell
- Homepage:
- Size: 296 KB
- Stars: 10
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MIDIHasKey
Virtual MIDI keyboard for microtonal music.
It works with [JACK Audio Connection Kit](http://jackaudio.org/) but technically it can work with
anything you name. You’d just have to create an application or a script that handles the events that
are coming from MIDIHasKey’s stdout.
One of the main reasons to create MIDIHasKey is to use all keyboard keys efficiently in context of
microtonal music. For example [Jack Keyboard](http://jack-keyboard.sourceforge.net/) is trying to
simulate the feel of a real piano keyboard by imitating its layout of white and black keys. It
doesn’t make any sense for microtonal scales such as 17tet, 19tet, 22tet and many other. Those
scales won’t be devided in equal octaves on the piano keyboard, and we have some unused keys,‥ so
wasteful when we have just about 2 and half octaves in 12tet scale and even less in other micro
scales.
## WARNING!
**Work in progress! It’s playable but some stuff can be changed or is only partially implemented.**
See https://github.com/metachronica/audio-midihaskey/projects/1 page that about progress of first
release.
For now you can:
* Play notes by pressing keys on keyboard you set to handle
* Play notes by pressing GUI buttons
* Trigger note-offs for everything by pressing `Panic` button
* Change base pitch, octave, MIDI channel to play to
* Store settings between application restarts
## Supported OS
* GNU/Linux
## Requirements
* [GTK3](https://www.gtk.org/)
* [JACK Audio Connection Kit](http://jackaudio.org/)
For included C++ JACK MIDI Player application. It’s optional (if you have your own app for that)
because MIDIHasKey just writes events to stdout (in its own format) and you can redirect it
wherever you want.
**TODO** For me: Document the MIDI Player API. For now you can reverse-engeneer it by looking
inside [this file](midiplayer-jack-cpp/src/main.c++) for instance. It also will change in the
future.
* [GCC](https://gcc.gnu.org/) __>=6.4.*__ (maybe lower, but must support C++17)
To build C++ JACK MIDI Player (it’s optional too if you use your own one).
## Usage
### Using [Nix](https://nixos.org/nix/)
Nix is the recommended way to run it.
You can run it just from a nix-shell:
``` sh
nix-shell --arg with-midihaskey true --arg with-midiplayer-jack-cpp true --run 'midihaskey /dev/input/by-id/usb-xxxx_yyyy-event-kbd | midiplayer-jack-cpp'
```
Where `/dev/input/by-id/usb-xxxx_yyyy-event-kbd` is your keyboard device path
(you must have access to read from that file for your current user).
#### Tuning `nix-shell`
Look at [default.nix](default.nix)’s arguments to see available options.
##### Development mode for C++ JACK MIDI Player
``` sh
nix-shell -A midiplayer-jack-cpp
```
#### Build and run
``` sh
nix-build -A midihaskey.exe -o result-midihaskey
nix-build -A midiplayer-jack-cpp -o result-midiplayer-jack-cpp
result-midihaskey/bin/midihaskey /dev/input/by-id/usb-xxxx_yyyy-event-kbd | result-midiplayer-jack-cpp/bin/midiplayer-jack-cpp
```
##### Test against newer GHC
Here is an example how to build using GHC 9.2.3
(HLS is failing to build at the moment):
``` sh
nix-build --argstr ghcVersion ghc923 --arg withHLS false -o result-test-ghc923
```
#### Dev tools for Haskell apps
Nix setup for nix-shell includes [HLS] turned on by default.
If you use Vim here is how you can configure [vim-lsp] plugin to use it:
``` viml
if executable('haskell-language-server-wrapper')
aug HaskellLsp
au! User lsp_setup cal lsp#register_server({
\ 'name': 'hls',
\ 'cmd': {server_info->['haskell-language-server-wrapper', '--lsp']},
\ 'allowlist': ['haskell'],
\ })
aug END
en
```
##### direnv
See [.envrc example file](.envrc.example).
See [direnv.net](https://direnv.net) if you are not familiar with direnv.
### Using [Stack](https://haskellstack.org)
``` sh
stack build --install-ghc
(cd midiplayer-jack-cpp && make)
stack exec -- midihaskey /dev/input/by-id/usb-xxxx_yyyy-event-kbd | midiplayer-jack-cpp/build/midiplayer-jack-cpp
```
# Author
Viacheslav Lotsmanov
# License
[GNU/GPLv3](LICENSE)
[HLS]: https://github.com/haskell/haskell-language-server
[vim-lsp]: https://github.com/prabirshrestha/vim-lsp