Java MIDIの心臓部を探る：javax.sound.midi.spi 詳細解説

第1章: `javax.sound.midi.spi`とは何か？ – 拡張性のための鍵

JavaでMIDI（Musical Instrument Digital Interface）を扱う際、多くの開発者はjavax.sound.midiパッケージを利用します。このパッケージは、MIDIシーケンスの再生やMIDIメッセージの送受信といった、アプリケーションレベルでの機能を提供します。しかし、Java Sound API（JSA）の真の力は、その拡張性にあります。その拡張性を支える屋台骨こそが、`javax.sound.midi.spi`パッケージです。

SPIは「Service Provider Interface」の略称です。これは、API（Application Programming Interface）とは対照的な概念です。

つまり、javax.sound.midi.spiは、Javaの標準MIDI機能だけではサポートされていない、サードパーティ製のハードウェアMIDIデバイス、ソフトウェアシンセサイザー、あるいは独自のファイル形式などをJava Sound環境に動的に組み込むための「接続口」を提供するものです。

この仕組みのおかげで、アプリケーションのコードを一切変更することなく、新しいMIDI機能をプラグインのように追加できます。例えば、あるメーカーが新しいUSB-MIDIキーボードを開発したとします。そのメーカーはjavax.sound.midi.spiに準拠したドライバ（サービスプロバイダ）を提供することで、Javaアプリケーションはそのキーボードを標準のMIDIデバイスとして認識し、利用できるようになるのです。

第2章: SPIの心臓部 – サービスプロバイダの登録メカニズム

では、Javaはどのようにしてこれらのカスタムサービスプロバイダを見つけ出すのでしょうか。その秘密は、Javaプラットフォームに標準で備わっている`ServiceLoader`という仕組みにあります。そして、この仕組みを利用するための規約が、`META-INF/services`ディレクトリです。

サービスプロバイダをJavaアプリケーションに認識させるための手順は、以下の通りです。

1. SPIの抽象クラス（例: MidiDeviceProvider）を継承した、具体的な機能を持つクラスを作成します。
2. プロジェクトのソースフォルダ内に、META-INF/services/という名前のディレクトリを作成します。
3. そのディレクトリ内に、提供したいサービスのSPIクラスの完全修飾名をファイル名として持つファイルを作成します。例えば、MIDIデバイスを提供する場合、ファイル名はjavax.sound.midi.spi.MidiDeviceProviderとなります。
4. 作成したファイルの中に、ステップ1で作成した実装クラスの完全修飾名を1行記述します。複数の実装クラスがある場合は、改行して記述します。
5. これらのクラスファイルとMETA-INFディレクトリをJARファイルにパッケージングします。

このJARファイルをアプリケーションのクラスパスに含めるだけで、MidiSystemなどのJava Sound APIがサービスを必要とするとき、ServiceLoaderが自動的にクラスパス上の全JARファイルをスキャンし、META-INF/services内の定義ファイルを読み込みます。そして、そこに記述されている実装クラスをロードして利用するのです。

my-custom-midi.jar
|
+-- com/example/midi/
|   |
|   +-- MyCustomMidiDeviceProvider.class
|   +-- MyCustomMidiDevice.class
|
+-- META-INF/
    |
    +-- services/
        |
        +-- javax.sound.midi.spi.MidiDeviceProvider
          

# MyCustomMidiDeviceProvider の完全修飾名を記述
com.example.midi.MyCustomMidiDeviceProvider
          

第3章: 主要な抽象クラスの解説と実装例

`javax.sound.midi.spi`パッケージには、主に4つの抽象クラスが用意されています。これらを継承し、独自のロジックを実装することがサービスプロバイダ開発の核となります。

import javax.sound.midi.*;
import javax.sound.midi.spi.MidiDeviceProvider;
import java.util.List;

// 仮想的なログ出力デバイスの実装
class LoggingMidiDevice extends AbstractMidiDevice {
    private final Info info;

    protected LoggingMidiDevice(Info info) {
        this.info = info;
    }

    @Override
    public Info getDeviceInfo() {
        return info;
    }
    
    @Override
    public Receiver getReceiver() throws MidiUnavailableException {
        return new LoggingReceiver();
    }
    
    // 他のメソッドは空実装 or 例外スロー
    @Override
    public List<Transmitter> getTransmitters() { return List.of(); }
    @Override
    public Transmitter getTransmitter() throws MidiUnavailableException {
        throw new MidiUnavailableException("Transmitter not supported");
    }
    @Override
    protected void implOpen() { /* 何もしない */ }
    @Override
    protected void implClose() { /* 何もしない */ }

    private static class LoggingReceiver implements Receiver {
        @Override
        public void send(MidiMessage message, long timeStamp) {
            System.out.printf("[%d] Received MIDI message: Status=%d, Data1=%d, Data2=%d%n",
                timeStamp, message.getStatus(), message.getMessage(), message.getMessage());
        }
        @Override
        public void close() { /* 何もしない */ }
    }
}

// MidiDeviceProviderの実装
public class LoggingMidiDeviceProvider extends MidiDeviceProvider {
    private static final MidiDevice.Info INFO = new MidiDevice.Info(
        "Logging MIDI Device", "MyCompany", "A virtual device that logs MIDI messages.", "1.0") {};

    @Override
    public MidiDevice.Info[] getDeviceInfo() {
        return new MidiDevice.Info[] { INFO };
    }

