エンコーダーのコード例

次のコードの例については、AVStream 模擬ハードウェア サンプル ドライバー (AVSHwS)を参照してください。 これらの例は、以下のことを示しています。

  • エンコーダーでサポートされているビット レートを指定する方法

  • エンコーダーでサポートされるビット レート エンコード モードを指定する方法

  • エンコーダー デバイスの「デバイス パラメータ\機能」レジストリ キーで実行時にメタデータ値を指定する方法

サポートされているビット レートの実装

次のコード スニペットは、ENCAPIPARAM_BITRATE プロパティのサポートを実装する方法を示しています。 KSPROPERTY_STEPPING_LONG 構造体を使用して、400 bps の下限と 4,000,000 bps の上限を持つ 400 ビット/秒 (bps) のステップ粒度を指定します。

const KSPROPERTY_STEPPING_LONG BitRateRanges [] = {
    {
        400,
        0,
        400,
        4000000
    }
};

GraphEdit などのツールでフィルターを右クリックしてエンコーダー フィルターのプロパティ ページにアクセスすると、これらの値が使用されているビット レート スライダー バーが表示されます。

次に、エンコーダー フィルターのインスタンスが作成されるときに、エンコーダー フィルターのデフォルト エンコード ビット レートを指定します。 使用されるデータ タイプは、ENCAPIPARAM_BITRATE プロパティに必要なプロパティ値タイプに対応する ULONG であることに注意してください。 この値は、エンコーダーのプロパティ ページに表示されるデフォルトのエンコード ビット レートです。

const ULONG BitRateValues [] = {
    1000000
};

ENCAPIPARAM_BITRATE プロパティの有効範囲の一覧およびデフォルト値を指定します。

 const KSPROPERTY_MEMBERSLIST BitRateMembersList [] = {
    {
        {
            KSPROPERTY_MEMBER_STEPPEDRANGES,
            sizeof (BitRateRanges),
            SIZEOF_ARRAY (BitRateRanges),
            0
        },
        BitRateRanges
    },
    {
        {
            KSPROPERTY_MEMBER_VALUES,
            sizeof (BitRateValues),
            SIZEOF_ARRAY (BitRateValues),
            KSPROPERTY_MEMBER_FLAG_DEFAULT
        },
        BitRateValues
    }
};
 const KSPROPERTY_VALUES BitRateValuesSet = {
    {
        STATICGUIDOF (KSPROPTYPESETID_General),
        VT_UI4,
        0
    },
    SIZEOF_ARRAY (BitRateMembersList),
    BitRateMembersList
};

ENCAPIPARAM_BITRATE プロパティ セットに定義されている単一のプロパティを指定します。

DEFINE_KSPROPERTY_TABLE(ENCAPI_BitRate) {
    DEFINE_KSPROPERTY_ITEM (
        0,
        GetBitRateHandler, //Get-property handler supported
        sizeof (KSPROPERTY),
        sizeof (ULONG),
        SetBitRateHandler, //Set-property handler supported
        &BitRateValuesSet,
        0,
        NULL,
        NULL,
        sizeof (ULONG)
        )
};

Note

get プロパティ ハンドラーはエンコード ビット レートを返します。Set プロパティ ハンドラーは、渡された値が有効かどうかを使用する前にテストする必要があります。

サポートされているエンコード ビット レート モードの実装

次のコード スニペットは、ENCAPIPARAM_BITRATE_MODE プロパティのサポートを実装する方法を示しています。

エンコーダーでサポートされるエンコード モードを定義します。

 const VIDEOENCODER_BITRATE_MODE BitRateModeValues [] = {
    ConstantBitRate,
    VariableBitRateAverage
};

デフォルトのエンコード ビット レートモードを平均可変ビットレートとして指定します:

const VIDEOENCODER_BITRATE_MODE BitRateModeDefaultValues [] = {
    VariableBitRateAverage
};

ENCAPIPARAM_BITRATE_MODE プロパティの有効範囲の一覧およびデフォルト値を指定します。

const KSPROPERTY_MEMBERSLIST BitRateModeMembersList [] = {
    {
        {
            KSPROPERTY_MEMBER_VALUES,
            sizeof (BitRateModeValues),
            SIZEOF_ARRAY (BitRateModeValues),
            0
        },
        BitRateModeValues
    },
    {
        {
            KSPROPERTY_MEMBER_VALUES,
            sizeof (BitRateModeDefaultValues),
            SIZEOF_ARRAY (BitRateModeDefaultValues),
            KSPROPERTY_MEMBER_FLAG_DEFAULT
        },
        BitRateModeDefaultValues
    }
};

const KSPROPERTY_VALUES BitRateModeValuesSet = {
    {
        STATICGUIDOF (KSPROPTYPESETID_General),
        VT_I4,
        0
    },
    SIZEOF_ARRAY (BitRateModeMembersList),
    BitRateModeMembersList
};

ENCAPIPARAM_BITRATE_MODE プロパティ セットに定義されている単一のプロパティを指定します。

DEFINE_KSPROPERTY_TABLE(ENCAPI_BitRateMode) {
    DEFINE_KSPROPERTY_ITEM (
        0,
        GetBitRateModeHandler, //Get-property handler supported
        sizeof (KSPROPERTY),
        sizeof (VIDEOENCODER_BITRATE_MODE),
        SetBitRateModeHandler, //Set-property handler supported
        &BitRateModeValuesSet,
        0,
        NULL,
        NULL,
        sizeof (VIDEOENCODER_BITRATE_MODE)
        )
};

