Merge pull request #799 from manuc66/feature/support-full-scan-size

Feature/support full scan size
manuc66 · Nov 25, 2023 · a5b8453 · a5b8453
2 parents 9928f3b + e924a74
commit a5b8453
Show file tree

Hide file tree

Showing 12 changed files with 316 additions and 11 deletions.
diff --git a/src/DeviceCapabilities.ts b/src/DeviceCapabilities.ts
@@ -1,4 +1,8 @@
 export interface DeviceCapabilities {
   supportsMultiItemScanFromPlaten: boolean;
   useWalkupScanToComp: boolean;
+  platenMaxWidth: number | null;
+  platenMaxHeight: number | null;
+  adfMaxWidth: number | null;
+  adfMaxHeight: number | null;
 }
diff --git a/src/ScanCaps.ts b/src/ScanCaps.ts
@@ -3,7 +3,23 @@ import { Parser } from "xml2js";
 const parser = new Parser();
 import { promisify } from "util";
 const parseString = promisify<string, ScanCapsData>(parser.parseString);
-export interface ScanCapsData {}
+
+export interface ScanCapsData {
+  ScanCaps: {
+    Platen: {
+      InputSourceCaps: {
+        MaxWidth: number;
+        MaxHeight: number;
+      }[];
+    }[];
+    Adf: {
+      InputSourceCaps: {
+        MaxWidth: number;
+        MaxHeight: number;
+      }[];
+    }[];
+  };
+}
 
 export default class ScanCaps {
   private readonly data: ScanCapsData;
@@ -16,4 +32,30 @@ export default class ScanCaps {
     const parsed = await parseString(content);
     return new ScanCaps(parsed);
   }
+
+  get PlatenMaxWidth(): number | null {
+    return (
+      this.data["ScanCaps"]["Platen"][0]["InputSourceCaps"][0]["MaxWidth"] ||
+      null
+    );
+  }
+
+  get PlatenMaxHeight(): number | null {
+    return (
+      this.data["ScanCaps"]["Platen"][0]["InputSourceCaps"][0]["MaxHeight"] ||
+      null
+    );
+  }
+
+  get AdfMaxWidth(): number | null {
+    return (
+      this.data["ScanCaps"]["Adf"][0]["InputSourceCaps"][0]["MaxWidth"] || null
+    );
+  }
+
+  get AdfMaxHeight(): number | null {
+    return (
+      this.data["ScanCaps"]["Adf"][0]["InputSourceCaps"][0]["MaxHeight"] || null
+    );
+  }
 }
