add get_board_sampling_rate method and overall cleanup (#805)

* add get_bord_sampling_rate() method, which tracks the current sampling rate of the device, instead of the static value

Signed-off-by: Andrey Parfenov <a1994ndrey@gmail.com>

Author: Andrey1994

cpp_package/src/board_shim.cpp

@@ -235,7 +235,8 @@ std::string BoardShim::config_board (std::string config)
     int response_len = 0;
     char response[8192];
     int res = ::config_board (
-        config.c_str (), response, &response_len, board_id, serialized_params.c_str ());
+        config.c_str (), response, &response_len, sizeof (response), board_id,
+        serialized_params.c_str ());
     if (res != (int)BrainFlowExitCodes::STATUS_OK)
     {
         throw BrainFlowException ("failed to config board", res);
@@ -281,6 +282,18 @@ int BoardShim::get_board_id ()
     return master_board_id;
 }
 
+int BoardShim::get_board_sampling_rate (int preset)
+{
+    int sampling_rate = -1;
+    int res =
+        ::get_board_sampling_rate (preset, &sampling_rate, board_id, serialized_params.c_str ());
+    if (res != (int)BrainFlowExitCodes::STATUS_OK)
+    {
+        throw BrainFlowException ("failed to get board sampling rate", res);
+    }
+    return sampling_rate;
+}
+
 //////////////////////////////////////////
 ///////////// data desc methods //////////
 //////////////////////////////////////////
