@texel/color 1.0.4 → 1.0.6

package/README.md

@@ -85,7 +85,7 @@ The return value is the new coordinates in the destination space; such as `[r,g,
 
 #### `output = gamutMapOKLCH(oklch, gamut = sRGBGamut, targetSpace = gamut.space, out = [0, 0, 0], mapping = MapToCuspL, [cusp])`
 
-Performs fast gamut mapping in OKLCH as [described by Björn Ottoson](https://bottosson.github.io/posts/gamutclipping/) (2021). This takes an input `[l,c,h]` coords in OKLCH space, and ensures the final result will lie within the specified color `gamut` (default `sRGBGamut`). You can further specify a different target space (which default's the the gamut's space), for example to get a linear-light sRGB and avoid the transfer function, or to keep the result in OKLCH:
+Performs fast gamut mapping in OKLCH as [described by Björn Ottoson](https://bottosson.github.io/posts/gamutclipping/) (2021). This takes an input `[l,c,h]` coords in OKLCH space, and ensures the final result will lie within the specified color `gamut` (default `sRGBGamut`). You can further specify a different target space (which default's to the gamut's space), for example to get a linear-light sRGB and avoid the transfer function, or to keep the result in OKLCH:
 
 ```js
 import { gamutMapOKLCH, sRGBGamut, sRGBLinear, OKLCH } from "@texel/color";
@@ -116,7 +116,7 @@ gamutMapOKLCH(oklch, sRGBGamut, sRGB, rgb, MapToL);
 
 The `cusp` can also be passed as the last parameter, allowing for faster evaluation for known hues. See below for calculating the cusp.
 
-> :Note: If you output to an OKLab-based target (OKLCH, OKHSL etc), the final step of RGB clipping will be skipped. This produces more predictable OKLab and OKLCH based results, but you will likely want to perform a final clampedRGB() step when converting to a displayable color.
+> **Note:** If you map to an OKLab-based target (OKLCH, OKHSL etc), the final step of RGB clipping will be skipped. This produces more predictable OKLab and OKLCH based results, but you will likely want to perform a final clampedRGB() step when converting to a displayable color.
 
 #### `LC = findCuspOKLCH(a, b, gamut, out = [0, 0])`
 
@@ -142,24 +142,41 @@ const cuspLC = findCuspOKLCH(a, b, gamut);
 
 // ... somewhere else in your program ...
 // pass 'cusp' parameter for faster evaluation
+// expected that your OKLCH coord has the same hue as the cusp (H)
 gamutMapOKLCH(oklch, gamut, gamut.space, out, MapToCuspL, cuspLC);
 ```
 
 The `a` and `b` can also be from OKLab coordinates, but must be normalized so `a^2 + b^2 == 1`.
 
-#### `str = serialize(coords, inputSpace = sRGB, outputSpace = inputSpace)`
+#### `str = serialize(coords, inputSpace, outputSpace = inputSpace)`
 
-Turns the specified `coords` (assumed to be in `inputSpace`) into a string, first converting if needed to the specified `outputSpace`. If the space is sRGB, a plain `rgb(r,g,b)` string (in bytes) will be used for browser compatibility and performance, otherwise a CSS color string will be returned. Note that not all spaces, such as certain linear spaces, are currently supported by CSS.
+Turns the specified `coords` (assumed to be in `inputSpace`) into a string, first converting if needed to the specified `outputSpace`. If the space is sRGB, a plain `rgb(r,g,b)` string (in bytes) will be used for browser compatibility and performance, otherwise a CSS color string will be returned. Note that not all spaces, such as certain linear spaces, are currently supported by CSS. You can optionally pass an `alpha` component (0..1 range) as the fourth element in the `coords` array for it to be considered.
 
 ```js
 import { serialize, sRGB, DisplayP3, OKLCH } from "@texel/color";
 
 serialize([0, 0.5, 1], sRGB); // "rgb(0, 128, 255)"
+serialize([0, 0.5, 1, 0.5], sRGB); // "rgba(0, 128, 255, 0.5)"
 serialize([0, 0.5, 1], DisplayP3); // "color(display-p3 0 0.5 1)"