diff --git a/src/ScanJobSettings.ts b/src/ScanJobSettings.ts
@@ -5,17 +5,23 @@ export default class ScanJobSettings {
   private readonly inputSource: "Adf" | "Platen";
   private readonly contentType: "Document" | "Photo";
   private readonly resolution: number;
+  private readonly width: number | null;
+  private readonly height: number | null;
   private readonly isDuplex: boolean;
 
   constructor(
     inputSource: "Adf" | "Platen",
     contentType: "Document" | "Photo",
     resolution: number,
+    width: number | null,
+    height: number | null,
     isDuplex: boolean,
   ) {
     this.inputSource = inputSource;
     this.contentType = contentType;
     this.resolution = resolution;
+    this.width = width;
+    this.height = height;
     this.isDuplex = isDuplex;
   }
 
@@ -25,7 +31,7 @@ export default class ScanJobSettings {
       '<ScanSettings xmlns="http://www.hp.com/schemas/imaging/con/cnx/scan/2008/08/19" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.hp.com/schemas/imaging/con/cnx/scan/2008/08/19 Scan Schema - 0.26.xsd">\n' +
       "\t<XResolution>200</XResolution>\n" +
       "\t<YResolution>200</YResolution>\n" +
-      "\t<XStart>33</XStart>\n" +
+      "\t<XStart>0</XStart>\n" +
       "\t<YStart>0</YStart>\n" +
       "\t<Width>2481</Width>\n" +
       "\t<Height>3507</Height>\n" +
@@ -53,6 +59,14 @@ export default class ScanJobSettings {
     parsed.ScanSettings.XResolution[0] = this.resolution;
     parsed.ScanSettings.YResolution[0] = this.resolution;
 
+    if (this.width !== null) {
+      parsed.ScanSettings.Width = this.width;
+    }
+
+    if (this.height !== null) {
+      parsed.ScanSettings.Height = this.height;
+    }
+
     parsed.ScanSettings.InputSource[0] = this.inputSource;
     if (this.inputSource === "Adf" && this.isDuplex) {
       parsed.ScanSettings["AdfOptions"] = [{ AdfOption: ["Duplex"] }];

diff --git a/src/index.ts b/src/index.ts
@@ -108,6 +108,8 @@ async function adfAutoscanCmd(
   );
   console.log(`Temp folder: ${tempFolder}`);
 
+  const deviceCapabilities = await readDeviceCapabilities();
+
   let scanCount = 0;
   let keepActive = true;
   let errorCount = 0;
@@ -123,7 +125,13 @@ async function adfAutoscanCmd(
 
       console.log(`Scan event captured, saving scan #${scanCount}`);
 
-      await scanFromAdf(scanCount, folder, tempFolder, adfAutoScanConfig);
+      await scanFromAdf(
+        scanCount,
+        folder,
+        tempFolder,
+        adfAutoScanConfig,
+        deviceCapabilities,
+      );
     } catch (e) {
       console.log(e);
       if (await HPApi.isAlive()) {
@@ -204,6 +212,14 @@ function setupScanParameters(command: Command): Command {
     "-r, --resolution <dpi>",
     "Resolution in DPI of the scans (default: 200)",
   );
+  command.option(
+    "-w, --width <width>",
+    "With in pixel of the scans (default: 2481)",
+  );
+  command.option(
+    "-h, --height <height>",
+    "Height in pixel of the scans (default: 3507)",
+  );
   return command;
 }
 
@@ -253,11 +269,33 @@ function getScanConfiguration(parentOption: OptionValues) {
     filePattern: parentOption.pattern || getConfig("pattern"),
   };
 
+  const configWidth = (
+    parentOption.width ||
+    getConfig("width") ||
+    0
+  ).toString();
+  const width =
+    configWidth.toLowerCase() === "max"
+      ? Number.MAX_SAFE_INTEGER
+      : parseInt(configWidth, 10);
+
+  const configHeight = (
+    parentOption.width ||
+    getConfig("height") ||
+    "0"
+  ).toString();
+  const height =
+    configWidth.toLowerCase() === "max"
+      ? Number.MAX_SAFE_INTEGER
+      : parseInt(configHeight, 10);
+
   const scanConfig: ScanConfig = {
     resolution: parseInt(
-      parentOption.resolution || getConfig("resolution") || 200,
+      parentOption.resolution || getConfig("resolution") || "200",
       10,
     ),
+    width: width,
+    height: height,
     directoryConfig,
   };
   return scanConfig;

diff --git a/src/readDeviceCapabilities.ts b/src/readDeviceCapabilities.ts
@@ -1,6 +1,7 @@
 import { DeviceCapabilities } from "./DeviceCapabilities";
 import HPApi from "./HPApi";
 import WalkupScanToCompCaps from "./WalkupScanToCompCaps";
+import ScanCaps from "./ScanCaps";
 
 export async function readDeviceCapabilities(): Promise<DeviceCapabilities> {
   let supportsMultiItemScanFromPlaten = true;
@@ -30,17 +31,22 @@ export async function readDeviceCapabilities(): Promise<DeviceCapabilities> {
     console.log("Unknown device!");
   }
 
+  let scanCaps: ScanCaps | null = null;
   if (discoveryTree.ScanJobManifestURI != null) {
     const scanJobManifest = await HPApi.getScanJobManifest(
       discoveryTree.ScanJobManifestURI,
     );
     if (scanJobManifest.ScanCapsURI != null) {
-      await HPApi.getScanCaps(scanJobManifest.ScanCapsURI);
+      scanCaps = await HPApi.getScanCaps(scanJobManifest.ScanCapsURI);
     }
   }
 
   return {
     supportsMultiItemScanFromPlaten,
     useWalkupScanToComp: walkupScanToCompCaps != null,
+    platenMaxWidth: scanCaps?.PlatenMaxWidth || null,
+    platenMaxHeight: scanCaps?.PlatenMaxHeight || null,
+    adfMaxWidth: scanCaps?.AdfMaxWidth || null,
+    adfMaxHeight: scanCaps?.AdfMaxHeight || null,
   };
 }
diff --git a/src/scanProcessing.ts b/src/scanProcessing.ts
@@ -350,6 +350,48 @@ function isPdf(
   }
 }
 
+export function getScanWidth(
+  scanConfig: ScanConfig,
+  inputSource: "Adf" | "Platen",
+  deviceCapabilities: DeviceCapabilities,
+) {
+  if (scanConfig.width && scanConfig.width > 0) {
+    const maxWidth =
+      inputSource === "Adf"
+        ? deviceCapabilities.adfMaxWidth
+        : deviceCapabilities.platenMaxWidth;
+
+    if (maxWidth && scanConfig.width > maxWidth) {
+      return maxWidth;
+    } else {
+      return scanConfig.width;
+    }
+  } else {
+    return null;
+  }
+}
+
+export function getScanHeight(
+  scanConfig: ScanConfig,
+  inputSource: "Adf" | "Platen",
+  deviceCapabilities: DeviceCapabilities,
+) {
+  if (scanConfig.height && scanConfig.height > 0) {
+    const maxHeight =
+      inputSource === "Adf"
+        ? deviceCapabilities.adfMaxHeight
+        : deviceCapabilities.platenMaxHeight;
+
+    if (maxHeight && scanConfig.height > maxHeight) {
+      return maxHeight;
+    } else {
+      return scanConfig.height;
+    }
+  } else {
+    return null;
+  }
+}
+
 export async function saveScan(
   event: Event,
   folder: string,
@@ -396,11 +438,15 @@ export async function saveScan(
   console.log("Afd is : " + scanStatus.adfState);
 
   const inputSource = scanStatus.getInputSource();
+  const scanWidth = getScanWidth(scanConfig, inputSource, deviceCapabilities);
+  const scanHeight = getScanHeight(scanConfig, inputSource, deviceCapabilities);
 
   const scanJobSettings = new ScanJobSettings(
     inputSource,
     contentType,
     scanConfig.resolution,
+    scanWidth,
+    scanHeight,
     isDuplex,
   );
 
@@ -441,6 +487,8 @@ export type DirectoryConfig = {
 };
 export type ScanConfig = {
   resolution: number;
+  width: number | null;
+  height: number | null;
   directoryConfig: DirectoryConfig;
 };
 export type AdfAutoScanConfig = ScanConfig & {
@@ -455,6 +503,7 @@ export async function scanFromAdf(
   folder: string,
   tempFolder: string,
   adfAutoScanConfig: AdfAutoScanConfig,
+  deviceCapabilities: DeviceCapabilities,
 ) {
   let destinationFolder: string;
   let contentType: "Document" | "Photo";
@@ -469,10 +518,19 @@ export async function scanFromAdf(
     destinationFolder = folder;
   }
 
+  const scanWidth = getScanWidth(adfAutoScanConfig, "Adf", deviceCapabilities);
+  const scanHeight = getScanHeight(
+    adfAutoScanConfig,
+    "Adf",
+    deviceCapabilities,
+  );
+
   const scanJobSettings = new ScanJobSettings(
     "Adf",
     contentType,
     adfAutoScanConfig.resolution,
+    scanWidth,
+    scanHeight,
     adfAutoScanConfig.isDuplex,
   );
 

diff --git a/test/ScanJobSettings.test.ts b/test/ScanJobSettings.test.ts
@@ -7,7 +7,7 @@ import * as fs from "fs/promises";
 describe("ScanJobSettings", () => {
   describe("toXML",  () => {
     it("Allows to describe an ADF two side", async () => {
-      const scanJobSettings = new ScanJobSettings("Adf", "Document", 200, true);
+      const scanJobSettings = new ScanJobSettings("Adf", "Document", 200, null, null, true);
 
       const content: string = await fs.readFile(
         path.resolve(__dirname, "./asset/adf_duplex_job.xml"), {encoding:'utf8' }
@@ -16,7 +16,7 @@ describe("ScanJobSettings", () => {
     });
 
     it("Allows to describe an ADF single side", async () => {
-      const scanJobSettings = new ScanJobSettings("Adf", "Document", 200, false);
+      const scanJobSettings = new ScanJobSettings("Adf", "Document", 200, null, null, false);
 
       const content: string = await fs.readFile(
         path.resolve(__dirname, "./asset/adf_simplex_job.xml"), {encoding:'utf8' }
@@ -25,12 +25,21 @@ describe("ScanJobSettings", () => {
     });
 
     it("Allows to describe dpi of 300", async () => {
-      const scanJobSettings = new ScanJobSettings("Adf", "Document", 300, false);
+      const scanJobSettings = new ScanJobSettings("Adf", "Document", 300, null, null, false);
 
       const content: string = await fs.readFile(
         path.resolve(__dirname, "./asset/300_dpi_job.xml"), {encoding:'utf8' }
       );
       expect((await scanJobSettings.toXML()).trimEnd()).to.be.eq(content.trimEnd().replace(/\r\n/g, "\n"));
     });
+
+    it ("Allows to describe a custom width and height", async () => {
+      const scanJobSettings = new ScanJobSettings("Adf", "Document", 200, 1000, 4000, false);
+
+      const content: string = await fs.readFile(
+        path.resolve(__dirname, "./asset/adf_simplex_custom_job.xml"), {encoding:'utf8' }
+      );
+      expect((await scanJobSettings.toXML()).trimEnd()).to.be.eq(content.trimEnd().replace(/\r\n/g, "\n"));
+    })
   });
 });
diff --git a/test/asset/300_dpi_job.xml b/test/asset/300_dpi_job.xml
@@ -2,7 +2,7 @@
 <ScanSettings xmlns="http://www.hp.com/schemas/imaging/con/cnx/scan/2008/08/19" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.hp.com/schemas/imaging/con/cnx/scan/2008/08/19 Scan Schema - 0.26.xsd">
 	<XResolution>300</XResolution>
 	<YResolution>300</YResolution>
-	<XStart>33</XStart>
+	<XStart>0</XStart>
 	<YStart>0</YStart>
 	<Width>2481</Width>
 	<Height>3507</Height>

diff --git a/test/asset/adf_duplex_job.xml b/test/asset/adf_duplex_job.xml
@@ -2,7 +2,7 @@
 <ScanSettings xmlns="http://www.hp.com/schemas/imaging/con/cnx/scan/2008/08/19" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.hp.com/schemas/imaging/con/cnx/scan/2008/08/19 Scan Schema - 0.26.xsd">
 	<XResolution>200</XResolution>
 	<YResolution>200</YResolution>
-	<XStart>33</XStart>
+	<XStart>0</XStart>
 	<YStart>0</YStart>
 	<Width>2481</Width>
 	<Height>3507</Height>