2011/02/16

魔法使いの弟子(その7-1)

【ミッション: Windows プログラミングに挑戦せよ】

中学の頃、ぼくは生まれて初めて C 言語の入門書を買った。

しかしそこに書いてあったのは、退屈なコマンドラインアプリケーションばかり。 GUI アプリケーションの構築を夢見ていたぼくにとって、それはあまりにもショッキングな現実であった。

そんなぼくも、やがて C 言語をひととおり学び(全然身についていないが)、ついに GUI アプリに手を付ける日が来た。
ソースコードは以下のようになる。これは初等的な Windows アプリケーションのソースコードであり、Charls Petzold著『プログラミング Windows』等でも解説されているため、詳細は省く。

【MainWindow.cpp】
#include <windows.h>

/** アプリケーション用データ構造体 **/
typedef struct {
    /* ****************************************** */
    /* グローバル変数にせず、極力ここに放り込む。 */
    /* 例えば…                                   */
    /* ・ 現在扱っているファイルのフルパス        */
    /* ・ ゲームのスコア、など…。                */
    /* ****************************************** */

    LPTSTR lpszStr; // 今回はテスト用文字列
} AppData;


/** どうしようもないグローバル変数の皆さん **/
HINSTANCE hInst;    // 現在のインスタンス
TCHAR szTitle[] = TEXT("たー"); // タイトルバーのテキスト
TCHAR szWindowClass[] = TEXT("WindowTestApp");  // ウィンドウクラス名


/** 関数プロトタイプ宣言 **/
LRESULT CALLBACK WndProc(HWND, UINT, WPARAM, LPARAM);
ATOM InitApp(HINSTANCE);
BOOL InitInstance(HINSTANCE, int);


/** アプリケーションのエントリポイント **/
int APIENTRY WinMain(HINSTANCE hInstance, 
                     HINSTANCE hPrevInstance,
                     LPSTR lpCmdLine,
                     int nCmdShow) {
    MSG msg;
    BOOL bRet;
 
    hInst = hInstance;

    if(!InitApp(hInst)) return FALSE;
    if(!InitInstance(hInst, nCmdShow)) return FALSE;

    // メッセージループ
    while((bRet = GetMessage(&msg, NULL, 0, 0)) != 0) {
        if(bRet == -1) break;
        TranslateMessage(&msg);
        DispatchMessage(&msg);
    }
    return (int)msg.wParam;
}

/** ウィンドウクラス登録 **/
ATOM InitApp(HINSTANCE hInstance) {
    WNDCLASSEX wcex;
    wcex.cbSize = sizeof(WNDCLASSEX);
    wcex.style = CS_HREDRAW | CS_VREDRAW;
    wcex.lpfnWndProc = WndProc;
    wcex.cbClsExtra = 0;
    wcex.cbWndExtra = sizeof(LONG_PTR); // メモリ追加確保
    wcex.hInstance = hInstance;
    wcex.hIcon = (HICON)LoadImage(NULL,
        MAKEINTRESOURCE(IDI_APPLICATION),
        IMAGE_ICON,
        0,
        0,
        LR_DEFAULTSIZE | LR_SHARED);
    wcex.hCursor = (HCURSOR)LoadImage(NULL,
        MAKEINTRESOURCE(IDC_ARROW),
        IMAGE_CURSOR,
        0,
        0,
        LR_DEFAULTSIZE | LR_SHARED);
    wcex.hbrBackground = (HBRUSH)GetStockObject(WHITE_BRUSH);
    wcex.lpszMenuName = NULL;
    wcex.lpszClassName = szWindowClass;
    wcex.hIconSm = (HICON)LoadImage(NULL,
        MAKEINTRESOURCE(IDI_APPLICATION),
        IMAGE_ICON,
        0,
        0,
        LR_DEFAULTSIZE | LR_SHARED);
    return RegisterClassEx(&wcex);
}

/** ウィンドウ生成 **/
BOOL InitInstance(HINSTANCE hInstance, int nCmdShow) {
    HWND hWnd = CreateWindow(szWindowClass,
        szTitle,
        WS_OVERLAPPEDWINDOW,
        CW_USEDEFAULT, CW_USEDEFAULT,   // x, y 座標
        CW_USEDEFAULT, CW_USEDEFAULT,   // 幅と高さ
        NULL, NULL,
        hInstance, NULL);
    if(!hWnd) return FALSE;
    ShowWindow(hWnd, nCmdShow);
    UpdateWindow(hWnd);
    return TRUE;
}

