Handling KSPROPERTY_CAMERACONTROL_EXTENDED_PROFILE on avscamera DMFT #1325

welljeng · 2025-09-24T06:18:52Z

In avscamera DMFT, its KsEvent and KsProperty functions handle KSPROPERTY_CAMERACONTROL_EXTENDED_PROFILE property to allow DMFT to behave appropriately in response of various camera streaming profile selected.

…ng behavior on camera DMFT.

chrilaMSFT · 2025-09-25T20:47:24Z

avstream/avscamera/DMFT/AvsCameraDMFT.cpp

+    }
 done:
-    return hr;
+    return S_OK;


S_OK

return hr

If source device return failed on the following, hr won't hold S_OK here. I would assume if source device returned failed, but the DMFT itself supports the KsEvent, it should reply OK.

https://github.com/welljeng/Windows-driver-samples/blob/4a380c3ff93f2227e40865cb472638954b3c31a1/avstream/avscamera/DMFT/AvsCameraDMFT.cpp#L1107

chrilaMSFT · 2025-09-25T20:50:09Z

avstream/avscamera/DMFT/AvsCameraDMFT.cpp

+        && (pEvent->Id == KSPROPERTY_CAMERACONTROL_EXTENDED_PROFILE))
+    {
+
+        m_hSelectedProfileKSEvent = nullptr;


m_hSelectedProfileKSEvent

use WIL handle object looks like this code leaks handles

chrilaMSFT · 2025-09-25T20:50:29Z

IFACEMETHODIMP CMultipinMft::KsEvent(

no lock?

Refers to: avstream/avscamera/DMFT/AvsCameraDMFT.cpp:1055 in 4a380c3. [](commit_id = 4a380c3, deletion_comment = False)

chrilaMSFT · 2025-09-25T20:51:10Z

avstream/avscamera/DMFT/AvsCameraDMFT.cpp

+            FALSE,
+            DUPLICATE_SAME_ACCESS) == false)
+        {
+            return E_INVALIDARG;


return E_INVALIDARG;

match coding style of the rest of the code with macro checks

chrilaMSFT · 2025-09-25T21:12:09Z

avstream/avscamera/DMFT/AvsCameraDMFT.cpp

+    if (pProperty->Id == KSPROPERTY_CAMERACONTROL_EXTENDED_PROFILE)
+    {
+        DMFTCHECKHR_GOTO(ProfilePropertyHandler(pProperty, ulPropertyLength, pvPropertyData, ulDataLength, pulBytesReturned), done);
+        goto done;


NIT: only use goto for error case

chrilaMSFT · 2025-09-25T21:12:45Z

avstream/avscamera/DMFT/AvsCameraDMFT.cpp

+        }
+        if (m_isProfileDDISupportedInBaseDriver.value_or(true))
+        {
+            m_hSelectedProfileKSEventSentToDriver = CreateEventExW(


m_hSelectedProfileKSEventSentToDriver

use WIL event

chrilaMSFT · 2025-09-25T21:13:31Z

avstream/avscamera/DMFT/AvsCameraDMFT.cpp

+    UNREFERENCED_PARAMETER(ulPropertyLength);
+    HRESULT hr = S_OK;
+
+    if (pProperty->Flags & KSPROPERTY_TYPE_SET)


chrilaMSFT · 2025-09-25T21:15:37Z

avstream/avscamera/DMFT/AvsCameraDMFT.cpp

        // Deref on the connected outpins to break reference loop
        (VOID)pInPin->ShutdownPin();
    }
    return ShutdownEventGenerator();


Need to handle canceling event and outstanding controls in shutdown

chrilaMSFT · 2025-09-25T21:17:17Z

avstream/avscamera/DMFT/AvsCameraDMFT.vcxproj

    <ClCompile>
      <PreprocessorDefinitions>%(PreprocessorDefinitions);UNICODE;MF_WPP;SECURITY_WIN32;MFT_UNIQUE_METHOD_NAMES;MF_DEVICEMFT_ALLOW_MFT0_LOAD</PreprocessorDefinitions>
      <AdditionalIncludeDirectories>$(IntDir);%(AdditionalIncludeDirectories);..\..\common;..\common</AdditionalIncludeDirectories>
+      <LanguageStandard>stdcpp17</LanguageStandard>


stdcpp17

I would recommend minimizing the $(Configuration)|$(Platform) unique configs move the common ones to a global setting

chrilaMSFT · 2025-09-25T21:18:43Z

avstream/avscamera/DMFT/AvsCameraDMFT.cpp

+                }
+                SetEvent(m_hSelectedProfileKSEvent);
+                m_hSelectedProfileKSEvent = nullptr;
+            }


Wait should not block

Consider using MFPutWaitingWorkItem to signal the m_hSelectedProfileKSEvent (using m_hSelectedProfileKSEventSentToDriver as the event handle to the API in question). This doesn't afford you the ability to use a timeout, but the spec requires drivers to signal the event both in the case of success or if the operation can't complete.

chrilaMSFT · 2025-09-25T21:19:24Z

avstream/avscamera/DMFT/AvsCameraDMFT.cpp

+
+    /// PDMFT only cares about ExtendedCameraControls, all others 
+    /// are just blindly forwarded to the upstream DMFTs. 
+    if (!IsEqualCLSID(pProperty->Set, KSPROPERTYSETID_ExtendedCameraControl))


IsEqualCLSID

requires a lock

chrilaMSFT · 2025-09-25T21:21:34Z