+serialize([0, 0.5, 1, 0.35], DisplayP3); // "color(display-p3 0 0.5 1 / 0.35)"
 serialize([1, 0, 0], OKLCH, sRGB); // "rgb(255, 255, 255)"
 serialize([1, 0, 0], OKLCH); // "oklch(1 0 0)"
 ```
 
+#### `info = deserialize(colorString)`
+
+The inverse of `serialize`, this will take a string and determine the color space `id` it is referencing, and the 3 or 4 (for alpha) `coords`. This is intentionally limited in functionality, only supporting hex RGB, `rgb()` and `rgba()` bytes, and `oklch()`, `oklab()`, and plain `color()` functions with no modifiers.
+
+```js
+import { deserialize } from "@texel/color";
+
+const { coords, id } = deserialize("color(display-p3 0 0.5 1 / 0.35)");
+console.log(id); // "display-p3"
+console.log(coords); // [ 0, 0.5, 1, 0.35 ]
+```
+
+> **Note:** Parsing is still a WIP area of API design, and complex CSS color string handling is not within the scope of this library.
+
 #### `delta = deltaEOK(oklabA, oklabB)`
 
 Performs a color difference in OKLab space between two coordinates. As this is a perceptually uniform color space that improves upon CIELAB and its flaws, it should be suitable as a replacement for the CIEDE2000 color difference equation in many situations.
@@ -293,6 +310,8 @@ import {
   LMS_to_XYZ_M,
   XYZ_to_LMS_M,
   sRGB,
+  OKHSLToOKLab,
+  DisplayP3Gamut,
 } from "@texel/color";
 
 console.log(XYZ_to_linear_sRGB_M); // [ [a,b,c], ... ]
@@ -301,6 +320,10 @@ OKLab_from(xyzD65, XYZ_to_LMS_M); // XYZ D65 -> OKLab
 transform(xyzD65, XYZ_to_linear_sRGB_M); // XYZ D65 -> sRGBLinear
 sRGB.fromBase(in_linear_sRGB, out_sRGB); // linear to gamma transfer function
 sRGB.toBase(in_sRGB, out_linear_sRGB); // linear to gamma transfer function
+
+// OKHSL in a non-sRGB gamut
+// also see OKHSVToOKLab and their inverse functions
+OKHSLToOKLab([h, s, l], DisplayP3Gamut, optionalOutVec);
 ```
 
 ## Notes
