ICCompress

関数

単一の映像フレームを圧縮する。

DLLMSVFW32.dll呼出規約cdecl対応OSWindows 2000 以降

シグネチャ

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

DWORD ICCompress(
    HIC hic,
    DWORD dwFlags,
    BITMAPINFOHEADER* lpbiOutput,
    void* lpData,
    BITMAPINFOHEADER* lpbiInput,
    void* lpBits,
    DWORD* lpckid,   // optional
    DWORD* lpdwFlags,   // optional
    INT lFrameNum,
    DWORD dwFrameSize,
    DWORD dwQuality,
    BITMAPINFOHEADER* lpbiPrev,   // optional
    void* lpPrev   // optional
);

パラメーター

名前	型	方向	説明
hic	HIC	in	使用する圧縮ドライバー(コンプレッサー)へのハンドル。
dwFlags	DWORD	in	圧縮フラグ。次の値が定義されています。 ICCOMPRESS_KEYFRAME コンプレッサーがこのフレームをキーフレームにする必要があることを示します。
lpbiOutput	BITMAPINFOHEADER*	in	出力形式を格納した BITMAPINFOHEADER 構造体へのポインター。
lpData	void*	out	圧縮済みフレームを格納するのに十分な大きさの出力バッファーへのポインター。
lpbiInput	BITMAPINFOHEADER*	in	入力形式を格納した BITMAPINFOHEADER 構造体へのポインター。
lpBits	void*	in	入力バッファーへのポインター。
lpckid	DWORD*	outoptional	予約済み。使用しないでください。
lpdwFlags	DWORD*	outoptional	AVI インデックスで使用される戻りフラグへのポインター。次の値が定義されています。 AVIIF_KEYFRAME 現在のフレームがキーフレームであることを示します。
lFrameNum	INT	in	フレーム番号。
dwFrameSize	DWORD	in	要求するフレームサイズ(バイト単位)。ICGetInfo 関数が返す VIDCF_CRUNCH フラグの有無で示されるように、コンプレッサーが推奨フレームサイズをサポートする場合は、0 以外の値を指定します。このフラグが設定されていない場合、またはフレームのデータレートを指定しない場合は、このパラメーターに 0 を指定します。コンプレッサーは、このパラメーターで指定されたサイズ目標を達成するために、画質を犠牲にしたり、その他のトレードオフを行ったりする必要が生じる場合があります。
dwQuality	DWORD	in	フレームに要求する品質値。ICGetInfo が返す VIDCF_QUALITY フラグの有無で示されるように、コンプレッサーが推奨品質値をサポートする場合は、0 以外の値を指定します。それ以外の場合は、このパラメーターに 0 を指定します。
lpbiPrev	BITMAPINFOHEADER*	inoptional	直前のフレームの形式を格納した BITMAPINFOHEADER 構造体へのポインター。
lpPrev	void*	inoptional	直前のフレームの非圧縮画像へのポインター。このパラメーターは、高速な時間方向圧縮(temporal compression)では使用されません。キーフレームを圧縮する場合、コンプレッサーが時間方向圧縮をサポートしていない場合、またはコンプレッサーが直前の画像の形式およびデータを保存するための外部バッファーを必要としない場合は、このパラメーターに NULL を指定します。

戻り値の型: DWORD

公式ドキュメント

ICCompress 関数は、単一のビデオ画像を圧縮します。

戻り値

成功した場合は ICERR_OK を返します。それ以外の場合はエラーを返します。

解説(Remarks)

出力バッファーに必要なサイズは、ICM_COMPRESS_GET_SIZE メッセージを送信する(または ICCompressGetSize マクロを使用する)ことで取得できます。

コンプレッサーは、キーフレームを作成するときに lpdwFlags の内容を AVIIF_KEYFRAME に設定します。アプリケーションが AVI ファイルを作成する場合は、lpckid および lpdwFlags で返された情報をファイルに保存する必要があります。

コンプレッサーは、時間方向圧縮を行う際に lpbiPrev と lpPrev を使用し、直前のフレームの形式およびデータを保存するための外部バッファーを必要とします。キーフレームを圧縮する場合、高速圧縮を行う場合、またはコンプレッサーが直前の画像の形式およびデータを保存する独自のバッファーを持っている場合は、lpbiPrev と lpPrev に NULL を指定します。ICGetInfo が VIDCF_TEMPORAL フラグを返し、コンプレッサーが通常の圧縮を行っており、圧縮対象のフレームがキーフレームでない場合は、これらのパラメーターに NULL 以外の値を指定します。

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

各言語での呼び出し定義

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

DWORD ICCompress(
    HIC hic,
    DWORD dwFlags,
    BITMAPINFOHEADER* lpbiOutput,
    void* lpData,
    BITMAPINFOHEADER* lpbiInput,
    void* lpBits,
    DWORD* lpckid,   // optional
    DWORD* lpdwFlags,   // optional
    INT lFrameNum,
    DWORD dwFrameSize,
    DWORD dwQuality,
    BITMAPINFOHEADER* lpbiPrev,   // optional
    void* lpPrev   // optional
);

