node-midi 技术文档

1. 安装指南

系统要求

OSX

• Xcode（或 Command Line Tools）
• Python（用于 node-gyp）

Windows

• Microsoft Visual C++（Express 版本也可以）
• Python（用于 node-gyp）

Linux

• C++ 编译器
• 必须安装并配置 ALSA。没有它，模块将无法构建。
• 安装 libasound2-dev 包。
• Python（用于 node-gyp）

安装步骤

使用 npm 安装

$ npm install midi

从源码安装

$ git clone https://github.com/justinlatimer/node-midi.git
$ cd node-midi/
$ npm install

2. 项目使用说明

MIDI 消息

该库处理 MIDI 消息的方式是将它们作为 JS 数组进行输入和输出。例如，[144,69,127] 是一个 MIDI 消息，状态码为 144，表示“通道 1”上的“音符开”。

输入

const midi = require('midi');

// 设置一个新的输入
const input = new midi.Input();

// 获取可用输入端口的数量
input.getPortCount();

// 获取指定输入端口的名称
input.getPortName(0);

// 配置回调函数
input.on('message', (deltaTime, message) => {
  // 消息是一个对应 MIDI 字节的数字数组：
  //   [状态, 数据1, 数据2]
  console.log(`m: ${message} d: ${deltaTime}`);
});

// 打开第一个可用输入端口
input.openPort(0);

// 默认情况下，系统专有消息、定时消息和活动感应消息会被忽略。
// 要启用这些消息类型，请在函数中为相应类型传递 false。
// 顺序：(系统专有, 定时, 活动感应)
input.ignoreTypes(false, false, false);

// ... 接收 MIDI 消息 ...

// 关闭端口
setTimeout(function() {
  input.closePort();
}, 100000);

输出

const midi = require('midi');

// 设置一个新的输出
const output = new midi.Output();

// 获取可用输出端口的数量
output.getPortCount();

// 获取指定输出端口的名称
output.getPortName(0);

// 打开第一个可用输出端口
output.openPort(0);

// 发送 MIDI 消息
output.sendMessage([176,22,1]);

// 关闭端口
output.closePort();

虚拟端口

在 Mac OS X 和 Linux（带有 ALSA）上，您可以创建一个虚拟设备，而不是打开到现有 MIDI 设备的连接。这可以通过调用 openVirtualPort(portName) 而不是 openPort(portNumber) 来实现。

const midi = require('midi');

// 设置一个新的输入
const input = new midi.Input();

// 配置回调函数
input.on('message', (deltaTime, message) => {
    console.log(`m: ${message} d: ${deltaTime}`);
});

// 创建一个虚拟输入端口
input.openVirtualPort("Test Input");

// 一个名为 "Test Input" 的 MIDI 设备现在可供其他软件发送消息。

// ... 接收 MIDI 消息 ...

// 关闭端口
input.closePort();

流

您还可以将此库与流一起使用！以下是接口示例：

可读流

// 创建一个可读流
const stream1 = midi.createReadStream();

// createReadStream 还接受一个可选的 `input` 参数
const input = new midi.Input();
input.openVirtualPort('hello world');

const stream2 = midi.createReadStream(input)

stream2.pipe(require('fs').createWriteStream('something.bin'));

可写流

// 创建一个可写流
const stream1 = midi.createWriteStream();

// createWriteStream 还接受一个可选的 `output` 参数
const output = new midi.Output();
output.openVirtualPort('hello again');

const stream2 = midi.createWriteStream(output);

require('fs').createReadStream('something.bin').pipe(stream2);

3. 项目 API 使用文档

输入 API

• new midi.Input(): 创建一个新的 MIDI 输入实例。
• input.getPortCount(): 获取可用输入端口的数量。
• input.getPortName(portNumber): 获取指定输入端口的名称。
• input.on('message', callback): 设置 MIDI 消息的回调函数。
• input.openPort(portNumber): 打开指定输入端口。
• input.ignoreTypes(sysex, timing, activeSensing): 设置忽略的消息类型。
• input.closePort(): 关闭输入端口。

输出 API

• new midi.Output(): 创建一个新的 MIDI 输出实例。
• output.getPortCount(): 获取可用输出端口的数量。
• output.getPortName(portNumber): 获取指定输出端口的名称。
• output.openPort(portNumber): 打开指定输出端口。
• output.sendMessage(message): 发送 MIDI 消息。
• output.closePort(): 关闭输出端口。

虚拟端口 API

• input.openVirtualPort(portName): 创建一个虚拟输入端口。
• output.openVirtualPort(portName): 创建一个虚拟输出端口。

流 API

• midi.createReadStream(input): 创建一个可读流。
• midi.createWriteStream(output): 创建一个可写流。

4. 项目安装方式

使用 npm 安装

$ npm install midi

从源码安装

$ git clone https://github.com/justinlatimer/node-midi.git
$ cd node-midi/
$ npm install