/** ウィンドウプロシージャ(コールバック関数) **/
LRESULT CALLBACK WndProc(HWND hWnd, UINT msg, 
                         WPARAM wp, LPARAM lp) {
    // データ構造体の初期化
    AppData* pAppData = (AppData*)GetWindowLongPtr(hWnd, 0);
 
    // 描画関連の変数
    PAINTSTRUCT ps;
    HDC  hdc;
    RECT rect;

    switch(msg) {
        case WM_CREATE:
            pAppData = (AppData*)malloc(sizeof(AppData));

            if(pAppData != NULL) {
    
                /** ここにアプリの初期化処理を書くよ **/
                /** たとえばデータ構造体の初期化とか **/
                pAppData->lpszStr = TEXT("Hello, Tercel!!");

                // ウィンドウの追加領域にポインタを保存
                SetWindowLongPtr(hWnd, 0, (LONG_PTR)pAppData);
            } else {
                MessageBox(hWnd, 
                    TEXT("アプリケーションの初期化に失敗しますた"),
                    TEXT("死の宣告"),
                    MB_OK);
                return -1; // ウィンドウ破棄
            }
            break;
        case WM_PAINT:
            /** 描画処理 **/
            GetClientRect(hWnd, &rect);
            hdc = BeginPaint(hWnd, &ps);

            // せっかくなので、データ構造体から取り出してみる
            DrawText(hdc,
                pAppData->lpszStr,   // 文字列
                -1,                     // 文字列の長さ
                &rect,              // 描画対象の矩形領域
                DT_CENTER | DT_WORDBREAK);
            EndPaint(hWnd, &ps);
            break;
        case WM_DESTROY:
            // 終了時にメモリを解放
            if (pAppData != NULL) free(pAppData);
            SetWindowLongPtr(hWnd, 0, NULL);
            PostQuitMessage(0);
            break;
        default:
            return DefWindowProc(hWnd, msg, wp, lp);
    }
    return 0;
}

基本的なコードであるとはいえ、C 言語の知識だけでは「とりあえず意味不明な構造体をひたすら初期化し、それらをがちがち組み合わせている」くらいにしか見えない(解読には Windows という OS の基礎的な知識も必要)。

最近はフロントエンド構築を可能な限り省力化しようという動きによって、Windows API を直叩きするコーディングスタイルは、もはやレガシーと化しつつあるようだが、ぼくの周りには未だに Windows API を直に叩いてアプリケーションを作る人が多い。.NET なんてもってのほか、MFC ですら許し難いというぶっちぎり硬派な Windows ユーザばかりで、こういうのが苦手なぼくにとっては針の筵である。



というわけで今回は、Windows プログラミングの練習がてら、上記のコードをいじくって OpenCV 2.0 と連繋してみる事にする。OpenCV は極めて強力な画像処理ライブラリであり、高度な処理をいとも簡単に実装する事ができるスグレモノだ。

まずは練習のため画像を表示するだけのプログラムを作ってみよう。一見簡単そうに見えるが、OpenCV と Windows API の連携では画像を表現するデータフォーマットが各々異なっている点がネックとなる。

OpenCV では IplImage 構造体で画像を表現するが、一方 Windows API では HBITMAP 構造体である(画像の実体は BITMAP 構造体だが)。両者に互換性は無いので、その橋渡しをしてやらねばならない。

これを超てきとうに解決していこう。なお、以降は OpenCV 2.0 環境が導入されている事を前提に話を進める。



まず、 cv200.lib、cxcore200.lib、highgui200.lib をリンク。
次に、ソースの冒頭で OpenCV の各ヘッダファイルをインクルードする。

#include <windows.h>
#include <string>

#include <cv.h>
#include <cxcore.h>
#include <highgui.h>

これで、OpenCV の関数が利用できるようになった。

つづいて、アプリケーションデータ構造体を以下のように書き換える。

