@xterm/addon-image 0.7.0-beta.1

package/out/SixelHandler.js

@@ -0,0 +1,140 @@
+"use strict";
+/**
+ * Copyright (c) 2020, 2023 The xterm.js authors. All rights reserved.
+ * @license MIT
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SixelHandler = void 0;
+const Colors_1 = require("sixel/lib/Colors");
+const ImageRenderer_1 = require("./ImageRenderer");
+const Decoder_1 = require("sixel/lib/Decoder");
+// always free decoder ressources after decoding if it exceeds this limit
+const MEM_PERMA_LIMIT = 4194304; // 1024 pixels * 1024 pixels * 4 channels = 4MB
+// custom default palette: VT340 (lower 16 colors) + ANSI256 (up to 256) + zeroed (up to 4096)
+const DEFAULT_PALETTE = Colors_1.PALETTE_ANSI_256;
+DEFAULT_PALETTE.set(Colors_1.PALETTE_VT340_COLOR);
+class SixelHandler {
+    constructor(_opts, _storage, _coreTerminal) {
+        this._opts = _opts;
+        this._storage = _storage;
+        this._coreTerminal = _coreTerminal;
+        this._size = 0;
+        this._aborted = false;
+        (0, Decoder_1.DecoderAsync)({
+            memoryLimit: this._opts.pixelLimit * 4,
+            palette: DEFAULT_PALETTE,
+            paletteLimit: this._opts.sixelPaletteLimit
+        }).then(d => this._dec = d);
+    }
+    reset() {
+        /**
+         * reset sixel decoder to defaults:
+         * - release all memory
+         * - nullify palette (4096)
+         * - apply default palette (256)
+         */
+        if (this._dec) {
+            this._dec.release();
+            // FIXME: missing interface on decoder to nullify full palette
+            this._dec._palette.fill(0);
+            this._dec.init(0, DEFAULT_PALETTE, this._opts.sixelPaletteLimit);
+        }
+    }
+    hook(params) {
+        var _a;
+        this._size = 0;
+        this._aborted = false;
+        if (this._dec) {
+            const fillColor = params.params[1] === 1 ? 0 : extractActiveBg(this._coreTerminal._core._inputHandler._curAttrData, (_a = this._coreTerminal._core._themeService) === null || _a === void 0 ? void 0 : _a.colors);
+            this._dec.init(fillColor, null, this._opts.sixelPaletteLimit);
+        }
+    }
+    put(data, start, end) {
+        if (this._aborted || !this._dec) {
+            return;
+        }
+        this._size += end - start;
+        if (this._size > this._opts.sixelSizeLimit) {
+            console.warn(`SIXEL: too much data, aborting`);
+            this._aborted = true;
+            this._dec.release();
+            return;
+        }
+        try {
+            this._dec.decode(data, start, end);
+        }
+        catch (e) {
+            console.warn(`SIXEL: error while decoding image - ${e}`);
+            this._aborted = true;
+            this._dec.release();
+        }
+    }
+    unhook(success) {
+        var _a;
+        if (this._aborted || !success || !this._dec) {
+            return true;
+        }
+        const width = this._dec.width;
+        const height = this._dec.height;
+        // partial fix for https://github.com/jerch/xterm-addon-image/issues/37
+        if (!width || !height) {
+            if (height) {
+                this._storage.advanceCursor(height);
+            }
+            return true;
+        }
+        const canvas = ImageRenderer_1.ImageRenderer.createCanvas(undefined, width, height);
+        (_a = canvas.getContext('2d')) === null || _a === void 0 ? void 0 : _a.putImageData(new ImageData(this._dec.data8, width, height), 0, 0);
+        if (this._dec.memoryUsage > MEM_PERMA_LIMIT) {
+            this._dec.release();
+        }
+        this._storage.addImage(canvas);
+        return true;
+    }
+}
+exports.SixelHandler = SixelHandler;
+/**
+ * Some helpers to extract current terminal colors.
+ */
+// get currently active background color from terminal
+// also respect INVERSE setting
+function extractActiveBg(attr, colors) {
+    let bg = 0;
+    if (!colors) {
+        // FIXME: theme service is prolly not available yet,
+        // happens if .open() was not called yet (bug in core?)
+        return bg;
+    }
+    if (attr.isInverse()) {
+        if (attr.isFgDefault()) {
+            bg = convertLe(colors.foreground.rgba);
+        }
+        else if (attr.isFgRGB()) {
+            const t = attr.constructor.toColorRGB(attr.getFgColor());
+            bg = (0, Colors_1.toRGBA8888)(...t);
+        }
+        else {
+            bg = convertLe(colors.ansi[attr.getFgColor()].rgba);
+        }
+    }
+    else {
+        if (attr.isBgDefault()) {
+            bg = convertLe(colors.background.rgba);
+        }
+        else if (attr.isBgRGB()) {
+            const t = attr.constructor.toColorRGB(attr.getBgColor());
+            bg = (0, Colors_1.toRGBA8888)(...t);
+        }
+        else {
+            bg = convertLe(colors.ansi[attr.getBgColor()].rgba);
+        }
+    }
+    return bg;
+}
+// rgba values on the color managers are always in BE, thus convert to LE
+function convertLe(color) {
+    if (Colors_1.BIG_ENDIAN)
+        return color;
+    return (color & 0xFF) << 24 | (color >>> 8 & 0xFF) << 16 | (color >>> 16 & 0xFF) << 8 | color >>> 24 & 0xFF;
+}
+//# sourceMappingURL=SixelHandler.js.map

