ホーム › Media.MediaFoundation › MFCalculateBitmapImageSize

MFCalculateBitmapImageSize

関数

ビットマップヘッダーから画像データのサイズを計算する。

DLLMFPlat.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// MFPlat.dll
#include <windows.h>

HRESULT MFCalculateBitmapImageSize(
    const BITMAPINFOHEADER* pBMIH,
    DWORD cbBufSize,
    DWORD* pcbImageSize,
    BOOL* pbKnown   // optional
);

パラメーター

名前	型	方向	説明
pBMIH	BITMAPINFOHEADER*	in	形式を記述する BITMAPINFOHEADER 構造体へのポインター。
cbBufSize	DWORD	in	pBMIH バッファーのサイズ(バイト単位)。このサイズには、BITMAPINFOHEADER 構造体に続くカラーマスクやパレットエントリも含まれます。
pcbImageSize	DWORD*	out	画像サイズ(バイト単位)を受け取ります。
pbKnown	BOOL*	outoptional	関数がビデオ形式を認識した場合は値 TRUE を受け取り、それ以外の場合は値 FALSE を受け取ります。このパラメーターは NULL にすることができます。

戻り値の型: HRESULT

公式ドキュメント

ビデオ形式の画像サイズを取得します。

戻り値

この関数は HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値	説明
S_OK	関数は成功しました。
E_INVALIDARG	BITMAPINFOHEADER 構造体が無効であるか、cbBufSize の値が小さすぎます。

解説(Remarks)

この関数を呼び出す前に、少なくとも BITMAPINFOHEADER 構造体の次のメンバーを設定する必要があります。

biCompression
biBitCount
biWidth
biHeight

また、biCompression が BI_BITFIELDS の場合、BITMAPINFOHEADER 構造体の後にカラーマスクの配列が続いている必要があります。

この関数は、BITMAPINFOHEADER 構造体がビデオ形式以外の形式を記述している場合は失敗します。たとえば、biCompresson が BI_JPEG または BI_PNG の場合は失敗します。

この関数は、Windows Media Format 11 SDK の再頒布可能コンポーネントがインストールされている場合、次のプラットフォームで使用できます。

Windows XP Service Pack 2 (SP2) 以降。
KB900325 (Windows XP Media Center Edition 2005) および KB925766 (October 2006 Update Rollup for Windows XP Media Center Edition) がインストールされた Windows XP Media Center Edition 2005。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// MFPlat.dll
#include <windows.h>

HRESULT MFCalculateBitmapImageSize(
    const BITMAPINFOHEADER* pBMIH,
    DWORD cbBufSize,
    DWORD* pcbImageSize,
    BOOL* pbKnown   // optional
);

[DllImport("MFPlat.dll", ExactSpelling = true)]
static extern int MFCalculateBitmapImageSize(
    IntPtr pBMIH,   // BITMAPINFOHEADER*
    uint cbBufSize,   // DWORD
    out uint pcbImageSize,   // DWORD* out
    IntPtr pbKnown   // BOOL* optional, out
);

<DllImport("MFPlat.dll", ExactSpelling:=True)>
Public Shared Function MFCalculateBitmapImageSize(
    pBMIH As IntPtr,   ' BITMAPINFOHEADER*
    cbBufSize As UInteger,   ' DWORD
    <Out> ByRef pcbImageSize As UInteger,   ' DWORD* out
    pbKnown As IntPtr   ' BOOL* optional, out
) As Integer
End Function

' pBMIH : BITMAPINFOHEADER*
' cbBufSize : DWORD
' pcbImageSize : DWORD* out
' pbKnown : BOOL* optional, out
Declare PtrSafe Function MFCalculateBitmapImageSize Lib "mfplat" ( _
    ByVal pBMIH As LongPtr, _
    ByVal cbBufSize As Long, _
    ByRef pcbImageSize As Long, _
    ByVal pbKnown As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MFCalculateBitmapImageSize = ctypes.windll.mfplat.MFCalculateBitmapImageSize
MFCalculateBitmapImageSize.restype = ctypes.c_int
MFCalculateBitmapImageSize.argtypes = [
    ctypes.c_void_p,  # pBMIH : BITMAPINFOHEADER*
    wintypes.DWORD,  # cbBufSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbImageSize : DWORD* out
    ctypes.c_void_p,  # pbKnown : BOOL* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MFPlat.dll')
MFCalculateBitmapImageSize = Fiddle::Function.new(
  lib['MFCalculateBitmapImageSize'],
  [
    Fiddle::TYPE_VOIDP,  # pBMIH : BITMAPINFOHEADER*
    -Fiddle::TYPE_INT,  # cbBufSize : DWORD
    Fiddle::TYPE_VOIDP,  # pcbImageSize : DWORD* out
    Fiddle::TYPE_VOIDP,  # pbKnown : BOOL* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "mfplat")]
extern "system" {
    fn MFCalculateBitmapImageSize(
        pBMIH: *const BITMAPINFOHEADER,  // BITMAPINFOHEADER*
        cbBufSize: u32,  // DWORD
        pcbImageSize: *mut u32,  // DWORD* out
        pbKnown: *mut i32  // BOOL* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("MFPlat.dll")]
public static extern int MFCalculateBitmapImageSize(IntPtr pBMIH, uint cbBufSize, out uint pcbImageSize, IntPtr pbKnown);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MFPlat_MFCalculateBitmapImageSize' -Namespace Win32 -PassThru
# $api::MFCalculateBitmapImageSize(pBMIH, cbBufSize, pcbImageSize, pbKnown)

#uselib "MFPlat.dll"
#func global MFCalculateBitmapImageSize "MFCalculateBitmapImageSize" sptr, sptr, sptr, sptr
; MFCalculateBitmapImageSize varptr(pBMIH), cbBufSize, varptr(pcbImageSize), varptr(pbKnown)   ; 戻り値は stat
; pBMIH : BITMAPINFOHEADER* -> "sptr"
; cbBufSize : DWORD -> "sptr"
; pcbImageSize : DWORD* out -> "sptr"
; pbKnown : BOOL* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "MFPlat.dll"
#cfunc global MFCalculateBitmapImageSize "MFCalculateBitmapImageSize" var, int, var, var
; res = MFCalculateBitmapImageSize(pBMIH, cbBufSize, pcbImageSize, pbKnown)
; pBMIH : BITMAPINFOHEADER* -> "var"
; cbBufSize : DWORD -> "int"
; pcbImageSize : DWORD* out -> "var"
; pbKnown : BOOL* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "MFPlat.dll"
#cfunc global MFCalculateBitmapImageSize "MFCalculateBitmapImageSize" sptr, int, sptr, sptr
; res = MFCalculateBitmapImageSize(varptr(pBMIH), cbBufSize, varptr(pcbImageSize), varptr(pbKnown))
; pBMIH : BITMAPINFOHEADER* -> "sptr"
; cbBufSize : DWORD -> "int"
; pcbImageSize : DWORD* out -> "sptr"
; pbKnown : BOOL* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。