add get_board_sampling_rate method

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

Author: Andrey1994

cpp_package/src/board_shim.cpp

@@ -282,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 //////////
 //////////////////////////////////////////

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

@@ -159,6 +159,8 @@ public static class BoardControllerLibrary64
         [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);
@@ -249,6 +251,8 @@ public static class BoardControllerLibrary32
         [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);
@@ -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 ())

csharp_package/brainflow/brainflow/board_shim.cs

@@ -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>

java_package/brainflow/src/main/java/brainflow/BoardShim.java

@@ -56,6 +56,7 @@ int get_current_board_data (int num_samples, int preset, double[] data_buf, int[
         int java_set_jnienv (JNIEnv java_jnienv);
 
         int get_sampling_rate (int board_id, int preset, int[] sampling_rate);
+        int get_board_sampling_rate (int preset, int[] sampling_rate, int board_id, String params);
 
         int get_battery_channel (int board_id, int preset, int[] battery_channel);
 
@@ -1359,6 +1360,28 @@ public int get_board_id ()
         return master_board_id;
     }
 
+    /**
+     * get actual sampling rate for this prepared board session
+     */
+    public int get_board_sampling_rate (BrainFlowPresets preset) throws BrainFlowError
+    {
+        int[] res = new int[1];
+        int ec = instance.get_board_sampling_rate (preset.get_code (), res, board_id, input_json);
+        if (ec != BrainFlowExitCode.STATUS_OK.get_code ())
+        {
+            throw new BrainFlowError ("Error in get_board_sampling_rate", ec);
+        }
+        return res[0];
+    }
+
+    /**
+     * get actual sampling rate for this prepared board session
+     */
+    public int get_board_sampling_rate () throws BrainFlowError
+    {
+        return get_board_sampling_rate (BrainFlowPresets.DEFAULT_PRESET);
+    }
+
     /**
      * add streamer
      */

julia_package/brainflow/src/board_shim.jl

@@ -136,7 +136,8 @@ end
 @brainflow_rethrow function get_eeg_names(board_id::BoardIdType, preset::PresetType=Integer(DEFAULT_PRESET))
     names_string = Vector{Cuchar}(undef, 4096)
     len = Vector{Cint}(undef, 1)
-    ccall((:get_eeg_names, BOARD_CONTROLLER_INTERFACE), Cint, (Cint, Cint, Ptr{UInt8}, Ptr{Cint}), Int32(board_id), Int32(preset), names_string, len)
+    ccall((:get_eeg_names, BOARD_CONTROLLER_INTERFACE), Cint, (Cint, Cint, Ptr{UInt8}, Ptr{Cint}, Cint),
+            Int32(board_id), Int32(preset), names_string, len, length(names_string))
     sub_string = String(names_string)[1:len[1]]
     value = split(sub_string, ',')
     return value
@@ -145,7 +146,8 @@ end
 @brainflow_rethrow function get_board_descr(board_id::BoardIdType, preset::PresetType=Integer(DEFAULT_PRESET))
     names_string = Vector{Cuchar}(undef, 16000)
     len = Vector{Cint}(undef, 1)
-    ccall((:get_board_descr, BOARD_CONTROLLER_INTERFACE), Cint, (Cint, Cint, Ptr{UInt8}, Ptr{Cint}), Int32(board_id), Int32(preset), names_string, len)
+    ccall((:get_board_descr, BOARD_CONTROLLER_INTERFACE), Cint, (Cint, Cint, Ptr{UInt8}, Ptr{Cint}, Cint),
+            Int32(board_id), Int32(preset), names_string, len, length(names_string))
     sub_string = String(names_string)[1:len[1]]
     value = JSON.parse(sub_string)
     return value
@@ -154,7 +156,8 @@ end
 @brainflow_rethrow function get_device_name(board_id::BoardIdType, preset::PresetType=Integer(DEFAULT_PRESET))
     names_string = Vector{Cuchar}(undef, 4096)
     len = Vector{Cint}(undef, 1)
-    ccall((:get_device_name, BOARD_CONTROLLER_INTERFACE), Cint, (Cint, Cint, Ptr{UInt8}, Ptr{Cint}), Int32(board_id), Int32(preset), names_string, len)
+    ccall((:get_device_name, BOARD_CONTROLLER_INTERFACE), Cint, (Cint, Cint, Ptr{UInt8}, Ptr{Cint}, Cint),
+            Int32(board_id), Int32(preset), names_string, len, length(names_string))
     sub_string = String(names_string)[1:len[1]]
     return sub_string
 end
@@ -239,6 +242,15 @@ end
 BoardShim(id::BoardIds, params::BrainFlowInputParams) = BoardShim(Integer(id), params)
 BoardShim(id) = BoardShim(id, BrainFlowInputParams())
 
+@brainflow_rethrow function get_board_sampling_rate(board_shim::BoardShim, preset::PresetType=Integer(DEFAULT_PRESET))
+    val = Vector{Cint}(undef, 1)
+    ccall((:get_board_sampling_rate, BOARD_CONTROLLER_INTERFACE), Cint,
+        (Cint, Ptr{Cint}, Cint, Ptr{UInt8}), Int32(preset), val, board_shim.board_id,
+        board_shim.input_json)
+    value = val[1]
+    return value
+end
+
 @brainflow_rethrow function prepare_session(board_shim::BoardShim)
     ccall((:prepare_session, BOARD_CONTROLLER_INTERFACE), Cint, (Cint, Ptr{UInt8}), board_shim.board_id, board_shim.input_json)
 end
@@ -291,8 +303,8 @@ end
 @brainflow_rethrow function config_board(config::String, board_shim::BoardShim)
     resp_string = Vector{Cuchar}(undef, 4096)
     len = Vector{Cint}(undef, 1)
-    ccall((:config_board, BOARD_CONTROLLER_INTERFACE), Cint, (Ptr{UInt8}, Ptr{UInt8}, Ptr{Cint}, Cint, Ptr{UInt8}),
-            config, resp_string, len, board_shim.board_id, board_shim.input_json)
+    ccall((:config_board, BOARD_CONTROLLER_INTERFACE), Cint, (Ptr{UInt8}, Ptr{UInt8}, Ptr{Cint}, Cint, Cint, Ptr{UInt8}),
+            config, resp_string, len, length(resp_string), board_shim.board_id, board_shim.input_json)
     sub_string = String(resp_string)[1:len[1]]
     return sub_string
 end
@@ -335,4 +347,4 @@ end
             num_samples, Int32(preset), val, data_size, board_shim.board_id, board_shim.input_json)
     value = transpose(reshape(val[1:data_size[1] * num_rows], (data_size[1], num_rows)))
     return value
