node-native-win-utils 1.1.1 → 1.3.1

package/README.md

@@ -4,19 +4,21 @@
 
 I did it for myself because I didn't feel like dealing with libraries like 'node-ffi' to implement this functionality. Maybe someone will find it useful. It's WINDOWS OS ONLY
 
-This package is a native addon for Node.js that allows you to perform various utility operations on Windows systems. It includes key event listeners, window data retrieval, window screenshot capture functionality, mouse movement, mouse click, mouse drag, and typing functionality.
+This package is a native addon for Node.js that allows you to perform various utility operations on Windows systems. It includes key event listeners, window data retrieval, window screenshot capture functionality, mouse movement, mouse click, mouse drag, and typing functionality, also I included precompiled libs of OpenCV(core, imgcodecs, imgproc)
 
-## Installation
+# Installation
 
 You can install the package using npm:
 
 ```shell
-npm install node-native-win-utils
+
+npm  install  node-native-win-utils
+
 ```
 
-## Usage
+# Usage
 
-### Importing the Package
+## Importing the Package
 
 To use the package, import the necessary functions, types, and classes:
 
@@ -26,15 +28,16 @@ import {
   keyUpHandler,
   getWindowData,
   captureWindow,
+  captureWindowN,
   mouseMove,
   mouseClick,
   mouseDrag,
   typeString,
-  KeyListener,
+  OpenCV,
 } from "node-native-win-utils";
 ```
 
-### Key Event Listeners
+## Key Event Listeners
 
 The package provides `keyDownHandler` and `keyUpHandler` functions, which allow you to register callbacks for key down and key up events, respectively. The callbacks receive the `keyCode` as a parameter:
 
@@ -52,7 +55,7 @@ keyUpHandler((keyCode) => {
 // Key up: 8
 ```
 
-### Window Data
+## Window Data
 
 The `getWindowData` function retrieves information about a specific window identified by its name. It returns an object with properties `width`, `height`, `x`, and `y`, representing the window dimensions and position:
 
@@ -64,7 +67,7 @@ console.log("Window data:", windowData);
 // Window data: { width: 800, height: 600, x: 50, y: 50 }
 ```
 
-### Window Capture
+## Window Capture
 
 The `captureWindow` function allows you to capture a screenshot of a specific window identified by its name. Provide the window name and the output path as parameters:
 
@@ -74,7 +77,7 @@ captureWindow("Window Name", "output.png");
 // Output: output.png with a screenshot of the window
 ```
 
-### Mouse Movement
+## Mouse Movement
 
 The `mouseMove` function allows you to move the mouse to a specific position on the screen. Provide the `posX` and `posY` coordinates as parameters:
 
@@ -82,25 +85,27 @@ The `mouseMove` function allows you to move the mouse to a specific position on
 mouseMove(100, 200);
 ```
 
-### Mouse Click
+## Mouse Click
 
 The `mouseClick` function allows you to perform a mouse click event. Optionally, you can specify the mouse button as a parameter (`"left"`, `"middle"`, or `"right"`). If no button is specified, a left mouse click is performed by default:
 
 ```javascript
 mouseClick(); // Left mouse click
+
 mouseClick("right"); // Right mouse click
 ```
 
-### Mouse Drag
+## Mouse Drag
 
 The `mouseDrag` function allows you to simulate dragging the mouse from one position to another. Provide the starting and ending coordinates (`startX`, `startY`, `endX`, `endY`) as parameters. Optionally, you can specify the speed at which the mouse should be dragged:
 
 ```javascript
 mouseDrag(100, 200, 300, 400);
+
 mouseDrag(100, 200, 300, 400, 100); // Drag with speed 100
 ```
 
-### Typing
+## Typing
 
 The `typeString` function allows you to simulate typing a string of characters. Provide the string to type as the `stringToType` parameter. Optionally, you can specify
 
@@ -108,10 +113,11 @@ a delay between each character (in milliseconds) using the `delay` parameter:
 
 ```javascript
 typeString("Hello, world!");
+
 typeString("Hello, world!", 100); // Type with a delay of 100ms between characters
 ```
 
-### Key Listener Class
+## Key Listener Class
 
 The `KeyListener` class extends the EventEmitter class and simplifies working with the `keyDownHandler` and `keyUpHandler` functions. You can register event listeners for the "keyDown" and "keyUp" events using the `on` method:
 
@@ -131,25 +137,131 @@ listener.on("keyUp", (data) => {
 // Key up: 8 Backspace
 ```
 
