RustでAPNGのライブラリを作ってみた

## APNG(Animated PNG) is 何？

*Animated PNG*とは、その名の通り、PNGをアニメーション(連番画像)のように表現した画像のことで、PNGフォーマットを拡張してできた画像のファイルフォーマットです。
LINEの動くスタンプなんかは皆さんに馴染み深いのかなって思います。

実際に開発している、ライブラリは以下から飛べるので是非ご意見をいただければと思います。

https://github.com/poccariswet/apng <- 飛んでみてね🏃‍♂️

## メリット of APNG

- 環境がサポートされていなくても、APNGの1フレーム目を普通のPNG画像(静止画)として使用できる。
- 可逆圧縮方式のため、劣化せずにデータを圧縮できる。
- アルファチャンネルもサポートするため、見た目が劣化せずにきれいに見える

上記のようなことがあげられます。

また、逆にデメリットとしては、サポートされているサービス、環境が少ないことです。


## Why Rust???

最近、rustでwasmという[記事](https://medium.com/hackernoon/compiling-rust-to-webassembly-guide-411066a69fde)や、rustの良記事([これ](https://blog.discordapp.com/using-rust-to-scale-elixir-for-11-million-concurrent-users-c6f19fc029d3)とか[これ](https://medium.com/figma-design/rust-in-production-at-figma-e10a0ec31929))を読んで、これやりたい！って思い、rustの勉強をし始めて、その勉強がてら作ろうと思いrustにしました。

#### Why APNG library???
なんで、*APNG* のライブラリかというと、いつも一緒に開発している友人の[dennougorilla](https://twitter.com/dennougorilla)が、[共有した画面をgifにclipするWebアプリ](https://dennougorilla.github.io/glips/)を**dart**作っており、gifか〜じゃあ俺はAPNGのWebアプリを作ろうと言ったような割と適当な動機ですw

Webアプリを作る上でRustでapngのライブラリを探したんですが、自分がこれと言って使いたいライブラリがなく、ないならじゃあ作ろうということで作成しました。ちなみに、ライブラリと言っても、エンコーダーしかまだ対応していないです🙇‍♂️


## 実装

実装していくにあたり、APNG, PNGの必要な知識を[ここ](https://developer.mozilla.org/ja/docs/Animated_PNG_graphics)で吸収しました。実際に構造や手順などが詳細に載っているので興味がある人は読んでみてください😁

以下に簡単に要約を残しておきます。

### APNGの構造
構造自体は[PNG仕様](https://www.w3.org/TR/PNG/)と同様、そこにanimation(連番)を追加するためのチャンクを追加して、フレームデータを規定する。

- acTL(Animation Control チャンク): APNGのフレーム数、ループ回数を定義する。最初の`IDAT`チャンクの前に存在しなければいけない
- fCTL(Frame Control チャンク): 1つのフレームに対しての情報(シーケンス番号やそのフレームを表示する時間)などを定義する。`IDAT`またはfdATチャンクの前に存在する。
- fdAT(Frame Data チャンク): `IDAT`と同じデータチャンク。シーケンス番号が最初に入っている以外は何も変わらない

元々のPNG仕様＋上記の3つのチャンクが*APNG*の構造になります。

図に示すとこんな感じです。

![apng_str](https://i.gyazo.com/4281f9c8eae6fed5b4c2ffaca98c126d.png)

#### rustで表現

rustでは、APNG の`Encoder`を`new`するときに、PNG SignatureからacTLまでを定義しておきます。
それぞれの処理に関しては、こちらのリンクから見てください

- https://github.com/poccariswet/apng/blob/master/src/apng.rs

```rs
impl<'a, W: io::Write> Encoder<'a, W> {
    pub fn new(writer: &'a mut W, config: Config) -> APNGResult<Self> {
        let mut e = Encoder {
            config: config,
            w: writer,
            seq_num: 0,
        };
        Self::write_png_header(&mut e)?;
        Self::write_ihdr(&mut e)?;
        Self::write_ac_tl(&mut e)?;
        Ok(e)
    }
   …
```

その後に、PNG画像を上記の画像で示したように連番にエンコードしていきます。

```rs
// all png images encode to apng
    pub fn encode_all(&mut self, apng: APNG, frame: Option<&Frame>) -> APNGResult<()> {
        for v in apng.images.iter() {
            if self.seq_num == 0 {
                Self::write_fc_tl(self, frame)?;
                Self::write_idats(self, &v.data)?;
            } else {
                Self::write_fc_tl(self, frame)?;
                Self::write_fd_at(self, &v.data)?;
            }
        }
        Self::write_iend(self)?;
        Ok(())
    }
```

簡単にエンコード処理を説明すると、`write_fc_tl`で1フレームの定義に必要な描写領域やフレーム速度などバッファ(`Vec<u8>`)に書き込み、write_chunkで、`new`で定義した、writerに書き込みます。
また、`write_fd_at`と`write_idats`では、[ZlibEncoder](https://docs.rs/flate2/1.0.7/flate2/write/struct.ZlibEncoder.html)を使用し圧縮処理をして、圧縮処理後のバイナリをwriterに書き込んでいます。


⚠ 実装上、まだフレームごとに描写領域の設定や、フレーム速度をいじれないので今後対応していく予定。(2019/10/17現在)

## ちょっと大変だったところ

実装していくにあたり、rust特有の機能である、[**所有権システム**](https://doc.rust-lang.org/book/ch04-00-understanding-ownership.html)で、つまずきました😅
圧縮のために使ったZlibEncoderにデータを入れるためのbufferをアドレスで所有権渡していて、Zlib ライブラリの仕様上、`finish`関数を最後に呼ばないと、その所有権が戻らないためエラーが吐かれていました。

```sh:err_ownership.sh
error[E0502]: cannot borrow `buf` as immutable because it is also borrowed as mutable
    --> src/main.rs:170:26
     |
 160 |         let mut zlib = ZlibEncoder::new(&mut buf, Compression::fast());
     |                                         -------- mutable borrow occurs here
 ...
 170 |         self.write_chunk(&buf, *b"fdAT")?;
     |                          ^^^^ immutable borrow occurs here
 ...
 173 |     }
     |     - mutable borrow might be used here, when `zlib` is dropped and runs the destructor for type `flate2::z
 lib::write::ZlibEncoder<&mut std::vec::Vec<u8>>`
```

https://docs.rs/flate2/0.2.20/flate2/write/struct.ZlibEncoder.html

exampleにもちゃんと書いてありますね💦
なんで`finish`忘れたんだろう...

```:ownership_rule
・Each value in Rust has a variable that’s called its owner.
・There can only be one owner at a time.
・When the owner goes out of scope, the value will be dropped
```
rustを書くなら覚えましょう


## 実装するときに使ったモロモロ...

インプットするときに自分が重宝したのは、メモ＋小記事にもなり得る https://scrapbox.io です。
あとは、Rust自体勉強しながらだったので、rustのチュートリアルは本当に参考になりました。

以下に自分のまとめたscrapboxとrustチュートリアルのリンクがあります。

- https://scrapbox.io/poccariswet/
- https://doc.rust-lang.org/book/index.html

## 最後に

今後は自分が作ったapngのライブラリを使ってapng maker on wasmを実装していくのと同時に、rustを書いてる人に使っていただけるようにもっとチューニングしていければと思います！

作成したAPNG↓ ちなみにrustのlogoです

<img src="https://github.com/poccariswet/apng/raw/master/example/sample/out.png" width="250">

あ、QiitaってAPNG対応していたんですね...


## 参考
- https://developer.mozilla.org/ja/docs/Animated_PNG_graphics
- https://www.w3.org/TR/PNG/
- https://doc.rust-lang.org/tutorial.html
- https://ics.media/entry/2441/
- https://hoshi-sano.hatenablog.com/entry/2013/08/18/112550
- https://qiita.com/cia_rana/items/18c78e0233e117b22af6