Note

get プロパティ ハンドラーはエンコード ビット レートを返す必要があります。Set プロパティ ハンドラーは、渡された値が有効かどうかを使用する前にテストする必要があります。

プロパティ セットは、KSFILTER_DESCRIPTOR 構造体のオートメーション テーブルとして指定されます。

DEFINE_KSPROPERTY_SET_TABLE(PropertyTable) {
    DEFINE_KSPROPERTY_SET(
        &ENCAPIPARAM_BITRATE_MODE,
        SIZEOF_ARRAY (ENCAPI_BitRateMode),
        ENCAPI_BitRateMode,
        0,
        NULL
        ),
    DEFINE_KSPROPERTY_SET(
        &ENCAPIPARAM_BITRATE,
        SIZEOF_ARRAY (ENCAPI_BitRate),
        ENCAPI_BitRate,
        0,
        NULL
        )
};

DEFINE_KSAUTOMATION_TABLE(FilterTestTable) {
    DEFINE_KSAUTOMATION_PROPERTIES(PropertyTable),
    DEFINE_KSAUTOMATION_METHODS_NULL,
    DEFINE_KSAUTOMATION_EVENTS_NULL
};

const
KSFILTER_DESCRIPTOR
FilterDescriptor = {
    ...,
    &FilterTestTable, // Automation Table
    ...,
    ...
};

レジストリでのエンコーダーの機能の指定

次のコード サンプルでは、デバイス パラメーター レジストリ キーの下に機能レジストリ キーを作成する方法およぼ、機能キーの下にサブ キーと値を作成して指定する方法を示します。 ドライバーの初期化時に、このコードを実行します。

Note

次のコードでは、物理デバイスごとに 1 つのハードウェア エンコーダーが存在することを前提としています。 ハードウェアに複数のエンコーダが含まれている場合は、IoGetDeviceInterfaces 関数の呼び出しで返されたリストを繰り返し処理し、各エンコーダの機能を登録する必要があります。

/**************************************************************************
CreateDwordValueInCapabilityRegistry()

IN Pdo: PhysicalDeviceObject
IN categoryGUID: Category GUID eg KSCATEGORY_CAPTURE

1. Get Symbolic name for interface
2. Open registry key for storing information about a
   particular device interface instance
3. Create Capabilities key under "Device Parameters" key
4. Create a DWORD value "TestCapValueDWORD" under Capabilities

Must be running at IRQL = PASSIVE_LEVEL in the context of a system thread
**************************************************************************/
NTSTATUS CreateDwordValueInCapabilityRegistry(IN PDEVICE_OBJECT pdo, IN GUID categoryGUID)

{

    // 1. Get Symbolic name for interface
    // pSymbolicNameList can contain multiple strings if pdo is NULL.
    // Driver should parse this list of string to get
    // the one corresponding to current device interface instance.
    PWSTR  pSymbolicNameList = NULL;

    NTSTATUS ntStatus = IoGetDeviceInterfaces(
        &categoryGUID,
        pdo,
        DEVICE_INTERFACE_INCLUDE_NONACTIVE,
        &pSymbolicNameList);
    if (NT_SUCCESS(ntStatus) && (NULL != pSymbolicNameList))
    {
        HANDLE hDeviceParametersKey = NULL;
        UNICODE_STRING symbolicName;

        // 2. Open registry key for storing information about a
        // particular device interface instance
        RtlInitUnicodeString(&symbolicName, pSymbolicNameList);
        ntStatus = IoOpenDeviceInterfaceRegistryKey(
            &symbolicName,
            KEY_READ|KEY_WRITE,
            &hDeviceParametersKey);
        if (NT_SUCCESS(ntStatus))
        {
            OBJECT_ATTRIBUTES objAttribSubKey;
            UNICODE_STRING subKey;

            // 3. Create Capabilities key under "Device Parameters" key
            RtlInitUnicodeString(&subKey,L"Capabilities");
            InitializeObjectAttributes(&objAttribSubKey,
                &subKey,
                OBJ_KERNEL_HANDLE,
                hDeviceParametersKey,
                NULL);

            HANDLE hCapabilityKeyHandle = NULL;

            ntStatus = ZwCreateKey(&hCapabilityKeyHandle,
                    KEY_READ|KEY_WRITE|KEY_SET_VALUE,
                    &objAttribSubKey,
                    0,
                    NULL,
                    REG_OPTION_NON_VOLATILE,
                    NULL);
            if (NT_SUCCESS(ntStatus))
            {
                OBJECT_ATTRIBUTES objAttribDwordKeyVal;
                UNICODE_STRING subValDword;

                // 4. Create a DWORD value "TestCapValueDWORD" under Capabilities
                RtlInitUnicodeString(&subValDword,L"TestCapValueDWORD");

                ULONG data = 0xaaaaaaaa;

                ntStatus = ZwSetValueKey(hCapabilityKeyHandle,&subValDword,0,REG_DWORD,&data,sizeof(ULONG));
                ZwClose(hCapabilityKeyHandle);
            }
        }
        ZwClose(hDeviceParametersKey);
        ExFreePool(pSymbolicNameList);
    }

    return ntStatus;
}