+## OpenCV
+
+The `OpenCV` class extends the capabilities of the native addon package by providing various image processing functionalities. It allows users to perform operations such as matching templates, blurring images, converting color formats, drawing rectangles, getting image regions, and writing images to files.
+
+#### Constructor
+
+```typescript
+const image = new  OpenCV(image: string | ImageData)
+```
+
+Creates a new instance of the `OpenCV` class with the specified image data. The `image` parameter can be either a file path (string) or an existing `ImageData` object.
+
+#### Properties
+
+##### `imageData: ImageData`
+
+Holds the underlying image data that will be used for image processing operations.
+
+##### `width: number`
+
+Read-only property that returns the width of the image in pixels.
+
+##### `height: number`
+
+Read-only property that returns the height of the image in pixels.
+
+#### Methods
+
+##### `matchTemplate(template: ImageData, method?: number | null, mask?: ImageData): OpenCV`
+
+Matches a template image with the current image and returns a new `OpenCV` instance containing the result.
+
+- `template: ImageData`: The template image data to be matched.
+- `method?: number | null`: (Optional) The matching method to be used. If not provided, the default method will be used.(currently no implemented)
+- `mask?: ImageData`: (Optional) An optional mask image data to be used during the matching process.
+
+##### `blur(sizeX: number, sizeY: number): OpenCV`
+
+Applies a blur filter to the current image and returns a new `OpenCV` instance containing the blurred result.
+
+- `sizeX: number`: The size of the blur kernel in the X direction.
+- `sizeY: number`: The size of the blur kernel in the Y direction.
+
+##### `bgrToGray(): OpenCV`
+
+Converts the current image from the BGR color format to grayscale and returns a new `OpenCV` instance containing the grayscale result.
+
+##### `drawRectangle(start: Point, end: Point, rgb: Color, thickness: number): OpenCV`
+
+Draws a rectangle on the current image and returns a new `OpenCV` instance containing the modified result.
+
+- `start: Point`: The starting point (top-left) of the rectangle.
+- `end: Point`: The ending point (bottom-right) of the rectangle.
+- `rgb: Color`: The color of the rectangle in the RGB format (e.g., `{ r: 255, g: 0, b: 0 }` for red).
+- `thickness: number`: The thickness of the rectangle's border.
+
+##### `getRegion(region: ROI): OpenCV`
+
+Extracts a region of interest (ROI) from the current image and returns a new `OpenCV` instance containing the extracted region.
+
+- `region: ROI`: An object specifying the region of interest with properties `x`, `y`, `width`, `height`.
+
+##### `imwrite(path: string): void`
+
+Writes the current image to a file specified by the `path`.
+
+- `path: string`: The file path where the image will be saved.
+
 ## Functions
 
-| Function       | Parameters                                                                              | Return Type            |
-| -------------- | --------------------------------------------------------------------------------------- | ---------------------- |
-| keyDownHandler | `callback: (keyCode: number) => void`                                                   | `void`                 |
-| keyUpHandler   | `callback: (keyCode: number) => void`                                                   | `void`                 |
-| getWindowData  | `windowName: string`                                                                    | `WindowData`           |
-| captureWindow  | `windowName: string, outputPath: string`                                                | `void`                 |
-| mouseMove      | `posX: number, posY: number`                                                            | `boolean`              |
-| mouseClick     | `button?: "left" \| "middle" \| "right"`                                                | `boolean`              |
-| mouseDrag      | `startX: number, startY: number, endX: number, endY: number, speed?: number`            | `boolean`              |
-| typeString     | `stringToType: string, delay?: number`                                                  | `boolean`              |
-| KeyListener.on | `event: "keyDown"`,<br>`callback: (data: { keyCode: number; keyName: string }) => void` | `this` (EventListener) |
-| KeyListener.on | `event: "keyUp"`,<br>`callback: (data: { keyCode: number; keyName: string }) => void`   | `this` (EventListener) |
+| Function       | Parameters                                                                   | Return Type  |
+| -------------- | ---------------------------------------------------------------------------- | ------------ |
+| keyDownHandler | `callback: (keyCode: number) => void`                                        | `void`       |
+| keyUpHandler   | `callback: (keyCode: number) => void`                                        | `void`       |
+| getWindowData  | `windowName: string`                                                         | `WindowData` |
+| captureWindow  | `windowName: string, outputPath: string`                                     | `void`       |
+| mouseMove      | `posX: number, posY: number`                                                 | `boolean`    |
+| mouseClick     | `button?: "left" \| "middle" \| "right"`                                     | `boolean`    |
+| mouseDrag      | `startX: number, startY: number, endX: number, endY: number, speed?: number` | `boolean`    |
+| typeString     | `stringToType: string, delay?: number`                                       | `boolean`    |
+| captureWindowN | `windowName: string`                                                         | `Buffer`     |
 
 ## Examples
 
 Here are some examples of using the package:
 
