cvReleaseImageの挙動について

OpenCV/videoInput Libraryによるビデオキャプチャのサンプルプログラムについて,
HandyARのデモが動かない問題の原因を発見した – サイScripterの旅立ちにて以下の指摘がありました.

どこのサイトを見ても、どうも怪しいコードしか載っていないように見える。

cvCreateImage後はimageDataにアロケートされているんだから、imageDataに代入しちゃったら解放するアドレスがわからないと思うんだけどなぁ。

でもメモリーリークの警告でないしなぁ・・・

結論から言うとメモリ解放について問題は無いです.ということで,
こちらとしても,「怪しいコードと断定」されるのも癪なので,
なぜ問題無いかについて少し書いてみます.

まず,cvReleaseImageの内部で何をやっているかというと,
確保したイメージ領域の解放のためにcvReleaseDataをコールしています.
cxarray.cppのcvReleaseData関数の中身を以下に示します.

[cpp]
// Deallocates array’s data
CV_IMPL void
cvReleaseData( CvArr* arr )
{
CV_FUNCNAME( “cvReleaseData” );

__BEGIN__;

if( CV_IS_MAT_HDR( arr ) || CV_IS_MATND_HDR( arr ))
{
CvMat* mat = (CvMat*)arr;
cvDecRefData( mat );
}
else if( CV_IS_IMAGE_HDR( arr ))
{
IplImage* img = (IplImage*)arr;

if( !CvIPL.deallocate )
{
char* ptr = img->imageDataOrigin;
img->imageData = img->imageDataOrigin = 0;
cvFree( &ptr );
}
else
{
CvIPL.deallocate( img, IPL_IMAGE_DATA );
}
}
else
{
CV_ERROR( CV_StsBadArg, “unrecognized or unsupported array type” );
}

__END__;
}
[/cpp]

その中で,
[cpp]
if( !CvIPL.deallocate )
{
char* ptr = img->imageDataOrigin;
img->imageData = img->imageDataOrigin = 0;
cvFree( &ptr );
}
[/cpp]
という部分からわかるように実際に解放するメモリ領域の先頭アドレスとして指定されるのは
img->imageDataOriginであることがわかると思います.

では,img->imageDataOriginって何?という話になるので,
IplImage構造体について一度確認してみましょう.
cxtypes.hのIplImage構造体の定義を以下に示します.

[cpp]
typedef struct _IplImage
{
int nSize; /* sizeof(IplImage) */
int ID; /* version (=0)*/
int nChannels; /* Most of OpenCV functions support 1,2,3 or 4 channels */
int alphaChannel; /* ignored by OpenCV */
int depth; /* pixel depth in bits: IPL_DEPTH_8U, IPL_DEPTH_8S, IPL_DEPTH_16S,
IPL_DEPTH_32S, IPL_DEPTH_32F and IPL_DEPTH_64F are supported */
char colorModel[4]; /* ignored by OpenCV */
char channelSeq[4]; /* ditto */
int dataOrder; /* 0 – interleaved color channels, 1 – separate color channels.
cvCreateImage can only create interleaved images */
int origin; /* 0 – top-left origin,
1 – bottom-left origin (Windows bitmaps style) */
int align; /* Alignment of image rows (4 or 8).
OpenCV ignores it and uses widthStep instead */
int width; /* image width in pixels */
int height; /* image height in pixels */
struct _IplROI *roi;/* image ROI. if NULL, the whole image is selected */
struct _IplImage *maskROI; /* must be NULL */
void *imageId; /* ditto */
struct _IplTileInfo *tileInfo; /* ditto */
int imageSize; /* image data size in bytes
(==image->height*image->widthStep
in case of interleaved data)*/
char *imageData; /* pointer to aligned image data */
int widthStep; /* size of aligned image row in bytes */
int BorderMode[4]; /* ignored by OpenCV */
int BorderConst[4]; /* ditto */
char *imageDataOrigin; /* pointer to very origin of image data
(not necessarily aligned) –
needed for correct deallocation */
}
IplImage;
[/cpp]

