DShow中filter的property page实现过程（以DsNetWork为例进行摘抄）

step1: expose a custom COM interface

 

//denetifc.idl, use the MIDL compiler to create the header file which is to be used in the next step.

 

interface IMulticastConfig ;

[
    object,
 uuid (1CB42CC8-D32C-4f73-9267-C114DA470378)
]

 

interface IMulticastConfig  : IUnknown
{
    HRESULT
    SetNetworkInterface (
        [in]    ULONG   ulNIC               //  network order
        ) ;

    HRESULT
    GetNetworkInterface (
        [out]   ULONG * pNIC                //  network order
        ) ;

    HRESULT
    SetMulticastGroup (
        [in]    ULONG   ulIP,               //  network order
        [in]    USHORT  usPort              //  network order
        ) ;

    HRESULT
    GetMulticastGroup (
        [out]   ULONG *     pIP,            //  network order
        [out]   USHORT *    pPort           //  network order
        ) ;
} ;

 

step 2: implement the IMulticastConfig interface in a filter.

 

//denetifc.idl-->dsnetifc.h #define DECLARE_IMULTICASTCONFIG();/ virtual STDMETHODIMP SetNetworkInterface (ULONG) ;/ virtual STDMETHODIMP GetNetworkInterface (ULONG *) ;/ virtual STDMETHODIMP SetMulticastGroup (ULONG, USHORT) ;/ virtual STDMETHODIMP GetMulticastGroup (ULONG *, USHORT*) ; //dssend.h class CNetworkSend: public IMulticastConfig { CCritSec m_crtFilter ; // filter lock CCritSec m_crtRecv ; // receiver lock; ULONG m_ulIP ; // IP address; network order USHORT m_usPort ; // port; network order ULONG m_ulNIC ; // NIC; network order public: // -------------------------------------------------------------------- // COM interfaces DECLARE_IMULTICASTCONFIG () ; } //dssend.cpp STDMETHODIMP CNetworkSend::SetNetworkInterface ( IN ULONG ulNIC ) { ... } STDMETHODIMP CNetworkSend::GetNetworkInterface ( OUT ULONG * pulNIC ) { ... } STDMETHODIMP CNetworkSend::SetMulticastGroup ( IN ULONG ulIP, IN USHORT usPort ) { ... } STDMETHODIMP CNetworkSend::GetMulticastGroup ( OUT ULONG * pIP, OUT USHORT * pPort ) { ... }

step 3: Implement the ISpecifyPropertyPages interface in the filter.

 

//dssend.h

class CNetworkSend : public ISpecifyPropertyPagesPages

{

         //  --------------------------------------------------------------------
        //  ISpecifyPropertyPages

        STDMETHODIMP GetPages (IN OUT CAUUID * pPages) ;

 }

//dssend.cpp

STDMETHODIMP
CNetworkSend::GetPages (
    IN OUT CAUUID * pPages
    )
{
 if (pPages == NULL) return E_POINTER;

    pPages -> cElems = 1 ;

    pPages -> pElems = (GUID *) CoTaskMemAlloc (pPages -> cElems * sizeof GUID) ;

    if (pPages -> pElems == NULL) {
        return E_OUTOFMEMORY;
    }

    (pPages -> pElems) [0] = CLSID_IPMulticastSendProppage ;

    return S_OK ;
}

 

/*

CAUUID : a Counted Array of UUID or GUID types.

 

Structure:

typedef struct tagCAUUID
{
    ULONG     cElems;
    GUID FAR* pElems;
} CAUUID;

Members:

cElems

Size of the array

pElems

Pointer to an array of UUID values, each of which specifies a CLSID of a particular property page. This array is allocated by the callee using CoTaskMemAlloc and is freed by the caller using CoTaskMemFree.

*/

/*

CoTaskMemAlloc

   Allocates a block of task memory.

Syntax

LPVOID CoTaskMemAlloc( ULONG cb);

Parameter

cb : size, in bytes, of the memory block to be allocted.

Return Values

Allocated memory block, if failed, return NULL.

*/

 

 

step 4:expose the filter's new interface to clients, so it need to support QueryInterface.

//dssend.h class CNetworkSend: public IMulticastConfig { public: // -------------------------------------------------------------------- // COM interfaces DECLARE_IUNKNOWN ; } STDMETHODIMP CNetworkSend::NonDelegatingQueryInterface ( IN REFIID riid, OUT void ** ppv ) { // property pages if (riid == IID_ISpecifyPropertyPages) { return GetInterface ( (ISpecifyPropertyPages *) this, ppv ) ; } // multicast else if (riid == IID_IMulticastConfig) { return GetInterface ( (IMulticastConfig *) this, ppv ) ; } // we do persist else if (riid == IID_IPersistStream) { return GetInterface ( (IPersistStream *) this, ppv ) ; } // fallback - call the baseclass else { return CBaseFilter::NonDelegatingQueryInterface (riid, ppv) ; } }

 

 step 5: create the Property Page. The filter supports everything that it needs for the Property page.

 

//propsend.h class CNetSendProp : public CBasePropertyPage { // property page HWND HWND m_hwnd ; // interface pointer, points to the filter's interface IMulticastConfig * m_pIMulticastConfig ; public: ... }

 

step 6: Store a Pointer to the Filter overriding the CBasePropertyPage::OnConnect method.

 

