RPi 3 で 'amidi' の MIDI ダンプをパイプで受け取るとMIDIシーケンスが１つ前のものになる

Question

TL;DR（概要）

RaspberryPi 3 に MIDI キーボードをつなげ、受け取った MIDI シーケンスデータが、 $ amidi --port="hw:1,0,0" --dump で表示される内容と、$ amidi --port="hw:1,0,0" --dump | php sample.php でパイプでプログラムに渡された内容が異なる。

押下／押上の結果

続けて「ド・レ・レ」と弾いた場合の信号の違いは以下の通りです。
「Dump RAW」は $ amidi --port="hw:1,0,0" --dump の値、「パイプ経由」は $ amidi --port="hw:1,0,0" --dump | php sample.php で標準入力をおうむ返しした値です。

ノート番号	操作	Dump RAW	パイプ経由
3C	押下↓	90 3C 33	80 3C 00
3C	押上↑	80 3C 00	90 3C 74
3E	押下↓	90 3E 42	80 3C 00
3E	押上↑	80 3E 00	90 3E 24
3E	押下↓	90 3E 2C	80 3E 00
3E	押上↑	80 3E 00	90 3E 64

備考

• MIDIチャンネル「0」
• 押下 = 9x xx xx（ノート・オン）
• 押上 = 8x xx xx（ノート・オフ）
• ド = 真ん中のC（3C）
• レ = 真ん中のD（3E）
• ３バイト目の値はベロシティなので00以外は毎回ランダム

パイプで受け取るプログラム例（PHP）

<?php
/* sample.php */
while (true) {
    $input = trim(fgets(STDIN));
    echo $input . PHP_EOL;
}

問題点

上記「Dump RAW」（$ amidi --port="hw:1,0,0" --dump でダンプした値）は正常に表示されているのですが、それをパイプでプログラムに渡すとズレが発生します。

他に試したこと

$ mkfifo pipemidi で名前付きパイプを作成し、$ amidi --port="hw:1,0,0" --dump > pipemidi と別ターミナルから $ cat pipemidi で正常に受け取れることを確認後、sample.phpを以下のように変更しましたが、同じズレが発生しました。

<?php

$path_file_pipe_midi = './pipemidi';

if(! file_exists($path_file_pipe_midi)){
    die('Can not read file.');
}

$file = new NoRewindIterator( new SplFileObject($path_file_pipe_midi, 'r') );

$file->setFlags(SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE);

foreach ($file as $n => $line) {
    if (false === $line) continue;
    echo "$n $line", PHP_EOL;
}

環境/条件

ビット長

• 1 アクションで受け取るMIDIデータ = 3バイト FF FF FF

ビットマスク

項目	ビットマスク
キー Down/Up	F0 00 00
MIDI チャンネル	0F 00 00
ノート番号	00 FF 00
ベロシティー	00 00 FF

MIDIデータの値

項目	値
MIDI チャンネル	0（Ch0）
ノート	C3 = 真ん中のド（60=0xC3）
ノート	3E = 真ん中のレ（62=0x3E）
押下アクション	8x xx xx9x xx xx
押上アクション	9x xx xx8x xx xx

検証環境

項目	内容
本体	RaspberryPi3 B
MIDI キーボード	AKAI MPKmini MK2
MIDI 接続	USB ケーブル直結
SSH 接続	WiFi 経由
PHP	v7.0.27-0+deb9u1 (cli)
MIDI ポート（$ amidi -l）	IO hw:1,0,0 MPKmini2 MIDI 1
$amidi --version	v1.0.28
OS	Jessie, ヘッドレス
$ lsb_release -a	（以下を参照）
	No LSB modules are available.
Distributor ID:	Raspbian
Description:	Raspbian GNU/Linux 8.0 (jessie)
Release:	8.0
Codename:	jessie

Comments

[miiika]

的外れでしたらごめんなさい。一つ目のコードについてですが、trimを外してみてください。 あるいは、echoしている個所で`.`ではなく`,`にしてみてください。おそらくphpの問題だと思いますので、phpのタグをつけたらよろしいかと思います。

