Choreographer 〜 AndroidでFPSを意識してみる話 〜


# **挨拶**
こんにちは、12/1を担当させて頂く[@wasabeef_jp](http://twitter.com/wasabeef_jp)です。

[DroidKaigi 2016](https://droidkaigi.github.io/2016/)の[Connpass](http://droidkaigi.connpass.com/event/23512)が募集開始されましたね。
もう、結構埋まっているみたいですが、Android界隈がいっそう盛り上がって貰えたら嬉しいです(๑•̀ㅂ•́)و✧

さて、今年一発目なので、ふんわりした内容を書いていこうかと思います。
少し前に[Takt](https://github.com/wasabeef/Takt)というライブラリを作りましたので、その話をさせて下さい。

# **Takt**
[![data_takt.png](https://qiita-image-store.s3.amazonaws.com/0/12099/c01c8b14-e5cf-f596-8d16-39622be2150a.png)](https://github.com/wasabeef/Takt)

何が出来るライブラリかというと「FPSを表示」することが出来るライブラリになります。
ゲームとかだとFPSが落ちないように意識するのが当たり前になっていますが
SNS系のアプリを作っている上で、そこまで意識していないことが多いのではないでしょうか。

重くなるようなアプリを作っていない場合は必要ないかもしれません。
私の場合、動画関連のAPIやOpenGLを利用する頻度が高かったため、これで簡単に可視化するようにしました。

![takt_fps.gif](https://qiita-image-store.s3.amazonaws.com/0/12099/0c7abd19-c778-538a-1105-ef17824ee5a2.gif)


## **FPS (Frames Per Second)**
そもそもFPS(Frames Per Second)とは、動画において
> 単位時間あたりに処理させるフレーム数（静止画像数、コマ数）である。
> 通常、1秒あたりの数値で表し、fps（英: frames per second＝フレーム毎秒）という単位で表す。

のことを指します。

人間が認識できるFPSは、60fpsまでと言われています。
アクションゲームの中には、60fpsが採用されているものがありますね。
実は、映像業界でも標準となっているFPSでも映画は24fpsだったりします。

FPSが違うと、こんなにも差があるように見えます。
![fpsdemo1.gif](https://qiita-image-store.s3.amazonaws.com/0/12099/bd71a2ad-d6e8-5d5b-fb38-f79acd5c9d1b.gif)
参考: https://twitter.com/McFunkypants/status/607916176912453632

## **VSync**

Displayのフレッシュレートが60Hzの場合
1秒間に60frameしか表示できないので、FPSが80とか出てた場合は
1frameを表示し切る前に、GPUから次のframeが来てしまうので、画面が乱れたりします..
こういうのをティアリングって言います。

そこで、ティアリングが起こらないように、DisplayのとGPUのframeを合わせようとするわけです。
Displayがframeを表示しきってからGPUにframeを送ってもらうことをVSync垂直同期といいます。

## **Choreographer**
> The choreographer receives timing pulses (such as vertical synchronization) from the display subsystem then schedules work to occur as part of rendering the next display frame.

AndroidではFPSを算出してくれるAPIはありません。
ただ、前述のVSyncのタイミングをChoreographerを使うことによって
Choreographer.FrameCallbackの登録が可能になります。
※しかし、Android 4.1で追加されたAPIということに注意する必要があります。

実は、ValueAnimatorの内部で、Choreographerが使われています。
AndroidのAnimationの実行タイミングはVSyncを意識して作られているということが分かりますね。
ただ、4.0以下の場合は Handlerを利用しているため、厳密にはVSync同期にはなっていません。

また、[Facebook/Rebound](https://github.com/facebook/rebound/blob/master/rebound-android/src/main/java/com/facebook/rebound/ChoreographerCompat.java)でも似たような処理が書かれています。

以下は、[Takt](https://github.com/wasabeef/Takt)の一部を抜粋したコードになりますが
Choreographerの使い方は簡単で、Choreographerのinstanceに対して、Callbackの登録・解除を行うだけで
VSyncのタイミングがdoFrameで返ってきます。

注意しなければいけないポイントとしては、1回の登録で1回分しか返ってこないため
計測し続けたい場合は、Choreographer.FrameCallback#doFrame(long)で、再登録する必要があります。

```java
public class Metronome implements Choreographer.FrameCallback {

  private Choreographer choreographer;

  public Metronome() {
    choreographer = Choreographer.getInstance();
  }

  public void start() {
    choreographer.postFrameCallback(this);
  }

  public void stop() {
    choreographer.removeFrameCallback(this);
  }

  @Override public void doFrame(long frameTimeNanos) {
    Timber.i("Callback frameTimeNanos" + frameTimeNanos);
    choreographer.postFrameCallback(this);
  }
}
```

## Setup

### Dependencies
```groovy
dependencies {
    compile 'jp.wasabeef:takt:1.0.2'
}
```

### Simple
簡単に使う場合は、1行コードを追加するだけで可能です。

```java
public class MyApplication extends Application {
  public void onCreate() {
    super.onCreate();
    Takt.stock(this).play();
  }
}
```

### Advanced
FPSの表示位置、更新時間、テキスト色、テキストサイズなど細かく設定が可能です。

```java
Takt.stock(this)
    .seat(Seat.BOTTOM_RIGHT)
    .interval(250)
    .color(Color.WHITE)
    .size(14f)
    .alpha(.5f)
    .listener(new Audience() {
      @Override public void heartbeat(double fps) {
        Timber.i("Excellent!" + fps + " fps");
        // Timber
        // jp.wasabeef.example.takt D/Excellent!﹕ 59.28853754940712 fps
        // jp.wasabeef.example.takt D/Excellent!﹕ 59.523809523809526 fps
        // jp.wasabeef.example.takt D/Excellent!﹕ 59.05511811023622 fps
        // jp.wasabeef.example.takt D/Excellent!﹕ 55.33596837944664 fps
        // jp.wasabeef.example.takt D/Excellent!﹕ 59.523809523809526 fps
      }
    })
    .play();
}
```

使ってみると、ざっくりではありますが、遅くなるタイミングわかったので意外と幸せになりました。

おしまい