@blazediff/bin 1.4.1 → 1.5.0

package/dist/cli.js

@@ -25,7 +25,11 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 
 // src/index.ts
 var import_core = __toESM(require("@blazediff/core"));
-async function blazeDiffBin(image1Path, image2Path, options) {
+var import_gmsd = __toESM(require("@blazediff/gmsd"));
+var isGmsdModeOptions = (options) => {
+  return options.mode === "gmsd";
+};
+async function bin(image1Path, image2Path, options) {
   const [image1, image2] = await Promise.all([
     options.transformer.transform(image1Path),
     options.transformer.transform(image2Path)
@@ -35,6 +39,40 @@ async function blazeDiffBin(image1Path, image2Path, options) {
       `Image dimensions do not match: ${image1.width}x${image1.height} vs ${image2.width}x${image2.height}`
     );
   }
+  if (isGmsdModeOptions(options)) {
+    let outputData2;
+    if (options.outputPath) {
+      outputData2 = new Uint8Array(image1.data.length);
+    }
+    const startTime2 = performance.now();
+    const score = (0, import_gmsd.default)(
+      image1.data,
+      image2.data,
+      outputData2,
+      image1.width,
+      image1.height,
+      options.options || {}
+    );
+    const duration2 = performance.now() - startTime2;
+    if (options.outputPath && outputData2) {
+      await options.transformer.write(
+        {
+          data: outputData2,
+          width: image1.width,
+          height: image1.height
+        },
+        options.outputPath
+      );
+    }
+    return {
+      mode: "gmsd",
+      width: image1.width,
+      height: image1.height,
+      outputData: outputData2,
+      duration: duration2,
+      score
+    };
+  }
   let outputData;
   if (options.outputPath) {
     outputData = new Uint8Array(image1.data.length);
@@ -46,7 +84,7 @@ async function blazeDiffBin(image1Path, image2Path, options) {
     outputData,
     image1.width,
     image1.height,
-    options.coreOptions
+    options.options || {}
   );
   const duration = performance.now() - startTime;
   if (diffCount > 0 && options.outputPath && outputData) {
@@ -60,6 +98,7 @@ async function blazeDiffBin(image1Path, image2Path, options) {
     );
   }
   return {
+    mode: "diff",
     diffCount,
     width: image1.width,
     height: image1.height,
@@ -77,7 +116,12 @@ Arguments:
   image1    Path to the first image
   image2    Path to the second image
 
-Options:
+General Options:
+  -m, --mode <mode>         Comparison mode: "diff" or "gmsd" (default: diff)
+  --transformer <name>      Specify transformer to use (e.g. pngjs, sharp)
+  -h, --help                Show this help message
+
+Diff Mode Options (default mode):
   -o, --output <path>       Output path for the diff image
   -t, --threshold <num>     Matching threshold (0 to 1, default: 0.1)
   -a, --alpha <num>         Opacity of original image in diff (default: 0.1)
@@ -86,14 +130,23 @@ Options:
   --diff-color-alt <r,g,b>  Alternative color for dark differences (default: same as diff-color)
   --include-aa              Include anti-aliasing detection
   --diff-mask               Draw diff over transparent background
-  --transformer <name>      Specify transformer to use (e.g. pngjs, sharp)
   --color-space <name>      Specify color space to use (e.g. yiq, ycbcr)
-  -h, --help                Show this help message
+
+GMSD Mode Options (--mode gmsd):
+  -o, --output <path>       Output path for GMS similarity map (grayscale visualization)
+  --downsample <0|1>        Downsample factor: 0=full-res, 1=2x downsample (default: 0)
+  --gmsd-c <num>            Stability constant for GMSD (default: 170)
 
 Examples:
+  # Pixel-by-pixel diff (default)
   blazediff image1.png image2.png
   blazediff image1.png image2.png -o diff.png -t 0.05
   blazediff image1.png image2.png --threshold 0.2 --alpha 0.3
+
+  # GMSD similarity score
+  blazediff image1.png image2.png --mode gmsd
+  blazediff image1.png image2.png --mode gmsd --downsample 1
+  blazediff image1.png image2.png --mode gmsd -o gms-map.png
 `);
 }
 function parseRGB(colorStr) {
@@ -192,6 +245,40 @@ function parseArgs() {
           i++;
         }
         break;
+      case "-m":
+      case "--mode":
+        if (nextArg) {
+          if (nextArg !== "diff" && nextArg !== "gmsd") {
+            throw new Error(
+              `Invalid mode: ${nextArg}. Must be "diff" or "gmsd"`
+            );
+          }
+          options.mode = nextArg;
+          i++;
+        }
+        break;
+      case "--downsample":
+        if (nextArg) {
+          const downsample = parseInt(nextArg, 10);
+          if (downsample !== 0 && downsample !== 1) {
+            throw new Error(`Invalid downsample: ${nextArg}. Must be 0 or 1`);
+          }
+          options.downsample = downsample;
+          i++;
+        }
+        break;
+      case "--gmsd-c":
+        if (nextArg) {
+          const gmsdC = parseFloat(nextArg);
+          if (Number.isNaN(gmsdC) || gmsdC <= 0) {
+            throw new Error(
+              `Invalid gmsd-c: ${nextArg}. Must be a positive number`
+            );
+          }
+          options.gmsdC = gmsdC;
+          i++;
+        }
+        break;
       default:
         console.error(`Unknown option: ${arg}`);
         printUsage();
@@ -215,33 +302,65 @@ async function main() {
   try {
     const { image1, image2, options } = parseArgs();
     const transformer = await getTransformer(options.transformer);
-    const result = await blazeDiffBin(image1, image2, {
-      outputPath: options.outputPath,
-      transformer,
-      coreOptions: {
-        threshold: options.threshold,
-        alpha: options.alpha,
-        aaColor: options.aaColor,
-        diffColor: options.diffColor,
-        diffColorAlt: options.diffColorAlt,
-        includeAA: options.includeAA,
-        diffMask: options.diffMask
-      }
-    });
-    console.log(`matched in: ${result.duration.toFixed(2)}ms`);
-    console.log(`dimensions: ${result.width}x${result.height}`);
-    console.log(`different pixels: ${result.diffCount}`);
-    console.log(
-      `error: ${(result.diffCount / (result.width * result.height) * 100).toFixed(2)}%`
-    );
-    if (result.diffCount > 0 && result.outputData) {
-      console.log(`diff image: ${options.outputPath}`);
+    let result;
+    if (options.mode === "gmsd") {
+      const binOptions = {
+        outputPath: options.outputPath,
+        transformer,
+        mode: "gmsd",
+        options: {
+          downsample: options.downsample || 0,
+          c: options.gmsdC
+        }
+      };
+      result = await bin(image1, image2, binOptions);
+    } else {
+      const binOptions = {
+        outputPath: options.outputPath,
+        transformer,
+        mode: "diff",
+        options: {
+          threshold: options.threshold,
+          alpha: options.alpha,
+          aaColor: options.aaColor,
+          diffColor: options.diffColor,
+          diffColorAlt: options.diffColorAlt,
+          includeAA: options.includeAA,
+          diffMask: options.diffMask
+        }
+      };
+      result = await bin(image1, image2, binOptions);
     }
-    if (result.diffCount > 0) {
-      process.exit(1);
+    console.log(`completed in: ${result.duration.toFixed(2)}ms`);
+    console.log(`dimensions: ${result.width}x${result.height}`);
+    if (result.mode === "gmsd") {
+      console.log(
+        `similarity score: ${result.score.toFixed(6)} (0=different, 1=identical)`
+      );
+      console.log(`similarity: ${(result.score * 100).toFixed(2)}%`);
+      if (options.outputPath && result.outputData) {
+        console.log(`GMS map saved to: ${options.outputPath}`);
+      }
+      if (result.score < 0.95) {
+        process.exit(1);
+      } else {
+        console.log(`Images are highly similar!`);
+        process.exit(0);
+      }
     } else {
-      console.log(`Images are identical!`);
-      process.exit(0);
+      console.log(`different pixels: ${result.diffCount}`);
+      console.log(
+        `error: ${(result.diffCount / (result.width * result.height) * 100).toFixed(2)}%`
+      );
+      if (result.diffCount > 0 && result.outputData && options.outputPath) {
+        console.log(`diff image: ${options.outputPath}`);
+      }
+      if (result.diffCount > 0) {
+        process.exit(1);
+      } else {
+        console.log(`Images are identical!`);
+        process.exit(0);
+      }
     }
   } catch (error) {
     console.error(

package/dist/index.d.mts

@@ -1,17 +1,46 @@
-import { BlazeDiffTransformer, BlazeDiffOptions } from '@blazediff/types';
+import { CoreOptions } from '@blazediff/core';
+import { GmsdOptions } from '@blazediff/gmsd';
 
-interface BlazeDiffBinOptions {
+interface Image {
+    data: Buffer | Uint8Array | Uint8ClampedArray;
+    width: number;
+    height: number;
+}
+interface Transformer {
+    transform: (input: string | Buffer) => Promise<Image>;
+    write: (image: Image, output: string | Buffer) => Promise<void>;
+}
+type ComparisonMode = "diff" | "gmsd";
+interface DiffModeOptions {
+    outputPath?: string;
+    transformer: Transformer;
+    mode?: "diff";
+    options?: CoreOptions;
+}
+interface GmsdModeOptions {
     outputPath?: string;
-    transformer: BlazeDiffTransformer;
-    coreOptions?: BlazeDiffOptions;
+    transformer: Transformer;
+    mode: "gmsd";
+    options?: GmsdOptions;
 }
-interface BlazeDiffBinResult {
+interface DiffModeResult {
+    mode: "diff";
     diffCount: number;
     width: number;
     height: number;
     outputData?: Uint8Array;
     duration: number;
 }
-declare function blazeDiffBin(image1Path: string, image2Path: string, options: BlazeDiffBinOptions): Promise<BlazeDiffBinResult>;
+interface GmsdModeResult {
+    mode: "gmsd";
+    score: number;
+    width: number;
+    height: number;
+    outputData?: Uint8Array;
+    duration: number;
+}
+type BlazeDiffBinResult = DiffModeResult | GmsdModeResult;
+declare function bin(image1Path: string, image2Path: string, options: GmsdModeOptions): Promise<GmsdModeResult>;
+declare function bin(image1Path: string, image2Path: string, options: DiffModeOptions): Promise<DiffModeResult>;
 
-export { type BlazeDiffBinOptions, type BlazeDiffBinResult, blazeDiffBin as default };
+export { type BlazeDiffBinResult, type ComparisonMode, type DiffModeOptions, type DiffModeResult, type GmsdModeOptions, type GmsdModeResult, type Image, type Transformer, bin as default };

package/dist/index.d.ts

@@ -1,17 +1,46 @@
-import { BlazeDiffTransformer, BlazeDiffOptions } from '@blazediff/types';
+import { CoreOptions } from '@blazediff/core';
+import { GmsdOptions } from '@blazediff/gmsd';
 
-interface BlazeDiffBinOptions {
+interface Image {
+    data: Buffer | Uint8Array | Uint8ClampedArray;
+    width: number;
+    height: number;
+}
+interface Transformer {
+    transform: (input: string | Buffer) => Promise<Image>;
+    write: (image: Image, output: string | Buffer) => Promise<void>;
+}
+type ComparisonMode = "diff" | "gmsd";
+interface DiffModeOptions {
+    outputPath?: string;
+    transformer: Transformer;
+    mode?: "diff";
+    options?: CoreOptions;
+}
+interface GmsdModeOptions {
     outputPath?: string;
-    transformer: BlazeDiffTransformer;
-    coreOptions?: BlazeDiffOptions;
+    transformer: Transformer;
+    mode: "gmsd";
+    options?: GmsdOptions;
 }
-interface BlazeDiffBinResult {
+interface DiffModeResult {
+    mode: "diff";
     diffCount: number;
     width: number;
     height: number;
     outputData?: Uint8Array;
     duration: number;
 }
-declare function blazeDiffBin(image1Path: string, image2Path: string, options: BlazeDiffBinOptions): Promise<BlazeDiffBinResult>;
+interface GmsdModeResult {
+    mode: "gmsd";
+    score: number;
+    width: number;
+    height: number;
+    outputData?: Uint8Array;
+    duration: number;
+}
+type BlazeDiffBinResult = DiffModeResult | GmsdModeResult;
+declare function bin(image1Path: string, image2Path: string, options: GmsdModeOptions): Promise<GmsdModeResult>;
+declare function bin(image1Path: string, image2Path: string, options: DiffModeOptions): Promise<DiffModeResult>;
 
-export { type BlazeDiffBinOptions, type BlazeDiffBinResult, blazeDiffBin as default };
+export { type BlazeDiffBinResult, type ComparisonMode, type DiffModeOptions, type DiffModeResult, type GmsdModeOptions, type GmsdModeResult, type Image, type Transformer, bin as default };

package/dist/index.js

@@ -1 +1 @@
-'use strict';var m=require('@blazediff/core');function _interopDefault(e){return e&&e.__esModule?e:{default:e}}var m__default=/*#__PURE__*/_interopDefault(m);async function u(n,f,i){let[t,e]=await Promise.all([i.transformer.transform(n),i.transformer.transform(f)]);if(t.width!==e.width||t.height!==e.height)throw new Error(`Image dimensions do not match: ${t.width}x${t.height} vs ${e.width}x${e.height}`);let r;i.outputPath&&(r=new Uint8Array(t.data.length));let h=performance.now(),a=m__default.default(t.data,e.data,r,t.width,t.height,i.coreOptions),o=performance.now()-h;return a>0&&i.outputPath&&r&&await i.transformer.write({data:r,width:t.width,height:t.height},i.outputPath),{diffCount:a,width:t.width,height:t.height,outputData:r,duration:o}}module.exports=u;
+'use strict';var g=require('@blazediff/core'),p=require('@blazediff/gmsd');function _interopDefault(e){return e&&e.__esModule?e:{default:e}}var g__default=/*#__PURE__*/_interopDefault(g);var p__default=/*#__PURE__*/_interopDefault(p);var w=n=>n.mode==="gmsd";async function c(n,d,e){let[t,i]=await Promise.all([e.transformer.transform(n),e.transformer.transform(d)]);if(t.width!==i.width||t.height!==i.height)throw new Error(`Image dimensions do not match: ${t.width}x${t.height} vs ${i.width}x${i.height}`);if(w(e)){let o;e.outputPath&&(o=new Uint8Array(t.data.length));let m=performance.now(),u=p__default.default(t.data,i.data,o,t.width,t.height,e.options||{}),h=performance.now()-m;return e.outputPath&&o&&await e.transformer.write({data:o,width:t.width,height:t.height},e.outputPath),{mode:"gmsd",width:t.width,height:t.height,outputData:o,duration:h,score:u}}let r;e.outputPath&&(r=new Uint8Array(t.data.length));let s=performance.now(),a=g__default.default(t.data,i.data,r,t.width,t.height,e.options||{}),f=performance.now()-s;return a>0&&e.outputPath&&r&&await e.transformer.write({data:r,width:t.width,height:t.height},e.outputPath),{mode:"diff",diffCount:a,width:t.width,height:t.height,outputData:r,duration:f}}module.exports=c;

package/dist/index.mjs

@@ -1 +1 @@
-import m from'@blazediff/core';async function u(n,f,i){let[t,e]=await Promise.all([i.transformer.transform(n),i.transformer.transform(f)]);if(t.width!==e.width||t.height!==e.height)throw new Error(`Image dimensions do not match: ${t.width}x${t.height} vs ${e.width}x${e.height}`);let r;i.outputPath&&(r=new Uint8Array(t.data.length));let h=performance.now(),a=m(t.data,e.data,r,t.width,t.height,i.coreOptions),o=performance.now()-h;return a>0&&i.outputPath&&r&&await i.transformer.write({data:r,width:t.width,height:t.height},i.outputPath),{diffCount:a,width:t.width,height:t.height,outputData:r,duration:o}}export{u as default};
+import g from'@blazediff/core';import p from'@blazediff/gmsd';var w=n=>n.mode==="gmsd";async function c(n,d,e){let[t,i]=await Promise.all([e.transformer.transform(n),e.transformer.transform(d)]);if(t.width!==i.width||t.height!==i.height)throw new Error(`Image dimensions do not match: ${t.width}x${t.height} vs ${i.width}x${i.height}`);if(w(e)){let o;e.outputPath&&(o=new Uint8Array(t.data.length));let m=performance.now(),u=p(t.data,i.data,o,t.width,t.height,e.options||{}),h=performance.now()-m;return e.outputPath&&o&&await e.transformer.write({data:o,width:t.width,height:t.height},e.outputPath),{mode:"gmsd",width:t.width,height:t.height,outputData:o,duration:h,score:u}}let r;e.outputPath&&(r=new Uint8Array(t.data.length));let s=performance.now(),a=g(t.data,i.data,r,t.width,t.height,e.options||{}),f=performance.now()-s;return a>0&&e.outputPath&&r&&await e.transformer.write({data:r,width:t.width,height:t.height},e.outputPath),{mode:"diff",diffCount:a,width:t.width,height:t.height,outputData:r,duration:f}}export{c as default};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blazediff/bin",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "Command-line interface for the blazediff image comparison library",
   "private": false,
   "publishConfig": {
@@ -37,10 +37,10 @@
   "homepage": "https://blazediff.dev",
   "license": "MIT",
   "dependencies": {
-    "@blazediff/core": "1.4.1",
-    "@blazediff/pngjs-transformer": "1.4.1",
-    "@blazediff/sharp-transformer": "1.4.1",
-    "@blazediff/types": "1.4.1"
+    "@blazediff/core": "1.5.0",
+    "@blazediff/gmsd": "1.5.0",
+    "@blazediff/pngjs-transformer": "1.5.0",
+    "@blazediff/sharp-transformer": "1.5.0"
   },
   "devDependencies": {
     "@types/node": "^24.3.0",