diff --git a/core/modules/filters/colour-ops.js b/core/modules/filters/colour-ops.js new file mode 100644 index 00000000000..341fb13f693 --- /dev/null +++ b/core/modules/filters/colour-ops.js @@ -0,0 +1,100 @@ +/*\ +title: $:/core/modules/filters/colour-ops.js +type: application/javascript +module-type: filteroperator + +Filter operators for colour operations + +\*/ +(function(){ + +/*jslint node: true, browser: true */ +/*global $tw: false */ +"use strict"; + +var Color = require("$:/core/modules/utils/dom/color.js").Color; + +exports["colour-lighten"] = makeSerialColourOperator(function (colour, operator, options) { + return colour.lighten($tw.utils.parseNumber(operator.operand)).display().toString(); +}); + +exports["colour-darken"] = makeSerialColourOperator(function (colour, operator, options) { + return colour.darken($tw.utils.parseNumber(operator.operand)).display().toString(); +}); + +exports["colour-get-oklch"] = makeSerialColourOperator(function (colour, operator, options) { + var prop = ((operator.suffixes || [])[0] || ["l"])[0]; + if(["l","c","h"].indexOf(prop) !== -1) { + colour = colour.oklch[prop]; + } + return colour.toString(); +}); + +exports["colour-set-oklch"] = makeSerialColourOperator(function (colour, operator, options) { + var prop = ((operator.suffixes || [])[0] || ["l"])[0]; + if(["l","c","h"].indexOf(prop) !== -1) { + colour.oklch[prop] = $tw.utils.parseNumber(operator.operand); + } + return colour.display().toString(); +}); + +exports["colour-contrast"] = makeParallelColourOperator(function (colours, operator, options) { + var colourContrasts = []; + $tw.utils.each(colours,function(colour,index) { + if(!colour) { + colour = $tw.utils.parseCSSColorObject("white"); + colours[index] = colour; + } + if(index > 0) { + colourContrasts.push(colour.contrast(colours[index - 1],"DeltaPhi").toString()); + } + }); + return colourContrasts; +}); + +exports["colour-interpolate"] = makeParallelColourOperator(function (colours, operator, options) { + // Special case for less than two colours + if(colours.length < 2) { + return []; + } + // Step through the indexes collecting the interpolated colours + var space = ((operator.suffixes || [])[0] || ["srgb"])[0], + rangefn = colours[0].range(colours[1],{space: space}), + outputColours = []; + $tw.utils.each(operator.operands,function(operand) { + // Get the index + var index = $tw.utils.parseNumber(operand); + // Calculate the interpolated colour + var colour = rangefn(index); + outputColours.push(colour.display().toString()); + }); + return outputColours; +}); + +function makeSerialColourOperator(fn) { + return function (source, operator, options) { + var results = []; + source(function (tiddler, title) { + var c = $tw.utils.parseCSSColorObject(title); + if (c) { + c = fn(c, operator, options); + results.push(c); + } else { + results.push(""); + } + }); + return results; + }; +} + +function makeParallelColourOperator(fn) { + return function (source, operator, options) { + var colours = []; + source(function (tiddler, title) { + colours.push($tw.utils.parseCSSColorObject(title)); + }); + return fn(colours, operator, options); + }; +} + +})(); diff --git a/core/modules/macros/contrastcolour.js b/core/modules/macros/contrastcolour.js index eab6f0108f1..6d38993f096 100644 --- a/core/modules/macros/contrastcolour.js +++ b/core/modules/macros/contrastcolour.js @@ -29,27 +29,28 @@ exports.params = [ Run the macro */ exports.run = function(target,fallbackTarget,colourA,colourB) { - var rgbTarget = $tw.utils.parseCSSColor(target) || $tw.utils.parseCSSColor(fallbackTarget); + var rgbTarget = $tw.utils.parseCSSColorObject(target) || $tw.utils.parseCSSColorObject(fallbackTarget); if(!rgbTarget) { return colourA; } - var rgbColourA = $tw.utils.parseCSSColor(colourA), - rgbColourB = $tw.utils.parseCSSColor(colourB); + var rgbColourA = $tw.utils.parseCSSColorObject(colourA), + rgbColourB = $tw.utils.parseCSSColorObject(colourB); if(rgbColourA && !rgbColourB) { - return rgbColourA; + return colourA; } if(rgbColourB && !rgbColourA) { - return rgbColourB; + return colourB; } if(!rgbColourA && !rgbColourB) { // If neither colour is readable, return a crude inverse of the target - return [255 - rgbTarget[0],255 - rgbTarget[1],255 - rgbTarget[2],rgbTarget[3]]; + rgbTarget.srgb.r = 1 - rgbTarget.srgb.r; + rgbTarget.srgb.g = 1 - rgbTarget.srgb.g; + rgbTarget.srgb.b = 1 - rgbTarget.srgb.b; + return rgbTarget.display(); } - // Colour brightness formula derived from http://www.w3.org/WAI/ER/WD-AERT/#color-contrast - var brightnessTarget = rgbTarget[0] * 0.299 + rgbTarget[1] * 0.587 + rgbTarget[2] * 0.114, - brightnessA = rgbColourA[0] * 0.299 + rgbColourA[1] * 0.587 + rgbColourA[2] * 0.114, - brightnessB = rgbColourB[0] * 0.299 + rgbColourB[1] * 0.587 + rgbColourB[2] * 0.114; - return Math.abs(brightnessTarget - brightnessA) > Math.abs(brightnessTarget - brightnessB) ? colourA : colourB; + var aContrast = rgbColourA.contrast(rgbTarget,"DeltaPhi"), + bContrast = rgbColourB.contrast(rgbTarget,"DeltaPhi"); + return aContrast > bContrast ? colourA : colourB; }; })(); diff --git a/core/modules/utils/dom/color-utils.js b/core/modules/utils/dom/color-utils.js new file mode 100644 index 00000000000..4756324181c --- /dev/null +++ b/core/modules/utils/dom/color-utils.js @@ -0,0 +1,44 @@ +/*\ +title: $:/core/modules/utils/color-utils.js +type: application/javascript +module-type: utils + +Color.js related utilities + +\*/ +(function(){ + +/*jslint node: true, browser: true */ +/*global $tw: false */ +"use strict"; + +var Color = require("$:/core/modules/utils/dom/color.js").Color; + +/* +For backwards compatibility +*/ +exports.parseCSSColor = function(colourString) { + var c = exports.parseCSSColorObject(colourString); + if(c) { + var rgb = c.srgb; + return [rgb[0],rgb[1],rgb[2],c.alpha]; + } else { + return null; + } +}; + + +/* +Preferred way to parse a Color.js colour +*/ +exports.parseCSSColorObject = function(colourString) { + var c = null; + try { + c = new Color(colourString); + } catch(e) { + // Return null if there is an error + } + return c; +}; + +})(); diff --git a/core/modules/utils/dom/color.js/LICENSE b/core/modules/utils/dom/color.js/LICENSE new file mode 100644 index 00000000000..74fc62b5e88 --- /dev/null +++ b/core/modules/utils/dom/color.js/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 Lea Verou, Chris Lilley + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/core/modules/utils/dom/color.js/color.global.0.5.2.js b/core/modules/utils/dom/color.js/color.global.0.5.2.js new file mode 100644 index 00000000000..492a9370fa8 --- /dev/null +++ b/core/modules/utils/dom/color.js/color.global.0.5.2.js @@ -0,0 +1,7508 @@ +var Color = (function () { + 'use strict'; + + // Type "imports" + /** @typedef {import("./types.js").Matrix3x3} Matrix3x3 */ + /** @typedef {import("./types.js").Vector3} Vector3 */ + + + /** + * A is m x n. B is n x p. product is m x p. + * + * Array arguments are treated like vectors: + * - A becomes 1 x n + * - B becomes n x 1 + * + * Returns Matrix m x p or equivalent array + * + * @overload + * @param {number[]} A Vector 1 x n + * @param {number[]} B Vector n x 1 + * @returns {number[]} Array with length 1 + * + * @overload + * @param {number[][]} A Matrix m x n + * @param {number[]} B Vector n x 1 + * @returns {number[]} Array with length m + * + * @overload + * @param {number[]} A Vector 1 x n + * @param {number[][]} B Matrix n x p + * @returns {number[]} Array with length p + * + * @overload + * @param {number[][]} A Matrix m x n + * @param {number[][]} B Matrix n x p + * @returns {number[][]} Matrix m x p + * + * @param {number[] | number[][]} A Matrix m x n or a vector + * @param {number[] | number[][]} B Matrix n x p or a vector + * @returns {number[] | number[][]} Matrix m x p or equivalent array + */ + function multiplyMatrices (A, B) { + let m = A.length; + /** @type {number[][]} */ + let AM; + /** @type {number[][]} */ + let BM; + + if (!Array.isArray(A[0])) { + // A is vector, convert to [[a, b, c, ...]] + AM = [/** @type {number[]} */ (A)]; + } + else { + AM = /** @type {number[][]} */ (A); + } + + if (!Array.isArray(B[0])) { + // B is vector, convert to [[a], [b], [c], ...]] + BM = B.map(x => [x]); + } + else { + BM = /** @type {number[][]} */ (B); + } + + + let p = BM[0].length; + let BM_cols = BM[0].map((_, i) => BM.map(x => x[i])); // transpose B + /** @type {number[] | number[][]} */ + let product = AM.map(row => BM_cols.map(col => { + let ret = 0; + + if (!Array.isArray(row)) { + for (let c of col) { + ret += row * c; + } + + return ret; + } + + for (let i = 0; i < row.length; i++) { + ret += row[i] * (col[i] || 0); + } + + return ret; + })); + + if (m === 1) { + product = product[0]; // Avoid [[a, b, c, ...]] + } + if (p === 1) { + return product.map(x => x[0]); // Avoid [[a], [b], [c], ...]] + } + + return product; + } + + + // dot3 and transform functions adapted from https://github.com/texel-org/color/blob/9793c7d4d02b51f068e0f3fd37131129a4270396/src/core.js + // + // The MIT License (MIT) + // Copyright (c) 2024 Matt DesLauriers + + // Permission is hereby granted, free of charge, to any person obtaining a copy + // of this software and associated documentation files (the "Software"), to deal + // in the Software without restriction, including without limitation the rights + // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + // copies of the Software, and to permit persons to whom the Software is + // furnished to do so, subject to the following conditions: + + // The above copyright notice and this permission notice shall be included in all + // copies or substantial portions of the Software. + + // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. + // IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + // DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR + // OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE + // OR OTHER DEALINGS IN THE SOFTWARE. + + + /** + * Returns the dot product of two vectors each with a length of 3. + * + * @param {Vector3} a + * @param {Vector3} b + * @returns {number} + */ + function dot3 (a, b) { + return a[0] * b[0] + a[1] * b[1] + a[2] * b[2]; + } + + /** + * Transforms a vector of length 3 by a 3x3 matrix. Specify the same input and output + * vector to transform in place. + * + * @param {Vector3} input + * @param {Matrix3x3} matrix + * @param {Vector3} [out] + * @returns {Vector3} + */ + function multiply_v3_m3x3 (input, matrix, out = [0, 0, 0]) { + const x = dot3(input, matrix[0]); + const y = dot3(input, matrix[1]); + const z = dot3(input, matrix[2]); + out[0] = x; + out[1] = y; + out[2] = z; + return out; + } + + /** + * Various utility functions + */ + + + /** + * Check if a value is a string (including a String object) + * @param {any} str - Value to check + * @returns {str is string} + */ + function isString (str) { + return type(str) === "string"; + } + + /** + * Determine the internal JavaScript [[Class]] of an object. + * @param {any} o - Value to check + * @returns {string} + */ + function type (o) { + let str = Object.prototype.toString.call(o); + + return (str.match(/^\[object\s+(.*?)\]$/)[1] || "").toLowerCase(); + } + + /** + * @param {number} n + * @param {{ precision?: number | undefined, unit?: string | undefined }} options + * @returns {string} + */ + function serializeNumber (n, {precision = 16, unit }) { + if (isNone(n)) { + return "none"; + } + + n = +toPrecision(n, precision); + + return n + (unit ?? ""); + } + + /** + * Check if a value corresponds to a none argument + * @param {any} n - Value to check + * @returns {n is null} + */ + function isNone (n) { + return n === null; + } + + /** + * Replace none values with 0 + * @param {number | null} n + * @returns {number} + */ + function skipNone (n) { + return isNone(n) ? 0 : n; + } + + /** + * Round a number to a certain number of significant digits + * @param {number} n - The number to round + * @param {number} precision - Number of significant digits + */ + function toPrecision (n, precision) { + if (n === 0) { + return 0; + } + let integer = ~~n; + let digits = 0; + if (integer && precision) { + digits = ~~Math.log10(Math.abs(integer)) + 1; + } + const multiplier = 10.0 ** (precision - digits); + return Math.floor(n * multiplier + 0.5) / multiplier; + } + + /** + * @param {number} start + * @param {number} end + * @param {number} p + */ + function interpolate (start, end, p) { + if (isNaN(start)) { + return end; + } + + if (isNaN(end)) { + return start; + } + + return start + (end - start) * p; + } + + /** + * @param {number} start + * @param {number} end + * @param {number} value + */ + function interpolateInv (start, end, value) { + return (value - start) / (end - start); + } + + /** + * @param {[number, number]} from + * @param {[number, number]} to + * @param {number} value + */ + function mapRange (from, to, value) { + if (!from || !to || from === to || from[0] === to[0] && from[1] === to[1] || isNaN(value) || value === null) { + // Ranges missing or the same + return value; + } + + return interpolate(to[0], to[1], interpolateInv(from[0], from[1], value)); + } + + /** + * Clamp value between the minimum and maximum + * @param {number} min minimum value to return + * @param {number} val the value to return if it is between min and max + * @param {number} max maximum value to return + */ + function clamp (min, val, max) { + return Math.max(Math.min(max, val), min); + } + + /** + * Copy sign of one value to another. + * @param {number} to - Number to copy sign to + * @param {number} from - Number to copy sign from + */ + function copySign (to, from) { + return Math.sign(to) === Math.sign(from) ? to : -to; + } + + /** + * Perform pow on a signed number and copy sign to result + * @param {number} base The base number + * @param {number} exp The exponent + */ + function spow (base, exp) { + return copySign(Math.abs(base) ** exp, base); + } + + /** + * Perform a divide, but return zero if the denominator is zero + * @param {number} n The numerator + * @param {number} d The denominator + */ + function zdiv (n, d) { + return (d === 0) ? 0 : n / d; + } + + /** + * Perform a bisect on a sorted list and locate the insertion point for + * a value in arr to maintain sorted order. + * @param {number[]} arr - array of sorted numbers + * @param {number} value - value to find insertion point for + * @param {number} lo - used to specify a the low end of a subset of the list + * @param {number} hi - used to specify a the high end of a subset of the list + */ + function bisectLeft (arr, value, lo = 0, hi = arr.length) { + while (lo < hi) { + const mid = (lo + hi) >> 1; + if (arr[mid] < value) { + lo = mid + 1; + } + else { + hi = mid; + } + } + return lo; + } + + var util = /*#__PURE__*/Object.freeze({ + __proto__: null, + bisectLeft: bisectLeft, + clamp: clamp, + copySign: copySign, + interpolate: interpolate, + interpolateInv: interpolateInv, + isNone: isNone, + isString: isString, + mapRange: mapRange, + multiplyMatrices: multiplyMatrices, + multiply_v3_m3x3: multiply_v3_m3x3, + serializeNumber: serializeNumber, + skipNone: skipNone, + spow: spow, + toPrecision: toPrecision, + type: type, + zdiv: zdiv + }); + + /** + * A class for adding deep extensibility to any piece of JS code + */ + class Hooks { + add (name, callback, first) { + if (typeof arguments[0] != "string") { + // Multiple hooks + for (var name in arguments[0]) { + this.add(name, arguments[0][name], arguments[1]); + } + + return; + } + + (Array.isArray(name) ? name : [name]).forEach(function (name) { + this[name] = this[name] || []; + + if (callback) { + this[name][first ? "unshift" : "push"](callback); + } + }, this); + } + + run (name, env) { + this[name] = this[name] || []; + this[name].forEach(function (callback) { + callback.call(env && env.context ? env.context : env, env); + }); + } + } + + /** + * The instance of {@link Hooks} used throughout Color.js + */ + const hooks = new Hooks(); + + // Global defaults one may want to configure + var defaults = { + gamut_mapping: "css", + precision: 5, + deltaE: "76", // Default deltaE method + verbose: globalThis?.process?.env?.NODE_ENV?.toLowerCase() !== "test", + warn: function warn (msg) { + if (this.verbose) { + globalThis?.console?.warn?.(msg); + } + }, + }; + + class Type { + // Class properties - declared here so that type inference works + type; + coordMeta; + coordRange; + /** @type {[number, number]} */ + range; + + /** + * @param {any} type + * @param {import("./types.js").CoordMeta} coordMeta + */ + constructor (type, coordMeta) { + if (typeof type === "object") { + this.coordMeta = type; + } + + if (coordMeta) { + this.coordRange = coordMeta.range ?? coordMeta.refRange; + } + + if (typeof type === "string") { + let params = type.trim().match(/^(?<[a-z]+>)(\[(?-?[.\d]+),\s*(?-?[.\d]+)\])?$/); + + if (!params) { + throw new TypeError(`Cannot parse ${type} as a type definition.`); + } + + this.type = params.groups.type; + let {min, max} = params.groups; + + if (min || max) { + this.range = [+min, +max]; + } + } + } + + /** @returns {[number, number]} */ + get computedRange () { + if (this.range) { + return this.range; + } + if (this.type === "") { + return this.percentageRange(); + } + else if (this.type === "") { + return [0, 360]; + } + return null; + } + + get unit () { + if (this.type === "") { + return "%"; + } + else if (this.type === "") { + return "deg"; + } + + return ""; + } + + /** + * Map a number to the internal representation + * @param {number} number + */ + resolve (number) { + if (this.type === "") { + return number; + } + + let fromRange = this.computedRange; + let toRange = this.coordRange; + + if (this.type === "") { + toRange ??= this.percentageRange(); + } + + return mapRange(fromRange, toRange, number); + } + + /** + * Serialize a number from the internal representation to a string + * @param {number} number + * @param {number} [precision] + */ + serialize (number, precision) { + let toRange = this.type === "" ? this.percentageRange(100) : this.computedRange; + + let unit = this.unit; + + number = mapRange(this.coordRange, toRange, number); + return serializeNumber(number, {unit, precision}); + } + + toString () { + let ret = this.type; + + if (this.range) { + let [min = "", max = ""] = this.range; + ret += `[${min},${max}]`; + } + + return ret; + } + + /** + * Returns a percentage range for values of this type + * @param {number} scale + * @returns {[number, number]} + */ + percentageRange (scale = 1) { + let range = this.coordRange && this.coordRange[0] < 0 ? [-1, 1] : [0, 1]; + return /** @type {[number, number]} */ (range.map(v => v * scale)); + } + + static get (type, ...args) { + if (type instanceof this) { + return type; + } + + return new this(type, ...args); + } + } + + // Type "imports" + /** @typedef {import("./types.js").ColorSpace} ColorSpace */ + /** @typedef {import("./types.js").Coords} Coords */ + /** @typedef {import("./types.js").Format} FormatInterface */ + + /** + * @internal + * Used to index {@link FormatInterface Format} objects and store an instance. + * Not meant for external use + */ + const instance = Symbol("instance"); + + /** + * Remove the first element of an array type + * @template {any[]} T + * @typedef {T extends [any, ...infer R] ? R : T[number][]} RemoveFirstElement + */ + + /** + * @class Format + * @implements {Omit} + * Class to hold a color serialization format + */ + class Format { + // Class properties - declared here so that type inference works + type; + name; + spaceCoords; + /** @type {Type[][]} */ + coords; + + /** + * @param {FormatInterface} format + * @param {ColorSpace} space + */ + constructor (format, space = format.space) { + format[instance] = this; + this.type = "function"; + this.name = "color"; + + Object.assign(this, format); + + this.space = space; + + if (this.type === "custom") { + // Nothing else to do here + return; + } + + this.spaceCoords = Object.values(space.coords); + + if (!this.coords) { + // @ts-expect-error Strings are converted to the correct type later + this.coords = this.spaceCoords.map(coordMeta => { + let ret = ["", ""]; + + if (coordMeta.type === "angle") { + ret.push(""); + } + + return ret; + }); + } + + this.coords = this.coords.map(/** @param {string | string[] | Type[]} types */ (types, i) => { + let coordMeta = this.spaceCoords[i]; + + if (typeof types === "string") { + types = types.trim().split(/\s*\|\s*/); + } + + return types.map(type => Type.get(type, coordMeta)); + }); + } + + /** + * @param {Coords} coords + * @param {number} precision + * @param {Type[]} types + */ + serializeCoords (coords, precision, types) { + types = coords.map((_, i) => Type.get(types?.[i] ?? this.coords[i][0], this.spaceCoords[i])); + return coords.map((c, i) => types[i].serialize(c, precision)); + } + + /** + * Validates the coordinates of a color against a format's coord grammar and + * maps the coordinates to the range or refRange of the coordinates. + * @param {Coords} coords + * @param {[string, string, string]} types + */ + coerceCoords (coords, types) { + return Object.entries(this.space.coords).map(([id, coordMeta], i) => { + let arg = coords[i]; + + if (isNone(arg) || isNaN(arg)) { + // Nothing to do here + return arg; + } + + // Find grammar alternative that matches the provided type + // Non-strict equals is intentional because we are comparing w/ string objects + let providedType = types[i]; + let type = this.coords[i].find(c => c.type == providedType); + + // Check that each coord conforms to its grammar + if (!type) { + // Type does not exist in the grammar, throw + let coordName = coordMeta.name || id; + throw new TypeError(`${ providedType ?? /** @type {any} */ (arg)?.raw ?? arg } not allowed for ${coordName} in ${this.name}()`); + } + + arg = type.resolve(arg); + + if (type.range) { + // Adjust type to include range + types[i] = type.toString(); + } + + return arg; + }); + } + + /** + * @returns {boolean | Required["serialize"]} + */ + canSerialize () { + return this.type === "function" || /** @type {any} */ (this).serialize; + } + + /** + * @param {Format | FormatInterface} format + * @param {RemoveFirstElement>} args + * @returns {Format} + */ + static get (format, ...args) { + if (!format || format instanceof Format) { + return /** @type {Format} */ (format); + } + + if (format[instance]) { + return format[instance]; + } + + return new Format(format, ...args); + } + } + + // Type "imports" + /** @typedef {import("./types.js").White} White */ + + /** @type {Record} */ + const WHITES = { + // for compatibility, the four-digit chromaticity-derived ones everyone else uses + D50: [0.3457 / 0.3585, 1.00000, (1.0 - 0.3457 - 0.3585) / 0.3585], + D65: [0.3127 / 0.3290, 1.00000, (1.0 - 0.3127 - 0.3290) / 0.3290], + }; + + /** + * + * @param {string | White} name + * @returns {White} + */ + function getWhite (name) { + if (Array.isArray(name)) { + return name; + } + + return WHITES[name]; + } + + /** + * Adapt XYZ from white point W1 to W2 + * @param {White | string} W1 + * @param {White | string} W2 + * @param {[number, number, number]} XYZ + * @param {{ method?: string | undefined }} options + * @returns {[number, number, number]} + */ + function adapt$2 (W1, W2, XYZ, options = {}) { + W1 = getWhite(W1); + W2 = getWhite(W2); + + if (!W1 || !W2) { + throw new TypeError(`Missing white point to convert ${!W1 ? "from" : ""}${!W1 && !W2 ? "/" : ""}${!W2 ? "to" : ""}`); + } + + if (W1 === W2) { + // Same whitepoints, no conversion needed + return XYZ; + } + + let env = {W1, W2, XYZ, options}; + + hooks.run("chromatic-adaptation-start", env); + + if (!env.M) { + if (env.W1 === WHITES.D65 && env.W2 === WHITES.D50) { + env.M = [ + [ 1.0479297925449969, 0.022946870601609652, -0.05019226628920524 ], + [ 0.02962780877005599, 0.9904344267538799, -0.017073799063418826 ], + [ -0.009243040646204504, 0.015055191490298152, 0.7518742814281371 ], + ]; + } + else if (env.W1 === WHITES.D50 && env.W2 === WHITES.D65) { + + env.M = [ + [ 0.955473421488075, -0.02309845494876471, 0.06325924320057072 ], + [ -0.0283697093338637, 1.0099953980813041, 0.021041441191917323 ], + [ 0.012314014864481998, -0.020507649298898964, 1.330365926242124 ], + ]; + } + } + + hooks.run("chromatic-adaptation-end", env); + + if (env.M) { + return multiply_v3_m3x3(env.XYZ, env.M); + } + else { + throw new TypeError("Only Bradford CAT with white points D50 and D65 supported for now."); + } + } + + // Type "imports" + /** @typedef {import("./types.js").ArgumentMeta} ArgumentMeta */ + /** @typedef {import("./types.js").ColorConstructor} ColorConstructor */ + /** @typedef {import("./types.js").ParseFunctionReturn} ParseFunctionReturn */ + /** @typedef {import("./types.js").ParseOptions} ParseOptions */ + + /** + * Convert a CSS Color string to a color object + * @param {string} str + * @param {ParseOptions} [options] + * @returns {ColorConstructor} + */ + function parse (str, options) { + let env = { + str: String(str)?.trim(), + options, + }; + + hooks.run("parse-start", env); + + if (env.color) { + return env.color; + } + + env.parsed = parseFunction(env.str); + let ret; + let meta = env.options ? env.options.parseMeta ?? env.options.meta : null; + + if (env.parsed) { + // Is a functional syntax + let name = env.parsed.name; + let format; + let space; + let coords = env.parsed.args; + let types = coords.map((c, i) => env.parsed.argMeta[i]?.type); + + if (name === "color") { + // color() function + let id = coords.shift(); + types.shift(); + // Check against both and versions + let alternateId = id.startsWith("--") ? id.substring(2) : `--${id}`; + let ids = [id, alternateId]; + format = ColorSpace.findFormat({name, id: ids, type: "function"}); + + if (!format) { + // Not found + let didYouMean; + + let registryId = id in ColorSpace.registry ? id : alternateId; + if (registryId in ColorSpace.registry) { + // Used color space id instead of color() id, these are often different + let cssId = ColorSpace.registry[registryId].formats?.color?.id; + + if (cssId) { + let altColor = str.replace("color(" + id, "color(" + cssId); + didYouMean = `Did you mean ${ altColor }?`; + } + } + + throw new TypeError(`Cannot parse ${env.str}. ` + (didYouMean ?? "Missing a plugin?")); + } + + space = format.space; + + if (format.id.startsWith("--") && !id.startsWith("--")) { + defaults.warn(`${space.name} is a non-standard space and not currently supported in the CSS spec. ` + + `Use prefixed color(${format.id}) instead of color(${id}).`); + } + if (id.startsWith("--") && !format.id.startsWith("--")) { + defaults.warn(`${space.name} is a standard space and supported in the CSS spec. ` + + `Use color(${format.id}) instead of prefixed color(${id}).`); + } + } + else { + format = ColorSpace.findFormat({name, type: "function"}); + space = format.space; + } + + if (meta) { + Object.assign(meta, {format, formatId: format.name, types, commas: env.parsed.commas}); + } + + let alpha = 1; + + if (format.alpha === true || env.parsed.lastAlpha) { + alpha = env.parsed.args.pop(); + + if (meta) { + meta.alphaType = types.pop(); + } + } + + let coordCount = format.coords.length; + + if (coords.length !== coordCount) { + throw new TypeError(`Expected ${coordCount} coordinates for ${space.id} in ${env.str}), got ${coords.length}`); + } + + coords = format.coerceCoords(coords, types); + + ret = {spaceId: space.id, coords, alpha}; + } + else { + // Custom, colorspace-specific format + for (let space of ColorSpace.all) { + for (let formatId in space.formats) { + let format = space.formats[formatId]; + + if (format.type !== "custom") { + continue; + } + + if (format.test && !format.test(env.str)) { + continue; + } + + // Convert to Format object + format = space.getFormat(format); + + let color = format.parse(env.str); + + if (color) { + if (meta) { + Object.assign(meta, { format, formatId }); + } + + ret = color; + break; + } + } + } + } + + if (!ret) { + // If we're here, we couldn't parse + throw new TypeError(`Could not parse ${str} as a color. Missing a plugin?`); + } + + // Clamp alpha to [0, 1] + ret.alpha = isNone(ret.alpha) ? ret.alpha : ret.alpha === undefined ? 1 : clamp(0, ret.alpha, 1); + + return ret; + } + + /** + * Units and multiplication factors for the internally stored numbers + */ + const units = { + "%": 0.01, + deg: 1, + grad: 0.9, + rad: 180 / Math.PI, + turn: 360, + }; + + const regex = { + // Need to list calc(NaN) explicitly as otherwise its ending paren would terminate the function call + function: /^([a-z]+)\(((?:calc\(NaN\)|.)+?)\)$/i, + number: /^([-+]?(?:[0-9]*\.)?[0-9]+(e[-+]?[0-9]+)?)$/i, + unitValue: RegExp(`(${Object.keys(units).join("|")})$`), + + // NOTE The -+ are not just for prefix, but also for idents, and e+N notation! + singleArgument: /\/?\s*(none|NaN|calc\(NaN\)|[-+\w.]+(?:%|deg|g?rad|turn)?)/g, + }; + + /** + * Parse a single function argument + * @param {string} rawArg + * @returns {{value: number, meta: ArgumentMeta}} + */ + function parseArgument (rawArg) { + /** @type {Partial} */ + let meta = {}; + let unit = rawArg.match(regex.unitValue)?.[0]; + /** @type {string | number} */ + let value = meta.raw = rawArg; + + if (unit) { // It’s a dimension token + meta.type = unit === "%" ? "" : ""; + meta.unit = unit; + meta.unitless = Number(value.slice(0, -unit.length)); // unitless number + + value = meta.unitless * units[unit]; + } + else if (regex.number.test(value)) { // It's a number + // Convert numerical args to numbers + value = Number(value); + meta.type = ""; + } + else if (value === "none") { + value = null; + } + else if (value === "NaN" || value === "calc(NaN)") { + value = NaN; + meta.type = ""; + } + else { + meta.type = ""; + } + + return { value: /** @type {number} */ (value), meta: /** @type {ArgumentMeta} */ (meta) }; + } + + /** + * Parse a CSS function, regardless of its name and arguments + * @param {string} str String to parse + * @return {ParseFunctionReturn | void} + */ + function parseFunction (str) { + if (!str) { + return; + } + + str = str.trim(); + + let parts = str.match(regex.function); + + if (parts) { + // It is a function, parse args + let args = []; + let argMeta = []; + let lastAlpha = false; + + let separators = parts[2].replace(regex.singleArgument, ($0, rawArg) => { + let {value, meta} = parseArgument(rawArg); + + if ($0.startsWith("/")) { + // It's alpha + lastAlpha = true; + } + + args.push(value); + argMeta.push(meta); + return ""; + }); + + return { + name: parts[1].toLowerCase(), + args, + argMeta, + lastAlpha, + commas: separators.includes(","), + rawName: parts[1], + rawArgs: parts[2], + }; + } + } + + // Type "imports" + /** @typedef {import("./types.js").ColorTypes} ColorTypes */ + /** @typedef {import("./types.js").PlainColorObject} PlainColorObject */ + + /** + * Resolves a color reference (object or string) to a plain color object + * @overload + * @param {ColorTypes} color + * @param {object} [options] + * @param {boolean} [options.parseMeta] Optional object to hold parsing metadata + * @returns {PlainColorObject} + */ + /** + * @overload + * @param {ColorTypes[]} color + * @param {object} [options] + * @param {boolean} [options.parseMeta] Optional object to hold parsing metadata + * @returns {PlainColorObject[]} + */ + function getColor (color, options) { + if (Array.isArray(color)) { + return color.map(c => getColor(c, options)); + } + + if (!color) { + throw new TypeError("Empty color reference"); + } + + if (isString(color)) { + color = parse(color, options); + } + + // Object fixup + let space = color.space || color.spaceId; + + if (!(space instanceof ColorSpace)) { + // Convert string id to color space object + color.space = ColorSpace.get(space); + } + + if (color.alpha === undefined) { + color.alpha = 1; + } + + return color; + } + + /** + * @packageDocumentation + * Defines the class and other types related to creating color spaces. + * For the builtin color spaces, see the `spaces` module. + */ + + const ε$7 = .000075; + + /** + * Class to represent a color space + */ + class ColorSpace { + constructor (options) { + this.id = options.id; + this.name = options.name; + this.base = options.base ? ColorSpace.get(options.base) : null; + this.aliases = options.aliases; + + if (this.base) { + this.fromBase = options.fromBase; + this.toBase = options.toBase; + } + + // Coordinate metadata + + let coords = options.coords ?? this.base.coords; + + for (let name in coords) { + if (!("name" in coords[name])) { + coords[name].name = name; + } + } + this.coords = coords; + + // White point + + let white = options.white ?? this.base.white ?? "D65"; + this.white = getWhite(white); + + // Sort out formats + + this.formats = options.formats ?? {}; + + for (let name in this.formats) { + let format = this.formats[name]; + format.type ||= "function"; + format.name ||= name; + } + + if (!this.formats.color?.id) { + this.formats.color = { + ...this.formats.color ?? {}, + id: options.cssId || this.id, + }; + } + + // Gamut space + + if (options.gamutSpace) { + // Gamut space explicitly specified + this.gamutSpace = options.gamutSpace === "self" ? this : ColorSpace.get(options.gamutSpace); + } + else { + // No gamut space specified, calculate a sensible default + if (this.isPolar) { + // Do not check gamut through polar coordinates + this.gamutSpace = this.base; + } + else { + this.gamutSpace = this; + } + } + + // Optimize inGamut for unbounded spaces + if (this.gamutSpace.isUnbounded) { + this.inGamut = (coords, options) => { + return true; + }; + } + + // Other stuff + this.referred = options.referred; + + // Compute ancestors and store them, since they will never change + Object.defineProperty(this, "path", { + value: getPath(this).reverse(), + writable: false, + enumerable: true, + configurable: true, + }); + + hooks.run("colorspace-init-end", this); + } + + inGamut (coords, {epsilon = ε$7} = {}) { + if (!this.equals(this.gamutSpace)) { + coords = this.to(this.gamutSpace, coords); + return this.gamutSpace.inGamut(coords, {epsilon}); + } + + let coordMeta = Object.values(this.coords); + + return coords.every((c, i) => { + let meta = coordMeta[i]; + + if (meta.type !== "angle" && meta.range) { + if (isNone(c)) { + // NaN is always in gamut + return true; + } + + let [min, max] = meta.range; + return (min === undefined || c >= min - epsilon) + && (max === undefined || c <= max + epsilon); + } + + return true; + }); + } + + get isUnbounded () { + return Object.values(this.coords).every(coord => !("range" in coord)); + } + + get cssId () { + return this.formats?.color?.id || this.id; + } + + get isPolar () { + for (let id in this.coords) { + if (this.coords[id].type === "angle") { + return true; + } + } + + return false; + } + + /** + * Lookup a format in this color space + * @param {string | object | Format} format - Format id if string. If object, it's converted to a `Format` object and returned. + * @returns {Format} + */ + getFormat (format) { + if (!format) { + return null; + } + + if (format === "default") { + format = Object.values(this.formats)[0]; + } + else if (typeof format === "string") { + format = this.formats[format]; + } + + let ret = Format.get(format, this); + + if (ret !== format && format.name in this.formats) { + // Update the format we have on file so we can find it more quickly next time + this.formats[format.name] = ret; + } + + return ret; + } + + /** + * Check if this color space is the same as another color space reference. + * Allows proxying color space objects and comparing color spaces with ids. + * @param {string | ColorSpace} space ColorSpace object or id to compare to + * @returns {boolean} + */ + equals (space) { + if (!space) { + return false; + } + + return this === space || this.id === space || this.id === space.id; + } + + to (space, coords) { + if (arguments.length === 1) { + const color = getColor(space); + [space, coords] = [color.space, color.coords]; + } + + space = ColorSpace.get(space); + + if (this.equals(space)) { + // Same space, no change needed + return coords; + } + + // Convert NaN to 0, which seems to be valid in every coordinate of every color space + coords = coords.map(c => isNone(c) ? 0 : c); + + // Find connection space = lowest common ancestor in the base tree + let myPath = this.path; + let otherPath = space.path; + + let connectionSpace, connectionSpaceIndex; + + for (let i = 0; i < myPath.length; i++) { + if (myPath[i].equals(otherPath[i])) { + connectionSpace = myPath[i]; + connectionSpaceIndex = i; + } + else { + break; + } + } + + if (!connectionSpace) { + // This should never happen + throw new Error(`Cannot convert between color spaces ${this} and ${space}: no connection space was found`); + } + + // Go up from current space to connection space + for (let i = myPath.length - 1; i > connectionSpaceIndex; i--) { + coords = myPath[i].toBase(coords); + } + + // Go down from connection space to target space + for (let i = connectionSpaceIndex + 1; i < otherPath.length; i++) { + coords = otherPath[i].fromBase(coords); + } + + return coords; + } + + from (space, coords) { + if (arguments.length === 1) { + const color = getColor(space); + [space, coords] = [color.space, color.coords]; + } + + space = ColorSpace.get(space); + + return space.to(this, coords); + } + + toString () { + return `${this.name} (${this.id})`; + } + + getMinCoords () { + let ret = []; + + for (let id in this.coords) { + let meta = this.coords[id]; + let range = meta.range || meta.refRange; + ret.push(range?.min ?? 0); + } + + return ret; + } + + static registry = {}; + + // Returns array of unique color spaces + static get all () { + return [...new Set(Object.values(ColorSpace.registry))]; + } + + static register (id, space) { + if (arguments.length === 1) { + space = arguments[0]; + id = space.id; + } + + space = this.get(space); + + if (this.registry[id] && this.registry[id] !== space) { + throw new Error(`Duplicate color space registration: '${id}'`); + } + this.registry[id] = space; + + // Register aliases when called without an explicit ID. + if (arguments.length === 1 && space.aliases) { + for (let alias of space.aliases) { + this.register(alias, space); + } + } + + return space; + } + + /** + * Lookup ColorSpace object by name + * @param {ColorSpace | string} name + */ + static get (space, ...alternatives) { + if (!space || space instanceof ColorSpace) { + return space; + } + + let argType = type(space); + + if (argType === "string") { + // It's a color space id + let ret = ColorSpace.registry[space.toLowerCase()]; + + if (!ret) { + throw new TypeError(`No color space found with id = "${space}"`); + } + + return ret; + } + + if (alternatives.length) { + return ColorSpace.get(...alternatives); + } + + throw new TypeError(`${space} is not a valid color space`); + } + + /** + * Look up all color spaces for a format that matches certain criteria + * @param {object | string} filters + * @param {Array} [spaces=ColorSpace.all] + * @returns {Format | null} + */ + static findFormat (filters, spaces = ColorSpace.all) { + if (!filters) { + return null; + } + + if (typeof filters === "string") { + filters = {name: filters}; + } + + for (let space of spaces) { + for (let [name, format] of Object.entries(space.formats)) { + format.name ??= name; + format.type ??= "function"; + + let matches = ( + (!filters.name || format.name === filters.name) && + (!filters.type || format.type === filters.type) + ); + + if (filters.id) { + let ids = format.ids || [format.id]; + let filterIds = Array.isArray(filters.id) ? filters.id : [filters.id]; + matches &&= filterIds.some(id => ids.includes(id)); + } + + if (matches) { + let ret = Format.get(format, space); + + if (ret !== format) { + space.formats[format.name] = ret; + } + + return ret; + } + } + } + + return null; + } + + /** + * Get metadata about a coordinate of a color space + * + * @static + * @param {Array | string} ref + * @param {ColorSpace | string} [workingSpace] + * @return {Object} + */ + static resolveCoord (ref, workingSpace) { + let coordType = type(ref); + let space, coord; + + if (coordType === "string") { + if (ref.includes(".")) { + // Absolute coordinate + [space, coord] = ref.split("."); + } + else { + // Relative coordinate + [space, coord] = [, ref]; + } + } + else if (Array.isArray(ref)) { + [space, coord] = ref; + } + else { + // Object + space = ref.space; + coord = ref.coordId; + } + + space = ColorSpace.get(space); + + if (!space) { + space = workingSpace; + } + + if (!space) { + throw new TypeError(`Cannot resolve coordinate reference ${ref}: No color space specified and relative references are not allowed here`); + } + + coordType = type(coord); + + if (coordType === "number" || coordType === "string" && coord >= 0) { + // Resolve numerical coord + let meta = Object.entries(space.coords)[coord]; + + if (meta) { + return {space, id: meta[0], index: coord, ...meta[1]}; + } + } + + space = ColorSpace.get(space); + + let normalizedCoord = coord.toLowerCase(); + + let i = 0; + for (let id in space.coords) { + let meta = space.coords[id]; + + if (id.toLowerCase() === normalizedCoord || meta.name?.toLowerCase() === normalizedCoord) { + return {space, id, index: i, ...meta}; + } + + i++; + } + + throw new TypeError(`No "${coord}" coordinate found in ${space.name}. Its coordinates are: ${Object.keys(space.coords).join(", ")}`); + } + + static DEFAULT_FORMAT = { + type: "functions", + name: "color", + }; + } + + function getPath (space) { + let ret = [space]; + + for (let s = space; s = s.base;) { + ret.push(s); + } + + return ret; + } + + var xyz_d65 = new ColorSpace({ + id: "xyz-d65", + name: "XYZ D65", + coords: { + x: {name: "X"}, + y: {name: "Y"}, + z: {name: "Z"}, + }, + white: "D65", + formats: { + color: { + ids: ["xyz-d65", "xyz"], + }, + }, + aliases: ["xyz"], + }); + + // Type "imports" + /** @typedef {import("./types.js").RGBOptions} RGBOptions */ + + /** Convenience class for RGB color spaces */ + class RGBColorSpace extends ColorSpace { + /** + * Creates a new RGB ColorSpace. + * If coords are not specified, they will use the default RGB coords. + * Instead of `fromBase()` and `toBase()` functions, + * you can specify to/from XYZ matrices and have `toBase()` and `fromBase()` automatically generated. + * @param {RGBOptions} options + */ + constructor (options) { + if (!options.coords) { + options.coords = { + r: { + range: [0, 1], + name: "Red", + }, + g: { + range: [0, 1], + name: "Green", + }, + b: { + range: [0, 1], + name: "Blue", + }, + }; + } + + if (!options.base) { + options.base = xyz_d65; + } + + if (options.toXYZ_M && options.fromXYZ_M) { + options.toBase ??= rgb => { + let xyz = multiply_v3_m3x3(rgb, options.toXYZ_M); + + if (this.white !== this.base.white) { + // Perform chromatic adaptation + xyz = adapt$2(this.white, this.base.white, xyz); + } + + return xyz; + }; + + options.fromBase ??= xyz => { + xyz = adapt$2(this.base.white, this.white, xyz); + return multiply_v3_m3x3(xyz, options.fromXYZ_M); + }; + } + + options.referred ??= "display"; + + super(options); + } + } + + /** @typedef {import("./types.js").ColorTypes} ColorTypes */ + /** @typedef {import("./types.js").Coords} Coords */ + + /** + * Options for {@link getAll} + * @typedef GetAllOptions + * @property {string | ColorSpace | undefined} [space] + * The color space to convert to. Defaults to the color's current space + * @property {number | undefined} [precision] + * The number of significant digits to round the coordinates to + */ + + /** + * Get the coordinates of a color in any color space + * @overload + * @param {ColorTypes} color + * @param {string | ColorSpace} [options=color.space] The color space to convert to. Defaults to the color's current space + * @returns {Coords} The color coordinates in the given color space + */ + /** + * @overload + * @param {ColorTypes} color + * @param {GetAllOptions} [options] + * @returns {Coords} The color coordinates in the given color space + */ + function getAll (color, options) { + color = getColor(color); + + let space = ColorSpace.get(options, options?.space); + let precision = options?.precision; + + let coords; + if (!space || color.space.equals(space)) { + // No conversion needed + coords = color.coords.slice(); + } + else { + coords = space.from(color); + } + + return precision === undefined ? coords : coords.map(coord => toPrecision(coord, precision)); + } + + // Type "imports" + /** @typedef {import("./types.js").ColorTypes} ColorTypes */ + /** @typedef {import("./types.js").Ref} Ref */ + + /** + * @param {ColorTypes} color + * @param {Ref} prop + * @returns {number} + */ + function get (color, prop) { + color = getColor(color); + + if (prop === "alpha") { + return color.alpha ?? 1; + } + + let {space, index} = ColorSpace.resolveCoord(prop, color.space); + let coords = getAll(color, space); + return coords[index]; + } + + // Type "imports" + /** @typedef {import("./types.js").ColorTypes} ColorTypes */ + /** @typedef {import("./types.js").Coords} Coords */ + /** @typedef {import("./types.js").PlainColorObject} PlainColorObject */ + + /** + * Set all coordinates of a color at once, in its own color space or another. + * Modifies the color in place. + * @overload + * @param {ColorTypes} color + * @param {Coords} coords Array of coordinates + * @param {number} [alpha] + * @returns {PlainColorObject} + */ + /** + * @overload + * @param {ColorTypes} color + * @param {string | ColorSpace} space The color space of the provided coordinates. + * @param {Coords} coords Array of coordinates + * @param {number} [alpha] + * @returns {PlainColorObject} + */ + function setAll (color, space, coords, alpha) { + color = getColor(color); + + if (Array.isArray(space)) { + // Space is omitted + [space, coords, alpha] = [color.space, space, coords]; + } + + space = ColorSpace.get(space); // Make sure we have a ColorSpace object + color.coords = space === color.space ? coords.slice() : space.to(color.space, coords); + + if (alpha !== undefined) { + color.alpha = alpha; + } + + return color; + } + + /** @type {"color"} */ + setAll.returns = "color"; + + // Type "imports" + /** @typedef {import("./types.js").ColorTypes} ColorTypes */ + /** @typedef {import("./types.js").PlainColorObject} PlainColorObject */ + /** @typedef {import("./types.js").Ref} Ref */ + + /** + * Set properties and return current instance + * @overload + * @param {ColorTypes} color + * @param {Ref} prop + * @param {number | ((coord: number) => number)} value + * @returns {PlainColorObject} + */ + /** + * @overload + * @param {ColorTypes} color + * @param {Record number)>} props + * @returns {PlainColorObject} + */ + function set (color, prop, value) { + color = getColor(color); + + if (arguments.length === 2 && type(arguments[1]) === "object") { + // Argument is an object literal + let object = arguments[1]; + for (let p in object) { + set(color, p, object[p]); + } + } + else { + if (typeof value === "function") { + value = value(get(color, prop)); + } + + if (prop === "alpha") { + color.alpha = value; + } + else { + let {space, index} = ColorSpace.resolveCoord(prop, color.space); + let coords = getAll(color, space); + coords[index] = value; + setAll(color, space, coords); + } + } + + return color; + } + + /** @type {"color"} */ + set.returns = "color"; + + var XYZ_D50 = new ColorSpace({ + id: "xyz-d50", + name: "XYZ D50", + white: "D50", + base: xyz_d65, + fromBase: coords => adapt$2(xyz_d65.white, "D50", coords), + toBase: coords => adapt$2("D50", xyz_d65.white, coords), + }); + + // κ * ε = 2^3 = 8 + const ε$6 = 216 / 24389; // 6^3/29^3 == (24/116)^3 + const ε3$1 = 24 / 116; + const κ$4 = 24389 / 27; // 29^3/3^3 + + let white$4 = WHITES.D50; + + var lab = new ColorSpace({ + id: "lab", + name: "Lab", + coords: { + l: { + refRange: [0, 100], + name: "Lightness", + }, + a: { + refRange: [-125, 125], + }, + b: { + refRange: [-125, 125], + }, + }, + + // Assuming XYZ is relative to D50, convert to CIE Lab + // from CIE standard, which now defines these as a rational fraction + white: white$4, + + base: XYZ_D50, + // Convert D50-adapted XYX to Lab + // CIE 15.3:2004 section 8.2.1.1 + fromBase (XYZ) { + // XYZ scaled relative to reference white + let xyz = XYZ.map((value, i) => value / white$4[i]); + let f = xyz.map(value => value > ε$6 ? Math.cbrt(value) : (κ$4 * value + 16) / 116); + + let L = 116 * f[1] - 16; + let a = 500 * (f[0] - f[1]); + let b = 200 * (f[1] - f[2]); + + return [ L, a, b ]; + }, + // Convert Lab to D50-adapted XYZ + // Same result as CIE 15.3:2004 Appendix D although the derivation is different + // http://www.brucelindbloom.com/index.html?Eqn_RGB_XYZ_Matrix.html + toBase (Lab) { + // compute f, starting with the luminance-related term + let [L, a, b] = Lab; + let f = []; + f[1] = (L + 16) / 116; + f[0] = a / 500 + f[1]; + f[2] = f[1] - b / 200; + + // compute xyz + let xyz = [ + f[0] > ε3$1 ? Math.pow(f[0], 3) : (116 * f[0] - 16) / κ$4, + Lab[0] > 8 ? Math.pow((Lab[0] + 16) / 116, 3) : Lab[0] / κ$4, + f[2] > ε3$1 ? Math.pow(f[2], 3) : (116 * f[2] - 16) / κ$4, + ]; + + // Compute XYZ by scaling xyz by reference white + return xyz.map((value, i) => value * white$4[i]); + }, + + formats: { + "lab": { + coords: [" | ", " | ", " | "], + }, + }, + }); + + /** + * Constrain an angle to 360 degrees + * @param {number} angle + * @returns {number} + */ + function constrain (angle) { + if (typeof angle !== "number") { + return angle; + } + + return ((angle % 360) + 360) % 360; + } + + /** + * @param {"raw" | "increasing" | "decreasing" | "longer" | "shorter"} arc + * @param {[number, number]} angles + * @returns {[number, number]} + */ + function adjust (arc, angles) { + let [a1, a2] = angles; + + let none1 = isNone(a1); + let none2 = isNone(a2); + + if (none1 && none2) { + return [a1, a2]; + } + else if (none1) { + a1 = a2; + } + else if (none2) { + a2 = a1; + } + + if (arc === "raw") { + return angles; + } + + a1 = constrain(a1); + a2 = constrain(a2); + + let angleDiff = a2 - a1; + + if (arc === "increasing") { + if (angleDiff < 0) { + a2 += 360; + } + } + else if (arc === "decreasing") { + if (angleDiff > 0) { + a1 += 360; + } + } + else if (arc === "longer") { + if (-180 < angleDiff && angleDiff < 180) { + if (angleDiff > 0) { + a1 += 360; + } + else { + a2 += 360; + } + } + } + else if (arc === "shorter") { + if (angleDiff > 180) { + a1 += 360; + } + else if (angleDiff < -180) { + a2 += 360; + } + } + + return [a1, a2]; + } + + var lch = new ColorSpace({ + id: "lch", + name: "LCH", + coords: { + l: { + refRange: [0, 100], + name: "Lightness", + }, + c: { + refRange: [0, 150], + name: "Chroma", + }, + h: { + refRange: [0, 360], + type: "angle", + name: "Hue", + }, + }, + + base: lab, + fromBase (Lab) { + // These methods are used for other polar forms as well, so we can't hardcode the ε + if (this.ε === undefined) { + let range = Object.values(this.base.coords)[1].refRange; + let extent = range[1] - range[0]; + this.ε = extent / 100000; + } + + // Convert to polar form + let [L, a, b] = Lab; + let isAchromatic = Math.abs(a) < this.ε && Math.abs(b) < this.ε; + let h = isAchromatic ? null : constrain(Math.atan2(b, a) * 180 / Math.PI); + let C = isAchromatic ? 0 : Math.sqrt(a ** 2 + b ** 2); + + return [ L, C, h ]; + }, + toBase (lch) { + // Convert from polar form + let [L, C, h] = lch; + let a = null, b = null; + + if (!isNone(h)) { + C = C < 0 ? 0 : C; // Clamp negative Chroma + a = C * Math.cos(h * Math.PI / 180); + b = C * Math.sin(h * Math.PI / 180); + } + + return [ L, a, b ]; + }, + + formats: { + "lch": { + coords: [" | ", " | ", " | "], + }, + }, + }); + + // deltaE2000 is a statistically significant improvement + // and is recommended by the CIE and Idealliance + // especially for color differences less than 10 deltaE76 + // but is wicked complicated + // and many implementations have small errors! + // DeltaE2000 is also discontinuous; in case this + // matters to you, use deltaECMC instead. + + const Gfactor = 25 ** 7; + const π$1 = Math.PI; + const r2d = 180 / π$1; + const d2r$1 = π$1 / 180; + + function pow7 (x) { + // Faster than x ** 7 or Math.pow(x, 7) + + const x2 = x * x; + const x7 = x2 * x2 * x2 * x; + + return x7; + } + + /** + * @param {import("../types.js").ColorTypes} color + * @param {import("../types.js").ColorTypes} sample + * @param {{ kL?: number | undefined; kC?: number | undefined; kH?: number | undefined }} options + * @returns {number} + */ + function deltaE2000 (color, sample, {kL = 1, kC = 1, kH = 1} = {}) { + [color, sample] = getColor([color, sample]); + + // Given this color as the reference + // and the function parameter as the sample, + // calculate deltaE 2000. + + // This implementation assumes the parametric + // weighting factors kL, kC and kH + // for the influence of viewing conditions + // are all 1, as sadly seems typical. + // kL should be increased for lightness texture or noise + // and kC increased for chroma noise + + let [L1, a1, b1] = lab.from(color); + let C1 = lch.from(lab, [L1, a1, b1])[1]; + let [L2, a2, b2] = lab.from(sample); + let C2 = lch.from(lab, [L2, a2, b2])[1]; + + // Check for negative Chroma, + // which might happen through + // direct user input of LCH values + + if (C1 < 0) { + C1 = 0; + } + if (C2 < 0) { + C2 = 0; + } + + let Cbar = (C1 + C2) / 2; // mean Chroma + + // calculate a-axis asymmetry factor from mean Chroma + // this turns JND ellipses for near-neutral colors back into circles + let C7 = pow7(Cbar); + + let G = 0.5 * (1 - Math.sqrt(C7 / (C7 + Gfactor))); + + // scale a axes by asymmetry factor + // this by the way is why there is no Lab2000 colorspace + let adash1 = (1 + G) * a1; + let adash2 = (1 + G) * a2; + + // calculate new Chroma from scaled a and original b axes + let Cdash1 = Math.sqrt(adash1 ** 2 + b1 ** 2); + let Cdash2 = Math.sqrt(adash2 ** 2 + b2 ** 2); + + // calculate new hues, with zero hue for true neutrals + // and in degrees, not radians + + let h1 = (adash1 === 0 && b1 === 0) ? 0 : Math.atan2(b1, adash1); + let h2 = (adash2 === 0 && b2 === 0) ? 0 : Math.atan2(b2, adash2); + + if (h1 < 0) { + h1 += 2 * π$1; + } + if (h2 < 0) { + h2 += 2 * π$1; + } + + h1 *= r2d; + h2 *= r2d; + + // Lightness and Chroma differences; sign matters + let ΔL = L2 - L1; + let ΔC = Cdash2 - Cdash1; + + // Hue difference, getting the sign correct + let hdiff = h2 - h1; + let hsum = h1 + h2; + let habs = Math.abs(hdiff); + let Δh; + + if (Cdash1 * Cdash2 === 0) { + Δh = 0; + } + else if (habs <= 180) { + Δh = hdiff; + } + else if (hdiff > 180) { + Δh = hdiff - 360; + } + else if (hdiff < -180) { + Δh = hdiff + 360; + } + else { + defaults.warn("the unthinkable has happened"); + } + + // weighted Hue difference, more for larger Chroma + let ΔH = 2 * Math.sqrt(Cdash2 * Cdash1) * Math.sin(Δh * d2r$1 / 2); + + // calculate mean Lightness and Chroma + let Ldash = (L1 + L2) / 2; + let Cdash = (Cdash1 + Cdash2) / 2; + let Cdash7 = pow7(Cdash); + + // Compensate for non-linearity in the blue region of Lab. + // Four possibilities for hue weighting factor, + // depending on the angles, to get the correct sign + let hdash; + if (Cdash1 * Cdash2 === 0) { + hdash = hsum; // which should be zero + } + else if (habs <= 180) { + hdash = hsum / 2; + } + else if (hsum < 360) { + hdash = (hsum + 360) / 2; + } + else { + hdash = (hsum - 360) / 2; + } + + // positional corrections to the lack of uniformity of CIELAB + // These are all trying to make JND ellipsoids more like spheres + + // SL Lightness crispening factor + // a background with L=50 is assumed + let lsq = (Ldash - 50) ** 2; + let SL = 1 + ((0.015 * lsq) / Math.sqrt(20 + lsq)); + + // SC Chroma factor, similar to those in CMC and deltaE 94 formulae + let SC = 1 + 0.045 * Cdash; + + // Cross term T for blue non-linearity + let T = 1; + T -= (0.17 * Math.cos(( hdash - 30) * d2r$1)); + T += (0.24 * Math.cos( 2 * hdash * d2r$1)); + T += (0.32 * Math.cos(((3 * hdash) + 6) * d2r$1)); + T -= (0.20 * Math.cos(((4 * hdash) - 63) * d2r$1)); + + // SH Hue factor depends on Chroma, + // as well as adjusted hue angle like deltaE94. + let SH = 1 + 0.015 * Cdash * T; + + // RT Hue rotation term compensates for rotation of JND ellipses + // and Munsell constant hue lines + // in the medium-high Chroma blue region + // (Hue 225 to 315) + let Δθ = 30 * Math.exp(-1 * (((hdash - 275) / 25) ** 2)); + let RC = 2 * Math.sqrt(Cdash7 / (Cdash7 + Gfactor)); + let RT = -1 * Math.sin(2 * Δθ * d2r$1) * RC; + + // Finally calculate the deltaE, term by term as root sume of squares + let dE = (ΔL / (kL * SL)) ** 2; + dE += (ΔC / (kC * SC)) ** 2; + dE += (ΔH / (kH * SH)) ** 2; + dE += RT * (ΔC / (kC * SC)) * (ΔH / (kH * SH)); + return Math.sqrt(dE); + // Yay!!! + } + + // Type "imports" + /** @typedef {import("../types.js").Matrix3x3} Matrix3x3 */ + + + // Recalculated for consistent reference white + // see https://github.com/w3c/csswg-drafts/issues/6642#issuecomment-943521484 + /** @type {Matrix3x3} */ + const XYZtoLMS_M$1 = [ + [ 0.8190224379967030, 0.3619062600528904, -0.1288737815209879 ], + [ 0.0329836539323885, 0.9292868615863434, 0.0361446663506424 ], + [ 0.0481771893596242, 0.2642395317527308, 0.6335478284694309 ], + ]; + // inverse of XYZtoLMS_M + /** @type {Matrix3x3} */ + const LMStoXYZ_M$1 = [ + [ 1.2268798758459243, -0.5578149944602171, 0.2813910456659647 ], + [ -0.0405757452148008, 1.1122868032803170, -0.0717110580655164 ], + [ -0.0763729366746601, -0.4214933324022432, 1.5869240198367816 ], + ]; + /** @type {Matrix3x3} */ + const LMStoLab_M = [ + [ 0.2104542683093140, 0.7936177747023054, -0.0040720430116193 ], + [ 1.9779985324311684, -2.4285922420485799, 0.4505937096174110 ], + [ 0.0259040424655478, 0.7827717124575296, -0.8086757549230774 ], + ]; + // LMStoIab_M inverted + /** @type {Matrix3x3} */ + const LabtoLMS_M = [ + [ 1.0000000000000000, 0.3963377773761749, 0.2158037573099136 ], + [ 1.0000000000000000, -0.1055613458156586, -0.0638541728258133 ], + [ 1.0000000000000000, -0.0894841775298119, -1.2914855480194092 ], + ]; + + var Oklab = new ColorSpace({ + id: "oklab", + name: "Oklab", + coords: { + l: { + refRange: [0, 1], + name: "Lightness", + }, + a: { + refRange: [-0.4, 0.4], + }, + b: { + refRange: [-0.4, 0.4], + }, + }, + + // Note that XYZ is relative to D65 + white: "D65", + base: xyz_d65, + fromBase (XYZ) { + // move to LMS cone domain + let LMS = multiply_v3_m3x3(XYZ, XYZtoLMS_M$1); + + // non-linearity + LMS[0] = Math.cbrt(LMS[0]); + LMS[1] = Math.cbrt(LMS[1]); + LMS[2] = Math.cbrt(LMS[2]); + + return multiply_v3_m3x3(LMS, LMStoLab_M, LMS); + }, + toBase (OKLab) { + // move to LMS cone domain + let LMSg = multiply_v3_m3x3(OKLab, LabtoLMS_M); + + // restore linearity + LMSg[0] = LMSg[0] ** 3; + LMSg[1] = LMSg[1] ** 3; + LMSg[2] = LMSg[2] ** 3; + + return multiply_v3_m3x3(LMSg, LMStoXYZ_M$1, LMSg); + }, + + formats: { + "oklab": { + coords: [" | ", " | ", " | "], + }, + }, + }); + + /** + * More accurate color-difference formulae + * than the simple 1976 Euclidean distance in CIE Lab + * @param {import("../types.js").ColorTypes} color + * @param {import("../types.js").ColorTypes} sample + * @returns {number} + */ + function deltaEOK (color, sample) { + [color, sample] = getColor([color, sample]); + + // Given this color as the reference + // and a sample, + // calculate deltaEOK, term by term as root sum of squares + let [L1, a1, b1] = Oklab.from(color); + let [L2, a2, b2] = Oklab.from(sample); + let ΔL = L1 - L2; + let Δa = a1 - a2; + let Δb = b1 - b2; + return Math.sqrt(ΔL ** 2 + Δa ** 2 + Δb ** 2); + } + + // Type "imports" + /** @typedef {import("./types.js").ColorTypes} ColorTypes */ + + const ε$5 = .000075; + + /** + * Check if a color is in gamut of either its own or another color space + * @param {ColorTypes} color + * @param {string | ColorSpace} [space] + * @param {{ epsilon?: number | undefined }} [param2] + * @returns {boolean} + */ + function inGamut (color, space, {epsilon = ε$5} = {}) { + color = getColor(color); + + if (!space) { + space = color.space; + } + + space = ColorSpace.get(space); + let coords = color.coords; + + if (space !== color.space) { + coords = space.from(color); + } + + return space.inGamut(coords, {epsilon}); + } + + // Type "imports" + /** @typedef {import("./color.js").default} Color */ + /** @typedef {import("./types.js").Coords} Coords */ + /** @typedef {import("./types.js").PlainColorObject} PlainColorObject */ + + /** + * @param {PlainColorObject} color + * @returns {PlainColorObject} + */ + function clone (color) { + return { + space: color.space, + coords: /** @type {Coords} */ (color.coords.slice()), + alpha: color.alpha, + }; + } + + // Type "imports" + /** @typedef {import("./types.js").ColorTypes} ColorTypes */ + + /** + * Euclidean distance of colors in an arbitrary color space + * @param {ColorTypes} color1 + * @param {ColorTypes} color2 + * @param {string | ColorSpace} space + * @returns {number} + */ + function distance (color1, color2, space = "lab") { + space = ColorSpace.get(space); + + // Assume getColor() is called on color in space.from() + let coords1 = space.from(color1); + let coords2 = space.from(color2); + + return Math.sqrt(coords1.reduce((acc, c1, i) => { + let c2 = coords2[i]; + if (isNone(c1) || isNone(c2)) { + return acc; + } + + return acc + (c2 - c1) ** 2; + }, 0)); + } + + /** + * @param {import("../types.js").ColorTypes} color + * @param {import("../types.js").ColorTypes} sample + * @returns {number} + */ + function deltaE76 (color, sample) { + // Assume getColor() is called in the distance function + return distance(color, sample, "lab"); + } + + // More accurate color-difference formulae + // than the simple 1976 Euclidean distance in Lab + + // CMC by the Color Measurement Committee of the + // Bradford Society of Dyeists and Colorsts, 1994. + // Uses LCH rather than Lab, + // with different weights for L, C and H differences + // A nice increase in accuracy for modest increase in complexity + const π = Math.PI; + const d2r = π / 180; + + /** + * @param {import("../types.js").ColorTypes} color + * @param {import("../types.js").ColorTypes} sample + * @param {{ l?: number | undefined; c?: number | undefined }} options + * @returns {number} + */ + function deltaECMC (color, sample, {l = 2, c = 1} = {}) { + [color, sample] = getColor([color, sample]); + + // Given this color as the reference + // and a sample, + // calculate deltaE CMC. + + // This implementation assumes the parametric + // weighting factors l:c are 2:1 + // which is typical for non-textile uses. + + let [L1, a1, b1] = lab.from(color); + let [, C1, H1] = lch.from(lab, [L1, a1, b1]); + let [L2, a2, b2] = lab.from(sample); + let C2 = lch.from(lab, [L2, a2, b2])[1]; + + // let [L1, a1, b1] = color.getAll(lab); + // let C1 = color.get("lch.c"); + // let H1 = color.get("lch.h"); + // let [L2, a2, b2] = sample.getAll(lab); + // let C2 = sample.get("lch.c"); + + // Check for negative Chroma, + // which might happen through + // direct user input of LCH values + + if (C1 < 0) { + C1 = 0; + } + if (C2 < 0) { + C2 = 0; + } + + // we don't need H2 as ΔH is calculated from Δa, Δb and ΔC + + // Lightness and Chroma differences + // These are (color - sample), unlike deltaE2000 + let ΔL = L1 - L2; + let ΔC = C1 - C2; + + let Δa = a1 - a2; + let Δb = b1 - b2; + + // weighted Hue difference, less for larger Chroma difference + + let H2 = (Δa ** 2) + (Δb ** 2) - (ΔC ** 2); + // due to roundoff error it is possible that, for zero a and b, + // ΔC > Δa + Δb is 0, resulting in attempting + // to take the square root of a negative number + + // trying instead the equation from Industrial Color Physics + // By Georg A. Klein + + // let ΔH = ((a1 * b2) - (a2 * b1)) / Math.sqrt(0.5 * ((C2 * C1) + (a2 * a1) + (b2 * b1))); + // console.log({ΔH}); + // This gives the same result to 12 decimal places + // except it sometimes NaNs when trying to root a negative number + + // let ΔH = Math.sqrt(H2); we never actually use the root, it gets squared again!! + + // positional corrections to the lack of uniformity of CIELAB + // These are all trying to make JND ellipsoids more like spheres + + // SL Lightness crispening factor, depends entirely on L1 not L2 + let SL = 0.511; // linear portion of the Y to L transfer function + if (L1 >= 16) { // cubic portion + SL = (0.040975 * L1) / (1 + 0.01765 * L1); + } + + // SC Chroma factor + let SC = ((0.0638 * C1) / (1 + 0.0131 * C1)) + 0.638; + + // Cross term T for blue non-linearity + let T; + if (isNone(H1)) { + H1 = 0; + } + + if (H1 >= 164 && H1 <= 345) { + T = 0.56 + Math.abs(0.2 * Math.cos((H1 + 168) * d2r)); + } + else { + T = 0.36 + Math.abs(0.4 * Math.cos((H1 + 35) * d2r)); + } + // console.log({T}); + + // SH Hue factor also depends on C1, + let C4 = Math.pow(C1, 4); + let F = Math.sqrt(C4 / (C4 + 1900)); + let SH = SC * ((F * T) + 1 - F); + + // Finally calculate the deltaE, term by term as root sume of squares + let dE = (ΔL / (l * SL)) ** 2; + dE += (ΔC / (c * SC)) ** 2; + dE += (H2 / (SH ** 2)); + // dE += (ΔH / SH) ** 2; + return Math.sqrt(dE); + // Yay!!! + } + + const Yw$1 = 203; // absolute luminance of media white + + var XYZ_Abs_D65 = new ColorSpace({ + // Absolute CIE XYZ, with a D65 whitepoint, + // as used in most HDR colorspaces as a starting point. + // SDR spaces are converted per BT.2048 + // so that diffuse, media white is 203 cd/m² + id: "xyz-abs-d65", + cssId: "--xyz-abs-d65", + name: "Absolute XYZ D65", + coords: { + x: { + refRange: [0, 9504.7], + name: "Xa", + }, + y: { + refRange: [0, 10000], + name: "Ya", + }, + z: { + refRange: [0, 10888.3], + name: "Za", + }, + }, + + base: xyz_d65, + fromBase (XYZ) { + // Make XYZ absolute, not relative to media white + // Maximum luminance in PQ is 10,000 cd/m² + // Relative XYZ has Y=1 for media white + return XYZ.map (v => Math.max(v * Yw$1, 0)); + }, + toBase (AbsXYZ) { + // Convert to media-white relative XYZ + return AbsXYZ.map(v => Math.max(v / Yw$1, 0)); + }, + }); + + // Type "imports" + /** @typedef {import("../types.js").Matrix3x3} Matrix3x3 */ + /** @typedef {import("../types.js").Vector3} Vector3 */ + + + const b$1 = 1.15; + const g = 0.66; + const n$1 = 2610 / (2 ** 14); + const ninv$1 = (2 ** 14) / 2610; + const c1$2 = 3424 / (2 ** 12); + const c2$2 = 2413 / (2 ** 7); + const c3$2 = 2392 / (2 ** 7); + const p = 1.7 * 2523 / (2 ** 5); + const pinv = (2 ** 5) / (1.7 * 2523); + const d = -0.56; + const d0 = 1.6295499532821566E-11; + + /** @type {Matrix3x3} */ + const XYZtoCone_M = [ + [ 0.41478972, 0.579999, 0.0146480 ], + [ -0.2015100, 1.120649, 0.0531008 ], + [ -0.0166008, 0.264800, 0.6684799 ], + ]; + // XYZtoCone_M inverted + /** @type {Matrix3x3} */ + const ConetoXYZ_M = [ + [ 1.9242264357876067, -1.0047923125953657, 0.037651404030618 ], + [ 0.35031676209499907, 0.7264811939316552, -0.06538442294808501 ], + [ -0.09098281098284752, -0.3127282905230739, 1.5227665613052603 ], + ]; + /** @type {Matrix3x3} */ + const ConetoIab_M = [ + [ 0.5, 0.5, 0 ], + [ 3.524000, -4.066708, 0.542708 ], + [ 0.199076, 1.096799, -1.295875 ], + ]; + // ConetoIab_M inverted + /** @type {Matrix3x3} */ + const IabtoCone_M = [ + [ 1, 0.1386050432715393, 0.05804731615611886 ], + [ 0.9999999999999999, -0.1386050432715393, -0.05804731615611886 ], + [ 0.9999999999999998, -0.09601924202631895, -0.8118918960560388 ], + ]; + + var Jzazbz = new ColorSpace({ + id: "jzazbz", + name: "Jzazbz", + coords: { + jz: { + refRange: [0, 1], + name: "Jz", + }, + az: { + refRange: [-0.5, 0.5], + }, + bz: { + refRange: [-0.5, 0.5], + }, + }, + + base: XYZ_Abs_D65, + fromBase (XYZ) { + // First make XYZ absolute, not relative to media white + // Maximum luminance in PQ is 10,000 cd/m² + // Relative XYZ has Y=1 for media white + // BT.2048 says media white Y=203 at PQ 58 + + let [ Xa, Ya, Za ] = XYZ; + + // modify X and Y + let Xm = (b$1 * Xa) - ((b$1 - 1) * Za); + let Ym = (g * Ya) - ((g - 1) * Xa); + + // move to LMS cone domain + let LMS = multiply_v3_m3x3([ Xm, Ym, Za ], XYZtoCone_M); + + // PQ-encode LMS + let PQLMS = /** @type {Vector3} } */ (LMS.map (function (val) { + let num = c1$2 + (c2$2 * ((val / 10000) ** n$1)); + let denom = 1 + (c3$2 * ((val / 10000) ** n$1)); + + return (num / denom) ** p; + })); + + // almost there, calculate Iz az bz + let [ Iz, az, bz] = multiply_v3_m3x3(PQLMS, ConetoIab_M); + // console.log({Iz, az, bz}); + + let Jz = ((1 + d) * Iz) / (1 + (d * Iz)) - d0; + return [Jz, az, bz]; + }, + toBase (Jzazbz) { + let [Jz, az, bz] = Jzazbz; + let Iz = (Jz + d0) / (1 + d - d * (Jz + d0)); + + // bring into LMS cone domain + let PQLMS = multiply_v3_m3x3([ Iz, az, bz ], IabtoCone_M); + + // convert from PQ-coded to linear-light + let LMS = /** @type {Vector3} } */ (PQLMS.map(function (val) { + let num = (c1$2 - (val ** pinv)); + let denom = (c3$2 * (val ** pinv)) - c2$2; + let x = 10000 * ((num / denom) ** ninv$1); + + return (x); // luminance relative to diffuse white, [0, 70 or so]. + })); + + // modified abs XYZ + let [ Xm, Ym, Za ] = multiply_v3_m3x3(LMS, ConetoXYZ_M); + + // restore standard D50 relative XYZ, relative to media white + let Xa = (Xm + ((b$1 - 1) * Za)) / b$1; + let Ya = (Ym + ((g - 1) * Xa)) / g; + return [ Xa, Ya, Za ]; + }, + + formats: { + // https://drafts.csswg.org/css-color-hdr/#Jzazbz + "color": { + coords: [" | ", " | ", " | "], + }, + }, + }); + + var jzczhz = new ColorSpace({ + id: "jzczhz", + name: "JzCzHz", + coords: { + jz: { + refRange: [0, 1], + name: "Jz", + }, + cz: { + refRange: [0, 1], + name: "Chroma", + }, + hz: { + refRange: [0, 360], + type: "angle", + name: "Hue", + }, + }, + + base: Jzazbz, + fromBase: lch.fromBase, + toBase: lch.toBase, + }); + + /** + * More accurate color-difference formulae + * than the simple 1976 Euclidean distance in Lab + * + * Uses JzCzHz, which has improved perceptual uniformity + * and thus a simple Euclidean root-sum of ΔL² ΔC² ΔH² + * gives good results. + * @param {import("../types.js").ColorTypes} color + * @param {import("../types.js").ColorTypes} sample + * @returns {number} + */ + function deltaEJz (color, sample) { + [color, sample] = getColor([color, sample]); + + // Given this color as the reference + // and a sample, + // calculate deltaE in JzCzHz. + let [Jz1, Cz1, Hz1] = jzczhz.from(color); + let [Jz2, Cz2, Hz2] = jzczhz.from(sample); + + // Lightness and Chroma differences + // sign does not matter as they are squared. + let ΔJ = Jz1 - Jz2; + let ΔC = Cz1 - Cz2; + + // length of chord for ΔH + if ((isNone(Hz1)) && (isNone(Hz2))) { + // both undefined hues + Hz1 = 0; + Hz2 = 0; + } + else if (isNone(Hz1)) { + // one undefined, set to the defined hue + Hz1 = Hz2; + } + else if (isNone(Hz2)) { + Hz2 = Hz1; + } + + let Δh = Hz1 - Hz2; + let ΔH = 2 * Math.sqrt(Cz1 * Cz2) * Math.sin((Δh / 2) * (Math.PI / 180)); + + return Math.sqrt(ΔJ ** 2 + ΔC ** 2 + ΔH ** 2); + } + + // Type "imports" + /** @typedef {import("../types.js").Matrix3x3} Matrix3x3 */ + /** @typedef {import("../types.js").Vector3} Vector3 */ + + const c1$1 = 3424 / 4096; + const c2$1 = 2413 / 128; + const c3$1 = 2392 / 128; + const m1$1 = 2610 / 16384; + const m2 = 2523 / 32; + const im1 = 16384 / 2610; + const im2 = 32 / 2523; + + // The matrix below includes the 4% crosstalk components + // and is from the Dolby "What is ICtCp" paper" + /** @type {Matrix3x3} */ + const XYZtoLMS_M = [ + [ 0.3592832590121217, 0.6976051147779502, -0.0358915932320290 ], + [ -0.1920808463704993, 1.1004767970374321, 0.0753748658519118 ], + [ 0.0070797844607479, 0.0748396662186362, 0.8433265453898765 ], + ]; + // linear-light Rec.2020 to LMS, again with crosstalk + // rational terms from Jan Fröhlich, + // Encoding High Dynamic Range andWide Color Gamut Imagery, p.97 + // and ITU-R BT.2124-0 p.2 + /* + const Rec2020toLMS_M = [ + [ 1688 / 4096, 2146 / 4096, 262 / 4096 ], + [ 683 / 4096, 2951 / 4096, 462 / 4096 ], + [ 99 / 4096, 309 / 4096, 3688 / 4096 ] + ]; + */ + // this includes the Ebner LMS coefficients, + // the rotation, and the scaling to [-0.5,0.5] range + // rational terms from Fröhlich p.97 + // and ITU-R BT.2124-0 pp.2-3 + /** @type {Matrix3x3} */ + const LMStoIPT_M = [ + [ 2048 / 4096, 2048 / 4096, 0 ], + [ 6610 / 4096, -13613 / 4096, 7003 / 4096 ], + [ 17933 / 4096, -17390 / 4096, -543 / 4096 ], + ]; + + // inverted matrices, calculated from the above + /** @type {Matrix3x3} */ + const IPTtoLMS_M = [ + [ 0.9999999999999998, 0.0086090370379328, 0.1110296250030260 ], + [ 0.9999999999999998, -0.0086090370379328, -0.1110296250030259 ], + [ 0.9999999999999998, 0.5600313357106791, -0.3206271749873188 ], + ]; + /* + const LMStoRec2020_M = [ + [ 3.4375568932814012112, -2.5072112125095058195, 0.069654319228104608382], + [-0.79142868665644156125, 1.9838372198740089874, -0.19240853321756742626 ], + [-0.025646662911506476363, -0.099240248643945566751, 1.1248869115554520431 ] + ]; + */ + /** @type {Matrix3x3} */ + const LMStoXYZ_M = [ + [ 2.0701522183894223, -1.3263473389671563, 0.2066510476294053 ], + [ 0.3647385209748072, 0.6805660249472273, -0.0453045459220347 ], + [ -0.0497472075358123, -0.0492609666966131, 1.1880659249923042 ], + ]; + + // Only the PQ form of ICtCp is implemented here. There is also an HLG form. + // from Dolby, "WHAT IS ICTCP?" + // https://professional.dolby.com/siteassets/pdfs/ictcp_dolbywhitepaper_v071.pdf + // and + // Dolby, "Perceptual Color Volume + // Measuring the Distinguishable Colors of HDR and WCG Displays" + // https://professional.dolby.com/siteassets/pdfs/dolby-vision-measuring-perceptual-color-volume-v7.1.pdf + var ictcp = new ColorSpace({ + id: "ictcp", + name: "ICTCP", + // From BT.2100-2 page 7: + // During production, signal values are expected to exceed the + // range E′ = [0.0 : 1.0]. This provides processing headroom and avoids + // signal degradation during cascaded processing. Such values of E′, + // below 0.0 or exceeding 1.0, should not be clipped during production + // and exchange. + // Values below 0.0 should not be clipped in reference displays (even + // though they represent “negative” light) to allow the black level of + // the signal (LB) to be properly set using test signals known as “PLUGE” + coords: { + i: { + refRange: [0, 1], // Constant luminance, + name: "I", + }, + ct: { + refRange: [-0.5, 0.5], // Full BT.2020 gamut in range [-0.5, 0.5] + name: "CT", + }, + cp: { + refRange: [-0.5, 0.5], + name: "CP", + }, + }, + + base: XYZ_Abs_D65, + fromBase (XYZ) { + // move to LMS cone domain + let LMS = multiply_v3_m3x3(XYZ, XYZtoLMS_M); + + return LMStoICtCp(LMS); + }, + toBase (ICtCp) { + let LMS = ICtCptoLMS(ICtCp); + + return multiply_v3_m3x3(LMS, LMStoXYZ_M); + }, + }); + + /** + * + * @param {Vector3} LMS + * @returns {Vector3} + */ + function LMStoICtCp (LMS) { + // apply the PQ EOTF + // we can't ever be dividing by zero because of the "1 +" in the denominator + let PQLMS = /** @type {Vector3} */ (LMS.map (function (val) { + let num = c1$1 + (c2$1 * ((val / 10000) ** m1$1)); + let denom = 1 + (c3$1 * ((val / 10000) ** m1$1)); + + return (num / denom) ** m2; + })); + + // LMS to IPT, with rotation for Y'C'bC'r compatibility + return multiply_v3_m3x3(PQLMS, LMStoIPT_M); + } + + /** + * + * @param {Vector3} ICtCp + * @returns {Vector3} + */ + function ICtCptoLMS (ICtCp) { + let PQLMS = multiply_v3_m3x3(ICtCp, IPTtoLMS_M); + + // From BT.2124-0 Annex 2 Conversion 3 + let LMS = /** @type {Vector3} */ (PQLMS.map (function (val) { + let num = Math.max((val ** im2) - c1$1, 0); + let denom = (c2$1 - (c3$1 * (val ** im2))); + return 10000 * ((num / denom) ** im1); + })); + + return LMS; + } + + /** + * Delta E in ICtCp space, + * which the ITU calls Delta E ITP, which is shorter. + * Formulae from ITU Rec. ITU-R BT.2124-0 + * @param {import("../types.js").ColorTypes} color + * @param {import("../types.js").ColorTypes} sample + * @returns {number} + */ + function deltaEITP (color, sample) { + [color, sample] = getColor([color, sample]); + + // Given this color as the reference + // and a sample, + // calculate deltaE in ICtCp + // which is simply the Euclidean distance + + let [ I1, T1, P1 ] = ictcp.from(color); + let [ I2, T2, P2 ] = ictcp.from(sample); + + // the 0.25 factor is to undo the encoding scaling in Ct + // the 720 is so that 1 deltaE = 1 JND + // per ITU-R BT.2124-0 p.3 + + return 720 * Math.sqrt((I1 - I2) ** 2 + (0.25 * (T1 - T2) ** 2) + (P1 - P2) ** 2); + } + + /** + * More accurate color-difference formulae + * than the simple 1976 Euclidean distance in CIE Lab + * The Oklab a and b axes are scaled relative to the L axis, for better uniformity + * Björn Ottosson said: + * "I've recently done some tests with color distance datasets as implemented + * in Colorio and on both the Combvd dataset and the OSA-UCS dataset a + * scale factor of slightly more than 2 for a and b would give the best results + * (2.016 works best for Combvd and 2.045 for the OSA-UCS dataset)." + * @see {@link } + * @param {import("../types.js").ColorTypes} color + * @param {import("../types.js").ColorTypes} sample + * @returns {number} + */ + function deltaEOK2 (color, sample) { + [color, sample] = getColor([color, sample]); + + // Given this color as the reference + // and a sample, + // calculate deltaEOK2, term by term as root sum of squares + let abscale = 2; + let [L1, a1, b1] = Oklab.from(color); + let [L2, a2, b2] = Oklab.from(sample); + let ΔL = L1 - L2; + let Δa = abscale * (a1 - a2); + let Δb = abscale * (b1 - b2); + return Math.sqrt(ΔL ** 2 + Δa ** 2 + Δb ** 2); + } + + // Type "imports" + /** @typedef {import("../types.js").Coords} Coords */ + /** @typedef {import("../types.js").Matrix3x3} Matrix3x3 */ + /** @typedef {import("../types.js").Vector3} Vector3 */ + + const white$3 = WHITES.D65; + const adaptedCoef = 0.42; + const adaptedCoefInv = 1 / adaptedCoef; + const tau$1 = 2 * Math.PI; + + /** @type {Matrix3x3} */ + const cat16 = [ + [ 0.401288, 0.650173, -0.051461 ], + [ -0.250268, 1.204414, 0.045854 ], + [ -0.002079, 0.048952, 0.953127 ], + ]; + + /** @type {Matrix3x3} */ + const cat16Inv = [ + [1.8620678550872327, -1.0112546305316843, 0.14918677544445175], + [0.38752654323613717, 0.6214474419314753, -0.008973985167612518], + [-0.015841498849333856, -0.03412293802851557, 1.0499644368778496], + ]; + + /** @type {Matrix3x3} */ + const m1 = [ + [460.0, 451.0, 288.0], + [460.0, -891.0, -261.0], + [460.0, -220.0, -6300.0], + ]; + + const surroundMap = { + dark: [0.8, 0.525, 0.8], + dim: [0.9, 0.59, 0.9], + average: [1, 0.69, 1], + }; + + const hueQuadMap = { + // Red, Yellow, Green, Blue, Red + h: [20.14, 90.00, 164.25, 237.53, 380.14], + e: [0.8, 0.7, 1.0, 1.2, 0.8], + H: [0.0, 100.0, 200.0, 300.0, 400.0], + }; + + const rad2deg = 180 / Math.PI; + const deg2rad$1 = Math.PI / 180; + + /** + * @param {Coords} coords + * @param {number} fl + * @returns {[number, number, number]} + */ + function adapt$1 (coords, fl) { + const temp = /** @type {[number, number, number]} */ (coords.map(c => { + const x = spow(fl * Math.abs(c) * 0.01, adaptedCoef); + return 400 * copySign(x, c) / (x + 27.13); + })); + return temp; + } + + /** + * @param {Coords} adapted + * @param {number} fl + * @returns {[number, number, number]} + */ + function unadapt (adapted, fl) { + const constant = 100 / fl * (27.13 ** adaptedCoefInv); + return /** @type {[number, number, number]} */ (adapted.map(c => { + const cabs = Math.abs(c); + return copySign(constant * spow(cabs / (400 - cabs), adaptedCoefInv), c); + })); + } + + /** + * @param {number} h + */ + function hueQuadrature (h) { + let hp = constrain(h); + if (hp <= hueQuadMap.h[0]) { + hp += 360; + } + + const i = bisectLeft(hueQuadMap.h, hp) - 1; + const [hi, hii] = hueQuadMap.h.slice(i, i + 2); + const [ei, eii] = hueQuadMap.e.slice(i, i + 2); + const Hi = hueQuadMap.H[i]; + + const t = (hp - hi) / ei; + return Hi + (100 * t) / (t + (hii - hp) / eii); + } + + /** + * @param {number} H + */ + function invHueQuadrature (H) { + let Hp = ((H % 400 + 400) % 400); + const i = Math.floor(0.01 * Hp); + Hp = Hp % 100; + const [hi, hii] = hueQuadMap.h.slice(i, i + 2); + const [ei, eii] = hueQuadMap.e.slice(i, i + 2); + + return constrain( + (Hp * (eii * hi - ei * hii) - 100 * hi * eii) / + (Hp * (eii - ei) - 100 * eii), + ); + } + + /** + * @param {[number, number, number]} refWhite + * @param {number} adaptingLuminance + * @param {number} backgroundLuminance + * @param {keyof typeof surroundMap} surround + * @param {boolean} discounting + */ + function environment ( + refWhite, + adaptingLuminance, + backgroundLuminance, + surround, + discounting, + ) { + + const env = {}; + + env.discounting = discounting; + env.refWhite = refWhite; + env.surround = surround; + const xyzW = /** @type {Vector3} */ (refWhite.map(c => { + return c * 100; + })); + + // The average luminance of the environment in `cd/m^2cd/m` (a.k.a. nits) + env.la = adaptingLuminance; + // The relative luminance of the nearby background + env.yb = backgroundLuminance; + // Absolute luminance of the reference white. + const yw = xyzW[1]; + + // Cone response for reference white + const rgbW = multiply_v3_m3x3(xyzW, cat16); + + // Surround: dark, dim, and average + // @ts-expect-error surround is never used again + surround = surroundMap[env.surround]; + const f = surround[0]; + env.c = surround[1]; + env.nc = surround[2]; + + const k = 1 / (5 * env.la + 1); + const k4 = k ** 4; + + // Factor of luminance level adaptation + env.fl = (k4 * env.la + 0.1 * (1 - k4) * (1 - k4) * Math.cbrt(5 * env.la)); + env.flRoot = env.fl ** 0.25; + + env.n = env.yb / yw; + env.z = 1.48 + Math.sqrt(env.n); + env.nbb = 0.725 * (env.n ** -0.2); + env.ncb = env.nbb; + + // Degree of adaptation calculating if not discounting + // illuminant (assumed eye is fully adapted) + const d = Math.max( + Math.min(f * (1 - 1 / 3.6 * Math.exp((-env.la - 42) / 92)), 1), + 0, + ); + env.dRgb = rgbW.map(c => { + return interpolate(1, yw / c, d); + }); + env.dRgbInv = env.dRgb.map(c => { + return 1 / c; + }); + + // Achromatic response + const rgbCW = /** @type {[number, number, number]} */ (rgbW.map((c, i) => { + return c * env.dRgb[i]; + })); + const rgbAW = adapt$1(rgbCW, env.fl); + env.aW = env.nbb * (2 * rgbAW[0] + rgbAW[1] + 0.05 * rgbAW[2]); + + // console.log(env); + + return env; + } + + // Pre-calculate everything we can with the viewing conditions + const viewingConditions$1 = environment( + white$3, + 64 / Math.PI * 0.2, 20, + "average", + false, + ); + + /** @typedef {{J: number, C: number, h: number, s: number, Q: number, M: number, H: number}} Cam16Object */ + + /** + * @param {Cam16Object} cam16 + * @param {Record} env + * @returns {[number, number, number]} + * @todo Add types for `env` + */ + function fromCam16 (cam16, env) { + + // These check ensure one, and only one attribute for a + // given category is provided. + if (!((cam16.J !== undefined) ^ (cam16.Q !== undefined))) { + throw new Error("Conversion requires one and only one: 'J' or 'Q'"); + } + + if (!((cam16.C !== undefined) ^ (cam16.M !== undefined) ^ (cam16.s !== undefined))) { + throw new Error("Conversion requires one and only one: 'C', 'M' or 's'"); + } + + // Hue is absolutely required + if (!((cam16.h !== undefined) ^ (cam16.H !== undefined))) { + throw new Error("Conversion requires one and only one: 'h' or 'H'"); + } + + // Black + if (cam16.J === 0.0 || cam16.Q === 0.0) { + return [0.0, 0.0, 0.0]; + } + + // Break hue into Cartesian components + let hRad = 0.0; + if (cam16.h !== undefined) { + hRad = constrain(cam16.h) * deg2rad$1; + } + else { + hRad = invHueQuadrature(cam16.H) * deg2rad$1; + } + + const cosh = Math.cos(hRad); + const sinh = Math.sin(hRad); + + // Calculate `Jroot` from one of the lightness derived coordinates. + let Jroot = 0.0; + if (cam16.J !== undefined) { + Jroot = spow(cam16.J, 1 / 2) * 0.1; + } + else if (cam16.Q !== undefined) { + Jroot = 0.25 * env.c * cam16.Q / ((env.aW + 4) * env.flRoot); + } + + // Calculate the `t` value from one of the chroma derived coordinates + let alpha = 0.0; + if (cam16.C !== undefined) { + alpha = cam16.C / Jroot; + } + else if (cam16.M !== undefined) { + alpha = (cam16.M / env.flRoot) / Jroot; + } + else if (cam16.s !== undefined) { + alpha = 0.0004 * (cam16.s ** 2) * (env.aW + 4) / env.c; + } + const t = spow( + alpha * Math.pow(1.64 - Math.pow(0.29, env.n), -0.73), + 10 / 9, + ); + + // Eccentricity + const et = 0.25 * (Math.cos(hRad + 2) + 3.8); + + // Achromatic response + const A = env.aW * spow(Jroot, 2 / env.c / env.z); + + // Calculate red-green and yellow-blue components + const p1 = 5e4 / 13 * env.nc * env.ncb * et; + const p2 = A / env.nbb; + const r = ( + 23 * (p2 + 0.305) * + zdiv(t, 23 * p1 + t * (11 * cosh + 108 * sinh)) + ); + const a = r * cosh; + const b = r * sinh; + + // Calculate back from cone response to XYZ + const rgb_c = unadapt( + /** @type {Vector3} */ + (multiply_v3_m3x3([p2, a, b], m1).map(c => { + return c * 1 / 1403; + })), + env.fl, + ); + return /** @type {Vector3} */ (multiply_v3_m3x3( + /** @type {Vector3} */(rgb_c.map((c, i) => { + return c * env.dRgbInv[i]; + })), + cat16Inv, + ).map(c => { + return c / 100; + })); + } + + /** + * @param {[number, number, number]} xyzd65 + * @param {Record} env + * @returns {Cam16Object} + * @todo Add types for `env` + */ + function toCam16 (xyzd65, env) { + // Cone response + const xyz100 = /** @type {Vector3} */ (xyzd65.map(c => { + return c * 100; + })); + const rgbA = adapt$1( + /** @type {[number, number, number]} */ + (multiply_v3_m3x3(xyz100, cat16).map((c, i) => { + return c * env.dRgb[i]; + })), + env.fl, + ); + + // Calculate hue from red-green and yellow-blue components + const a = rgbA[0] + (-12 * rgbA[1] + rgbA[2]) / 11; + const b = (rgbA[0] + rgbA[1] - 2 * rgbA[2]) / 9; + const hRad = ((Math.atan2(b, a) % tau$1) + tau$1) % tau$1; + + // Eccentricity + const et = 0.25 * (Math.cos(hRad + 2) + 3.8); + + const t = ( + 5e4 / 13 * env.nc * env.ncb * + zdiv( + et * Math.sqrt(a ** 2 + b ** 2), + rgbA[0] + rgbA[1] + 1.05 * rgbA[2] + 0.305, + ) + ); + const alpha = spow(t, 0.9) * Math.pow(1.64 - Math.pow(0.29, env.n), 0.73); + + // Achromatic response + const A = env.nbb * (2 * rgbA[0] + rgbA[1] + 0.05 * rgbA[2]); + + const Jroot = spow(A / env.aW, 0.5 * env.c * env.z); + + // Lightness + const J = 100 * spow(Jroot, 2); + + // Brightness + const Q = (4 / env.c * Jroot * (env.aW + 4) * env.flRoot); + + // Chroma + const C = alpha * Jroot; + + // Colorfulness + const M = C * env.flRoot; + + // Hue + const h = constrain(hRad * rad2deg); + + // Hue quadrature + const H = hueQuadrature(h); + + // Saturation + const s = 50 * spow(env.c * alpha / (env.aW + 4), 1 / 2); + + // console.log({J: J, C: C, h: h, s: s, Q: Q, M: M, H: H}); + + return {J: J, C: C, h: h, s: s, Q: Q, M: M, H: H}; + } + + + // Provided as a way to directly evaluate the CAM16 model + // https://observablehq.com/@jrus/cam16: reference implementation + // https://arxiv.org/pdf/1802.06067.pdf: Nico Schlömer + // https://onlinelibrary.wiley.com/doi/pdf/10.1002/col.22324: hue quadrature + // https://www.researchgate.net/publication/318152296_Comprehensive_color_solutions_CAM16_CAT16_and_CAM16-UCS + // Results compared against: https://github.com/colour-science/colour + var cam16 = new ColorSpace({ + id: "cam16-jmh", + cssId: "--cam16-jmh", + name: "CAM16-JMh", + coords: { + j: { + refRange: [0, 100], + name: "J", + }, + m: { + refRange: [0, 105.0], + name: "Colorfulness", + }, + h: { + refRange: [0, 360], + type: "angle", + name: "Hue", + }, + }, + + base: xyz_d65, + + fromBase (xyz) { + const cam16 = toCam16(xyz, viewingConditions$1); + return [cam16.J, cam16.M, cam16.h]; + }, + toBase (cam16) { + return fromCam16( + {J: cam16[0], M: cam16[1], h: cam16[2]}, + viewingConditions$1, + ); + }, + }); + + const white$2 = WHITES.D65; + const ε$4 = 216 / 24389; // 6^3/29^3 == (24/116)^3 + const κ$3 = 24389 / 27; // 29^3/3^3 + + function toLstar (y) { + // Convert XYZ Y to L* + + const fy = (y > ε$4) ? Math.cbrt(y) : (κ$3 * y + 16) / 116; + return (116.0 * fy) - 16.0; + } + + function fromLstar (lstar) { + // Convert L* back to XYZ Y + + return (lstar > 8) ? Math.pow((lstar + 16) / 116, 3) : lstar / κ$3; + } + + function fromHct (coords, env) { + // Use Newton's method to try and converge as quick as possible or + // converge as close as we can. While the requested precision is achieved + // most of the time, it may not always be achievable. Especially past the + // visible spectrum, the algorithm will likely struggle to get the same + // precision. If, for whatever reason, we cannot achieve the accuracy we + // seek in the allotted iterations, just return the closest we were able to + // get. + + let [h, c, t] = coords; + let xyz = []; + let j = 0; + + // Shortcut out for black + if (t === 0) { + return [0.0, 0.0, 0.0]; + } + + // Calculate the Y we need to target + let y = fromLstar(t); + + // A better initial guess yields better results. Polynomials come from + // curve fitting the T vs J response. + if (t > 0) { + j = 0.00379058511492914 * t ** 2 + 0.608983189401032 * t + 0.9155088574762233; + } + else { + j = 9.514440756550361e-06 * t ** 2 + 0.08693057439788597 * t - 21.928975842194614; + } + + // Threshold of how close is close enough, and max number of attempts. + // More precision and more attempts means more time spent iterating. Higher + // required precision gives more accuracy but also increases the chance of + // not hitting the goal. 2e-12 allows us to convert round trip with + // reasonable accuracy of six decimal places or more. + const threshold = 2e-12; + const max_attempts = 15; + + let attempt = 0; + let last = Infinity; + + // Try to find a J such that the returned y matches the returned y of the L* + while (attempt <= max_attempts) { + xyz = fromCam16({J: j, C: c, h: h}, env); + + // If we are within range, return XYZ + // If we are closer than last time, save the values + const delta = Math.abs(xyz[1] - y); + if (delta < last) { + if (delta <= threshold) { + return xyz; + } + last = delta; + } + + // f(j_root) = (j ** (1 / 2)) * 0.1 + // f(j) = ((f(j_root) * 100) ** 2) / j - 1 = 0 + // f(j_root) = Y = y / 100 + // f(j) = (y ** 2) / j - 1 + // f'(j) = (2 * y) / j + j = j - (xyz[1] - y) * j / (2 * xyz[1]); + + attempt += 1; + } + + // We could not acquire the precision we desired, + // return our closest attempt. + return fromCam16({J: j, C: c, h: h}, env); + } + + function toHct (xyz, env) { + // Calculate HCT by taking the L* of CIE LCh D65 and CAM16 chroma and hue. + + const t = toLstar(xyz[1]); + if (t === 0.0) { + return [0.0, 0.0, 0.0]; + } + const cam16 = toCam16(xyz, viewingConditions); + return [constrain(cam16.h), cam16.C, t]; + } + + // Pre-calculate everything we can with the viewing conditions + const viewingConditions = environment( + white$2, 200 / Math.PI * fromLstar(50.0), + fromLstar(50.0) * 100, + "average", + false, + ); + + // https://material.io/blog/science-of-color-design + // This is not a port of the material-color-utilities, + // but instead implements the full color space as described, + // combining CAM16 JCh and Lab D65. This does not clamp conversion + // to HCT to specific chroma bands and provides support for wider + // gamuts than Google currently supports and does so at a greater + // precision (> 8 bits back to sRGB). + // This implementation comes from https://github.com/facelessuser/coloraide + // which is licensed under MIT. + var hct = new ColorSpace({ + id: "hct", + name: "HCT", + coords: { + h: { + refRange: [0, 360], + type: "angle", + name: "Hue", + }, + c: { + refRange: [0, 145], + name: "Colorfulness", + }, + t: { + refRange: [0, 100], + name: "Tone", + }, + }, + + base: xyz_d65, + + fromBase (xyz) { + return toHct(xyz); + }, + toBase (hct) { + return fromHct(hct, viewingConditions); + }, + formats: { + color: { + id: "--hct", + coords: [" | ", " | ", " | "], + }, + }, + }); + + const deg2rad = Math.PI / 180; + const ucsCoeff = [1.00, 0.007, 0.0228]; + + /** + * Convert HCT chroma and hue (CAM16 JMh colorfulness and hue) using UCS logic for a and b. + * @param {Coords} coords - HCT coordinates. + * @return {number[]} + */ + function convertUcsAb (coords) { + // We want the distance between the actual color. + // If chroma is negative, it will throw off our calculations. + // Normally, converting back to the base and forward will correct it. + // If we have a negative chroma after this, then we have a color that + // cannot resolve to positive chroma. + if (coords[1] < 0) { + coords = hct.fromBase(hct.toBase(coords)); + } + + // Only in extreme cases (usually outside the visible spectrum) + // can the input value for log become negative. + // Avoid domain error by forcing a zero result via "max" if necessary. + const M = Math.log(Math.max(1 + ucsCoeff[2] * coords[1] * viewingConditions.flRoot, 1.0)) / ucsCoeff[2]; + const hrad = coords[0] * deg2rad; + const a = M * Math.cos(hrad); + const b = M * Math.sin(hrad); + + return [coords[2], a, b]; + } + + + /** + * Color distance using HCT. + * @param {import("../types.js").ColorTypes} color + * @param {import("../types.js").ColorTypes} sample + * @returns {number} + */ + function deltaEHCT (color, sample) { + [color, sample] = getColor([color, sample]); + + let [ t1, a1, b1 ] = convertUcsAb(hct.from(color)); + let [ t2, a2, b2 ] = convertUcsAb(hct.from(sample)); + + // Use simple euclidean distance with a and b using UCS conversion + // and LCh lightness (HCT tone). + return Math.sqrt((t1 - t2) ** 2 + (a1 - a2) ** 2 + (b1 - b2) ** 2); + } + + /** + * @packageDocumentation + * This module defines all the builtin deltaE methods. + */ + + var deltaEMethods = { + deltaE76, + deltaECMC, + deltaE2000, + deltaEJz, + deltaEITP, + deltaEOK, + deltaEOK2, + deltaEHCT, + }; + + /** @typedef {keyof typeof import("./index.js").default extends `deltaE${infer Method}` ? Method : string} Methods */ + + // Type "imports" + /** @typedef {import("./types.js").ColorTypes} ColorTypes */ + /** @typedef {import("./types.js").PlainColorObject} PlainColorObject */ + /** @typedef {import("./types.js").ToGamutOptions} ToGamutOptions */ + + /** + * Calculate the epsilon to 2 degrees smaller than the specified JND. + * @param {number} jnd The target "just noticeable difference". + * @returns {number} + */ + function calcEpsilon (jnd) { + // Calculate the epsilon to 2 degrees smaller than the specified JND. + + const order = (!jnd) ? 0 : Math.floor(Math.log10(Math.abs(jnd))); + // Limit to an arbitrary value to ensure value is never too small and causes infinite loops. + return Math.max(parseFloat(`1e${order - 2}`), 1e-6); + } + + const GMAPPRESET = { + "hct": { + method: "hct.c", + jnd: 2, + deltaEMethod: "hct", + blackWhiteClamp: {}, + }, + "hct-tonal": { + method: "hct.c", + jnd: 0, + deltaEMethod: "hct", + blackWhiteClamp: { channel: "hct.t", min: 0, max: 100 }, + }, + }; + + /** + * Force coordinates to be in gamut of a certain color space. + * Mutates the color it is passed. + * @overload + * @param {ColorTypes} color + * @param {ToGamutOptions} [options] + * @returns {PlainColorObject} + */ + /** + * @overload + * @param {ColorTypes} color + * @param {string} [space] + * @returns {PlainColorObject} + */ + /** + * @param {ColorTypes} color + * @param {string & Partial | ToGamutOptions} [space] + * @returns {PlainColorObject} + */ + function toGamut ( + color, + { + method = defaults.gamut_mapping, + space = undefined, + deltaEMethod = "", + jnd = 2, + blackWhiteClamp = {}, + } = {}, + ) { + color = getColor(color); + + if (isString(arguments[1])) { + space = arguments[1]; + } + else if (!space) { + space = color.space; + } + + space = ColorSpace.get(space); + + // 3 spaces: + // color.space: current color space + // space: space whose gamut we are mapping to + // mapSpace: space with the coord we're reducing + + if (inGamut(color, space, { epsilon: 0 })) { + return /** @type {PlainColorObject} */ (color); + } + + let spaceColor; + if (method === "css") { + spaceColor = toGamutCSS(color, { space }); + } + else { + if (method !== "clip" && !inGamut(color, space)) { + if (Object.prototype.hasOwnProperty.call(GMAPPRESET, method)) { + ({method, jnd, deltaEMethod, blackWhiteClamp} = GMAPPRESET[method]); + } + + // Get the correct delta E method + let de = deltaE2000; + if (deltaEMethod !== "") { + for (let m in deltaEMethods) { + if ("deltae" + deltaEMethod.toLowerCase() === m.toLowerCase()) { + de = deltaEMethods[m]; + break; + } + } + } + + let clipped = toGamut(to(color, space), { method: "clip", space }); + if (de(color, clipped) > jnd) { + + // Clamp to SDR white and black if required + if (Object.keys(blackWhiteClamp).length === 3) { + let channelMeta = ColorSpace.resolveCoord(blackWhiteClamp.channel); + let channel = get(to(color, channelMeta.space), channelMeta.id); + if (isNone(channel)) { + channel = 0; + } + if (channel >= blackWhiteClamp.max) { + return to({ space: "xyz-d65", coords: WHITES["D65"] }, color.space); + } + else if (channel <= blackWhiteClamp.min) { + return to({ space: "xyz-d65", coords: [0, 0, 0] }, color.space); + } + } + + // Reduce a coordinate of a certain color space until the color is in gamut + let coordMeta = ColorSpace.resolveCoord(method); + let mapSpace = coordMeta.space; + let coordId = coordMeta.id; + + let mappedColor = to(color, mapSpace); + // If we were already in the mapped color space, we need to resolve undefined channels + mappedColor.coords.forEach((c, i) => { + if (isNone(c)) { + mappedColor.coords[i] = 0; + } + }); + let bounds = coordMeta.range || coordMeta.refRange; + let min = bounds[0]; + let ε = calcEpsilon(jnd); + let low = min; + let high = get(mappedColor, coordId); + + while (high - low > ε) { + let clipped = clone(mappedColor); + clipped = toGamut(clipped, { space, method: "clip" }); + let deltaE = de(mappedColor, clipped); + + if (deltaE - jnd < ε) { + low = get(mappedColor, coordId); + } + else { + high = get(mappedColor, coordId); + } + + set(mappedColor, coordId, (low + high) / 2); + } + + spaceColor = to(mappedColor, space); + } + else { + spaceColor = clipped; + } + } + else { + spaceColor = to(color, space); + } + + if (method === "clip" // Dumb coord clipping + // finish off smarter gamut mapping with clip to get rid of ε, see #17 + || !inGamut(spaceColor, space, { epsilon: 0 }) + ) { + let bounds = Object.values(space.coords).map(c => c.range || []); + + spaceColor.coords = /** @type {[number, number, number]} */ (spaceColor.coords.map((c, i) => { + let [min, max] = bounds[i]; + + if (min !== undefined) { + c = Math.max(min, c); + } + + if (max !== undefined) { + c = Math.min(c, max); + } + + return c; + })); + } + } + + if (space !== color.space) { + spaceColor = to(spaceColor, color.space); + } + + color.coords = spaceColor.coords; + return /** @type {PlainColorObject} */ (color); + } + + /** @type {"color"} */ + toGamut.returns = "color"; + + /** + * The reference colors to be used if lightness is out of the range 0-1 in the + * `Oklch` space. These are created in the `Oklab` space, as it is used by the + * DeltaEOK calculation, so it is guaranteed to be imported. + * @satisfies {Record} + */ + const COLORS = { + WHITE: { space: Oklab, coords: [1, 0, 0], alpha: 1 }, + BLACK: { space: Oklab, coords: [0, 0, 0], alpha: 1 }, + }; + + /** + * Given a color `origin`, returns a new color that is in gamut using + * the CSS Gamut Mapping Algorithm. If `space` is specified, it will be in gamut + * in `space`, and returned in `space`. Otherwise, it will be in gamut and + * returned in the color space of `origin`. + * @param {ColorTypes} origin + * @param {{ space?: string | ColorSpace | undefined }} param1 + * @returns {PlainColorObject} + */ + function toGamutCSS (origin, {space} = {}) { + const JND = 0.02; + const ε = 0.0001; + + origin = getColor(origin); + + if (!space) { + space = origin.space; + } + + space = ColorSpace.get(space); + const oklchSpace = ColorSpace.get("oklch"); + + if (space.isUnbounded) { + return to(origin, space); + } + + const origin_OKLCH = to(origin, oklchSpace); + let L = origin_OKLCH.coords[0]; + + // return media white or black, if lightness is out of range + if (L >= 1) { + const white = to(COLORS.WHITE, space); + white.alpha = origin.alpha; + return to(white, space); + } + if (L <= 0) { + const black = to(COLORS.BLACK, space); + black.alpha = origin.alpha; + return to(black, space); + } + + if (inGamut(origin_OKLCH, space, {epsilon: 0})) { + return to(origin_OKLCH, space); + } + + function clip (_color) { + const destColor = to(_color, space); + const spaceCoords = Object.values(/** @type {ColorSpace} */ (space).coords); + destColor.coords = /** @type {[number, number, number]} */ (destColor.coords.map((coord, index) => { + if ("range" in spaceCoords[index]) { + const [min, max] = spaceCoords[index].range; + return clamp(min, coord, max); + } + return coord; + })); + return destColor; + } + let min = 0; + let max = origin_OKLCH.coords[1]; + let min_inGamut = true; + let current = clone(origin_OKLCH); + let clipped = clip(current); + + let E = deltaEOK(clipped, current); + if (E < JND) { + return clipped; + } + + while ((max - min) > ε) { + const chroma = (min + max) / 2; + current.coords[1] = chroma; + if (min_inGamut && inGamut(current, space, {epsilon: 0})) { + min = chroma; + } + else { + clipped = clip(current); + E = deltaEOK(clipped, current); + if (E < JND) { + if ((JND - E < ε)) { + break; + } + else { + min_inGamut = false; + min = chroma; + } + } + else { + max = chroma; + } + } + } + return clipped; + } + + // Type "imports" + /** @typedef {import("./types.js").ColorTypes} ColorTypes */ + /** @typedef {import("./types.js").PlainColorObject} PlainColorObject */ + /** @typedef {import("./types.js").ToGamutOptions} ToGamutOptions */ + + /** + * Convert to color space and return a new color + * @param {ColorTypes} color + * @param {string | ColorSpace} space + * @param {{ inGamut?: boolean | ToGamutOptions | undefined }} options + * @returns {PlainColorObject} + */ + function to (color, space, {inGamut} = {}) { + color = getColor(color); + space = ColorSpace.get(space); + + let coords = space.from(color); + let ret = {space, coords, alpha: color.alpha}; + + if (inGamut) { + ret = toGamut(ret, inGamut === true ? undefined : inGamut); + } + + return ret; + } + + /** @type {"color"} */ + to.returns = "color"; + + // Type "imports" + /** @typedef {import("./types.js").ColorTypes} ColorTypes */ + /** @typedef {import("./types.js").SerializeOptions} SerializeOptions */ + + /** + * Generic toString() method, outputs a color(spaceId ...coords) function, a functional syntax, or custom formats defined by the color space + * @param {ColorTypes} color + * @param {SerializeOptions & Record} options + * @returns {string} + */ + function serialize (color, options = {}) { + let { + precision = defaults.precision, + format, + inGamut: inGamut$1 = true, + coords: coordFormat, + alpha: alphaFormat, + commas, + } = options; + let ret; + + color = getColor(color); + + let formatId = format; + + if (color.parseMeta && !format) { + if (color.parseMeta.format.canSerialize()) { + format = color.parseMeta.format; + formatId = color.parseMeta.formatId; + } + + coordFormat ??= color.parseMeta.types; + alphaFormat ??= color.parseMeta.alphaType; + commas ??= color.parseMeta.commas; + } + + if (formatId) { + // A format is explicitly specified + format = color.space.getFormat(format) ?? ColorSpace.findFormat(formatId); + } + + if (!format) { + // No format specified, or format not found + format = color.space.getFormat("default") ?? ColorSpace.DEFAULT_FORMAT; + formatId = format.name; + } + + if (format && format.space && format.space !== color.space) { + // Format specified belongs to a different color space, + // need to convert to it first + color = to(color, format.space); + } + + // The assignment to coords and inGamut needs to stay in the order they are now + // The order of the assignment was changed as a workaround for a bug in Next.js + // See this issue for details: https://github.com/color-js/color.js/issues/260 + + let coords = color.coords.slice(); // clone so we can manipulate it + + inGamut$1 ||= format.toGamut; + + if (inGamut$1 && !inGamut(color)) { + // FIXME what happens if the color contains none values? + coords = toGamut(clone(color), inGamut$1 === true ? undefined : inGamut$1).coords; + } + + if (format.type === "custom") { + if (format.serialize) { + ret = format.serialize(coords, color.alpha, options); + } + else { + throw new TypeError(`format ${formatId} can only be used to parse colors, not for serialization`); + } + } + else { + // Functional syntax + let name = format.name || "color"; + + let args = format.serializeCoords(coords, precision, coordFormat); + + if (name === "color") { + // If output is a color() function, add colorspace id as first argument + let cssId = format.id || format.ids?.[0] || color.space.cssId || color.space.id; + args.unshift(cssId); + } + + // Serialize alpha? + /** @type {string | number} */ + let alpha = color.alpha; + + if (alphaFormat !== undefined && !(typeof alphaFormat === "object")) { + alphaFormat = typeof alphaFormat === "string" ? {type: alphaFormat} : {include: alphaFormat}; + } + + let alphaType = alphaFormat?.type ?? ""; + let serializeAlpha = alphaFormat?.include === true || format.alpha === true || (alphaFormat?.include !== false && format.alpha !== false && alpha < 1); + let strAlpha = ""; + + commas ??= format.commas; + + if (serializeAlpha) { + if (precision !== null) { + let unit; + + if (alphaType === "") { + unit = "%"; + alpha *= 100; + } + + alpha = serializeNumber(alpha, {precision, unit}); + } + + strAlpha = `${ commas ? "," : " /" } ${alpha}`; + } + + ret = `${ name }(${ args.join(commas ? ", " : " ") }${ strAlpha })`; + } + + return ret; + } + + // Type "imports" + /** @typedef {import("../types.js").Matrix3x3} Matrix3x3 */ + + // convert an array of linear-light rec2020 values to CIE XYZ + // using D65 (no chromatic adaptation) + // http://www.brucelindbloom.com/index.html?Eqn_RGB_XYZ_Matrix.html + // 0 is actually calculated as 4.994106574466076e-17 + /** @type {Matrix3x3} */ + const toXYZ_M$5 = [ + [ 0.6369580483012914, 0.14461690358620832, 0.1688809751641721 ], + [ 0.2627002120112671, 0.6779980715188708, 0.05930171646986196 ], + [ 0.000000000000000, 0.028072693049087428, 1.060985057710791 ], + ]; + + // from ITU-R BT.2124-0 Annex 2 p.3 + /** @type {Matrix3x3} */ + const fromXYZ_M$5 = [ + [ 1.716651187971268, -0.355670783776392, -0.253366281373660 ], + [ -0.666684351832489, 1.616481236634939, 0.0157685458139111 ], + [ 0.017639857445311, -0.042770613257809, 0.942103121235474 ], + ]; + + var REC_2020_Linear = new RGBColorSpace({ + id: "rec2020-linear", + cssId: "--rec2020-linear", + name: "Linear REC.2020", + white: "D65", + toXYZ_M: toXYZ_M$5, + fromXYZ_M: fromXYZ_M$5, + }); + + // import sRGB from "./srgb.js"; + + const α = 1.09929682680944; + const β = 0.018053968510807; + + var REC2020 = new RGBColorSpace({ + id: "rec2020", + name: "REC.2020", + base: REC_2020_Linear, + // Non-linear transfer function from Rec. ITU-R BT.2020-2 table 4 + toBase (RGB) { + return RGB.map(function (val) { + if (val < β * 4.5) { + return val / 4.5; + } + + return Math.pow((val + α - 1) / α, 1 / 0.45); + }); + }, + fromBase (RGB) { + return RGB.map(function (val) { + if (val >= β) { + return α * Math.pow(val, 0.45) - (α - 1); + } + + return 4.5 * val; + }); + }, + }); + + // Type "imports" + /** @typedef {import("../types.js").Matrix3x3} Matrix3x3 */ + + /** @type {Matrix3x3} */ + const toXYZ_M$4 = [ + [0.4865709486482162, 0.26566769316909306, 0.1982172852343625], + [0.2289745640697488, 0.6917385218365064, 0.079286914093745], + [0.0000000000000000, 0.04511338185890264, 1.043944368900976], + ]; + + /** @type {Matrix3x3} */ + const fromXYZ_M$4 = [ + [ 2.493496911941425, -0.9313836179191239, -0.40271078445071684], + [-0.8294889695615747, 1.7626640603183463, 0.023624685841943577], + [ 0.03584583024378447, -0.07617238926804182, 0.9568845240076872], + ]; + + var P3Linear = new RGBColorSpace({ + id: "p3-linear", + cssId: "--display-p3-linear", + name: "Linear P3", + white: "D65", + toXYZ_M: toXYZ_M$4, + fromXYZ_M: fromXYZ_M$4, + }); + + // Type "imports" + /** @typedef {import("../types.js").Matrix3x3} Matrix3x3 */ + + // This is the linear-light version of sRGB + // as used for example in SVG filters + // or in Canvas + + // This matrix was calculated directly from the RGB and white chromaticities + // when rounded to 8 decimal places, it agrees completely with the official matrix + // see https://github.com/w3c/csswg-drafts/issues/5922 + /** @type {Matrix3x3} */ + const toXYZ_M$3 = [ + [ 0.41239079926595934, 0.357584339383878, 0.1804807884018343 ], + [ 0.21263900587151027, 0.715168678767756, 0.07219231536073371 ], + [ 0.01933081871559182, 0.11919477979462598, 0.9505321522496607 ], + ]; + + // This matrix is the inverse of the above; + // again it agrees with the official definition when rounded to 8 decimal places + /** @type {Matrix3x3} */ + const fromXYZ_M$3 = [ + [ 3.2409699419045226, -1.537383177570094, -0.4986107602930034 ], + [ -0.9692436362808796, 1.8759675015077202, 0.04155505740717559 ], + [ 0.05563007969699366, -0.20397695888897652, 1.0569715142428786 ], + ]; + + var sRGBLinear = new RGBColorSpace({ + id: "srgb-linear", + name: "Linear sRGB", + white: "D65", + toXYZ_M: toXYZ_M$3, + fromXYZ_M: fromXYZ_M$3, + }); + + // To produce: Visit https://www.w3.org/TR/css-color-4/#named-colors + // and run in the console: + // copy($$("tr", $(".named-color-table tbody")).map(tr => `"${tr.cells[2].textContent.trim()}": [${tr.cells[4].textContent.trim().split(/\s+/).map(c => c === "0"? "0" : c === "255"? "1" : c + " / 255").join(", ")}]`).join(",\n")) + + /** List of CSS color keywords + * Note that this does not include currentColor, transparent, + * or system colors + * + * @type {Record} + */ + var KEYWORDS = { + "aliceblue": [240 / 255, 248 / 255, 1], + "antiquewhite": [250 / 255, 235 / 255, 215 / 255], + "aqua": [0, 1, 1], + "aquamarine": [127 / 255, 1, 212 / 255], + "azure": [240 / 255, 1, 1], + "beige": [245 / 255, 245 / 255, 220 / 255], + "bisque": [1, 228 / 255, 196 / 255], + "black": [0, 0, 0], + "blanchedalmond": [1, 235 / 255, 205 / 255], + "blue": [0, 0, 1], + "blueviolet": [138 / 255, 43 / 255, 226 / 255], + "brown": [165 / 255, 42 / 255, 42 / 255], + "burlywood": [222 / 255, 184 / 255, 135 / 255], + "cadetblue": [95 / 255, 158 / 255, 160 / 255], + "chartreuse": [127 / 255, 1, 0], + "chocolate": [210 / 255, 105 / 255, 30 / 255], + "coral": [1, 127 / 255, 80 / 255], + "cornflowerblue": [100 / 255, 149 / 255, 237 / 255], + "cornsilk": [1, 248 / 255, 220 / 255], + "crimson": [220 / 255, 20 / 255, 60 / 255], + "cyan": [0, 1, 1], + "darkblue": [0, 0, 139 / 255], + "darkcyan": [0, 139 / 255, 139 / 255], + "darkgoldenrod": [184 / 255, 134 / 255, 11 / 255], + "darkgray": [169 / 255, 169 / 255, 169 / 255], + "darkgreen": [0, 100 / 255, 0], + "darkgrey": [169 / 255, 169 / 255, 169 / 255], + "darkkhaki": [189 / 255, 183 / 255, 107 / 255], + "darkmagenta": [139 / 255, 0, 139 / 255], + "darkolivegreen": [85 / 255, 107 / 255, 47 / 255], + "darkorange": [1, 140 / 255, 0], + "darkorchid": [153 / 255, 50 / 255, 204 / 255], + "darkred": [139 / 255, 0, 0], + "darksalmon": [233 / 255, 150 / 255, 122 / 255], + "darkseagreen": [143 / 255, 188 / 255, 143 / 255], + "darkslateblue": [72 / 255, 61 / 255, 139 / 255], + "darkslategray": [47 / 255, 79 / 255, 79 / 255], + "darkslategrey": [47 / 255, 79 / 255, 79 / 255], + "darkturquoise": [0, 206 / 255, 209 / 255], + "darkviolet": [148 / 255, 0, 211 / 255], + "deeppink": [1, 20 / 255, 147 / 255], + "deepskyblue": [0, 191 / 255, 1], + "dimgray": [105 / 255, 105 / 255, 105 / 255], + "dimgrey": [105 / 255, 105 / 255, 105 / 255], + "dodgerblue": [30 / 255, 144 / 255, 1], + "firebrick": [178 / 255, 34 / 255, 34 / 255], + "floralwhite": [1, 250 / 255, 240 / 255], + "forestgreen": [34 / 255, 139 / 255, 34 / 255], + "fuchsia": [1, 0, 1], + "gainsboro": [220 / 255, 220 / 255, 220 / 255], + "ghostwhite": [248 / 255, 248 / 255, 1], + "gold": [1, 215 / 255, 0], + "goldenrod": [218 / 255, 165 / 255, 32 / 255], + "gray": [128 / 255, 128 / 255, 128 / 255], + "green": [0, 128 / 255, 0], + "greenyellow": [173 / 255, 1, 47 / 255], + "grey": [128 / 255, 128 / 255, 128 / 255], + "honeydew": [240 / 255, 1, 240 / 255], + "hotpink": [1, 105 / 255, 180 / 255], + "indianred": [205 / 255, 92 / 255, 92 / 255], + "indigo": [75 / 255, 0, 130 / 255], + "ivory": [1, 1, 240 / 255], + "khaki": [240 / 255, 230 / 255, 140 / 255], + "lavender": [230 / 255, 230 / 255, 250 / 255], + "lavenderblush": [1, 240 / 255, 245 / 255], + "lawngreen": [124 / 255, 252 / 255, 0], + "lemonchiffon": [1, 250 / 255, 205 / 255], + "lightblue": [173 / 255, 216 / 255, 230 / 255], + "lightcoral": [240 / 255, 128 / 255, 128 / 255], + "lightcyan": [224 / 255, 1, 1], + "lightgoldenrodyellow": [250 / 255, 250 / 255, 210 / 255], + "lightgray": [211 / 255, 211 / 255, 211 / 255], + "lightgreen": [144 / 255, 238 / 255, 144 / 255], + "lightgrey": [211 / 255, 211 / 255, 211 / 255], + "lightpink": [1, 182 / 255, 193 / 255], + "lightsalmon": [1, 160 / 255, 122 / 255], + "lightseagreen": [32 / 255, 178 / 255, 170 / 255], + "lightskyblue": [135 / 255, 206 / 255, 250 / 255], + "lightslategray": [119 / 255, 136 / 255, 153 / 255], + "lightslategrey": [119 / 255, 136 / 255, 153 / 255], + "lightsteelblue": [176 / 255, 196 / 255, 222 / 255], + "lightyellow": [1, 1, 224 / 255], + "lime": [0, 1, 0], + "limegreen": [50 / 255, 205 / 255, 50 / 255], + "linen": [250 / 255, 240 / 255, 230 / 255], + "magenta": [1, 0, 1], + "maroon": [128 / 255, 0, 0], + "mediumaquamarine": [102 / 255, 205 / 255, 170 / 255], + "mediumblue": [0, 0, 205 / 255], + "mediumorchid": [186 / 255, 85 / 255, 211 / 255], + "mediumpurple": [147 / 255, 112 / 255, 219 / 255], + "mediumseagreen": [60 / 255, 179 / 255, 113 / 255], + "mediumslateblue": [123 / 255, 104 / 255, 238 / 255], + "mediumspringgreen": [0, 250 / 255, 154 / 255], + "mediumturquoise": [72 / 255, 209 / 255, 204 / 255], + "mediumvioletred": [199 / 255, 21 / 255, 133 / 255], + "midnightblue": [25 / 255, 25 / 255, 112 / 255], + "mintcream": [245 / 255, 1, 250 / 255], + "mistyrose": [1, 228 / 255, 225 / 255], + "moccasin": [1, 228 / 255, 181 / 255], + "navajowhite": [1, 222 / 255, 173 / 255], + "navy": [0, 0, 128 / 255], + "oldlace": [253 / 255, 245 / 255, 230 / 255], + "olive": [128 / 255, 128 / 255, 0], + "olivedrab": [107 / 255, 142 / 255, 35 / 255], + "orange": [1, 165 / 255, 0], + "orangered": [1, 69 / 255, 0], + "orchid": [218 / 255, 112 / 255, 214 / 255], + "palegoldenrod": [238 / 255, 232 / 255, 170 / 255], + "palegreen": [152 / 255, 251 / 255, 152 / 255], + "paleturquoise": [175 / 255, 238 / 255, 238 / 255], + "palevioletred": [219 / 255, 112 / 255, 147 / 255], + "papayawhip": [1, 239 / 255, 213 / 255], + "peachpuff": [1, 218 / 255, 185 / 255], + "peru": [205 / 255, 133 / 255, 63 / 255], + "pink": [1, 192 / 255, 203 / 255], + "plum": [221 / 255, 160 / 255, 221 / 255], + "powderblue": [176 / 255, 224 / 255, 230 / 255], + "purple": [128 / 255, 0, 128 / 255], + "rebeccapurple": [102 / 255, 51 / 255, 153 / 255], + "red": [1, 0, 0], + "rosybrown": [188 / 255, 143 / 255, 143 / 255], + "royalblue": [65 / 255, 105 / 255, 225 / 255], + "saddlebrown": [139 / 255, 69 / 255, 19 / 255], + "salmon": [250 / 255, 128 / 255, 114 / 255], + "sandybrown": [244 / 255, 164 / 255, 96 / 255], + "seagreen": [46 / 255, 139 / 255, 87 / 255], + "seashell": [1, 245 / 255, 238 / 255], + "sienna": [160 / 255, 82 / 255, 45 / 255], + "silver": [192 / 255, 192 / 255, 192 / 255], + "skyblue": [135 / 255, 206 / 255, 235 / 255], + "slateblue": [106 / 255, 90 / 255, 205 / 255], + "slategray": [112 / 255, 128 / 255, 144 / 255], + "slategrey": [112 / 255, 128 / 255, 144 / 255], + "snow": [1, 250 / 255, 250 / 255], + "springgreen": [0, 1, 127 / 255], + "steelblue": [70 / 255, 130 / 255, 180 / 255], + "tan": [210 / 255, 180 / 255, 140 / 255], + "teal": [0, 128 / 255, 128 / 255], + "thistle": [216 / 255, 191 / 255, 216 / 255], + "tomato": [1, 99 / 255, 71 / 255], + "turquoise": [64 / 255, 224 / 255, 208 / 255], + "violet": [238 / 255, 130 / 255, 238 / 255], + "wheat": [245 / 255, 222 / 255, 179 / 255], + "white": [1, 1, 1], + "whitesmoke": [245 / 255, 245 / 255, 245 / 255], + "yellow": [1, 1, 0], + "yellowgreen": [154 / 255, 205 / 255, 50 / 255], + }; + + // Type "imports" + /** @typedef {import("../types.js").Coords} Coords */ + + let coordGrammar = Array(3).fill(" | [0, 255]"); + let coordGrammarNumber = Array(3).fill("[0, 255]"); + + var sRGB = new RGBColorSpace({ + id: "srgb", + name: "sRGB", + base: sRGBLinear, + fromBase: rgb => { + // convert an array of linear-light sRGB values in the range 0.0-1.0 + // to gamma corrected form + // https://en.wikipedia.org/wiki/SRGB + return rgb.map(val => { + let sign = val < 0 ? -1 : 1; + let abs = val * sign; + + if (abs > 0.0031308) { + return sign * (1.055 * (abs ** (1 / 2.4)) - 0.055); + } + + return 12.92 * val; + }); + }, + toBase: rgb => { + // convert an array of sRGB values in the range 0.0 - 1.0 + // to linear light (un-companded) form. + // https://en.wikipedia.org/wiki/SRGB + return rgb.map(val => { + let sign = val < 0 ? -1 : 1; + let abs = val * sign; + + if (abs <= 0.04045) { + return val / 12.92; + } + + return sign * (((abs + 0.055) / 1.055) ** 2.4); + }); + }, + formats: { + "rgb": { + coords: coordGrammar, + }, + "rgb_number": { + name: "rgb", + commas: true, + coords: coordGrammarNumber, + alpha: false, + }, + "color": { /* use defaults */ }, + "rgba": { + coords: coordGrammar, + commas: true, + alpha: true, + }, + "rgba_number": { + name: "rgba", + commas: true, + coords: coordGrammarNumber, + }, + "hex": { + type: "custom", + toGamut: true, + test: str => /^#([a-f0-9]{3,4}){1,2}$/i.test(str), + parse (str) { + if (str.length <= 5) { + // #rgb or #rgba, duplicate digits + str = str.replace(/[a-f0-9]/gi, "$&$&"); + } + + /** @type {number[]} */ + let rgba = []; + str.replace(/[a-f0-9]{2}/gi, component => { + rgba.push(parseInt(component, 16) / 255); + }); + + return { + spaceId: "srgb", + coords: /** @type {Coords} */ (rgba.slice(0, 3)), + alpha: /** @type {number} */ (rgba.slice(3)[0]), + }; + }, + serialize: (coords, alpha, { + collapse = true, // collapse to 3-4 digit hex when possible? + alpha: alphaFormat, + } = {}) => { + if (alphaFormat !== false && alpha < 1 || alphaFormat === true) { + coords.push(alpha); + } + + coords = /** @type {[number, number, number]} */ (coords.map(c => Math.round(c * 255))); + + let collapsible = collapse && coords.every(c => c % 17 === 0); + + let hex = coords.map(c => { + if (collapsible) { + return (c / 17).toString(16); + } + + return c.toString(16).padStart(2, "0"); + }).join(""); + + return "#" + hex; + }, + }, + "keyword": { + type: "custom", + test: str => /^[a-z]+$/i.test(str), + parse (str) { + str = str.toLowerCase(); + let ret = {spaceId: "srgb", coords: null, alpha: 1}; + + if (str === "transparent") { + ret.coords = KEYWORDS.black; + ret.alpha = 0; + } + else { + ret.coords = KEYWORDS[str]; + } + + if (ret.coords) { + return ret; + } + }, + }, + }, + }); + + var P3 = new RGBColorSpace({ + id: "p3", + cssId: "display-p3", + name: "P3", + base: P3Linear, + // Gamma encoding/decoding is the same as sRGB + fromBase: sRGB.fromBase, + toBase: sRGB.toBase, + }); + + // Type "imports" + /** @typedef {import("./types.js").ColorTypes} ColorTypes */ + /** @typedef {import("./types.js").PlainColorObject} PlainColorObject */ + /** @typedef {import("./types.js").Display} Display */ + /** @typedef {import("./ColorSpace.js").default} ColorSpace */ + + // Default space for CSS output. Code in Color.js makes this wider if there's a DOM available + defaults.display_space = sRGB; + + let supportsNone; + + if (typeof CSS !== "undefined" && CSS.supports) { + // Find widest supported color space for CSS + for (let space of [lab, REC2020, P3]) { + let coords = space.getMinCoords(); + let color = {space, coords, alpha: 1}; + let str = serialize(color); + + if (CSS.supports("color", str)) { + defaults.display_space = space; + break; + } + } + } + + /** + * Returns a serialization of the color that can actually be displayed in the browser. + * If the default serialization can be displayed, it is returned. + * Otherwise, the color is converted to Lab, REC2020, or P3, whichever is the widest supported. + * In Node.js, this is basically equivalent to `serialize()` but returns a `String` object instead. + * @param {ColorTypes} color + * @param {{ space?: string | ColorSpace | undefined } & Record} param1 + * Options to be passed to `serialize()` + * @returns {Display} String object containing the serialized color + * with a color property containing the converted color (or the original, if no conversion was necessary) + */ + function display (color, {space = defaults.display_space, ...options} = {}) { + color = getColor(color); + + let ret = /** @type {Display} */ (serialize(color, options)); + + if (typeof CSS === "undefined" || CSS.supports("color", /** @type {string} */ (ret)) || !defaults.display_space) { + ret = /** @type {Display} */ (new String(ret)); + ret.color = /** @type {PlainColorObject} */ (color); + } + else { + // If we're here, what we were about to output is not supported + let fallbackColor = /** @type {PlainColorObject} */ (color); + + // First, check if the culprit is none values + let hasNone = color.coords.some(isNone) || isNone(color.alpha); + + if (hasNone) { + // Does the browser support none values? + if (!(supportsNone ??= CSS.supports("color", "hsl(none 50% 50%)"))) { + // Nope, try again without none + fallbackColor = clone(/** @type {PlainColorObject} */ (color)); + fallbackColor.coords = /** @type {[number, number, number]} */ (fallbackColor.coords.map(skipNone)); + fallbackColor.alpha = skipNone(fallbackColor.alpha); + + // @ts-expect-error This is set to the correct type later + ret = serialize(fallbackColor, options); + + if (CSS.supports("color", /** @type {string} */ (ret))) { + // We're done, now it's supported + ret = /** @type {Display} */ (new String(ret)); + ret.color = fallbackColor; + return ret; + } + } + } + + // If we're here, the color function is not supported + // Fall back to fallback space + fallbackColor = to(fallbackColor, space); + ret = /** @type {Display} */ (new String(serialize(fallbackColor, options))); + ret.color = fallbackColor; + } + + return ret; + } + + // Type "imports" + /** @typedef {import("./types.js").ColorTypes} ColorTypes */ + /** @typedef {import("./types.js").DeltasReturn} DeltasReturn */ + + /** + * Get color differences per-component, on any color space + * @param {ColorTypes} c1 + * @param {ColorTypes} c2 + * @param {object} options + * @param {string | ColorSpace} [options.space=c1.space] - The color space to use for the delta calculation. Defaults to the color space of the first color. + * @param {Parameters[0]} [options.hue="shorter"] - How to handle hue differences. Same as hue interpolation option. + * @returns {DeltasReturn} + */ + function deltas (c1, c2, {space, hue = "shorter"} = {}) { + c1 = getColor(c1); + space ||= c1.space; + space = ColorSpace.get(space); + let spaceCoords = Object.values(space.coords); + + [c1, c2] = [c1, c2].map(c => to(c, space)); + let [coords1, coords2] = [c1, c2].map(c => c.coords); + + let coords = /** @type {[number, number, number]} */ (coords1.map((coord1, i) => { + let coordMeta = spaceCoords[i]; + let coord2 = coords2[i]; + + if (coordMeta.type === "angle") { + [coord1, coord2] = adjust(hue, [coord1, coord2]); + } + + return subtractCoords(coord1, coord2); + })); + + let alpha = subtractCoords(c1.alpha, c2.alpha); + + return { space: /** @type {ColorSpace} */ (space), coords, alpha }; + } + + function subtractCoords (c1, c2) { + if (isNone(c1) || isNone(c2)) { + return c1 === c2 ? null : 0; + } + + return c1 - c2; + } + + // Type "imports" + /** @typedef {import("./types.js").ColorTypes} ColorTypes */ + + /** + * @param {ColorTypes} color1 + * @param {ColorTypes} color2 + * @returns {boolean} + */ + function equals (color1, color2) { + color1 = getColor(color1); + color2 = getColor(color2); + + return color1.space === color2.space + && color1.alpha === color2.alpha + && color1.coords.every((c, i) => c === color2.coords[i]); + } + + /** + * Relative luminance + */ + + // Type "imports" + /** @typedef {import("./types.js").ColorTypes} ColorTypes */ + + /** + * + * @param {ColorTypes} color + * @returns {number} + */ + function getLuminance (color) { + // Assume getColor() is called on color in get() + return get(color, [xyz_d65, "y"]); + } + + /** + * @param {ColorTypes} color + * @param {number | ((coord: number) => number)} value + */ + function setLuminance (color, value) { + // Assume getColor() is called on color in set() + set(color, [xyz_d65, "y"], value); + } + + /** + * @param {typeof import("./color.js").default} Color + */ + function register$2 (Color) { + Object.defineProperty(Color.prototype, "luminance", { + get () { + return getLuminance(this); + }, + set (value) { + setLuminance(this, value); + }, + }); + } + + var luminance = /*#__PURE__*/Object.freeze({ + __proto__: null, + getLuminance: getLuminance, + register: register$2, + setLuminance: setLuminance + }); + + // WCAG 2.0 contrast https://www.w3.org/TR/WCAG20-TECHS/G18.html + // Simple contrast, with fixed 5% viewing flare contribution + // Symmetric, does not matter which is foreground and which is background + + + /** + * @param {import("../types.js").ColorTypes} color1 + * @param {import("../types.js").ColorTypes} color2 + * @returns {number} + */ + function contrastWCAG21 (color1, color2) { + color1 = getColor(color1); + color2 = getColor(color2); + + let Y1 = Math.max(getLuminance(color1), 0); + let Y2 = Math.max(getLuminance(color2), 0); + + if (Y2 > Y1) { + [Y1, Y2] = [Y2, Y1]; + } + + return (Y1 + .05) / (Y2 + .05); + } + + // APCA 0.0.98G + // https://github.com/Myndex/apca-w3 + // see also https://github.com/w3c/silver/issues/643 + + + // exponents + const normBG = 0.56; + const normTXT = 0.57; + const revTXT = 0.62; + const revBG = 0.65; + + // clamps + const blkThrs = 0.022; + const blkClmp = 1.414; + const loClip = 0.1; + const deltaYmin = 0.0005; + + // scalers + // see https://github.com/w3c/silver/issues/645 + const scaleBoW = 1.14; + const loBoWoffset = 0.027; + const scaleWoB = 1.14; + + function fclamp (Y) { + if (Y >= blkThrs) { + return Y; + } + return Y + (blkThrs - Y) ** blkClmp; + } + + function linearize (val) { + let sign = val < 0 ? -1 : 1; + let abs = Math.abs(val); + return sign * Math.pow(abs, 2.4); + } + + /** + * Not symmetric, requires a foreground (text) color, and a background color + * @param {import("../types.js").ColorTypes} background + * @param {import("../types.js").ColorTypes} foreground + * @returns {number} + */ + function contrastAPCA (background, foreground) { + foreground = getColor(foreground); + background = getColor(background); + + let S; + let C; + let Sapc; + + // Myndex as-published, assumes sRGB inputs + let R, G, B; + + foreground = to(foreground, "srgb"); + // Should these be clamped to in-gamut values? + + // Calculates "screen luminance" with non-standard simple gamma EOTF + // weights should be from CSS Color 4, not the ones here which are via Myndex and copied from Lindbloom + [R, G, B] = foreground.coords.map(c => { + return isNone(c) ? 0 : c; + }); + let lumTxt = linearize(R) * 0.2126729 + linearize(G) * 0.7151522 + linearize(B) * 0.0721750; + + background = to(background, "srgb"); + [R, G, B] = background.coords.map(c => { + return isNone(c) ? 0 : c; + }); + let lumBg = linearize(R) * 0.2126729 + linearize(G) * 0.7151522 + linearize(B) * 0.0721750; + + // toe clamping of very dark values to account for flare + let Ytxt = fclamp(lumTxt); + let Ybg = fclamp(lumBg); + + // are we "Black on White" (dark on light), or light on dark? + let BoW = Ybg > Ytxt; + + // why is this a delta, when Y is not perceptually uniform? + // Answer: it is a noise gate, see + // https://github.com/LeaVerou/color.js/issues/208 + if (Math.abs(Ybg - Ytxt) < deltaYmin) { + C = 0; + } + else { + if (BoW) { + // dark text on light background + S = Ybg ** normBG - Ytxt ** normTXT; + C = S * scaleBoW; + } + else { + // light text on dark background + S = Ybg ** revBG - Ytxt ** revTXT; + C = S * scaleWoB; + } + } + if (Math.abs(C) < loClip) { + Sapc = 0; + } + else if (C > 0) { + // not clear whether Woffset is loBoWoffset or loWoBoffset + // but they have the same value + Sapc = C - loBoWoffset; + } + else { + Sapc = C + loBoWoffset; + } + + return Sapc * 100; + } + + // Michelson luminance contrast + // the relation between the spread and the sum of the two luminances + // Symmetric, does not matter which is foreground and which is background + // No black level compensation for flare. + + + /** + * @param {import("../types.js").ColorTypes} color1 + * @param {import("../types.js").ColorTypes} color2 + * @returns {number} + */ + function contrastMichelson (color1, color2) { + color1 = getColor(color1); + color2 = getColor(color2); + + let Y1 = Math.max(getLuminance(color1), 0); + let Y2 = Math.max(getLuminance(color2), 0); + + if (Y2 > Y1) { + [Y1, Y2] = [Y2, Y1]; + } + + let denom = (Y1 + Y2); + return denom === 0 ? 0 : (Y1 - Y2) / denom; + } + + // Weber luminance contrast + // The difference between the two luminances divided by the lower luminance + // Symmetric, does not matter which is foreground and which is background + // No black level compensation for flare. + + + // the darkest sRGB color above black is #000001 and this produces + // a plain Weber contrast of ~45647. + // So, setting the divide-by-zero result at 50000 is a reasonable + // max clamp for the plain Weber + const max = 50000; + + /** + * @param {import("../types.js").ColorTypes} color1 + * @param {import("../types.js").ColorTypes} color2 + * @returns {number} + */ + function contrastWeber (color1, color2) { + color1 = getColor(color1); + color2 = getColor(color2); + + let Y1 = Math.max(getLuminance(color1), 0); + let Y2 = Math.max(getLuminance(color2), 0); + + if (Y2 > Y1) { + [Y1, Y2] = [Y2, Y1]; + } + + return Y2 === 0 ? max : (Y1 - Y2) / Y2; + } + + // CIE Lightness difference, as used by Google Material Design + // Google HCT Tone is the same as CIE Lightness + // https://material.io/blog/science-of-color-design + + + /** + * @param {import("../types.js").ColorTypes} color1 + * @param {import("../types.js").ColorTypes} color2 + * @returns {number} + */ + function contrastLstar (color1, color2) { + color1 = getColor(color1); + color2 = getColor(color2); + + let L1 = get(color1, [lab, "l"]); + let L2 = get(color2, [lab, "l"]); + + return Math.abs(L1 - L2); + } + + // κ * ε = 2^3 = 8 + const ε$3 = 216 / 24389; // 6^3/29^3 == (24/116)^3 + const ε3 = 24 / 116; + const κ$2 = 24389 / 27; // 29^3/3^3 + + let white$1 = WHITES.D65; + + var lab_d65 = new ColorSpace({ + id: "lab-d65", + name: "Lab D65", + coords: { + l: { + refRange: [0, 100], + name: "Lightness", + }, + a: { + refRange: [-125, 125], + }, + b: { + refRange: [-125, 125], + }, + }, + + // Assuming XYZ is relative to D65, convert to CIE Lab + // from CIE standard, which now defines these as a rational fraction + white: white$1, + + base: xyz_d65, + // Convert D65-adapted XYZ to Lab + // CIE 15.3:2004 section 8.2.1.1 + fromBase (XYZ) { + // compute xyz, which is XYZ scaled relative to reference white + let xyz = XYZ.map((value, i) => value / white$1[i]); + + // now compute f + let f = xyz.map(value => value > ε$3 ? Math.cbrt(value) : (κ$2 * value + 16) / 116); + + return [ + (116 * f[1]) - 16, // L + 500 * (f[0] - f[1]), // a + 200 * (f[1] - f[2]), // b + ]; + }, + // Convert Lab to D65-adapted XYZ + // Same result as CIE 15.3:2004 Appendix D although the derivation is different + // http://www.brucelindbloom.com/index.html?Eqn_RGB_XYZ_Matrix.html + toBase (Lab) { + // compute f, starting with the luminance-related term + let f = []; + f[1] = (Lab[0] + 16) / 116; + f[0] = Lab[1] / 500 + f[1]; + f[2] = f[1] - Lab[2] / 200; + + // compute xyz + let xyz = [ + f[0] > ε3 ? Math.pow(f[0], 3) : (116 * f[0] - 16) / κ$2, + Lab[0] > 8 ? Math.pow((Lab[0] + 16) / 116, 3) : Lab[0] / κ$2, + f[2] > ε3 ? Math.pow(f[2], 3) : (116 * f[2] - 16) / κ$2, + ]; + + // Compute XYZ by scaling xyz by reference white + return xyz.map((value, i) => value * white$1[i]); + }, + + formats: { + "lab-d65": { + coords: [" | ", " | ", " | "], + }, + }, + }); + + // Delta Phi Star perceptual lightness contrast + // See https://github.com/Myndex/deltaphistar + // The (difference between two Lstars each raised to phi) raised to (1/phi) + // Symmetric, does not matter which is foreground and which is background + + + const phi = Math.pow(5, 0.5) * 0.5 + 0.5; // Math.phi can be used if Math.js + + /** + * @param {import("../types.js").ColorTypes} color1 + * @param {import("../types.js").ColorTypes} color2 + * @returns {number} + */ + function contrastDeltaPhi (color1, color2) { + color1 = getColor(color1); + color2 = getColor(color2); + + let Lstr1 = get(color1, [lab_d65, "l"]); + let Lstr2 = get(color2, [lab_d65, "l"]); + + let deltaPhiStar = Math.abs(Math.pow(Lstr1, phi) - Math.pow(Lstr2, phi)); + + let contrast = Math.pow(deltaPhiStar, (1 / phi)) * Math.SQRT2 - 40; + + return (contrast < 7.5) ? 0.0 : contrast ; + } + + /** @typedef {keyof typeof import("./index.js") extends `contrast${infer Alg}` ? Alg : string} Algorithms */ + + var contrastMethods = /*#__PURE__*/Object.freeze({ + __proto__: null, + contrastAPCA: contrastAPCA, + contrastDeltaPhi: contrastDeltaPhi, + contrastLstar: contrastLstar, + contrastMichelson: contrastMichelson, + contrastWCAG21: contrastWCAG21, + contrastWeber: contrastWeber + }); + + // Type "imports" + /** @typedef {import("./types.js").Algorithms} Algorithms */ + /** @typedef {import("./types.js").ColorTypes} ColorTypes */ + + /** + * + * @param {ColorTypes} background + * @param {ColorTypes} foreground + * @param {Algorithms | ({ algorithm: Algorithms } & Record)} o + * Algorithm to use as well as any other options to pass to the contrast function + * @returns {number} + * @throws {TypeError} Unknown or unspecified algorithm + */ + function contrast (background, foreground, o) { + if (isString(o)) { + o = {algorithm: o}; + } + + let {algorithm, ...rest} = o || {}; + + if (!algorithm) { + let algorithms = Object.keys(contrastMethods).map(a => a.replace(/^contrast/, "")).join(", "); + throw new TypeError(`contrast() function needs a contrast algorithm. Please specify one of: ${algorithms}`); + } + + background = getColor(background); + foreground = getColor(foreground); + + for (let a in contrastMethods) { + if ("contrast" + algorithm.toLowerCase() === a.toLowerCase()) { + return contrastMethods[a](background, foreground, rest); + } + } + + throw new TypeError(`Unknown contrast algorithm: ${algorithm}`); + } + + // Type "imports" + /** @typedef {import("./color.js").default} Color */ + /** @typedef {import("./color.js").ColorTypes} ColorTypes */ + + // Chromaticity coordinates + /** + * @param {ColorTypes} color + * @returns {[number, number]} + */ + function uv (color) { + // Assumes getAll() calls getColor() on color + let [X, Y, Z] = getAll(color, xyz_d65); + let denom = X + 15 * Y + 3 * Z; + return [4 * X / denom, 9 * Y / denom]; + } + + /** + * @param {ColorTypes} color + * @returns {[number, number]} + */ + function xy (color) { + // Assumes getAll() calls getColor() on color + let [X, Y, Z] = getAll(color, xyz_d65); + let sum = X + Y + Z; + return [X / sum, Y / sum]; + } + + /** + * @param {typeof import("./color.js").default} Color + */ + function register$1 (Color) { + // no setters, as lightness information is lost + // when converting color to chromaticity + Object.defineProperty(Color.prototype, "uv", { + get () { + return uv(this); + }, + }); + + Object.defineProperty(Color.prototype, "xy", { + get () { + return xy(this); + }, + }); + } + + var chromaticity = /*#__PURE__*/Object.freeze({ + __proto__: null, + register: register$1, + uv: uv, + xy: xy + }); + + // Type "imports" + /** @typedef {import("./types.js").ColorTypes} ColorTypes */ + /** @typedef {import("./types.js").Methods} Methods */ + + /** + * + * @param {ColorTypes} c1 + * @param {ColorTypes} c2 + * @param {Methods | ({ method?: Methods | undefined } & Record)} [o] + * deltaE method to use as well as any other options to pass to the deltaE function + * @returns {number} + * @throws {TypeError} Unknown or unspecified method + */ + function deltaE (c1, c2, o = {}) { + if (isString(o)) { + o = {method: o}; + } + + let {method = defaults.deltaE, ...rest} = o; + + for (let m in deltaEMethods) { + if ("deltae" + method.toLowerCase() === m.toLowerCase()) { + return deltaEMethods[m](c1, c2, rest); + } + } + + throw new TypeError(`Unknown deltaE method: ${method}`); + } + + // Type "imports" + /** @typedef {import("./types.js").ColorTypes} ColorTypes */ + /** @typedef {import("./types.js").PlainColorObject} PlainColorObject */ + /** @typedef {import("./types.js").Ref} Ref */ + + /** + * @param {ColorTypes} color + * @param {number} amount + * @returns {PlainColorObject} + */ + function lighten (color, amount = 0.25) { + let space = ColorSpace.get("oklch", "lch"); + let /** @type {Ref} */ lightness = [space, "l"]; + return set(color, lightness, l => l * (1 + amount)); + } + + /** + * @param {ColorTypes} color + * @param {number} amount + * @returns {PlainColorObject} + */ + function darken (color, amount = .25) { + let space = ColorSpace.get("oklch", "lch"); + let /** @type {Ref} */ lightness = [space, "l"]; + return set(color, lightness, l => l * (1 - amount)); + } + + var variations = /*#__PURE__*/Object.freeze({ + __proto__: null, + darken: darken, + lighten: lighten + }); + + /** + * Functions related to color interpolation + */ + + // Type "imports" + /** @typedef {import("./types.js").ColorTypes} ColorTypes */ + /** @typedef {import("./types.js").MixOptions} MixOptions */ + /** @typedef {import("./types.js").PlainColorObject} PlainColorObject */ + /** @typedef {import("./types.js").Range} Range */ + /** @typedef {import("./types.js").RangeOptions} RangeOptions */ + /** @typedef {import("./types.js").StepsOptions} StepsOptions */ + /** @typedef {import("./types.js").Ref} Ref */ + + /** + * Return an intermediate color between two colors + * @overload + * @param {ColorTypes} c1 + * @param {ColorTypes} c2 + * @param {MixOptions} [options] + * @returns {PlainColorObject} + */ + /** + * @overload + * @param {ColorTypes} c1 + * @param {ColorTypes} c2 + * @param {number} p + * @param {MixOptions} [options] + * @returns {PlainColorObject} + */ + function mix (c1, c2, p = .5, o = {}) { + [c1, c2] = [getColor(c1), getColor(c2)]; + + if (type(p) === "object") { + [p, o] = [.5, p]; + } + + let r = range(c1, c2, o); + return r(p); + } + + /** + * Get an array of discrete steps + * @overload + * @param {ColorTypes} c1 + * @param {ColorTypes} c2 + * @param {StepsOptions} [options] + * @returns {PlainColorObject[]} + */ + /** + * @overload + * @param {Range} range + * @param {StepsOptions} [options] + * @returns {PlainColorObject[]} + */ + function steps (c1, c2, options = {}) { + let colorRange; + + if (isRange(c1)) { + // Tweaking existing range + [colorRange, options] = [c1, c2]; + [c1, c2] = colorRange.rangeArgs.colors; + } + + let { + maxDeltaE, deltaEMethod, + steps = 2, maxSteps = 1000, + ...rangeOptions + } = options; + + if (!colorRange) { + [c1, c2] = [getColor(c1), getColor(c2)]; + colorRange = range(c1, c2, rangeOptions); + } + + let totalDelta = deltaE(c1, c2); + let actualSteps = maxDeltaE > 0 ? Math.max(steps, Math.ceil(totalDelta / maxDeltaE) + 1) : steps; + let ret = []; + + if (maxSteps !== undefined) { + actualSteps = Math.min(actualSteps, maxSteps); + } + + if (actualSteps === 1) { + ret = [{p: .5, color: colorRange(.5)}]; + } + else { + let step = 1 / (actualSteps - 1); + ret = Array.from({length: actualSteps}, (_, i) => { + let p = i * step; + return {p, color: colorRange(p)}; + }); + } + + if (maxDeltaE > 0) { + // Iterate over all stops and find max deltaE + let maxDelta = ret.reduce((acc, cur, i) => { + if (i === 0) { + return 0; + } + + let ΔΕ = deltaE(cur.color, ret[i - 1].color, deltaEMethod); + return Math.max(acc, ΔΕ); + }, 0); + + while (maxDelta > maxDeltaE) { + // Insert intermediate stops and measure maxDelta again + // We need to do this for all pairs, otherwise the midpoint shifts + maxDelta = 0; + + for (let i = 1; (i < ret.length) && (ret.length < maxSteps); i++) { + let prev = ret[i - 1]; + let cur = ret[i]; + + let p = (cur.p + prev.p) / 2; + let color = colorRange(p); + maxDelta = Math.max(maxDelta, deltaE(color, prev.color), deltaE(color, cur.color)); + ret.splice(i, 0, {p, color: colorRange(p)}); + i++; + } + } + } + + ret = ret.map(a => a.color); + + return ret; + } + + /** + * Creates a function that accepts a number and returns a color. + * For numbers in the range 0 to 1, the function interpolates; + * for numbers outside that range, the function extrapolates + * (and thus may not return the results you expect) + * @overload + * @param {Range} range + * @param {RangeOptions} [options] + * @returns {Range} + */ + /** + * @overload + * @param {ColorTypes} color1 + * @param {ColorTypes} color2 + * @param {RangeOptions & Record} [options] + * @returns {Range} + */ + function range (color1, color2, options = {}) { + if (isRange(color1)) { + // Tweaking existing range + let [r, options] = [color1, color2]; + + return range(...r.rangeArgs.colors, {...r.rangeArgs.options, ...options}); + } + + let {space, outputSpace, progression, premultiplied} = options; + + color1 = getColor(color1); + color2 = getColor(color2); + + // Make sure we're working on copies of these colors + color1 = clone(color1); + color2 = clone(color2); + + let rangeArgs = {colors: [color1, color2], options}; + + if (space) { + space = ColorSpace.get(space); + } + else { + space = ColorSpace.registry[defaults.interpolationSpace] || color1.space; + } + + outputSpace = outputSpace ? ColorSpace.get(outputSpace) : space; + + color1 = to(color1, space); + color2 = to(color2, space); + + // Gamut map to avoid areas of flat color + color1 = toGamut(color1); + color2 = toGamut(color2); + + // Handle hue interpolation + // See https://github.com/w3c/csswg-drafts/issues/4735#issuecomment-635741840 + if (space.coords.h && space.coords.h.type === "angle") { + let arc = options.hue = options.hue || "shorter"; + + let /** @type {Ref} */ hue = [space, "h"]; + let [θ1, θ2] = [get(color1, hue), get(color2, hue)]; + // Undefined hues must be evaluated before hue fix-up to properly + // calculate hue arcs between undefined and defined hues. + // See https://github.com/w3c/csswg-drafts/issues/9436#issuecomment-1746957545 + if (isNone(θ1) && !isNone(θ2)) { + θ1 = θ2; + } + else if (isNone(θ2) && !isNone(θ1)) { + θ2 = θ1; + } + [θ1, θ2] = adjust(arc, [θ1, θ2]); + set(color1, hue, θ1); + set(color2, hue, θ2); + } + + if (premultiplied) { + // not coping with polar spaces yet + color1.coords = /** @type {[number, number, number]} */ (color1.coords.map(c => c * color1.alpha)); + color2.coords = /** @type {[number, number, number]} */ (color2.coords.map(c => c * color2.alpha)); + } + + return Object.assign(p => { + p = progression ? progression(p) : p; + let coords = color1.coords.map((start, i) => { + let end = color2.coords[i]; + return interpolate(start, end, p); + }); + + let alpha = interpolate(color1.alpha, color2.alpha, p); + let ret = {space, coords, alpha}; + + if (premultiplied) { + // undo premultiplication + ret.coords = ret.coords.map(c => c / alpha); + } + + if (outputSpace !== space) { + ret = to(ret, outputSpace); + } + + return ret; + }, { + rangeArgs, + }); + } + + /** + * @param {any} val + * @returns {val is Range} + */ + function isRange (val) { + return type(val) === "function" && !!val.rangeArgs; + } + + defaults.interpolationSpace = "lab"; + + /** + * @param {typeof import("./color.js").default} Color + */ + function register (Color) { + Color.defineFunction("mix", mix, {returns: "color"}); + Color.defineFunction("range", range, {returns: "function"}); + Color.defineFunction("steps", steps, {returns: "array"}); + } + + var interpolation = /*#__PURE__*/Object.freeze({ + __proto__: null, + isRange: isRange, + mix: mix, + range: range, + register: register, + steps: steps + }); + + var hsl = new ColorSpace({ + id: "hsl", + name: "HSL", + coords: { + h: { + refRange: [0, 360], + type: "angle", + name: "Hue", + }, + s: { + range: [0, 100], + name: "Saturation", + }, + l: { + range: [0, 100], + name: "Lightness", + }, + }, + + base: sRGB, + + // Adapted from https://drafts.csswg.org/css-color-4/better-rgbToHsl.js + fromBase: rgb => { + let max = Math.max(...rgb); + let min = Math.min(...rgb); + let [r, g, b] = rgb; + let [h, s, l] = [null, 0, (min + max) / 2]; + let d = max - min; + + if (d !== 0) { + s = (l === 0 || l === 1) ? 0 : (max - l) / Math.min(l, 1 - l); + + switch (max) { + case r: h = (g - b) / d + (g < b ? 6 : 0); break; + case g: h = (b - r) / d + 2; break; + case b: h = (r - g) / d + 4; + } + + h = h * 60; + } + + // Very out of gamut colors can produce negative saturation + // If so, just rotate the hue by 180 and use a positive saturation + // see https://github.com/w3c/csswg-drafts/issues/9222 + if (s < 0) { + h += 180; + s = Math.abs(s); + } + + if (h >= 360) { + h -= 360; + } + + return [h, s * 100, l * 100]; + }, + + // Adapted from https://en.wikipedia.org/wiki/HSL_and_HSV#HSL_to_RGB_alternative + toBase: hsl => { + let [h, s, l] = hsl; + h = h % 360; + + if (h < 0) { + h += 360; + } + + s /= 100; + l /= 100; + + function f (n) { + let k = (n + h / 30) % 12; + let a = s * Math.min(l, 1 - l); + return l - a * Math.max(-1, Math.min(k - 3, 9 - k, 1)); + } + + return [f(0), f(8), f(4)]; + }, + + formats: { + "hsl": { + coords: [" | ", "", ""], + }, + "hsla": { + coords: [" | ", "", ""], + commas: true, + alpha: true, + }, + }, + }); + + // Note that, like HSL, calculations are done directly on + // gamma-corrected sRGB values rather than linearising them first. + + var HSV = new ColorSpace({ + id: "hsv", + name: "HSV", + coords: { + h: { + refRange: [0, 360], + type: "angle", + name: "Hue", + }, + s: { + range: [0, 100], + name: "Saturation", + }, + v: { + range: [0, 100], + name: "Value", + }, + }, + + base: sRGB, + // https://en.wikipedia.org/wiki/HSL_and_HSV#Formal_derivation + fromBase (rgb) { + let max = Math.max(...rgb); + let min = Math.min(...rgb); + let [r, g, b] = rgb; + let [h, s, v] = [null, 0, max]; + let d = max - min; + + if (d !== 0) { + switch (max) { + case r: h = (g - b) / d + (g < b ? 6 : 0); break; + case g: h = (b - r) / d + 2; break; + case b: h = (r - g) / d + 4; + } + + h = h * 60; + } + + if (v) { + s = d / v; + } + + if (h >= 360) { + h -= 360; + } + + return [h, s * 100, v * 100]; + }, + // Adapted from https://en.wikipedia.org/wiki/HSL_and_HSV#HSV_to_RGB_alternative + toBase (hsv) { + let [h, s, v] = hsv; + h = h % 360; + + if (h < 0) { + h += 360; + } + + s /= 100; + v /= 100; + + function f (n) { + let k = (n + h / 60) % 6; + return v - v * s * Math.max(0, Math.min(k, 4 - k, 1)); + } + + return [f(5), f(3), f(1)]; + }, + + formats: { + color: { + id: "--hsv", + coords: [" | ", " | ", " | "], + }, + }, + }); + + // The Hue, Whiteness Blackness (HWB) colorspace + // See https://drafts.csswg.org/css-color-4/#the-hwb-notation + // Note that, like HSL, calculations are done directly on + // gamma-corrected sRGB values rather than linearising them first. + + var hwb = new ColorSpace({ + id: "hwb", + name: "HWB", + coords: { + h: { + refRange: [0, 360], + type: "angle", + name: "Hue", + }, + w: { + range: [0, 100], + name: "Whiteness", + }, + b: { + range: [0, 100], + name: "Blackness", + }, + }, + + base: HSV, + fromBase (hsv) { + let [h, s, v] = hsv; + + return [h, v * (100 - s) / 100, 100 - v]; + }, + toBase (hwb) { + let [h, w, b] = hwb; + + // Now convert percentages to [0..1] + w /= 100; + b /= 100; + + // Achromatic check (white plus black >= 1) + let sum = w + b; + if (sum >= 1) { + let gray = w / sum; + return [h, 0, gray * 100]; + } + + let v = (1 - b); + let s = (v === 0) ? 0 : 1 - w / v; + return [h, s * 100, v * 100]; + }, + + formats: { + "hwb": { + coords: [" | ", " | ", " | "], + }, + }, + }); + + // Type "imports" + /** @typedef {import("../types.js").Matrix3x3} Matrix3x3 */ + + // convert an array of linear-light a98-rgb values to CIE XYZ + // http://www.brucelindbloom.com/index.html?Eqn_RGB_XYZ_Matrix.html + // has greater numerical precision than section 4.3.5.3 of + // https://www.adobe.com/digitalimag/pdfs/AdobeRGB1998.pdf + // but the values below were calculated from first principles + // from the chromaticity coordinates of R G B W + + + /** @type {Matrix3x3} */ + const toXYZ_M$2 = [ + [ 0.5766690429101305, 0.1855582379065463, 0.1882286462349947 ], + [ 0.29734497525053605, 0.6273635662554661, 0.07529145849399788 ], + [ 0.02703136138641234, 0.07068885253582723, 0.9913375368376388 ], + ]; + + + /** @type {Matrix3x3} */ + const fromXYZ_M$2 = [ + [ 2.0415879038107465, -0.5650069742788596, -0.34473135077832956 ], + [ -0.9692436362808795, 1.8759675015077202, 0.04155505740717557 ], + [ 0.013444280632031142, -0.11836239223101838, 1.0151749943912054 ], + ]; + + var A98Linear = new RGBColorSpace({ + id: "a98rgb-linear", + cssId: "--a98-rgb-linear", + name: "Linear Adobe® 98 RGB compatible", + white: "D65", + toXYZ_M: toXYZ_M$2, + fromXYZ_M: fromXYZ_M$2, + }); + + var a98rgb = new RGBColorSpace({ + id: "a98rgb", + cssId: "a98-rgb", + name: "Adobe® 98 RGB compatible", + base: A98Linear, + toBase: RGB => RGB.map(val => Math.pow(Math.abs(val), 563 / 256) * Math.sign(val)), + fromBase: RGB => RGB.map(val => Math.pow(Math.abs(val), 256 / 563) * Math.sign(val)), + }); + + // Type "imports" + /** @typedef {import("../types.js").Matrix3x3} Matrix3x3 */ + + // convert an array of prophoto-rgb values to CIE XYZ + // using D50 (so no chromatic adaptation needed afterwards) + // matrix cannot be expressed in rational form, but is calculated to 64 bit accuracy + // see https://github.com/w3c/csswg-drafts/issues/7675 + /** @type {Matrix3x3} */ + const toXYZ_M$1 = [ + [ 0.79776664490064230, 0.13518129740053308, 0.03134773412839220 ], + [ 0.28807482881940130, 0.71183523424187300, 0.00008993693872564 ], + [ 0.00000000000000000, 0.00000000000000000, 0.82510460251046020 ], + ]; + + /** @type {Matrix3x3} */ + const fromXYZ_M$1 = [ + [ 1.34578688164715830, -0.25557208737979464, -0.05110186497554526 ], + [ -0.54463070512490190, 1.50824774284514680, 0.02052744743642139 ], + [ 0.00000000000000000, 0.00000000000000000, 1.21196754563894520 ], + ]; + + var ProPhotoLinear = new RGBColorSpace({ + id: "prophoto-linear", + cssId: "--prophoto-rgb-linear", + name: "Linear ProPhoto", + white: "D50", + base: XYZ_D50, + toXYZ_M: toXYZ_M$1, + fromXYZ_M: fromXYZ_M$1, + }); + + const Et = 1 / 512; + const Et2 = 16 / 512; + + var prophoto = new RGBColorSpace({ + id: "prophoto", + cssId: "prophoto-rgb", + name: "ProPhoto", + base: ProPhotoLinear, + toBase (RGB) { + // Transfer curve is gamma 1.8 with a small linear portion + return RGB.map(v => v < Et2 ? v / 16 : v ** 1.8); + }, + fromBase (RGB) { + return RGB.map(v => v >= Et ? v ** (1 / 1.8) : 16 * v); + }, + }); + + var oklch = new ColorSpace({ + id: "oklch", + name: "Oklch", + coords: { + l: { + refRange: [0, 1], + name: "Lightness", + }, + c: { + refRange: [0, 0.4], + name: "Chroma", + }, + h: { + refRange: [0, 360], + type: "angle", + name: "Hue", + }, + }, + white: "D65", + + base: Oklab, + fromBase: lch.fromBase, + toBase: lch.toBase, + + formats: { + "oklch": { + coords: [" | ", " | ", " | "], + }, + }, + }); + + // Okhsl class. + // + // ---- License ---- + // + // Copyright (c) 2021 Björn Ottosson + // + // Permission is hereby granted, free of charge, to any person obtaining a copy of + // this software and associated documentation files (the "Software"), to deal in + // the Software without restriction, including without limitation the rights to + // use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies + // of the Software, and to permit persons to whom the Software is furnished to do + // so, subject to the following conditions: + // + // The above copyright notice and this permission notice shall be included in all + // copies or substantial portions of the Software. + // + // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + // SOFTWARE. + + // Type "imports" + /** @typedef {import("../types.js").Matrix3x3} Matrix3x3 */ + /** @typedef {import("../types.js").Vector3} Vector3 */ + /** @typedef {import("../types.js").OKCoeff} OKCoeff */ + + const tau = 2 * Math.PI; + + /** @type {Matrix3x3} */ + const toSRGBLinear = [ + [ 4.0767416360759583, -3.3077115392580629, 0.2309699031821043], + [-1.2684379732850315, 2.6097573492876882, -0.3413193760026570], + [-0.0041960761386756, -0.7034186179359362, 1.7076146940746117], + ]; + + /** @type {OKCoeff} */ + const RGBCoeff = [ + // Red + [ + // Limit + [-1.8817031, -0.80936501], + // `Kn` coefficients + [1.19086277, 1.76576728, 0.59662641, 0.75515197, 0.56771245], + ], + // Green + [ + // Limit + [1.8144408, -1.19445267], + // `Kn` coefficients + [0.73956515, -0.45954404, 0.08285427, 0.12541073, -0.14503204], + ], + // Blue + [ + // Limit + [0.13110758, 1.81333971], + // `Kn` coefficients + [1.35733652, -0.00915799, -1.1513021, -0.50559606, 0.00692167], + ], + ]; + + const floatMax = Number.MAX_VALUE; + const K1 = 0.206; + const K2 = 0.03; + const K3 = (1.0 + K1) / (1.0 + K2); + + + function vdot (a, b) { + // Dot two vectors + + let l = a.length; + if (l !== b.length) { + throw new Error(`Vectors of size ${l} and ${b.length} are not aligned`); + } + + let s = 0.0; + a.forEach((c, i) => { + s += c * b[i]; + }); + + return s; + } + + + /** + * Toe function for L_r + * @param {number} x + */ + function toe (x) { + return 0.5 * (K3 * x - K1 + Math.sqrt((K3 * x - K1) * (K3 * x - K1) + 4 * K2 * K3 * x)); + } + + + /** + * Inverse toe function for L_r + * @param {number} x + */ + function toeInv (x) { + return (x ** 2 + K1 * x) / (K3 * (x + K2)); + } + + + /** + * @param {readonly [number, number]} cusp + * @returns {[number, number]} + */ + function toSt (cusp) { + // To ST. + + let [l, c] = cusp; + return [c / l, c / (1 - l)]; + } + + + function getStMid (a, b) { + // Returns a smooth approximation of the location of the cusp. + // + // This polynomial was created by an optimization process. + // It has been designed so that S_mid < S_max and T_mid < T_max. + + + let s = 0.11516993 + 1.0 / ( + 7.44778970 + 4.15901240 * b + + a * ( + -2.19557347 + 1.75198401 * b + + a * ( + -2.13704948 - 10.02301043 * b + + a * ( + -4.24894561 + 5.38770819 * b + 4.69891013 * a + ) + ) + ) + ); + + let t = 0.11239642 + 1.0 / ( + 1.61320320 - 0.68124379 * b + + a * ( + 0.40370612 + 0.90148123 * b + + a * ( + -0.27087943 + 0.61223990 * b + + a * ( + 0.00299215 - 0.45399568 * b - 0.14661872 * a + ) + ) + ) + ); + + return [s, t]; + } + + /** + * @param {Vector3} lab + * @param {Matrix3x3} lmsToRgb + */ + function oklabToLinearRGB (lab, lmsToRgb) { + // Convert from Oklab to linear RGB. + // + // Can be any gamut as long as `lmsToRgb` is a matrix + // that transform the LMS values to the linear RGB space. + + let lms = multiply_v3_m3x3(lab, LabtoLMS_M); + + lms[0] = lms[0] ** 3; + lms[1] = lms[1] ** 3; + lms[2] = lms[2] ** 3; + + return multiply_v3_m3x3(lms, lmsToRgb, lms); + } + + /** + * @param {number} a + * @param {number} b + * @param {Matrix3x3} lmsToRgb + * @param {OKCoeff} okCoeff + * @returns {[number, number]} + * @todo Could probably make these types more specific/better-documented if desired + */ + function findCusp (a, b, lmsToRgb, okCoeff) { + // Finds L_cusp and C_cusp for a given hue. + // + // `a` and `b` must be normalized so `a^2 + b^2 == 1`. + + // First, find the maximum saturation (saturation `S = C/L`) + let sCusp = computeMaxSaturation(a, b, lmsToRgb, okCoeff); + + // Convert to linear RGB to find the first point where at least one of r, g or b >= 1: + let rgb = oklabToLinearRGB([1, sCusp * a, sCusp * b], lmsToRgb); + let lCusp = spow(1.0 / Math.max(...rgb), 1 / 3); + let cCusp = lCusp * sCusp; + + return [lCusp, cCusp]; + } + + + /** + * @param {number} a + * @param {number} b + * @param {number} l1 + * @param {number} c1 + * @param {number} l0 + * @param {Matrix3x3} lmsToRgb + * @param {OKCoeff} okCoeff + * @param {[number, number]} cusp + * @returns {Number} + * @todo Could probably make these types more specific/better-documented if desired + */ + function findGamutIntersection (a, b, l1, c1, l0, lmsToRgb, okCoeff, cusp) { + // Finds intersection of the line. + // + // Defined by the following: + // + // ``` + // L = L0 * (1 - t) + t * L1 + // C = t * C1 + // ``` + // + // `a` and `b` must be normalized so `a^2 + b^2 == 1`. + + let t; + + if (cusp === undefined) { + cusp = findCusp(a, b, lmsToRgb, okCoeff); + } + + // Find the intersection for upper and lower half separately + if (((l1 - l0) * cusp[1] - (cusp[0] - l0) * c1) <= 0.0) { + // Lower half + t = cusp[1] * l0 / (c1 * cusp[0] + cusp[1] * (l0 - l1)); + } + else { + // Upper half + + // First intersect with triangle + t = cusp[1] * (l0 - 1.0) / (c1 * (cusp[0] - 1.0) + cusp[1] * (l0 - l1)); + + // Then one step Halley's method + let dl = l1 - l0; + let dc = c1; + + let kl = vdot(LabtoLMS_M[0].slice(1), [a, b]); + let km = vdot(LabtoLMS_M[1].slice(1), [a, b]); + let ks = vdot(LabtoLMS_M[2].slice(1), [a, b]); + + let ldt_ = dl + dc * kl; + let mdt_ = dl + dc * km; + let sdt_ = dl + dc * ks; + + // If higher accuracy is required, 2 or 3 iterations of the following block can be used: + let L = l0 * (1.0 - t) + t * l1; + let C = t * c1; + + let l_ = L + C * kl; + let m_ = L + C * km; + let s_ = L + C * ks; + + let l = l_ ** 3; + let m = m_ ** 3; + let s = s_ ** 3; + + let ldt = 3 * ldt_ * (l_ ** 2); + let mdt = 3 * mdt_ * (m_ ** 2); + let sdt = 3 * sdt_ * (s_ ** 2); + + let ldt2 = 6 * (ldt_ ** 2) * l_; + let mdt2 = 6 * (mdt_ ** 2) * m_; + let sdt2 = 6 * (sdt_ ** 2) * s_; + + let r_ = vdot(lmsToRgb[0], [l, m, s]) - 1; + let r1 = vdot(lmsToRgb[0], [ldt, mdt, sdt]); + let r2 = vdot(lmsToRgb[0], [ldt2, mdt2, sdt2]); + + let ur = r1 / (r1 * r1 - 0.5 * r_ * r2); + let tr = -r_ * ur; + + let g_ = vdot(lmsToRgb[1], [l, m, s]) - 1; + let g1 = vdot(lmsToRgb[1], [ldt, mdt, sdt]); + let g2 = vdot(lmsToRgb[1], [ldt2, mdt2, sdt2]); + + let ug = g1 / (g1 * g1 - 0.5 * g_ * g2); + let tg = -g_ * ug; + + let b_ = vdot(lmsToRgb[2], [l, m, s]) - 1; + let b1 = vdot(lmsToRgb[2], [ldt, mdt, sdt]); + let b2 = vdot(lmsToRgb[2], [ldt2, mdt2, sdt2]); + + let ub = b1 / (b1 * b1 - 0.5 * b_ * b2); + let tb = -b_ * ub; + + tr = (ur >= 0.0) ? tr : floatMax; + tg = (ug >= 0.0) ? tg : floatMax; + tb = (ub >= 0.0) ? tb : floatMax; + + t += Math.min(tr, Math.min(tg, tb)); + } + + return t; + } + + + function getCs (lab, lmsToRgb, okCoeff) { + // Get Cs + + let [l, a, b] = lab; + + let cusp = findCusp(a, b, lmsToRgb, okCoeff); + + let cMax = findGamutIntersection(a, b, l, 1, l, lmsToRgb, okCoeff, cusp); + let stMax = toSt(cusp); + + // Scale factor to compensate for the curved part of gamut shape: + let k = cMax / Math.min((l * stMax[0]), (1 - l) * stMax[1]); + + let stMid = getStMid(a, b); + + // Use a soft minimum function, instead of a sharp triangle shape to get a smooth value for chroma. + let ca = l * stMid[0]; + let cb = (1.0 - l) * stMid[1]; + let cMid = 0.9 * k * Math.sqrt(Math.sqrt(1.0 / (1.0 / (ca ** 4) + 1.0 / (cb ** 4)))); + + // For `C_0`, the shape is independent of hue, so `ST` are constant. + // Values picked to roughly be the average values of `ST`. + ca = l * 0.4; + cb = (1.0 - l) * 0.8; + + // Use a soft minimum function, instead of a sharp triangle shape to get a smooth value for chroma. + let c0 = Math.sqrt(1.0 / (1.0 / (ca ** 2) + 1.0 / (cb ** 2))); + + return [c0, cMid, cMax]; + } + + + function computeMaxSaturation (a, b, lmsToRgb, okCoeff) { + // Finds the maximum saturation possible for a given hue that fits in RGB. + // + // Saturation here is defined as `S = C/L`. + // `a` and `b` must be normalized so `a^2 + b^2 == 1`. + + // Max saturation will be when one of r, g or b goes below zero. + + // Select different coefficients depending on which component goes below zero first. + + let k0, k1, k2, k3, k4, wl, wm, ws; + + if (vdot(okCoeff[0][0], [a, b]) > 1) { + // Red component + [k0, k1, k2, k3, k4] = okCoeff[0][1]; + [wl, wm, ws] = lmsToRgb[0]; + } + else if (vdot(okCoeff[1][0], [a, b]) > 1) { + // Green component + [k0, k1, k2, k3, k4] = okCoeff[1][1]; + [wl, wm, ws] = lmsToRgb[1]; + } + else { + // Blue component + [k0, k1, k2, k3, k4] = okCoeff[2][1]; + [wl, wm, ws] = lmsToRgb[2]; + } + + // Approximate max saturation using a polynomial: + let sat = k0 + k1 * a + k2 * b + k3 * (a ** 2) + k4 * a * b; + + // Do one step Halley's method to get closer. + // This gives an error less than 10e6, except for some blue hues where the `dS/dh` is close to infinite. + // This should be sufficient for most applications, otherwise do two/three steps. + + let kl = vdot(LabtoLMS_M[0].slice(1), [a, b]); + let km = vdot(LabtoLMS_M[1].slice(1), [a, b]); + let ks = vdot(LabtoLMS_M[2].slice(1), [a, b]); + + let l_ = 1.0 + sat * kl; + let m_ = 1.0 + sat * km; + let s_ = 1.0 + sat * ks; + + let l = l_ ** 3; + let m = m_ ** 3; + let s = s_ ** 3; + + let lds = 3.0 * kl * (l_ ** 2); + let mds = 3.0 * km * (m_ ** 2); + let sds = 3.0 * ks * (s_ ** 2); + + let lds2 = 6.0 * (kl ** 2) * l_; + let mds2 = 6.0 * (km ** 2) * m_; + let sds2 = 6.0 * (ks ** 2) * s_; + + let f = wl * l + wm * m + ws * s; + let f1 = wl * lds + wm * mds + ws * sds; + let f2 = wl * lds2 + wm * mds2 + ws * sds2; + + sat = sat - f * f1 / ((f1 ** 2) - 0.5 * f * f2); + + return sat; + } + + + function okhslToOklab (hsl, lmsToRgb, okCoeff) { + // Convert Okhsl to Oklab. + + let [h, s, l] = hsl; + let L = toeInv(l); + let a = null; + let b = null; + h = constrain(h) / 360.0; + + if (L !== 0.0 && L !== 1.0 && s !== 0) { + let a_ = Math.cos(tau * h); + let b_ = Math.sin(tau * h); + + let [c0, cMid, cMax] = getCs([L, a_, b_], lmsToRgb, okCoeff); + + // Interpolate the three values for C so that: + // ``` + // At s=0: dC/ds = C_0, C=0 + // At s=0.8: C=C_mid + // At s=1.0: C=C_max + // ``` + + let mid = 0.8; + let midInv = 1.25; + let t, k0, k1, k2; + + if (s < mid) { + t = midInv * s; + k0 = 0.0; + k1 = mid * c0; + k2 = (1.0 - k1 / cMid); + } + else { + t = 5 * (s - 0.8); + k0 = cMid; + k1 = 0.2 * (cMid ** 2) * (1.25 ** 2) / c0; + k2 = 1.0 - k1 / (cMax - cMid); + } + + let c = k0 + t * k1 / (1.0 - k2 * t); + + a = c * a_; + b = c * b_; + } + + return [L, a, b]; + } + + + function oklabToOkhsl (lab, lmsToRgb, okCoeff) { + // Oklab to Okhsl. + + // Epsilon for lightness should approach close to 32 bit lightness + // Epsilon for saturation just needs to be sufficiently close when denoting achromatic + let εL = 1e-7; + let εS = 1e-4; + let L = lab[0]; + let s = 0.0; + let l = toe(L); + + let c = Math.sqrt(lab[1] ** 2 + lab[2] ** 2); + let h = 0.5 + Math.atan2(-lab[2], -lab[1]) / tau; + + if (l !== 0.0 && l !== 1.0 && c !== 0) { + let a_ = lab[1] / c; + let b_ = lab[2] / c; + + let [c0, cMid, cMax] = getCs([L, a_, b_], lmsToRgb, okCoeff); + + let mid = 0.8; + let midInv = 1.25; + let k0, k1, k2, t; + + if (c < cMid) { + k1 = mid * c0; + k2 = 1.0 - k1 / cMid; + + t = c / (k1 + k2 * c); + s = t * mid; + } + + else { + k0 = cMid; + k1 = 0.2 * (cMid ** 2) * (midInv ** 2) / c0; + k2 = (1.0 - (k1) / (cMax - cMid)); + + t = (c - k0) / (k1 + k2 * (c - k0)); + s = mid + 0.2 * t; + } + } + + const achromatic = Math.abs(s) < εS; + if (achromatic || l === 0.0 || Math.abs(1 - l) < εL) { + h = null; + // Due to floating point imprecision near lightness of 1, we can end up + // with really high around white, this is to provide consistency as + // saturation can be really high for white due this imprecision. + if (!achromatic) { + s = 0.0; + } + } + + else { + h = constrain(h * 360); + } + + return [h, s, l]; + } + + + var okhsl = new ColorSpace({ + id: "okhsl", + name: "Okhsl", + coords: { + h: { + refRange: [0, 360], + type: "angle", + name: "Hue", + }, + s: { + range: [0, 1], + name: "Saturation", + }, + l: { + range: [0, 1], + name: "Lightness", + }, + }, + + base: Oklab, + gamutSpace: "self", + + // Convert Oklab to Okhsl + fromBase (lab) { + return oklabToOkhsl(lab, toSRGBLinear, RGBCoeff); + }, + + // Convert Okhsl to Oklab + toBase (hsl) { + return okhslToOklab(hsl, toSRGBLinear, RGBCoeff); + }, + + formats: { + color: { + id: "--okhsl", + coords: [" | ", " | ", " | "], + }, + }, + }); + + var OKLrab = new ColorSpace({ + id: "oklrab", + name: "Oklrab", + coords: { + l: { + refRange: [0, 1], + name: "Lightness", + }, + a: { + refRange: [-0.4, 0.4], + }, + b: { + refRange: [-0.4, 0.4], + }, + }, + + // Note that XYZ is relative to D65 + white: "D65", + + base: Oklab, + fromBase (oklab) { + return [toe(oklab[0]), oklab[1], oklab[2]]; + }, + toBase (oklrab) { + return [toeInv(oklrab[0]), oklrab[1], oklrab[2]]; + }, + + formats: { + "color": { + coords: [" | ", " | [-1,1]", " | [-1,1]"], + }, + }, + }); + + var oklrch = new ColorSpace({ + id: "oklrch", + name: "Oklrch", + coords: { + l: { + refRange: [0, 1], + name: "Lightness", + }, + c: { + refRange: [0, 0.4], + name: "Chroma", + }, + h: { + refRange: [0, 360], + type: "angle", + name: "Hue", + }, + }, + white: "D65", + + base: OKLrab, + fromBase: lch.fromBase, + toBase: lch.toBase, + + formats: { + "color": { + coords: [" | ", " | [0,1]", " | "], + }, + }, + }); + + // Okhsv class. + // + // ---- License ---- + // + // Copyright (c) 2021 Björn Ottosson + // + // Permission is hereby granted, free of charge, to any person obtaining a copy of + // this software and associated documentation files (the "Software"), to deal in + // the Software without restriction, including without limitation the rights to + // use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies + // of the Software, and to permit persons to whom the Software is furnished to do + // so, subject to the following conditions: + // + // The above copyright notice and this permission notice shall be included in all + // copies or substantial portions of the Software. + // + // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + // SOFTWARE. + + // Type "imports" + /** @typedef {import("../types.js").Matrix3x3} Matrix3x3 */ + /** @typedef {import("../types.js").Vector3} Vector3 */ + /** @typedef {import("../types.js").Coords} Coords */ + /** @typedef {import("../types.js").OKCoeff} OKCoeff */ + + + /** + * + * @param {Vector3} hsv + * @param {Matrix3x3} lmsToRgb + * @param {OKCoeff} okCoeff + * @returns {Coords} + */ + function okhsvToOklab (hsv, lmsToRgb, okCoeff) { + // Convert from Okhsv to Oklab.""" + + let [h, s, v] = hsv; + h = constrain(h) / 360.0; + + let l = toeInv(v); + let a = null; + let b = null; + + // Avoid processing gray or colors with undefined hues + if (l !== 0.0 && s !== 0.0) { + let a_ = Math.cos(tau * h); + let b_ = Math.sin(tau * h); + + let cusp = findCusp(a_, b_, lmsToRgb, okCoeff); + let [sMax, tMax] = toSt(cusp); + let s0 = 0.5; + let k = 1 - s0 / sMax; + + // first we compute L and V as if the gamut is a perfect triangle: + + // L, C when v==1: + let lv = 1 - s * s0 / (s0 + tMax - tMax * k * s); + let cv = s * tMax * s0 / (s0 + tMax - tMax * k * s); + + l = v * lv; + let c = v * cv; + + // then we compensate for both toe and the curved top part of the triangle: + let lvt = toeInv(lv); + let cvt = cv * lvt / lv; + + let lNew = toeInv(l); + c = c * lNew / l; + l = lNew; + + // RGB scale + let [rs, gs, bs] = oklabToLinearRGB([lvt, a_ * cvt, b_ * cvt], lmsToRgb); + let scaleL = spow(1.0 / Math.max(Math.max(rs, gs), Math.max(bs, 0.0)), 1 / 3); + + l = l * scaleL; + c = c * scaleL; + + a = c * a_; + b = c * b_; + } + + return [l, a, b]; + } + + /** + * + * @param {Vector3} lab + * @param {Matrix3x3} lmsToRgb + * @param {OKCoeff} okCoeff + * @returns {Coords} + */ + function oklabToOkhsv (lab, lmsToRgb, okCoeff) { + // Oklab to Okhsv. + + // Epsilon for saturation just needs to be sufficiently close when denoting achromatic + let ε = 1e-4; + let l = lab[0]; + let s = 0.0; + let v = toe(l); + let c = Math.sqrt(lab[1] ** 2 + lab[2] ** 2); + let h = 0.5 + Math.atan2(-lab[2], -lab[1]) / tau; + + if (l !== 0.0 && l !== 1 && c !== 0.0) { + let a_ = lab[1] / c; + let b_ = lab[2] / c; + + let cusp = findCusp(a_, b_, lmsToRgb, okCoeff); + let [sMax, tMax] = toSt(cusp); + let s0 = 0.5; + let k = 1 - s0 / sMax; + + // first we find `L_v`, `C_v`, `L_vt` and `C_vt` + let t = tMax / (c + l * tMax); + let lv = t * l; + let cv = t * c; + + let lvt = toeInv(lv); + let cvt = cv * lvt / lv; + + // we can then use these to invert the step that compensates + // for the toe and the curved top part of the triangle: + let [rs, gs, bs] = oklabToLinearRGB([lvt, a_ * cvt, b_ * cvt], lmsToRgb); + let scaleL = spow(1.0 / Math.max(Math.max(rs, gs), Math.max(bs, 0.0)), 1 / 3); + + l = l / scaleL; + c = c / scaleL; + + c = c * toe(l) / l; + l = toe(l); + + // we can now compute v and s: + v = l / lv; + s = (s0 + tMax) * cv / ((tMax * s0) + tMax * k * cv); + } + + if (Math.abs(s) < ε || v === 0.0) { + h = null; + } + + else { + h = constrain(h * 360); + } + + return [h, s, v]; + } + + + var okhsv = new ColorSpace({ + id: "okhsv", + name: "Okhsv", + coords: { + h: { + refRange: [0, 360], + type: "angle", + name: "Hue", + }, + s: { + range: [0, 1], + name: "Saturation", + }, + v: { + range: [0, 1], + name: "Value", + }, + }, + + base: Oklab, + gamutSpace: "self", + + // Convert Oklab to Okhsl + fromBase (lab) { + return oklabToOkhsv(lab, toSRGBLinear, RGBCoeff); + }, + + // Convert Okhsl to Oklab + toBase (hsl) { + return okhsvToOklab(hsl, toSRGBLinear, RGBCoeff); + }, + + formats: { + color: { + id: "--okhsv", + coords: [" | ", " | ", " | "], + }, + }, + }); + + let white = WHITES.D65; + + const ε$2 = 216 / 24389; // 6^3/29^3 == (24/116)^3 + const κ$1 = 24389 / 27; // 29^3/3^3 + const [U_PRIME_WHITE, V_PRIME_WHITE] = uv({space: xyz_d65, coords: white}); + + var Luv = new ColorSpace({ + id: "luv", + name: "Luv", + coords: { + l: { + refRange: [0, 100], + name: "Lightness", + }, + // Reference ranges from https://facelessuser.github.io/coloraide/colors/luv/ + u: { + refRange: [-215, 215], + }, + v: { + refRange: [-215, 215], + }, + }, + + white: white, + base: xyz_d65, + + // Convert D65-adapted XYZ to Luv + // https://en.wikipedia.org/wiki/CIELUV#The_forward_transformation + fromBase (XYZ) { + let xyz = /** @type {[number, number, number]} */ ([skipNone(XYZ[0]), skipNone(XYZ[1]), skipNone(XYZ[2])]); + let y = xyz[1]; + + let [up, vp] = uv({space: xyz_d65, coords: xyz}); + + // Protect against XYZ of [0, 0, 0] + if (!Number.isFinite(up) || !Number.isFinite(vp)) { + return [0, 0, 0]; + } + + let L = y <= ε$2 ? κ$1 * y : 116 * Math.cbrt(y) - 16; + return [ + L, + 13 * L * (up - U_PRIME_WHITE), + 13 * L * (vp - V_PRIME_WHITE), + ]; + }, + + // Convert Luv to D65-adapted XYZ + // https://en.wikipedia.org/wiki/CIELUV#The_reverse_transformation + toBase (Luv) { + let [L, u, v] = Luv; + + // Protect against division by zero and none Lightness + if (L === 0 || isNone(L)) { + return [0, 0, 0]; + } + + u = skipNone(u); + v = skipNone(v); + + let up = (u / (13 * L)) + U_PRIME_WHITE; + let vp = (v / (13 * L)) + V_PRIME_WHITE; + + let y = L <= 8 ? L / κ$1 : Math.pow((L + 16) / 116, 3); + + return [ + y * ((9 * up) / (4 * vp)), + y, + y * ((12 - 3 * up - 20 * vp) / (4 * vp)), + ]; + }, + + formats: { + color: { + id: "--luv", + coords: [" | ", " | ", " | "], + }, + }, + }); + + var LCHuv = new ColorSpace({ + id: "lchuv", + name: "LChuv", + coords: { + l: { + refRange: [0, 100], + name: "Lightness", + }, + c: { + refRange: [0, 220], + name: "Chroma", + }, + h: { + refRange: [0, 360], + type: "angle", + name: "Hue", + }, + }, + + base: Luv, + fromBase: lch.fromBase, + toBase: lch.toBase, + + formats: { + color: { + id: "--lchuv", + coords: [" | ", " | ", " | "], + }, + }, + }); + + /* + Adapted from: https://github.com/hsluv/hsluv-javascript/blob/14b49e6cf9a9137916096b8487a5372626b57ba4/src/hsluv.ts + + Copyright (c) 2012-2022 Alexei Boronine + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE. + */ + + + const ε$1 = 216 / 24389; // 6^3/29^3 == (24/116)^3 + const κ = 24389 / 27; // 29^3/3^3 + + const m_r0 = fromXYZ_M$3[0][0]; + const m_r1 = fromXYZ_M$3[0][1]; + const m_r2 = fromXYZ_M$3[0][2]; + const m_g0 = fromXYZ_M$3[1][0]; + const m_g1 = fromXYZ_M$3[1][1]; + const m_g2 = fromXYZ_M$3[1][2]; + const m_b0 = fromXYZ_M$3[2][0]; + const m_b1 = fromXYZ_M$3[2][1]; + const m_b2 = fromXYZ_M$3[2][2]; + + function distanceFromOriginAngle (slope, intercept, angle) { + const d = intercept / (Math.sin(angle) - slope * Math.cos(angle)); + return d < 0 ? Infinity : d; + } + + /** + * @param {number} l + */ + function calculateBoundingLines (l) { + const sub1 = Math.pow(l + 16, 3) / 1560896; + const sub2 = sub1 > ε$1 ? sub1 : l / κ; + const s1r = sub2 * (284517 * m_r0 - 94839 * m_r2); + const s2r = sub2 * (838422 * m_r2 + 769860 * m_r1 + 731718 * m_r0); + const s3r = sub2 * (632260 * m_r2 - 126452 * m_r1); + const s1g = sub2 * (284517 * m_g0 - 94839 * m_g2); + const s2g = sub2 * (838422 * m_g2 + 769860 * m_g1 + 731718 * m_g0); + const s3g = sub2 * (632260 * m_g2 - 126452 * m_g1); + const s1b = sub2 * (284517 * m_b0 - 94839 * m_b2); + const s2b = sub2 * (838422 * m_b2 + 769860 * m_b1 + 731718 * m_b0); + const s3b = sub2 * (632260 * m_b2 - 126452 * m_b1); + + return { + r0s: s1r / s3r, + r0i: s2r * l / s3r, + r1s: s1r / (s3r + 126452), + r1i: (s2r - 769860) * l / (s3r + 126452), + g0s: s1g / s3g, + g0i: s2g * l / s3g, + g1s: s1g / (s3g + 126452), + g1i: (s2g - 769860) * l / (s3g + 126452), + b0s: s1b / s3b, + b0i: s2b * l / s3b, + b1s: s1b / (s3b + 126452), + b1i: (s2b - 769860) * l / (s3b + 126452), + }; + } + + function calcMaxChromaHsluv (lines, h) { + const hueRad = h / 360 * Math.PI * 2; + const r0 = distanceFromOriginAngle(lines.r0s, lines.r0i, hueRad); + const r1 = distanceFromOriginAngle(lines.r1s, lines.r1i, hueRad); + const g0 = distanceFromOriginAngle(lines.g0s, lines.g0i, hueRad); + const g1 = distanceFromOriginAngle(lines.g1s, lines.g1i, hueRad); + const b0 = distanceFromOriginAngle(lines.b0s, lines.b0i, hueRad); + const b1 = distanceFromOriginAngle(lines.b1s, lines.b1i, hueRad); + + return Math.min(r0, r1, g0, g1, b0, b1); + } + + var hsluv = new ColorSpace({ + id: "hsluv", + name: "HSLuv", + coords: { + h: { + refRange: [0, 360], + type: "angle", + name: "Hue", + }, + s: { + range: [0, 100], + name: "Saturation", + }, + l: { + range: [0, 100], + name: "Lightness", + }, + }, + + base: LCHuv, + gamutSpace: sRGB, + + // Convert LCHuv to HSLuv + fromBase (lch) { + let [l, c, h] = [skipNone(lch[0]), skipNone(lch[1]), skipNone(lch[2])]; + let s; + + if (l > 99.9999999) { + s = 0; + l = 100; + } + else if (l < 0.00000001) { + s = 0; + l = 0; + } + else { + let lines = calculateBoundingLines(l); + let max = calcMaxChromaHsluv(lines, h); + s = c / max * 100; + } + + return [h, s, l]; + }, + + // Convert HSLuv to LCHuv + toBase (hsl) { + let [h, s, l] = [skipNone(hsl[0]), skipNone(hsl[1]), skipNone(hsl[2])]; + let c; + + if (l > 99.9999999) { + l = 100; + c = 0; + } + else if (l < 0.00000001) { + l = 0; + c = 0; + } + else { + let lines = calculateBoundingLines(l); + let max = calcMaxChromaHsluv(lines, h); + c = max / 100 * s; + } + + return [l, c, h]; + }, + + formats: { + color: { + id: "--hsluv", + coords: [" | ", " | ", " | "], + }, + }, + }); + + /* + Adapted from: https://github.com/hsluv/hsluv-javascript/blob/14b49e6cf9a9137916096b8487a5372626b57ba4/src/hsluv.ts + + Copyright (c) 2012-2022 Alexei Boronine + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE. + */ + + + fromXYZ_M$3[0][0]; + fromXYZ_M$3[0][1]; + fromXYZ_M$3[0][2]; + fromXYZ_M$3[1][0]; + fromXYZ_M$3[1][1]; + fromXYZ_M$3[1][2]; + fromXYZ_M$3[2][0]; + fromXYZ_M$3[2][1]; + fromXYZ_M$3[2][2]; + + function distanceFromOrigin (slope, intercept) { + return Math.abs(intercept) / Math.sqrt(Math.pow(slope, 2) + 1); + } + + function calcMaxChromaHpluv (lines) { + let r0 = distanceFromOrigin(lines.r0s, lines.r0i); + let r1 = distanceFromOrigin(lines.r1s, lines.r1i); + let g0 = distanceFromOrigin(lines.g0s, lines.g0i); + let g1 = distanceFromOrigin(lines.g1s, lines.g1i); + let b0 = distanceFromOrigin(lines.b0s, lines.b0i); + let b1 = distanceFromOrigin(lines.b1s, lines.b1i); + + return Math.min(r0, r1, g0, g1, b0, b1); + } + + var hpluv = new ColorSpace({ + id: "hpluv", + name: "HPLuv", + coords: { + h: { + refRange: [0, 360], + type: "angle", + name: "Hue", + }, + s: { + range: [0, 100], + name: "Saturation", + }, + l: { + range: [0, 100], + name: "Lightness", + }, + }, + + base: LCHuv, + gamutSpace: "self", + + // Convert LCHuv to HPLuv + fromBase (lch) { + let [l, c, h] = [skipNone(lch[0]), skipNone(lch[1]), skipNone(lch[2])]; + let s; + + if (l > 99.9999999) { + s = 0; + l = 100; + } + else if (l < 0.00000001) { + s = 0; + l = 0; + } + else { + let lines = calculateBoundingLines(l); + let max = calcMaxChromaHpluv(lines); + s = c / max * 100; + } + return [h, s, l]; + }, + + // Convert HPLuv to LCHuv + toBase (hsl) { + let [h, s, l] = [skipNone(hsl[0]), skipNone(hsl[1]), skipNone(hsl[2])]; + let c; + + if (l > 99.9999999) { + l = 100; + c = 0; + } + else if (l < 0.00000001) { + l = 0; + c = 0; + } + else { + let lines = calculateBoundingLines(l); + let max = calcMaxChromaHpluv(lines); + c = max / 100 * s; + } + + return [l, c, h]; + }, + + formats: { + color: { + id: "--hpluv", + coords: [" | ", " | ", " | "], + }, + }, + }); + + var REC_2100_Linear = new RGBColorSpace({ + id: "rec2100-linear", + name: "Linear REC.2100", + white: "D65", + toBase: REC_2020_Linear.toBase, + fromBase: REC_2020_Linear.fromBase, + }); + + const Yw = 203; // absolute luminance of media white, cd/m² + const n = 2610 / (2 ** 14); + const ninv = (2 ** 14) / 2610; + const m = 2523 / (2 ** 5); + const minv = (2 ** 5) / 2523; + const c1 = 3424 / (2 ** 12); + const c2 = 2413 / (2 ** 7); + const c3 = 2392 / (2 ** 7); + + var rec2100Pq = new RGBColorSpace({ + id: "rec2100pq", + cssId: "rec2100-pq", + name: "REC.2100-PQ", + base: REC_2100_Linear, + toBase (RGB) { + // given PQ encoded component in range [0, 1] + // return media-white relative linear-light + return RGB.map(function (val) { + let x = ((Math.max(((val ** minv) - c1), 0) / (c2 - (c3 * (val ** minv)))) ** ninv); + return (x * 10000 / Yw); // luminance relative to diffuse white, [0, 70 or so]. + }); + }, + fromBase (RGB) { + // given media-white relative linear-light + // returnPQ encoded component in range [0, 1] + return RGB.map(function (val) { + let x = Math.max(val * Yw / 10000, 0); // absolute luminance of peak white is 10,000 cd/m². + let num = (c1 + (c2 * (x ** n))); + let denom = (1 + (c3 * (x ** n))); + + return ((num / denom) ** m); + }); + }, + }); + + const a = 0.17883277; + const b = 0.28466892; // 1 - (4 * a) + const c = 0.55991073; // 0.5 - a * Math.log(4 *a) + + const scale = 3.7743; // Place 18% grey at HLG 0.38, so media white at 0.75 + + var rec2100Hlg = new RGBColorSpace({ + id: "rec2100hlg", + cssId: "rec2100-hlg", + name: "REC.2100-HLG", + referred: "scene", + + base: REC_2100_Linear, + toBase (RGB) { + // given HLG encoded component in range [0, 1] + // return media-white relative linear-light + return RGB.map(function (val) { + // first the HLG EOTF + // ITU-R BT.2390-10 p.30 section + // 6.3 The hybrid log-gamma electro-optical transfer function (EOTF) + // Then scale by 3 so media white is 1.0 + if (val <= 0.5) { + return (val ** 2) / 3 * scale; + } + return ((Math.exp((val - c) / a) + b) / 12) * scale; + }); + }, + fromBase (RGB) { + // given media-white relative linear-light + // where diffuse white is 1.0, + // return HLG encoded component in range [0, 1] + return RGB.map(function (val) { + // first scale to put linear-light media white at 1/3 + val /= scale; + // now the HLG OETF + // ITU-R BT.2390-10 p.23 + // 6.1 The hybrid log-gamma opto-electronic transfer function (OETF) + if (val <= 1 / 12) { + return spow(3 * val, 0.5); + } + return a * Math.log(12 * val - b) + c; + }); + }, + }); + + // Type "imports" + /** @typedef {import("./types.js").White} White */ + /** @typedef {import("./types.js").CAT} CAT */ + + /** @type {Record} */ + const CATs = {}; + + hooks.add("chromatic-adaptation-start", env => { + if (env.options.method) { + env.M = adapt(env.W1, env.W2, env.options.method); + } + }); + + hooks.add("chromatic-adaptation-end", env => { + if (!env.M) { + env.M = adapt(env.W1, env.W2, env.options.method); + } + }); + + function defineCAT (/** @type {CAT} */ {id, toCone_M, fromCone_M}) { + // Use id, toCone_M, fromCone_M like variables + CATs[id] = arguments[0]; + } + + /** + * + * @param {White} W1 + * @param {White} W2 + * @param {string} id + * @returns {number[][]} + */ + function adapt (W1, W2, id = "Bradford") { + // adapt from a source whitepoint or illuminant W1 + // to a destination whitepoint or illuminant W2, + // using the given chromatic adaptation transform (CAT) + // debugger; + let method = CATs[id]; + + let [ρs, γs, βs] = multiplyMatrices(method.toCone_M, W1); + let [ρd, γd, βd] = multiplyMatrices(method.toCone_M, W2); + + // all practical illuminants have non-zero XYZ so no division by zero can occur below + let scale = [ + [ρd / ρs, 0, 0 ], + [0, γd / γs, 0 ], + [0, 0, βd / βs], + ]; + // console.log({scale}); + + let scaled_cone_M = multiplyMatrices(scale, method.toCone_M); + let adapt_M = multiplyMatrices(method.fromCone_M, scaled_cone_M); + // console.log({scaled_cone_M, adapt_M}); + return adapt_M; + } + + defineCAT({ + id: "von Kries", + toCone_M: [ + [ 0.4002400, 0.7076000, -0.0808100 ], + [ -0.2263000, 1.1653200, 0.0457000 ], + [ 0.0000000, 0.0000000, 0.9182200 ], + ], + fromCone_M: [ + [ 1.8599363874558397, -1.1293816185800916, 0.21989740959619328 ], + [ 0.3611914362417676, 0.6388124632850422, -0.000006370596838649899 ], + [ 0, 0, 1.0890636230968613 ], + ], + }); + + defineCAT({ + id: "Bradford", + // Convert an array of XYZ values in the range 0.0 - 1.0 + // to cone fundamentals + toCone_M: [ + [ 0.8951000, 0.2664000, -0.1614000 ], + [ -0.7502000, 1.7135000, 0.0367000 ], + [ 0.0389000, -0.0685000, 1.0296000 ], + ], + // and back + fromCone_M: [ + [ 0.9869929054667121, -0.14705425642099013, 0.15996265166373122 ], + [ 0.4323052697233945, 0.5183602715367774, 0.049291228212855594 ], + [ -0.00852866457517732, 0.04004282165408486, 0.96848669578755 ], + ], + }); + + defineCAT({ + id: "CAT02", + // with complete chromatic adaptation to W2, so D = 1.0 + toCone_M: [ + [ 0.7328000, 0.4296000, -0.1624000 ], + [ -0.7036000, 1.6975000, 0.0061000 ], + [ 0.0030000, 0.0136000, 0.9834000 ], + ], + fromCone_M: [ + [ 1.0961238208355142, -0.27886900021828726, 0.18274517938277307 ], + [ 0.4543690419753592, 0.4735331543074117, 0.07209780371722911 ], + [ -0.009627608738429355, -0.00569803121611342, 1.0153256399545427 ], + ], + }); + + defineCAT({ + id: "CAT16", + toCone_M: [ + [ 0.401288, 0.650173, -0.051461 ], + [ -0.250268, 1.204414, 0.045854 ], + [ -0.002079, 0.048952, 0.953127 ], + ], + // the extra precision is needed to avoid roundtripping errors + fromCone_M: [ + [ 1.862067855087233, -1.0112546305316845, 0.14918677544445172 ], + [ 0.3875265432361372, 0.6214474419314753, -0.008973985167612521 ], + [ -0.01584149884933386, -0.03412293802851557, 1.0499644368778496 ], + ], + }); + + Object.assign(WHITES, { + // whitepoint values from ASTM E308-01 with 10nm spacing, 1931 2 degree observer + // all normalized to Y (luminance) = 1.00000 + // Illuminant A is a tungsten electric light, giving a very warm, orange light. + A: [1.09850, 1.00000, 0.35585], + + // Illuminant C was an early approximation to daylight: illuminant A with a blue filter. + C: [0.98074, 1.000000, 1.18232], + + // The daylight series of illuminants simulate natural daylight. + // The color temperature (in degrees Kelvin/100) ranges from + // cool, overcast daylight (D50) to bright, direct sunlight (D65). + D55: [0.95682, 1.00000, 0.92149], + D75: [0.94972, 1.00000, 1.22638], + + // Equal-energy illuminant, used in two-stage CAT16 + E: [1.00000, 1.00000, 1.00000], + + // The F series of illuminants represent fluorescent lights + F2: [0.99186, 1.00000, 0.67393], + F7: [0.95041, 1.00000, 1.08747], + F11: [1.00962, 1.00000, 0.64350], + }); + + // Type "imports" + /** @typedef {import("../types.js").Matrix3x3} Matrix3x3 */ + + // The ACES whitepoint + // see TB-2018-001 Derivation of the ACES White Point CIE Chromaticity Coordinates + // also https://github.com/ampas/aces-dev/blob/master/documents/python/TB-2018-001/aces_wp.py + // Similar to D60 + WHITES.ACES = [0.32168 / 0.33767, 1.00000, (1.00000 - 0.32168 - 0.33767) / 0.33767]; + + // convert an array of linear-light ACEScc values to CIE XYZ + /** @type {Matrix3x3} */ + const toXYZ_M = [ + [ 0.6624541811085053, 0.13400420645643313, 0.1561876870049078 ], + [ 0.27222871678091454, 0.6740817658111484, 0.05368951740793705 ], + [ -0.005574649490394108, 0.004060733528982826, 1.0103391003129971 ], + ]; + /** @type {Matrix3x3} */ + const fromXYZ_M = [ + [ 1.6410233796943257, -0.32480329418479, -0.23642469523761225 ], + [ -0.6636628587229829, 1.6153315916573379, 0.016756347685530137 ], + [ 0.011721894328375376, -0.008284441996237409, 0.9883948585390215 ], + ]; + + var ACEScg = new RGBColorSpace({ + id: "acescg", + cssId: "--acescg", + name: "ACEScg", + + // ACEScg – A scene-referred, linear-light encoding of ACES Data + // https://docs.acescentral.com/specifications/acescg/ + // uses the AP1 primaries, see section 4.3.1 Color primaries + coords: { + r: { + range: [0, 65504], + name: "Red", + }, + g: { + range: [0, 65504], + name: "Green", + }, + b: { + range: [0, 65504], + name: "Blue", + }, + }, + + referred: "scene", + + white: WHITES.ACES, + + toXYZ_M, + fromXYZ_M, + }); + + // export default Color; + + const ε = 2 ** -16; + + // the smallest value which, in the 32bit IEEE 754 float encoding, + // decodes as a non-negative value + const ACES_min_nonzero = -0.35828683; + + // brightest encoded value, decodes to 65504 + const ACES_cc_max = (Math.log2(65504) + 9.72) / 17.52; // 1.468 + + var acescc = new RGBColorSpace({ + id: "acescc", + cssId: "--acescc", + name: "ACEScc", + // see S-2014-003 ACEScc – A Logarithmic Encoding of ACES Data + // https://docs.acescentral.com/specifications/acescc/ + // uses the AP1 primaries, see section 4.3.1 Color primaries + + // Appendix A: "Very small ACES scene referred values below 7 1/4 stops + // below 18% middle gray are encoded as negative ACEScc values. + // These values should be preserved per the encoding in Section 4.4 + // so that all positive ACES values are maintained." + coords: { + r: { + range: [ACES_min_nonzero, ACES_cc_max], + name: "Red", + }, + g: { + range: [ACES_min_nonzero, ACES_cc_max], + name: "Green", + }, + b: { + range: [ACES_min_nonzero, ACES_cc_max], + name: "Blue", + }, + }, + referred: "scene", + + base: ACEScg, + // from section 4.4.2 Decoding Function + toBase (RGB) { + const low = (9.72 - 15) / 17.52; // -0.3014 + + return RGB.map(function (val) { + if (val <= low) { + return (2 ** ((val * 17.52) - 9.72) - ε) * 2; // very low values, below -0.3014 + } + else if (val < ACES_cc_max) { + return 2 ** ((val * 17.52) - 9.72); + } + else { // val >= ACES_cc_max + return 65504; + } + }); + }, + + // Non-linear encoding function from S-2014-003, section 4.4.1 Encoding Function + fromBase (RGB) { + return RGB.map(function (val) { + if (val <= 0) { + return (Math.log2(ε) + 9.72) / 17.52; // -0.3584 + } + else if (val < ε) { + return (Math.log2(ε + val * 0.5) + 9.72) / 17.52; + } + else { // val >= ε + return (Math.log2(val) + 9.72) / 17.52; + } + }); + }, + // encoded media white (rgb 1,1,1) => linear [ 222.861, 222.861, 222.861 ] + // encoded media black (rgb 0,0,0) => linear [ 0.0011857, 0.0011857, 0.0011857] + }); + + /** + * @packageDocumentation + * Re-exports all the spaces built into Color.js. + */ + + var spaces = /*#__PURE__*/Object.freeze({ + __proto__: null, + A98RGB: a98rgb, + A98RGB_Linear: A98Linear, + ACEScc: acescc, + ACEScg: ACEScg, + CAM16_JMh: cam16, + HCT: hct, + HPLuv: hpluv, + HSL: hsl, + HSLuv: hsluv, + HSV: HSV, + HWB: hwb, + ICTCP: ictcp, + JzCzHz: jzczhz, + Jzazbz: Jzazbz, + LCH: lch, + LCHuv: LCHuv, + Lab: lab, + Lab_D65: lab_d65, + Luv: Luv, + OKLCH: oklch, + OKLab: Oklab, + OKLrCH: oklrch, + OKLrab: OKLrab, + Okhsl: okhsl, + Okhsv: okhsv, + P3: P3, + P3_Linear: P3Linear, + ProPhoto: prophoto, + ProPhoto_Linear: ProPhotoLinear, + REC_2020: REC2020, + REC_2020_Linear: REC_2020_Linear, + REC_2100_HLG: rec2100Hlg, + REC_2100_Linear: REC_2100_Linear, + REC_2100_PQ: rec2100Pq, + XYZ_ABS_D65: XYZ_Abs_D65, + XYZ_D50: XYZ_D50, + XYZ_D65: xyz_d65, + sRGB: sRGB, + sRGB_Linear: sRGBLinear + }); + + /** + * @packageDocumentation + * @class Color + * Class that represents a single color. + * All of Color.js’s tree-shakeable methods are also available as instance methods on this class, + * as well as static methods that take the color as the first argument. + */ + + + class Color { + /** + * Creates an instance of Color. + * Signatures: + * - `new Color(stringToParse)` + * - `new Color(otherColor)` + * - `new Color({space, coords, alpha})` + * - `new Color(space, coords, alpha)` + * - `new Color(spaceId, coords, alpha)` + */ + constructor (...args) { + let color; + + if (args.length === 1) { + let parseMeta = {}; + color = getColor(args[0], {parseMeta}); + + if (parseMeta.format) { + // Color actually came from a string + this.parseMeta = parseMeta; + } + } + + let space, coords, alpha; + + if (color) { + space = color.space || color.spaceId; + coords = color.coords; + alpha = color.alpha; + } + else { + // default signature new Color(ColorSpace, array [, alpha]) + [space, coords, alpha] = args; + } + + Object.defineProperty(this, "space", { + value: ColorSpace.get(space), + writable: false, + enumerable: true, + configurable: true, // see note in https://262.ecma-international.org/8.0/#sec-proxy-object-internal-methods-and-internal-slots-get-p-receiver + }); + + this.coords = coords ? coords.slice() : [0, 0, 0]; + + // Clamp alpha to [0, 1] + this.alpha = isNone(alpha) ? alpha : alpha === undefined ? 1 : clamp(0, alpha, 1); + + // Define getters and setters for each coordinate + for (let id in this.space.coords) { + Object.defineProperty(this, id, { + get: () => this.get(id), + set: value => this.set(id, value), + }); + } + } + + get spaceId () { + return this.space.id; + } + + clone () { + return new Color(this.space, this.coords, this.alpha); + } + + toJSON () { + return { + spaceId: this.spaceId, + coords: this.coords, + alpha: this.alpha, + }; + } + + display (...args) { + let ret = display(this, ...args); + + // Convert color object to Color instance + ret.color = new Color(ret.color); + + return ret; + } + + /** + * Get a color from the argument passed + * Basically gets us the same result as new Color(color) but doesn't clone an existing color object + */ + static get (color, ...args) { + if (color instanceof Color) { + return color; + } + + return new Color(color, ...args); + } + + static defineFunction (name, code, o = code) { + let {instance = true, returns} = o; + + let func = function (...args) { + let ret = code(...args); + + if (returns === "color") { + ret = Color.get(ret); + } + else if (returns === "function") { + let f = ret; + ret = function (...args) { + let ret = f(...args); + return Color.get(ret); + }; + // Copy any function metadata + Object.assign(ret, f); + } + else if (returns === "array") { + ret = ret.map(c => Color.get(c)); + } + + return ret; + }; + + if (!(name in Color)) { + Color[name] = func; + } + + if (instance) { + Color.prototype[name] = function (...args) { + return func(this, ...args); + }; + } + } + + static defineFunctions (o) { + for (let name in o) { + Color.defineFunction(name, o[name], o[name]); + } + } + + static extend (exports) { + if (exports.register) { + exports.register(Color); + } + else { + // No register method, just add the module's functions + for (let name in exports) { + Color.defineFunction(name, exports[name]); + } + } + } + } + + Color.defineFunctions({ + get, + getAll, + set, + setAll, + to, + equals, + inGamut, + toGamut, + distance, + deltas, + toString: serialize, + }); + + Object.assign(Color, { + util, + hooks, + WHITES, + Space: ColorSpace, + spaces: ColorSpace.registry, + parse, + + // Global defaults one may want to configure + defaults, + }); + + /** + * @packageDocumentation + * This module contains {@link spaces a namespace} with all the spaces built into Color.js. + */ + + for (let key of Object.keys(spaces)) { + ColorSpace.register(spaces[key]); + } + + /** + * This plugin defines getters and setters for color[spaceId] + * e.g. color.lch on *any* color gives us the lch coords + */ + + // Add space accessors to existing color spaces + for (let id in ColorSpace.registry) { + addSpaceAccessors(id, ColorSpace.registry[id]); + } + + // Add space accessors to color spaces not yet created + hooks.add("colorspace-init-end", space => { + addSpaceAccessors(space.id, space); + space.aliases?.forEach(alias => { + addSpaceAccessors(alias, space); + }); + }); + + function addSpaceAccessors (id, space) { + let propId = id.replace(/-/g, "_"); + + Object.defineProperty(Color.prototype, propId, { + // Convert coords to coords in another colorspace and return them + // Source colorspace: this.spaceId + // Target colorspace: id + get () { + let ret = this.getAll(id); + + if (typeof Proxy === "undefined") { + // If proxies are not supported, just return a static array + return ret; + } + + // Enable color.spaceId.coordName syntax + return new Proxy(ret, { + has: /** @param {string} property */ (obj, property) => { + try { + ColorSpace.resolveCoord([space, property]); + return true; + } + catch (e) {} + + return Reflect.has(obj, property); + }, + get: (obj, property, receiver) => { + if (property && typeof property !== "symbol" && !(property in obj)) { + let {index} = ColorSpace.resolveCoord([space, property]); + + if (index >= 0) { + return obj[index]; + } + } + + return Reflect.get(obj, property, receiver); + }, + set: (obj, property, value, receiver) => { + if (property && typeof property !== "symbol" && !(property in obj) || property >= 0) { + let {index} = ColorSpace.resolveCoord([space, /** @type {string} */ (property)]); + + if (index >= 0) { + obj[index] = value; + + // Update color.coords + this.setAll(id, obj); + + return true; + } + } + + return Reflect.set(obj, property, value, receiver); + }, + }); + }, + // Convert coords in another colorspace to internal coords and set them + // Target colorspace: this.spaceId + // Source colorspace: id + set (coords) { + this.setAll(id, coords); + }, + configurable: true, + enumerable: true, + }); + } + + /** + * Entry point for the OOP flavor of the API + * Import as `colorjs.io` + */ + + Color.extend(deltaEMethods); + Color.extend({deltaE}); + Object.assign(Color, {deltaEMethods}); + Color.extend(variations); + Color.extend({contrast}); + Color.extend(chromaticity); + Color.extend(luminance); + Color.extend(interpolation); + Color.extend(contrastMethods); + + return Color; + +})(); +//# sourceMappingURL=color.global.js.map \ No newline at end of file diff --git a/core/modules/utils/dom/color.js/tiddlywiki.files b/core/modules/utils/dom/color.js/tiddlywiki.files new file mode 100644 index 00000000000..0ce43a85e47 --- /dev/null +++ b/core/modules/utils/dom/color.js/tiddlywiki.files @@ -0,0 +1,21 @@ +{ + "tiddlers": [ + { + "file": "color.global.0.5.2.js", + "fields": { + "type": "application/javascript", + "title": "$:/core/modules/utils/dom/color.js", + "module-type": "library" + }, + "prefix": "", + "suffix": ";\nexports.Color = Color;" + }, + { + "file": "LICENSE", + "fields": { + "type": "text/plain", + "title": "$:/core/modules/utils/dom/color.js/license" + } + } + ] +} diff --git a/core/modules/utils/dom/csscolorparser.js b/core/modules/utils/dom/csscolorparser.js deleted file mode 100644 index 1ad4a1f20bc..00000000000 --- a/core/modules/utils/dom/csscolorparser.js +++ /dev/null @@ -1,200 +0,0 @@ -// (c) Dean McNamee , 2012. -// -// https://github.com/deanm/css-color-parser-js -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to -// deal in the Software without restriction, including without limitation the -// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or -// sell copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in -// all copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS -// IN THE SOFTWARE. - -// http://www.w3.org/TR/css3-color/ -var kCSSColorTable = { - "transparent": [0,0,0,0], "aliceblue": [240,248,255,1], - "antiquewhite": [250,235,215,1], "aqua": [0,255,255,1], - "aquamarine": [127,255,212,1], "azure": [240,255,255,1], - "beige": [245,245,220,1], "bisque": [255,228,196,1], - "black": [0,0,0,1], "blanchedalmond": [255,235,205,1], - "blue": [0,0,255,1], "blueviolet": [138,43,226,1], - "brown": [165,42,42,1], "burlywood": [222,184,135,1], - "cadetblue": [95,158,160,1], "chartreuse": [127,255,0,1], - "chocolate": [210,105,30,1], "coral": [255,127,80,1], - "cornflowerblue": [100,149,237,1], "cornsilk": [255,248,220,1], - "crimson": [220,20,60,1], "cyan": [0,255,255,1], - "darkblue": [0,0,139,1], "darkcyan": [0,139,139,1], - "darkgoldenrod": [184,134,11,1], "darkgray": [169,169,169,1], - "darkgreen": [0,100,0,1], "darkgrey": [169,169,169,1], - "darkkhaki": [189,183,107,1], "darkmagenta": [139,0,139,1], - "darkolivegreen": [85,107,47,1], "darkorange": [255,140,0,1], - "darkorchid": [153,50,204,1], "darkred": [139,0,0,1], - "darksalmon": [233,150,122,1], "darkseagreen": [143,188,143,1], - "darkslateblue": [72,61,139,1], "darkslategray": [47,79,79,1], - "darkslategrey": [47,79,79,1], "darkturquoise": [0,206,209,1], - "darkviolet": [148,0,211,1], "deeppink": [255,20,147,1], - "deepskyblue": [0,191,255,1], "dimgray": [105,105,105,1], - "dimgrey": [105,105,105,1], "dodgerblue": [30,144,255,1], - "firebrick": [178,34,34,1], "floralwhite": [255,250,240,1], - "forestgreen": [34,139,34,1], "fuchsia": [255,0,255,1], - "gainsboro": [220,220,220,1], "ghostwhite": [248,248,255,1], - "gold": [255,215,0,1], "goldenrod": [218,165,32,1], - "gray": [128,128,128,1], "green": [0,128,0,1], - "greenyellow": [173,255,47,1], "grey": [128,128,128,1], - "honeydew": [240,255,240,1], "hotpink": [255,105,180,1], - "indianred": [205,92,92,1], "indigo": [75,0,130,1], - "ivory": [255,255,240,1], "khaki": [240,230,140,1], - "lavender": [230,230,250,1], "lavenderblush": [255,240,245,1], - "lawngreen": [124,252,0,1], "lemonchiffon": [255,250,205,1], - "lightblue": [173,216,230,1], "lightcoral": [240,128,128,1], - "lightcyan": [224,255,255,1], "lightgoldenrodyellow": [250,250,210,1], - "lightgray": [211,211,211,1], "lightgreen": [144,238,144,1], - "lightgrey": [211,211,211,1], "lightpink": [255,182,193,1], - "lightsalmon": [255,160,122,1], "lightseagreen": [32,178,170,1], - "lightskyblue": [135,206,250,1], "lightslategray": [119,136,153,1], - "lightslategrey": [119,136,153,1], "lightsteelblue": [176,196,222,1], - "lightyellow": [255,255,224,1], "lime": [0,255,0,1], - "limegreen": [50,205,50,1], "linen": [250,240,230,1], - "magenta": [255,0,255,1], "maroon": [128,0,0,1], - "mediumaquamarine": [102,205,170,1], "mediumblue": [0,0,205,1], - "mediumorchid": [186,85,211,1], "mediumpurple": [147,112,219,1], - "mediumseagreen": [60,179,113,1], "mediumslateblue": [123,104,238,1], - "mediumspringgreen": [0,250,154,1], "mediumturquoise": [72,209,204,1], - "mediumvioletred": [199,21,133,1], "midnightblue": [25,25,112,1], - "mintcream": [245,255,250,1], "mistyrose": [255,228,225,1], - "moccasin": [255,228,181,1], "navajowhite": [255,222,173,1], - "navy": [0,0,128,1], "oldlace": [253,245,230,1], - "olive": [128,128,0,1], "olivedrab": [107,142,35,1], - "orange": [255,165,0,1], "orangered": [255,69,0,1], - "orchid": [218,112,214,1], "palegoldenrod": [238,232,170,1], - "palegreen": [152,251,152,1], "paleturquoise": [175,238,238,1], - "palevioletred": [219,112,147,1], "papayawhip": [255,239,213,1], - "peachpuff": [255,218,185,1], "peru": [205,133,63,1], - "pink": [255,192,203,1], "plum": [221,160,221,1], - "powderblue": [176,224,230,1], "purple": [128,0,128,1], - "red": [255,0,0,1], "rosybrown": [188,143,143,1], - "royalblue": [65,105,225,1], "saddlebrown": [139,69,19,1], - "salmon": [250,128,114,1], "sandybrown": [244,164,96,1], - "seagreen": [46,139,87,1], "seashell": [255,245,238,1], - "sienna": [160,82,45,1], "silver": [192,192,192,1], - "skyblue": [135,206,235,1], "slateblue": [106,90,205,1], - "slategray": [112,128,144,1], "slategrey": [112,128,144,1], - "snow": [255,250,250,1], "springgreen": [0,255,127,1], - "steelblue": [70,130,180,1], "tan": [210,180,140,1], - "teal": [0,128,128,1], "thistle": [216,191,216,1], - "tomato": [255,99,71,1], "turquoise": [64,224,208,1], - "violet": [238,130,238,1], "wheat": [245,222,179,1], - "white": [255,255,255,1], "whitesmoke": [245,245,245,1], - "yellow": [255,255,0,1], "yellowgreen": [154,205,50,1]} - -function clamp_css_byte(i) { // Clamp to integer 0 .. 255. - i = Math.round(i); // Seems to be what Chrome does (vs truncation). - return i < 0 ? 0 : i > 255 ? 255 : i; -} - -function clamp_css_float(f) { // Clamp to float 0.0 .. 1.0. - return f < 0 ? 0 : f > 1 ? 1 : f; -} - -function parse_css_int(str) { // int or percentage. - if (str[str.length - 1] === '%') - return clamp_css_byte(parseFloat(str) / 100 * 255); - return clamp_css_byte(parseInt(str)); -} - -function parse_css_float(str) { // float or percentage. - if (str[str.length - 1] === '%') - return clamp_css_float(parseFloat(str) / 100); - return clamp_css_float(parseFloat(str)); -} - -function css_hue_to_rgb(m1, m2, h) { - if (h < 0) h += 1; - else if (h > 1) h -= 1; - - if (h * 6 < 1) return m1 + (m2 - m1) * h * 6; - if (h * 2 < 1) return m2; - if (h * 3 < 2) return m1 + (m2 - m1) * (2/3 - h) * 6; - return m1; -} - -function parseCSSColor(css_str) { - // Remove all whitespace, not compliant, but should just be more accepting. - var str = css_str.replace(/ /g, '').toLowerCase(); - - // Color keywords (and transparent) lookup. - if (str in kCSSColorTable) return kCSSColorTable[str].slice(); // dup. - - // #abc and #abc123 syntax. - if (str[0] === '#') { - if (str.length === 4) { - var iv = parseInt(str.substr(1), 16); // TODO(deanm): Stricter parsing. - if (!(iv >= 0 && iv <= 0xfff)) return null; // Covers NaN. - return [((iv & 0xf00) >> 4) | ((iv & 0xf00) >> 8), - (iv & 0xf0) | ((iv & 0xf0) >> 4), - (iv & 0xf) | ((iv & 0xf) << 4), - 1]; - } else if (str.length === 7) { - var iv = parseInt(str.substr(1), 16); // TODO(deanm): Stricter parsing. - if (!(iv >= 0 && iv <= 0xffffff)) return null; // Covers NaN. - return [(iv & 0xff0000) >> 16, - (iv & 0xff00) >> 8, - iv & 0xff, - 1]; - } - - return null; - } - - var op = str.indexOf('('), ep = str.indexOf(')'); - if (op !== -1 && ep + 1 === str.length) { - var fname = str.substr(0, op); - var params = str.substr(op+1, ep-(op+1)).split(','); - var alpha = 1; // To allow case fallthrough. - switch (fname) { - case 'rgba': - if (params.length !== 4) return null; - alpha = parse_css_float(params.pop()); - // Fall through. - case 'rgb': - if (params.length !== 3) return null; - return [parse_css_int(params[0]), - parse_css_int(params[1]), - parse_css_int(params[2]), - alpha]; - case 'hsla': - if (params.length !== 4) return null; - alpha = parse_css_float(params.pop()); - // Fall through. - case 'hsl': - if (params.length !== 3) return null; - var h = (((parseFloat(params[0]) % 360) + 360) % 360) / 360; // 0 .. 1 - // NOTE(deanm): According to the CSS spec s/l should only be - // percentages, but we don't bother and let float or percentage. - var s = parse_css_float(params[1]); - var l = parse_css_float(params[2]); - var m2 = l <= 0.5 ? l * (s + 1) : l + s - l * s; - var m1 = l * 2 - m2; - return [clamp_css_byte(css_hue_to_rgb(m1, m2, h+1/3) * 255), - clamp_css_byte(css_hue_to_rgb(m1, m2, h) * 255), - clamp_css_byte(css_hue_to_rgb(m1, m2, h-1/3) * 255), - alpha]; - default: - return null; - } - } - - return null; -} - -try { exports.parseCSSColor = parseCSSColor } catch(e) { } diff --git a/core/modules/utils/dom/csscolorparser.js.meta b/core/modules/utils/dom/csscolorparser.js.meta deleted file mode 100644 index 064e84de2c2..00000000000 --- a/core/modules/utils/dom/csscolorparser.js.meta +++ /dev/null @@ -1,3 +0,0 @@ -title: $:/core/modules/utils/dom/csscolorparser.js -type: application/javascript -module-type: utils diff --git a/core/palette-templates/TwentyTwenties.tid b/core/palette-templates/TwentyTwenties.tid new file mode 100644 index 00000000000..b2949324e97 --- /dev/null +++ b/core/palette-templates/TwentyTwenties.tid @@ -0,0 +1,195 @@ +title: $:/palettes/TwentyTwenties +name: TwentyTwenties +description: Modern and flexible +tags: $:/tags/Palette +type: application/x-tiddler-dictionary +color-scheme: light +palette-type: modern + +# Background and foreground colours, which are interpolated as required +base-paper: #FCFFF0 +base-background: #f5f0f9 +base-ink: #333344 +?base-paper-ink: [tf.check-colour-contrast[base-paper],[base-ink],[45]] +?base-background-ink: [tf.check-colour-contrast[base-background],[base-ink],[45]] + +# Primary colour, used for links and other accented elements +base-primary: #5778d8 +?base-paper-primary: [tf.check-colour-contrast[base-paper],[base-primary],[45]] +?base-background-primary: [tf.check-colour-contrast[base-background],[base-primary],[45]] + +# Secondary colour, used for alerts and other secondary elements +base-secondary: #f0e48a +?base-ink-secondary: [tf.check-colour-contrast[base-ink],[base-secondary],[45]] + +# Tertiary base colour, used for monospaced text and other tertiary elements +base-tertiary: rgb(183, 95, 95) +?base-paper-tertiary: [tf.check-colour-contrast[base-paper],[base-tertiary],[45]] + +# Basic spectrum colours +base-black: #100F0F +base-red: #D14D41 +base-orange: #DA702C +base-yellow: #D0A215 +base-green: #879A39 +base-cyan: #3AA99F +base-blue: #4385BE +base-purple: #8B7EC8 +base-magenta: #CE5D97 +# Darker variants +# base-red: #AF3029; +# base-orange: #BC5215; +# base-yellow: #AD8301; +# base-green: #66800B; +# base-cyan: #24837B; +# base-blue: #205EA6; +# base-purple: #5E409D; +# base-magenta: #A02F6F; + +# Colour definitions +alert-background: [function[colour],[base-secondary]] +alert-border: [function[colour],[base-ink]] [function[colour],[alert-background]] +[colour-interpolate:oklch[0.6]] +alert-highlight: [function[colour],[base-ink]] [function[colour],[base-primary]] +[colour-interpolate:oklch[0.3]] +alert-muted-foreground: [function[colour],[base-ink]] [function[colour],[alert-background]] +[colour-interpolate:oklch[0.4]] +?alert-contrast: [tf.check-colour-contrast[alert-background],[foreground],[45]] +background: [function[colour],[base-paper]] +blockquote-bar: [function[colour],[muted-foreground]] +button-background: +button-foreground: +button-border: +code-background: [function[colour],[base-tertiary]colour-set-oklch:l[0.9]] +code-border: [function[colour],[base-tertiary]color-oklch:l[0.5]] +code-foreground: [function[colour],[base-tertiary]colour-set-oklch:l[0.3]] +?code-contrast: [tf.check-colour-contrast[code-background],[code-foreground],[45]] +diff-delete-background: [function[colour],[]] +diff-delete-foreground: [function[colour],[foreground]] +diff-equal-background: +diff-equal-foreground: [function[colour],[foreground]] +diff-insert-background: [function[colour],[]] +diff-insert-foreground: [function[colour],[foreground]] +diff-invisible-background: +diff-invisible-foreground: [function[colour],[muted-foreground]] +dirty-indicator: [function[colour],[]] +download-background: [function[colour],[]] +download-foreground: [function[colour],[background]] +dragger-background: [function[colour],[foreground]] +dragger-foreground: [function[colour],[background]] +dropdown-background: [function[colour],[background]] +dropdown-border: [function[colour],[muted-foreground]] +dropdown-tab-background-selected: [function[colour],[]] +dropdown-tab-background: [function[colour],[]] +dropzone-background: rgba(0,200,0,0.7) +external-link-background-hover: inherit +external-link-background-visited: inherit +external-link-background: inherit +external-link-foreground-hover: inherit +external-link-foreground-visited: [function[colour],[primary]] +external-link-foreground: [function[colour],[primary]] +footnote-target-background: [function[colour],[]] +foreground: [function[colour],[base-ink]] +?background-foreground-contrast: [tf.check-colour-contrast[background],[foreground],[45]] +highlight-background: [function[colour],[]] +highlight-foreground: [function[colour],[]] +message-background: [function[colour],[]] +message-border: [function[colour],[]] +message-foreground: [function[colour],[]] +modal-backdrop: [function[colour],[foreground]] +modal-background: [function[colour],[background]] +modal-border: [function[colour],[]] +modal-footer-background: [function[colour],[]] +modal-footer-border: [function[colour],[]] +modal-header-border: [function[colour],[]] +muted-foreground: [function[colour],[]] +network-activity-foreground: [function[colour],[]] +notification-background: [function[colour],[base-tertiary]colour-set-oklch:l[0.9]] +notification-border: [function[colour],[base-tertiary]colour-set-oklch:l[0.2]] +page-background: [function[colour],[base-background]] +pre-background: [function[colour],[base-tertiary]colour-set-oklch:l[0.98]] +pre-border: [function[colour],[base-tertiary]colour-set-oklch:l[0.3]] +primary: [function[colour],[base-primary]] +selection-background: +selection-foreground: +select-tag-background: +select-tag-foreground: +sidebar-button-foreground: [function[colour],[foreground]] +sidebar-controls-foreground-hover: [function[colour],[]] +sidebar-controls-foreground: [function[colour],[]] +sidebar-foreground-shadow: rgba(255,255,255, 0.8) +sidebar-foreground: [function[colour],[]] +sidebar-muted-foreground-hover: [function[colour],[]] +sidebar-muted-foreground: [function[colour],[]] +sidebar-tab-background-selected: [function[colour],[]] +sidebar-tab-background: [function[colour],[]] +sidebar-tab-border-selected: [function[colour],[tab-border-selected]] +sidebar-tab-border: [function[colour],[tab-border]] +sidebar-tab-divider: [function[colour],[]] +sidebar-tab-foreground-selected: +sidebar-tab-foreground: [function[colour],[tab-foreground]] +sidebar-tiddler-link-foreground-hover: [function[colour],[]] +sidebar-tiddler-link-foreground: [function[colour],[]] +site-title-foreground: [function[colour],[tiddler-title-foreground]] +stability-stable: [function[colour],[]] +stability-experimental: [function[colour],[]] +stability-deprecated: [function[colour],[]] +stability-legacy: [function[colour],[]] +static-alert-foreground: [function[colour],[]] +tab-background-selected: [function[colour],[]] +tab-background: [function[colour],[]] +tab-border-selected: [function[colour],[]] +tab-border: [function[colour],[]] +tab-divider: [function[colour],[]] +tab-foreground-selected: [function[colour],[tab-foreground]] +tab-foreground: [function[colour],[]] +table-border: [function[colour],[]] +table-footer-background: [function[colour],[]] +table-header-background: [function[colour],[]] +tag-background: [function[colour],[]] +tag-foreground: [function[colour],[]] +testcase-accent-level-1: [function[colour],[]] +testcase-accent-level-2: [function[colour],[]] +testcase-accent-level-3: [function[colour],[]] +tiddler-background: [function[colour],[background]] +tiddler-border: [function[colour],[base-paper]] [function[colour],[base-background]] +[colour-interpolate:oklch[0.5]] +tiddler-controls-foreground-hover: [function[colour],[background]] [function[colour],[foreground]] +[colour-interpolate:oklch[0.7]] +tiddler-controls-foreground-selected: [function[colour],[background]] [function[colour],[foreground]] +[colour-interpolate:oklch[0.9]] +tiddler-controls-foreground: [function[colour],[background]] [function[colour],[foreground]] +[colour-interpolate:oklch[0.5]] +tiddler-editor-background: [function[colour],[]] +tiddler-editor-border-image: [function[colour],[]] +tiddler-editor-border: [function[colour],[]] +tiddler-editor-fields-even: [function[colour],[]] +tiddler-editor-fields-odd: [function[colour],[]] +tiddler-info-background: [function[colour],[]] +tiddler-info-border: [function[colour],[]] +tiddler-info-tab-background: [function[colour],[]] +tiddler-link-background: [function[colour],[background]] +tiddler-link-foreground: [function[colour],[primary]] +tiddler-subtitle-foreground: [function[colour],[]] +tiddler-title-foreground: [function[colour],[]] +toolbar-new-button: +toolbar-options-button: +toolbar-save-button: +toolbar-info-button: +toolbar-edit-button: +toolbar-close-button: +toolbar-delete-button: +toolbar-cancel-button: +toolbar-done-button: +untagged-background: [function[colour],[]] +very-muted-foreground: [function[colour],[]] +wikilist-background: [function[colour],[]] +wikilist-item: [function[colour],[]] +wikilist-info: [function[colour],[]] +wikilist-title: [function[colour],[]] +wikilist-title-svg: [function[colour],[wikilist-title]] +wikilist-url: [function[colour],[]] +wikilist-button-open: [function[colour],[]] +wikilist-button-open-hover: green +wikilist-button-reveal: [function[colour],[]] +wikilist-button-reveal-hover: blue +wikilist-button-remove: [function[colour],[]] +wikilist-button-remove-hover: red +wikilist-toolbar-background: [function[colour],[]] +wikilist-toolbar-foreground: [function[colour],[]] +wikilist-droplink-dragover: rgba(255,192,192,0.5) +wikilist-button-background: [function[colour],[]] +wikilist-button-foreground: [function[colour],[]] diff --git a/core/palette-templates/TwentyTwentiesGreen.tid b/core/palette-templates/TwentyTwentiesGreen.tid new file mode 100644 index 00000000000..82ad2330414 --- /dev/null +++ b/core/palette-templates/TwentyTwentiesGreen.tid @@ -0,0 +1,12 @@ +title: $:/palettes/TwentyTwenties/Green +name: TwentyTwenties (Green) +description: Modern and flexible, Greenish +tags: $:/tags/Palette +type: application/x-tiddler-dictionary +color-scheme: light +palette-type: modern +palette-import: $:/palettes/TwentyTwenties + +base-paper: rgb(188, 255, 161) +base-background: rgb(94, 192, 145) +base-primary: #6e803c diff --git a/core/ui/Palettes/Preview/Alert.tid b/core/ui/Palettes/Preview/Alert.tid new file mode 100644 index 00000000000..cd523ff422b --- /dev/null +++ b/core/ui/Palettes/Preview/Alert.tid @@ -0,0 +1,19 @@ +title: $:/core/ui/Palettes/Preview/Alert +tags: $:/tags/Preview/PageOptional + +\whitespace trim +<$colour.div class="tc-palette-preview-thumbnail-alert" styleName="background-color" styleColour="alert-background"> + <$colour.div class="tc-palette-preview-thumbnail-alert-border" styleName="border-color" styleColour="alert-border"> + <$colour.div styleName="color" styleColour="foreground"> + <$colour.div class="tc-palette-preview-thumbnail-alert-subtitle" styleName="color" styleColour="alert-muted-foreground"> + Lorem Ipsum + <$colour.div class="tc-palette-preview-thumbnail-alert-highlight" styleName="color" styleColour="alert-highlight"> + (Count: 1) + + + <$colour.div class="tc-palette-preview-thumbnail-alert-body"> + Lorem Ipsum Dolor Sit Amet Consectetur Adipiscing Elit Sed Do Eiusmod Tempor Incididunt. + + + + \ No newline at end of file diff --git a/core/ui/Palettes/Preview/Notification.tid b/core/ui/Palettes/Preview/Notification.tid new file mode 100644 index 00000000000..52f4d521a5c --- /dev/null +++ b/core/ui/Palettes/Preview/Notification.tid @@ -0,0 +1,11 @@ +title: $:/core/ui/Palettes/Preview/Notification +tags: $:/tags/Preview/PageOptional + +\whitespace trim +<$colour.div class="tc-palette-preview-thumbnail-notification" styleName="background-color" styleColour="notification-background"> + <$colour.div class="tc-palette-preview-thumbnail-notification-border" styleName="border-color" styleColour="notification-border"> + <$colour.div class="tc-palette-preview-thumbnail-notification-body" styleName="color" styleColour="foreground"> + Lorem Ipsum Dolor Sit Amet Consectetur + + + \ No newline at end of file diff --git a/core/ui/Palettes/Preview/SideBar/Search.tid b/core/ui/Palettes/Preview/SideBar/Search.tid new file mode 100644 index 00000000000..5bf2cd96cd1 --- /dev/null +++ b/core/ui/Palettes/Preview/SideBar/Search.tid @@ -0,0 +1,8 @@ +title: $:/core/ui/Palettes/Preview/Sidebar/Search +tags: $:/tags/Preview/SideBar + +\whitespace trim +<$colour.div class="tc-palette-preview-thumbnail-sidebar-search" styleName="background-color" styleColour="background"> + <$colour.div class="tc-palette-preview-thumbnail-sidebar-search-box"> + + diff --git a/core/ui/Palettes/Preview/SideBar/Subtitle.tid b/core/ui/Palettes/Preview/SideBar/Subtitle.tid new file mode 100644 index 00000000000..ad4889e22cc --- /dev/null +++ b/core/ui/Palettes/Preview/SideBar/Subtitle.tid @@ -0,0 +1,7 @@ +title: $:/core/ui/Palettes/Preview/Sidebar/Subtitle +tags: $:/tags/Preview/SideBar + +\whitespace trim +<$colour.div class="tc-palette-preview-thumbnail-sidebar-subtitle"> + a non-linear personal web notebook + diff --git a/core/ui/Palettes/Preview/SideBar/Title.tid b/core/ui/Palettes/Preview/SideBar/Title.tid new file mode 100644 index 00000000000..ac3b6eba7d0 --- /dev/null +++ b/core/ui/Palettes/Preview/SideBar/Title.tid @@ -0,0 +1,7 @@ +title: $:/core/ui/Palettes/Preview/Sidebar/Title +tags: $:/tags/Preview/SideBar + +\whitespace trim +<$colour.div class="tc-palette-preview-thumbnail-sidebar-title" styleName="color" styleColour="site-title-foreground"> + ~TiddlyWiki + diff --git a/core/ui/Palettes/Preview/Sidebar.tid b/core/ui/Palettes/Preview/Sidebar.tid new file mode 100644 index 00000000000..2b5f8e151ae --- /dev/null +++ b/core/ui/Palettes/Preview/Sidebar.tid @@ -0,0 +1,7 @@ +title: $:/core/ui/Palettes/Preview/SideBar +tags: $:/tags/Preview/Page + +\whitespace trim +<$colour.div class="tc-palette-preview-thumbnail-sidebar" styleName="color" styleColour="sidebar-foreground"> + <> + \ No newline at end of file diff --git a/core/ui/Palettes/Preview/Story.tid b/core/ui/Palettes/Preview/Story.tid new file mode 100644 index 00000000000..76a5bde30e9 --- /dev/null +++ b/core/ui/Palettes/Preview/Story.tid @@ -0,0 +1,9 @@ +title: $:/core/ui/Palettes/Preview/Story +tags: $:/tags/Preview/Page + +\whitespace trim +<$colour.div class="tc-palette-preview-thumbnail-story"> + <$list filter="HelloThere GettingStarted" variable="title"> + <> + + \ No newline at end of file diff --git a/core/ui/Palettes/Preview/Tiddler.tid b/core/ui/Palettes/Preview/Tiddler.tid new file mode 100644 index 00000000000..e03e8dbea31 --- /dev/null +++ b/core/ui/Palettes/Preview/Tiddler.tid @@ -0,0 +1,8 @@ +title: $:/core/ui/Palettes/Preview/Tiddler +tags: $:/tags/Preview/Story + +\parameters (title) +\whitespace trim +<$colour.div class="tc-palette-preview-thumbnail-tiddler" styleName="background-color" styleColour="tiddler-background"> + <> + \ No newline at end of file diff --git a/core/ui/Palettes/Preview/Tiddler/Body.tid b/core/ui/Palettes/Preview/Tiddler/Body.tid new file mode 100644 index 00000000000..d87ddadf3fa --- /dev/null +++ b/core/ui/Palettes/Preview/Tiddler/Body.tid @@ -0,0 +1,7 @@ +title: $:/core/ui/Palettes/Preview/Tiddler/Body +tags: $:/tags/Preview/Tiddler + +\whitespace trim +<$colour.div class="tc-palette-preview-thumbnail-tiddler-body" styleName="color" styleColour="foreground"> + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras non arcu ultricies, egestas odio tempus, vestibulum ipsum. Praesent diam lorem, elementum in venenatis eget, tincidunt quis lacus. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Etiam efficitur velit tortor, sit amet tristique felis viverra sit amet. Nullam posuere facilisis purus sed consectetur. Integer vel elit euismod, posuere ligula et, dictum tellus. Donec in odio diam. Sed metus magna, placerat at ligula et, imperdiet sagittis ex. + diff --git a/core/ui/Palettes/Preview/Tiddler/Header.tid b/core/ui/Palettes/Preview/Tiddler/Header.tid new file mode 100644 index 00000000000..5e4fdad9cd5 --- /dev/null +++ b/core/ui/Palettes/Preview/Tiddler/Header.tid @@ -0,0 +1,14 @@ +title: $:/core/ui/Palettes/Preview/Tiddler/Header +tags: $:/tags/Preview/Tiddler + +\whitespace trim +<$colour.div class="tc-palette-preview-thumbnail-tiddler-header"> +<$colour.div class="tc-palette-preview-thumbnail-tiddler-title" styleName="color" styleColour="tiddler-title-foreground"> + <$text text=<>/> +</$colour.div> +<$colour.div class="tc-palette-preview-thumbnail-tiddler-toolbar" styleName="fill" styleColour="tiddler-controls-foreground"> + {{$:/core/images/down-arrow}} + {{$:/core/images/edit-button}} + {{$:/core/images/close-button}} +</$colour.div> +</$colour.div> diff --git a/core/ui/Palettes/Preview/Tiddler/Subtitle.tid b/core/ui/Palettes/Preview/Tiddler/Subtitle.tid new file mode 100644 index 00000000000..949765ec7e9 --- /dev/null +++ b/core/ui/Palettes/Preview/Tiddler/Subtitle.tid @@ -0,0 +1,7 @@ +title: $:/core/ui/Palettes/Preview/Tiddler/Subtitle +tags: $:/tags/Preview/Tiddler + +\whitespace trim +<$colour.div class="tc-palette-preview-thumbnail-tiddler-subtitle" styleName="color" styleColour="tiddler-subtitle-foreground"> + Motovun Jack +</$colour.div> diff --git a/core/wiki/currpalettepreview.tid b/core/wiki/currpalettepreview.tid index 61356edd0b6..013414847bd 100644 --- a/core/wiki/currpalettepreview.tid +++ b/core/wiki/currpalettepreview.tid @@ -1,52 +1,60 @@ title: $:/snippets/currpalettepreview -\define resolve-colour(macrocall) -\import $:/core/macros/utils \whitespace trim -<$wikify name="name" text="""$macrocall$"""> -<<name>> -</$wikify> -\end -\define swatchStyle() -background-color: $(swatchColour)$; -\end -\define swatch-inner() + +\procedure colour-div-filtered(class,styleName,styleColour) +<!-- Note the join, needed to cope with palette entries containing spaces --> +\function colour(name) [<colour-palette>getindex<name>] :else[<colour-palette>get[palette-import]getindex<name>] :map[subfilter<currentTiddler>join[ ]] +<$let + colour-palette=<<currentTiddler>> + colour-result={{{ [function[colour],<styleColour>] }}} +> + <div class=<<class>> style={{{ [<styleName>addsuffix[:]addsuffix<colour-result>addsuffix[;]] }}}> + <$slot $name="ts-raw" $depth="2"/> + </div> +</$let> +\end colour-div-filtered + +\procedure colour-div-wikified(class,styleName,styleColour) +<!-- Define our own deeply backwards compatible local versions of the colour macro --> +\define colour(name) \whitespace trim -<$set name="swatchColour" value={{##$(colourResolved)$}}> -<$list filter="[<swatchColour>!prefix[<<colour ]!suffix[>>]]" variable="ignore"> -<div class="tc-swatch" style=<<swatchStyle>> title=<<swatchTitle>>/> - -</$list> -<$list filter="[<swatchColour>prefix[<<colour ]suffix[>>]]" variable="ignore"> -<$wikify name="colourResolved" text="<$macrocall $name='resolve-colour' macrocall=<<swatchColour>>/>"> -<<swatch-inner>> -</$wikify> -</$list> -</$set> -\end -\define swatch() -\whitespace trim -<$set name="swatchColour" value={{##$(colour)$}}> -<$set name="swatchTitle" value=<<colour>>> -<$list filter="[<swatchColour>!prefix[<<colour ]!suffix[>>]]" variable="ignore"> -<div class="tc-swatch" style=<<swatchStyle>> title=<<swatchTitle>>/> - -</$list> -<$list filter="[<swatchColour>prefix[<<colour ]suffix[>>]]" variable="ignore"> -<$wikify name="colourResolved" text="<$macrocall $name='resolve-colour' macrocall=<<swatchColour>>/>"> -<<swatch-inner>> +<$transclude tiddler=<<currentTiddler>> index="$name$"> + <$transclude tiddler="$:/config/DefaultColourMappings/$name$"/> +</$transclude> +\end colour +\define color(name) <<colour $name$>> +<$wikify name="colour-result" text={{{ [[<<colour ]addsuffix<styleColour>addsuffix[>>]] }}} mode="inline"> + <div class=<<class>> style={{{ [<styleName>addsuffix[:]addsuffix<colour-result>addsuffix[;]] }}}> + <$slot $name="ts-raw" $depth="2"/> + </div> </$wikify> +\end colour-div-wikified + +\widget $colour.div(class,styleName,styleColour) +<%if [<styleName>!match[]] %> + <%if [<currentTiddler>get[palette-type]match[modern]] %> + <$transclude $variable="colour-div-filtered" class=<<class>> styleName=<<styleName>> styleColour=<<styleColour>>/> + <%else%> + <$transclude $variable="colour-div-wikified" class=<<class>> styleName=<<styleName>> styleColour=<<styleColour>>/> + <%endif%> +<%else%> + <div class=<<class>>> + <$slot $name="ts-raw"/> + </div> +<%endif%> +\end $colour.div + +\procedure palette-preview-component-list(tag) +<$list filter="[all[shadows+tiddlers]tag<tag>!has[draft.of]]" variable="componentTitle"> + <$transclude $tiddler=<<componentTitle>> title=<<title>>/> </$list> -</$set> -</$set> -\end -\whitespace trim -<div class="tc-swatches-horiz"><$list filter=" -foreground -background -muted-foreground -primary -page-background -tab-background -tiddler-info-background -" variable="colour"><<swatch>></$list></div> +\end palette-preview-component-list + +\procedure palette-preview-thumbnail() +<$colour.div class="tc-palette-preview-thumbnail" styleName="background-color" styleColour="page-background"> + <<palette-preview-component-list "$:/tags/Preview/Page">> +</$colour.div> +\end palette-preview-thumbnail + +<<palette-preview-thumbnail>> diff --git a/core/wiki/macros/CSS.tid b/core/wiki/macros/CSS.tid index 09c85efe9b4..44ae8ff6481 100644 --- a/core/wiki/macros/CSS.tid +++ b/core/wiki/macros/CSS.tid @@ -1,17 +1,91 @@ title: $:/core/macros/CSS tags: $:/tags/Macro -<!-- Needs to stay that way for backwards compatibility. See GH issue: #8326 --> +\procedure actions-compile-palette-filtered(tempPalette,outputTitle) +<!-- Note the join, needed to cope with palette entries containing spaces --> +\function colour(name) [<tv-palette-name>getindex<name>] :else[<tv-palette-name>get[palette-import]getindex<name>] :map[subfilter<currentTiddler>join[ ]] +<!-- Make the colour function use the input palette --> +<$let + tv-palette-name=<<tempPalette>> +> + <$list filter="[<tempPalette>indexes[]sort[]]" variable="colour-name"> + <$let colour-filter={{{ [<tempPalette>getindex<colour-name>] }}}> + <!-- Note the join, needed to cope with palette entries containing spaces --> + <$action-setfield $tiddler=<<outputTitle>> $index=<<colour-name>> $value={{{ [subfilter<colour-filter>join[ ]] }}}/> + </$let> + </$list> +</$let> +\end actions-compile-palette-filtered + +\procedure actions-compile-palette-wikified(tempPalette,outputTitle) +<!-- Define our own deeply backwards compatible local versions of the colour macro --> \define colour(name) \whitespace trim -<$transclude tiddler={{$:/palette}} index="$name$"> - <$transclude tiddler="$:/palettes/Vanilla" index="$name$"> - <$transclude tiddler="$:/config/DefaultColourMappings/$name$"/> - </$transclude> +<$transclude tiddler=<<tempPalette>> index="$name$"> + <$transclude tiddler="$:/config/DefaultColourMappings/$name$"/> </$transclude> -\end - +\end colour \define color(name) <<colour $name$>> +<$list filter="[<tempPalette>indexes[]sort[]]" variable="colour-name" $debug="yes"> + <$wikify name="colour-value" text={{{ [<tempPalette>getindex<colour-name>] }}} mode="inline"> + <$action-setfield $tiddler=<<outputTitle>> $index=<<colour-name>> $value=<<colour-value>>/> + </$wikify> +</$list> +\end actions-compile-palette-wikified + +\procedure actions-compile-palette(inputTitle,outputTitle,defaultImport="$:/palettes/Vanilla") +<$let + tempPalette="$:/temp/palette-source" +> + <!-- Clear the temporary consolidated palette --> + <$action-deletetiddler $tiddler=<<tempPalette>>/> + <!-- Consolidate the imported palette --> + <$let importTitle={{{ [<inputTitle>get[palette-import]else<defaultImport>] }}}> + <%if [<importTitle>!match[]] %> + <$list filter="[<importTitle>indexes[]sort[]]" variable="colour-name"> + <$action-setfield $tiddler=<<tempPalette>> $index=<<colour-name>> $value={{{ [<importTitle>getindex<colour-name>] }}}/> + </$list> + <%endif%> + </$let> + <!-- Consolidate the main palette --> + <$list filter="[<inputTitle>indexes[]sort[]]" variable="colour-name"> + <$action-setfield $tiddler=<<tempPalette>> $index=<<colour-name>> $value={{{ [<inputTitle>getindex<colour-name>] }}}/> + </$list> + <!-- Compile the temporary palette to the output palette --> + <%if [<inputTitle>get[palette-type]match[modern]] %> + <$transclude $variable="actions-compile-palette-filtered" tempPalette=<<tempPalette>> outputTitle=<<outputTitle>>/> + <%else%> + <$transclude $variable="actions-compile-palette-wikified" tempPalette=<<tempPalette>> outputTitle=<<outputTitle>>/> + <%endif%> + <!-- Remove the temporary consolidated palette --> + <!-- <$action-deletetiddler $tiddler=<<tempPalette>>/> --> +</$let> +\end actions-compile-palette + +\procedure actions-switch-colour-palette(paletteTitle) +\procedure tv-action-refresh-policy() always +<$action-deletetiddler $tiddler="$:/temp/palette-colours"/> +<$action-setfield $tiddler="$:/palette" $field="text" $value=<<paletteTitle>>/> +<$transclude $variable="actions-compile-palette" inputTitle=<<paletteTitle>> outputTitle="$:/temp/palette-colours"/> +\end actions-switch-colour-palette + +\procedure tv-palette-name() $:/temp/palette-colours + +\function colour(name) +[<tv-palette-name>getindex<name>] :else[[$:/config/DefaultColourMappings/]addsuffix<name>get[text]] +\end colour + +\function color(name) +[function[colour],<name>] +\end color + +\function tf.check-colour-contrast-subfunction() +[function[colour],<paletteEntryA>] [function[colour],<paletteEntryB>] +[colour-contrast:DeltaPhi[]fixed[3]] +\end tf.check-colour-contrast-subfunction + +\function tf.check-colour-contrast(paletteEntryA,paletteEntryB,threshold) +[function[tf.check-colour-contrast-subfunction]compare:number:gt<threshold>then[ok]] :else[function[tf.check-colour-contrast-subfunction]addsuffix[: ]addsuffix<paletteEntryA>addsuffix[/]addsuffix<paletteEntryB>addsuffix[ contrast is too low]] +\end tf.check-colour-contrast \define box-shadow(shadow) `` diff --git a/core/wiki/paletteswitcher.tid b/core/wiki/paletteswitcher.tid index e79c0aabe01..ced304b7ba7 100644 --- a/core/wiki/paletteswitcher.tid +++ b/core/wiki/paletteswitcher.tid @@ -1,19 +1,28 @@ title: $:/snippets/paletteswitcher \whitespace trim -<$linkcatcher to="$:/palette"> -<div class="tc-chooser"> -<$list filter="[all[shadows+tiddlers]tag[$:/tags/Palette]sort[name]]"> -<$set name="cls" filter="[all[current]prefix{$:/palette}]" value="tc-chooser-item tc-chosen" emptyValue="tc-chooser-item"> -<div class=<<cls>>> -<$link to={{!!title}}> -''<$view field="name" format="text"/>'' - - -<$view field="description" format="text"/> -{{||$:/snippets/currpalettepreview}} -</$link> -</div> -</$set> -</$list> -</div> +\procedure actions() +<$transclude $variable="actions-switch-colour-palette" paletteTitle=<<navigateTo>>/> +\end actions + +<$linkcatcher actions=<<actions>>> + <div class="tc-chooser tc-chooser-cards"> + <$list filter="[all[shadows+tiddlers]tag[$:/tags/Palette]sort[name]]"> + <$set name="cls" filter="[all[current]prefix{$:/palette}]" value="tc-chooser-item tc-chosen" emptyValue="tc-chooser-item"> + <div class=<<cls>>> + <$link to={{!!title}} aria-label=`${[[$:/language/ControlPanel/Palette/Caption]get[text]]}$ - ${[all[current]get[name]]}$. ${[all[current]get[description]]}$`> + {{||$:/snippets/currpalettepreview}} + <div class="tc-chooser-item-description"> + ''<$view field="name" format="text"/>'' + <div class="tc-chooser-item-subtitle"> + <$view field="description" format="text"/> + </div> + </div> + </$link> + </div> + </$set> + </$list> + </div> </$linkcatcher> + +{{$:/snippets/palettetests}} diff --git a/core/wiki/palettetests.tid b/core/wiki/palettetests.tid new file mode 100644 index 00000000000..b7bd24d69ff --- /dev/null +++ b/core/wiki/palettetests.tid @@ -0,0 +1,19 @@ +title: $:/snippets/palettetests + +<$let failureCount={{{ [[$:/temp/palette-colours]indexes[]prefix[?]] :filter[[$:/temp/palette-colours]getindex<currentTiddler>!match[ok]] +[count[]] }}}> + +<%if [<failureCount>compare:number:gt[0]] %> + +Palette test failures: <$text text=<<failureCount>>/> + +<$list filter="[[$:/temp/palette-colours]indexes[]prefix[?]sort[]]" variable="name"> + <%if [[$:/temp/palette-colours]getindex<name>!match[ok]] %> + <div> + ''<$text text={{{ [<name>removeprefix[?]] }}}/>'': <$text text={{{ [[$:/temp/palette-colours]getindex<name>] }}}/> + </div> + <%endif%> +</$list> + +<%endif%> + +</$let> diff --git a/core/wiki/startup-actions/set-palette.tid b/core/wiki/startup-actions/set-palette.tid new file mode 100644 index 00000000000..d42012d9e1c --- /dev/null +++ b/core/wiki/startup-actions/set-palette.tid @@ -0,0 +1,5 @@ +title: $:/core/wiki/startup-actions/set-palette +tags: $:/tags/StartupAction + +\import [subfilter{$:/core/config/GlobalImportFilter}] +<$transclude $variable="actions-switch-colour-palette" paletteTitle={{$:/palette}}/> diff --git a/core/wiki/tags/PreviewPage.tid b/core/wiki/tags/PreviewPage.tid new file mode 100644 index 00000000000..51b2e68f467 --- /dev/null +++ b/core/wiki/tags/PreviewPage.tid @@ -0,0 +1,2 @@ +title: $:/tags/Preview/Page +list: $:/core/ui/Palettes/Preview/Alert $:/core/ui/Palettes/Preview/Notification $:/core/ui/Palettes/Preview/Story $:/core/ui/Palettes/Preview/Sidebar diff --git a/core/wiki/tags/PreviewSideBar.tid b/core/wiki/tags/PreviewSideBar.tid new file mode 100644 index 00000000000..36ada0ed9ec --- /dev/null +++ b/core/wiki/tags/PreviewSideBar.tid @@ -0,0 +1,2 @@ +title: $:/tags/Preview/SideBar +list: $:/core/ui/Palettes/Preview/Sidebar/Title $:/core/ui/Palettes/Preview/Sidebar/Subtitle $:/core/ui/Palettes/Preview/Sidebar/Search diff --git a/core/wiki/tags/PreviewTiddler.tid b/core/wiki/tags/PreviewTiddler.tid new file mode 100644 index 00000000000..3e0cd95f664 --- /dev/null +++ b/core/wiki/tags/PreviewTiddler.tid @@ -0,0 +1,2 @@ +title: $:/tags/Preview/Tiddler +list: $:/core/ui/Palettes/Preview/Tiddler/Header $:/core/ui/Palettes/Preview/Tiddler/Subtitle $:/core/ui/Palettes/Preview/Tiddler/Body \ No newline at end of file diff --git a/editions/prerelease/tiddlers/palette.tid b/editions/prerelease/tiddlers/palette.tid index afd78912b7a..9cd6f441c64 100644 --- a/editions/prerelease/tiddlers/palette.tid +++ b/editions/prerelease/tiddlers/palette.tid @@ -1,3 +1,3 @@ title: $:/palette -$:/palettes/Vanilla \ No newline at end of file +$:/palettes/TwentyTwenties \ No newline at end of file diff --git a/editions/test/tiddlers/tests/data/macros/contrastcolour/ContrastColourBasic.tid b/editions/test/tiddlers/tests/data/macros/contrastcolour/ContrastColourBasic.tid new file mode 100644 index 00000000000..13940f3ed59 --- /dev/null +++ b/editions/test/tiddlers/tests/data/macros/contrastcolour/ContrastColourBasic.tid @@ -0,0 +1,12 @@ +title: Macros/ContrastColour/ContrastColourBasic +description: Basic usage of contrastcolour macro +type: text/vnd.tiddlywiki-multiple +tags: [[$:/tags/wiki-test-spec]] + +title: Output + +Colour: <<contrastcolour target:#1e90ff fallbackTarget:#eecc66 colourA:#333333 colourB:#ffffff>> ++ +title: ExpectedResult + +<p>Colour: #ffffff</p> \ No newline at end of file diff --git a/editions/test/tiddlers/tests/data/operators/colour/ColourContrast.tid b/editions/test/tiddlers/tests/data/operators/colour/ColourContrast.tid new file mode 100644 index 00000000000..5aa5281b382 --- /dev/null +++ b/editions/test/tiddlers/tests/data/operators/colour/ColourContrast.tid @@ -0,0 +1,17 @@ +title: Operators/Colour/ColourContrast +description: Contrast colour function +type: text/vnd.tiddlywiki-multiple +tags: [[$:/tags/wiki-test-spec]] + +title: Output + +\parsermode inline +<$text text={{{ [subfilter{Filter}] }}}/> ++ +title: Filter + +[[black]] [[gray]] +[colour-contrast:DeltaPhi[]trunc[]] ++ +title: ExpectedResult + +35 \ No newline at end of file diff --git a/editions/test/tiddlers/tests/data/operators/colour/ColourDarken.tid b/editions/test/tiddlers/tests/data/operators/colour/ColourDarken.tid new file mode 100644 index 00000000000..7964984805d --- /dev/null +++ b/editions/test/tiddlers/tests/data/operators/colour/ColourDarken.tid @@ -0,0 +1,17 @@ +title: Operators/Colour/ColourDarken +description: Darken colour function +type: text/vnd.tiddlywiki-multiple +tags: [[$:/tags/wiki-test-spec]] + +title: Output + +\parsermode inline +<$text text={{{ [subfilter{Filter}] }}}/> ++ +title: Filter + +[[#5778d8]colour-darken[0.5]] ++ +title: ExpectedResult + +#0f1d77 \ No newline at end of file diff --git a/editions/test/tiddlers/tests/data/operators/colour/ColourGetOklch.tid b/editions/test/tiddlers/tests/data/operators/colour/ColourGetOklch.tid new file mode 100644 index 00000000000..a1ba2ea51a3 --- /dev/null +++ b/editions/test/tiddlers/tests/data/operators/colour/ColourGetOklch.tid @@ -0,0 +1,21 @@ +title: Operators/Colour/ColourOklchL +description: colour-set-oklch function +type: text/vnd.tiddlywiki-multiple +tags: [[$:/tags/wiki-test-spec]] + +title: Output + +\parsermode inline +<$text text={{{ [subfilter{Filter}] }}}/> ++ +title: Filter + +=[[#5778d8]colour-get-oklch[]] +=[[#5778d8]colour-get-oklch:l[]] +=[[#5778d8]colour-get-oklch:c[]] +=[[#5778d8]colour-get-oklch:h[]] ++[fixed[3]join[,]] ++ +title: ExpectedResult + +0.595,0.595,0.151,267.432 \ No newline at end of file diff --git a/editions/test/tiddlers/tests/data/operators/colour/ColourInterpolate.tid b/editions/test/tiddlers/tests/data/operators/colour/ColourInterpolate.tid new file mode 100644 index 00000000000..eeea1801598 --- /dev/null +++ b/editions/test/tiddlers/tests/data/operators/colour/ColourInterpolate.tid @@ -0,0 +1,19 @@ +title: Operators/Colour/ColourInterpolate +description: colour-interpolate function +type: text/vnd.tiddlywiki-multiple +tags: [[$:/tags/wiki-test-spec]] + +title: Output + +\parsermode inline +<$text text={{{ [subfilter{Filter}] }}}/> ++ +title: Filter + +=[[#5778d8]] +=[[#d85757]] ++[colour-interpolate:oklch[0.2],[0.5],[0.99]join[,]] ++ +title: ExpectedResult + +oklch(60.08% 0.15344 290.55),oklch(60.956% 0.15699 325.23),oklch(62.386% 0.1628 381.88) \ No newline at end of file diff --git a/editions/test/tiddlers/tests/data/operators/colour/ColourLighten.tid b/editions/test/tiddlers/tests/data/operators/colour/ColourLighten.tid new file mode 100644 index 00000000000..f359a041ae9 --- /dev/null +++ b/editions/test/tiddlers/tests/data/operators/colour/ColourLighten.tid @@ -0,0 +1,17 @@ +title: Operators/Colour/ColourLighten +description: Lighten colour function +type: text/vnd.tiddlywiki-multiple +tags: [[$:/tags/wiki-test-spec]] + +title: Output + +\parsermode inline +<$text text={{{ [subfilter{Filter}] }}}/> ++ +title: Filter + +[[#5778d8]colour-lighten[0.5]] ++ +title: ExpectedResult + +#c6dbff \ No newline at end of file diff --git a/editions/test/tiddlers/tests/data/operators/colour/ColourSetOklch.tid b/editions/test/tiddlers/tests/data/operators/colour/ColourSetOklch.tid new file mode 100644 index 00000000000..7d2231b37be --- /dev/null +++ b/editions/test/tiddlers/tests/data/operators/colour/ColourSetOklch.tid @@ -0,0 +1,17 @@ +title: Operators/Colour/ColourSetOklch +description: colour-set-oklch function +type: text/vnd.tiddlywiki-multiple +tags: [[$:/tags/wiki-test-spec]] + +title: Output + +\parsermode inline +<$text text={{{ [subfilter{Filter}] }}}/> ++ +title: Filter + +=[[#5778d8]colour-set-oklch[0.5]] =[[#5778d8]colour-set-oklch:l[0.5]] +[join[,]] ++ +title: ExpectedResult + +#3d5bb8,#3d5bb8 \ No newline at end of file diff --git a/editions/tw5.com/tiddlers/concepts/Colour Spaces.tid b/editions/tw5.com/tiddlers/concepts/Colour Spaces.tid new file mode 100644 index 00000000000..8894bfd9c06 --- /dev/null +++ b/editions/tw5.com/tiddlers/concepts/Colour Spaces.tid @@ -0,0 +1,44 @@ +title: Colour Spaces + +The list of currently supported colour spaces is given below. See the [[color.js website|https://colorjs.io/docs/spaces]] for details. + +* ''a98rgb-linear'' +* ''a98rgb'' +* ''acescc'' +* ''acescg'' +* ''cam16-jmh'' +* ''hct'' +* ''hpluv'' +* ''hsl'' +* ''hsluv'' +* ''hsv'' +* ''hwb'' +* ''ictcp'' +* ''jzazbz'' +* ''jzczhz'' +* ''lab-d65'' +* ''lab'' +* ''lch'' +* ''lchuv'' +* ''luv'' +* ''okhsl'' +* ''okhsv'' +* ''oklab'' +* ''oklch'' +* ''oklrab'' +* ''oklrch'' +* ''p3-linear'' +* ''p3'' +* ''prophoto-linear'' +* ''prophoto'' +* ''rec2020-linear'' +* ''rec2020'' +* ''rec2100-linear'' +* ''rec2100hlg'' +* ''rec2100pq'' +* ''srgb-linear'' +* ''srgb'' +* ''xyz-abs-d65'' +* ''xyz-d50'' +* ''xyz-d65'' +* ''xyz'' diff --git a/editions/tw5.com/tiddlers/filters/colour-get-oklch.tid b/editions/tw5.com/tiddlers/filters/colour-get-oklch.tid new file mode 100644 index 00000000000..9fb397cebb4 --- /dev/null +++ b/editions/tw5.com/tiddlers/filters/colour-get-oklch.tid @@ -0,0 +1,33 @@ +created: 20241117161528913 +modified: 20241117161528913 +tags: [[Filter Operators]] [[Colour Operators]] +title: colour-get-oklch Operator +caption: colour-get-oklch +op-purpose: retrieve components of colour values in the OKLCH colour space +op-input: a selection of colour values +op-suffix: "l", "c" or "h" to indicate which component of the colour to retrieve +op-output: the values of the specified component of the input colours + +<<.from-version "5.3.7">> See [[Colour Palettes]] for background. + +The <<.op colour-get-oklch>> operator is used to retrieve components of colour values in the [[OKLCH|https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/oklch]] colour space. The OKLCH colour space expresses colours as three numbers: + +|!Id |!Name |!Range | +|l |Lightness |0 – 1 | +|c |Chroma |0 – 0.4 | +|h |Hue |0 – 360 | + +The advantage of the OKLCH space is that it is perceptually uniform, meaning that equal changes in the numbers correspond to equal changes in the perceived colour. + +For example, this filter expression will get the lightness of the colour current page background colour: + +``` +[function[colour],[page-background]colour-get-oklch:l[]] +``` + +See also the following related operators: + +* <<.olink colour-set-oklch>> to modify a component of a colour value in the OKLCH colour space +* <<.olink colour-lighten>> to lighten a colour value +* <<.olink colour-darken>> to lighten a colour value + diff --git a/editions/tw5.com/tiddlers/filters/colour-interpolate.tid b/editions/tw5.com/tiddlers/filters/colour-interpolate.tid new file mode 100644 index 00000000000..083710c2ec4 --- /dev/null +++ b/editions/tw5.com/tiddlers/filters/colour-interpolate.tid @@ -0,0 +1,33 @@ +created: 20241117161528913 +modified: 20241117161528913 +tags: [[Filter Operators]] [[Colour Operators]] +title: colour-interpolate Operator +caption: colour-interpolate +op-purpose: smoothly interpolate between a set of colours +op-input: a selection of colour values +op-suffix: the name of the colour space to be used for the interpolation such as "OkLCh" or "sRGB" +op-parameter: one or more indexes where 0 is the first colour and 1 is the last colour and intermediate values are smoothly interpolated +op-output: the values of the interpolated colours + +<<.from-version "5.3.7">> See [[Colour Palettes]] for background. + +The <<.op colour-interpolate>> operator is used to interpolate colour values in a chosen colour space. + +The full list of colour spaces that can be used for interpolation is given in [[Colour Spaces]]. + +Note that at least two input colours must be provided for interpolation to occur. + +Note that indexes outside the range 0 to 1 will extrapolate from the provided colour values. + +For example, this filter expression will return 4 colours that smoothly blend from red to green in the OKLCH colour space: + +``` +red green +[colour-interpolate:oklch[0],[0.333],[0.666],[1]] +``` + +See also the following related operators: + +* <<.olink colour-get-oklch>> to retrieve a component of a colour value in the OKLCH colour space +* <<.olink colour-lighten>> to lighten a colour value +* <<.olink colour-darken>> to lighten a colour value + diff --git a/editions/tw5.com/tiddlers/filters/colour-set-oklch.tid b/editions/tw5.com/tiddlers/filters/colour-set-oklch.tid new file mode 100644 index 00000000000..12ac126a883 --- /dev/null +++ b/editions/tw5.com/tiddlers/filters/colour-set-oklch.tid @@ -0,0 +1,34 @@ +created: 20241117161528913 +modified: 20241117161528913 +tags: [[Filter Operators]] [[Colour Operators]] +title: colour-set-oklch Operator +caption: colour-set-oklch +op-purpose: manipulate colour values in the OKLCH colour space +op-input: a selection of colour values +op-suffix: "l", "c" or "h" to indicate which component of the colour to modify +op-parameter: value of the property to modify +op-output: the values of the modified colours + +<<.from-version "5.3.7">> See [[Colour Palettes]] for background. + +The <<.op colour-set-oklch>> operator is used to manipulate colour values in the [[OKLCH|https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/oklch]] colour space. The OKLCH colour space expresses colours as three numbers: + +|!Id |!Name |!Range | +|l |Lightness |0 – 1 | +|c |Chroma |0 – 0.4 | +|h |Hue |0 – 360 | + +The advantage of the OKLCH space is that it is perceptually uniform, meaning that equal changes in the numbers correspond to equal changes in the perceived colour. + +For example, this filter expression will alter the lightness of the colour current page background colour to 0.1: + +``` +[function[colour],[page-background]colour-set-oklch:l[0.1]] +``` + +See also the following related operators: + +* <<.olink colour-get-oklch>> to retrieve a component of a colour value in the OKLCH colour space +* <<.olink colour-lighten>> to lighten a colour value +* <<.olink colour-darken>> to lighten a colour value + diff --git a/plugins/tiddlywiki/jasmine/run-wiki-based-tests.js b/plugins/tiddlywiki/jasmine/run-wiki-based-tests.js index 90d4768e4c6..2e854cf4632 100644 --- a/plugins/tiddlywiki/jasmine/run-wiki-based-tests.js +++ b/plugins/tiddlywiki/jasmine/run-wiki-based-tests.js @@ -30,6 +30,13 @@ describe("Wiki-based tests", function() { wiki.addTiddler(coreTiddler); } wiki.addTiddlers(readMultipleTiddlersTiddler(title)); + // Unpack plugin tiddlers + wiki.readPluginInfo(); + wiki.registerPluginTiddlers("plugin"); + wiki.unpackPluginTiddlers(); + wiki.addIndexersToWiki(); + // Clear changes queue + wiki.clearTiddlerEventQueue(); // Complain if we don't have the ouput and expected results if(!wiki.tiddlerExists("Output")) { throw "Missing 'Output' tiddler"; diff --git a/themes/tiddlywiki/vanilla/base.tid b/themes/tiddlywiki/vanilla/base.tid index c795ad362e7..1a7ddd40234 100644 --- a/themes/tiddlywiki/vanilla/base.tid +++ b/themes/tiddlywiki/vanilla/base.tid @@ -2822,8 +2822,17 @@ a.tc-tiddlylink.tc-plugin-info:hover > .tc-plugin-info-chunk .tc-plugin-info-sta .tc-chooser { border-right: 1px solid <<colour table-header-background>>; border-left: 1px solid <<colour table-header-background>>; + white-space: pre-wrap; +} + +.tc-chooser .tc-chooser-item.tc-chosen { + outline: 2px solid <<colour primary>>; } +.tc-chooser.tc-chooser-cards { + display: flex; + flex-wrap: wrap; +} .tc-chooser-item { border-bottom: 1px solid <<colour table-header-background>>; @@ -2831,6 +2840,14 @@ a.tc-tiddlylink.tc-plugin-info:hover > .tc-plugin-info-chunk .tc-plugin-info-sta padding: 2px 4px 2px 14px; } +.tc-chooser.tc-chooser-cards .tc-chooser-item { + width: 220px; + margin: 0.5em; + padding: 6px; + border: 1px solid <<colour muted-foreground>>; + border-radius: 3px; +} + .tc-drop-down .tc-chooser-item { padding: 2px; } @@ -2845,10 +2862,23 @@ a.tc-tiddlylink.tc-plugin-info:hover > .tc-plugin-info-chunk .tc-plugin-info-sta cursor:default; } +.tc-chosen > .tc-tiddlylink:before { + margin-left: -10px; + position: relative; + content: "» "; +} + +.tc-chooser.tc-chooser-cards .tc-chosen > .tc-tiddlylink:before { + margin: 0; + content: ""; +} + .tc-chooser-item .tc-tiddlylink { display: block; text-decoration: none; background-color: transparent; + font-weight: normal; + color: <<colour foreground>>; } .tc-chooser-item:hover .tc-tiddlylink:hover { @@ -2860,12 +2890,6 @@ a.tc-tiddlylink.tc-plugin-info:hover > .tc-plugin-info-chunk .tc-plugin-info-sta color: <<colour foreground>>; } -.tc-chosen > .tc-tiddlylink:before { - margin-left: -10px; - position: relative; - content: "» "; -} - .tc-chooser-item svg, .tc-chooser-item img{ max-width: 1em; @@ -2873,6 +2897,15 @@ a.tc-tiddlylink.tc-plugin-info:hover > .tc-plugin-info-chunk .tc-plugin-info-sta vertical-align: middle; } +.tc-chooser-item .tc-chooser-item-description { + padding: 3px; +} + +.tc-chooser-item .tc-chooser-item-subtitle { + font-size: 0.8em; + line-height: 1.2; +} + .tc-language-chooser .tc-image-button img { max-width: 2em; max-height: 1em; @@ -2904,6 +2937,107 @@ input.tc-palette-manager-colour-input { padding: 0; } +.tc-palette-preview-thumbnail { + display: inline-block; + position: relative; + padding: 0.5em 0.5em 0 0.5em; + display: flex; + flex-direction: row; + font-weight: normal; + color: <<colour foreground>>; + line-height: 1.2; +} + +.tc-palette-preview-thumbnail-alert { + position: absolute; + top: 3px; + left: 3px; + width: 35em; + font-size: 2px; + border-radius: 2px; +} + +.tc-palette-preview-thumbnail-alert-border { + border-width: 1px; + border-style: solid; + padding: 3px; + border-radius: 2px; +} + +.tc-palette-preview-thumbnail-notification { + position: absolute; + right: 3px; + top: 3px; + width: 25em; + font-size: 2px; + border-radius: 2px; +} + +.tc-palette-preview-thumbnail-notification-border { + border-width: 1px; + border-style: solid; + padding: 3px; + border-radius: 2px; +} + +.tc-palette-preview-thumbnail-story { + flex-grow: 2; +} + +.tc-palette-preview-thumbnail-tiddler { + margin-bottom: 0.5em; + padding: 0.5em; +} + +.tc-palette-preview-thumbnail-tiddler-header { + display: flex; + justify-content: space-between; +} + +.tc-palette-preview-thumbnail-tiddler-title { + font-size: 6px; +} + +.tc-palette-preview-thumbnail-tiddler-toolbar { + line-height: 0; +} + +.tc-palette-preview-thumbnail-tiddler-toolbar svg { + width: 6px; + height: 6px; +} + +.tc-palette-preview-thumbnail-tiddler-subtitle { + font-size: 3px; +} + +.tc-palette-preview-thumbnail-tiddler-body { + font-size: 3px; +} + +.tc-palette-preview-thumbnail-sidebar { + flex-grow: 1; + padding: 0.5em; +} + +.tc-palette-preview-thumbnail-sidebar-title { + font-size: 6px; +} + +.tc-palette-preview-thumbnail-sidebar-subtitle { + font-size: 3px; +} + +.tc-palette-preview-thumbnail-sidebar-search { + margin:3px 0; + line-height: 0; + width: 70%; +} + +.tc-palette-preview-thumbnail-sidebar-search-box { + height: 4px; +} + /* ** Table of contents */