コメントにもありますが,imageDataOriginは,cvCreateImageで確保したイメージ領域を解放する
ことを保証するために用意されていて,実際にcvCreateImage関数の内部で
呼ばれるcvCreateData関数の中で,イメージ領域の割り当て時に
イメージ領域の先頭アドレスはimageDataとimageDataOriginの両方に格納されます.
cvarray.cppのcvCreateData関数の一部を以下に示します.

[cpp]
if( !CvIPL.allocateData )
{
CV_CALL( img->imageData = img->imageDataOrigin =
(char*)cvAlloc( (size_t)img->imageSize ));
}
[/cpp]

ということで,imageDataが変更されても,imageDataOriginにイメージ領域の先頭アドレスが
格納されているので,cvReleaseImageできちんと解放されることがおわかりいただけると思います.

そんなわけで,OpenCVの内部でどうなっているかを把握した上で書いている点ご理解ください.
※誤解を生まないようVI.getPixelsで取得したイメージデータをmemcpy使ってコピーすれば
 いいんでしょうけど,ループ中にメモリコピーを行うと速度が落ちそうなので,ポインタの変更で済ませちゃってます.

#まぁ,指摘通り,C,C++がある程度わかる人には一見危なそうに見えるのは事実なんですが,
#このようにきちんと内部動作まで解説するとそれなりに大変で,初心者がそれを読むと挫折しそうなので
#今のところ説明を省いています.その辺のバランスって難しいですよね。。。
#何か良い案があれば教えてください.

cvReleaseImageの挙動について」への4件のフィードバック

  1. いつぞやメールでお尋ねしたやつですねw
    わかる人が見ると最初に「解放は大丈夫か」というところに目が行くのでやっぱり気になっちゃいますよね.
    玄人と初心者を両方カバーするならば,とりあえず安全そうに見えるコードを書いておいて,玄人向けに
    「まぁこうしなくてもいいんですけど」というコメ,というスタンスが良いのかな.

    # IVRCでお会いしたものの「あ,ども」で終わってしまってすみませんでした.
    # ほんとはゆっくりお話したかったんですが・・・

  2. >いつぞやメールでお尋ねしたやつですねw
    そうです.約1年ぶりですっかり忘れていました。。。(苦笑)
    スミマセン.

    >玄人と初心者を両方カバーするならば,とりあえず安全そうに見えるコードを書いておいて,玄人向けに
    >「まぁこうしなくてもいいんですけど」というコメ,というスタンスが良いのかな.

    ・以前,提案されていたヘッダだけ生成する方法
    or
    ・memcpyを行う方法

    をwikiの方で紹介してから,このエントリに誘導するようにしたいと思います.
    ということで,お忙しい中アドバイスありがとうございました.

    それにしても,指摘されたblogに対してこの記事を書いたことをコメントしてきたのに
    完全にスルーされています。。。(少なくとも反応位は欲しいところですが)

    ># IVRCでお会いしたものの「あ,ども」で終わってしまってすみませんでした.
    ># ほんとはゆっくりお話したかったんですが・・・
    こちらこそ.すみません.取材がお忙しそうだったので,遠慮してしまいました(苦笑)
    また,機会があるような気がするのでそのときはよろしくお願いします.

  3. 問題のブログのものです。わざわざ詳細を書いていただいてありがとうございます。
    いくつかのサイトでそのようなコードがあったのですが、どうも自分の中で納得がいかなくて、少しソースを眺めていての結果だったのですが、どうやら読み間違えているようです。
    しっかりリソースを開放するための仕掛けを確保しているんですね。

    まだまだOpenCVのコードが読めていなくて、勉強不足でした。

    ブログの管理も結構適当ですいませんでした。

  4. >問題のブログのものです。わざわざ詳細を書いていただいてありがとうございます。
    こちらこそ内部処理まで追った記述をwikiに明記してなくて申し訳ないです.

    >まだまだOpenCVのコードが読めていなくて、勉強不足でした。
    OpenCVを内部まで読んでみるといろいろ工夫しているところがあっておもしろいので,
    興味があれば読んでみると良いかもしれません.

    ということでご指摘ありがとうございました.

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です