(WIP)もはやRustだけで曲作れるから

己の🦀を磨け

## 注

別にシンセやらドラムやらは一切出てきません 強いて言うならメロディです
いきあたりばったりな実装なので[参考サイト](https://qiita.com/raiga0310/private/d5aa7cdb3a75c13cad53#%E5%8F%82%E8%80%83%E3%82%B5%E3%82%A4%E3%83%88)の方から見てやっていくのがいいと思います｡
とりあえず記録として残しておきたかったのでだいぶ適当に書いています｡ そのうち書き直しと勉強してもう少しわかりやすい内容に更新する予定です｡

## 作ったもの

<!-- ここに動画が入る -->

https://twitter.com/ahoxa1rx/status/1689586228289806336

下手なのは許してください

## 経緯

あるLTにてゲームを作った人がいたので`bevy`いじりがてら作ってみるかと至った次第です｡
めっちゃいい内容なので皆さん見てください

https://speakerdeck.com/shunshobon/rustdedui-zhan-xing-tetriswozuo-tutahua

## bevy､ECSについて

Bevyとは､Rust製のゲームエンジンで､Rustでゲーム開発をするのであればこれでなんとかなる場合が多いと思います｡
別にWebAssemblyでゲーム開発をすることもできますが､Assetも多いですし､様々な作成例が公開されたコードとともに転がっているのでBevyがおすすめです｡

Bevyでのゲーム開発は､ECSと呼ばれる設計パターンに基づいて実装していきます｡
一昔一世を風靡したオブジェクト指向のような継承ではなく､コンポジションを用いることにより､複雑な依存性を管理することなく開発を行うことができるので､データ指向の設計と相性がいいです
~~ほぼ受け売りなので各自調べていただけると幸いです~~

## ざっくり作り方

何かしらのオブジェクトを作りたい場合､Bundleを使用して`.spawn(Bundle {})`です

### 画面(初期状態)を作る

```rust
pub fn game_setup(mut commands: Commands) {
    println!("Game Setup");

    commands.spawn((
        Camera3dBundle {
            transform: Transform::from_xyz(20.0, 0.0, 50.0)
                .looking_at(Vec3::new(10.0, 5.0, 0.0), Vec3::Y),

            ..Default::default()
        },
        ThirdPersonCamera,
    ));

    commands.spawn(PointLightBundle {
        point_light: PointLight {
            intensity: 5000.0,
            shadows_enabled: true,
            ..default()
        },
        transform: Transform::from_xyz(-3.0, 0.0, 10.0),
        ..default()
    });
}
```

今回は3Dゲームなので､オブジェクトの表示のために`Camera3dBundle`､`PointLightBundle`を用います｡Unityの最初の画面みたいなもんだと思います｡(エアプ)
数値に関しては視点やら光源の位置角度を指定するものですが､これはなんども調整しながら作ったので苦労しました｡

### オブジェクトを作る

ピアノの鍵盤をつくります｡直方体ですが､それぞれ黒鍵･白鍵か､何番目なのか､などの情報を構造体で保持します｡構造体はECSに基づいて`#[derive(Component)]`しておいてデータのやり取りをしましょう｡

```rust
            commands.spawn((
                PianoKey(index, PianoKeyType::White),
                PianoKeyId(index),
                PianoKeyType::White,
                PbrBundle {
                    mesh: meshes.add(Mesh::from(shape::Box::new(
                        WHITE_KEY_WIDTH,
                        WHITE_KEY_HEIGHT,
                        WHITE_KEY_DEPTH,
                    ))),
                    material: materials.add(Color::WHITE.into()),
                    transform: Transform::from_xyz(position_x, 0.0, 0.0),
                    ..default()
                },
            ));
```

`PbrBundle`は､`Phycical Base Rendering`のPBRで､`bevy`では`mesh`と`material`で構成されるオブジェクトのことを指します｡ここでは直方体を生成したいので､`Mesh::from(shape::Box::new())`を用いて生成しています｡

### 押された鍵盤をハイライトする
### イベントを起こす

音を鳴らすときに､ピアノのオブジェクトからイベントを通知するために`PianoKeyInputEvent`を定義
`#[derive(Event)]`でイベント構造体に出来､発火したい場所で`send()`しましょう

```rust
    for key in key_events.iter() {
        for (entity, key_id_component, key_type) in &key_entityies {
            let PianoKeyId(key_id) = key_id_component;
            if key.key_code == Some(KEBOARD_MAPPING[*key_id]) {
                if let Ok(handle) = key_materials.get_mut(entity) {
                    if let Some(material) = materials.get_mut(&handle) {
                        let color: Color;
                        match key.state {
                            ButtonState::Pressed => {
                                color = Color::BLUE;
                                note_events.send(PianoKeyInputEvent {
                                    key_id: *key_id,
                                    key_state: ButtonState::Pressed,
                                });
                            }
                            ButtonState::Released => {
                                color = if key_type == &PianoKeyType::Black {
                                    Color::BLACK
                                } else {
                                    Color::WHITE
                                };
                                note_events.send(PianoKeyInputEvent {
                                    key_id: *key_id,
                                    key_state: ButtonState::Released,
                                });
                            }
                        };
                        material.base_color = color;
                    }
                }
            }
        }
    }
```


### 音を出す

```rust
    // play the sound
    for event in note_events.iter() {
        match event.key_state {
            ButtonState::Pressed => {
                let truck = trucks.trucks.get(&event.key_id).unwrap();
                let truck_handle = truck.clone_weak();
                let truck_handle = truck_handle;
                audio.play(truck_handle);
            }
            ButtonState::Released => {}
        }
    }
```

打鍵に反応して音がなるようにしています｡

## 今後の展望

+ 今のところ音源をアセットとして提供しているので､自分で音を録って来ている → 鍵盤数から周波数を割り当てて自動でアセットが生成できるようにしたい
+ MIDIの動画でよくある鳴らした鍵盤から物体を出したい

## 余談: 数式を用いてピアノっぽい音をつくる

波といえば(数多くの音声処理ライブラリにおいて)正弦波が最も扱いやすいのですが､楽器として出る音が正弦波では味気ないので､数式でピアノの音を再現します｡

```rust
    let mut y = 0.0;
    let a = 0.6 * (freq * t * 2.0 * PI as f32).sin() * (-0.0015 * freq * t).exp();
    let b = a + 0.4 * (2.0 * freq * t * 2.0 * PI as f32).sin() * (-0.0015 * freq * t).exp();
    let c = b.powi(3);
    y += c * (1.0 + 16.0 * t * (-6.0 * t).exp());
    
    (y * 0.5 + 0.5).try_into().unwrap()
```

![tone_math.gif](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/606626/757e6ca3-17bc-7660-0812-c04c73f18b6d.gif)

## おまけ: Unwelcome School冒頭の歌詞

```
n   ,   ;  / h

n  ,  .  ,  ;  ; /

w 2 q  ; . , m j m , . ; /    c

n   ,   ;  / h

n  ,  .  ,  ;  ; /

w 2 q ; / q 2 w 3 3 e e r
```

楽譜も何もかも分からずにメモしただけなので適当です｡

## GitHub

https://github.com/raiga0310/midi-bevy

## 参考サイト

bevyは頻繁にアップデートにより推奨･非推奨のものが移り変わるので､**必ず最新のバージョンを参照してください｡**

+ 3Dオブジェクトの生成関連はこのリポジトリにお世話になりました バージョンが最新ではないのですこし非推奨の関数が混じっているので参考する際には注意してください｡
+ ここではMIDI機器がある前提なので音の再生やらキーイベントの取得は自分で考えることになったのでいい勉強になりました｡
 
https://github.com/whoisryosuke/bevy-midi-playground

+ 効果音扱いなので再生周りのイベント発火はExampleをもとにしました｡

https://github.com/bevyengine/bevy/blob/8ba9571eedada4f3ff43cdf1402670b7fe7c280d/examples/games/breakout.rs

+ Unwelcome Schoolの音はここみて頑張りました｡

https://youtu.be/CXPXmOHVQ_I

+ ピアノの数式も自分でできたら良かったのですが､早く音が鳴らしたかったので先人の知恵をお借りしました

https://www.youtube.com/watch?v=ogFAHvYatWs

### Bevy系

Rustは全体的に役に立つソースが少ないですが､それでも公式ドキュメントの充実度たるやという感じです｡
Bevyに関しては非公式のチートブックもあるので､それも参照しながらやるといい感じに開発できるのでは無いでしょうか

+ https://docs.rs/bevy/0.11.0/bevy/index.html
+ https://docs.rs/bevy_input/0.11.0/bevy_input/index.html
+ https://docs.rs/bevy_ecs/0.11.0/bevy_ecs/index.html
+ https://bevy-cheatbook.github.io/introduction.html