@techstark/opencv-js 4.12.0-release.1 → 5.0.0-release.1

package/README.md

@@ -1,8 +1,8 @@
 # opencv-js
 
-OpenCV JavaScript version (NPM package) for node.js or browser. Get started guide [OpenCV.js Tutorials](https://docs.opencv.org/4.12.0/#:~:text=OpenCV%2DPython%20Tutorials-,OpenCV.js%20Tutorials,-Tutorials%20for%20contrib).
+OpenCV JavaScript version (NPM package) for node.js or browser. Get started guide [OpenCV.js Tutorials](https://docs.opencv.org/5.0.0/#:~:text=OpenCV%2DPython%20Tutorials-,OpenCV.js%20Tutorials,-Tutorials%20for%20contrib).
 
-The file `opencv.js` was downloaded from https://docs.opencv.org/4.12.0/opencv.js
+The file `opencv.js` was downloaded from https://docs.opencv.org/5.0.0/opencv.js
 
 TypeScript is supported (thanks to `mirada`).
 
@@ -16,10 +16,14 @@ async function getOpenCv() {
   if (cvModule instanceof Promise) {
     cv = await cvModule;
   } else {
-    await new Promise((resolve) => {
-      cvModule.onRuntimeInitialized = () => resolve();
-    });
-    cv = cvModule;
+    if (cvModule.Mat) {
+      cv = cvModule;
+    } else {
+      await new Promise((resolve) => {
+        cvModule.onRuntimeInitialized = () => resolve();
+      });
+      cv = cvModule;
+    }
   }
   return { cv };
 }

package/dist/opencv.js.patch

@@ -1,14 +1,22 @@
-diff --git a/dist/opencv.js b/dist/opencv.js
-index af4111b..3ba8a69 100644
 --- a/dist/opencv.js
 +++ b/dist/opencv.js
-@@ -41,7 +41,7 @@ else if (typeof define === 'function' && define['amd'])
-   define([], () => cv);
- 
-   if (typeof Module === 'undefined')
+@@ UMD wrapper call @@
+-}(this, function () {
++}(globalThis, function () {
+
+ Fixes: In browser ESM (<script type="module">), top-level `this` is
+ undefined. The UMD else branch `root.cv = factory()` then throws:
+   TypeError: Cannot set properties of undefined (setting 'cv')
+ Using `globalThis` is always defined in modern environments.
+
+@@ UMD factory tail @@
+-  if (typeof Module === 'undefined')
 -    Module = {};
++  if (typeof Module === 'undefined')
 +    var Module = {};
-   return cv(Module);
- }));
-         
-
+
+ Fixes: When opencv.js is bundled by Webpack (which wraps everything in
+ "use strict"), the bare `Module = {}` assignment throws:
+   ReferenceError: Module is not defined
+ Declaring with `var` creates a local variable instead of an implicit
+ global assignment, which is safe in strict mode.

package/dist/src/types/opencv/BackgroundSubtractor.d.ts

@@ -0,0 +1,33 @@
+import type { Algorithm, double, InputArray, OutputArray } from "./_types";
+/**
+ * Base class for background/foreground segmentation algorithms.
+ *
+ * The class is only used to define the common interface for the whole family of background/foreground
+ * segmentation algorithms.
+ *
+ * Source:
+ * [opencv2/video.hpp](https://github.com/opencv/opencv/tree/master/modules/video/include/opencv2/video/background_segm.hpp).
+ */
+export declare class BackgroundSubtractor extends Algorithm {
+    constructor();
+    /**
+     * Computes a foreground mask.
+     *
+     * @param image Next video frame.
+     * @param fgmask The output foreground mask as an 8-bit binary image.
+     * @param learningRate The value between 0 and 1 that indicates how fast the background model is learnt.
+     * Negative parameter value makes the algorithm use some automatically chosen learning rate.
+     * 0 means that the background model is not updated at all, 1 means that the background model is
+     * completely reinitialized from the last frame.
+     */
+    apply(image: InputArray, fgmask: OutputArray, learningRate?: double): void;
+    /**
+     * Computes a background image.
+     *
+     * @param backgroundImage The output background image.
+     *
+     * @note Sometimes the background image can be very blurry, as it contain the average background
+     * statistics.
+     */
+    getBackgroundImage(backgroundImage: OutputArray): void;
+}

package/dist/src/types/opencv/BackgroundSubtractor.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=BackgroundSubtractor.js.map

package/dist/src/types/opencv/BackgroundSubtractor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackgroundSubtractor.js","sourceRoot":"","sources":["../../../../src/types/opencv/BackgroundSubtractor.ts"],"names":[],"mappings":""}

package/dist/src/types/opencv/BackgroundSubtractorMOG2.d.ts

@@ -0,0 +1,21 @@
+import type { BackgroundSubtractor, bool, double, int } from "./_types";
+/**
+ * Gaussian Mixture-based Background/Foreground Segmentation Algorithm.
+ *
+ * The class implements the Gaussian mixture model background subtraction described in [Zivkovic2004]
+ * and [Zivkovic2006].
+ *
+ * Source:
+ * [opencv2/video.hpp](https://github.com/opencv/opencv/tree/master/modules/video/include/opencv2/video/background_segm.hpp).
+ */
+export declare class BackgroundSubtractorMOG2 extends BackgroundSubtractor {
+    /**
+     * @param history Length of the history.
+     * @param varThreshold Threshold on the squared Mahalanobis distance between the pixel and the model
+     * to decide whether a pixel is well described by the background model. This parameter does not
+     * affect the background update.
+     * @param detectShadows If true, the algorithm will detect shadows and mark them. It decreases the
+     * speed a bit, so if you do not need this feature, set the parameter to false.
+     */
+    constructor(history?: int, varThreshold?: double, detectShadows?: bool);
+}

package/dist/src/types/opencv/BackgroundSubtractorMOG2.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=BackgroundSubtractorMOG2.js.map

package/dist/src/types/opencv/BackgroundSubtractorMOG2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackgroundSubtractorMOG2.js","sourceRoot":"","sources":["../../../../src/types/opencv/BackgroundSubtractorMOG2.ts"],"names":[],"mappings":""}

package/dist/src/types/opencv/Mat.d.ts

@@ -706,6 +706,11 @@ export declare class Mat extends EmscriptenEmbindInstance {
      * the array copy is a continuous array occupying [total()]*elemSize() bytes.
      */
     clone(): Mat;
+    /**
+     *   Creates a deep copy of the Mat with independent data buffer.
+     *   This method ensures the copied Mat has its own data that is independent of the original.
+     */
+    mat_clone(): Mat;
     /**
      *   The method makes a new header for the specified matrix column and returns it. This is an O(1)
      * operation, regardless of the matrix size. The underlying data of the new matrix is shared with the

package/dist/src/types/opencv/_types.d.ts

@@ -1,6 +1,8 @@
 export * from "./Affine3";
 export * from "./Algorithm";
 export * from "./AutoBuffer";
+export * from "./BackgroundSubtractor";
+export * from "./BackgroundSubtractorMOG2";
 export * from "./BFMatcher";
 export * from "./BOWTrainer";
 export * from "./calib3d";

package/dist/src/types/opencv/_types.js

@@ -17,6 +17,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Affine3"), exports);
 __exportStar(require("./Algorithm"), exports);
 __exportStar(require("./AutoBuffer"), exports);
+__exportStar(require("./BackgroundSubtractor"), exports);
+__exportStar(require("./BackgroundSubtractorMOG2"), exports);
 __exportStar(require("./BFMatcher"), exports);
 __exportStar(require("./BOWTrainer"), exports);
 __exportStar(require("./calib3d"), exports);

package/dist/src/types/opencv/_types.js.map

@@ -1 +1 @@
-{"version":3,"file":"_types.js","sourceRoot":"","sources":["../../../../src/types/opencv/_types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,8CAA4B;AAC5B,+CAA6B;AAC7B,8CAA4B;AAC5B,+CAA6B;AAC7B,4CAA0B;AAC1B,sDAAoC;AACpC,+CAA6B;AAC7B,iDAA+B;AAC/B,uDAAqC;AACrC,+CAA6B;AAC7B,sDAAoC;AACpC,wCAAsB;AACtB,kDAAgC;AAChC,8CAA4B;AAC5B,8CAA4B;AAC5B,oDAAkC;AAClC,4CAA0B;AAC1B,sDAAoC;AACpC,kDAAgC;AAChC,8DAA4C;AAC5C,qDAAmC;AACnC,iDAA+B;AAC/B,oDAAkC;AAClC,mDAAiC;AACjC,iDAA+B;AAC/B,iDAA+B;AAC/B,mDAAiC;AACjC,kDAAgC;AAChC,sDAAoC;AACpC,2CAAyB;AACzB,6CAA2B;AAC3B,wCAAsB;AACtB,4CAA0B;AAC1B,0CAAwB;AACxB,yCAAuB;AACvB,yCAAuB;AACvB,8CAA4B;AAC5B,wCAAsB;AACtB,wCAAsB;AACtB,kDAAgC;AAChC,gDAA8B;AAC9B,+CAA6B;AAC7B,8CAA4B;AAC5B,gDAA8B;AAC9B,2CAAyB;AACzB,4CAA0B;AAC1B,+CAA6B"}
+{"version":3,"file":"_types.js","sourceRoot":"","sources":["../../../../src/types/opencv/_types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,8CAA4B;AAC5B,+CAA6B;AAC7B,yDAAuC;AACvC,6DAA2C;AAC3C,8CAA4B;AAC5B,+CAA6B;AAC7B,4CAA0B;AAC1B,sDAAoC;AACpC,+CAA6B;AAC7B,iDAA+B;AAC/B,uDAAqC;AACrC,+CAA6B;AAC7B,sDAAoC;AACpC,wCAAsB;AACtB,kDAAgC;AAChC,8CAA4B;AAC5B,8CAA4B;AAC5B,oDAAkC;AAClC,4CAA0B;AAC1B,sDAAoC;AACpC,kDAAgC;AAChC,8DAA4C;AAC5C,qDAAmC;AACnC,iDAA+B;AAC/B,oDAAkC;AAClC,mDAAiC;AACjC,iDAA+B;AAC/B,iDAA+B;AAC/B,mDAAiC;AACjC,kDAAgC;AAChC,sDAAoC;AACpC,2CAAyB;AACzB,6CAA2B;AAC3B,wCAAsB;AACtB,4CAA0B;AAC1B,0CAAwB;AACxB,yCAAuB;AACvB,yCAAuB;AACvB,8CAA4B;AAC5B,wCAAsB;AACtB,wCAAsB;AACtB,kDAAgC;AAChC,gDAA8B;AAC9B,+CAA6B;AAC7B,8CAA4B;AAC5B,gDAA8B;AAC9B,2CAAyB;AACzB,4CAA0B;AAC1B,+CAA6B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@techstark/opencv-js",
-  "version": "4.12.0-release.1",
+  "version": "5.0.0-release.1",
   "description": "OpenCV JavaScript version for node.js or browser",
   "main": "dist/opencv.js",
   "types": "dist/src/index.d.ts",
@@ -12,15 +12,16 @@
     "build": "tsc",
     "prepack": "npm run build",
     "format": "prettier --write \"src/**/*.ts\"",
-    "test": "jest"
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest",
+    "test:compat": "node test/compat/run-all.mjs"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.14",
-    "jest": "^29.7.0",
-    "jimp": "^1.6.0",
-    "prettier": "^3.5.3",
-    "ts-jest": "^29.3.4",
-    "typescript": "^5.8.3"
+    "@types/jest": "^30.0.0",
+    "jest": "^30.0.0",
+    "jimp": "^1.6.1",
+    "prettier": "^3.8.4",
+    "ts-jest": "^29.4.11",
+    "typescript": "^6.0.3"
   },
   "repository": {
     "type": "git",

package/src/types/opencv/BackgroundSubtractor.ts

@@ -0,0 +1,36 @@
+import type { Algorithm, bool, double, InputArray, OutputArray } from "./_types";
+
+/**
+ * Base class for background/foreground segmentation algorithms.
+ *
+ * The class is only used to define the common interface for the whole family of background/foreground 
+ * segmentation algorithms.
+ *
+ * Source:
+ * [opencv2/video.hpp](https://github.com/opencv/opencv/tree/master/modules/video/include/opencv2/video/background_segm.hpp).
+ */
+export declare class BackgroundSubtractor extends Algorithm {
+  public constructor();
+
+  /**
+   * Computes a foreground mask.
+   *
+   * @param image Next video frame.
+   * @param fgmask The output foreground mask as an 8-bit binary image.
+   * @param learningRate The value between 0 and 1 that indicates how fast the background model is learnt. 
+   * Negative parameter value makes the algorithm use some automatically chosen learning rate.
+   * 0 means that the background model is not updated at all, 1 means that the background model is 
+   * completely reinitialized from the last frame.
+   */
+  public apply(image: InputArray, fgmask: OutputArray, learningRate?: double): void;
+
+  /**
+   * Computes a background image.
+   *
+   * @param backgroundImage The output background image.
+   *
+   * @note Sometimes the background image can be very blurry, as it contain the average background 
+   * statistics.
+   */
+  public getBackgroundImage(backgroundImage: OutputArray): void;
+}

package/src/types/opencv/BackgroundSubtractorMOG2.ts

@@ -0,0 +1,22 @@
+import type { BackgroundSubtractor, bool, double, int } from "./_types";
+
+/**
+ * Gaussian Mixture-based Background/Foreground Segmentation Algorithm.
+ *
+ * The class implements the Gaussian mixture model background subtraction described in [Zivkovic2004] 
+ * and [Zivkovic2006].
+ *
+ * Source:
+ * [opencv2/video.hpp](https://github.com/opencv/opencv/tree/master/modules/video/include/opencv2/video/background_segm.hpp).
+ */
+export declare class BackgroundSubtractorMOG2 extends BackgroundSubtractor {
+  /**
+   * @param history Length of the history.
+   * @param varThreshold Threshold on the squared Mahalanobis distance between the pixel and the model 
+   * to decide whether a pixel is well described by the background model. This parameter does not 
+   * affect the background update.
+   * @param detectShadows If true, the algorithm will detect shadows and mark them. It decreases the 
+   * speed a bit, so if you do not need this feature, set the parameter to false.
+   */
+  public constructor(history?: int, varThreshold?: double, detectShadows?: bool);
+}

package/src/types/opencv/Mat.ts

@@ -787,6 +787,12 @@ export declare class Mat extends EmscriptenEmbindInstance {
    */
   public clone(): Mat;
 
+  /**
+   *   Creates a deep copy of the Mat with independent data buffer.
+   *   This method ensures the copied Mat has its own data that is independent of the original.
+   */
+  public mat_clone(): Mat;
+
   /**
    *   The method makes a new header for the specified matrix column and returns it. This is an O(1)
    * operation, regardless of the matrix size. The underlying data of the new matrix is shared with the

package/src/types/opencv/_types.ts

@@ -1,6 +1,8 @@
 export * from "./Affine3";
 export * from "./Algorithm";
 export * from "./AutoBuffer";
+export * from "./BackgroundSubtractor";
+export * from "./BackgroundSubtractorMOG2";
 export * from "./BFMatcher";
 export * from "./BOWTrainer";
 export * from "./calib3d";