xbrz-js 1.0.0

package/README.md

@@ -0,0 +1,69 @@
+xBRZ JavaScript version
+=======================
+
+xBRZ: "Scale by rules" - high quality pixel art upscaling by Zenju
+
+Notes
+* Original code is GPL3 licensed, the same license may apply here
+* Currently updated to xBRZ v1.9
+* Some code semi-automatically converted to JavaScript by Codex (AI)
+* Only tested with `xbrzColorFormat.argb` (expects in-memory byte order of `R, G, B, A` or `B, G, R, A`)
+
+<img src="./test/test-in.png">
+<img src="./test/test-out.png">
+
+## API
+```ts
+enum xbrzColorFormat {
+  argb,
+};
+
+type XbrzConfig = {
+  equalColorTolerance: number;
+  centerDirectionBias: number;
+  steepDirectionThreshold: number;
+  dominantDirectionThreshold: number;
+};
+function xbrzConfig(opts?: Partial<XbrzConfig>): XbrzConfig;
+
+function xbrzScale(
+  scale: number,
+  src: Uint32Array,
+  dst: Uint32Array,
+  width: number,
+  height: number,
+  colorFormat: xbrzColorFormat,
+  config?: XbrzConfig,
+): void;
+```
+
+## Example usage
+
+```js
+const { xbrzScale, xbrzColorFormat, xbrzConfig } = require('xbrz');
+
+let config = xbrzConfig({
+  // these are the defaults, xbrzConfig({}) or null would work as well
+  equalColorTolerance: 30,
+  centerDirectionBias: 4,
+  steepDirectionThreshold: 2.4,
+  dominantDirectionThreshold: 3.6,
+});
+
+let src = new Uint32Array([
+  // White on black "x"
+  0xFFFFFFFF, 0x000000FF, 0xFFFFFFFF,
+  0x000000FF, 0xFFFFFFFF, 0x000000FF,
+  0xFFFFFFFF, 0x000000FF, 0xFFFFFFFF,
+]);
+
+let scale = 6;
+let dst = new Uint32Array(3*scale * 3*scale);
+xbrzScale(scale, src, dst, 3, 3, xbrzColorFormat.argb, config);
+```
+
+See [test/test.js](test/test.js) for an example including reading and writing from a PNG file.
+
+## Links
+
+https://sourceforge.net/projects/xbrz/

package/lib.js

@@ -0,0 +1,9 @@
+const { ScalerCfgDefault } = require('./src/xbrz_config.js');
+exports.xbrzScale = require('./src/xbrz.js').xbrzScale;
+exports.xbrzConfig = function (params) {
+  return {
+    ...ScalerCfgDefault,
+    ...params,
+  };
+}
+exports.xbrzColorFormat = require('./src/xbrz_h.js').ColorFormat;

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "xbrz-js",
+  "version": "1.0.0",
+  "descript": "xBRZ - Scale by rules - pure JS implementation of high quality pixel art upscaling by Zenju",
+  "main": "lib.js",
+  "keywords": [
+    "xbrz",
+    "pixel",
+    "upscale"
+  ],
+  "author": "Jimb Esser (https://github.com/Jimbly)",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Jimbly/xbrz-js.git"
+  },
+  "license": "GPL3"
+}