- Added timeout option to control the time until sending is considered stopped

- Support capturing of mip-mapped textures

Author: schellingb

Install/UnityCaptureFilter32bit.dll

@@ -60,6 +60,9 @@ can refer to the 'UnityCaptureTextureExample' scene and the 'CaptureTexture' scr
 There are a few settings for the 'Unity Capture' behavior.
 
 - 'Capture Device': Set the capture device filter number (only relevant when multiple capture devices were [installed](#installation))
+- 'Timeout': Sets how many milliseconds to wait for a new frame until sending is considered to be stopped  
+  If rendering every frame this can be very low. Default is 1000 to allow stalls due to loading, etc.
+  When set to 0 the image will stay up even when Unity is ended (until the receiving application also ends).
 - 'Resize Mode': It is suggested to leave this disabled and just let your capture target application handle the display
   sizing/resizing because this setting can introduce frame skipping. So far only a very basic linear resize is supported.
 - 'Mirror Mode': This setting should also be handled by your target application if possible and needed, but it is available.

Install/UnityCaptureFilter64bit.dll

@@ -153,8 +153,8 @@ class CCaptureStream : CSourceStream, IKsPropertySet, IAMStreamConfig, IAMStream
 				break;
 
 			case SharedImageMemory::RECEIVERES_OLDFRAME:{
-				if (m_llFrameMissCount++ < 5) break;
-				//Show color pattern when having 5 frames without new image (probably Unity stopped sending data)
+				if (++m_llFrameMissCount < m_llFrameMissMax) break;
+				//Show color pattern when received more than X frames without new image (probably Unity stopped sending data)
 				char DisplayString[] = "Unity has stopped sending image data", *DisplayStrings[] = { DisplayString };
 				int DisplayStringLens[] = { sizeof(DisplayString) - 1 };
 				FillErrorPattern(ErrorDrawModes[EDC_UnitySendingStopped], &State, 1, DisplayStrings, DisplayStringLens, m_llFrame);
@@ -454,8 +454,11 @@ class CCaptureStream : CSourceStream, IKsPropertySet, IAMStreamConfig, IAMStream
 		CCaptureStream* Owner;
 	};
 
-	static void ProcessImage(int InWidth, int InHeight, int InStride, SharedImageMemory::EFormat Format, SharedImageMemory::EResizeMode ResizeMode, SharedImageMemory::EMirrorMode MirrorMode, uint8_t* InBuf, ProcessState* State)
+	static void ProcessImage(int InWidth, int InHeight, int InStride, SharedImageMemory::EFormat Format, SharedImageMemory::EResizeMode ResizeMode, SharedImageMemory::EMirrorMode MirrorMode, int Timeout, uint8_t* InBuf, ProcessState* State)
 	{
+		//Set maximum number of missed frames allowed until we show sending as having stopped
+		State->Owner->m_llFrameMissMax = (Timeout + SharedImageMemory::RECEIVE_MAX_WAIT - 1) / SharedImageMemory::RECEIVE_MAX_WAIT;
+
 		const bool NeedResize = (InWidth != State->BufWidth || InHeight != State->BufHeight);
 		if (NeedResize && ResizeMode == SharedImageMemory::RESIZEMODE_DISABLED)
 		{
@@ -805,11 +808,12 @@ class CCaptureStream : CSourceStream, IKsPropertySet, IAMStreamConfig, IAMStream
 	{
 		DebugLog("[OnThreadStartPlay] OnThreadStartPlay\n");
 		m_llFrame = m_llFrameMissCount = 0;
+		m_llFrameMissMax = 5;
 		return CSourceStream::OnThreadStartPlay();
 	}
 
 	CMediaType m_mt;
-	LONGLONG m_llFrame, m_llFrameMissCount;
+	LONGLONG m_llFrame, m_llFrameMissCount, m_llFrameMissMax;
 	REFERENCE_TIME m_prevStartTime;
 	REFERENCE_TIME m_avgTimePerFrame;
 	SharedImageMemory* m_pReceiver;

README.md

@@ -71,7 +71,7 @@ extern "C" __declspec(dllexport) void CaptureDeleteInstance(UnityCaptureInstance
 	delete c;
 }
 
-extern "C" __declspec(dllexport) int CaptureSendTexture(UnityCaptureInstance* c, void* TextureNativePtr, bool UseDoubleBuffering, SharedImageMemory::EResizeMode ResizeMode, SharedImageMemory::EMirrorMode MirrorMode, bool IsLinearColorSpace)
+extern "C" __declspec(dllexport) int CaptureSendTexture(UnityCaptureInstance* c, void* TextureNativePtr, int Timeout, bool UseDoubleBuffering, SharedImageMemory::EResizeMode ResizeMode, SharedImageMemory::EMirrorMode MirrorMode, bool IsLinearColorSpace)
 {
 	if (!c || !TextureNativePtr) return RET_ERROR_PARAMETER;
 	if (g_GraphicsDeviceType != kUnityGfxRendererD3D11) return RET_ERROR_UNSUPPORTEDGRAPHICSDEVICE;
@@ -95,7 +95,7 @@ extern "C" __declspec(dllexport) int CaptureSendTexture(UnityCaptureInstance* c,
 		ZeroMemory(&textureDesc, sizeof(textureDesc));
 		textureDesc.Width = desc.Width;
 		textureDesc.Height = desc.Height;
-		textureDesc.MipLevels = 1;
+		textureDesc.MipLevels = desc.MipLevels;
 		textureDesc.ArraySize = 1;
 		textureDesc.Format = desc.Format;
 		textureDesc.SampleDesc.Count = 1;
@@ -128,10 +128,10 @@ extern "C" __declspec(dllexport) int CaptureSendTexture(UnityCaptureInstance* c,
 	//Copy render texture to texture with CPU access and map the image data to RAM
 	ctx->CopyResource(WriteTexture, d3dtex);
 	D3D11_MAPPED_SUBRESOURCE mapResource;
-	if (FAILED(ctx->Map(ReadTexture, 0, D3D11_MAP_READ, NULL, &mapResource))) return RET_ERROR_READTEXTURE;
+	if (FAILED(ctx->Map(ReadTexture, 0, D3D11_MAP_READ, 0, &mapResource))) return RET_ERROR_READTEXTURE;
 
 	//Push the captured data to the direct show filter
-	SharedImageMemory::ESendResult res = c->Sender->Send(desc.Width, desc.Height, mapResource.RowPitch / (Format == SharedImageMemory::FORMAT_UINT8 ? 4 : 8), mapResource.RowPitch * desc.Height, Format, ResizeMode, MirrorMode, (const unsigned char*)mapResource.pData);
+	SharedImageMemory::ESendResult res = c->Sender->Send(desc.Width, desc.Height, mapResource.RowPitch / (Format == SharedImageMemory::FORMAT_UINT8 ? 4 : 8), mapResource.RowPitch * desc.Height, Format, ResizeMode, MirrorMode, Timeout, (const unsigned char*)mapResource.pData);
 
 	ctx->Unmap(ReadTexture, 0);
 

Source/UnityCaptureFilter.cpp

@@ -39,22 +39,23 @@ struct SharedImageMemory
 
 	int32_t GetCapNum() { return m_CapNum; }
 	enum { MAX_CAPNUM = ('z' - '0') }; //see Open() for why this number
+	enum { RECEIVE_MAX_WAIT = 200 }; //How many milliseconds to wait for new frame
 	enum EFormat { FORMAT_UINT8, FORMAT_FP16_GAMMA, FORMAT_FP16_LINEAR };
 	enum EResizeMode { RESIZEMODE_DISABLED = 0, RESIZEMODE_LINEAR = 1 };
 	enum EMirrorMode { MIRRORMODE_DISABLED = 0, MIRRORMODE_HORIZONTALLY = 1 };
 	enum EReceiveResult { RECEIVERES_CAPTUREINACTIVE, RECEIVERES_NEWFRAME, RECEIVERES_OLDFRAME };
 
-	typedef void (*ReceiveCallbackFunc)(int width, int height, int stride, EFormat format, EResizeMode resizemode, EMirrorMode mirrormode, uint8_t* buffer, void* callback_data);
+	typedef void (*ReceiveCallbackFunc)(int width, int height, int stride, EFormat format, EResizeMode resizemode, EMirrorMode mirrormode, int timeout, uint8_t* buffer, void* callback_data);
 
 	EReceiveResult Receive(ReceiveCallbackFunc callback, void* callback_data)
 	{
 		if (!Open(true) || !m_pSharedBuf->width) return RECEIVERES_CAPTUREINACTIVE;
 
 		SetEvent(m_hWantFrameEvent);
-		bool IsNewFrame = (WaitForSingleObject(m_hSentFrameEvent, 200) == WAIT_OBJECT_0);
+		bool IsNewFrame = (WaitForSingleObject(m_hSentFrameEvent, RECEIVE_MAX_WAIT) == WAIT_OBJECT_0);
 
 		WaitForSingleObject(m_hMutex, INFINITE); //lock mutex
-		callback(m_pSharedBuf->width, m_pSharedBuf->height, m_pSharedBuf->stride, (EFormat)m_pSharedBuf->format, (EResizeMode)m_pSharedBuf->resizemode, (EMirrorMode)m_pSharedBuf->mirrormode, m_pSharedBuf->data, callback_data);
+		callback(m_pSharedBuf->width, m_pSharedBuf->height, m_pSharedBuf->stride, (EFormat)m_pSharedBuf->format, (EResizeMode)m_pSharedBuf->resizemode, (EMirrorMode)m_pSharedBuf->mirrormode, m_pSharedBuf->timeout, m_pSharedBuf->data, callback_data);
 		ReleaseMutex(m_hMutex); //unlock mutex
 
 		return (IsNewFrame ? RECEIVERES_NEWFRAME : RECEIVERES_OLDFRAME);
@@ -66,7 +67,7 @@ struct SharedImageMemory
 	}
 
 	enum ESendResult { SENDRES_TOOLARGE, SENDRES_WARN_FRAMESKIP, SENDRES_OK };
-	ESendResult Send(int width, int height, int stride, DWORD DataSize, EFormat format, EResizeMode resizemode, EMirrorMode mirrormode, const uint8_t* buffer)
+	ESendResult Send(int width, int height, int stride, DWORD DataSize, EFormat format, EResizeMode resizemode, EMirrorMode mirrormode, int timeout, const uint8_t* buffer)
 	{
 		UCASSERT(buffer);
 		UCASSERT(m_pSharedBuf);
@@ -79,6 +80,7 @@ struct SharedImageMemory
 		m_pSharedBuf->format = format;
 		m_pSharedBuf->resizemode = resizemode;
 		m_pSharedBuf->mirrormode = mirrormode;
+		m_pSharedBuf->timeout = timeout;
 		memcpy(m_pSharedBuf->data, buffer, DataSize);
 		ReleaseMutex(m_hMutex); //unlock mutex
 
@@ -150,6 +152,7 @@ private:
 		int format;
 		int resizemode;
 		int mirrormode;
+		int timeout;
 		uint8_t data[1];
 	};
 

Source/UnityCapturePlugin.cpp

@@ -38,6 +38,7 @@ public enum ECaptureSendResult { SUCCESS = 0, WARNING_FRAMESKIP = 1, WARNING_CAP
 
     [SerializeField] [Tooltip("Capture device index")] public ECaptureDevice CaptureDevice = ECaptureDevice.CaptureDevice1;
     [SerializeField] [Tooltip("Scale image if Unity and capture resolution don't match (can introduce frame dropping, not recommended)")] public EResizeMode ResizeMode = EResizeMode.Disabled;
+    [SerializeField] [Tooltip("How many milliseconds to wait for a new frame until sending is considered to be stopped")] public int Timeout = 1000;
     [SerializeField] [Tooltip("Mirror captured output image")] public EMirrorMode MirrorMode = EMirrorMode.Disabled;
     [SerializeField] [Tooltip("Introduce a frame of latency in favor of frame rate")] public bool DoubleBuffering = false;
     [SerializeField] [Tooltip("Check to enable VSync during capturing")] public bool EnableVSync = false;
@@ -71,7 +72,7 @@ void OnDestroy()
     void OnRenderImage(RenderTexture source, RenderTexture destination)
     {
         Graphics.Blit(source, destination);
-        switch (CaptureInterface.SendTexture(source, DoubleBuffering, ResizeMode, MirrorMode))
+        switch (CaptureInterface.SendTexture(source, Timeout, DoubleBuffering, ResizeMode, MirrorMode))
         {
             case ECaptureSendResult.SUCCESS: break;
             case ECaptureSendResult.WARNING_FRAMESKIP:               if (!HideWarnings) Debug.LogWarning("[UnityCapture] Capture device did skip a frame read, capture frame rate will not match render frame rate."); break;
@@ -89,7 +90,7 @@ public class Interface
     {
         [System.Runtime.InteropServices.DllImport("UnityCapturePlugin")] extern static System.IntPtr CaptureCreateInstance(int CapNum);
         [System.Runtime.InteropServices.DllImport("UnityCapturePlugin")] extern static void CaptureDeleteInstance(System.IntPtr instance);
-        [System.Runtime.InteropServices.DllImport("UnityCapturePlugin")] extern static ECaptureSendResult CaptureSendTexture(System.IntPtr instance, System.IntPtr nativetexture, bool UseDoubleBuffering, EResizeMode ResizeMode, EMirrorMode MirrorMode, bool IsLinearColorSpace);
+        [System.Runtime.InteropServices.DllImport("UnityCapturePlugin")] extern static ECaptureSendResult CaptureSendTexture(System.IntPtr instance, System.IntPtr nativetexture, int Timeout, bool UseDoubleBuffering, EResizeMode ResizeMode, EMirrorMode MirrorMode, bool IsLinearColorSpace);
         System.IntPtr CaptureInstance;
 
         public Interface(ECaptureDevice CaptureDevice)
@@ -108,10 +109,10 @@ public void Close()
             CaptureInstance = System.IntPtr.Zero;
         }
 
-        public ECaptureSendResult SendTexture(Texture Source, bool DoubleBuffering = false, EResizeMode ResizeMode = EResizeMode.Disabled, EMirrorMode MirrorMode = EMirrorMode.Disabled)
+        public ECaptureSendResult SendTexture(Texture Source, int Timeout = 1000, bool DoubleBuffering = false, EResizeMode ResizeMode = EResizeMode.Disabled, EMirrorMode MirrorMode = EMirrorMode.Disabled)
         {
             if (CaptureInstance == System.IntPtr.Zero) return ECaptureSendResult.ERROR_INVALIDCAPTUREINSTANCEPTR;
-            return CaptureSendTexture(CaptureInstance, Source.GetNativeTexturePtr(), DoubleBuffering, ResizeMode, MirrorMode, QualitySettings.activeColorSpace == ColorSpace.Linear);
+            return CaptureSendTexture(CaptureInstance, Source.GetNativeTexturePtr(), Timeout, DoubleBuffering, ResizeMode, MirrorMode, QualitySettings.activeColorSpace == ColorSpace.Linear);
         }
     }
 }