package/out/SixelHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SixelHandler.js","sourceRoot":"","sources":["../src/SixelHandler.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,6CAAiG;AAEjG,mDAAgD;AAEhD,+CAA0D;AAE1D,yEAAyE;AACzE,MAAM,eAAe,GAAG,OAAO,CAAC,CAAC,+CAA+C;AAEhF,8FAA8F;AAC9F,MAAM,eAAe,GAAG,yBAAgB,CAAC;AACzC,eAAe,CAAC,GAAG,CAAC,4BAAmB,CAAC,CAAC;AAGzC,MAAa,YAAY;IAKvB,YACmB,KAAyB,EACzB,QAAsB,EACtB,aAA2B;QAF3B,UAAK,GAAL,KAAK,CAAoB;QACzB,aAAQ,GAAR,QAAQ,CAAc;QACtB,kBAAa,GAAb,aAAa,CAAc;QAPtC,UAAK,GAAG,CAAC,CAAC;QACV,aAAQ,GAAG,KAAK,CAAC;QAQvB,IAAA,sBAAY,EAAC;YACX,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,CAAC;YACtC,OAAO,EAAE,eAAe;YACxB,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,iBAAiB;SAC3C,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC;IAC9B,CAAC;IAEM,KAAK;QACV;;;;;WAKG;QACH,IAAI,IAAI,CAAC,IAAI,EAAE;YACb,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YACpB,8DAA8D;YAC7D,IAAI,CAAC,IAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACpC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,eAAe,EAAE,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;SAClE;IACH,CAAC;IAEM,IAAI,CAAC,MAAe;;QACzB,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QACf,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,IAAI,IAAI,CAAC,IAAI,EAAE;YACb,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe,CAC5D,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,YAAY,EACnD,MAAA,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,aAAa,0CAAE,MAAM,CAAC,CAAC;YAClD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;SAC/D;IACH,CAAC;IAEM,GAAG,CAAC,IAAiB,EAAE,KAAa,EAAE,GAAW;QACtD,IAAI,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YAC/B,OAAO;SACR;QACD,IAAI,CAAC,KAAK,IAAI,GAAG,GAAG,KAAK,CAAC;QAC1B,IAAI,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE;YAC1C,OAAO,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;YAC/C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACrB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YACpB,OAAO;SACR;QACD,IAAI;YACF,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;SACpC;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,CAAC,IAAI,CAAC,uCAAuC,CAAC,EAAE,CAAC,CAAC;YACzD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACrB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;SACrB;IACH,CAAC;IAEM,MAAM,CAAC,OAAgB;;QAC5B,IAAI,IAAI,CAAC,QAAQ,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YAC3C,OAAO,IAAI,CAAC;SACb;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;QAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;QAEhC,uEAAuE;QACvE,IAAI,CAAC,KAAK,IAAI,CAAE,MAAM,EAAE;YACtB,IAAI,MAAM,EAAE;gBACV,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;aACrC;YACD,OAAO,IAAI,CAAC;SACb;QAED,MAAM,MAAM,GAAG,6BAAa,CAAC,YAAY,CAAC,SAAS,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;QACpE,MAAA,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,0CAAE,YAAY,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3F,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,eAAe,EAAE;YAC3C,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;SACrB;QACD,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAvFD,oCAuFC;AAGD;;GAEG;AAEH,sDAAsD;AACtD,+BAA+B;AAC/B,SAAS,eAAe,CAAC,IAAmB,EAAE,MAAoC;IAChF,IAAI,EAAE,GAAG,CAAC,CAAC;IACX,IAAI,CAAC,MAAM,EAAE;QACX,oDAAoD;QACpD,uDAAuD;QACvD,OAAO,EAAE,CAAC;KACX;IACD,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE;QACpB,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE;YACtB,EAAE,GAAG,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;SACxC;aAAM,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE;YACzB,MAAM,CAAC,GAAI,IAAI,CAAC,WAAoC,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;YACnF,EAAE,GAAG,IAAA,mBAAU,EAAC,GAAG,CAAC,CAAC,CAAC;SACvB;aAAM;YACL,EAAE,GAAG,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;SACrD;KACF;SAAM;QACL,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE;YACtB,EAAE,GAAG,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;SACxC;aAAM,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE;YACzB,MAAM,CAAC,GAAI,IAAI,CAAC,WAAoC,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;YACnF,EAAE,GAAG,IAAA,mBAAU,EAAC,GAAG,CAAC,CAAC,CAAC;SACvB;aAAM;YACL,EAAE,GAAG,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;SACrD;KACF;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,yEAAyE;AACzE,SAAS,SAAS,CAAC,KAAa;IAC9B,IAAI,mBAAU;QAAE,OAAO,KAAK,CAAC;IAC7B,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,KAAK,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,KAAK,KAAK,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,KAAK,EAAE,GAAG,IAAI,CAAC;AAC9G,CAAC"}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@xterm/addon-image",
+  "version": "0.7.0-beta.1",
+  "author": {
+    "name": "The xterm.js authors",
+    "url": "https://xtermjs.org/"
+  },
+  "main": "lib/addon-image.js",
+  "types": "typings/addon-image.d.ts",
+  "repository": "https://github.com/xtermjs/xterm.js/tree/master/addons/addon-image",
+  "license": "MIT",
+  "keywords": [
+    "terminal",
+    "image",
+    "sixel",
+    "xterm",
+    "xterm.js"
+  ],
+  "scripts": {
+    "prepackage": "../../node_modules/.bin/tsc -p .",
+    "package": "../../node_modules/.bin/webpack",
+    "prepublishOnly": "npm run package"
+  },
+  "peerDependencies": {
+    "@xterm/xterm": "^5.2.0"
+  },
+  "devDependencies": {
+    "sixel": "^0.16.0",
+    "xterm-wasm-parts": "^0.1.0"
+  }
+}

