Fix for min/max inversion in mastering luminance

Now pushing metadata once per second to madVR resolving issues with it not being picked up
Verified to work with madVR beta 131

Author: defl

CHANGELOG.txt

@@ -0,0 +1,11 @@
+0.1.0
+ - Fix for min/max inversion in mastering luminance
+ - Now pushing metadata once per second to madVR resolving issues with it not being picked up
+ - Verified to work with madVR beta 131
+ 
+0.0.2
+- Added config file to set parameters
+- Added HDFury Vertex2 auto config file param generator
+
+0.0.1
+ - First release

README.md

@@ -1,39 +1,41 @@
 # [DirectShow Metadata Injector Filter](https://github.com/defl/directshow_metadata_injector_filter)
 
-This is a DirectShow filter that can inject metadata related to high dynamic range (HDR) and wide color gamut (WCG) 
-into a directshow graph.
+This is a DirectShow filter that can inject metadata related to high dynamic range (HDR) and wide color gamut (WCG) the graph so it can be used by capable renderers like [madVR](http://madvr.com/).
+
+It is usable for sources which do not properly relay this information like consumer video capture cards such as the [AVerMedia Live Gamer 4K - GC573](https://www.avermedia.com/us/product-detail/GC573) who technically do HDR data but refuse to forward the correct HDR metadata through their DirectShow source filters. This leads to downstream renderers making a mess of the picture as they don't know how to interpret it.
 
-This is usable for sources which do not properly relay this information like consumer video capture cards 
-[AVerMedia Live Gamer 4K - GC573](https://www.avermedia.com/us/product-detail/GC573) who technically do HDR 
-data but refuse to forward the correct HDR metdata through their DirectShow source filters. 
-This leads to downstream renderers making a mess of the picture as they don't know how to interpret it.
 Example [before](images/without.png) and [after](images/with.png) screenshots probably speak for themselves.
 
-## Features
+# Features
 
 * Supported metadata
-    * HDR primaries & whitepoint as xy coordinates
+    * HDR primaries & whitepoint as CIE1931 xy coordinates
 	* HDR min/max mastering luminance
 	* HDR content light levels (MaxCLL, MaxFALL)
 	* HDR Transfer Matrix (BT.2020 etc)
 	* HDR Primaries (DCI-P3, BT.2020 etc)
 	* HDR Video transfer function (SMPTE ST 2084 (PQ), HLG etc)
-* Configuration through an ini file (default in same directory)
+* Configuration through an .ini file (by default in same directory)
 * Tested players
     * Potplayer
 * Tested DirectShow sources
     * AVerMedia Live Gamer 4K - GC573
-    * Blackmagic Design DeckLink Mini Recorder 4K
 * Tested DirectShow renderers
     * madVR
+    
+    
 
-## Install
+# Install
 
 * Install VS2019 x64 runtime
+
 * Download directshow_metadata_injector_filter.ax to a location you will not delete (and which is not admin only under windows like program files)
+
 * Copy the example_config.ini as directshow_metadata_injector_filter.ini to the same dir
 
-Potplayer
+  
+
+**Potplayer**
 
 * Open potplayer
 * Open preferences (F5)
@@ -45,47 +47,45 @@ Potplayer
 * Bottom right of screen set priority to "Prefer"
 *(If you're running a AVerMedia Live Gamer 4K - GC573 don't forget to set it's output to P010 for 10bit, you can do this in preferences under device->webcam->format, see [here](images/potplayer_avermedia_settings.png))*
 
-optional: hdfury_virtex2_ini_generator.py
 
-* Install Python
-* Install python/requirements.txt modules
-* Run hdfury_virtex2_ini_generator.py <ip of vertex2> <directshow_metadata_injector_filter.ini file from above>
 
-## Poor mans' madVRlabs Envy?
+# Configuration
 
-Schematically this looks like: source (Apple TV4k or blueray player) -> HDFurty Vertex2 -> HTPC (madVR, nvidia GPU, capture card) -> display
+Configuration is via a .ini file which contains all the settings. There is an example_config.ini in the project's code repo. Copy that to the same location as where you downloaded the .ax file and rename to directshow_metadata_injector_filter.ini. The settings are well documented and speak for themselves.
 
-Notes:
- * The sound you want to run off of the Vertex2 split to a processor/receiver if you plan on running any sort of interesting format like Atmos. Beware that delay might be high (>200ms) so get one that can handle it.
- * Note that in some jurisdictions it's allowed to remove HDCP for the right reasons. This is not hard, but figuring out how to do this is left as an exercise to the reader.
- * The hdfury_virtex2_ini_generator.py connects to the fury and updates the filter's config ever 10 seconds. A stop-start of the stream in potplayer will engage the new settings.
 
-If you like this, and have the means, please buy a real [envy](https://madvrenvy.com/) to support further madVR development. It is really, really a much better experience.
 
-## Configuration
+# HDFury Virtex2 auto config generator
 
-Configuration is via a .ini file which contains all the settings. There is an example_config.ini. Copy that to the same location as where you downloaded the .ax file and rename to directshow_metadata_injector_filter.ini.
+If you have a HDFury Virtex2 you can automate the metadata generation. For this to work you need
+to place the device before the input to the capture server (you want to do this anyway because higher end audio is notoriously poor though such setups). This way the device will see the same HDR meta data as the capture card and the filter can inject the correct metadata in the DirectShow stream. 
 
-There is a small Python program included in the python/ subdir which can automatically generate this file for a range of devices. For this to work you need
-to place the device before the input to the capture server (you want to do this anyway because higher end audio is notriously poor though such setups). This 
-way the device will see the same HDR meta data as the capture card and the filter can inject the correct metadata in the directshow stream. The config is 
-re-generated every few seconds and a quick stop-start will reload everything and get you the right parameters (after a menu-switch or a new movie starts for 
-example).
+The config is re-generated every few seconds and a quick stop-start will reload everything and get you the right parameters (after a menu-switch or a new movie starts for example).
+
+Installation and use:
+
+* Install Python
+* Install python/requirements.txt modules
+* Run hdfury_virtex2_ini_generator.py <ip of vertex2> <directshow_metadata_injector_filter.ini file from above>
 
-Supported devices:
 
- * HDFury Vertex2
 
 
-## Build
+# Build
 
 **C++**: Open with Visual Studio 2019 VC++, should just work out of the box.
 
 **Python**: Just have a python 3.x interpretor and install the packages mentioned in requirements.txt
 
-## FAQ
+# FAQ
+
+**Is this plug and play?** 
+No, because this filter does not offer anything new to get an video stream decoded it will not automatically be added to a DirectShow graph. It needs to be forced to be included, see install for an example.
+
+**After starting the video the screen remains black**
+This happens if there is another filter in between this filter and madVR. At that point the filter can't get memory for sending the metadata and will not copy the image data as well. Fix your graph/player.
+
 
-Is this plug and play? No, because this filter does not offer anything new to get an video stream decoded it will not automatically be added to a DirectShow graph. It needs to be forced to be included, see install for an example.
 
 ## Credits
 

cpp/directshow_metadata_injector_filter/directshow_metadata_injector_filter.vcxproj

@@ -175,6 +175,7 @@
     </ProjectReference>
   </ItemGroup>
   <ItemGroup>
+    <None Include="..\..\example_config.ini" />
     <None Include="directshow_metadata_injector_filter.def" />
   </ItemGroup>
   <ItemGroup>

cpp/directshow_metadata_injector_filter/directshow_metadata_injector_filter.vcxproj.filters

@@ -60,5 +60,8 @@
     <None Include="directshow_metadata_injector_filter.def">
       <Filter>Source Files</Filter>
     </None>
+    <None Include="..\..\example_config.ini">
+      <Filter>Resource Files</Filter>
+    </None>
   </ItemGroup>
 </Project>

cpp/directshow_metadata_injector_filter/guids.h

@@ -5,7 +5,7 @@
 
 // {C3BD8F60-565F-404D-9B8F-D7E38BFA9B5E}
 DEFINE_GUID(
-	CLSID_METADATA_INJECTOR_FILTER, 
+	CLSID_METADATA_INJECTOR_FILTER,
 	0xc3bd8f60, 0x565f, 0x404d, 0x9b, 0x8f, 0xd7, 0xe3, 0x8b, 0xfa, 0x9b, 0x5e);
 
 

cpp/directshow_metadata_injector_filter/metadata_injector_filter.cpp

@@ -65,7 +65,7 @@ CFactoryTemplate g_Templates[] = {
       &CLSID_METADATA_INJECTOR_FILTER,
       MetadataInjectorFilter::CreateInstance,
       NULL,
-      &sMIPSetup 
+      &sMIPSetup
     },
     {
       L"Metadata Injector Properties",
@@ -120,43 +120,38 @@ HRESULT MetadataInjectorFilter::Transform(IMediaSample* pIn, IMediaSample* pOut)
     if (FAILED(hr))
         return hr;
 
-    if(mSendSideData)
+    // Update once per second
+    if ((mFrameCounter % mFramesPerSecond) == 0)
     {
+        // This can fail if you have a filter behind this which does not understand side data (ie, it's not going directly to madVR)
         IMediaSideData* pMediaSideData = nullptr;
         if (FAILED(hr = pOut->QueryInterface(&pMediaSideData)))
             return hr;
-         
-        {
-            MediaSideDataHDR hdr;
-            ZeroMemory(&hdr, sizeof(hdr));
-
-            hdr.display_primaries_x[0] = mDisplayPrimaryGreenX;
-            hdr.display_primaries_x[1] = mDisplayPrimaryBlueX;
-            hdr.display_primaries_x[2] = mDisplayPrimaryRedX;
-            hdr.display_primaries_y[0] = mDisplayPrimaryGreenY;
-            hdr.display_primaries_y[1] = mDisplayPrimaryBlueY;
-            hdr.display_primaries_y[2] = mDisplayPrimaryRedY;
-
-            hdr.white_point_x = mWhitePointX;
-            hdr.white_point_y = mWhitePointY;
-
-            hdr.max_display_mastering_luminance = mMasteringLuminanceMax;
-            hdr.min_display_mastering_luminance = mMasteringLuminanceMin;
-            pMediaSideData->SetSideData(IID_MediaSideDataHDR, (const BYTE*)&hdr, sizeof(hdr));
-        }
-
-        {
-            MediaSideDataHDRContentLightLevel hdrLightLevel;
-            hdrLightLevel.MaxCLL = mMaxCLL;
-            hdrLightLevel.MaxFALL = mMaxFALL;
-
-            pMediaSideData->SetSideData(IID_MediaSideDataHDRContentLightLevel, (const BYTE*)&hdrLightLevel, sizeof(hdrLightLevel));
-        }
+
+        MediaSideDataHDR hdr;
+        ZeroMemory(&hdr, sizeof(hdr));
+        hdr.display_primaries_x[0] = mDisplayPrimaryGreenX;
+        hdr.display_primaries_x[1] = mDisplayPrimaryBlueX;
+        hdr.display_primaries_x[2] = mDisplayPrimaryRedX;
+        hdr.display_primaries_y[0] = mDisplayPrimaryGreenY;
+        hdr.display_primaries_y[1] = mDisplayPrimaryBlueY;
+        hdr.display_primaries_y[2] = mDisplayPrimaryRedY;
+        hdr.white_point_x = mWhitePointX;
+        hdr.white_point_y = mWhitePointY;
+        hdr.max_display_mastering_luminance = mMasteringLuminanceMax;
+        hdr.min_display_mastering_luminance = mMasteringLuminanceMin;
+        pMediaSideData->SetSideData(IID_MediaSideDataHDR, (const BYTE*)&hdr, sizeof(hdr));
+
+        MediaSideDataHDRContentLightLevel hdrLightLevel;
+        ZeroMemory(&hdrLightLevel, sizeof(hdrLightLevel));
+        hdrLightLevel.MaxCLL = mMaxCLL;
+        hdrLightLevel.MaxFALL = mMaxFALL;
+        pMediaSideData->SetSideData(IID_MediaSideDataHDRContentLightLevel, (const BYTE*)&hdrLightLevel, sizeof(hdrLightLevel));
 
         pMediaSideData->Release();
-        mSendSideData = false;
     }
 
+    ++mFrameCounter;
     return NOERROR;
 }
 
@@ -348,7 +343,7 @@ HRESULT MetadataInjectorFilter::CheckInputType(const CMediaType* mtIn)
 HRESULT MetadataInjectorFilter::CheckTransform(const CMediaType* mtIn, const CMediaType* mtOut)
 {
     CheckPointer(mtIn, E_POINTER);
-    CheckPointer(mtOut, E_POINTER); 
+    CheckPointer(mtOut, E_POINTER);
 
     return NOERROR;
 }
@@ -379,7 +374,7 @@ HRESULT MetadataInjectorFilter::DecideBufferSize(IMemAllocator* pAlloc, ALLOCATO
 
     ASSERT(Actual.cBuffers == 1);
 
-    if (pProperties->cBuffers > Actual.cBuffers || 
+    if (pProperties->cBuffers > Actual.cBuffers ||
         pProperties->cbBuffer > Actual.cbBuffer)
         return E_FAIL;
 
@@ -400,6 +395,9 @@ HRESULT MetadataInjectorFilter::GetMediaType(int iPosition, CMediaType* pMediaTy
 
     BuildFakeMediaType(pMediaType);
 
+    const VIDEOINFOHEADER* const pvi = (VIDEOINFOHEADER*)m_pInput->CurrentMediaType().Format();
+    mFramesPerSecond = 1.0 / (pvi->AvgTimePerFrame / 10000000.0);  // time unit is 100ns
+
     return NOERROR;
 }
 
@@ -444,7 +442,7 @@ STDMETHODIMP MetadataInjectorFilter::GetClassID(CLSID* pClsid)
 HRESULT MetadataInjectorFilter::ScribbleToStream(IStream* pStream)
 {
     HRESULT hr = pStream->Write(mConfigFilename.c_str(), mConfigFilename.length() + 1, NULL);
-    if (FAILED(hr)) 
+    if (FAILED(hr))
         return hr;
 
     return NOERROR;
@@ -495,10 +493,10 @@ void MetadataInjectorFilter::BuildFakeMediaType(CMediaType* pMediaType)
     pvi2->dwPictAspectRatioX = mAspectRatioX;
     pvi2->dwPictAspectRatioY = mAspectRatioY;
 
-    // dwControlFlags is a 32bit int. With AMCONTROL_COLORINFO_PRESENT the upper 24 bits are used by DXVA_ExtendedFormat. 
-    // That struct is 32 bits so it's lower member (SampleFormat) is actually overbooked with the value of dwConotrolFlags 
-    // so can't be used. LAV has defined some out-of-spec but compatile with madVR values for the more modern formats, 
-    // which we use as well see 
+    // dwControlFlags is a 32bit int. With AMCONTROL_COLORINFO_PRESENT the upper 24 bits are used by DXVA_ExtendedFormat.
+    // That struct is 32 bits so it's lower member (SampleFormat) is actually overbooked with the value of dwConotrolFlags
+    // so can't be used. LAV has defined some out-of-spec but compatile with madVR values for the more modern formats,
+    // which we use as well see
     // https://github.com/Nevcairiel/LAVFilters/blob/ddef56ae155d436f4301346408f4fdba755197d6/decoder/LAVVideo/Media.cpp
 
     DXVA_ExtendedFormat* colorimetry = (DXVA_ExtendedFormat*)&(pvi2->dwControlFlags);

cpp/directshow_metadata_injector_filter/metadata_injector_filter.h

@@ -61,21 +61,22 @@ class MetadataInjectorFilter:
 
     std::string mConfigFilename;
 
-    bool mSendSideData = true;
-    
+    unsigned int mFramesPerSecond = 0;
+    unsigned int mFrameCounter = 0;
+
     double mDisplayPrimaryGreenX;
     double mDisplayPrimaryBlueX;
     double mDisplayPrimaryRedX;
     double mDisplayPrimaryGreenY;
     double mDisplayPrimaryBlueY;
     double mDisplayPrimaryRedY;
-    
+
     double mWhitePointX;
     double mWhitePointY;
-    
+
     double mMasteringLuminanceMin;
     double mMasteringLuminanceMax;
-    
+
     unsigned int mMaxCLL;
     unsigned int mMaxFALL;
 

cpp/directshow_metadata_injector_filter/metadata_injector_properties.h

@@ -5,7 +5,8 @@
 
 #include "metadata_injector_interface.h"
 
-class MetadataInjectorProperties: 
+
+class MetadataInjectorProperties:
     public CBasePropertyPage
 {