[KEINOS]

ご指摘の２点と PHP 以外で シェル・スクリプトでも試してみましたが、いずれもズレは発生しました。ただ、「trimを外して」みたところ、意図しない改行が入っていることに気づきました！もしかすると制御コード系の問題かもしれないので、もう少し検証して原因をしぼったら質問を修正したいと思います！ありがとうございます！

[miiika]

進展があったようで何よりです。

Answer 1

解決しました。

信号が１つズレた原因は amidi の仕様で改行コードが出力されるタイミングでした。

TL;DR

amidi のダンプデータは、1 アクションごとに出力する MIDI シーケンスの先頭に改行コードが付いてきます。そのため、1 アクションを検知（判断）するのは EOL や \n などの改行コードではなく読み込んだバイト数（９バイト）で判断する必要があります。

TS;DR

MIDI キーボードのキーやパッドを押すと「90 3C 16」といった３バイトの MIDI 信号（シーケンス・データ）が流れてきますが、厳密には「\n90 3c 16」という９バイトの文字列データです。ここで注意すべきは**「\n」の改行コードが先頭に付いている**ことです。

つまり「[データ1]\n [データ2]\n ...」と１アクションごとに改行が後に付いていると思い込んでいたことが原因です。実際には「\n[データ1] \n[データ2] ...」ということです。

このことから、「パイプ渡しによる標準入力」だけでなく「名前付きパイプによるファイル読み込み」であっても、データを読み込む際に１行ごとに読み込みながら処理する場合は注意が必要です。

単純に改行ごとに処理をしてしまうと、１発目のアクションは先頭の改行コードのせいで「空」になり、２発目のアクションで１発目のデータが流れてくることになります。これが１アクションズレる原因でした。

そのため、プログラム言語を問わず、「標準入力」もしくは（名前付きパイプ経由の）「ファイル読み込み」であっても、データを読み込む時は９バイトを境に読み込みを区切る必要があります。

区切りを9バイトにしたのは、私の MIDI 機器（AKAI MPKmini MK2）がどのキーやパッドを操作しても９バイトの固定長だったためです。

\n90 3c 16 → \n 9 0 3 C 1 6 = 9 バイト長

改行区切りで読み込み、一時的に変数に入れるなどバッファをさせる方法も考えました。しかし、9バイト以上のデータ（シーケンスのダンプなど）が流れる可能性がない限り、リアルタイム処理の場合はバイト長で区切った方が処理が速そうです。

パイプ渡しで確認する例

<?php
// sample.php
while(true){
    $input = trim(fgets(STDIN, 9)); //9バイト区切りで読み込む
    echo  $input ? $input . PHP_EOL : '';
}

$ #実行
$ $ amidi --port="hw:1,0,0" --dump | php sample.php

名前付きパイプで確認する例

２つのターミナル・ウィンドウを開いて試してください。

各々のウィンドウで下記コマンドを打ったのち、MIDI キーボードで操作すると、ウィンドウ２にもダンプデータが流れてきます。

この時、一発目の操作で空行が入ることと、カーソルが行末に来たままであることに注目してください。

$ # ウィンドウ1の作業内奥
$ # MIDI ポートの確認
$ amidi -l
Dir Device    Name
IO  hw:1,0,0  MPKmini2 MIDI 1
$ # 名前付きパイプの作成
$ mkfifo dump
$ # MIDI信号のダンプを作成した名前付きパイプに書き込みつつ表示
$ amidi --port="hw:1,0,0" --dump | tee dump

$ # ウィンドウ2の作業内容
$ # dump ファイルの中身を表示する
$ cat dump

MIDI シーケンスの誤記

なお、質問時の MIDI キーボード押下時および押上時の MIDI シーケンスが間違っていました。正しくは以下です。

操作	値	備考
押下	9x xx xx	シグナル・オン（9nH）
押上	8x xx xx	シグナル・オフ（8nH）