package/src/IIPHandler.ts

@@ -0,0 +1,161 @@
+/**
+ * Copyright (c) 2023 The xterm.js authors. All rights reserved.
+ * @license MIT
+ */
+import { IImageAddonOptions, IOscHandler, IResetHandler, ITerminalExt } from './Types';
+import { ImageRenderer } from './ImageRenderer';
+import { ImageStorage, CELL_SIZE_DEFAULT } from './ImageStorage';
+import Base64Decoder from 'xterm-wasm-parts/lib/base64/Base64Decoder.wasm';
+import { HeaderParser, IHeaderFields, HeaderState } from './IIPHeaderParser';
+import { imageType, UNSUPPORTED_TYPE } from './IIPMetrics';
+
+
+// eslint-disable-next-line
+declare const Buffer: any;
+
+// limit hold memory in base64 decoder
+const KEEP_DATA = 4194304;
+
+// default IIP header values
+const DEFAULT_HEADER: IHeaderFields = {
+  name: 'Unnamed file',
+  size: 0,
+  width: 'auto',
+  height: 'auto',
+  preserveAspectRatio: 1,
+  inline: 0
+};
+
+
+export class IIPHandler implements IOscHandler, IResetHandler {
+  private _aborted = false;
+  private _hp = new HeaderParser();
+  private _header: IHeaderFields = DEFAULT_HEADER;
+  private _dec = new Base64Decoder(KEEP_DATA);
+  private _metrics = UNSUPPORTED_TYPE;
+
+  constructor(
+    private readonly _opts: IImageAddonOptions,
+    private readonly _renderer: ImageRenderer,
+    private readonly _storage: ImageStorage,
+    private readonly _coreTerminal: ITerminalExt
+  ) {}
+
+  public reset(): void {}
+
+  public start(): void {
+    this._aborted = false;
+    this._header = DEFAULT_HEADER;
+    this._metrics  = UNSUPPORTED_TYPE;
+    this._hp.reset();
+  }
+
+  public put(data: Uint32Array, start: number, end: number): void {
+    if (this._aborted) return;
+
+    if (this._hp.state === HeaderState.END) {
+      if (this._dec.put(data, start, end)) {
+        this._dec.release();
+        this._aborted = true;
+      }
+    } else {
+      const dataPos = this._hp.parse(data, start, end);
+      if (dataPos === -1) {
+        this._aborted = true;
+        return;
+      }
+      if (dataPos > 0) {
+        this._header = Object.assign({}, DEFAULT_HEADER, this._hp.fields);
+        if (!this._header.inline || !this._header.size || this._header.size > this._opts.iipSizeLimit) {
+          this._aborted = true;
+          return;
+        }
+        this._dec.init(this._header.size);
+        if (this._dec.put(data, dataPos, end)) {
+          this._dec.release();
+          this._aborted = true;
+        }
+      }
+    }
+  }
+
+  public end(success: boolean): boolean | Promise<boolean> {
+    if (this._aborted) return true;
+
+    let w = 0;
+    let h = 0;
+
+    // early exit condition chain
+    let cond: number | boolean = true;
+    if (cond = success) {
+      if (cond = !this._dec.end()) {
+        this._metrics = imageType(this._dec.data8);
+        if (cond = this._metrics.mime !== 'unsupported') {
+          w = this._metrics.width;
+          h = this._metrics.height;
+          if (cond = w && h && w * h < this._opts.pixelLimit) {
+            [w, h] = this._resize(w, h).map(Math.floor);
+            cond = w && h && w * h < this._opts.pixelLimit;
+          }
+        }
+      }
+    }
+    if (!cond) {
+      this._dec.release();
+      return true;
+    }
+
+    const blob = new Blob([this._dec.data8], { type: this._metrics.mime });
+    this._dec.release();
+
+    if (!window.createImageBitmap) {
+      const url = URL.createObjectURL(blob);
+      const img = new Image();
+      return new Promise<boolean>(r => {
+        img.addEventListener('load', () => {
+          URL.revokeObjectURL(url);
+          const canvas = ImageRenderer.createCanvas(window.document, w, h);
+          canvas.getContext('2d')?.drawImage(img, 0, 0, w, h);
+          this._storage.addImage(canvas);
+          r(true);
+        });
+        img.src = url;
+        // sanity measure to avoid terminal blocking from dangling promise
+        // happens from corrupt data (onload never gets fired)
+        setTimeout(() => r(true), 1000);
+      });
+    }
+    return createImageBitmap(blob, { resizeWidth: w, resizeHeight: h })
+      .then(bm => {
+        this._storage.addImage(bm);
+        return true;
+      });
+  }
+
+  private _resize(w: number, h: number): [number, number] {
+    const cw = this._renderer.dimensions?.css.cell.width || CELL_SIZE_DEFAULT.width;
+    const ch = this._renderer.dimensions?.css.cell.height || CELL_SIZE_DEFAULT.height;
+    const width = this._renderer.dimensions?.css.canvas.width || cw * this._coreTerminal.cols;
+    const height = this._renderer.dimensions?.css.canvas.height || ch * this._coreTerminal.rows;
+
+    const rw = this._dim(this._header.width!, width, cw);
+    const rh = this._dim(this._header.height!, height, ch);
+    if (!rw && !rh) {
+      const wf = width / w;         // TODO: should this respect initial cursor offset?
+      const hf = (height - ch) / h; // TODO: fix offset issues from float cell height
+      const f = Math.min(wf, hf);
+      return f < 1 ? [w * f, h * f] : [w, h];
+    }
+    return !rw
+      ? [w * rh / h, rh]
+      : this._header.preserveAspectRatio || !rw || !rh
+        ? [rw, h * rw / w] : [rw, rh];
+  }
+
+  private _dim(s: string, total: number, cdim: number): number {
+    if (s === 'auto') return 0;
+    if (s.endsWith('%')) return parseInt(s.slice(0, -1)) * total / 100;
+    if (s.endsWith('px')) return parseInt(s.slice(0, -2));
+    return parseInt(s) * cdim;
+  }
+}

