managed-midi 技术文档

1. 安装指南

1.1 环境要求

• 操作系统: Linux, Mac, Windows (经典和UWP), iOS, Android
• 框架: Mono, .NET Framework, .NET Core

1.2 安装步骤

1. 通过NuGet安装:

   dotnet add package managed-midi
   

2. 手动下载并引用:

   • 从GitHub仓库下载源码或二进制文件。
   • 将Commons.Music.Midi.dll添加到你的项目引用中。

2. 项目的使用说明

2.1 项目概述

managed-midi 是一个跨平台的C#/.NET库，旨在提供对MIDI设备的近乎原始的访问，支持多种平台（Linux, Mac, Windows, iOS, Android），并且支持标准MIDI文件的操作和播放功能。

2.2 主要功能

• MIDI事件处理: 支持MidiEvent, MidiMessage, MidiTrack, MidiMusic等类，用于存储和管理MIDI事件、轨道和歌曲。
• 标准MIDI文件读写: 提供SmfReader和SmfWriter，支持读写标准MIDI文件（SMF）。
• MIDI设备访问: 通过IMidiAccess接口，提供对MIDI输入和输出设备的访问。
• MIDI播放器: 支持播放、暂停、停止和快进功能。
• 虚拟MIDI设备: MidiMachine类用于表示虚拟输出设备，显示当前MIDI设备的状态。

2.3 示例代码

2.3.1 播放音符

using Commons.Music.Midi;

var access = MidiAccessManager.Default;
var output = access.OpenOutputAsync(access.Outputs.Last().Id).Result;
output.Send(new byte [] {0xC0, GeneralMidi.Instruments.AcousticGrandPiano}, 0, 2, 0);
output.Send(new byte [] {MidiEvent.NoteOn, 0x40, 0x70}, 0, 3, 0);
output.Send(new byte [] {MidiEvent.NoteOff, 0x40, 0x70}, 0, 3, 0);
output.CloseAsync();

2.3.2 播放MIDI文件并检测特定事件

using Commons.Music.Midi;

var access = MidiAccessManager.Default;
var output = access.OpenOutputAsync(access.Outputs.Last().Id).Result;
var music = MidiMusic.Read(System.IO.File.OpenRead("mysong.mid"));
var player = new MidiPlayer(music, output);
player.EventReceived += (MidiEvent e) => {
  if (e.EventType == MidiEvent.Program)
    Console.WriteLine ($"Program changed: Channel:{e.Channel} Instrument:{e.Msb}");
  };
player.PlayAsync();
Console.WriteLine("Type [CR] to stop.");
Console.ReadLine();
player.Dispose();

3. 项目API使用文档

3.1 主要API接口

• MidiAccessManager: 提供默认的MIDI访问管理器。
• IMidiAccess: 用于创建IMidiInput和IMidiOutput通道，访问MIDI设备。
• MidiPlayer: 提供MIDI播放功能，支持播放、暂停、停止和快进。
• SmfReader/SmfWriter: 用于读写标准MIDI文件。

3.2 API稳定性

• API仍在不断变化中，可能会出现不兼容的更改。
• 未来将遵循语义化版本控制2.0.0规范。

4. 项目安装方式

4.1 通过NuGet安装

dotnet add package managed-midi

4.2 手动安装

1. 下载项目源码或二进制文件。
2. 将Commons.Music.Midi.dll添加到你的项目引用中。

4.3 平台特定实现

• Linux: 默认使用ALSA，支持portmidi和rtmidi。
• Mac: 默认使用CoreMIDI，支持portmidi和rtmidi。
• Windows: 默认使用WinMM，支持portmidi和rtmidi。
• Android: 使用Android MIDI API。
• iOS: 使用Microsoft.iOS CoreMIDI。

通过以上文档，用户可以快速了解并使用managed-midi项目，进行MIDI设备的访问和操作。