https://github.com/jazz-soft/midi-test

Virtual MIDI ports for testing MIDI applications
https://github.com/jazz-soft/midi-test

midi test

Last synced: 3 months ago
JSON representation

Virtual MIDI ports for testing MIDI applications

• Host: GitHub
• URL: https://github.com/jazz-soft/midi-test
• Owner: jazz-soft
• Created: 2018-06-07T01:58:46.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-27T10:20:13.000Z (9 months ago)
• Last Synced: 2024-11-11T20:51:58.855Z (3 months ago)
• Topics: midi, test
• Language: C++
• Homepage:
• Size: 70.3 KB
• Stars: 10
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# midi-test

[![npm](https://img.shields.io/npm/v/midi-test.svg)](https://www.npmjs.com/package/midi-test)

[![npm](https://img.shields.io/npm/dt/midi-test.svg)](https://www.npmjs.com/package/midi-test)

[![build](https://github.com/jazz-soft/midi-test/actions/workflows/build.yml/badge.svg)](https://github.com/jazz-soft/midi-test/actions)

## Virtual MIDI ports for testing MIDI applications

See also: [**web-midi-test**](https://github.com/jazz-soft/web-midi-test), [**test-midi-files**](https://github.com/jazz-soft/test-midi-files)

Install: `npm install midi-test --save-dev`

Manual rebuild (if needed): `node-gyp rebuild`

## API

### MIDI Source (Virtual MIDI-In)

```js

var MT = require('midi-test');

var port = new MT.MidiSrc('VIRTUAL MIDI-In');

port.connect();

port.emit([0x90, 0x40, 0x7f]);

//...

port.disconnect();

```

### MIDI Destination (Virtual MIDI-Out)

```js

var MT = require('midi-test');

var port = new MT.MidiDst('VIRTUAL MIDI-Out');

port.receive = function(msg) { console.log('received:', msg); };

port.connect();

//...

port.disconnect();

```

### TypeScript

```ts

import * as MT from 'midi-test'

//...

```

## Developer notes

**midi-test** currently works in **Linux** and **MacOS**.  

**Windows** version may appear some day in the future, but it is not in the immediate plans.

This package requires **Node.js v18 or above**,

and the full stack of [**node-gyp**](https://www.npmjs.com/package/node-gyp) build tools.  

(for older versions of Node please use **midi-test v1.2.9**)  

Linux build also requires the ALSA libraries: `apt-get install libasound2-dev`

Since the Linux version needs special permissions to access the computer's sound system,  

it may not work properly in virtual Linux environments such as the one at [**Travis-CI**](https://travis-ci.org)

or [**GitHub Actions**](https://docs.github.com/en/actions).

To make your test work with **Travis-CI** or **GitHub Actions**, run it on **MacOS**.  

in `.travis.yml`:

```

os:

  - osx

...

```

in `.github/workflows/*.yml`:

```

jobs:

  build-macos:

    runs-on: macos-latest

  ...

```

If you are getting a build error related to Python 3.12, you may want to add this build step

(see the [build.yml](https://github.com/jazz-soft/midi-test/blob/master/.github/workflows/build.yml) file):

```

- run: python -m pip install --upgrade packaging pip setuptools

```