前回は3.Xへの更新について説明を行いました。

Introduction

現状の.NETのUIといえば、UWPがメインに据えられ(Microsoft的な意味で)、WPFが微妙な立ち位置になり、WinFormsがレガシーとなっていますが、UI以外の面では System.Drawing 名前空間は、GDIという太古からのレガシーを受け継いでいたため、WPFでは互換性維持程度のAPIサポートしかなくなりました。

でも、いつ解放されるかわからない System.Windows.Media.Imaging.BitmapSource よりも、System.IDisposable を実装している System.Drawing.Bitmap のが、メモリ管理という点では管理しやすいのは事実です。

なので、Bitmapを使っている既存ライブラリを活用するため、BitmapSourceから、あるいはその逆変換を行う必要は結構あると思います。
そういう事情を反映してか、OpenCVSharpも便利な拡張メソッド BitmapSource OpenCvSharp.Extensions.ToBitmapSource を提供しています。
これはBitmapをBitmapSourceに変換する拡張メソッドですが、BitmapSourceに変換したいだけなら、ちょっと一手間加えるだけで、速度面で改善を加えることができます。

それは下記のソースになります。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
[System.Security.SuppressUnmanagedCodeSecurity]
[DllImport("gdi32.dll", EntryPoint = "DeleteObject")]
[return: MarshalAs(UnmanagedType.Bool)]
private static extern bool DeleteObject([In] IntPtr hObject);

private static BitmapSource ToBetterBitmapSource(Bitmap source)
{
var handle = source.GetHbitmap();
try
{
return Imaging.CreateBitmapSourceFromHBitmap(
handle,
IntPtr.Zero,
Int32Rect.Empty,
BitmapSizeOptions.FromEmptyOptions());
}
finally
{
DeleteObject(handle);
}
}

これを使って、OpenCVと比較しました。
以下サンプルソースです。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Drawing;
using System.Drawing.Imaging;
using System.Linq;
using System.Runtime.InteropServices;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Interop;
using System.Windows.Media.Imaging;
using OpenCvSharp.Extensions;

namespace OpenCV4
{

class Program
{

static void Main(string[] args)
{
const int width = 600;
const int height = 400;
const int repeat = 10000;

BitmapSource bitmapSource;

var sp = new Stopwatch();
sp.Start();
#if TRUE
using (var bitmap = new Bitmap(width, height, PixelFormat.Format32bppArgb))
{
Enumerable.Repeat(0, repeat).ToList().ForEach(i =>
{
bitmapSource = bitmap.ToBitmapSource();
Console.WriteLine($"{bitmapSource}");
});
}
#else
using (var bitmap = new Bitmap(width, height, PixelFormat.Format32bppArgb))
{
Enumerable.Repeat(0, repeat).ToList().ForEach(i =>
{
bitmapSource = ToNativeBitmapSource(bitmap);
Console.WriteLine($"{bitmapSource}");
});
}
#endif
sp.Stop();
Console.WriteLine($"Total: {sp.ElapsedMilliseconds} ms. Average: {sp.ElapsedMilliseconds/repeat} ms");
}

[System.Security.SuppressUnmanagedCodeSecurity]
[DllImport("gdi32.dll", EntryPoint = "DeleteObject")]
[return: MarshalAs(UnmanagedType.Bool)]
private static extern bool DeleteObject([In] IntPtr hObject);

private static BitmapSource ToNativeBitmapSource(Bitmap source)
{
var handle = source.GetHbitmap();
try
{
// フリーズされていない
return Imaging.CreateBitmapSourceFromHBitmap(
handle,
IntPtr.Zero,
Int32Rect.Empty,
BitmapSizeOptions.FromEmptyOptions());
}
finally
{
DeleteObject(handle);
}
}

}

}

600x400の32bit画像を10000回BitmapSourceに変換するだけです。
以下テスト結果です。

  • OpenCVSharp: Total: 55023 ms. Average: 5.5 ms
  • better: Total: 16843 ms. Average: 1.6 ms

結果は圧勝です。

BitmapSourceにして、System.Windows.Controls.Image に表示したいだけなら、断然後者です。

性能差の原因は?

OpenCVSharpのToBitmapSourceのソースを見ればわかりますが、けっこう色々やっています。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
public static BitmapSource ToBitmapSource(this Bitmap src)
{
if (src == null)
throw new ArgumentNullException(nameof(src));

if (Application.Current?.Dispatcher == null)
{
using (var memoryStream = new MemoryStream())
{
src.Save(memoryStream, ImageFormat.Png);
return CreateBitmapSourceFromBitmap(memoryStream);
}
}

try
{
using (var memoryStream = new MemoryStream())
{
// You need to specify the image format to fill the stream.
// I'm assuming it is PNG
src.Save(memoryStream, ImageFormat.Png);
memoryStream.Seek(0, SeekOrigin.Begin);

// Make sure to create the bitmap in the UI thread
if (IsInvokeRequired())
return (BitmapSource)Application.Current.Dispatcher.Invoke(
new Func<Stream, BitmapSource>(CreateBitmapSourceFromBitmap),
DispatcherPriority.Normal,
memoryStream);

return CreateBitmapSourceFromBitmap(memoryStream);
}
}
catch (Exception)
{
return null;
}
}

private static BitmapSource CreateBitmapSourceFromBitmap(Stream stream)
{
var bitmapDecoder = BitmapDecoder.Create(
stream,
BitmapCreateOptions.PreservePixelFormat,
BitmapCacheOption.OnLoad);

// This will disconnect the stream from the image completely...
var writable = new WriteableBitmap(bitmapDecoder.Frames.Single());
writable.Freeze();

return writable;
}

ざっくりと説明すると、BitmapをMemoryStreamにSaveし、MemoryStreamからBitmapSourceを生成しています。
MemoryStreamへ保存している時点で全バイトデータのコピーが走るでしょうし、WritableBitmapSourceを作成するときも、MemoryStreamからメモリデータの転送が実行されるわけです。
そりゃ時間がかかるでしょう。CPUのキャッシュに乗る量なら良いですが、画像データのメモリコピーは(CPUからすれば)遅いです。
CreateBitmapSourceFromHBitmap もメモリのコピーはあるはずでしょう。

また、ToBitmapSourceは戻ってくるBitmapSourceが最初からFreezeされています。
なので、編集したい場合は使えないです。

こうすると、ToBitmapSourceを使うメリットが無いですねぇ..

Conclusion

性能が出ないとき、全てを疑うのは時間の無駄ですが、一番ボトルネックになりそう、っていう勘どころをつかめると楽ですね。
今回はそれが理由でパフォーマンスを調査したのが始まりでした。

Source Code

https://github.com/takuya-takeuchi/Demo/tree/OpenCV4