typedef struct {
    // ウィンドウハンドル
    HWND hWnd;
    
    // メモリデバイスコンテキストとビットマップハンドル
    HDC hMemDC;
    HBITMAP hBitmap;

    // 画像ファイル名
    std::string imageFileName;
    
    // IplImage構造体へのポインタ
    cv::Ptr<IplImage> iplImage;
} AppData;

言い忘れたが、このアプリケーションデータ構造体は、「アプリケーション全体に亘って保持しておきたい変数」をまとめておくためのものである。グローバル変数や静的変数 にすると、プログラムの安全性が著しく低下するだけでなく、多重起動に対応できない(複数のウィンドウが同じグローバル領域を参照するため)という問題点も生じる。

そこで、保持したいグローバルデータを構造体に包み、ウィンドウ毎に(構造体分の)動的領域を確保する事で上記の問題点を回避する。

なお、構造体の中では IplImageHBITMAP の両方を保持する事にした。



さらに、コールバック関数 WndProc の中を大改造する。

switch 文で振り分けられる各メッセージについて、各々以下のように書き換えた。

case WM_CREATE:
        pAppData = (AppData*)new AppData();
    
            /** ここにアプリの初期化処理を書くよ **/
            /** たとえばデータ構造体の初期化とか **/
            pAppData->hBitmap = NULL;
            pAppData->hWnd = hWnd;
            pAppData->iplImage = NULL;

            // ウィンドウの追加領域にポインタを保存
            SetWindowLongPtr(hWnd, 0, (LONG_PTR)pAppData);



        } else {
            MessageBox(hWnd, 
                TEXT("アプリケーションの初期化に失敗しますた"),
                TEXT("死の宣告"),
                MB_OK);
            return -1; // ウィンドウ破棄
        }
        break;

WM_CREATE ではデータ構造体の初期化を行う。本来であればコンストラクタにまとめるべきところなのだが、試行錯誤の結果つぎはぎだらけのコードになってしまった。ご容赦。

尚、ポインタ変数の初期値は問答無用で NULL を入れるように心がけている。これはメモリ周りの厄介なバグを検出するためである。

つづいて、描画処理の WM_PAINT を以下のように書いた。

case WM_PAINT:
    /** 描画処理 **/
    GetClientRect(hWnd, &rect);
    hdc = BeginPaint(hWnd, &ps);

    // ビットブロックを転送
    if(pAppData->hMemDC != NULL 
        && pAppData->hBitmap != NULL) {
                    
            BitBlt(hdc, 0, 0, 
                pAppData->iplImage->width,
                pAppData->iplImage->height,
                pAppData->hMemDC,
                0, 0, SRCCOPY);
                
    }
    EndPaint(hWnd, &ps);
    break;

アプリケーションデータ構造体からビットマップデータを取り出して、そのビットブロックを BitBlt 関数でディスプレイに転送する。もしもアプリケーションデータ構造体にしかるべき値が格納されていれば、これで画像をディスプレイに表示する事が可能となる。

最後に、WM_DESTROY メッセージの処理である。

case WM_DESTROY:
    // 終了時にメモリを解放
    if (pAppData != NULL) {
                
        if(pAppData->hMemDC != NULL) {
            DeleteDC(pAppData->hMemDC);
            pAppData->hMemDC = NULL;
        }

        if(pAppData->hBitmap != NULL) {
            DeleteObject(pAppData->hBitmap);
            pAppData->hBitmap = NULL;
        }

        delete pAppData;
    }
    SetWindowLongPtr(hWnd, 0, NULL);
    PostQuitMessage(0);
    break;

データ構造体のメンバである各ポインタ変数の解放が主な処理だ。



さて、ようやっと画像の読み込み関数を定義する。

まずは前処理として、cvConvertImage 関数によって、IplImage を 1 チャネルまたは 3 チャネルの 8 ビット画像に変換する。 OpenCV の 3 チャネル画像データは、通常 BGR の順で輝度が格納されているが、これも cvConvertImage によって RGB の順に変換される。

この関数は、OpenCV で画像をウィンドウに表示する関数 cvShowImage の中でも暗黙的に呼ばれるものである。

次に、IplImage の画像データのアクセスだが、これは Gary Bradski, Adrian Kaehler著『詳解 OpenCV』でポインタを駆使した有用なコードが示されている。

