Merge pull request #22 from open-ephys/issue-21

Fix MiniCam frame rate
open-ephys · Nov 6, 2024 · 696040f · 696040f
2 parents 08a1aeb + 00e9b76
commit 696040f
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 17 deletions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -13,7 +13,7 @@
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
     <UseArtifactsOutput>true</UseArtifactsOutput>
     <PackageIcon>icon.png</PackageIcon>
-    <VersionPrefix>0.2.0</VersionPrefix>
+    <VersionPrefix>0.3.0</VersionPrefix>
     <VersionSuffix></VersionSuffix>
     <LangVersion>10.0</LangVersion>
     <Features>strict</Features>

diff --git a/ExamplesWorkflows/UclaMiniCam.bonsai b/ExamplesWorkflows/UclaMiniCam.bonsai
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<WorkflowBuilder Version="2.8.5"
+<WorkflowBuilder Version="2.8.1"
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                  xmlns:p1="clr-namespace:OpenEphys.Miniscope;assembly=OpenEphys.Miniscope"
                  xmlns:rx="clr-namespace:Bonsai.Reactive;assembly=Bonsai.Core"
@@ -13,7 +13,7 @@
           <p1:Index>0</p1:Index>
           <p1:LedBrightness>0</p1:LedBrightness>
           <p1:SensorGain>Low</p1:SensorGain>
-          <p1:FramesPerSecond>Fps50</p1:FramesPerSecond>
+          <p1:FramesPerSecond>30</p1:FramesPerSecond>
         </Combinator>
       </Expression>
       <Expression xsi:type="MemberSelector">

diff --git a/ExamplesWorkflows/UclaMiniCamTriggered.bonsai b/ExamplesWorkflows/UclaMiniCamTriggered.bonsai
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<WorkflowBuilder Version="2.8.5"
+<WorkflowBuilder Version="2.8.1"
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                  xmlns:p1="clr-namespace:OpenEphys.Miniscope;assembly=OpenEphys.Miniscope"
                  xmlns:rx="clr-namespace:Bonsai.Reactive;assembly=Bonsai.Core"
@@ -13,7 +13,7 @@
           <p1:Index>0</p1:Index>
           <p1:LedBrightness>0</p1:LedBrightness>
           <p1:SensorGain>Low</p1:SensorGain>
-          <p1:FramesPerSecond>Fps50</p1:FramesPerSecond>
+          <p1:FramesPerSecond>30</p1:FramesPerSecond>
         </Combinator>
       </Expression>
       <Expression xsi:type="rx:Condition">

diff --git a/OpenEphys.Miniscope/UclaMiniCam.cs b/OpenEphys.Miniscope/UclaMiniCam.cs
@@ -20,14 +20,6 @@ public enum GainMiniCam
             Maximum = 6240,
         };
 
-        // NB: Needs a unique name, even though its a class member, for de/serilizaiton without issues
-        public enum FrameRateMiniCam
-        {
-            Fps10 = 2048,
-            Fps40 = 1536,
-            Fps50 = 6240,
-        };
-
         // Frame size
         const int Width = 1024;
         const int Height = 768;
@@ -50,7 +42,9 @@ public enum FrameRateMiniCam
         public GainMiniCam SensorGain { get; set; } = GainMiniCam.Low;
 
         [Description("Frames captured per second.")]
-        public FrameRateMiniCam FramesPerSecond { get; set; } = FrameRateMiniCam.Fps50;
+        [Range(5, 47)]
+        [Editor(DesignTypes.SliderEditor, typeof(UITypeEditor))]
+        public int FramesPerSecond { get; set; } = 30;
 
         // State
         readonly IObservable<UclaMiniCamFrame> source;
@@ -82,7 +76,7 @@ static internal AbusedUvcRegisters IssueStartCommands(Capture capture)
             Helpers.SendConfig(capture, Helpers.CreateCommand(176, 15, 2)); // Speed up I2c bus timer to 50u Max
             Helpers.SendConfig(capture, Helpers.CreateCommand(176, 30, 10)); // Decrease BCC timeout, units in 2 ms
             Helpers.SendConfig(capture, Helpers.CreateCommand(192, 8, 186, 108)); // Set aliases for MT9P031 and LM3509
-            Helpers.SendConfig(capture, Helpers.CreateCommand(192, 16, 186, 108)); // Set aliasesor MT9P031 and LM3509
+            Helpers.SendConfig(capture, Helpers.CreateCommand(192, 16, 186, 108)); // Set aliases for MT9P031 and LM3509
             Helpers.SendConfig(capture, Helpers.CreateCommand(186, 3, 5, 255)); // Set height to 1535 rows
             Helpers.SendConfig(capture, Helpers.CreateCommand(186, 4, 7, 255)); // Set width to 2047 colums
             Helpers.SendConfig(capture, Helpers.CreateCommand(186, 34, 0, 17)); // 2x subsamp and binning 1
@@ -142,8 +136,12 @@ public UclaMiniCam()
 
                                     if (FramesPerSecond != lastFps || !initialized)
                                     {
-                                        byte vl = (byte)((int)FramesPerSecond & 0x00000FF);
-                                        byte vh = (byte)(((int)FramesPerSecond & 0x000FF00) >> 8);
+                                        // This was found empirically.
+                                        var reg = 37000 / FramesPerSecond;
+                                        if (reg < 0) reg = 0;
+
+                                        byte vl = (byte)(reg & 0x00000FF);
+                                        byte vh = (byte)((reg & 0x000FF00) >> 8);
                                         Helpers.SendConfig(capture, Helpers.CreateCommand(186, 9, vh, vl));
                                         lastFps = FramesPerSecond;
                                     }