package/src/IIPHeaderParser.test.ts

@@ -0,0 +1,138 @@
+/**
+ * Copyright (c) 2023 The xterm.js authors. All rights reserved.
+ * @license MIT
+ */
+
+import { assert } from 'chai';
+import { HeaderParser, HeaderState, IHeaderFields } from './IIPHeaderParser';
+
+
+const CASES: [string, IHeaderFields][] = [
+  ['File=size=123456;name=dGVzdA==:', {name: 'test', size: 123456}],
+  ['File=size=123456;name=dGVzdA:', {name: 'test', size: 123456}],
+  // utf-8 encoding in name
+  ['File=size=123456;name=w7xtbMOkdXTDnw==:', {name: 'ümläutß', size: 123456}],
+  ['File=size=123456;name=w7xtbMOkdXTDnw:', {name: 'ümläutß', size: 123456}],
+  // full header spec
+  [
+    'File=inline=1;width=10px;height=20%;preserveAspectRatio=1;size=123456;name=w7xtbMOkdXTDnw:',
+    {
+      inline: 1,
+      width: '10px',
+      height: '20%',
+      preserveAspectRatio: 1,
+      size: 123456,
+      name: 'ümläutß'
+    }
+  ],
+  [
+    'File=inline=1;width=auto;height=20;preserveAspectRatio=1;size=123456;name=w7xtbMOkdXTDnw:',
+    {
+      inline: 1,
+      width: 'auto',
+      height: '20',
+      preserveAspectRatio: 1,
+      size: 123456,
+      name: 'ümläutß'
+    }
+  ]
+];
+
+function fromBs(bs: string): Uint32Array {
+  const r = new Uint32Array(bs.length);
+  for (let i = 0; i < r.length; ++i) r[i] = bs.charCodeAt(i);
+  return r;
+}
+
+describe('IIPHeaderParser', () => {
+  it('at once', () => {
+    const hp = new HeaderParser();
+    for (const example of CASES) {
+      hp.reset();
+      const inp = fromBs(example[0]);
+      const res = hp.parse(inp, 0, inp.length);
+      assert.strictEqual(res, inp.length);
+      assert.strictEqual(hp.state, HeaderState.END);
+      assert.deepEqual(hp.fields, example[1]);
+    }
+  });
+  it('bytewise', () => {
+    const hp = new HeaderParser();
+    for (const example of CASES) {
+      hp.reset();
+      const inp = fromBs(example[0]);
+      let pos = 0;
+      let res = -2;
+      while (res === -2 && pos < inp.length) {
+        res = hp.parse(new Uint32Array([inp[pos++]]), 0, 1);
+      }
+      assert.strictEqual(res, 1);
+      assert.strictEqual(hp.state, HeaderState.END);
+      assert.deepEqual(hp.fields, example[1]);
+    }
+  });
+  it('no File= starter', () => {
+    const hp = new HeaderParser();
+    let inp = fromBs('size=123456;name=dGVzdA==:');
+    let res = hp.parse(inp, 0, inp.length);
+    assert.strictEqual(res, -1);
+    hp.reset();
+    inp = fromBs(CASES[0][0]);
+    res = hp.parse(inp, 0, inp.length);
+    assert.strictEqual(res, inp.length);
+    assert.strictEqual(hp.state, HeaderState.END);
+    assert.deepEqual(hp.fields, CASES[0][1]);
+  });
+  it('empty key - error', () => {
+    const hp = new HeaderParser();
+    let inp = fromBs('File=size=123456;=dGVzdA==:');
+    let res = hp.parse(inp, 0, inp.length);
+    assert.strictEqual(res, -1);
+    hp.reset();
+    inp = fromBs(CASES[0][0]);
+    res = hp.parse(inp, 0, inp.length);
+    assert.strictEqual(res, inp.length);
+    assert.strictEqual(hp.state, HeaderState.END);
+    assert.deepEqual(hp.fields, CASES[0][1]);
+  });
+  it('empty size value - set to 0', () => {
+    const hp = new HeaderParser();
+    let inp = fromBs('File=size=;name=dGVzdA==:');
+    let res = hp.parse(inp, 0, inp.length);
+    assert.strictEqual(res, inp.length);
+    assert.strictEqual(hp.state, HeaderState.END);
+    assert.deepEqual(hp.fields, {name: 'test', size: 0});
+    hp.reset();
+    inp = fromBs(CASES[0][0]);
+    res = hp.parse(inp, 0, inp.length);
+    assert.strictEqual(res, inp.length);
+    assert.strictEqual(hp.state, HeaderState.END);
+    assert.deepEqual(hp.fields, CASES[0][1]);
+  });
+  it('empty name value - set to empty string', () => {
+    const hp = new HeaderParser();
+    let inp = fromBs('File=size=123456;name=:');
+    let res = hp.parse(inp, 0, inp.length);
+    assert.strictEqual(res, inp.length);
+    assert.strictEqual(hp.state, HeaderState.END);
+    assert.deepEqual(hp.fields, {name: '', size: 123456});
+    hp.reset();
+    inp = fromBs(CASES[0][0]);
+    res = hp.parse(inp, 0, inp.length);
+    assert.strictEqual(res, inp.length);
+    assert.strictEqual(hp.state, HeaderState.END);
+    assert.deepEqual(hp.fields, CASES[0][1]);
+  });
+  it('empty size value - error', () => {
+    const hp = new HeaderParser();
+    let inp = fromBs('File=inline=1;width=;height=20%;preserveAspectRatio=1;size=123456;name=w7xtbMOkdXTDnw:');
+    let res = hp.parse(inp, 0, inp.length);
+    assert.strictEqual(res, -1);
+    hp.reset();
+    inp = fromBs(CASES[0][0]);
+    res = hp.parse(inp, 0, inp.length);
+    assert.strictEqual(res, inp.length);
+    assert.strictEqual(hp.state, HeaderState.END);
+    assert.deepEqual(hp.fields, CASES[0][1]);
+  });
+});