画像の全ピクセルを走査して RGB の輝度値を取得し、それを SetPixel によってビットマップデータにちくちく書きこんでいく。SetPixel は割と重たい関数だが、別にゲームのようなリアルタイム処理をしたいわけではないし、比較的直感的にピクセル操作が可能なので、ここでは躊躇なく使う事にする。

以上を踏まえ、画像のファイルパス及びアプリケーションデータ構造体へのポインタを引数に取り、 OpenCV の機能を用いて読み込んだ画像を GDI 経由で画面に表示する LoadImage 関数を以下のように定義した。

10分くらいで作ったのでバグってるかも知れないが、いい加減眠いのでこの程度で勘弁してほしい。

HRESULT LoadImage(std::string fileName, AppData* appData) {
    
    // OpenCV の関数を使って指定されたファイルを読み込み
    cv::Ptr<IplImage> img = cvLoadImage(fileName.c_str());

    // 読み込みに失敗したらエラーを返す
    if(img == NULL) return E_FAIL;

    // アプリデータにファイル名をセット
    appData->imageFileName = fileName;

    // 画像を1または3チャネルの8ビット画像に変換
    // さらに画像の各ピクセルの格納順をRGBに調整
    // 必要に応じて、上下反転して、データ構造体に格納
    appData->iplImage = img;
    cvConvertImage(appData->iplImage, appData->iplImage,
        CV_CVTIMG_SWAP_RB | (img->origin == 0 ? 0 : CV_CVTIMG_FLIP));
    
    HDC hdc = GetDC(appData->hWnd);

    // メモリデバイスコンテキストを作るよ!
    if(appData->hMemDC != NULL) {
        DeleteDC(appData->hMemDC);
        appData->hMemDC = NULL;
    }
    appData->hMemDC = CreateCompatibleDC(hdc);

    // ビットマップを作るよ!
    if(appData->hBitmap != NULL) {
        DeleteObject(appData->hBitmap);
        appData->hBitmap = NULL;
    }
    appData->hBitmap = CreateCompatibleBitmap(hdc,
        appData->iplImage->width,
        appData->iplImage->height);

    ReleaseDC(appData->hWnd, hdc);

    SelectObject(appData->hMemDC, appData->hBitmap);

    // IplImage → HBITMAP
    COLORREF color;
    for(int y = 0; y < appData->iplImage->height; ++y) {
        uchar* ptr = (uchar*)(appData->iplImage->imageData 
            + y * appData->iplImage->widthStep);

        for(int x = 0; x < appData->iplImage->width; ++x) {
            if(appData->iplImage->nChannels == 3)
                color = RGB(ptr[3*x], ptr[3*x+1], ptr[3*x+2]);
            else
                color = RGB(ptr[3*x], ptr[3*x], ptr[3*x]);
            SetPixel(appData->hMemDC, x, y, color);
        }
    }
    
    return S_OK;
}



LoadImage 関数をテストするために、コード冒頭に LoadImage のプロトタイプ宣言を追加し、ウィンドウプロシージャ内の WM_CREATE メッセージを処理する部分を以下のように変更した。