@@ -289,7 +302,8 @@ json BoardShim::get_board_descr (int board_id, int preset)
 {
     char board_descr_str[16000];
     int string_len = 0;
-    int res = ::get_board_descr (board_id, preset, board_descr_str, &string_len);
+    int res =
+        ::get_board_descr (board_id, preset, board_descr_str, &string_len, sizeof (board_descr_str));
     if (res != (int)BrainFlowExitCodes::STATUS_OK)
     {
         throw BrainFlowException ("failed to get board info", res);
@@ -368,7 +382,7 @@ std::vector<std::string> BoardShim::get_eeg_names (int board_id, int preset)
 {
     char eeg_names[4096];
     int string_len = 0;
-    int res = ::get_eeg_names (board_id, preset, eeg_names, &string_len);
+    int res = ::get_eeg_names (board_id, preset, eeg_names, &string_len, sizeof (eeg_names));
     if (res != (int)BrainFlowExitCodes::STATUS_OK)
     {
         throw BrainFlowException ("failed to get board info", res);
@@ -401,7 +415,7 @@ std::string BoardShim::get_device_name (int board_id, int preset)
 {
     char name[4096];
     int string_len = 0;
-    int res = ::get_device_name (board_id, preset, name, &string_len);
+    int res = ::get_device_name (board_id, preset, name, &string_len, sizeof (name));
     if (res != (int)BrainFlowExitCodes::STATUS_OK)
     {
         throw BrainFlowException ("failed to get board info", res);
@@ -602,4 +616,4 @@ std::string BoardShim::get_version ()
     std::string verion_str (version, string_len);
 
     return verion_str;
-}
+}

cpp_package/src/inc/board_shim.h

@@ -255,6 +255,8 @@ class BoardShim
         int num_samples, int preset = (int)BrainFlowPresets::DEFAULT_PRESET);
     /// Get board id, for some boards can be different than provided (playback, streaming)
     int get_board_id ();
+    /// get actual sampling rate for prepared board session
+    int get_board_sampling_rate (int preset = (int)BrainFlowPresets::DEFAULT_PRESET);
     /// get number of packages in ringbuffer
     int get_board_data_count (int preset = (int)BrainFlowPresets::DEFAULT_PRESET);
     /// get all collected data and flush it from internal buffer

csharp_package/brainflow/brainflow/board_controller_library.cs

@@ -151,14 +151,16 @@ public static class BoardControllerLibrary64
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int log_message_board_controller (int log_level, string message);
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
-        public static extern int config_board (string config, byte[] response, int[] len, int board_id, string input_json);
+        public static extern int config_board (string config, byte[] response, int[] len, int max_len, int board_id, string input_json);
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int config_board_with_bytes (byte[] bytes, int len, int board_id, string input_json);
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int set_log_file_board_controller (string log_file);
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_sampling_rate (int board_id, int preset, int[] sampling_rate);
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
+        public static extern int get_board_sampling_rate (int preset, int[] sampling_rate, int board_id, string input_json);
+        [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_timestamp_channel (int board_id, int preset, int[] timestamp_channel);
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_marker_channel (int board_id, int preset, int[] marker_channel);
@@ -195,19 +197,19 @@ public static class BoardControllerLibrary64
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int is_prepared (int[] prepared, int board_id, string input_json);
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
-        public static extern int get_eeg_names (int board_id, int preset, byte[] eeg_names, int[] len);
+        public static extern int get_eeg_names (int board_id, int preset, byte[] eeg_names, int[] len, int max_len);
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_resistance_channels (int board_id, int preset, int[] channels, int[] len);
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_magnetometer_channels (int board_id, int preset, int[] channels, int[] len);
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_exg_channels (int board_id, int preset, int[] channels, int[] len);
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
-        public static extern int get_device_name (int board_id, int preset, byte[] name, int[] len);
+        public static extern int get_device_name (int board_id, int preset, byte[] name, int[] len, int max_len);
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int insert_marker (double value, int preset, int board_id, string input_json);
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
-        public static extern int get_board_descr (int board_id, int preset, byte[] board_descr, int[] len);
+        public static extern int get_board_descr (int board_id, int preset, byte[] board_descr, int[] len, int max_len);
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int release_all_sessions ();
         [DllImport ("BoardController", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
@@ -241,14 +243,16 @@ public static class BoardControllerLibrary32
         [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int log_message_board_controller (int log_level, string message);
         [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
-        public static extern int config_board (string config, byte[] response, int[] len, int board_id, string input_json);
+        public static extern int config_board (string config, byte[] response, int[] len, int max_len, int board_id, string input_json);
         [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int config_board_with_bytes (byte[] bytes, int len, int board_id, string input_json);
         [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int set_log_file_board_controller (string log_file);
         [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_sampling_rate (int board_id, int preset, int[] sampling_rate);
         [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
+        public static extern int get_board_sampling_rate (int preset, int[] sampling_rate, int board_id, string input_json);
+        [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_timestamp_channel (int board_id, int preset, int[] timestamp_channel);
         [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_marker_channel (int board_id, int preset, int[] marker_channel);
@@ -285,17 +289,17 @@ public static class BoardControllerLibrary32
         [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int is_prepared (int[] prepared, int board_id, string input_json);
         [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
-        public static extern int get_eeg_names (int board_id, int preset, byte[] eeg_names, int[] len);
+        public static extern int get_eeg_names (int board_id, int preset, byte[] eeg_names, int[] len, int max_len);
         [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_resistance_channels (int board_id, int preset, int[] channels, int[] len);
         [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int get_exg_channels (int board_id, int preset, int[] channels, int[] len);
         [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
-        public static extern int get_device_name (int board_id, int preset, byte[] name, int[] len);
+        public static extern int get_device_name (int board_id, int preset, byte[] name, int[] len, int max_len);
         [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int insert_marker (double value, int preset, int board_id, string input_json);
         [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
-        public static extern int get_board_descr (int board_id, int preset, byte[] board_descr, int[] len);
+        public static extern int get_board_descr (int board_id, int preset, byte[] board_descr, int[] len, int max_len);
         [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
         public static extern int release_all_sessions ();
         [DllImport ("BoardController32", SetLastError = true, CallingConvention = CallingConvention.Cdecl)]
@@ -457,14 +461,14 @@ public static int insert_marker (double value, int preset, int board_id, string
         }
 
 
-        public static int config_board (string config, byte[] str, int[] len, int board_id, string input_json)
+        public static int config_board (string config, byte[] str, int[] len, int max_len, int board_id, string input_json)
         {
             switch (PlatformHelper.get_library_environment ())
             {
                 case LibraryEnvironment.x64:
-                    return BoardControllerLibrary64.config_board (config, str, len, board_id, input_json);
+                    return BoardControllerLibrary64.config_board (config, str, len, max_len, board_id, input_json);
                 case LibraryEnvironment.x86:
-                    return BoardControllerLibrary32.config_board (config, str, len, board_id, input_json);
+                    return BoardControllerLibrary32.config_board (config, str, len, max_len, board_id, input_json);
             }
 
             return (int)BrainFlowExitCodes.GENERAL_ERROR;
@@ -535,6 +539,19 @@ public static int get_sampling_rate (int board_id, int preset, int[] sampling_ra
             return (int)BrainFlowExitCodes.GENERAL_ERROR;
         }
 
+        public static int get_board_sampling_rate (int preset, int[] sampling_rate, int board_id, string input_json)
+        {
+            switch (PlatformHelper.get_library_environment ())
+            {
+                case LibraryEnvironment.x64:
+                    return BoardControllerLibrary64.get_board_sampling_rate (preset, sampling_rate, board_id, input_json);
+                case LibraryEnvironment.x86:
+                    return BoardControllerLibrary32.get_board_sampling_rate (preset, sampling_rate, board_id, input_json);
+            }
+
+            return (int)BrainFlowExitCodes.GENERAL_ERROR;
+        }
+
         public static int get_package_num_channel (int board_id, int preset, int[] package_num)
         {
             switch (PlatformHelper.get_library_environment ())
@@ -600,14 +617,14 @@ public static int get_marker_channel (int board_id, int preset, int[] marker_cha
             return (int)BrainFlowExitCodes.GENERAL_ERROR;
         }
 
-        public static int get_eeg_names (int board_id, int preset, byte[] names, int[] len)
+        public static int get_eeg_names (int board_id, int preset, byte[] names, int[] len, int max_len)
         {
             switch (PlatformHelper.get_library_environment ())
             {
                 case LibraryEnvironment.x64:
-                    return BoardControllerLibrary64.get_eeg_names (board_id, preset, names, len);
+                    return BoardControllerLibrary64.get_eeg_names (board_id, preset, names, len, max_len);
                 case LibraryEnvironment.x86:
-                    return BoardControllerLibrary32.get_eeg_names (board_id, preset, names, len);
+                    return BoardControllerLibrary32.get_eeg_names (board_id, preset, names, len, max_len);
             }
 
             return (int)BrainFlowExitCodes.GENERAL_ERROR;
@@ -626,27 +643,27 @@ public static int get_board_presets (int board_id, int[] names, int[] len)
             return (int)BrainFlowExitCodes.GENERAL_ERROR;
         }
 
-        public static int get_board_descr (int board_id, int preset, byte[] descr, int[] len)
+        public static int get_board_descr (int board_id, int preset, byte[] descr, int[] len, int max_len)
         {
             switch (PlatformHelper.get_library_environment ())
             {
                 case LibraryEnvironment.x64:
-                    return BoardControllerLibrary64.get_board_descr (board_id, preset, descr, len);
+                    return BoardControllerLibrary64.get_board_descr (board_id, preset, descr, len, max_len);
                 case LibraryEnvironment.x86:
-                    return BoardControllerLibrary32.get_board_descr (board_id, preset, descr, len);
+                    return BoardControllerLibrary32.get_board_descr (board_id, preset, descr, len, max_len);
             }
 
             return (int)BrainFlowExitCodes.GENERAL_ERROR;
         }
 
-        public static int get_device_name (int board_id, int preset, byte[] name, int[] len)
+        public static int get_device_name (int board_id, int preset, byte[] name, int[] len, int max_len)
         {
             switch (PlatformHelper.get_library_environment ())
             {
                 case LibraryEnvironment.x64:
-                    return BoardControllerLibrary64.get_device_name (board_id, preset, name, len);
+                    return BoardControllerLibrary64.get_device_name (board_id, preset, name, len, max_len);
                 case LibraryEnvironment.x86:
-                    return BoardControllerLibrary32.get_device_name (board_id, preset, name, len);
+                    return BoardControllerLibrary32.get_device_name (board_id, preset, name, len, max_len);
             }
 
             return (int)BrainFlowExitCodes.GENERAL_ERROR;

csharp_package/brainflow/brainflow/board_shim.cs

@@ -179,7 +179,7 @@ public static string[] get_eeg_names (int board_id, int preset = (int)BrainFlowP
         {
             int[] len = new int[1];
             byte[] str = new byte[4096];
-            int res = BoardControllerLibrary.get_eeg_names (board_id, preset, str, len);
+            int res = BoardControllerLibrary.get_eeg_names (board_id, preset, str, len, str.Length);
             if (res != (int)BrainFlowExitCodes.STATUS_OK)
             {
                 throw new BrainFlowError (res);
@@ -222,7 +222,7 @@ public static T get_board_descr<T> (int board_id, int preset = (int)BrainFlowPre
         {
             int[] len = new int[1];
             byte[] str = new byte[16000];
-            int res = BoardControllerLibrary.get_board_descr (board_id, preset, str, len);
+            int res = BoardControllerLibrary.get_board_descr (board_id, preset, str, len, str.Length);
             if (res != (int)BrainFlowExitCodes.STATUS_OK)
             {
                 throw new BrainFlowError (res);
@@ -246,7 +246,7 @@ public static string get_device_name (int board_id, int preset = (int)BrainFlowP
         {
             int[] len = new int[1];
             byte[] str = new byte[4096];
-            int res = BoardControllerLibrary.get_device_name (board_id, preset, str, len);
+            int res = BoardControllerLibrary.get_device_name (board_id, preset, str, len, str.Length);
             if (res != (int)BrainFlowExitCodes.STATUS_OK)
             {
                 throw new BrainFlowError (res);
@@ -717,7 +717,7 @@ public string config_board (string config)
         {
             int[] len = new int[1];
             byte[] str = new byte[4096];
-            int res = BoardControllerLibrary.config_board (config, str, len, board_id, input_json);
+            int res = BoardControllerLibrary.config_board (config, str, len, str.Length, board_id, input_json);
             if (res != (int)BrainFlowExitCodes.STATUS_OK)
             {
                 throw new BrainFlowError (res);
@@ -839,6 +839,22 @@ public int get_board_id ()
             return master_board;
         }
 
+        /// <summary>
+        /// get actual sampling rate for this prepared board session
+        /// </summary>
+        /// <param name="preset">preset for device</param>
+        /// <returns>sampling rate</returns>
+        public int get_board_sampling_rate (int preset = (int)BrainFlowPresets.DEFAULT_PRESET)
+        {
+            int[] val = new int[1];
+            int res = BoardControllerLibrary.get_board_sampling_rate (preset, val, board_id, input_json);
+            if (res != (int)BrainFlowExitCodes.STATUS_OK)
+            {
+                throw new BrainFlowError (res);
+            }
+            return val[0];
+        }
+
         ///<summary>
         /// Get input params
         ///</summary>