Feature/451/bits per pixel (#452)

s1hofmann · web-flow · commit 21f1971f947d · 2022-11-15T22:26:50.000Z
* (#451) Extended image class with bitPerPixel and byteWidth properties * (#451) Adjusted image tests to new interface * (#451) Adjusted usages of Image class to provide required new data, added type predicate to highlight and grabRegion * (#451) Adjusted tests
diff --git a/lib/image.class.spec.ts b/lib/image.class.spec.ts
@@ -14,38 +14,46 @@ afterEach(() => {
 
 describe("Image class", () => {
   it("should return alphachannel = true for > 3 channels", () => {
-    const SUT = new Image(200, 200, Buffer.from([123]), 4, "id");
+    const SUT = new Image(200, 200, Buffer.from([123]), 4, "id", 4, 200 * 4);
     expect(SUT.hasAlphaChannel).toBeTruthy();
   });
 
   it("should return alphachannel = false for <= 3 channels", () => {
-    const SUT = new Image(200, 200, Buffer.from([123]), 3, "id");
+    const SUT = new Image(200, 200, Buffer.from([123]), 3, "id", 4, 200 * 4);
     expect(SUT.hasAlphaChannel).toBeFalsy();
   });
   it("should return alphachannel = false for <= 3 channels", () => {
-    const SUT = new Image(200, 200, Buffer.from([123]), 2, "id");
+    const SUT = new Image(200, 200, Buffer.from([123]), 2, "id", 4, 200 * 4);
     expect(SUT.hasAlphaChannel).toBeFalsy();
   });
   it("should return alphachannel = false for <= 3 channels", () => {
-    const SUT = new Image(200, 200, Buffer.from([123]), 1, "id");
+    const SUT = new Image(200, 200, Buffer.from([123]), 1, "id", 4, 200 * 4);
     expect(SUT.hasAlphaChannel).toBeFalsy();
   });
 
   it("should throw for <= 0 channels", () => {
-    expect(() => new Image(200, 200, Buffer.from([123]), 0, "id")).toThrowError(
-      "Channel <= 0"
-    );
+    expect(
+      () => new Image(200, 200, Buffer.from([123]), 0, "id", 4, 200 * 4)
+    ).toThrowError("Channel <= 0");
   });
 
   it("should have a default pixel density of 1.0", () => {
-    const SUT = new Image(200, 200, Buffer.from([123]), 1, "id");
+    const SUT = new Image(200, 200, Buffer.from([123]), 1, "id", 4, 200 * 4);
     expect(SUT.pixelDensity).toEqual({ scaleX: 1.0, scaleY: 1.0 });
   });
 
   describe("Colormode", () => {
     it("should not try to convert an image to BGR if it already has the correct color mode", async () => {
       // GIVEN
-      const bgrImage = new Image(100, 100, Buffer.from([]), 3, "testImage");
+      const bgrImage = new Image(
+        100,
+        100,
+        Buffer.from([]),
+        3,
+        "testImage",
+        4,
+        200 * 4
+      );
 
       // WHEN
       const convertedImage = await bgrImage.toBGR();
@@ -63,6 +71,8 @@ describe("Image class", () => {
         Buffer.from([]),
         3,
         "testImage",
+        4,
+        200 * 4,
         ColorMode.RGB
       );
 
@@ -78,7 +88,7 @@ describe("Image class", () => {
   describe("isImage typeguard", () => {
     it("should identify an Image", () => {
       // GIVEN
-      const img = new Image(100, 100, Buffer.from([]), 4, "foo");
+      const img = new Image(100, 100, Buffer.from([]), 4, "foo", 4, 200 * 4);
 
       // WHEN
       const result = isImage(img);
diff --git a/lib/image.class.ts b/lib/image.class.ts
@@ -12,6 +12,8 @@ export class Image {
    * @param data Generic {@link Image} data
    * @param channels Amount of {@link Image} channels
    * @param id Image identifier
+   * @param bitsPerPixel Number of bits per single pixel
+   * @param byteWidth Total number of bytes per image line
    * @param colorMode An images color mode, defaults to {@link ColorMode.BGR}
    * @param pixelDensity Object containing scale info to work with e.g. Retina display data where the reported display size and pixel size differ (Default: {scaleX: 1.0, scaleY: 1.0})
    */
@@ -21,6 +23,8 @@ export class Image {
     public readonly data: Buffer,
     public readonly channels: number,
     public readonly id: string,
+    public readonly bitsPerPixel: number,
+    public readonly byteWidth: number,
     public readonly colorMode: ColorMode = ColorMode.BGR,
     public readonly pixelDensity: { scaleX: number; scaleY: number } = {
       scaleX: 1.0,
@@ -53,6 +57,8 @@ export class Image {
       rgbImage.bitmap.data,
       this.channels,
       this.id,
+      this.bitsPerPixel,
+      this.byteWidth,
       ColorMode.RGB,
       this.pixelDensity
     );
@@ -72,6 +78,8 @@ export class Image {
       rgbImage.bitmap.data,
       this.channels,
       this.id,
+      this.bitsPerPixel,
+      this.byteWidth,
       ColorMode.BGR,
       this.pixelDensity
     );
@@ -85,15 +93,41 @@ export class Image {
     height: number,
     data: Buffer,
     channels: number,
-    id: string
+    id: string,
+    bitsPerPixel: number,
+    byteWidth: number
   ): Image {
-    const rgbImage = new Image(width, height, data, channels, id);
+    const rgbImage = new Image(
+      width,
+      height,
+      data,
+      channels,
+      id,
+      bitsPerPixel,
+      byteWidth
+    );
     const jimpImage = imageToJimp(rgbImage);
-    return new Image(width, height, jimpImage.bitmap.data, channels, id);
+    return new Image(
+      width,
+      height,
+      jimpImage.bitmap.data,
+      channels,
+      id,
+      bitsPerPixel,
+      byteWidth
+    );
   }
 }
 
-const testImage = new Image(100, 100, Buffer.from([]), 4, "typeCheck");
+const testImage = new Image(
+  100,
+  100,
+  Buffer.from([]),
+  4,
+  "typeCheck",
+  4,
+  100 * 4
+);
 const imageKeys = Object.keys(testImage);
 
 export function isImage(possibleImage: any): possibleImage is Image {
diff --git a/lib/imageResources.function.ts b/lib/imageResources.function.ts
@@ -38,6 +38,8 @@ export async function fetchFromUrl(url: string | URL): Promise<Image> {
         image.bitmap.data,
         4,
         imageUrl.href,
+        image.bitmap.data.length / (image.bitmap.width * image.bitmap.height),
+        image.bitmap.data.length / image.bitmap.height,
         ColorMode.RGB
       );
     })
diff --git a/lib/match-request.class.spec.ts b/lib/match-request.class.spec.ts
@@ -6,8 +6,8 @@ jest.mock("jimp", () => {});
 describe("MatchRequest", () => {
   it("should default to multi-scale matching", () => {
     const SUT = new MatchRequest(
-      new Image(100, 100, Buffer.from([]), 3, "haystack_image"),
-      new Image(100, 100, Buffer.from([]), 3, "needle_image"),
+      new Image(100, 100, Buffer.from([]), 3, "haystack_image", 4, 100 * 4),
+      new Image(100, 100, Buffer.from([]), 3, "needle_image", 4, 100 * 4),
       0.99
     );
 
diff --git a/lib/provider/io/imageToJimp.function.spec.ts b/lib/provider/io/imageToJimp.function.spec.ts
@@ -31,7 +31,9 @@ describe("imageToJimp", () => {
       1,
       Buffer.from([0, 0, 0]),
       3,
-      "input_image"
+      "input_image",
+      4,
+      4
     );
 
     // WHEN
diff --git a/lib/provider/io/jimp-image-reader.class.ts b/lib/provider/io/jimp-image-reader.class.ts
@@ -27,6 +27,9 @@ export default class implements ImageReader {
               jimpImage.bitmap.data,
               jimpImage.hasAlpha() ? 4 : 3,
               parameters,
+              jimpImage.bitmap.data.length /
+                (jimpImage.bitmap.width * jimpImage.bitmap.height),
+              jimpImage.bitmap.data.length / jimpImage.bitmap.height,
               ColorMode.BGR
             )
           );
diff --git a/lib/provider/io/jimp-image-writer.class.spec.ts b/lib/provider/io/jimp-image-writer.class.spec.ts
@@ -25,7 +25,15 @@ describe("Jimp image writer", () => {
   it("should reject on writing failures", async () => {
     // GIVEN
     const outputFileName = "/does/not/compute.png";
-    const outputFile = new Image(100, 200, Buffer.from([]), 3, outputFileName);
+    const outputFile = new Image(
+      100,
+      200,
+      Buffer.from([]),
+      3,
+      outputFileName,
+      4,
+      100 * 4
+    );
     const writeMock = jest.fn(() => Promise.resolve(new Jimp()));
     const scanMock = jest.fn();
     Jimp.prototype.scan = scanMock;
diff --git a/lib/provider/native/libnut-screen.class.ts b/lib/provider/native/libnut-screen.class.ts
@@ -33,6 +33,8 @@ export default class ScreenAction implements ScreenProviderInterface {
             screenShot.image,
             4,
             "grabScreenResult",
+            screenShot.bitsPerPixel,
+            screenShot.byteWidth,
             ColorMode.BGR,
             pixelScaling
           )
@@ -63,6 +65,8 @@ export default class ScreenAction implements ScreenProviderInterface {
             screenShot.image,
             4,
             "grabScreenRegionResult",
+            4,
+            screenShot.width * 4,
             ColorMode.BGR,
             pixelScaling
           )
diff --git a/lib/screen.class.spec.ts b/lib/screen.class.spec.ts
diff --git a/lib/screen.class.ts b/lib/screen.class.ts
diff --git a/lib/screen.colorAt.spec.ts b/lib/screen.colorAt.spec.ts