case WM_CREATE:
    pAppData = (AppData*)new AppData();

    if(pAppData != NULL) {
    
        /** ここにアプリの初期化処理を書くよ **/
        /** たとえばデータ構造体の初期化とか **/
        pAppData->hBitmap = NULL;
        pAppData->hWnd = hWnd;
        pAppData->iplImage = NULL;

        // ウィンドウの追加領域にポインタを保存
        SetWindowLongPtr(hWnd, 0, (LONG_PTR)pAppData);

        /*** テスト:: 画像の読み込み ***/
        LoadImage("C:\\Users\\tercel\\Pictures\\IMG_1031.JPG", pAppData);

        // ...以下略

これを実行した結果は以下の通り。
なるほど、確かに画像を読み込んで表示する事に成功している。テスト不足だからどこにバグが潜在しているか怖くて仕方ないけど、とりあえず一回分のネタもできたからこれでよい事にしよう。

最後に、現時点での全ソースコードを掲載する。折りたたんでおくので適宜展開してご覧いただきたい。

#include <windows.h>
#include <string>

#include <cv.h>
#include <cxcore.h>
#include <highgui.h>

typedef struct {
    // ウィンドウハンドル
    HWND hWnd;
    
    // メモリデバイスコンテキストとビットマップハンドル
    HDC hMemDC;
    HBITMAP hBitmap;

    // 画像ファイル名
    std::string imageFileName;
    
    // IplImage構造体へのポインタ
    cv::Ptr<IplImage> iplImage;
} AppData;


/** グローバル変数 **/
HINSTANCE hInst;    // 現在のインスタンス
TCHAR szTitle[] = TEXT("たー"); // タイトルバーのテキスト
TCHAR szWindowClass[] = TEXT("WindowTestApp");  // ウィンドウクラス名


/** 関数プロトタイプ宣言 **/
LRESULT CALLBACK WndProc(HWND, UINT, WPARAM, LPARAM);
ATOM InitApp(HINSTANCE);
BOOL InitInstance(HINSTANCE, int);

HRESULT LoadImage(std::string fileName, AppData* appData);

/** アプリケーションのエントリポイント **/
int APIENTRY WinMain(HINSTANCE hInstance, 
                     HINSTANCE hPrevInstance,
                     LPSTR lpCmdLine,
                     int nCmdShow) {
    MSG msg;
    BOOL bRet;
 
    hInst = hInstance;

    if(!InitApp(hInst)) return FALSE;
    if(!InitInstance(hInst, nCmdShow)) return FALSE;

    // メッセージループ
    while((bRet = GetMessage(&msg, NULL, 0, 0)) != 0) {
        if(bRet == -1) break;
        TranslateMessage(&msg);
        DispatchMessage(&msg);
    }
    return (int)msg.wParam;
}

/** ウィンドウクラス登録 **/
ATOM InitApp(HINSTANCE hInstance) {
    WNDCLASSEX wcex;
    wcex.cbSize = sizeof(WNDCLASSEX);
    wcex.style = CS_HREDRAW | CS_VREDRAW;
    wcex.lpfnWndProc = WndProc;
    wcex.cbClsExtra = 0;
    wcex.cbWndExtra = sizeof(LONG_PTR); // メモリ追加確保
    wcex.hInstance = hInstance;
    wcex.hIcon = (HICON)LoadImage(NULL,
        MAKEINTRESOURCE(IDI_APPLICATION),
        IMAGE_ICON,
        0,
        0,
        LR_DEFAULTSIZE | LR_SHARED);
    wcex.hCursor = (HCURSOR)LoadImage(NULL,
        MAKEINTRESOURCE(IDC_ARROW),
        IMAGE_CURSOR,
        0,
        0,
        LR_DEFAULTSIZE | LR_SHARED);
    wcex.hbrBackground = (HBRUSH)GetStockObject(WHITE_BRUSH);
    wcex.lpszMenuName = NULL;
    wcex.lpszClassName = szWindowClass;
    wcex.hIconSm = (HICON)LoadImage(NULL,
        MAKEINTRESOURCE(IDI_APPLICATION),
        IMAGE_ICON,
        0,
        0,
        LR_DEFAULTSIZE | LR_SHARED);
    return RegisterClassEx(&wcex);
}

/** ウィンドウ生成 **/
BOOL InitInstance(HINSTANCE hInstance, int nCmdShow) {
    HWND hWnd = CreateWindow(szWindowClass,
        szTitle,
        WS_OVERLAPPEDWINDOW,
        CW_USEDEFAULT, CW_USEDEFAULT,   // x, y 座標
        CW_USEDEFAULT, CW_USEDEFAULT,   // 幅と高さ
        NULL, NULL,
        hInstance, NULL);
    if(!hWnd) return FALSE;
    ShowWindow(hWnd, nCmdShow);
    UpdateWindow(hWnd);
    return TRUE;
}

/** ウィンドウプロシージャ(コールバック関数) **/
LRESULT CALLBACK WndProc(HWND hWnd, UINT msg, 
                         WPARAM wp, LPARAM lp) {
    // データ構造体の初期化
    AppData* pAppData = (AppData*)GetWindowLongPtr(hWnd, 0);
 
    // 描画関連の変数
    PAINTSTRUCT ps;
    HDC  hdc;
    RECT rect;

    switch(msg) {
        case WM_CREATE:
            pAppData = (AppData*)new AppData();
            
            if(pAppData != NULL) {
    
                /** ここにアプリの初期化処理を書くよ **/
                /** たとえばデータ構造体の初期化とか **/
                pAppData->hBitmap = NULL;
                pAppData->hWnd = hWnd;
                pAppData->iplImage = NULL;

                // ウィンドウの追加領域にポインタを保存
                SetWindowLongPtr(hWnd, 0, (LONG_PTR)pAppData);

                /*** テスト:: 画像の読み込み ***/
                LoadImage("C:\\Users\\tercel\\Pictures\\IMG_1031.JPG", pAppData);
            } else {
                MessageBox(hWnd, 
                    TEXT("アプリケーションの初期化に失敗しますた"),
                    TEXT("死の宣告"),
                    MB_OK);
                return -1; // ウィンドウ破棄
            }
            break;
        case WM_PAINT:
            /** 描画処理 **/
            GetClientRect(hWnd, &rect);
            hdc = BeginPaint(hWnd, &ps);

            // せっかくなので、データ構造体から取り出してみる
            if(pAppData->hMemDC != NULL 
                && pAppData->hBitmap != NULL) {
                    
                    BitBlt(hdc, 0, 0, 
                        pAppData->iplImage->width,
                        pAppData->iplImage->height,
                        pAppData->hMemDC,
                        0, 0, SRCCOPY);
                    
            }
            EndPaint(hWnd, &ps);
            break;
        case WM_DESTROY:
            // 終了時にメモリを解放
            if (pAppData != NULL) {
                
                if(pAppData->hMemDC != NULL) {
                    DeleteDC(pAppData->hMemDC);
                    pAppData->hMemDC = NULL;
                }

                if(pAppData->hBitmap != NULL) {
                    DeleteObject(pAppData->hBitmap);
                    pAppData->hBitmap = NULL;
                }

                delete pAppData;
            }
            SetWindowLongPtr(hWnd, 0, NULL);
            PostQuitMessage(0);
            break;
        default:
            return DefWindowProc(hWnd, msg, wp, lp);
    }
    return 0;
}

HRESULT LoadImage(std::string fileName, AppData* appData) {
    
    // OpenCV の関数を使って指定されたファイルを読み込み
    cv::Ptr<IplImage> img = cvLoadImage(fileName.c_str());

    // 読み込みに失敗したらエラーを返す
    if(img == NULL) return E_FAIL;

    // アプリデータにファイル名をセット
    appData->imageFileName = fileName;

    // 画像を1または3チャネルの8ビット画像に変換
    // さらに画像の各ピクセルの格納順をRGBに調整
    // 必要に応じて、上下反転して、データ構造体に格納
    appData->iplImage = img;
    cvConvertImage(appData->iplImage, appData->iplImage,
        CV_CVTIMG_SWAP_RB | (img->origin == 0 ? 0 : CV_CVTIMG_FLIP));
    
    HDC hdc = GetDC(appData->hWnd);

    // メモリデバイスコンテキストを作るよ!
    if(appData->hMemDC != NULL) {
        DeleteDC(appData->hMemDC);
        appData->hMemDC = NULL;
    }
    appData->hMemDC = CreateCompatibleDC(hdc);

    // ビットマップを作るよ!
    if(appData->hBitmap != NULL) {
        DeleteObject(appData->hBitmap);
        appData->hBitmap = NULL;
    }
    appData->hBitmap = CreateCompatibleBitmap(hdc,
        appData->iplImage->width,
        appData->iplImage->height);

    ReleaseDC(appData->hWnd, hdc);

    SelectObject(appData->hMemDC, appData->hBitmap);

    // IplImage → HBITMAP
    COLORREF color;
    for(int y = 0; y < appData->iplImage->height; ++y) {
        uchar* ptr = (uchar*)(appData->iplImage->imageData 
            + y * appData->iplImage->widthStep);

        for(int x = 0; x < appData->iplImage->width; ++x) {
            if(appData->iplImage->nChannels == 3)
                color = RGB(ptr[3*x], ptr[3*x+1], ptr[3*x+2]);
            else
                color = RGB(ptr[3*x], ptr[3*x], ptr[3*x]);
            SetPixel(appData->hMemDC, x, y, color);
        }
    }
    
    return S_OK;
}