Merge pull request #8 from VRCFaceTracking/feat/better-errors

Better Error Handling

Author: benaclejames

SRanipalExtTrackingModule/SRanipalTrackingInterface.cs

@@ -16,14 +16,44 @@ namespace SRanipalExtTrackingInterface
 {
     public class SRanipalExtTrackingInterface : ExtTrackingModule
     {
-        LipData_v2 lipData;
-        EyeData_v2 eyeData;
-        private static bool eyeEnabled, lipEnabled, isViveProEye;
+        LipData_v2 lipData = default;
+        EyeData_v2 eyeData = default;
+        private static bool eyeEnabled = false, 
+                            lipEnabled = false, 
+                            isViveProEye = false,
+                            isWireless = false;
+        private static Error eyeError = Error.UNDEFINED;
+        private static Error lipError = Error.UNDEFINED;
+
+        internal static Process? _process;
+        internal static IntPtr _processHandle;
+        internal static IntPtr _offset;
+        
         private static byte[] eyeImageCache, lipImageCache;
 
         // Kernel32 SetDllDirectory
         [DllImport("kernel32.dll", CharSet = CharSet.Unicode)]
         private static extern bool SetDllDirectory(string lpPathName);
+        
+        private static bool Attach()
+        {
+            var processes = Process.GetProcessesByName("sr_runtime");
+            if (processes.Length <= 0) return false;
+            _process = processes[0];
+            _processHandle =
+                Utils.OpenProcess(Utils.PROCESS_VM_READ,
+                    false, _process.Id);
+            return true;
+        }
+
+        private static byte[] ReadMemory(IntPtr offset, ref byte[] buf) {
+            var bytesRead = 0;
+            var size = buf.Length;
+            
+            Utils.ReadProcessMemory((int) _processHandle, offset, buf, size, ref bytesRead);
+
+            return bytesRead != size ? null : buf;
+        }
 
         public override (bool SupportsEye, bool SupportsExpression) Supported => (true, true);
 
@@ -83,15 +113,10 @@ public override (bool eyeSuccess, bool expressionSuccess) Initialize(bool eyeAva
 
             SetDllDirectory(currentDllDirectory + "\\ModuleLibs\\" + (srRuntimeVer.StartsWith("1.3.6") ? "New" : "Old"));
 
-            Error eyeError = Error.UNDEFINED, lipError = Error.UNDEFINED;
-
-            if (eyeAvailable)
-                eyeError = SRanipal_API.Initial(SRanipal_Eye_v2.ANIPAL_TYPE_EYE_V2, IntPtr.Zero);
-
-            if (expressionAvailable)
-                lipError = SRanipal_API.Initial(SRanipal_Lip_v2.ANIPAL_TYPE_LIP_V2, IntPtr.Zero);
+            SRanipal_API.InitialRuntime(); // hack to unblock sranipal!!!
 
-            HandleSrErrors(eyeError, lipError);
+            eyeEnabled = InitTracker(SRanipal_Eye_v2.ANIPAL_TYPE_EYE_V2, "Eye");
+            lipEnabled = InitTracker(SRanipal_Lip_v2.ANIPAL_TYPE_LIP_V2, "Lip");
 
             if (eyeEnabled && Utils.HasAdmin)
             {
@@ -112,7 +137,7 @@ public override (bool eyeSuccess, bool expressionSuccess) Initialize(bool eyeAva
                         {
                             _offset = module.BaseAddress; 
 
-                            switch (_process.MainModule.FileVersionInfo.FileVersion)
+                            switch (_process.MainModule?.FileVersionInfo.FileVersion)
                             {
                                 case "1.3.2.0":
                                     _offset += 0x19190;
@@ -126,8 +151,6 @@ public override (bool eyeSuccess, bool expressionSuccess) Initialize(bool eyeAva
                                     UnifiedTracking.EyeImageData.SupportsImage = false;
                                     break;
                             }
-
-                            //(_process.MainModule.FileVersionInfo.FileVersion == "1.3.2.0" ? 0x19190 : 0x19100);
                         }
 
                     UnifiedTracking.EyeImageData.ImageSize = (200, 100);
@@ -140,12 +163,10 @@ public override (bool eyeSuccess, bool expressionSuccess) Initialize(bool eyeAva
             {
                 UnifiedTracking.LipImageData.SupportsImage = true;
                 UnifiedTracking.LipImageData.ImageSize = (SRanipal_Lip_v2.ImageWidth, SRanipal_Lip_v2.ImageHeight);
-                UnifiedTracking.LipImageData.ImageData = new byte[SRanipal_Lip_v2.ImageWidth *
-                                                                  SRanipal_Lip_v2.ImageHeight * 4];
-                
                 lipData.image = Marshal.AllocCoTaskMem(UnifiedTracking.LipImageData.ImageSize.x *
                                                        UnifiedTracking.LipImageData.ImageSize.x);
 
+                UnifiedTracking.LipImageData.ImageData = new byte[SRanipal_Lip_v2.ImageWidth * SRanipal_Lip_v2.ImageHeight * 4];
                 lipImageCache = new byte[SRanipal_Lip_v2.ImageWidth * SRanipal_Lip_v2.ImageHeight];
             }
 
@@ -162,89 +183,67 @@ public override (bool eyeSuccess, bool expressionSuccess) Initialize(bool eyeAva
 
             isViveProEye = SRanipal_Eye_API.IsViveProEye();
 
-            return (eyeEnabled, lipEnabled);
+            return (eyeAvailable && eyeEnabled, expressionAvailable && lipEnabled);
         }
 
-        private static void HandleSrErrors(Error eyeError, Error lipError)
+        private bool InitTracker(int anipalType, string name)
         {
-            if (eyeError == Error.WORK)
-                eyeEnabled = true;
+            Logger.LogInformation($"Initializing {name}...");
+            var error = SRanipal_API.Initial(anipalType, IntPtr.Zero);
 
-            if (lipError == Error.FOXIP_SO)
-                while (lipError == Error.FOXIP_SO)
-                    lipError = SRanipal_API.Initial(SRanipal_Lip_v2.ANIPAL_TYPE_LIP_V2, IntPtr.Zero);
-            
-            if (lipError == Error.WORK)
-                lipEnabled = true;
+            handler:
+            switch (error)
+            {
+                case Error.FOXIP_SO: // wireless issue
+                    Logger.LogInformation("Vive wireless detected. Forcing initialization...");
+                    while (error == Error.FOXIP_SO)
+                        error = SRanipal_API.Initial(anipalType, IntPtr.Zero);
+                    goto handler;
+                case Error.WORK:
+                    Logger.LogInformation($"{name} successfully started!");
+                    return true;
+                default:
+                    break;
+            }
+            Logger.LogInformation($"{name} failed to initialize: {error}");
+            return false;
         }
 
         public override void Teardown()
         {
-            // We won't bother terminating sranipal modules here as if this is a shutdown, they'll automatically be released.
+            SRanipal_API.ReleaseRuntime();
         }
 
-        #region Update
-
-        
         public override void Update()
         {
             Thread.Sleep(10);
 
             if (Status != ModuleState.Active)
                 return;
-            
-            if (lipEnabled && UpdateMouth() != Error.WORK)
+            if (lipEnabled && !UpdateMouth())
             {
-                Logger.LogError("An error occured while getting lip data. This might be a wireless crash.");
-                Logger.LogWarning("Waiting 30 seconds before reinitializing to account for wireless users.");
-                Thread.Sleep(30000);
-               // UnifiedLibManager.Initialize();
-                return;
+                Logger.LogError("An error has occured when updating tracking. Reinitializing needed runtimes.");
+                SRanipal_API.InitialRuntime();
+                InitTracker(SRanipal_Lip_v2.ANIPAL_TYPE_LIP_V2, "Lip");
             }
-
-            if (eyeEnabled && UpdateEye() != Error.WORK)
+            if (eyeEnabled && !UpdateEye())
             {
-                Logger.LogError("An error occured while getting eye data. This might be a wireless crash.");
-                Logger.LogWarning("Waiting 30 seconds before reinitializing to account for wireless users.");
-                Thread.Sleep(30000);
-                //UnifiedLibManager.Initialize();
-                return;
+                Logger.LogError("An error has occured when updating tracking. Reinitializing needed runtimes.");
+                SRanipal_API.InitialRuntime();
+                InitTracker(SRanipal_Eye_v2.ANIPAL_TYPE_EYE_V2, "Eye");
             }
         }
 
-        #endregion
-
-        private static Process _process;
-        private static IntPtr _processHandle;
-        private IntPtr _offset;
-
-        private static bool Attach()
-        {
-            if (Process.GetProcessesByName("sr_runtime").Length <= 0) return false;
-            _process = Process.GetProcessesByName("sr_runtime")[0];
-            _processHandle =
-                Utils.OpenProcess(Utils.PROCESS_VM_READ,
-                    false, _process.Id);
-            return true;
-        }
-
-        private static byte[] ReadMemory(IntPtr offset, ref byte[] buf) {
-            var bytesRead = 0;
-            var size = buf.Length;
-            
-            Utils.ReadProcessMemory((int) _processHandle, offset, buf, size, ref bytesRead);
-
-            return bytesRead != size ? null : buf;
-        }
-        
-        private Error UpdateEye()
+        private bool UpdateEye()
         {
-            var updateResult = SRanipal_Eye_API.GetEyeData_v2(ref eyeData);
+            eyeError = SRanipal_Eye_API.GetEyeData_v2(ref eyeData);
+            if (eyeError != Error.WORK) return false;
 
             UpdateEyeParameters(ref UnifiedTracking.Data.Eye, eyeData.verbose_data);
             UpdateEyeExpressions(ref UnifiedTracking.Data.Shapes, eyeData.expression_data);
 
-            if (_processHandle == IntPtr.Zero || !UnifiedTracking.EyeImageData.SupportsImage) return updateResult;
+            if (_processHandle == IntPtr.Zero || !UnifiedTracking.EyeImageData.SupportsImage) 
+                return true;
 
             // Read 20000 image bytes from the predefined offset. 10000 bytes per eye.
             var imageBytes = ReadMemory(_offset, ref eyeImageCache);
@@ -280,7 +279,7 @@ private Error UpdateEye()
                 }
             }
 
-            return updateResult;
+            return true;
         }
 
         private static Vector3 GetConvergenceAngleOffset(VerboseData external)
@@ -357,13 +356,15 @@ private void UpdateEyeExpressions(ref UnifiedExpressionShape[] data, EyeExpressi
             data[(int)UnifiedExpressions.BrowLowererRight].Weight = external.right.eye_squeeze;
         }
 
-        private Error UpdateMouth()
+        private bool UpdateMouth()
         {
-            var updateResult = SRanipal_Lip_API.GetLipData_v2(ref lipData);
-
+            lipError = SRanipal_Lip_API.GetLipData_v2(ref lipData);
+            if (lipError != Error.WORK)
+                return false;
             UpdateMouthExpressions(ref UnifiedTracking.Data, lipData.prediction_data);
 
-            if (lipData.image == IntPtr.Zero || !UnifiedTracking.LipImageData.SupportsImage) return updateResult;
+            if (lipData.image == IntPtr.Zero || !UnifiedTracking.LipImageData.SupportsImage) 
+                return true;
 
             Marshal.Copy(lipData.image, lipImageCache, 0, UnifiedTracking.LipImageData.ImageSize.x *
             UnifiedTracking.LipImageData.ImageSize.y);
@@ -383,7 +384,7 @@ private Error UpdateMouth()
                 }
             }
 
-            return updateResult;
+            return true;
         }
 
         private void UpdateMouthExpressions(ref UnifiedTrackingData data, PredictionData_v2 external)

SRanipalExtTrackingModule/SRanipal_API.cs

@@ -6,34 +6,33 @@ namespace ViveSR
 {
     namespace anipal
     {
-        public class SRanipal_API
+        public static class SRanipal_API
         {
-            /// <summary>
-            /// Invokes an anipal module.
-            /// </summary>
-            /// <param name="anipalType">The index of an anipal module.</param>
-            /// <param name="config">Indicates the resulting ViveSR.Error status of this method.</returns>
-            /// <returns>Indicates the resulting ViveSR.Error status of this method.</returns>
-            [DllImport("SRanipal")]
-            public static extern Error Initial(int anipalType, IntPtr config);
+            [DllImport("kernel32.dll", SetLastError = true)]
+            private static extern IntPtr LoadLibrary(string dllToLoad);
 
-            /// <summary>
-            /// Terminates an anipal module.
-            /// </summary>
-            /// <param name="anipalType">The index of an anipal module.</param>
-            /// <returns>Indicates the resulting ViveSR.Error status of this method.</returns>
-            [DllImport("SRanipal")]
-            public static extern Error Release(int anipalType);
+            [DllImport("kernel32.dll", SetLastError = true)]
+            [return: MarshalAs(UnmanagedType.Bool)]
+            private static extern bool FreeLibrary(IntPtr hModule);
 
-            /// <summary>
-            /// Gets the status of an anipal module.
-            /// </summary>
-            /// <param name="anipalType">The index of an anipal module.</param>
-            /// <param name="status">The status of an anipal module.</param>
-            /// <returns>Indicates the resulting ViveSR.Error status of this method.</returns>
-            [DllImport("SRanipal")]
-            public static extern Error GetStatus(int anipalType, out AnipalStatus status);
+            private static IntPtr module = IntPtr.Zero;
 
+            public static void InitialRuntime()
+            {
+                if (module != IntPtr.Zero) 
+                    ReleaseRuntime();
+                module = LoadLibrary("SRanipal.dll");
+            }
+
+            public static void ReleaseRuntime()
+            {
+                if (!FreeLibrary(module)) // ideally should never happen.
+                    throw new Exception($"Failed to release Lip module DLL.");
+                module = IntPtr.Zero;
+            }
+
+            [DllImport("SRanipal.dll", CallingConvention = CallingConvention.Cdecl)]
+            internal static extern Error Initial(int anipalType, IntPtr config);
         }
     }
-}
+}