//propsend.h HRESULT OnConnect ( IN IUnknown * pIUnknown ); //propsend.cpp HRESULT CNetSendProp::OnConnect (IN IUnknown * pIUnknown ) { HRESULT hr ; ASSERT (pIUnknown) ; if (!g_NIC.IsInitialized ()) { hr = g_NIC.Initialize () ; if (FAILED (hr)) { return hr ; } } hr = pIUnknown -> QueryInterface ( IID_IMulticastConfig, (void **) & m_pIMulticastConfig ) ; return hr ; }

 

step 7: override the CBaseProportyPage::OnActivate method and use the current value of the filter's property to initialize the Dialog.

 

 //propsend.h class CNetSendProp : public CBasePropertyPage { public: HRESULT OnActive (); } //propsend.cpp HRESULT CNetSendProp::OnActivate ( ) { CCombobox NICs (m_hwnd, IDC_NIC) ; int iIndex ; INTERFACE_INFO * pIfc ; DWORD i ; // setup the NICs ASSERT (g_NIC.IsInitialized ()) ; for (i = 0, pIfc = g_NIC [i] ; pIfc ; i++, pIfc = g_NIC [i]) { if ((pIfc -> iiFlags & IFF_UP) && (pIfc -> iiFlags & IFF_MULTICAST)) { iIndex = NICs.Append (inet_ntoa (pIfc -> iiAddress.AddressIn.sin_addr)) ; if (iIndex == CB_ERR) { return E_FAIL ; } NICs.SetItemData (* (DWORD *) (& pIfc -> iiAddress.AddressIn.sin_addr), iIndex) ; } } // wildcard iIndex = NICs.Append (ANY_IFC) ; if (iIndex == CB_ERR) { return E_FAIL ; } NICs.SetItemData (INADDR_ANY, iIndex) ; // undefined iIndex = NICs.Append (UNDEFINED_STR) ; if (iIndex == CB_ERR) { return E_FAIL ; } NICs.SetItemData ((unsigned long) UNDEFINED, iIndex) ; Refresh_ () ; return S_OK ; }

 

step 8: override the CBasePropertyPage::OnReceiveMessage method to update the dialog controls in response to user input. If it is unneeded to handle a particular message, call the OnReceiveMessage method on the parent class.

 

 

 //propsend.h class CNetSendProp : public CBasePropertyPage { HRESULT OnSave_(); public: BOOL CNetSendProp::OnReceiveMessage ( IN HWND hwnd, IN UINT uMsg, IN WPARAM wParam, IN LPARAM lParam ); } //propsend.cpp HRESULT CNetSendProp::OnSave_ ( ) { CCombobox NICs (m_hwnd, IDC_NIC) ; CEditControl IP (m_hwnd, IDC_IP) ; CEditControl Port (m_hwnd, IDC_PORT) ; int i ; ULONG ulIP ; USHORT usPort ; ULONG ulNIC ; HRESULT hr ; char ach [32] ; if (IP.IsEmpty () || Port.IsEmpty ()) { return E_INVALIDARG ; } // IP IP.GetText (ach, 32) ; ulIP = inet_addr (ach) ; if (ulIP == INADDR_NONE) { return E_FAIL ; } // port Port.GetText (& i) ; i &= 0x0000ffff ; usPort = htons ((USHORT) i) ; // NIC NICs.GetCurrentItemData (& ulNIC) ; hr = m_pIMulticastConfig -> SetMulticastGroup (ulIP, usPort) ; if (FAILED (hr)) { return hr ; } hr = m_pIMulticastConfig -> SetNetworkInterface (ulNIC) ; if (FAILED (hr)) { return hr ; } return S_OK ; } BOOL CNetSendProp::OnReceiveMessage ( IN HWND hwnd, IN UINT uMsg, IN WPARAM wParam, IN LPARAM lParam ) { HRESULT hr ; switch (uMsg) { case WM_INITDIALOG: { ASSERT (m_hwnd == NULL) ; m_hwnd = hwnd ; return TRUE ; } case WM_DESTROY : { m_hwnd = NULL ; break ; } case WM_COMMAND: { switch (LOWORD (wParam)) { case IDC_SAVE : hr = OnSave_ () ; if (FAILED (hr)) { MessageBoxError (TEXT("Failed to Save"), TEXT("The returned error code is %08xh"), hr) ; } break ; } ; return TRUE ; } } return CBasePropertyPage::OnReceiveMessage ( hwnd, uMsg, wParam, lParam ) ; }

 

 

 step 9: override the CBasePropertyPage::OnApplyChanges method to commit any property changes.

 

 //propsend.h class CNetSendProp : public CBasePropertyPage { public: HRESULT OnApplyChanges(); } //propsend.cpp HRESULT CNetSendProp::OnApplyChanges ( ) { return OnSave_ () ; }

 

 step 10: override the CBasePropertyPage:OnDisconnect method to release any interface that obtained in the OnConnect method.

//propsend.h class CNetSendProp : public CBasePropertyPage { public: HRESULT OnDisconnect ( ) ; } //projpch.h #define RELEASE_AND_CLEAR(p) if (p) { (p) -> Release () ; (p) = NULL ; } //propsend.cpp HRESULT CNetSendProp::OnDisconnect ( ) { RELEASE_AND_CLEAR (m_pIMulticastConfig) ; return S_OK ; }

 

 step11 : support COM registration

CFactoryTemplate g_Templates [] = { // sender filter { NET_SEND_FILTER_NAME, & CLSID_DSNetSend, CNetworkSend::CreateInstance, NULL, & g_sudSendFilter }, // sender property page { NET_SEND_PROP_PAGE_NAME, & CLSID_IPMulticastSendProppage, CNetSendProp::CreateInstance, NULL, NULL } }; int g_cTemplates = sizeof (g_Templates) / sizeof (g_Templates[0]);