[DllImport("MSVFW32.dll", ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern uint ICCompress(
    IntPtr hic,   // HIC
    uint dwFlags,   // DWORD
    IntPtr lpbiOutput,   // BITMAPINFOHEADER*
    IntPtr lpData,   // void* out
    IntPtr lpbiInput,   // BITMAPINFOHEADER*
    IntPtr lpBits,   // void*
    IntPtr lpckid,   // DWORD* optional, out
    IntPtr lpdwFlags,   // DWORD* optional, out
    int lFrameNum,   // INT
    uint dwFrameSize,   // DWORD
    uint dwQuality,   // DWORD
    IntPtr lpbiPrev,   // BITMAPINFOHEADER* optional
    IntPtr lpPrev   // void* optional
);

<DllImport("MSVFW32.dll", ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function ICCompress(
    hic As IntPtr,   ' HIC
    dwFlags As UInteger,   ' DWORD
    lpbiOutput As IntPtr,   ' BITMAPINFOHEADER*
    lpData As IntPtr,   ' void* out
    lpbiInput As IntPtr,   ' BITMAPINFOHEADER*
    lpBits As IntPtr,   ' void*
    lpckid As IntPtr,   ' DWORD* optional, out
    lpdwFlags As IntPtr,   ' DWORD* optional, out
    lFrameNum As Integer,   ' INT
    dwFrameSize As UInteger,   ' DWORD
    dwQuality As UInteger,   ' DWORD
    lpbiPrev As IntPtr,   ' BITMAPINFOHEADER* optional
    lpPrev As IntPtr   ' void* optional
) As UInteger
End Function

' hic : HIC
' dwFlags : DWORD
' lpbiOutput : BITMAPINFOHEADER*
' lpData : void* out
' lpbiInput : BITMAPINFOHEADER*
' lpBits : void*
' lpckid : DWORD* optional, out
' lpdwFlags : DWORD* optional, out
' lFrameNum : INT
' dwFrameSize : DWORD
' dwQuality : DWORD
' lpbiPrev : BITMAPINFOHEADER* optional
' lpPrev : void* optional
Declare PtrSafe Function ICCompress Lib "msvfw32" ( _
    ByVal hic As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal lpbiOutput As LongPtr, _
    ByVal lpData As LongPtr, _
    ByVal lpbiInput As LongPtr, _
    ByVal lpBits As LongPtr, _
    ByVal lpckid As LongPtr, _
    ByVal lpdwFlags As LongPtr, _
    ByVal lFrameNum As Long, _
    ByVal dwFrameSize As Long, _
    ByVal dwQuality As Long, _
    ByVal lpbiPrev As LongPtr, _
    ByVal lpPrev As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ICCompress = ctypes.cdll.msvfw32.ICCompress
ICCompress.restype = wintypes.DWORD
ICCompress.argtypes = [
    wintypes.HANDLE,  # hic : HIC
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # lpbiOutput : BITMAPINFOHEADER*
    ctypes.POINTER(None),  # lpData : void* out
    ctypes.c_void_p,  # lpbiInput : BITMAPINFOHEADER*
    ctypes.POINTER(None),  # lpBits : void*
    ctypes.POINTER(wintypes.DWORD),  # lpckid : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpdwFlags : DWORD* optional, out
    ctypes.c_int,  # lFrameNum : INT
    wintypes.DWORD,  # dwFrameSize : DWORD
    wintypes.DWORD,  # dwQuality : DWORD
    ctypes.c_void_p,  # lpbiPrev : BITMAPINFOHEADER* optional
    ctypes.POINTER(None),  # lpPrev : void* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MSVFW32.dll')
ICCompress = Fiddle::Function.new(
  lib['ICCompress'],
  [
    Fiddle::TYPE_VOIDP,  # hic : HIC
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpbiOutput : BITMAPINFOHEADER*
    Fiddle::TYPE_VOIDP,  # lpData : void* out
    Fiddle::TYPE_VOIDP,  # lpbiInput : BITMAPINFOHEADER*
    Fiddle::TYPE_VOIDP,  # lpBits : void*
    Fiddle::TYPE_VOIDP,  # lpckid : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpdwFlags : DWORD* optional, out
    Fiddle::TYPE_INT,  # lFrameNum : INT
    -Fiddle::TYPE_INT,  # dwFrameSize : DWORD
    -Fiddle::TYPE_INT,  # dwQuality : DWORD
    Fiddle::TYPE_VOIDP,  # lpbiPrev : BITMAPINFOHEADER* optional
    Fiddle::TYPE_VOIDP,  # lpPrev : void* optional
  ],
  -Fiddle::TYPE_INT, Fiddle::Function::CDECL)

#[link(name = "msvfw32")]
extern "C" {
    fn ICCompress(
        hic: *mut core::ffi::c_void,  // HIC
        dwFlags: u32,  // DWORD
        lpbiOutput: *mut BITMAPINFOHEADER,  // BITMAPINFOHEADER*
        lpData: *mut (),  // void* out
        lpbiInput: *mut BITMAPINFOHEADER,  // BITMAPINFOHEADER*
        lpBits: *mut (),  // void*
        lpckid: *mut u32,  // DWORD* optional, out
        lpdwFlags: *mut u32,  // DWORD* optional, out
        lFrameNum: i32,  // INT
        dwFrameSize: u32,  // DWORD
        dwQuality: u32,  // DWORD
        lpbiPrev: *mut BITMAPINFOHEADER,  // BITMAPINFOHEADER* optional
        lpPrev: *mut ()  // void* optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("MSVFW32.dll", CallingConvention = CallingConvention.Cdecl)]
public static extern uint ICCompress(IntPtr hic, uint dwFlags, IntPtr lpbiOutput, IntPtr lpData, IntPtr lpbiInput, IntPtr lpBits, IntPtr lpckid, IntPtr lpdwFlags, int lFrameNum, uint dwFrameSize, uint dwQuality, IntPtr lpbiPrev, IntPtr lpPrev);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MSVFW32_ICCompress' -Namespace Win32 -PassThru
# $api::ICCompress(hic, dwFlags, lpbiOutput, lpData, lpbiInput, lpBits, lpckid, lpdwFlags, lFrameNum, dwFrameSize, dwQuality, lpbiPrev, lpPrev)

#uselib "MSVFW32.dll"
#func global ICCompress "ICCompress" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; ICCompress hic, dwFlags, varptr(lpbiOutput), lpData, varptr(lpbiInput), lpBits, varptr(lpckid), varptr(lpdwFlags), lFrameNum, dwFrameSize, dwQuality, varptr(lpbiPrev), lpPrev   ; 戻り値は stat
; hic : HIC -> "sptr"
; dwFlags : DWORD -> "sptr"
; lpbiOutput : BITMAPINFOHEADER* -> "sptr"
; lpData : void* out -> "sptr"
; lpbiInput : BITMAPINFOHEADER* -> "sptr"
; lpBits : void* -> "sptr"
; lpckid : DWORD* optional, out -> "sptr"
; lpdwFlags : DWORD* optional, out -> "sptr"
; lFrameNum : INT -> "sptr"
; dwFrameSize : DWORD -> "sptr"
; dwQuality : DWORD -> "sptr"
; lpbiPrev : BITMAPINFOHEADER* optional -> "sptr"
; lpPrev : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "MSVFW32.dll"
#cfunc global ICCompress "ICCompress" sptr, int, var, sptr, var, sptr, var, var, int, int, int, var, sptr
; res = ICCompress(hic, dwFlags, lpbiOutput, lpData, lpbiInput, lpBits, lpckid, lpdwFlags, lFrameNum, dwFrameSize, dwQuality, lpbiPrev, lpPrev)
; hic : HIC -> "sptr"
; dwFlags : DWORD -> "int"
; lpbiOutput : BITMAPINFOHEADER* -> "var"
; lpData : void* out -> "sptr"
; lpbiInput : BITMAPINFOHEADER* -> "var"
; lpBits : void* -> "sptr"
; lpckid : DWORD* optional, out -> "var"
; lpdwFlags : DWORD* optional, out -> "var"
; lFrameNum : INT -> "int"
; dwFrameSize : DWORD -> "int"
; dwQuality : DWORD -> "int"
; lpbiPrev : BITMAPINFOHEADER* optional -> "var"
; lpPrev : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "MSVFW32.dll"
#cfunc global ICCompress "ICCompress" sptr, int, sptr, sptr, sptr, sptr, sptr, sptr, int, int, int, sptr, sptr
; res = ICCompress(hic, dwFlags, varptr(lpbiOutput), lpData, varptr(lpbiInput), lpBits, varptr(lpckid), varptr(lpdwFlags), lFrameNum, dwFrameSize, dwQuality, varptr(lpbiPrev), lpPrev)
; hic : HIC -> "sptr"
; dwFlags : DWORD -> "int"
; lpbiOutput : BITMAPINFOHEADER* -> "sptr"
; lpData : void* out -> "sptr"
; lpbiInput : BITMAPINFOHEADER* -> "sptr"
; lpBits : void* -> "sptr"
; lpckid : DWORD* optional, out -> "sptr"
; lpdwFlags : DWORD* optional, out -> "sptr"
; lFrameNum : INT -> "int"
; dwFrameSize : DWORD -> "int"
; dwQuality : DWORD -> "int"
; lpbiPrev : BITMAPINFOHEADER* optional -> "sptr"
; lpPrev : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。