ファミコンエミュレータに挑戦してみた

##
- 背景がスクロールできるように改良
- スプライトが透過され背景が表示されるように改良

-----
## はじめに

- 「 [ファミコンエミュレーターの創り方　- Hello, World!編 -](https://qiita.com/bokuweb/items/1575337bef44ae82f4d3)」の続きを作ろうとしたら思いの外苦戦した

- なのでHello, World!以降の第1歩となる資料の作成を試みた

- まだリアルなファミコンのソフトを実行するところまでできていない(間に合わなかった)
- 手厚く開発のサポートしてくれた[bokuweb](https://twitter.com/bokuweb17)氏にこの場を借りて感謝したい


-----
## 何故ファミコンエミュレーター

<b>CPUなど処理装置の学習がしたかったから</b>

- [CPUの創りかた](https://www.amazon.co.jp/CPU%E3%81%AE%E5%89%B5%E3%82%8A%E3%81%8B%E3%81%9F-%E6%B8%A1%E6%B3%A2-%E9%83%81/dp/4839909865)という本を読んだ

- 試しに[CPUのエミュレーター](https://github.com/rchaser53/TD4-cpu-emulater)をJavaScriptで作成してみた
- 勉強にはなったがやれることが少なくて物足りない(タイマーくらいしか使えない)
- サンプルの多い練習台はないか
- ファミコンエミュレーター(NES)があるじゃないか

-----
## 内容

<b>落とし穴になりそうなあたりを説明</b>

- [bokuweb氏のブログ](http://blog.bokuweb.me/entry/nes)の通り[ｷﾞｺ猫でもわかるファミコンプログラミング](http://gikofami.fc2web.com/)をやっていけばHello Worldの後は基本的には良さそう
- でも書かれている資料だけでは大量に存在する落とし穴を回避できない
- なので落とし穴を回避するために補足の資料を書こうと思った


-----
## nesファイルの作成

- [ｷﾞｺ猫でもわかるファミコンプログラミング](http://gikofami.fc2web.com/)はasmファイルしか提供してくれない
- NESASM.EXEが入っているがWindows専用
- [nesasm](https://github.com/thentenaar/nesasm)をビルドすればmacやunix環境用のnesasmが作成できる
(macなら特に何も考えずにmake叩けばOK)

<b>思ったより簡単</b>

-----
## colorの定義はどこにある?

- 背景のパレットやスプライトのパレットで指定されるやつ
- ファミコンの基盤によって微妙に違うらしい
- とりあえず筆者は[NES HACKER](http://www.thealmightyguru.com/Games/Hacking/Wiki/index.php/NES_Palette)に乗っているcolorの情報を使っている

-----
## paletteのミラー

- 色情報を指定するpaletteは背景用(16byte)とスプライト用(16byte)の2種類が存在する
- スプライト用のアドレスの一部が背景のアドレスのミラーになっている(同一のデータになっている)
- 背景のアドレスの一部もまた別の背景のアドレスのミラーになっている
- 筆者は[NES Palette Tricks](https://ahefner.livejournal.com/11670.html)を参照した

-----
## paletteのミラー(例)
スプライトの画像情報を作成する処理

```javascript
  createSpliteDrawInfo(spriteIndex, upperColorBits, attribute) {
    const sprite = createSpriteInputs(this.characteSpriteData[spriteIndex])
    const retSprites = createBaseArrays()
    const { startTop, startLeft, useBackground } = this.culculateAttribute(attribute)

    for (let row = 0; row < 8; row++) {
      for (let column = 0; column < 8; column++) {
        const actualRow = startTop ? row : 7 - row
        const actualColumn = startLeft ? 7 - column : column

        const paletteIndex = (upperColorBits << 2) | sprite[row][column]
        // 特定のアドレスを参照する際、スプライトのパレットではなく背景のパレットを参照する
        const shouldUseBackground = (useBackground || paletteIndex === 0x00 || paletteIndex === 0x04 || paletteIndex === 0x08 || paletteIndex === 0x0c);

        retSprites[actualRow][actualColumn] = shouldUseBackground
                                                ? this.backgroundPalette[paletteIndex]
                                                : this.spritePalette[paletteIndex]
      }
    }
    return retSprites
  }


```

-----
## paletteのミラー(例)
背景の画像情報を作成する処理

```javascript
  createBackgroundSprite(characterIndex, nameIndex) {
    const { row, column } = convertIndexToRowColumn(nameIndex)
    const sprite = createSpriteInputs(this.characteSpriteData[characterIndex])

    return sprite.map((elem) => {
      return elem
        .map((num) => {
          const base = (this.colorTileBuffer[row][column] << 2) | num

          // アドレスが0x04 or 0x08 or 0x0cの時、 0x00の値を返す
          const paletteIndex = base === 0x04 || base === 0x08 || base === 0x0c ? 0x00 : base
          return this.backgroundPalette[paletteIndex]
        })
        .reverse()
    })
  }
```

-----
## 適当に作ると思ったより遅い

- putImageDataなどを使いcanvasで描画する回数を減らす
- 可読性は落ちるが可能な限り論理演算で対処する(特にPPUのレジスタが顕著)
- debug用のflagを用意して、trueの場合、どのbitがtrueになっているとか表示するのが妥当そう

<b>60fpsは適当に作ると出ない</b>

-----
## レジスタだけ管理すれば動くという訳ではない

- 当たり前と言えば当たり前の話
- nmiの割り込みなどregisterだけで全ての状態が管理されている訳ではない(1fpsに1回)
- 筆者はこれに気づかずcpuの1cycleごとに1回nmi割り込みを実行するように１回実装した

<b>実機だとどんな処理をしているかイメージしながら実装すると捗ると思う(多分)</b>

-----
## 実際のとこどうなの?

- 思いの外、雑でも動く
- どんな処理を実際にはやっているのか想像しながら実装できるので学習は進む
- 動くサンプル([flownes](https://github.com/bokuweb/flownes))があるので亀の歩みでも進捗はできる
- 日本語の資料だけではやっぱり不足する([NesDev](http://nesdev.com/)を読もう)
- 想像以上に時間がかかる(完全に注力できたわけではないとは言え、現状まで2ヶ月ほどかかっている)

<b>CPUなどの処理装置の勉強の第２歩目くらいに良いと思う</b>


-----
## レポジトリ

- [cpuエミュレーター](https://github.com/rchaser53/nes-emulator)
- [nes](https://github.com/rchaser53/nes-emulator) (鋭意開発中)

![working2.gif](https://qiita-image-store.s3.amazonaws.com/0/99025/e67edbd2-b756-b254-307c-a7002f57a92a.gif)


-----
## 参考リンク
- [ファミコンエミュレータの創り方　- Hello, World!編 -](https://qiita.com/bokuweb/items/1575337bef44ae82f4d3#%E3%83%AC%E3%82%B8%E3%82%B9%E3%82%BF) およびそこに書かれている参考リンク
- [NES Palette Tricks](https://ahefner.livejournal.com/11670.html)
- [nesasm](https://github.com/thentenaar/nesasm)
- [NES HACKER](http://www.thealmightyguru.com/Games/Hacking/Wiki/index.php/NES_Palette)