View on GitHub

smf-to-ym2151log-rust

smf-to-ym2151log-rust

smf-to-ym2151log-rust

Japanese English

Standard MIDI Files (SMF) をYM2151レジスタ書き込みログ（JSON形式）に変換するRust実装

WIP

まだドレミを最低限のJSONに変換できる程度です

今後より高度な実装をしていく予定です

破壊的変更を頻繁に行う想定です

用途

ライブラリとして、 cat-play-mml から利用しています

現在の制約

チャンネル割り当て戦略

現在の実装では、和音数ベースの静的チャンネル割り当て戦略とドラムチャンネル優先を使用しています：

1. 和音数分析フェーズ: 変換前に、MIDIファイルを分析し、重複するノートイベントを追跡することで各MIDIチャンネルの最大和音数（同時発音数）を測定します。

2. 和音数に基づく静的割り当て: YM2151チャンネル（0-7、合計8チャンネル）を各MIDIチャンネルの和音数要求に基づいて割り当てます。

3. ドラムチャンネル優先の並び替え: 初期割り当ての後、MIDIチャンネル9（General MIDIドラムチャンネル）が存在する場合、割り当てが並び替えられます：

ボイス管理:

制限事項:

スコープ外:

これらの機能は、シンプルさを保つため、プロジェクトの目標に沿って意図的に省略されています。

概要

smf-to-ym2151log のRust版実装です。 Standard MIDI Files (SMF) をYM2151 FM音源チップのレジスタ書き込みログ（JSON形式）に変換します。

特徴

使い方

インストール

# リポジトリをクローン
git clone https://github.com/cat2151/smf-to-ym2151log-rust.git
cd smf-to-ym2151log-rust

# ビルドとインストール
cargo install --path .

コマンドライン使用

# MIDIファイルの変換
smf-to-ym2151log-rust song.mid

# 出力ファイル:
# - song_events.json  (パスA: デバッグ用中間イベント)
# - song_ym2151.json  (パスB: YM2151レジスタログ)

ライブラリとして使用

他のRustプロジェクトからライブラリとして利用できます：

# Cargo.toml
[dependencies]
smf-to-ym2151log = { git = "https://github.com/cat2151/smf-to-ym2151log-rust" }

詳細なAPIドキュメント: cargo doc --open

出力例

smf-to-ym2151log-rust
Processing: song.mid

Pass A: Parsing MIDI file...
  ✓ Successfully parsed MIDI file
  - Ticks per beat: 480
  - Initial tempo: 120.00 BPM
  - Total events: 4

Saving intermediate events JSON...
  ✓ Saved: song_events.json

Pass B: Converting to YM2151 register log...
  ✓ Successfully converted to YM2151 log
  - Total YM2151 events: 42

Saving YM2151 log JSON...
  ✓ Saved: song_ym2151.json

=== CONVERSION COMPLETE ===

プログラムチェンジ対応

コンバータはMIDIプログラムチェンジイベント（0-127）による音色切り替えに対応しています。プログラムチェンジイベントが検出されると、コンバータは以下の動作をします：

  1. 外部音色ファイルを検索 tones/{program:03}.json （例：プログラム42の場合は tones/042.json）
  2. 音色をロードして適用 ファイルが存在する場合
  3. 内蔵デフォルト音色を使用 ファイルが存在しない場合

カスタム音色ファイル

tones/ ディレクトリにJSONファイルを配置することで、カスタムYM2151音色を作成できます：

tones/
├── 000.json    # プログラム0 (アコースティックグランドピアノ)
├── 001.json    # プログラム1 (ブライトアコースティックピアノ)
├── ...
└── 127.json    # プログラム127 (ガンショット)

各音色ファイルは、FM合成パラメータを設定するためのYM2151レジスタ書き込みを定義します。詳細なフォーマットドキュメントと例については、tones/README.md を参照してください。

使用例

# 1. MIDIプログラム42用のカスタム音色を作成
#    （例：ブラス音）
cat > tones/042.json << EOF
{
  "events": [
    { "time": 0.0, "addr": "0x20", "data": "0xC7" },
    { "time": 0.0, "addr": "0x38", "data": "0x00" },
    ...
  ]
}
EOF

# 2. プログラム42を使用するMIDIファイルを変換
smf-to-ym2151log-rust song.mid

# コンバータはプログラムチェンジでプログラム42が
# 指定されると自動的に tones/042.json を使用します

開発

前提条件

ビルド (Build)

# デバッグビルド
cargo build

# リリースビルド
cargo build --release

テスト

# すべてのテストを実行
cargo test

# 特定のテストを実行
cargo test midi_parser

# テストカバレッジ
cargo tarpaulin --out Html

コード品質 (Code Quality)

# フォーマットチェック
cargo fmt --check

# lintチェック
cargo clippy -- -D warnings

# セキュリティチェック
cargo audit

参照