Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jazz-soft/jzz-midi-gm
General MIDI instrument names: MIDI to string / string to MIDI
https://github.com/jazz-soft/jzz-midi-gm
general-midi gm gm2 gs midi xg
Last synced: about 1 month ago
JSON representation
General MIDI instrument names: MIDI to string / string to MIDI
- Host: GitHub
- URL: https://github.com/jazz-soft/jzz-midi-gm
- Owner: jazz-soft
- License: mit
- Created: 2018-02-28T03:22:37.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-23T03:50:54.000Z (9 months ago)
- Last Synced: 2024-05-02T05:04:52.011Z (8 months ago)
- Topics: general-midi, gm, gm2, gs, midi, xg
- Language: JavaScript
- Homepage:
- Size: 134 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# JZZ-midi-GM
[](https://www.npmjs.com/package/jzz-midi-gm)
[](https://www.npmjs.com/package/jzz-midi-gm)
[](https://github.com/jazz-soft/JZZ-midi-GM/actions)
[](https://coveralls.io/github/jazz-soft/JZZ-midi-GM?branch=master)
### General MIDI / GM2 / GS / XG instrument names: MIDI to string / string to MIDI
## Install
`npm install jzz-midi-gm`
or `yarn add jzz-midi-gm`
or get the full development version and minified scripts from [**GitHub**](https://github.com/jazz-soft/JZZ-midi-GM)
## Usage
##### Plain HTML
```html
//...
```
##### CDN (jsdelivr)
```html
//...
```
##### CDN (unpkg)
```html
//...
```
##### CommonJS
```js
var JZZ = require('jzz');
require('jzz-midi-gm')(JZZ);
//...
```
##### TypeScript / ES6
```ts
import { JZZ } from 'jzz';
import { GM } from 'jzz-midi-gm';
GM(JZZ);
//...
```
##### AMD
```js
require(['JZZ', 'JZZ.midi.GM'], function(JZZ, gm) {
// ...
});
```
## API
### MIDI to string
`JZZ.MIDI.programName(midi)` -
map MIDI program value to a General MIDI instrument name.
`JZZ.MIDI.programName(midi, msb, lsb)` -
map MIDI program value and bank msb/lsb to a GM2/GS/XG instrument name.
`JZZ.MIDI.groupName(midi)` -
map MIDI program value to a General MIDI group name.
`JZZ.MIDI.percussionName(midi)` -
map MIDI note value to General a MIDI percussion name.
```js
console.log(JZZ.MIDI.programName(60));
// => 'French Horn'
console.log(JZZ.MIDI.programName(24, 0, 1));
// => 'Ukulele' (GM2)
console.log(JZZ.MIDI.groupName(60));
// => 'Brass'
console.log(JZZ.MIDI.percussionName(60));
// => 'Hi Bongo'
```
### string to MIDI
`JZZ.MIDI.programValue(str)` -
map instrument name to a MIDI program (GM only);
if there is no exact match, try the best guess.
`JZZ.MIDI.noteValue(str)` -
map percussion name to a MIDI note number;
if there is no exact match, try the best guess.
`JZZ.MIDI.guessValue(str)` -
map program or percussion name (whatever matches best) to a MIDI value;
if the return value is negative, it's the percussion note value with a minus sign, otherwise, it's the program value.
```js
console.log(JZZ.MIDI.programName(JZZ.MIDI.programValue('piano')));
// => 'Acoustic Grand Piano'
console.log(JZZ.MIDI.percussionName(JZZ.MIDI.noteValue('snare')));
// => 'Acoustic Snare'
var n = JZZ.MIDI.guessValue('crash');
if (n < 0) console.log(JZZ.MIDI.percussionName(-n));
else console.log(JZZ.MIDI.programName(n));
// => 'Crash Cymbal 1'
```
### list all instruments
`allGM2() / allGS() / allXG()` -
return a complete list of GM2/GS/XG programs as an array of of triplets `[program-number, bank-msb, bank-lsb]`.
### JZZ helpers
`note(...) / noteOn(...) / noteOff(...) / aftertouch(...) / program(...)` -
when the module is loaded, JZZ helper functions will understand the instrument names where appropriate.
```js
JZZ().openMidiOut()
.ch(0).program('accordion').noteOn('C#6', 100)
.ch(9).noteOn('cowbell', 127);
```
## Demo
[**https://jazz-soft.net/demo/GmGsXg.html**](https://jazz-soft.net/demo/GmGsXg.html)
## More information
Please visit [**https://jazz-soft.net**](https://jazz-soft.net) for more information.