avstream/avscamera/DMFT/AvsCameraDMFT.h

    PWCHAR                       m_SymbolicLink;
+    HANDLE                       m_hSelectedProfileKSEvent;
+    HANDLE                       m_hSelectedProfileKSEventSentToDriver;
+    std::optional<bool>          m_isProfileDDISupportedInBaseDriver;


m_isProfileDDISupportedInBaseDriver

this should be a static property of the DMFT since it ideally is developed with the camera/driver it is being used with

I am hesitate of make it static since if the same DMFT is being applied on multiple camera DMFT chain, all the DMFT instances will share the same m_isProfileDDISupportedInBaseDriver value, which might not be the ideal case.
Correct me if I were wong.

chrilaMSFT · 2025-09-25T21:22:23Z

avstream/avscamera/DMFT/AvsCameraDMFT.h


 interface IDirect3DDeviceManager9;

+constexpr int kMAX_WAIT_TIME_DRIVER_PROFILE_KSEVENT = 3000;// ms, amount of time to wait for the profile DDI KsEvent sent to the driver


kMAX_WAIT_TIME_DRIVER_PROFILE_KSEVENT

I think pipeline should handle max wait

chrilaMSFT · 2025-09-25T21:23:14Z

avstream/avscamera/DMFT/AvsCameraDMFT.cpp

+// TODO: required to avoid bug OS bug 36971659 in extended property handling that introduces a 16 bytes cookie
+typedef struct
+{
+    //byte cookieBuffer[16];


remove commented out code

chrilaMSFT · 2025-09-25T21:23:31Z

avstream/avscamera/DMFT/AvsCameraDMFT.cpp

    DMFTCHECKHR_GOTO(pAttributes->SetUINT32( MF_SA_D3D_AWARE, TRUE ), done);
    DMFTCHECKHR_GOTO(pAttributes->SetString( MFT_ENUM_HARDWARE_URL_Attribute, L"SampleMultiPinMft" ),done);
    m_spAttributes = pAttributes;
+


NIT: remove

SangChoe · 2025-09-25T22:21:18Z

avstream/avscamera/DMFT/AvsCameraDMFT.cpp

-        pvPropertyData,
-        ulDataLength,
-        pulBytesReturned),done);
+    if (pProperty->Id == KSPROPERTY_CAMERACONTROL_EXTENDED_PROFILE)


if (pProperty->Id == KSPROPERTY_CAMERACONTROL_EXTENDED_PROFILE)

This is incorrect. You're only checking against the Id. The combination should always be Set + Id to determine the control.

In this particular case, you're going to intercept any control whose Id is 34 regardless of whether that Id belongs to the KSPROPERTYSETID_ExtendedCameraControl or not. I think what you meant to do here is to intercept and call ProfilePropertyHandler only if the Set == KSPROPERTYSETID_ExtendedCameraControl && Id == KSPROPERTY_CAMERACONTROL_EXTENDED_PROFILE.

Excellent poinnt!!

SangChoe · 2025-09-25T22:23:10Z

avstream/avscamera/DMFT/AvsCameraDMFT.cpp

+
+            m_selectedProfileId.Type = pProfile->ProfileId;
+            m_selectedProfileId.Index = pProfile->Index;
+            m_selectedProfileId.Unused = pProfile->Reserved;


This information is never forwarded to the driver so the SentToDriver event will never signal.

Frank Cheng and others added 4 commits September 24, 2025 14:18

Handling KsEvent, KSCAMERAPROFILE_FaceAuth_Mode for different streami…

68cc5fa

…ng behavior on camera DMFT.

Remove Wil dependancy from AvsCameraDMFT.vcxproj to fix CI/CD issue.

bc6eda8

Eliminate WIL dependancy on AvsCameraDMFT.h/cpp.

93a1488

Merge branch 'main' into user/chengfrank/DMFTFaceAuth

4a380c3

welljeng changed the title ~~Handling KsEvent, KSCAMERAPROFILE_FaceAuth_Mode for different streami…~~ Handling KSCAMERAPROFILE_FaceAuth_Mode on avscamera DMFT Sep 25, 2025

welljeng changed the title ~~Handling KSCAMERAPROFILE_FaceAuth_Mode on avscamera DMFT~~ Handling KSPROPERTY_CAMERACONTROL_EXTENDED_PROFILE on avscamera DMFT Sep 25, 2025

welljeng marked this pull request as ready for review September 25, 2025 18:02

welljeng requested a review from a team as a code owner September 25, 2025 18:02

chrilaMSFT reviewed Sep 25, 2025

View reviewed changes

chrilaMSFT requested review from jiteshkris and a team September 25, 2025 21:26

SangChoe reviewed Sep 25, 2025

View reviewed changes


		interface IDirect3DDeviceManager9;

		constexpr int kMAX_WAIT_TIME_DRIVER_PROFILE_KSEVENT = 3000;// ms, amount of time to wait for the profile DDI KsEvent sent to the driver

Handling KSPROPERTY_CAMERACONTROL_EXTENDED_PROFILE on avscamera DMFT #1325

Are you sure you want to change the base?

Handling KSPROPERTY_CAMERACONTROL_EXTENDED_PROFILE on avscamera DMFT #1325

Conversation

welljeng commented Sep 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chrilaMSFT commented Sep 25, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

welljeng Sep 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

welljeng commented Sep 24, 2025 •

edited

Loading

welljeng Sep 26, 2025 •

edited

Loading