【.NET】OpenCVSharpとZXing.Netを使ったバーコード読み込み

# はじめに
これは[OpenCV Advent Calendar 2017](https://qiita.com/advent-calendar/2017/opencv)の13日目の記事となります。

**本来はバーコード読み取り精度を高めた上で記事にする予定だったのですが、別の開発の遅れにより13日に間に合わなかったので、それは後々とします。**
【2017/12/23追記】14日以降に幾つか分かったことを追記しました。

お仕事でKEYENCEやDENSOなどの専用バーコードスキャナーを使っています。最近は、アスタリスク社のiPod Touchを使ったバーコードスキャナーの提案も受けます。

今回、マイクロソフト Surface Pro 4 の内蔵カメラを使って、バーコードを読めないかという依頼がありました。Surfaceなら持ち歩けるので、その場で読みたい。バーコードスキャナーを一緒に持ち歩きたくない。

# QRコード
QRコード（Quick Responce Code）は1994年にデンソーウェブの開発した、マトリックス型2次元コードの一種です。名前の通り、高速読取を目的に開発されました。

* [どうしてあの形なの？ QRコードに秘められた技術を「生みの親」に聞いた](http://hrnabi.com/2017/12/12/15799/)
* [QRコードとは](https://www.keyence.co.jp/ss/products/autoid/codereader/basic2d_qr.jsp)
* [QRコードの誤り訂正レベルの判別方法～アイカツスターズ！のQRコードを分析してみる](http://www.ryusuke.net/archives/765)

# 開発環境
マイクロソフト Surface Pro 4 バックカメラ 800万画素

カメラ操作にOpenCVSharp 、バーコード読取りにZXing(ゼブラクロッシング)を使用します。
NuGetから現在バージョンとして、OpenCVSharp v3.3.1.20171117 と ZXing.Net v0.16.2 をインストールしています。

## クラス分け
Cameraクラスを別途作成し、Windowsフォーム側と分離するようにしています。
画像処理はMat型を受け渡ししています。バーコード解析処理もCameraクラスに内包しています。
※ソースコードを一部掲載していますが、掲載用に編集しているのでそのままでは動きません。

## デリゲート(委譲)
CameraクラスからWindowsフォーム側にアクセスしたい場合、デリゲートを使っています。

```csharp
// 【Cameraクラス側】
public delegate void DisplayProgress(Mat img, int threshold);
// デコード処理
public string Decode(int min, int max, int add, Mat img, int threshold, DisplayProgress callback)
{
    // (中略)
    // フォーム側処理を呼ぶ
    callback?.Invoke(img2, value);
    // (中略)
}

// 【フォーム側処理】
// しきい値を中央に解析する
string value = await Task.Run(() => _camera.Decode(min, max, 1, img, threshold, AnalyzeDisplay));

public void AnalyzeDisplay(Mat img, int threshold)
{
    this.Invoke(new Action(() =>
    { 
        picCapture.ImageIpl = img;
        txtThreshold.Text = threshold.ToString();
    }));
}
```
* [デリゲートとは【C#】](http://kan-kikuchi.hatenablog.com/entry/Delegate)
* [C#のイベントとデリゲート(delegate)の違い](http://eno0514.hatenadiary.jp/entry/20150820/1440012230)

# カメラ画像の読取り
カメラ画像の読取りには、BackgroundWorkerクラスを使用しています。キャプチャー画像はPictureBoxIplコントロール(picMain)をCenterImageにして中央にQRコードを表示するようにしています。

```csharp
// 【Cameraクラス側】
VideoCapture _cap = null;

public Camera()
{
    // カメラ有無 0:バックカメラ 1:フロントカメラ
    _cap = new VideoCapture(0) { AutoFocus = false };
    Enabled = _cap.IsOpened();
}

// 【フォーム側処理】
bool _isRunning = false;

// バッググラウンド処理
private void bgWorker_DoWork(object sender, DoWorkEventArgs e)
{
    BackgroundWorker worker = (BackgroundWorker)sender;

    if (!_camera.Enabled) return;

    while (_isRunning)
    {
        // bgWorker_ProgressChangedイベントで画像取得
        Mat dst = _camera.Read();
        worker.ReportProgress(0, dst);
    }
}

// バッググラウンド進行変更イベント処理
private void bgWorker_ProgressChanged(object sender, ProgressChangedEventArgs e)
{
    // カメラ画像表示
    picMain.ImageIpl = (Mat)e.UserState;
}

// キャプチャー開始処理
private void CaputureStart()
{
    _isRunning = true;
    bgWorker.RunWorkerAsync();
    tmrCapture.Enabled = true;
}

// キャプチャー停止処理
private void CaputureStop()
{
    _isRunning = false;
    bgWorker.CancelAsync();
    tmrCapture.Enabled = false;
}
```

# ターゲット枠配置
ユーザーがQRコードを中央の位置に合わせやすいように、赤色十字のターゲット枠を配置します。
キャプチャー画像にターゲット枠を直接描画すると解析上おかしなことになるので、別のPictureBoxにターゲット枠イメージ(png)を用意して、BackColor = Color.Transparent にした上で子コントロール化することでターゲット枠を重ね合せています。[PictureBox上のLabelの背景が透明にならない問題の解決法](http://dobon.net/vb/dotnet/control/labelonpicturebox.html)

```csharp
// ターゲットアイコン用(メイン用)
picMain.Controls.Add(picTargetMain);
picTargetMain.Left -= picMain.Left;
picTargetMain.Top -= picMain.Top;
```

# 解析処理
タイマー(1000ms以内)を使って、ぶれ防止を兼ねてキャプチャー画像を一旦保存した上で、キャプチャー画像サイズが大きく、解析部分を減らすために中央に映っているある程度の範囲のみにトリミングしてから解析処理をしていきます。

```csharp
// キャプチャー画面
const string CAPTURE_PATH = "caputure.png";

// タイマー処理
private void tmrCapture_Tick(object sender, EventArgs e)
{
    if (picMain.Image == null) return;

    // 画面キャプチャー保存
    picMain.ImageIpl.SaveImage(CAPTURE_PATH);

    // 画像読込(中央あたりをトリミング)
    Mat src = new Mat(CAPTURE_PATH);
    Rect rc = new Rect((src.Width - picMain.Width) / 2,
                       (src.Height - picMain.Height) / 2 - Camera.IMAGE_MERGIN_SIZE,
                       picMain.Width,
                       picMain.Height + Camera.IMAGE_MERGIN_SIZE);
    picCapture.ImageIpl = new Mat(new Mat(CAPTURE_PATH), rc);

    // そのまま解析
    Result result = _camera.Analyze(picCapture.ImageIpl);
    if (result == null) return;

    string decode = result.ToString().Trim();
    if (decode != "" && decode != "error")
    {
        // 解析出来たなら入力値へ送信
        Send(decode);
    }

    // 解析可能性がある
    if (decode == "error")
    {
        // 自動解析処理
        AnalyzeAuto(picCapture.ImageIpl, trbThreshold.Value);
    }
}
```


# 読み取り精度を高めたい
2cm以上のQRバーコードはなんなく読めたのですが、ユーザーから実際に使用するバーコードが送られてきたところ、ケーブルに付けられた8mmのQRコードでありました。それだとごくまれに読める程度で実用には程遠い状態です。
しかし、専用バーコードスキャナーはレーザーなのでなんなく読めるのです。

ケーブルの紙は少し角度が付いていることもあり、8mmのQRコードを専用プリンタで印刷して平面状態にしたところ、少しは読めるようになったのですが、まだまだ実用には程遠い状態です。

試行錯誤が始まりました。

【2018/07/18追記】
8mmのQRコードはソフトウェアでの対応は難しく(カメラのピントが合わせ難いやQRコードが丸まってると読み取りできない)、結局ハードウェアの小型QRコードリーダーUSB対応(例 [cubeQR](https://www.e-welcom.com/products/h/scanner/cubeqr/index.html))で対応することになりました。

## 試行１ グレースケール化
カメラ画像をグレースケール化します。気休めかも知れません。
【2017/12/23追記】2値化する上でグレースケール化は必須です。

 [OpenCvSharpを使う　その3 (グレースケールに変換)](http://schima.hatenablog.com/entry/20090621/1245595172)

``` csharp
// カメラ画像の読込み
public Mat Read()
{
    Mat result = null;

    if (_cap.IsOpened())
    {
        Mat frame = new Mat();
        result = new Mat();

        // カメラ画像の読込み
        _cap.Read(frame);
        // グレースケール化
        Cv2.CvtColor(frame, result, ColorConversionCodes.BGRA2GRAY);
    }

    return result;
}
```

## 試行2 先鋭化と2値化
先鋭化または2値化をやってみましたが、逆に読めなくなってしまいました。これは研究中です。

【2017/12/23追記】
見た目では読めそうなQRコードを読めるようにするのに色々検討した結果、先鋭化は駄目でしたが2値化ではしきい値を調整すること読めるようになりました。
[画像の閾値処理（2 値化）](https://bi.biopapyrus.jp/ia/opencv/threshold.html)

しきい値をどうやって決めるのかですが、256段階にグレースケール化して使用されている白色が一番多い値(周辺の明るさ)を算出します。
例えば算出値が209と明るめの場合、190～200の範囲で2値化して解析して読めるかを繰り返します。すると194でerrorの値となり、195で解析可能となりました。ちなみに196では解析不可でした。
同様に算出値が90と暗めの場合、70～80の範囲で2値化すると、75で解析可能となりました。

手動(ボタンをクリックして解析)の場合には数秒は待ってもらえるので、2値化する範囲を広げてじっくり解析できます。自動(リアルタイム)では、2値化する範囲を狭めて解析します。その基準となるしきい値はトラックバーを用意してユーザー側である程度調整させるのと、手動で読めた際のしきい値を反映させます。
ここらへんはどうするのか検討中です。

## 試行3 マクロレンズ
ソフトが駄目ならハードでってことで、100均ショップにスマホ用カメラにクリップで付けるマクロレンズが売っていたので購入しました。

確かに付けることで少しは読めるようになるのですが、SurfaceとQRコードをかなり近づけることになるので、運用上あまりイケていない。あくまでソフト側で対応することにしました。

【2017/12/23追記】
Surfaceは借り物だったので返してしまった。開発PCの内蔵カメラは性能が低いので、マクロレンズを使わないとボケてしまう。さすがにボケると滲んで2値化で調整しても読めないので今は必須です。

## 試行4 読み取り種類の限定化
TryHarderオプションの有効化と読み取るバーコードの種類をBarcodeFormat.CODE_39, BarcodeFormat.QR_CODEの２種類にしました。

[ZXing(.Net)のバーコード認識率を上げる方法](http://d.sunnyone.org/2015/09/zxingnet.html)

```csharp
// 解析処理
public Result Analyze(Mat img)
{
    BarcodeReader reader = new BarcodeReader
    {
        AutoRotate = true,
        TryInverted = true,
        // Code-39とQRコードに限定
        Options = new ZXing.Common.DecodingOptions
        {
            TryHarder = true,
            PossibleFormats = new[] { BarcodeFormat.QR_CODE }.ToList()
        }
    };

    return reader.Decode(img.ToBitmap());
}
```

## 試行5 射影変換
ZXingはファインダパタンなどの座標を取得後に文字列のデコードを開始します。しかし、このデコードに失敗した場合に例え座標が取れていてもResultオブジェクトは生成されません。これは非常に勿体無い。
その為、QRコードの認識位置を取得するようにZXingライブラリを修正する。
座標が取れてデコードが失敗する場合、QRコードの部分を抜き出して、射影変換後に再度デコードさせる。これで少しは良くなりました。

* [急角度・急斜面に対応するQRデコーダ（ZXing編）](http://enlosph.hatenablog.com/entry/2015/09/14/193143)
* [OpenCvSharpで透視投影の補正](http://sourcechord.hatenablog.com/entry/2017/02/20/233042)

【2017/12/23追記】
2値化で読めるようになったので射影変換は止めました。ある程度、傾いていても誤り訂正で読んでくれたので、必要性に迫られたら再度検討します。

### Result情報
* Result.Text : デコード結果の文字列
* Result.Points[*] : 0-2はファインダパタン（L字で順に取得する．つまり[1]が折れた箇所），3以降は位置合わせパタン
* ResultPoint では左下、左上、右上、右下(位置補正)の順に取得

【2017/12/23追記】
ResultPointは、左下→左上→右上の順の時と、右下→左下→右上の順の時がありました。
ResultPointはファインダパタンの中央点となるので、端までの差を決めてあげればQRコード部分のみの画像が取得できます。※射影変換をやめたので今は使っていません。

```csharp
// ファインダパタンの中央点から端までの差
public const int IMAGE_MERGIN_SIZE = 22;

/// <summary>
/// ポイント情報からQRコード部分のサイズを取得する
/// </summary>
/// <param name="result">ポイント情報</param>
/// <param name="width">最大幅</param>
/// <param name="height">最大高さ</param>
/// <returns>QRコード部分のサイズ</returns>
public Rect GetPoints(Result result, int width, int height)
{
    // ポイント情報からQRコード部分を切り取る
    int stX = 0;
    int stY = 0;
    int w = 0;
    int h = 0;
    if (result.ResultPoints[0].X < result.ResultPoints[2].X)
    {
        // 左下→左上→右上
        stX = (int)GetMinValue(result.ResultPoints[0].X, result.ResultPoints[1].X) - IMAGE_MERGIN_SIZE;
        stY = (int)GetMinValue(result.ResultPoints[1].Y, result.ResultPoints[2].Y) - IMAGE_MERGIN_SIZE;
        w = (int)result.ResultPoints[2].X + IMAGE_MERGIN_SIZE - stX;
        h = (int)result.ResultPoints[0].Y + IMAGE_MERGIN_SIZE - stY;
    }
    else
    {
        // 右下→左下→右上
        stX = (int)GetMinValue(result.ResultPoints[1].X, result.ResultPoints[2].X) - IMAGE_MERGIN_SIZE;
        stY = (int)(result.ResultPoints[2].Y - IMAGE_MERGIN_SIZE);
        w = (int)result.ResultPoints[0].X + IMAGE_MERGIN_SIZE - stX;
        h = (int)result.ResultPoints[1].Y + IMAGE_MERGIN_SIZE - stY;
    }

    stX = (int)GetMaxValue(stX, 0);
    stY = (int)GetMaxValue(stY, 0);
    w = (int)GetMinValue(w, width);
    h = (int)GetMinValue(h, height);

    return new Rect(stX, stY, w, h);
}

// 引数の小さい値を取得する
private float GetMinValue(float min1, float min2)
{
    return (min1 <= min2 ? min1 : min2);
}

// 引数の大きい値を取得する
private float GetMaxValue(float max1, float max2)
{
    return (min1 >= min2 ? max1 : max2);
}
```

### OpneCVのPointで取得位置の順番
左上、左下、右下、右上の順

# ZXing.Netのデバッグ
読めるQRコードと読めないQRコードの画像を比較しても、見た目に違いがないのに読めない。
その原因を探るにはZXing.Netのライブラリをデバッグしていけば何か分かるはず。

ソースコードをダウンロードします。
https://github.com/micjahn/ZXing.Net

今回のアプリケーションは.NET4.6を使用しているので、プロジェクトに.Net4.6用のzxing.net4.6.csprojを追加します。
これで、Decodeメソッドでステップインしていけば、ZXing.Netに入っていけます。

# 最後に
14日あたりから、QRコード読み取りの研究に再度取り組むことになるので1週間後にまた記事を更新できると思います。

【2017/12/23追記】
14日以降で分かった範囲を追記しました。

# 参照
## OpenCVSharp
OpenCVSharp自体は、日本の方が開発している。

* [OpenCvSharpを使う　その1 (準備)](http://schima.hatenablog.com/entry/20090616/1245081217)
* [OpenCVSharp APIリファレンス](https://shimat.github.io/opencvsharp_docs/html/d75eb659-6335-53f6-af7a-81814a21ab7f.htm)
* [OpenCVリファレンス(日本語)](http://opencv.jp/reference_manual)

### 導入と使い方
  * [OpenCvSharpをつかう　その17(NuGetで導入)](http://schima.hatenablog.com/entry/2013/12/15/110513)
  * [OpenCvSharpをつかう　その23 (OpenCV 3.0対応)](http://schima.hatenablog.com/entry/2015/08/17/203901)
  * [OpenCvSharpをつかう　その6 (PictureBoxIpl)](http://schima.hatenablog.com/entry/20090903/1251978952)
  * [OpenCvSharp3を使ってみた](http://sourcechord.hatenablog.com/entry/2016/08/11/121553)

###  カメラ
  * [http://robot-factory.blogspot.jp/2013/10/c-web.html](C#で画像処理-WEBカメラの使用)
  * [C#によるUSBカメラ操作(WPF編)](https://tocsworld.wordpress.com/2014/02/26/c%E3%81%AB%E3%82%88%E3%82%8Busb%E3%82%AB%E3%83%A1%E3%83%A9%E6%93%8D%E4%BD%9Cwpf%E7%B7%A8/)
  * [OpenCVSharp3を使ってWebカメラのキャプチャ](https://debuyan.wordpress.com/2016/05/22/opencvsharp3%E3%82%92%E4%BD%BF%E3%81%A3%E3%81%A6web%E3%82%AB%E3%83%A1%E3%83%A9%E3%81%AE%E3%82%AD%E3%83%A3%E3%83%97%E3%83%81%E3%83%A3/)
  * [がんばるC# (OpenCV)](https://blogs.yahoo.co.jp/mikewanko2/13932243.html)

### Mat型
OpenCVの画像はMat型変数で表現されます。Matという名前は matrix で行列の略です。その為、行列なので(行、列)の順に指定されるため、一般の画像指定の(x, y)ではない。※x, yの順番が逆なことに注意!!

|定数|内容|
|:--|:--|
|CV\_8UC1|8ビット、符号なし、1チャンネルのデータ|
|CV\_8UC3|8ビット、符号なし、3チャンネルのデータ|

※CV_8Uは0から255の整数
※1画素はB, G, Rの順に格納されている。

* [２．画像の簡単操作](http://www.wakayama-u.ac.jp/~chen/opencv/opencv2.html|)
* [知っておきたいMatのゴリ知識](http://gori-naru.blogspot.jp/2012/11/mat.html)

### 画像アクセス
* [OpenCvSharp3入門](http://sourcechord.hatenablog.com/entry/2016/08/15/235654)
* [[C#] ビットマップにピクセル単位で高速にアクセスするには (GetPixel/SetPixel vs BitmapData 速度比較)](http://www.84kure.com/blog/2014/07/13/c-%E3%83%93%E3%83%83%E3%83%88%E3%83%9E%E3%83%83%E3%83%97%E3%81%AB%E3%83%94%E3%82%AF%E3%82%BB%E3%83%AB%E5%8D%98%E4%BD%8D%E3%81%A7%E9%AB%98%E9%80%9F%E3%81%AB%E3%82%A2%E3%82%AF%E3%82%BB%E3%82%B9/)
* [OpenCVでピクセルにアクセスする方法4つ](http://d.akiroom.com/2012-06/opencv-pixel-read-write-get-set/)

### MATとBITMAP相互変換
* [OpenCvSharpでのIplImageとBitmapの相互変換](http://nc30mtd.oops.jp/blog/2015/01/opencvsharpiplimagebitmap.html)
* [BitmapToMat & MatToBitmapを使う際の注意点 OpenCV Java API for Android](http://micchysdiary.blogspot.jp/2011/10/bitmaptomat-mattobitmap-opencv-java-api.html)

## ZXing(ゼブラクロッシング)
ZXing(ゼブラクロッシング)はGoogle が開発して[公開](https://github.com/zxing/zxing)している、様々な一次元や二次元のバーコードの生成/操作ができるオープンソースライブラリです。

  * [「ZXing QR コードスキャナー」の内部処理を追う](http://dsas.blog.klab.org/archives/52107940.html)
  * [ZXing(.Net)のバーコード認識率を上げる方法](http://d.sunnyone.org/2015/09/zxingnet.html)

## その他
  * [HololensでQRコードリーダを作ってみた．](http://hiroyky.hatenablog.com/entry/2017/02/23/005957)
  * [WEBカメラ＆ ZBar を使った キャプチャー＆自動スキャン アプリ](http://www.dogodemo.net/redmine/projects/dogodemo/wiki/WEB%E3%82%AB%E3%83%A1%E3%83%A9%EF%BC%86_ZBar_%E3%82%92%E4%BD%BF%E3%81%A3%E3%81%9F_%E3%82%AD%E3%83%A3%E3%83%97%E3%83%81%E3%83%A3%E3%83%BC%EF%BC%86%E8%87%AA%E5%8B%95%E3%82%B9%E3%82%AD%E3%83%A3%E3%83%B3_%E3%82%A2%E3%83%97%E3%83%AA)