image-comparator v1.8.4

image-comparator

Compares images by resizing and checking color match without external dependencies

Install

npm install --save image-comparator

Test

npm test

Build

npm run build

Example

const fs = require("node:fs");
const comparator = require("image-comparator");

const imagePath1 = "path/to/image1.png";
const imagePath2 = "path/to/image2.png";

const imageBuffer1 = fs.readFileSync(imagePath1);
const imageBuffer2 = fs.readFileSync(imagePath2);

const compare = async () => {
  const areSame = await comparator.compare(imageBuffer1, imageBuffer2);

  if (areSame) {
    console.log("Images are the same");
  } else {
    console.log("Images are different");
  }
};

compare();

With custom threshold

const fs = require("node:fs");
const comparator = require("image-comparator");

const imagePath1 = "path/to/same.png";
const imagePath2 = "path/to/same.jpg";

const imageBuffer1 = fs.readFileSync(imagePath1);
const imageBuffer2 = fs.readFileSync(imagePath2);

const compare = async () => {
  const compareFunction = (byte1, byte2) => false; // Images are always different

  const areSame = await comparator.compare(imageBuffer1, imageBuffer2, {
    compareFunction,
  });

  if (areSame) {
    throw new Error("Should not happen");
  } else {
    console.log("Images are different");
  }
};

compare();

const fs = require("node:fs");
const comparator = require("image-comparator");

const imagePath1 = "path/to/same.png";
const imagePath2 = "path/to/same.jpg";

const imageBuffer1 = fs.readFileSync(imagePath1);
const imageBuffer2 = fs.readFileSync(imagePath2);

const compare = async () => {
  const compareFunction = (byte1, byte2) => Math.abs(byte1 - byte2) < 128; // If color difference is small enough

  const areSame = await comparator.compare(imageBuffer1, imageBuffer2, {
    compareFunction,
  });

  if (areSame) {
    console.log("Images are the same");
  } else {
    console.log("Images are different");
  }
};

compare();

Hue detection:

const fs = require("node:fs");
const comparator = require("image-comparator");

const imagePath1 = "path/to/same.png";
const imagePath2 = "path/to/same.jpg";

const imageBuffer1 = fs.readFileSync(imagePath1);
const imageBuffer2 = fs.readFileSync(imagePath2);

const compare = async () => {
  const compareFunction = (byte1, byte2) => Math.abs(byte1 - byte2) < 128; // If color difference is small enough

  const areSame = await comparator.compare(imageBuffer1, imageBuffer2, {
    compareFunction,
    modes: comparator.MODES.CHECK_HUE,
  });

  if (areSame) {
    console.log("Images are the same");
  } else {
    console.log("Images are different");
  }
};

compare();

Grayscale detection:

const fs = require("node:fs");
const comparator = require("image-comparator");

const imagePath1 = "path/to/same.png";
const imagePath2 = "path/to/same.jpg";

const imageBuffer1 = fs.readFileSync(imagePath1);
const imageBuffer2 = fs.readFileSync(imagePath2);

const compare = async () => {
  const compareFunction = (byte1, byte2) => Math.abs(byte1 - byte2) < 128; // If color difference is small enough

  const areSame = await comparator.compare(imageBuffer1, imageBuffer2, {
    compareFunction,
    modes: comparator.MODES.CHECK_GRAYSCALE,
  });

  if (areSame) {
    console.log("Images are the same");
  } else {
    console.log("Images are different");
  }
};

compare();

Inversion detection:

const fs = require("node:fs");
const comparator = require("image-comparator");

const imagePath1 = "path/to/same.png";
const imagePath2 = "path/to/same.jpg";

const imageBuffer1 = fs.readFileSync(imagePath1);
const imageBuffer2 = fs.readFileSync(imagePath2);

const compare = async () => {
  const compareFunction = (byte1, byte2) => Math.abs(byte1 - byte2) < 128; // If color difference is small enough

  const areSame = await comparator.compare(imageBuffer1, imageBuffer2, {
    compareFunction,
    modes: comparator.MODES.CHECK_INVERSION,
  });

  if (areSame) {
    console.log("Images are the same");
  } else {
    console.log("Images are different");
  }
};

compare();

API

compare: (buffer1: Buffer, buffer2: Buffer, options: Options) => bool;

type Options = {
  compareFunction?: (byte1, byte2) => boolean,
  modes?:
    | MODES.CHECK_HUE
    | MODES.CHECK_GRAYSCALE
    | MODES.CHECK_INVERSION
    | MODES.CHECK_ROTATION,
};

Compares two images. Can accept modes to detect hue or grayscale changes.

Can detect differences between images of different formats, such as comparision of jpg with webp.

Warns about deprecated third argument if compareFunction passed outside the object as function.

Supported extensions

• png
• jpg
• webp

Supported modes

• CHECK_HUE
• CHECK_GRAYSCALE
• CHECK_INVERSION

Detection algorithm

1. Retrieve dimensions and bitmap data from the input image buffers
2. Resize the images to a consistent mini size
3. Compare the resized images using the areBuffersEqual function

Notes

• May produce false positives for comparison of images of different format origins due to inconsistent resulting bitmap size. Use compareFunction in options third argument as mitigation.