@@ -309,7 +332,7 @@ sRGB.toBase(in_sRGB, out_linear_sRGB); // linear to gamma transfer function
 
 [Colorjs](https://colorjs.io/) is fantastic and perhaps the current leading standard in JavaScript, but it's not very practical for creative coding and real-time web applications, where the requirements are often (1) leaner codebases, (2) highly optimized, and (3) minimal GC thrashing.
 
-Colorjs, and simialrly, [Culori](https://culorijs.org/)), are focused on matching CSS spec, which means it will very likely continue to grow in complexity over time, and performance will often be marred (for example, `@texel/color` cusp intersection gamut mapping is ~125 times faster than Colorjs and ~60 times faster than culori).
+Colorjs, and simialrly, [Culori](https://culorijs.org/), are focused on matching CSS spec, which means it will very likely continue to grow in complexity over time, and performance will often be marred (for example, `@texel/color` cusp intersection gamut mapping is ~125 times faster than Colorjs and ~60 times faster than culori).
 
 There are many other options such as [color-space](https://www.npmjs.com/package/color-space) or [color-convert](https://www.npmjs.com/package/color-convert), however, these do not support modern spacse such as OKLab and OKHSL, and/or have dubious levels of accuracy (many libraries, for example, do not distinguish between D50 and D65 whitepoints in XYZ).
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@texel/color",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "a minimal and modern color library",
   "type": "module",
   "main": "./src/index.js",

package/src/core.js

@@ -1,6 +1,6 @@
-import { floatToByte, vec3 } from "./util.js";
+import { clamp, floatToByte, hexToRGB, vec3 } from "./util.js";
 import { LMS_to_OKLab_M, OKLab_to_LMS_M } from "./conversion_matrices.js";
-import { XYZ } from "./spaces.js";
+import { listColorSpaces, sRGB, XYZ } from "./spaces.js";
 
 const tmp3 = vec3();
 
@@ -51,25 +51,131 @@ const vec3Copy = (input, output) => {
 
 export const serialize = (input, inputSpace, outputSpace = inputSpace) => {
   if (!inputSpace) throw new Error(`must specify an input space`);
+  // extract alpha if present
+  let alpha = 1;
+  if (input.length > 3) {
+    alpha = input[3];
+  }
+  // copy into temp
+  vec3Copy(input, tmp3);
+  // convert if needed
   if (inputSpace !== outputSpace) {
     convert(input, inputSpace, outputSpace, tmp3);
-  } else {
-    vec3Copy(input, tmp3);
   }
-
   const id = outputSpace.id;
   if (id == "srgb") {
     const r = floatToByte(tmp3[0]);
     const g = floatToByte(tmp3[1]);
     const b = floatToByte(tmp3[2]);
-    return `rgb(${r}, ${g}, ${b})`;
-  } else if (id == "oklab" || id == "oklch") {
-    return `${id}(${tmp3[0]} ${tmp3[1]} ${tmp3[2]})`;
+    const rgb = `${r}, ${g}, ${b}`;
+    return alpha === 1 ? `rgb(${rgb})` : `rgba(${rgb}, ${alpha})`;
   } else {
-    return `color(${id} ${tmp3[0]} ${tmp3[1]} ${tmp3[2]})`;
+    const alphaSuffix = alpha === 1 ? "" : ` / ${alpha}`;
+    if (id == "oklab" || id == "oklch") {
+      return `${id}(${tmp3[0]} ${tmp3[1]} ${tmp3[2]}${alphaSuffix})`;
+    } else {
+      return `color(${id} ${tmp3[0]} ${tmp3[1]} ${tmp3[2]}${alphaSuffix})`;
+    }
   }
 };
 
+const stripAlpha = (coords) => {
+  if (coords.length >= 4 && coords[3] === 1) return coords.slice(0, 3);
+  return coords;
+};
+
+export const deserialize = (input) => {
+  if (typeof input !== "string") {
+    throw new Error(`expected a string as input`);
+  }
+  input = input.trim();
+  if (input.charAt(0) === "#") {
+    const rgbIn = input.slice(0, 7);
+    let alphaByte = input.length > 7 ? parseInt(input.slice(7, 9), 16) : 255;
+    let alpha = isNaN(alphaByte) ? 1 : alphaByte / 255;
+    const coords = hexToRGB(rgbIn);
+    if (alpha !== 1) coords.push(alpha);
+    return {
+      id: "srgb",
+      coords,
+    };
+  } else {
+    const parts = /^(rgb|rgba|oklab|oklch|color)\((.+)\)$/i.exec(input);
+    if (!parts) {
+      throw new Error(`could not parse color string ${input}`);
+    }
+    const fn = parts[1].toLowerCase();
+    if (/^rgba?$/i.test(fn)) {
+      const hasAlpha = fn == "rgba";
+      const coords = parts[2]
+        .split(",")
+        .map((v, i) =>
+          i < 3 ? clamp(parseInt(v, 10) || 0, 0, 255) / 255 : parseFloat(v)
+        );
+      const expectedLen = hasAlpha ? 4 : 3;
+      if (coords.length !== expectedLen) {
+        throw new Error(
+          `got ${fn} with incorrect number of coords, expected ${expectedLen}`
+        );
+      }
+      return {
+        id: "srgb",
+        coords: stripAlpha(coords),
+      };
+    } else {
+      let id, coordsStrings;
+      if (fn === "color") {
+        const params =
+          /([^\s]+)\s+([^\s]+)\s+([^\s]+)\s+([^\s/]+)(?:\s?\/\s?([^\s]+))?/.exec(
+            parts[2]
+          );
+        if (!params)
+          throw new Error(`could not parse color() function ${input}`);
+        id = params[1].toLowerCase();
+        coordsStrings = params.slice(2, 6);
+      } else if (/^(oklab|oklch)$/.test(fn)) {
+        id = fn;
+        const params =
+          /([^\s]+)\s+([^\s]+)\s+([^\s/]+)(?:\s?\/\s?([^\s]+))?/.exec(parts[2]);
+        if (!params)
+          throw new Error(`could not parse color() function ${input}`);
+        coordsStrings = params.slice(1, 6);
+      }
+
+      if (coordsStrings[3] == null) {
+        coordsStrings = coordsStrings.slice(0, 3);
+      }
+
+      const coords = coordsStrings.map((f) => parseFloat(f));
+      if (coords.length < 3 || coords.length > 4)
+        throw new Error(`invalid number of coordinates`);
+      return {
+        id,
+        coords: stripAlpha(coords),
+      };
+    }
+  }
+};
+export const parse = (input, targetSpace, out = vec3()) => {
+  if (!targetSpace)
+    throw new Error(`must specify a target space to parse into`);
+
+  const { coords, id } = deserialize(input);
+  const space = listColorSpaces().find((f) => id === f.id);
+  if (!space) throw new Error(`could not find space with the id ${id}`);
+  const alpha = coords.length === 4 ? coords[3] : 1;
+
+  // copy 3D coords to output and convert
+  vec3Copy(coords, out);
+  convert(out, space, targetSpace, out);
+
+  // store alpha
+  if (alpha !== 1) out[3] = alpha;
+  // reduce to 3D
+  if (alpha == 1 && out.length === 4) out.pop();
+  return out;
+};
+
 export const convert = (input, fromSpace, toSpace, out = vec3()) => {
   // place into output
   vec3Copy(input, out);

package/src/gamut.js

@@ -334,7 +334,7 @@ export const gamutMapOKLCH = (
     //    will be applied. The OKLCH result is _basically_ in gamut, but not exactly; you'll need to clip at final stage.
     // I've documented this behaviour in the readme.
     const targetSpaceBase = targetSpace.base ?? targetSpace;
-    if (targetSpaceBase == OKLab) {
+    if (targetSpaceBase.id == "oklab") {
       return convert(out, OKLCH, targetSpace, out);
     }
 

package/src/util.js

@@ -26,9 +26,12 @@ export const hexToRGB = (str, out = vec3()) => {
   return out;
 };
 
-export const RGBtoHex = (rgb) =>
+export const RGBToHex = (rgb) =>
   `#${rgb.map((n) => floatToByte(n).toString(16).padStart(2, "0")).join("")}`;
 
+/** @deprecated use RGBToHex */
+export const RGBtoHex = (rgb) => RGBToHex;
+
 export const isRGBInGamut = (lrgb, ep = GAMUT_EPSILON) => {
   const r = lrgb[0];
   const g = lrgb[1];

package/test/test.js

@@ -5,7 +5,7 @@ import {
   floatToByte,
   hexToRGB,
   isRGBInGamut,
-  RGBtoHex,
+  RGBToHex,
   linear_sRGB_to_LMS_M,
   LMS_to_linear_sRGB_M,
   LMS_to_XYZ_M,
@@ -42,6 +42,8 @@ import {
   A98RGBLinear,
   XYZ_to_linear_A98RGB_M,
   DisplayP3Gamut,
+  deserialize,
+  parse,
 } from "../src/index.js";
 
 test("should convert XYZ in different whitepoints", async (t) => {
@@ -229,10 +231,96 @@ test("should serialize", async (t) => {
   t.deepEqual(serialize([0, 0.5, 1], sRGBLinear), "color(srgb-linear 0 0.5 1)");
   t.deepEqual(serialize([1, 0, 0], OKLCH, sRGB), "rgb(255, 255, 255)");
   t.deepEqual(serialize([1, 0, 0], OKLCH), "oklch(1 0 0)");
+  t.deepEqual(serialize([1, 0, 0], OKLab), "oklab(1 0 0)");
+  t.deepEqual(
+    serialize([1, 0, 0, 0.4523], OKLCH, sRGB),
+    "rgba(255, 255, 255, 0.4523)"
+  );
+  t.deepEqual(
+    serialize([1, 0, 0, 0.4523], OKLCH, OKLCH),
+    "oklch(1 0 0 / 0.4523)"
+  );
+  t.deepEqual(serialize([1, 0, 0, 0.4523], OKLCH), "oklch(1 0 0 / 0.4523)");
+  t.deepEqual(
+    serialize([1, 0, 0, 0.4523], DisplayP3),
+    "color(display-p3 1 0 0 / 0.4523)"
+  );
+});
+
+test("should parse to a color coord", async (t) => {
+  t.deepEqual(parse("rgb(0, 128, 255)", sRGB), [0, 128 / 0xff, 255 / 0xff]);
+  t.deepEqual(parse("rgba(0, 128, 255, .25)", sRGB), [
+    0,
+    128 / 0xff,
+    255 / 0xff,
+    0.25,
+  ]);
+  let outVec = [0, 0, 0];
+  t.deepEqual(parse("rgba(0, 128, 255, 1)", sRGB), [0, 128 / 0xff, 255 / 0xff]);
+  let out;
+  out = parse("rgba(0, 128, 255, 1)", sRGB, outVec);
+  t.deepEqual(out, [0, 128 / 0xff, 255 / 0xff]);
+  t.equal(out, outVec);
+
+  // trims to 3
+  outVec = [0, 0, 0, 0];
+  out = parse("rgba(0, 128, 255, 1)", sRGB, outVec);
+  t.deepEqual(out, [0, 128 / 0xff, 255 / 0xff]);
+  t.equal(out, outVec);
+
+  // ensures 4
+  outVec = [0, 0, 0, 0];
+  out = parse("rgba(0, 128, 255, 0.91)", sRGB, outVec);
+  t.deepEqual(out, [0, 128 / 0xff, 255 / 0xff, 0.91]);
+  t.equal(out, outVec);
+
+  t.deepEqual(
+    serialize(parse("oklch(1 0 0)", sRGB), sRGB),
+    "rgb(255, 255, 255)"
+  );
+});
+
+test("should deserialize color string information", async (t) => {
+  t.deepEqual(deserialize("rgb(0, 128, 255)"), {
+    coords: [0, 128 / 0xff, 255 / 0xff],
+    id: "srgb",
+  });
+  t.deepEqual(deserialize("rgba(0, 128, 255, 0.35)"), {
+    coords: [0, 128 / 0xff, 255 / 0xff, 0.35],
+    id: "srgb",
+  });
+  t.deepEqual(deserialize("#ff00cc"), {
+    id: "srgb",
+    coords: [1, 0, 0.8],
+  });
+  t.deepEqual(deserialize("#ff00cccc"), {
+    id: "srgb",
+    coords: [1, 0, 0.8, 0.8],
+  });
+  t.deepEqual(deserialize("color(srgb-linear 0 0.5 1)"), {
+    id: "srgb-linear",
+    coords: [0, 0.5, 1],
+  });
+  t.deepEqual(deserialize("color(srgb-linear 0 0.5 1/0.25)"), {
+    id: "srgb-linear",
+    coords: [0, 0.5, 1, 0.25],
+  });
+  t.deepEqual(deserialize("color(srgb-linear 0 0.5 1 / 0.25)"), {
+    id: "srgb-linear",
+    coords: [0, 0.5, 1, 0.25],
+  });
+  t.deepEqual(deserialize("oklch(1 0 0)"), {
+    id: "oklch",
+    coords: [1, 0, 0],
+  });
+  t.deepEqual(deserialize("oklch(1 0 0/0.25)"), {
+    id: "oklch",
+    coords: [1, 0, 0, 0.25],
+  });
 });
 
 test("utils", async (t) => {
-  t.deepEqual(RGBtoHex([0, 0.5, 1]), "#0080ff");
+  t.deepEqual(RGBToHex([0, 0.5, 1]), "#0080ff");
   t.deepEqual(hexToRGB("#0080ff"), [0, 0.5019607843137255, 1]);
   const tmp = [0, 0, 0];
   hexToRGB("#0080ff", tmp);