package/src/IIPHeaderParser.ts

@@ -0,0 +1,186 @@
+/**
+ * Copyright (c) 2023 The xterm.js authors. All rights reserved.
+ * @license MIT
+ */
+
+// eslint-disable-next-line
+declare const Buffer: any;
+
+
+export interface IHeaderFields {
+  // base-64 encoded filename. Defaults to "Unnamed file".
+  name: string;
+  // File size in bytes. The file transfer will be canceled if this size is exceeded.
+  size: number;
+  /**
+   * Optional width and height to render:
+   * - N: N character cells.
+   * - Npx: N pixels.
+   * - N%: N percent of the session's width or height.
+   * - auto: The image's inherent size will be used to determine an appropriate dimension.
+   */
+  width?: string;
+  height?: string;
+  // Optional, defaults to 1 respecting aspect ratio (width takes precedence).
+  preserveAspectRatio?: number;
+  // Optional, defaults to 0. If set to 1, the file will be displayed inline, else downloaded
+  // (download not supported).
+  inline?: number;
+}
+
+export const enum HeaderState {
+  START = 0,
+  ABORT = 1,
+  KEY = 2,
+  VALUE = 3,
+  END = 4
+}
+
+// field value decoders
+
+// ASCII bytes to string
+function toStr(data: Uint32Array): string {
+  let s = '';
+  for (let i = 0; i < data.length; ++i) {
+    s += String.fromCharCode(data[i]);
+  }
+  return s;
+}
+
+// digits to integer
+function toInt(data: Uint32Array): number {
+  let v = 0;
+  for (let i = 0; i < data.length; ++i) {
+    if (data[i] < 48 || data[i] > 57) {
+      throw new Error('illegal char');
+    }
+    v = v * 10 + data[i] - 48;
+  }
+  return v;
+}
+
+// check for correct size entry
+function toSize(data: Uint32Array): string {
+  const v = toStr(data);
+  if (!v.match(/^((auto)|(\d+?((px)|(%)){0,1}))$/)) {
+    throw new Error('illegal size');
+  }
+  return v;
+}
+
+// name is base64 encoded utf-8
+function toName(data: Uint32Array): string {
+  if (typeof Buffer !== 'undefined') {
+    return Buffer.from(toStr(data), 'base64').toString();
+  }
+  const bs = atob(toStr(data));
+  const b = new Uint8Array(bs.length);
+  for (let i = 0; i < b.length; ++i) {
+    b[i] = bs.charCodeAt(i);
+  }
+  return new TextDecoder().decode(b);
+}
+
+const DECODERS: {[key: string]: (v: Uint32Array) => any} = {
+  inline: toInt,
+  size: toInt,
+  name: toName,
+  width: toSize,
+  height: toSize,
+  preserveAspectRatio: toInt
+};
+
+
+const FILE_MARKER = [70, 105, 108, 101];
+const MAX_FIELDCHARS = 1024;
+
+
+export class HeaderParser {
+  public state: HeaderState = HeaderState.START;
+  private _buffer = new Uint32Array(MAX_FIELDCHARS);
+  private _position = 0;
+  private _key = '';
+  public fields: {[key: string]: any} = {};
+
+  public reset(): void {
+    this._buffer.fill(0);
+    this.state = HeaderState.START;
+    this._position = 0;
+    this.fields = {};
+    this._key = '';
+  }
+
+  public parse(data: Uint32Array, start: number, end: number): number {
+    let state = this.state;
+    let pos = this._position;
+    const buffer = this._buffer;
+    if (state === HeaderState.ABORT || state === HeaderState.END) return -1;
+    if (state === HeaderState.START && pos > 6) return -1;
+    for (let i = start; i < end; ++i) {
+      const c = data[i];
+      switch (c) {
+        case 59: // ;
+          if (!this._storeValue(pos)) return this._a();
+          state = HeaderState.KEY;
+          pos = 0;
+          break;
+        case 61: // =
+          if (state === HeaderState.START) {
+            for (let k = 0; k < FILE_MARKER.length; ++k) {
+              if (buffer[k] !== FILE_MARKER[k]) return this._a();
+            }
+            state = HeaderState.KEY;
+            pos = 0;
+          } else if (state === HeaderState.KEY) {
+            if (!this._storeKey(pos)) return this._a();
+            state = HeaderState.VALUE;
+            pos = 0;
+          } else if (state === HeaderState.VALUE) {
+            if (pos >= MAX_FIELDCHARS) return this._a();
+            buffer[pos++] = c;
+          }
+          break;
+        case 58: // :
+          if (state === HeaderState.VALUE) {
+            if (!this._storeValue(pos)) return this._a();
+          }
+          this.state = HeaderState.END;
+          return i + 1;
+        default:
+          if (pos >= MAX_FIELDCHARS) return this._a();
+          buffer[pos++] = c;
+      }
+    }
+    this.state = state;
+    this._position = pos;
+    return -2;
+  }
+
+  private _a(): number {
+    this.state = HeaderState.ABORT;
+    return -1;
+  }
+
+  private _storeKey(pos: number): boolean {
+    const k = toStr(this._buffer.subarray(0, pos));
+    if (k) {
+      this._key = k;
+      this.fields[k] = null;
+      return true;
+    }
+    return false;
+  }
+
+  private _storeValue(pos: number): boolean {
+    if (this._key) {
+      try {
+        const v = this._buffer.slice(0, pos);
+        this.fields[this._key] = DECODERS[this._key] ? DECODERS[this._key](v) : v;
+      } catch (e) {
+        return false;
+      }
+      return true;
+    }
+    return false;
+  }
+}