+```javascript
+// Example usage of the OpenCV class
+import { OpenCV } from "node-native-win-utils";
+
+const image = new OpenCV("path/to/image.png");
+
+const template = new OpenCV("path/to/template.png");
+const matchedImage = image.matchTemplate(template.imageData);
+
+const blurredImage = image.blur(5, 5);
+
+const grayscaleImage = image.bgrToGray();
+
+const regionOfInterest = { x: 100, y: 100, width: 200, height: 150 };
+const regionImage = image.getRegion(regionOfInterest);
+
+const redColor = { r: 255, g: 0, b: 0 };
+const thickRectangle = image.drawRectangle(
+  { x: 50, y: 50 },
+  { x: 150, y: 150 },
+  redColor,
+  3
+);
+
+matchedImage.imwrite("output/matched.png");
+blurredImage.imwrite("output/blurred.png");
+grayscaleImage.imwrite("output/grayscale.png");
+regionImage.imwrite("output/region.png");
+thickRectangle.imwrite("output/thick_rectangle.png");
+```
+
+```javascript
+// If you want to aply blur and convert to gray then do it that order:
+image.blur(5, 5).bgrToGray();
+// Otherwise you will get an error.
+```
+
+Please note that the above example demonstrates the usage of different methods available in the `OpenCV` class. Make sure to replace `"path/to/image.png"` and `"path/to/template.png"` with actual image file paths.
+
 ```javascript
 import {
   keyDownHandler,
@@ -198,16 +310,19 @@ mouseMove(100, 200);
 // Perform mouse click
 
 mouseClick(); // Left mouse click
+
 mouseClick("right"); // Right mouse click
 
 // Simulate mouse drag
 
 mouseDrag(100, 200, 300, 400);
+
 mouseDrag(100, 200, 300, 400, 100); // Drag with speed 100
 
 // Simulate typing
 
 typeString("Hello, world!");
+
 typeString("Hello, world!", 100); // Type with a delay of 100ms between characters
 
 // Use KeyListener class
@@ -227,7 +342,9 @@ listener.on("keyUp", (data) => {
 // Key up: 8 Backspace
 ```
 
-P.S.: As my knowledge of C++ is just brief, most of the C++ code is written using GPT-3.5 and GPT-4 or found on Google with some minor edits by myself.
+P.S.: As my knowledge of C++ is just brief, most of the C++ code is written with help of GPT-3.5 and GPT-4
+
+[OpenCV License](https://github.com/opencv/opencv/blob/master/LICENSE)
 
 [license-src]: https://img.shields.io/github/license/nuxt-modules/icon.svg?style=for-the-badge&colorA=18181B&colorB=28CF8D
 [license-href]: https://github.com/RynerNO/node-native-win-utils/blob/main/LICENSE

package/binding.gyp

@@ -6,13 +6,25 @@
             "openssl_flips": "",
             "include_dirs": [
                 "<!@(node -p \"require('node-addon-api').include\")",
-                "src/cpp"
+                "src/cpp",
+                "libs",
+                "include",
+                "dll"
             ],
             "dependencies": [
                 "<!(node -p \"require('node-addon-api').gyp\")"
             ],
-            "libraries": ["dwmapi.lib", "windowsapp.lib"],
-            "defines": ["NAPI_DISABLE_CPP_EXCEPTIONS"],
+            "libraries": [
+                "dwmapi.lib",
+                "windowsapp.lib",
+                "<!(node -p \"require('path').resolve('libs/libjpeg-turbo.lib')\")",
+                "<!(node -p \"require('path').resolve('libs/libpng.lib')\")",
+                "<!(node -p \"require('path').resolve('libs/zlib.lib')\")",
+                "<!(node -p \"require('path').resolve('libs/opencv_core470.lib')\")",
+                "<!(node -p \"require('path').resolve('libs/opencv_imgcodecs470.lib')\")",
+                "<!(node -p \"require('path').resolve('libs/opencv_imgproc470.lib')\")",
+
+            ],
             "conditions": [
                 ["OS=='win'", {
                     "defines": [
@@ -25,9 +37,10 @@
                     }
                 }]
             ],
+            "defines": ["NAPI_CPP_EXCEPTIONS"],
             "cflags!": ["-fno-exceptions"],
-            "cflags_cc!": ["-fno-exceptions"],
-            "defines": ["NAPI_CPP_EXCEPTIONS"]
+            "cflags_cc!": ["-fno-rtti"],
+            "cflags": ["/std:c++17"]
         }
     ]
 }