    @Override
    public MidiDevice getDevice(MidiDevice.Info info) {
        if (info.equals(INFO)) {
            return new LoggingMidiDevice(info);
        }
        throw new IllegalArgumentException("Device not supported: " + info);
    }
}
            

import javax.sound.midi.*;
import javax.sound.midi.spi.MidiFileReader;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import javax.sound.midi.InvalidMidiDataException;

// 架空のカスタムフォーマット(.myseq)を読み込むリーダー
public class MySequenceFileReader extends MidiFileReader {

    // カスタムフォーマットのマジックナンバー
    private static final byte[] MAGIC_NUMBER = {'M', 'Y', 'S', 'Q'};

    @Override
    public MidiFileFormat getMidiFileFormat(InputStream stream) throws InvalidMidiDataException, IOException {
        // streamを調べて、ヘッダー情報からMidiFileFormatを構築する
        // (ここでは簡略化)
        if (!isMySequenceFile(stream)) {
            throw new InvalidMidiDataException("Not a MySequence file");
        }
        // ... パース処理 ...
        return new MidiFileFormat(1, 480, 10, 12000, 100);
    }

    @Override
    public Sequence getSequence(InputStream stream) throws InvalidMidiDataException, IOException {
        // streamからデータを読み込み、Sequenceオブジェクトを構築する
        // (ここでは簡略化)
        if (!isMySequenceFile(stream)) {
            throw new InvalidMidiDataException("Not a MySequence file");
        }
        Sequence sequence = new Sequence(Sequence.PPQ, 480);
        // ... パースしてTrackとMidiEventを追加する処理 ...
        return sequence;
    }

    // 他のオーバーロードメソッド(File, URL)も同様に実装する
    @Override
    public MidiFileFormat getMidiFileFormat(File file) throws InvalidMidiDataException, IOException { /* ... */ return null; }
    @Override
    public Sequence getSequence(File file) throws InvalidMidiDataException, IOException { /* ... */ return null; }

    private boolean isMySequenceFile(InputStream stream) throws IOException {
        // 先頭4バイトがマジックナンバーと一致するか確認
        stream.mark(4);
        byte[] header = new byte;
        int bytesRead = stream.read(header);
        stream.reset();
        return bytesRead == 4 && java.util.Arrays.equals(header, MAGIC_NUMBER);
    }
}
            

第4章: 総合的な実装と利用の流れ

これまでに解説した各SPIクラスを実装し、実際にアプリケーションから利用するまでの一連の流れをまとめます。

ステップ1: SPI実装クラスの作成

第3章で示したような、MidiDeviceProviderなどの抽象クラスを継承した具象クラス（例: com.example.midi.LoggingMidiDeviceProvider）を作成します。

ステップ2: `META-INF/services` ファイルの作成

ソースディレクトリにMETA-INF/services/ディレクトリを作成し、その中に提供するサービスに対応するファイルを作成します。

ファイル名: javax.sound.midi.spi.MidiDeviceProvider
ファイル内容:

com.example.midi.LoggingMidiDeviceProvider

ステップ3: JARファイルの作成

コンパイルしたクラスファイルとMETA-INFディレクトリをまとめて、JAR（Java Archive）ファイルを作成します。

# コンパイル済みのクラスファイルがあるディレクトリに移動
cd build/classes/java/main

# JARファイルを作成
jar cvf custom-midi-provider.jar com/ META-INF/
        

ステップ4: 利用側アプリケーションでの確認

作成したJARファイル（custom-midi-provider.jar）をクラスパスに含めて、Javaアプリケーションを実行します。特別なコードは必要ありません。MidiSystemが自動的に新しいプロバイダを認識します。

import javax.sound.midi.*;

public class MidiSpiTest {
    public static void main(String[] args) {
        System.out.println("Available MIDI Devices:");
        MidiDevice.Info[] infos = MidiSystem.getMidiDeviceInfo();

        if (infos.length == 0) {
            System.out.println("No MIDI devices found.");
        } else {
            for (MidiDevice.Info info : infos) {
                System.out.println("--------------------");
                System.out.println("Name: " + info.getName());
                System.out.println("Vendor: " + info.getVendor());
                System.out.println("Description: " + info.getDescription());
                System.out.println("Version: " + info.getVersion());

                // もし我々のカスタムデバイスが見つかったら、使ってみる
                if (info.getName().equals("Logging MIDI Device")) {
                    try {
                        MidiDevice device = MidiSystem.getMidiDevice(info);
                        device.open();
                        System.out.println("Logging MIDI Device opened successfully.");
                        Receiver receiver = device.getReceiver();
                        
                        // テスト用のノートオンメッセージを送信
                        ShortMessage msg = new ShortMessage();
                        msg.setMessage(ShortMessage.NOTE_ON, 0, 60, 100); // チャンネル1, C4, Velocity 100
                        receiver.send(msg, -1);
                        
                        device.close();
                    } catch (MidiUnavailableException | InvalidMidiDataException e) {
                        e.printStackTrace();
                    }
                }
            }
        }
    }
}
        

このプログラムを、作成したJARファイルをクラスパスに加えて実行すると、コンソールに「Logging MIDI Device」が表示され、実際にログが出力されることが確認できるはずです。

# JARをクラスパスに含めて実行
java -cp ".:custom-midi-provider.jar" MidiSpiTest
        

第5章: `javax.sound.midi.spi` を扱う上での注意点

SPIを実装する際には、アプリケーション全体の安定性やパフォーマンスに影響を与えないよう、いくつかの点に注意する必要があります。

まとめ