-end
+end

matlab_package/brainflow/BoardShim.m

@@ -505,6 +505,16 @@ function insert_marker(obj, value, preset)
            prepared = boolean(res.value);
         end
 
+        function sampling_rate = get_board_sampling_rate(obj, preset)
+            % get actual sampling rate for prepared board session
+            task_name = 'get_board_sampling_rate';
+            lib_name = BoardShim.load_lib();
+            res = libpointer('int32Ptr', 0);
+            exit_code = calllib(lib_name, task_name, preset, res, obj.board_id, obj.input_params_json);
+            BoardShim.check_ec(exit_code, task_name);
+            sampling_rate = res.value;
+        end
+
     end
 
 end

nodejs_package/brainflow/board_shim.ts

@@ -78,6 +78,7 @@ class BoardControllerDLL extends BoardControllerFunctions
         this.releaseSession = this.lib.func(CLike.release_session);
         this.stopStream = this.lib.func(CLike.stop_stream);
         this.getSamplingRate = this.lib.func(CLike.get_sampling_rate);
+        this.getBoardSamplingRate = this.lib.func(CLike.get_board_sampling_rate);
         this.getPackageNumChannel = this.lib.func(CLike.get_package_num_channel);
         this.getTimestampChannel = this.lib.func(CLike.get_timestamp_channel);
         this.getMarkerChannel = this.lib.func(CLike.get_marker_channel);
