UMatの内部処理

この記事は[OpenCV Advent Calendar 2015](http://qiita.com/advent-calendar/2015/opencv)の20日目の記事です．

# はじめに
OpenCV 3.0よりCPU/GPU実装のカプセル化を行うための仕組みである**T-API（transparent API）**が導入されました．そのため，OpenCVユーザーは，**T-API**で提供される**UMat**と呼ばれるデータ構造を用いて実装することで，CPU/GPUどちらでも動作する処理を同一コードで記述できます．

**UMat**については，筆者の[連載記事](http://www.buildinsider.net/small/opencv/002)，[スライド](http://www.slideshare.net/YasuhiroYoshimura/gpgpu-dandelion1124-201301130)だけでなく，以下のURLの記事を参照ください．

- [CVPR 2015チュートリアル資料](https://docs.google.com/presentation/d/1qoa29N_B-s297-fp0-b3rBirvpzJQp8dCtllLQ4DVCY/present)
- [OpenCL | OpenCV](http://opencv.org/platforms/opencl.html)
- [OpenCV Transparent API | Learn OpenCV](http://www.learnopencv.com/opencv-transparent-api/)
- [OpenCV 3.0.0での独自カーネルOpenCL - Qiita](http://qiita.com/tackson5/items/8dac6b083071d31baf00)

## UMatを使ったサンプルコード
UMatを使ったサンプルコードは2015年12月現在でWeb上であまり公開されていないため，
OpenCVにある以下のディレクトリにあるものが参考になるかもしれません．

- <code>samples/tapi</code>
- <code>modules/core/perf/opencl</code>
- <code>modules/core/test/ocl</code>

# 前準備
UMatでOpenCLを使用するには以下のCMakeオプションをONにしてOpenCVをビルドする必要があります．

- [x] WITH_OPENCL

また，コマンドラインでCMakeを実行する場合は<code>-D WITH_OPENCL=ON</code>と指定してください．

# UMatの内部処理
以下のサンプルコードにある処理を例に挙げてUMatの内部処理を紹介します．

- [Mat::copyToメソッドの振る舞い](#copyTo)
- [cv::cvtColorメソッドの振る舞い](#cvtcolor)
- [cv::imshowメソッドの振る舞い](#imshow)

```cpp:
#include <opencv2/core.hpp>
#include <opencv2/imgproc.hpp>
#include <opencv2/imgcodecs.hpp>
#include <opencv2/highgui.hpp>

#include <iostream>

int main(int argc, char *argv[])
{
    cv::Mat img = cv::imread("lena.jpg", cv::IMREAD_COLOR);
    if (img.empty())
    {
        std::cerr << "Failed to open image file." << std::endl;
        return -1;
    }

    cv::UMat u_img, u_gray;

    // （1）MatのデータをUMatにコピーする
    img.copyTo(u_img);

    // （2）UMatクラスのインスタンスを用いてグレースケール化を行う
    cv::cvtColor(u_img, u_gray, cv::COLOR_BGR2GRAY);

    // （3）UMatのデータをウィンドウ表示する
    cv::namedWindow("u_gray");
    cv::imshow("u_gray", u_gray);
    cv::waitKey(0);
    cv::destroyAllWindows();

    return 0;
}
```

<a name="copyTo"></a>
## Mat::copyToメソッドの振る舞い
前述のサンプルコードでは<code>img.copyTo(u_img);</code>という記述により，
MatのデータをUMatにコピーしています．

以下にcopyToメソッドの実装の一部を引用します．

```cpp:
    if( _dst.isUMat() )
    {
        _dst.create( dims, size.p, type() );
        UMat dst = _dst.getUMat();

        size_t i, sz[CV_MAX_DIM], dstofs[CV_MAX_DIM], esz = elemSize();
        for( i = 0; i < (size_t)dims; i++ )
            sz[i] = size.p[i];
        sz[dims-1] *= esz;
        dst.ndoffset(dstofs);
        dstofs[dims-1] *= esz;
        dst.u->currAllocator->upload(dst.u, data, dims, sz, dstofs, dst.step.p, step.p);
        return;
    }
```

ここではcopyToメソッドの引数がUMatクラスのインスタンスだった場合，
<code>UMat dst = _dst.getUMat();</code>にて，コピー先のインスタンスを生成しています．

そして，<code>UMat dst = _dst.getUMat();</code>
にて，MatのデータをUMatにコピーしています．

その後，オフセットの調整を行ってから
<code>dst.u->currAllocator->upload(dst.u, data, dims, sz, dstofs, dst.step.p, step.p);</code>
にて，OpenCLデバイスにデータをアップロードします．

<a name="cvtcolor"></a>
## cv::cvtColorメソッドの振る舞い
以下にcv::cvtColorメソッドの実装の一部を引用します．

```cpp:
void cv::cvtColor( InputArray _src, OutputArray _dst, int code, int dcn )
{
    int stype = _src.type();
    int scn = CV_MAT_CN(stype), depth = CV_MAT_DEPTH(stype), bidx;

    CV_OCL_RUN( _src.dims() <= 2 && _dst.isUMat() && !(depth == CV_8U && (code == CV_Luv2BGR || code == CV_Luv2RGB)),
                ocl_cvtColor(_src, _dst, code, dcn) )
```

この例では，CV_OCL_RUNマクロにある条件（<code>_src.dims() <= 2 && _dst.isUMat() && !(depth == CV_8U && (code == CV_Luv2BGR || code == CV_Luv2RGB))</code>）を満たす場合に，OpenCL実装であるocl_cvtColorがコールされます．

以下にocl_cvtColorの実装の一部を引用します．

```cpp:
    case COLOR_RGB2GRAY: case COLOR_RGBA2GRAY:
    {
        CV_Assert(scn == 3 || scn == 4);
        bidx = code == COLOR_BGR2GRAY || code == COLOR_BGRA2GRAY ? 0 : 2;
        dcn = 1;
        k.create("RGB2Gray", ocl::imgproc::cvtcolor_oclsrc,
                 opts + format("-D dcn=1 -D bidx=%d -D STRIPE_SIZE=%d",
                               bidx, stripeSize));
        globalsize[0] = (src.cols + stripeSize-1)/stripeSize;
        break;
    }
```

また，ocl_cvtColorの<code>k.create</code>にて目的の処理に応じたOpenCLカーネルをコンパイルし，OpenCLプログラムを生成します．

このとき生成したOpenCLプログラムは，OpenCLカーネルのビルドオプション文字列から生成したハッシュ値をキーとしてmap形式でメモリ上に保存しています，そのため，同じ関数を再度コールした場合は，OpenCLカーネルをコンパイルは行わずにハッシュキーでヒットしたOpenCLプログラムを使って処理を行います．

### OpenCV 2.4系（oclMat）との違い
OpenCV 2.4系（厳密に言うとOpenCV 2.4.7以降のOpenCV 2.4系）のoclMatは生成したOpenCLプログラムを外部ファイルとして出力しますが，3.0からはmap形式でメモリ上に保存するように変更になりました．

oclMatとはなんぞやという方は[私のスライド](http://www.slideshare.net/YasuhiroYoshimura/gpgpu2opencvopencloclmat)を参照ください．

<a name="imshow"></a>
## cv::imshowメソッドの振る舞い
結論から述べるとcv::imshowメソッドに対して**UMat**クラスのインスタンスをそのまま渡して問題ありません．
以下にcv::imshowメソッドの実装の一部を引用します．

```cpp:
void cv::imshow( const String& winname, InputArray _img )
{
    const Size size = _img.size();
#ifndef HAVE_OPENGL
    CV_Assert(size.width>0 && size.height>0);
    {
        Mat img = _img.getMat();
        CvMat c_img = img;
        cvShowImage(winname.c_str(), &c_img);
    }
```

cv::imshowメソッド内の<code>Mat img = _img.getMat();</code>でMatのデータとして変換し，そのデータをcvShowImage関数に渡しているため，ユーザーはOpenCLデバイスからのダウンロード処理を記述する必要はありません．

# UMatでハマったこと
**UMat**を使うことでOpenCL利用による高速化の恩恵を受けられる場合もあるのですが，劇的に遅くなるケースにも遭遇しました．もしかしたら他の**UMat**ユーザーも参考になるかもしれないのでご紹介します．

## 事の発端
[@WL_Amigo](https://twitter.com/WL_Amigo)さんが[waifu2x-converter-cpp](https://github.com/WL-Amigo/waifu2x-converter-cpp)を開発されているときの以下のツイートがきっかけです．

<blockquote class="twitter-tweet" data-conversation="none" lang="ja"><p lang="ja" dir="ltr"><a href="https://twitter.com/dandelion1124">@dandelion1124</a> 自分の方でも一応OpenCV3.0.0のビルド及び本プログラムのビルドと実行も出来ているのですが…&#10;Ubuntuの方ではCUDA無しでも400x240の画像のnoise_scale処理に30秒程度なのですが、Winの方では数時間かかってしまうのです…</p>&mdash; アミーゴ (@WL_Amigo) <a href="https://twitter.com/WL_Amigo/status/603176328112701441">2015, 5月 26</a></blockquote>
<script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script>

※現在の[waifu2x-converter-cpp](https://github.com/WL-Amigo/waifu2x-converter-cpp)は，この問題が解決しています．

## サンプルコード
調査するために現象を再現させるサンプルコードを作りました．

```cpp:
#include <opencv2/core.hpp>
#include <opencv2/core/ocl.hpp>
#include <opencv2/imgproc.hpp>

#include <iostream>
#include <random>

int main(int argc, const char* argv[])
{
    const int loopNum = 10;
    cv::Mat src(cv::Size(512, 512), CV_8UC3, cv::Scalar(0, 0, 255));
    cv::Mat dst;
    cv::Mat kernel[loopNum];
    cv::UMat u_kernel[loopNum];

    std::random_device rd;
    std::srand(rd());
    for (int i = 0; i < loopNum; i++)
    {
        kernel[i] =
            (
                cv::Mat_<float>(3, 3) <<
                std::rand(), 1.0, 1.0,
                1.0, 1.0, 1.0,
                1.0, 1.0, 1.0
            );
        u_kernel[i] = kernel[i].getUMat(cv::ACCESS_READ);
    }
    cv::UMat u_src, u_dst;
    src.copyTo(u_src);
    double f = 1000.0f / cv::getTickFrequency();

    int64 start = cv::getTickCount();
    // ここからがMatの処理
    for (int i = 0; i < loopNum; i++)
    {
        cv::filter2D(src, dst, -1, kernel[i]);
    }
    int64 end = cv::getTickCount();

    start = cv::getTickCount();
    // ここからがUMatの処理
    for (int i = 0; i < loopNum; i++)
    {
        cv::filter2D(u_src, u_dst, -1, u_kernel[i]);
    }
    end = cv::getTickCount();

    std::cout << "[Mat]  " << (end - start) * f << "[ms]" << std::endl;
    std::cout << "[UMat] " << (end - start) * f << "[ms]" << std::endl;

    return 0;
}
```

## 実行結果
私の環境で前述のサンプルコードを実行した時の結果は以下の通りです．
<pre>
[Mat]  35.0787[ms]
[UMat] 1257.96[ms]
</pre>

**UMatの方がめちゃくちゃ遅い・・・！！**

原因がわからないと気持ち悪いので調査してみることにしました．

## 調査
ということで，Visual Studio 2013のプロファイラーを使ってどの部分が遅いか確認します．
プロファイラーを使って調べたホットパスは以下の通りです．

![hotpath.png](https://qiita-image-store.s3.amazonaws.com/0/31158/13374cb3-1b16-cd15-79fc-b4428b7613f7.png)

この結果からもわかるように，OpenCLカーネルコンパイル時間がほとんどの時間を占めていることがわかります．具体的には，forループ中でcv::filter2Dを呼んでいるところが今回の問題のトリガです．

```cpp:
    for (int i = 0; i < loomNum; i++)
    {
        cv::filter2D(src, dst, -1, kernel[i]);
    }
```
UMatでOpenCLが有効な場合，cv::filter2Dではフィルタのカーネル毎にOpenCLカーネルをコンパイルするのですが，フィルタのカーネル<code>kernel[i]</code>が異なると使いまわせないのでOpenCLカーネルコンパイル処理が大量に走り，パフォーマンスが著しく劣化してしまいます．

## 回避方法
知らない方からするとおまじないみたいなのでアレですが，**UMat**の関数を実行する前に
<code>cv::ocl::setUseOpenCL(false);</code>
と実行することで，**UMat**内部で常にCPU動作の実装が動くようになり，この問題を回避することができます．

## 公式の見解
このUMatの振る舞いは想定されているものなのか気になったので公式メンバに[質問しました](http://code.opencv.org/issues/4377)．
以下に公式メンバの回答を引用します．

<pre>
In filter2D OpenCL kernel is compiled with exact filter kernel values (to reach maximum speed).
In your example you change filter kernel values on every call, so OpenCL compiler invoked many times.
So this behaviour is expected.
</pre>

結論から述べると**「想定された振る舞い」**とのことです．
というわけで，**UMat**を使うときにはこの辺の振る舞いにも気を付ける必要がありそうです．
（OpenCL詳しくない人がこの現象踏んだら詰みそうではありますが・・・）

# おわりに
この記事では，**UMat**の内部処理および**UMat**でハマったことをまとめました．
これをきっかけに，**UMat**ユーザーが増えて**UMat**に関する日本語情報が増えると嬉しいです．
~~2015年12月現在，UMatの情報は現状Web上でほとんど見付けることができないので・・・~~

# 備考
筆者は以下の環境で動作確認しました．

* [OpenCV 3.0.0](https://github.com/Itseez/opencv/releases/tag/3.0.0)
* Windows 8.1 Pro（64bit）
* Visual Studio 2013 Update5
* NVIDIA CUDA Toolkit 7.5