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

package/README.md

@@ -1,36 +1,41 @@
 # opencv-js
 
-OpenCV JavaScript version (NPM package) for node.js or browser. Get started guide [OpenCV.js Tutorials](https://docs.opencv.org/4.11.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.11.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`).
 
 # Basic Usage
 
-## >=4.11
-
 ```js
-import cvReadyPromise from "@techstark/opencv-js";
+import cvModule from "@techstark/opencv-js";
+
+async function getOpenCv() {
+  let cv;
+  if (cvModule instanceof Promise) {
+    cv = await cvModule;
+  } else {
+    if (cvModule.Mat) {
+      cv = cvModule;
+    } else {
+      await new Promise((resolve) => {
+        cvModule.onRuntimeInitialized = () => resolve();
+      });
+      cv = cvModule;
+    }
+  }
+  return { cv };
+}
 
 async function main() {
-  const cv = await cvReadyPromise;
+  const { cv } = await getOpenCv();
   console.log("OpenCV.js is ready!");
   // You can now use OpenCV functions here
   console.log(cv.getBuildInformation());
 }
-```
-
-## <=4.10
 
-```js
-import cv from "@techstark/opencv-js";
-
-cv.onRuntimeInitialized = () => {
-  console.log("OpenCV.js is ready!");
-  // You can now use OpenCV functions here
-  console.log(cv.getBuildInformation());
-};
+main();
 ```
 
 # Code Examples

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/Feature2D.d.ts

@@ -1,6 +1,6 @@
 import type { Algorithm, KeyPointVector, Mat, OutputArray } from "./_types";
 /**
- * https://docs.opencv.org/4.11.0/d0/d13/classcv_1_1Feature2D.html
+ * https://docs.opencv.org/master/d0/d13/classcv_1_1Feature2D.html
  */
 export declare class Feature2D extends Algorithm {
     /**

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
@@ -1438,7 +1443,7 @@ export declare class Mat extends EmscriptenEmbindInstance {
      */
     type(): int;
     updateContinuityFlag(): void;
-    ucharPtr(i: any, j: any): any;
+    ucharPtr(i: any, j?: any): any;
     charPtr(i: any, j: any): any;
     shortPtr(i: any, j: any): any;
     ushortPtr(i: any, j: any): any;

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

@@ -1,6 +1,6 @@
 import type { Feature2D, float, int } from "./_types";
 /**
- * https://docs.opencv.org/4.11.0/db/d95/classcv_1_1ORB.html
+ * https://docs.opencv.org/master/db/d95/classcv_1_1ORB.html
  */
 export declare class ORB extends Feature2D {
     constructor(nfeatures?: int, scaleFactor?: float, nlevels?: int, edgeThreshold?: int, firstLevel?: int, WTA_K?: int, scoreType?: ORBScoreType, patchSize?: int, fastThreshold?: int);

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

@@ -0,0 +1,76 @@
+import type { bool, InputArray, OutputArray, OutputArrayOfArrays } from "./_types";
+/**
+ * QR Code detection and decoding class.
+ *
+ * This class implements QR code detection and decoding functionality.
+ * It can detect QR codes in an image and decode their content.
+ *
+ * Source:
+ * [opencv2/objdetect.hpp](https://github.com/opencv/opencv/tree/master/modules/objdetect/include/opencv2/objdetect.hpp).
+ */
+export declare class QRCodeDetector {
+    /**
+     * QRCodeDetector constructor
+     */
+    constructor();
+    /**
+     * Detects QR code in image and returns the quadrangle containing the code.
+     *
+     * @param img grayscale or color (BGR) image containing (or not) QR code.
+     * @param points Output vector of vertices of the minimum-area quadrangle containing the code.
+     */
+    detect(img: InputArray, points: OutputArray): bool;
+    /**
+     * Decodes QR code in image once it's found by the detect() method.
+     *
+     * @param img grayscale or color (BGR) image containing QR code.
+     * @param points Quadrangle vertices found by detect() method (or some other algorithm).
+     * @param straight_qrcode The optional output image containing rectified and binarized QR code
+     */
+    decode(img: InputArray, points: InputArray, straight_qrcode?: OutputArray): String;
+    /**
+     * Both detects and decodes QR code
+     *
+     * @param img grayscale or color (BGR) image containing QR code.
+     * @param points optional output array of vertices of the found QR code quadrangle. Will be empty if not found.
+     * @param straight_qrcode The optional output image containing rectified and binarized QR code
+     */
+    detectAndDecode(img: InputArray, points?: OutputArray, straight_qrcode?: OutputArray): String;
+    /**
+     * Detects QR codes in image and returns the vector of the quadrangles containing the codes.
+     *
+     * @param img grayscale or color (BGR) image containing (or not) QR codes.
+     * @param points Output vector of vector of vertices of the minimum-area quadrangle containing the codes.
+     */
+    detectMulti(img: InputArray, points: OutputArrayOfArrays): bool;
+    /**
+     * Decodes QR codes in image once it's found by the detectMulti() method.
+     *
+     * @param img grayscale or color (BGR) image containing QR codes.
+     * @param points vector of Quadrangle vertices found by detectMulti() method (or some other algorithm).
+     * @param decoded_info UTF8-encoded output vector of String or empty vector of String if the codes cannot be decoded.
+     * @param straight_qrcode The optional output vector of images containing rectified and binarized QR codes
+     */
+    decodeMulti(img: InputArray, points: InputArray, decoded_info: any, straight_qrcode?: OutputArrayOfArrays): bool;
+    /**
+     * Both detects and decodes QR codes
+     *
+     * @param img grayscale or color (BGR) image containing QR codes.
+     * @param decoded_info UTF8-encoded output vector of String or empty vector of String if the codes cannot be decoded.
+     * @param points optional output vector of vertices of the found QR code quadrangles. Will be empty if not found.
+     * @param straight_qrcode The optional output vector of images containing rectified and binarized QR codes
+     */
+    detectAndDecodeMulti(img: InputArray, decoded_info: any, points?: OutputArrayOfArrays, straight_qrcode?: OutputArrayOfArrays): bool;
+    /**
+     * Aruco-based QR code detector
+     */
+    setUseAruco(use_aruco: bool): void;
+    /**
+     * Get if Aruco-based QR code detector is used
+     */
+    getUseAruco(): bool;
+    /**
+     * Releases the object
+     */
+    delete(): void;
+}

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

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

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

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

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

@@ -0,0 +1,101 @@
+import type { bool, float, InputArray, OutputArray, OutputArrayOfArrays } from "./_types";
+/**
+ * Parameters for QRCodeDetectorAruco
+ */
+export declare class QRCodeDetectorAruco_Params {
+    minModuleSizeInPyramid: float;
+    maxRotation: float;
+    maxModuleSizeMismatch: float;
+    maxTimingPatternMismatch: float;
+    maxPenalties: float;
+    maxColorsMismatch: float;
+    scaleTimingPatternScore: float;
+    constructor();
+    /**
+     * Releases the object
+     */
+    delete(): void;
+}
+/**
+ * QR Code detection and decoding class using Aruco-based detection.
+ *
+ * This class implements QR code detection and decoding functionality using
+ * Aruco marker detection techniques for improved robustness.
+ *
+ * Source:
+ * [opencv2/objdetect.hpp](https://github.com/opencv/opencv/tree/master/modules/objdetect/include/opencv2/objdetect.hpp).
+ */
+export declare class QRCodeDetectorAruco {
+    /**
+     * QRCodeDetectorAruco constructor
+     */
+    constructor();
+    /**
+     * QRCodeDetectorAruco constructor with parameters
+     *
+     * @param params QRCodeDetectorAruco parameters
+     */
+    constructor(params: QRCodeDetectorAruco_Params);
+    /**
+     * Detects QR code in image and returns the quadrangle containing the code.
+     *
+     * @param img grayscale or color (BGR) image containing (or not) QR code.
+     * @param points Output vector of vertices of the minimum-area quadrangle containing the code.
+     */
+    detect(img: InputArray, points: OutputArray): bool;
+    /**
+     * Decodes QR code in image once it's found by the detect() method.
+     *
+     * @param img grayscale or color (BGR) image containing QR code.
+     * @param points Quadrangle vertices found by detect() method (or some other algorithm).
+     * @param straight_qrcode The optional output image containing rectified and binarized QR code
+     */
+    decode(img: InputArray, points: InputArray, straight_qrcode?: OutputArray): String;
+    /**
+     * Both detects and decodes QR code
+     *
+     * @param img grayscale or color (BGR) image containing QR code.
+     * @param points optional output array of vertices of the found QR code quadrangle. Will be empty if not found.
+     * @param straight_qrcode The optional output image containing rectified and binarized QR code
+     */
+    detectAndDecode(img: InputArray, points?: OutputArray, straight_qrcode?: OutputArray): String;
+    /**
+     * Detects QR codes in image and returns the vector of the quadrangles containing the codes.
+     *
+     * @param img grayscale or color (BGR) image containing (or not) QR codes.
+     * @param points Output vector of vector of vertices of the minimum-area quadrangle containing the codes.
+     */
+    detectMulti(img: InputArray, points: OutputArrayOfArrays): bool;
+    /**
+     * Decodes QR codes in image once it's found by the detectMulti() method.
+     *
+     * @param img grayscale or color (BGR) image containing QR codes.
+     * @param points vector of Quadrangle vertices found by detectMulti() method (or some other algorithm).
+     * @param decoded_info UTF8-encoded output vector of String or empty vector of String if the codes cannot be decoded.
+     * @param straight_qrcode The optional output vector of images containing rectified and binarized QR codes
+     */
+    decodeMulti(img: InputArray, points: InputArray, decoded_info: any, straight_qrcode?: OutputArrayOfArrays): bool;
+    /**
+     * Both detects and decodes QR codes
+     *
+     * @param img grayscale or color (BGR) image containing QR codes.
+     * @param decoded_info UTF8-encoded output vector of String or empty vector of String if the codes cannot be decoded.
+     * @param points optional output vector of vertices of the found QR code quadrangles. Will be empty if not found.
+     * @param straight_qrcode The optional output vector of images containing rectified and binarized QR codes
+     */
+    detectAndDecodeMulti(img: InputArray, decoded_info: any, points?: OutputArrayOfArrays, straight_qrcode?: OutputArrayOfArrays): bool;
+    /**
+     * Get detector parameters
+     */
+    getDetectorParameters(): QRCodeDetectorAruco_Params;
+    /**
+     * Set detector parameters
+     *
+     * @param params QRCodeDetectorAruco parameters
+     */
+    setDetectorParameters(params: QRCodeDetectorAruco_Params): void;
+    /**
+     * Releases the object
+     */
+    delete(): void;
+}

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

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

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

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

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";
@@ -19,6 +21,7 @@ export * from "./fisheye";
 export * from "./FlannBasedMatcher";
 export * from "./HOGDescriptor";
 export * from "./imgproc_color_conversions";
+export * from "./imgproc_colormap";
 export * from "./imgproc_draw";
 export * from "./imgproc_feature";
 export * from "./imgproc_filter";

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);
@@ -35,6 +37,7 @@ __exportStar(require("./fisheye"), exports);
 __exportStar(require("./FlannBasedMatcher"), exports);
 __exportStar(require("./HOGDescriptor"), exports);
 __exportStar(require("./imgproc_color_conversions"), exports);
+__exportStar(require("./imgproc_colormap"), exports);
 __exportStar(require("./imgproc_draw"), exports);
 __exportStar(require("./imgproc_feature"), exports);
 __exportStar(require("./imgproc_filter"), 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,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/dist/src/types/opencv/imgproc_colormap.d.ts

@@ -0,0 +1,43 @@
+import type { InputArray, int, OutputArray } from "./_types";
+/**
+ * Applies a colormap on a given image.
+ *
+ * @param src The source image, which should be grayscale. Should be 8-bit, 16-bit, or floating-point.
+ * @param dst The result is the colored image.
+ * @param colormap The colormap to apply.
+ */
+export declare function applyColorMap(src: InputArray, dst: OutputArray, colormap: int): void;
+/**
+ * Applies a user colormap on a given image.
+ *
+ * @param src The source image, which should be grayscale. Should be 8-bit, 16-bit, or floating-point.
+ * @param dst The result is the colored image.
+ * @param userColor The colormap to apply of type CV_8UC1 or CV_8UC3 and size 256.
+ */
+export declare function applyColorMap(src: InputArray, dst: OutputArray, userColor: InputArray): void;
+/**
+ * Colormap types used by the applyColorMap function.
+ */
+export type ColormapTypes = any;
+export declare const COLORMAP_AUTUMN: ColormapTypes;
+export declare const COLORMAP_BONE: ColormapTypes;
+export declare const COLORMAP_JET: ColormapTypes;
+export declare const COLORMAP_WINTER: ColormapTypes;
+export declare const COLORMAP_RAINBOW: ColormapTypes;
+export declare const COLORMAP_OCEAN: ColormapTypes;
+export declare const COLORMAP_SUMMER: ColormapTypes;
+export declare const COLORMAP_SPRING: ColormapTypes;
+export declare const COLORMAP_COOL: ColormapTypes;
+export declare const COLORMAP_HSV: ColormapTypes;
+export declare const COLORMAP_PINK: ColormapTypes;
+export declare const COLORMAP_HOT: ColormapTypes;
+export declare const COLORMAP_PARULA: ColormapTypes;
+export declare const COLORMAP_MAGMA: ColormapTypes;
+export declare const COLORMAP_INFERNO: ColormapTypes;
+export declare const COLORMAP_PLASMA: ColormapTypes;
+export declare const COLORMAP_VIRIDIS: ColormapTypes;
+export declare const COLORMAP_CIVIDIS: ColormapTypes;
+export declare const COLORMAP_TWILIGHT: ColormapTypes;
+export declare const COLORMAP_TWILIGHT_SHIFTED: ColormapTypes;
+export declare const COLORMAP_TURBO: ColormapTypes;
+export declare const COLORMAP_DEEPGREEN: ColormapTypes;

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

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

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

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

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

@@ -38,9 +38,9 @@ export declare function boundingRect(array: InputArray): Rect;
  *
  * @param box The input rotated rectangle. It may be the output of
  *
- * @param points The output array of four vertices of rectangles.
+ * @returns An array of four vertices of the rectangle (Point2f[])
  */
-export declare function boxPoints(box: RotatedRect, points: OutputArray): void;
+export declare function boxPoints(box: RotatedRect): Point2f[];
 /**
  * image with 4 or 8 way connectivity - returns N, the total number of labels [0, N-1] where 0
  * represents the background label. ltype specifies the output label image type, an important

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

@@ -41,3 +41,5 @@ export declare const CASCADE_DO_CANNY_PRUNING: any;
 export declare const CASCADE_SCALE_IMAGE: any;
 export declare const CASCADE_FIND_BIGGEST_OBJECT: any;
 export declare const CASCADE_DO_ROUGH_SEARCH: any;
+export { QRCodeDetector } from "./QRCodeDetector";
+export { QRCodeDetectorAruco, QRCodeDetectorAruco_Params, } from "./QRCodeDetectorAruco";

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

@@ -1,3 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.QRCodeDetectorAruco_Params = exports.QRCodeDetectorAruco = exports.QRCodeDetector = void 0;
+var QRCodeDetector_1 = require("./QRCodeDetector");
+Object.defineProperty(exports, "QRCodeDetector", { enumerable: true, get: function () { return QRCodeDetector_1.QRCodeDetector; } });
+var QRCodeDetectorAruco_1 = require("./QRCodeDetectorAruco");
+Object.defineProperty(exports, "QRCodeDetectorAruco", { enumerable: true, get: function () { return QRCodeDetectorAruco_1.QRCodeDetectorAruco; } });
+Object.defineProperty(exports, "QRCodeDetectorAruco_Params", { enumerable: true, get: function () { return QRCodeDetectorAruco_1.QRCodeDetectorAruco_Params; } });
 //# sourceMappingURL=objdetect.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"objdetect.js","sourceRoot":"","sources":["../../../../src/types/opencv/objdetect.ts"],"names":[],"mappings":""}
+{"version":3,"file":"objdetect.js","sourceRoot":"","sources":["../../../../src/types/opencv/objdetect.ts"],"names":[],"mappings":";;;AAwGA,mDAAkD;AAAzC,gHAAA,cAAc,OAAA;AACvB,6DAG+B;AAF7B,0HAAA,mBAAmB,OAAA;AACnB,iIAAA,0BAA0B,OAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@techstark/opencv-js",
-  "version": "4.11.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/Feature2D.ts

@@ -1,7 +1,7 @@
 import type { Algorithm, KeyPointVector, Mat, OutputArray } from "./_types";
 
 /**
- * https://docs.opencv.org/4.11.0/d0/d13/classcv_1_1Feature2D.html
+ * https://docs.opencv.org/master/d0/d13/classcv_1_1Feature2D.html
  */
 export declare class Feature2D extends Algorithm {
   /**

package/src/types/opencv/FlannBasedMatcher.ts

@@ -1,4 +1,11 @@
-import type { bool, DescriptorMatcher, FileNode, FileStorage, InputArrayOfArrays, Ptr } from "./_types";
+import type {
+  bool,
+  DescriptorMatcher,
+  FileNode,
+  FileStorage,
+  InputArrayOfArrays,
+  Ptr,
+} from "./_types";
 
 /**
  * This matcher trains [cv::flann::Index](#d1/db2/classcv_1_1flann_1_1Index}) on a train descriptor

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
@@ -1595,7 +1601,7 @@ export declare class Mat extends EmscriptenEmbindInstance {
 
   public updateContinuityFlag(): void;
 
-  public ucharPtr(i: any, j: any): any;
+  public ucharPtr(i: any, j?: any): any;
   public charPtr(i: any, j: any): any;
   public shortPtr(i: any, j: any): any;
   public ushortPtr(i: any, j: any): any;

package/src/types/opencv/ORB.ts

@@ -1,7 +1,7 @@
 import type { Feature2D, float, int } from "./_types";
 
 /**
- * https://docs.opencv.org/4.11.0/db/d95/classcv_1_1ORB.html
+ * https://docs.opencv.org/master/db/d95/classcv_1_1ORB.html
  */
 export declare class ORB extends Feature2D {
   public constructor(

package/src/types/opencv/QRCodeDetector.ts

@@ -0,0 +1,111 @@
+import type {
+  bool,
+  InputArray,
+  InputOutputArray,
+  OutputArray,
+  OutputArrayOfArrays,
+  Point2f,
+} from "./_types";
+
+/**
+ * QR Code detection and decoding class.
+ *
+ * This class implements QR code detection and decoding functionality.
+ * It can detect QR codes in an image and decode their content.
+ *
+ * Source:
+ * [opencv2/objdetect.hpp](https://github.com/opencv/opencv/tree/master/modules/objdetect/include/opencv2/objdetect.hpp).
+ */
+export declare class QRCodeDetector {
+  /**
+   * QRCodeDetector constructor
+   */
+  public constructor();
+
+  /**
+   * Detects QR code in image and returns the quadrangle containing the code.
+   *
+   * @param img grayscale or color (BGR) image containing (or not) QR code.
+   * @param points Output vector of vertices of the minimum-area quadrangle containing the code.
+   */
+  public detect(img: InputArray, points: OutputArray): bool;
+
+  /**
+   * Decodes QR code in image once it's found by the detect() method.
+   *
+   * @param img grayscale or color (BGR) image containing QR code.
+   * @param points Quadrangle vertices found by detect() method (or some other algorithm).
+   * @param straight_qrcode The optional output image containing rectified and binarized QR code
+   */
+  public decode(
+    img: InputArray,
+    points: InputArray,
+    straight_qrcode?: OutputArray,
+  ): String;
+
+  /**
+   * Both detects and decodes QR code
+   *
+   * @param img grayscale or color (BGR) image containing QR code.
+   * @param points optional output array of vertices of the found QR code quadrangle. Will be empty if not found.
+   * @param straight_qrcode The optional output image containing rectified and binarized QR code
+   */
+  public detectAndDecode(
+    img: InputArray,
+    points?: OutputArray,
+    straight_qrcode?: OutputArray,
+  ): String;
+
+  /**
+   * Detects QR codes in image and returns the vector of the quadrangles containing the codes.
+   *
+   * @param img grayscale or color (BGR) image containing (or not) QR codes.
+   * @param points Output vector of vector of vertices of the minimum-area quadrangle containing the codes.
+   */
+  public detectMulti(img: InputArray, points: OutputArrayOfArrays): bool;
+
+  /**
+   * Decodes QR codes in image once it's found by the detectMulti() method.
+   *
+   * @param img grayscale or color (BGR) image containing QR codes.
+   * @param points vector of Quadrangle vertices found by detectMulti() method (or some other algorithm).
+   * @param decoded_info UTF8-encoded output vector of String or empty vector of String if the codes cannot be decoded.
+   * @param straight_qrcode The optional output vector of images containing rectified and binarized QR codes
+   */
+  public decodeMulti(
+    img: InputArray,
+    points: InputArray,
+    decoded_info: any,
+    straight_qrcode?: OutputArrayOfArrays,
+  ): bool;
+
+  /**
+   * Both detects and decodes QR codes
+   *
+   * @param img grayscale or color (BGR) image containing QR codes.
+   * @param decoded_info UTF8-encoded output vector of String or empty vector of String if the codes cannot be decoded.
+   * @param points optional output vector of vertices of the found QR code quadrangles. Will be empty if not found.
+   * @param straight_qrcode The optional output vector of images containing rectified and binarized QR codes
+   */
+  public detectAndDecodeMulti(
+    img: InputArray,
+    decoded_info: any,
+    points?: OutputArrayOfArrays,
+    straight_qrcode?: OutputArrayOfArrays,
+  ): bool;
+
+  /**
+   * Aruco-based QR code detector
+   */
+  public setUseAruco(use_aruco: bool): void;
+
+  /**
+   * Get if Aruco-based QR code detector is used
+   */
+  public getUseAruco(): bool;
+
+  /**
+   * Releases the object
+   */
+  public delete(): void;
+}

package/src/types/opencv/QRCodeDetectorAruco.ts

@@ -0,0 +1,139 @@
+import type {
+  bool,
+  float,
+  InputArray,
+  OutputArray,
+  OutputArrayOfArrays,
+} from "./_types";
+
+/**
+ * Parameters for QRCodeDetectorAruco
+ */
+export declare class QRCodeDetectorAruco_Params {
+  public minModuleSizeInPyramid: float;
+  public maxRotation: float;
+  public maxModuleSizeMismatch: float;
+  public maxTimingPatternMismatch: float;
+  public maxPenalties: float;
+  public maxColorsMismatch: float;
+  public scaleTimingPatternScore: float;
+
+  public constructor();
+
+  /**
+   * Releases the object
+   */
+  public delete(): void;
+}
+
+/**
+ * QR Code detection and decoding class using Aruco-based detection.
+ *
+ * This class implements QR code detection and decoding functionality using
+ * Aruco marker detection techniques for improved robustness.
+ *
+ * Source:
+ * [opencv2/objdetect.hpp](https://github.com/opencv/opencv/tree/master/modules/objdetect/include/opencv2/objdetect.hpp).
+ */
+export declare class QRCodeDetectorAruco {
+  /**
+   * QRCodeDetectorAruco constructor
+   */
+  public constructor();
+
+  /**
+   * QRCodeDetectorAruco constructor with parameters
+   *
+   * @param params QRCodeDetectorAruco parameters
+   */
+  public constructor(params: QRCodeDetectorAruco_Params);
+
+  /**
+   * Detects QR code in image and returns the quadrangle containing the code.
+   *
+   * @param img grayscale or color (BGR) image containing (or not) QR code.
+   * @param points Output vector of vertices of the minimum-area quadrangle containing the code.
+   */
+  public detect(img: InputArray, points: OutputArray): bool;
+
+  /**
+   * Decodes QR code in image once it's found by the detect() method.
+   *
+   * @param img grayscale or color (BGR) image containing QR code.
+   * @param points Quadrangle vertices found by detect() method (or some other algorithm).
+   * @param straight_qrcode The optional output image containing rectified and binarized QR code
+   */
+  public decode(
+    img: InputArray,
+    points: InputArray,
+    straight_qrcode?: OutputArray,
+  ): String;
+
+  /**
+   * Both detects and decodes QR code
+   *
+   * @param img grayscale or color (BGR) image containing QR code.
+   * @param points optional output array of vertices of the found QR code quadrangle. Will be empty if not found.
+   * @param straight_qrcode The optional output image containing rectified and binarized QR code
+   */
+  public detectAndDecode(
+    img: InputArray,
+    points?: OutputArray,
+    straight_qrcode?: OutputArray,
+  ): String;
+
+  /**
+   * Detects QR codes in image and returns the vector of the quadrangles containing the codes.
+   *
+   * @param img grayscale or color (BGR) image containing (or not) QR codes.
+   * @param points Output vector of vector of vertices of the minimum-area quadrangle containing the codes.
+   */
+  public detectMulti(img: InputArray, points: OutputArrayOfArrays): bool;
+
+  /**
+   * Decodes QR codes in image once it's found by the detectMulti() method.
+   *
+   * @param img grayscale or color (BGR) image containing QR codes.
+   * @param points vector of Quadrangle vertices found by detectMulti() method (or some other algorithm).
+   * @param decoded_info UTF8-encoded output vector of String or empty vector of String if the codes cannot be decoded.
+   * @param straight_qrcode The optional output vector of images containing rectified and binarized QR codes
+   */
+  public decodeMulti(
+    img: InputArray,
+    points: InputArray,
+    decoded_info: any,
+    straight_qrcode?: OutputArrayOfArrays,
+  ): bool;
+
+  /**
+   * Both detects and decodes QR codes
+   *
+   * @param img grayscale or color (BGR) image containing QR codes.
+   * @param decoded_info UTF8-encoded output vector of String or empty vector of String if the codes cannot be decoded.
+   * @param points optional output vector of vertices of the found QR code quadrangles. Will be empty if not found.
+   * @param straight_qrcode The optional output vector of images containing rectified and binarized QR codes
+   */
+  public detectAndDecodeMulti(
+    img: InputArray,
+    decoded_info: any,
+    points?: OutputArrayOfArrays,
+    straight_qrcode?: OutputArrayOfArrays,
+  ): bool;
+
+  /**
+   * Get detector parameters
+   */
+  public getDetectorParameters(): QRCodeDetectorAruco_Params;
+
+  /**
+   * Set detector parameters
+   *
+   * @param params QRCodeDetectorAruco parameters
+   */
+  public setDetectorParameters(params: QRCodeDetectorAruco_Params): void;
+
+  /**
+   * Releases the object
+   */
+  public delete(): void;
+}

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";
@@ -19,6 +21,7 @@ export * from "./fisheye";
 export * from "./FlannBasedMatcher";
 export * from "./HOGDescriptor";
 export * from "./imgproc_color_conversions";
+export * from "./imgproc_colormap";
 export * from "./imgproc_draw";
 export * from "./imgproc_feature";
 export * from "./imgproc_filter";

package/src/types/opencv/imgproc_colormap.ts

@@ -0,0 +1,60 @@
+import type { InputArray, int, OutputArray } from "./_types";
+
+/*
+ * # Colormap Transformations
+ *
+ */
+
+/**
+ * Applies a colormap on a given image.
+ *
+ * @param src The source image, which should be grayscale. Should be 8-bit, 16-bit, or floating-point.
+ * @param dst The result is the colored image.
+ * @param colormap The colormap to apply.
+ */
+export declare function applyColorMap(
+  src: InputArray,
+  dst: OutputArray,
+  colormap: int,
+): void;
+
+/**
+ * Applies a user colormap on a given image.
+ *
+ * @param src The source image, which should be grayscale. Should be 8-bit, 16-bit, or floating-point.
+ * @param dst The result is the colored image.
+ * @param userColor The colormap to apply of type CV_8UC1 or CV_8UC3 and size 256.
+ */
+export declare function applyColorMap(
+  src: InputArray,
+  dst: OutputArray,
+  userColor: InputArray,
+): void;
+
+/**
+ * Colormap types used by the applyColorMap function.
+ */
+export type ColormapTypes = any;
+
+export declare const COLORMAP_AUTUMN: ColormapTypes; // initializer: = 0
+export declare const COLORMAP_BONE: ColormapTypes; // initializer: = 1
+export declare const COLORMAP_JET: ColormapTypes; // initializer: = 2
+export declare const COLORMAP_WINTER: ColormapTypes; // initializer: = 3
+export declare const COLORMAP_RAINBOW: ColormapTypes; // initializer: = 4
+export declare const COLORMAP_OCEAN: ColormapTypes; // initializer: = 5
+export declare const COLORMAP_SUMMER: ColormapTypes; // initializer: = 6
+export declare const COLORMAP_SPRING: ColormapTypes; // initializer: = 7
+export declare const COLORMAP_COOL: ColormapTypes; // initializer: = 8
+export declare const COLORMAP_HSV: ColormapTypes; // initializer: = 9
+export declare const COLORMAP_PINK: ColormapTypes; // initializer: = 10
+export declare const COLORMAP_HOT: ColormapTypes; // initializer: = 11
+export declare const COLORMAP_PARULA: ColormapTypes; // initializer: = 12
+export declare const COLORMAP_MAGMA: ColormapTypes; // initializer: = 13
+export declare const COLORMAP_INFERNO: ColormapTypes; // initializer: = 14
+export declare const COLORMAP_PLASMA: ColormapTypes; // initializer: = 15
+export declare const COLORMAP_VIRIDIS: ColormapTypes; // initializer: = 16
+export declare const COLORMAP_CIVIDIS: ColormapTypes; // initializer: = 17
+export declare const COLORMAP_TWILIGHT: ColormapTypes; // initializer: = 18
+export declare const COLORMAP_TWILIGHT_SHIFTED: ColormapTypes; // initializer: = 19
+export declare const COLORMAP_TURBO: ColormapTypes; // initializer: = 20
+export declare const COLORMAP_DEEPGREEN: ColormapTypes; // initializer: = 21

package/src/types/opencv/imgproc_shape.ts

@@ -65,9 +65,9 @@ export declare function boundingRect(array: InputArray): Rect;
  *
  * @param box The input rotated rectangle. It may be the output of
  *
- * @param points The output array of four vertices of rectangles.
+ * @returns An array of four vertices of the rectangle (Point2f[])
  */
-export declare function boxPoints(box: RotatedRect, points: OutputArray): void;
+export declare function boxPoints(box: RotatedRect): Point2f[];
 
 /**
  * image with 4 or 8 way connectivity - returns N, the total number of labels [0, N-1] where 0
@@ -533,9 +533,7 @@ export declare function minAreaRect(points: InputArray): RotatedRect;
  *
  * @param points Input vector of 2D points, stored in std::vector<> or Mat
  */
-export declare function minEnclosingCircle(
-  points: InputArray,
-): Circle;
+export declare function minEnclosingCircle(points: InputArray): Circle;
 
 /**
  * The function finds a triangle of minimum area enclosing the given set of 2D points and returns its

package/src/types/opencv/objdetect.ts

@@ -101,3 +101,9 @@ export declare const CASCADE_SCALE_IMAGE: any; // initializer: = 2
 export declare const CASCADE_FIND_BIGGEST_OBJECT: any; // initializer: = 4
 
 export declare const CASCADE_DO_ROUGH_SEARCH: any; // initializer: = 8
+
+export { QRCodeDetector } from "./QRCodeDetector";
+export {
+  QRCodeDetectorAruco,
+  QRCodeDetectorAruco_Params,
+} from "./QRCodeDetectorAruco";