@@ -309,6 +310,18 @@ export class BoardShim
         return dataSize[0];
     }
 
+    public getBoardSamplingRate(preset = BrainFlowPresets.DEFAULT_PRESET): number
+    {
+        const samplingRate = [0];
+        const res = BoardControllerDLL.getInstance().getBoardSamplingRate(
+            preset, samplingRate, this.boardId, this.inputJson);
+        if (res !== BrainFlowExitCodes.STATUS_OK)
+        {
+            throw new BrainFlowError (res, 'Could not get board sampling rate');
+        }
+        return samplingRate[0];
+    }
+
     public getBoardData(numSamples?: number, preset = BrainFlowPresets.DEFAULT_PRESET): number[][]
     {
         let dataSize = this.getBoardDataCount(preset);

nodejs_package/brainflow/functions.types.ts

@@ -51,6 +51,8 @@ export enum BoardControllerCLikeFunctions {
     get_num_rows = 'int get_num_rows (int board_id, int preset, _Inout_ int *num_rows)',
     get_sampling_rate =
         'int get_sampling_rate (int board_id, int preset, _Inout_ int *sampling_rate)',
+    get_board_sampling_rate =
+        'int get_board_sampling_rate (int preset, _Inout_ int *sampling_rate, int board_id, const char *json_brainflow_input_params)',
     get_battery_channel = 'int get_battery_channel (int board_id, int preset, _Inout_ int *value)',
     get_package_num_channel =
         'int get_package_num_channel (int board_id, int preset, _Inout_ int *value)',
@@ -182,6 +184,12 @@ export class BoardControllerFunctions
         boardId: BoardIds, preset: BrainFlowPresets, numRows: number[]) => BrainFlowExitCodes;
     getSamplingRate!: (
         boardId: BoardIds, preset: BrainFlowPresets, samplingRate: number[]) => BrainFlowExitCodes;
+    getBoardSamplingRate!: (
+        preset: BrainFlowPresets,
+        samplingRate: number[],
+        boardId: BoardIds,
+        inputJson: string,
+        ) => BrainFlowExitCodes;
     getEegChannels!: (
         boardId: BoardIds,
         preset: BrainFlowPresets,

python_package/brainflow/board_shim.py

@@ -348,6 +348,15 @@ def __init__(self):
             ndpointer(ctypes.c_int32)
         ]
 
+        self.get_board_sampling_rate = self.lib.get_board_sampling_rate
+        self.get_board_sampling_rate.restype = ctypes.c_int
+        self.get_board_sampling_rate.argtypes = [
+            ctypes.c_int,
+            ndpointer(ctypes.c_int32),
+            ctypes.c_int,
+            ctypes.c_char_p
+        ]
+
         self.get_battery_channel = self.lib.get_battery_channel
         self.get_battery_channel.restype = ctypes.c_int
         self.get_battery_channel.argtypes = [
@@ -1343,6 +1352,22 @@ def get_board_id(self) -> int:
 
         return self._master_board_id
 
+    def get_board_sampling_rate(self, preset: int = BrainFlowPresets.DEFAULT_PRESET) -> int:
+        """Get actual sampling rate for this prepared board session.
+
+        :param preset: preset
+        :type preset: int
+        :return: sampling rate
+        :rtype: int
+        """
+
+        sampling_rate = numpy.zeros(1).astype(numpy.int32)
+        res = BoardControllerDLL.get_instance().get_board_sampling_rate(
+            preset, sampling_rate, self.board_id, self.input_json)
+        if res != BrainFlowExitCodes.STATUS_OK.value:
+            raise BrainFlowError('unable to get sampling rate for this board session', res)
+        return sampling_rate[0]
+
     def insert_marker(self, value: float, preset: int = BrainFlowPresets.DEFAULT_PRESET) -> None:
         """Insert Marker to Data Stream