package/dist/index.d.ts

@@ -1,31 +1,173 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import EventEmitter = require("events");
-type WindowData = {
+/**
+ * Represents the data of a window.
+ */
+export type WindowData = {
     width: number;
     height: number;
     x: number;
     y: number;
 };
+/**
+ * Represents the data of an image.
+ */
+export type ImageData = {
+    width: number;
+    height: number;
+    data: Uint8Array;
+};
+/**
+ * Represents the result of a template matching operation.
+ */
+export type MatchData = {
+    minValue: number;
+    maxValue: number;
+    minLocation: {
+        x: number;
+        y: number;
+    };
+    maxLocation: {
+        x: number;
+        y: number;
+    };
+};
 export type GetWindowData = (windowName: string) => WindowData;
-export type CaptureWindow = (windowName: string, outputPath: string) => void;
+export type CaptureWindow = (windowName: string) => Buffer;
+/**
+ * The handler to listen to key-down events.
+ * @param callback - The callback function to handle key-down events.
+ */
 export type KeyDownHandler = (callback: (keyCode: number) => void) => void;
+/**
+ * The handler to listen to key-up events.
+ * @param callback - The callback function to handle key-up events.
+ */
 export type KeyUpHandler = (callback: (keyCode: number) => void) => void;
+/**
+ * Function type for moving the mouse.
+ */
 export type MouseMove = (posX: number, posY: number) => boolean;
+/**
+ * Function type for simulating a mouse click.
+ */
 export type MouseClick = (button?: "left" | "middle" | "right") => boolean;
+/**
+ * Function type for simulating typing.
+ */
 export type TypeString = (stringToType: string, delay?: number) => boolean;
+/**
+ * Function type for simulating a mouse drag operation.
+ */
 export type MouseDrag = (starX: number, startY: number, endX: Number, endY: number, speed?: number) => boolean;
+/**
+ * Represents a point in a two-dimensional space.
+ */
+export type Point = [x: number, y: number];
+export type Color = [r: number, g: number, b: number];
+/**
+ * Represents a region of interest in an image.
+ */
+export type ROI = [x: number, y: number, width: number, height: number];
+export type Imread = (path: string) => ImageData;
+export type Imwrite = (image: ImageData) => Buffer;
+export type MatchTemplate = (image: ImageData, template: ImageData, method?: number | null, mask?: ImageData) => MatchData;
+export type Blur = (image: ImageData, sizeX: number, sizeY: number) => ImageData;
+export type BgrToGray = (image: ImageData) => ImageData;
+export type DrawRectangle = (image: ImageData, start: Point, end: Point, rgb: Color, thickness: number) => ImageData;
+export type GetRegion = (image: ImageData, region: ROI) => ImageData;
+declare const keyDownHandler: KeyDownHandler, keyUpHandler: KeyUpHandler, getWindowData: GetWindowData, captureWindowN: CaptureWindow, mouseMove: MouseMove, mouseClick: MouseClick, mouseDrag: MouseDrag, typeString: TypeString;
+/**
+ * Captures a window and saves it to a file.
+ * @param windowName - The name of the window to capture.
+ * @param path - The file path to save the captured image.
+ * @returns True if the capture and save operation is successful, otherwise false.
+ */
+declare function captureWindow(windowName: string, path: string): boolean;
 export interface KeyListener extends EventEmitter {
+    /**
+     * Event: Fires when a key is pressed down.
+     * @param event - The event name ('keyDown').
+     * @param callback - The callback function to handle the event.
+     */
     on(event: "keyDown", callback: (data: {
         keyCode: number;
         keyName: string;
     }) => void): this;
+    /**
+     * Event: Fires when a key is released.
+     * @param event - The event name ('keyUp').
+     * @param callback - The callback function to handle the event.
+     */
     on(event: "keyUp", callback: (data: {
         keyCode: number;
         keyName: string;
     }) => void): this;
 }
-declare const keyDownHandler: KeyDownHandler, keyUpHandler: KeyUpHandler, getWindowData: GetWindowData, captureWindow: CaptureWindow, mouseMove: MouseMove, mouseClick: MouseClick, mouseDrag: MouseDrag, typeString: TypeString;
+/**
+ * Represents a class to listen to keyboard events.
+ * @extends EventEmitter
+ */
 export declare class KeyListener extends EventEmitter {
     constructor();
 }
-export { keyDownHandler, keyUpHandler, getWindowData, captureWindow, mouseMove, mouseClick, mouseDrag, typeString, };
+/**
+ * Represents the OpenCV class that provides image processing functionality.
+ */
+export declare class OpenCV {
+    imageData: ImageData;
+    /**
+     * Represents the OpenCV class that provides image processing functionality.
+     */
+    constructor(image: string | ImageData);
+    /**
+     * The width of the image.
+     */
+    get width(): number;
+    /**
+     * The height of the image.
+     */
+    get height(): number;
+    /**
+     * Matches a template image within the current image.
+     * @param template - The template image data to search for.
+     * @param method - The template matching method (optional).
+     * @param mask - The optional mask image data to apply the operation (optional).
+     * @returns The result of the template matching operation.
+     */
+    matchTemplate(template: ImageData, method?: number | null, mask?: ImageData): MatchData;
+    /**
+     * Applies a blur filter to the image.
+     * @param sizeX - The horizontal size of the blur filter.
+     * @param sizeY - The vertical size of the blur filter.
+     * @returns A new OpenCV instance with the blurred image data.
+     */
+    blur(sizeX: number, sizeY: number): OpenCV;
+    /**
+     * Converts the image from BGR to grayscale.
+     * @returns A new OpenCV instance with the grayscale image data.
+     */
+    bgrToGray(): OpenCV;
+    /**
+     * Draws a rectangle on the image.
+     * @param start - The starting point of the rectangle.
+     * @param end - The ending point of the rectangle.
+     * @param rgb - The color (RGB) of the rectangle.
+     * @param thickness - The thickness of the rectangle's border.
+     * @returns A new OpenCV instance with the image containing the drawn rectangle.
+     */
+    drawRectangle(start: Point, end: Point, rgb: Color, thickness: number): OpenCV;
+    /**
+     * Extracts a region of interest (ROI) from the image.
+     * @param region - The region of interest defined as [x, y, width, height].
+     * @returns A new OpenCV instance with the extracted region of interest.
+     */
+    getRegion(region: ROI): OpenCV;
+    /**
+     * Writes the image data to a file.
+     * @param path - The file path to save the image.
+     */
+    imwrite(path: string): void;
+}
+export { keyDownHandler, keyUpHandler, getWindowData, captureWindow, captureWindowN, mouseMove, mouseClick, mouseDrag, typeString, };

package/dist/index.js

@@ -3,20 +3,39 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.typeString = exports.mouseDrag = exports.mouseClick = exports.mouseMove = exports.captureWindow = exports.getWindowData = exports.keyUpHandler = exports.keyDownHandler = exports.KeyListener = void 0;
+exports.typeString = exports.mouseDrag = exports.mouseClick = exports.mouseMove = exports.captureWindowN = exports.captureWindow = exports.getWindowData = exports.keyUpHandler = exports.keyDownHandler = exports.OpenCV = exports.KeyListener = void 0;
 const EventEmitter = require("events");
 const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
 const bindings = require("node-gyp-build")(path_1.default.resolve(__dirname, ".."));
 const keyCodes_1 = __importDefault(require("./keyCodes"));
-const { keyDownHandler, keyUpHandler, getWindowData, captureWindow, mouseMove, mouseClick, mouseDrag, typeString, } = bindings;
+const { keyDownHandler, keyUpHandler, getWindowData, captureWindowN, mouseMove, mouseClick, mouseDrag, typeString, imread, imwrite, matchTemplate, blur, bgrToGray, drawRectangle, getRegion, } = bindings;
 exports.keyDownHandler = keyDownHandler;
 exports.keyUpHandler = keyUpHandler;
 exports.getWindowData = getWindowData;
-exports.captureWindow = captureWindow;
+exports.captureWindowN = captureWindowN;
 exports.mouseMove = mouseMove;
 exports.mouseClick = mouseClick;
 exports.mouseDrag = mouseDrag;
 exports.typeString = typeString;
+/**
+ * Captures a window and saves it to a file.
+ * @param windowName - The name of the window to capture.
+ * @param path - The file path to save the captured image.
+ * @returns True if the capture and save operation is successful, otherwise false.
+ */
+function captureWindow(windowName, path) {
+    const buffer = captureWindowN(windowName);
+    if (!buffer)
+        return false;
+    fs_1.default.writeFileSync(path, buffer);
+    return true;
+}
+exports.captureWindow = captureWindow;
+/**
+ * Represents a class to listen to keyboard events.
+ * @extends EventEmitter
+ */
 class KeyListener extends EventEmitter {
     constructor() {
         super();
@@ -37,3 +56,88 @@ class KeyListener extends EventEmitter {
     }
 }
 exports.KeyListener = KeyListener;
+/**
+ * Represents the OpenCV class that provides image processing functionality.
+ */
+class OpenCV {
+    imageData;
+    /**
+     * Represents the OpenCV class that provides image processing functionality.
+     */
+    constructor(image) {
+        if (typeof image === "string") {
+            this.imageData = imread(image);
+        }
+        else {
+            this.imageData = image;
+        }
+    }
+    /**
+     * The width of the image.
+     */
+    get width() {
+        return this.imageData.width;
+    }
+    /**
+     * The height of the image.
+     */
+    get height() {
+        return this.imageData.height;
+    }
+    /**
+     * Matches a template image within the current image.
+     * @param template - The template image data to search for.
+     * @param method - The template matching method (optional).
+     * @param mask - The optional mask image data to apply the operation (optional).
+     * @returns The result of the template matching operation.
+     */
+    matchTemplate(template, method, mask) {
+        return matchTemplate(this.imageData, template, method, mask);
+    }
+    /**
+     * Applies a blur filter to the image.
+     * @param sizeX - The horizontal size of the blur filter.
+     * @param sizeY - The vertical size of the blur filter.
+     * @returns A new OpenCV instance with the blurred image data.
+     */
+    blur(sizeX, sizeY) {
+        return new OpenCV(blur(this.imageData, sizeX, sizeY));
+    }
+    /**
+     * Converts the image from BGR to grayscale.
+     * @returns A new OpenCV instance with the grayscale image data.
+     */
+    bgrToGray() {
+        return new OpenCV(bgrToGray(this.imageData));
+    }
+    /**
+     * Draws a rectangle on the image.
+     * @param start - The starting point of the rectangle.
+     * @param end - The ending point of the rectangle.
+     * @param rgb - The color (RGB) of the rectangle.
+     * @param thickness - The thickness of the rectangle's border.
+     * @returns A new OpenCV instance with the image containing the drawn rectangle.
+     */
+    drawRectangle(start, end, rgb, thickness) {
+        return new OpenCV(drawRectangle(this.imageData, start, end, rgb, thickness));
+    }
+    /**
+     * Extracts a region of interest (ROI) from the image.
+     * @param region - The region of interest defined as [x, y, width, height].
+     * @returns A new OpenCV instance with the extracted region of interest.
+     */
+    getRegion(region) {
+        return new OpenCV(getRegion(this.imageData, region));
+    }
+    /**
+     * Writes the image data to a file.
+     * @param path - The file path to save the image.
+     */
+    imwrite(path) {
+        const buffer = imwrite(this.imageData);
+        if (!buffer)
+            return;
+        fs_1.default.writeFileSync(path, buffer);
+    }
+}
+exports.OpenCV = OpenCV;