Merge pull request justadudewhohacks#445 from oyyd/threads

src: add threads related API

Author: justadudewhohacks

cc/core/core.cc

@@ -42,6 +42,9 @@ NAN_MODULE_INIT(Core::Init) {
   Nan::SetMethod(target, "cartToPolarAsync", CartToPolarAsync);
   Nan::SetMethod(target, "polarToCart", PolarToCart);
   Nan::SetMethod(target, "polarToCartAsync", PolarToCartAsync);
+  Nan::SetMethod(target, "getNumThreads", GetNumThreads);
+  Nan::SetMethod(target, "setNumThreads", SetNumThreads);
+  Nan::SetMethod(target, "getThreadNum", GetThreadNum);
 };
 
 NAN_METHOD(Core::GetBuildInformation) {
@@ -158,3 +161,25 @@ NAN_METHOD(Core::PolarToCartAsync) {
     info
   );
 }
+
+NAN_METHOD(Core::GetNumThreads) {
+  FF_METHOD_CONTEXT("Core::GetNumThreads");
+  FF_RETURN(IntConverter::wrap(cv::getNumThreads()));
+}
+
+NAN_METHOD(Core::SetNumThreads) {
+  FF_METHOD_CONTEXT("Core::SetNumThreads");
+
+  if(!FF_IS_INT(info[0])) {
+    return Nan::ThrowError("Core::SetNumThreads expected arg0 to an int");
+  }
+
+  int32_t num = FF_CAST_INT(info[0]);
+
+  cv::setNumThreads(num);
+}
+
+NAN_METHOD(Core::GetThreadNum) {
+  FF_METHOD_CONTEXT("Core::GetNumThreads");
+  FF_RETURN(IntConverter::wrap(cv::getThreadNum()));
+}

cc/core/core.h

@@ -22,6 +22,9 @@ class Core : public Nan::ObjectWrap {
 	static NAN_METHOD(CartToPolarAsync);
 	static NAN_METHOD(PolarToCart);
 	static NAN_METHOD(PolarToCartAsync);
+	static NAN_METHOD(GetNumThreads);
+	static NAN_METHOD(SetNumThreads);
+	static NAN_METHOD(GetThreadNum);
 };
 
 #endif

lib/typings/cv.d.ts

@@ -116,6 +116,9 @@ export function partition(data: Mat[], predicate: (mat1: Mat, mat2: Mat) => bool
 export function plot1DHist(hist: Mat, plotImg: Mat, color: Vec3, lineType?: number, thickness?: number, shift?: number): Mat;
 export function polarToCart(magnitude: Mat, angle: Mat, angleInDegrees?: boolean): { x: Mat, y: Mat };
 export function polarToCartAsync(magnitude: Mat, angle: Mat, angleInDegrees?: boolean): Promise<{ x: Mat, y: Mat }>;
+export function getNumThreads(): number;
+export function setNumThreads(nthreads: number): void;
+export function getThreadNum(): number;
 export function projectPoints(objectPoints: Point3[], imagePoints: Point2[], rvec: Vec3, tvec: Vec3, cameraMatrix: Mat, distCoeffs: number[], aspectRatio?: number): { imagePoints: Point2[], jacobian: Mat };
 export function projectPointsAsync(objectPoints: Point3[], imagePoints: Point2[], rvec: Vec3, tvec: Vec3, cameraMatrix: Mat, distCoeffs: number[], aspectRatio?: number): Promise<{ imagePoints: Point2[], jacobian: Mat }>;
 export function readNetFromCaffe(prototxt: string, modelPath?: string): Net;

test/tests/core/core.test.js

@@ -170,6 +170,50 @@ describe('core', () => {
     });
   });
 
+  describe('getNumThreads', () => {
+    it('should return the number of threads that used by OpenCV', () => {
+      expect(cv.getNumThreads()).to.be.an('number');
+    });
+  });
+
+  describe('setNumThreads', () => {
+    it('should try to set the number of threads'
+        + ' that used by OpenCV', () => {
+      const number = 2;
+      cv.setNumThreads(number);
+      // OpenCV will **try** to set the number of threads for the
+      // next parallel region so that `cv.getNumThreads()` don't react
+      // to this immediately.
+      // expect(cv.getNumThreads()).to.be.equal(number);
+    });
+
+    it('should throw when the argument is not integer', () => {
+      let err;
+
+      const expectError = (fn, msg) => {
+        try {
+          fn();
+        } catch (e) {
+          err = e;
+        }
+
+        expect(err.message).to.be
+          .equal(msg);
+      };
+
+      expectError(() => cv.setNumThreads('hello'),
+        'Core::SetNumThreads expected arg0 to an int');
+      expectError(() => cv.setNumThreads(1.1),
+        'Core::SetNumThreads expected arg0 to an int');
+    });
+  });
+
+  describe('GetThreadNum', () => {
+    it('should returns the index of the currently executed thread', () => {
+      expect(cv.getThreadNum()).to.be.an('number');
+    });
+  });
+
   if (asyncHooks) {
     describe('async_hooks', () => {
       it('should trigger `init` callback in async_hooks', () => {