@lightningjs/renderer 0.3.1 → 0.3.2

package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts

@@ -0,0 +1,705 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
+
+import { getRgbaString, type RGBA } from '../../lib/utils.js';
+
+const MAX_TEXTURE_DIMENSION = 2048;
+
+/**
+ * Text Overflow Values
+ */
+export type TextOverflow =
+  | 'ellipsis'
+  | 'clip'
+  | (string & Record<never, never>);
+
+/***
+ * Text Horizontal Align Values
+ */
+export type TextAlign = 'left' | 'center' | 'right';
+
+/***
+ * Text Baseline Values
+ */
+export type TextBaseline =
+  | 'alphabetic'
+  | 'top'
+  | 'hanging'
+  | 'middle'
+  | 'ideographic'
+  | 'bottom';
+
+/***
+ * Text Vertical Align Values
+ */
+export type TextVerticalAlign = 'top' | 'middle' | 'bottom';
+
+/**
+ * Text Texture Settings
+ */
+export interface Settings {
+  w: number;
+  h: number;
+  text: string;
+  fontStyle: string;
+  fontSize: number;
+  fontBaselineRatio: number;
+  fontFace: string | null;
+  wordWrap: boolean;
+  wordWrapWidth: number;
+  wordBreak: boolean;
+  textOverflow: TextOverflow | null;
+  lineHeight: number | null;
+  textBaseline: TextBaseline;
+  textAlign: TextAlign;
+  verticalAlign: TextVerticalAlign;
+  offsetY: number | null;
+  maxLines: number;
+  maxLinesSuffix: string;
+  precision: number;
+  textColor: RGBA;
+  paddingLeft: number;
+  paddingRight: number;
+  shadow: boolean;
+  shadowColor: RGBA;
+  shadowOffsetX: number;
+  shadowOffsetY: number;
+  shadowBlur: number;
+  highlight: boolean;
+  highlightHeight: number;
+  highlightColor: RGBA;
+  highlightOffset: number;
+  highlightPaddingLeft: number;
+  highlightPaddingRight: number;
+  letterSpacing: number;
+  textIndent: number;
+  cutSx: number;
+  cutSy: number;
+  cutEx: number;
+  cutEy: number;
+  advancedRenderer: boolean;
+
+  // Normally stage options
+  textRenderIssueMargin: number;
+}
+
+export interface RenderInfo {
+  w: number;
+  h: number;
+  lines: string[];
+  precision: number;
+  remainingText: string;
+  moreTextLines: boolean;
+  width: number;
+  innerWidth: number;
+  height: number;
+  fontSize: number;
+  cutSx: number;
+  cutSy: number;
+  cutEx: number;
+  cutEy: number;
+  lineHeight: number;
+  lineWidths: number[];
+  offsetY: number;
+  paddingLeft: number;
+  paddingRight: number;
+  letterSpacing: number;
+  textIndent: number;
+}
+
+export class LightningTextTextureRenderer {
+  private _canvas: OffscreenCanvas;
+  private _context: OffscreenCanvasRenderingContext2D;
+  private _settings: Settings;
+  private renderInfo: RenderInfo | undefined;
+
+  constructor(
+    canvas: OffscreenCanvas,
+    context: OffscreenCanvasRenderingContext2D,
+  ) {
+    this._canvas = canvas;
+    this._context = context;
+    this._settings = this.mergeDefaults({});
+  }
+
+  set settings(v: Partial<Settings>) {
+    this._settings = this.mergeDefaults(v);
+  }
+
+  get settings(): Settings {
+    return this._settings;
+  }
+
+  getPrecision() {
+    return this._settings.precision;
+  }
+
+  setFontProperties() {
+    this._context.font = this._getFontSetting();
+    this._context.textBaseline = this._settings.textBaseline;
+  }
+
+  _getFontSetting() {
+    const ff = [this._settings.fontFace];
+
+    const ffs = [];
+    for (let i = 0, n = ff.length; i < n; i++) {
+      if (ff[i] === 'serif' || ff[i] === 'sans-serif') {
+        ffs.push(ff[i]);
+      } else {
+        ffs.push(`"${ff[i]!}"`);
+      }
+    }
+
+    return `${this._settings.fontStyle} ${
+      this._settings.fontSize * this.getPrecision()
+    }px ${ffs.join(',')}`;
+  }
+
+  _load() {
+    if (true && document.fonts) {
+      const fontSetting = this._getFontSetting();
+      try {
+        if (!document.fonts.check(fontSetting, this._settings.text)) {
+          // Use a promise that waits for loading.
+          return document.fonts
+            .load(fontSetting, this._settings.text)
+            .catch((err) => {
+              // Just load the fallback font.
+              console.warn('[Lightning] Font load error', err, fontSetting);
+            })
+            .then(() => {
+              if (!document.fonts.check(fontSetting, this._settings.text)) {
+                console.warn('[Lightning] Font not found', fontSetting);
+              }
+            });
+        }
+      } catch (e) {
+        console.warn("[Lightning] Can't check font loading for " + fontSetting);
+      }
+    }
+  }
+
+  calculateRenderInfo(): RenderInfo {
+    const renderInfo: Partial<RenderInfo> = {};
+
+    const precision = this.getPrecision();
+
+    const paddingLeft = this._settings.paddingLeft * precision;
+    const paddingRight = this._settings.paddingRight * precision;
+    const fontSize = this._settings.fontSize * precision;
+    let offsetY =
+      this._settings.offsetY === null
+        ? null
+        : this._settings.offsetY * precision;
+    let lineHeight = (this._settings.lineHeight || fontSize) * precision;
+    const w = this._settings.w * precision;
+    const h = this._settings.h * precision;
+    let wordWrapWidth = this._settings.wordWrapWidth * precision;
+    const cutSx = this._settings.cutSx * precision;
+    const cutEx = this._settings.cutEx * precision;
+    const cutSy = this._settings.cutSy * precision;
+    const cutEy = this._settings.cutEy * precision;
+    const letterSpacing = (this._settings.letterSpacing || 0) * precision;
+    const textIndent = this._settings.textIndent * precision;
+
+    // Set font properties.
+    this.setFontProperties();
+
+    // Total width.
+    let width = w || 2048 / this.getPrecision();
+
+    // Inner width.
+    let innerWidth = width - paddingLeft;
+    if (innerWidth < 10) {
+      width += 10 - innerWidth;
+      innerWidth = 10;
+    }
+
+    if (!wordWrapWidth) {
+      wordWrapWidth = innerWidth;
+    }
+
+    // Text overflow
+    if (this._settings.textOverflow && !this._settings.wordWrap) {
+      let suffix;
+      switch (this._settings.textOverflow) {
+        case 'clip':
+          suffix = '';
+          break;
+        case 'ellipsis':
+          suffix = this._settings.maxLinesSuffix;
+          break;
+        default:
+          suffix = this._settings.textOverflow;
+      }
+      this._settings.text = this.wrapWord(
+        this._settings.text,
+        wordWrapWidth - textIndent,
+        suffix,
+      );
+    }
+
+    // word wrap
+    // preserve original text
+    let linesInfo: { n: number[]; l: string[] };
+    if (this._settings.wordWrap) {
+      linesInfo = this.wrapText(
+        this._settings.text,
+        wordWrapWidth,
+        letterSpacing,
+        textIndent,
+      );
+    } else {
+      linesInfo = { l: this._settings.text.split(/(?:\r\n|\r|\n)/), n: [] };
+      const n = linesInfo.l.length;
+      for (let i = 0; i < n - 1; i++) {
+        linesInfo.n.push(i);
+      }
+    }
+    let lines = linesInfo.l;
+
+    if (this._settings.maxLines && lines.length > this._settings.maxLines) {
+      const usedLines = lines.slice(0, this._settings.maxLines);
+
+      let otherLines = null;
+      if (this._settings.maxLinesSuffix) {
+        // Wrap again with max lines suffix enabled.
+        const w = this._settings.maxLinesSuffix
+          ? this.measureText(this._settings.maxLinesSuffix)
+          : 0;
+        const al = this.wrapText(
+          usedLines[usedLines.length - 1]!,
+          wordWrapWidth - w,
+          letterSpacing,
+          textIndent,
+        );
+        usedLines[usedLines.length - 1] = `${al.l[0]!}${
+          this._settings.maxLinesSuffix
+        }`;
+        otherLines = [al.l.length > 1 ? al.l[1] : ''];
+      } else {
+        otherLines = [''];
+      }
+
+      // Re-assemble the remaining text.
+      let i;
+      const n = lines.length;
+      let j = 0;
+      const m = linesInfo.n.length;
+      for (i = this._settings.maxLines; i < n; i++) {
+        otherLines[j] += `${otherLines[j] ? ' ' : ''}${lines[i]!}`;
+        if (i + 1 < m && linesInfo.n[i + 1]) {
+          j++;
+        }
+      }
+
+      renderInfo.remainingText = otherLines.join('\n');
+
+      renderInfo.moreTextLines = true;
+
+      lines = usedLines;
+    } else {
+      renderInfo.moreTextLines = false;
+      renderInfo.remainingText = '';
+    }
+
+    // calculate text width
+    let maxLineWidth = 0;
+    const lineWidths: number[] = [];
+    for (let i = 0; i < lines.length; i++) {
+      const lineWidth =
+        this.measureText(lines[i]!, letterSpacing) + (i === 0 ? textIndent : 0);
+      lineWidths.push(lineWidth);
+      maxLineWidth = Math.max(maxLineWidth, lineWidth);
+    }
+
+    renderInfo.lineWidths = lineWidths;
+
+    if (!w) {
+      // Auto-set width to max text length.
+      width = maxLineWidth + paddingLeft + paddingRight;
+      innerWidth = maxLineWidth;
+    }
+
+    // calculate text height
+    lineHeight = lineHeight || fontSize;
+
+    let height;
+    if (h) {
+      height = h;
+    } else {
+      const baselineOffset =
+        this._settings.textBaseline != 'bottom' ? 0.5 * fontSize : 0;
+      height =
+        lineHeight * (lines.length - 1) +
+        baselineOffset +
+        Math.max(lineHeight, fontSize) +
+        (offsetY || 0);
+    }
+
+    if (offsetY === null) {
+      offsetY = fontSize;
+    }
+
+    renderInfo.w = width;
+    renderInfo.h = height;
+    renderInfo.lines = lines;
+    renderInfo.precision = precision;
+
+    if (!width) {
+      // To prevent canvas errors.
+      width = 1;
+    }
+
+    if (!height) {
+      // To prevent canvas errors.
+      height = 1;
+    }
+
+    if (cutSx || cutEx) {
+      width = Math.min(width, cutEx - cutSx);
+    }
+
+    if (cutSy || cutEy) {
+      height = Math.min(height, cutEy - cutSy);
+    }
+
+    renderInfo.width = width;
+    renderInfo.innerWidth = innerWidth;
+    renderInfo.height = height;
+    renderInfo.fontSize = fontSize;
+    renderInfo.cutSx = cutSx;
+    renderInfo.cutSy = cutSy;
+    renderInfo.cutEx = cutEx;
+    renderInfo.cutEy = cutEy;
+    renderInfo.lineHeight = lineHeight;
+    renderInfo.lineWidths = lineWidths;
+    renderInfo.offsetY = offsetY;
+    renderInfo.paddingLeft = paddingLeft;
+    renderInfo.paddingRight = paddingRight;
+    renderInfo.letterSpacing = letterSpacing;
+    renderInfo.textIndent = textIndent;
+
+    return renderInfo as RenderInfo;
+  }
+
+  draw(
+    renderInfo: RenderInfo,
+    linesOverride?: { lines: string[]; lineWidths: number[] },
+  ) {
+    const precision = this.getPrecision();
+
+    // Allow lines to be overriden for partial rendering.
+    const lines = linesOverride?.lines || renderInfo.lines;
+    const lineWidths = linesOverride?.lineWidths || renderInfo.lineWidths;
+    const height = linesOverride
+      ? linesOverride.lines.length * renderInfo.lineHeight
+      : renderInfo.height;
+
+    // Add extra margin to prevent issue with clipped text when scaling.
+    this._canvas.width = Math.min(
+      Math.ceil(renderInfo.width + this._settings.textRenderIssueMargin),
+      MAX_TEXTURE_DIMENSION,
+    );
+    this._canvas.height = Math.min(Math.ceil(height), MAX_TEXTURE_DIMENSION);
+
+    // Canvas context has been reset.
+    this.setFontProperties();
+
+    if (renderInfo.fontSize >= 128) {
+      // WpeWebKit bug: must force compositing because cairo-traps-compositor will not work with text first.
+      this._context.globalAlpha = 0.01;
+      this._context.fillRect(0, 0, 0.01, 0.01);
+      this._context.globalAlpha = 1.0;
+    }
+
+    if (renderInfo.cutSx || renderInfo.cutSy) {
+      this._context.translate(-renderInfo.cutSx, -renderInfo.cutSy);
+    }
+
+    let linePositionX;
+    let linePositionY;
+
+    const drawLines = [];
+
+    // Draw lines line by line.
+    for (let i = 0, n = lines.length; i < n; i++) {
+      linePositionX = i === 0 ? renderInfo.textIndent : 0;
+
+      // By default, text is aligned to top
+      linePositionY = i * renderInfo.lineHeight + renderInfo.offsetY;
+
+      if (this._settings.verticalAlign == 'middle') {
+        linePositionY += (renderInfo.lineHeight - renderInfo.fontSize) / 2;
+      } else if (this._settings.verticalAlign == 'bottom') {
+        linePositionY += renderInfo.lineHeight - renderInfo.fontSize;
+      }
+
+      if (this._settings.textAlign === 'right') {
+        linePositionX += renderInfo.innerWidth - lineWidths[i]!;
+      } else if (this._settings.textAlign === 'center') {
+        linePositionX += (renderInfo.innerWidth - lineWidths[i]!) / 2;
+      }
+      linePositionX += renderInfo.paddingLeft;
+
+      drawLines.push({
+        text: lines[i]!,
+        x: linePositionX,
+        y: linePositionY,
+        w: lineWidths[i]!,
+      });
+    }
+
+    // Highlight.
+    if (this._settings.highlight) {
+      const color = this._settings.highlightColor;
+
+      const hlHeight =
+        this._settings.highlightHeight * precision || renderInfo.fontSize * 1.5;
+      const offset = this._settings.highlightOffset * precision;
+      const hlPaddingLeft =
+        this._settings.highlightPaddingLeft !== null
+          ? this._settings.highlightPaddingLeft * precision
+          : renderInfo.paddingLeft;
+      const hlPaddingRight =
+        this._settings.highlightPaddingRight !== null
+          ? this._settings.highlightPaddingRight * precision
+          : renderInfo.paddingRight;
+
+      this._context.fillStyle = getRgbaString(color);
+      for (let i = 0; i < drawLines.length; i++) {
+        const drawLine = drawLines[i]!;
+        this._context.fillRect(
+          drawLine.x - hlPaddingLeft,
+          drawLine.y - renderInfo.offsetY + offset,
+          drawLine.w + hlPaddingRight + hlPaddingLeft,
+          hlHeight,
+        );
+      }
+    }
+
+    // Text shadow.
+    let prevShadowSettings: null | [string, number, number, number] = null;
+    if (this._settings.shadow) {
+      prevShadowSettings = [
+        this._context.shadowColor,
+        this._context.shadowOffsetX,
+        this._context.shadowOffsetY,
+        this._context.shadowBlur,
+      ];
+
+      this._context.shadowColor = getRgbaString(this._settings.shadowColor);
+      this._context.shadowOffsetX = this._settings.shadowOffsetX * precision;
+      this._context.shadowOffsetY = this._settings.shadowOffsetY * precision;
+      this._context.shadowBlur = this._settings.shadowBlur * precision;
+    }
+
+    this._context.fillStyle = getRgbaString(this._settings.textColor);
+    for (let i = 0, n = drawLines.length; i < n; i++) {
+      const drawLine = drawLines[i]!;
+
+      if (renderInfo.letterSpacing === 0) {
+        this._context.fillText(drawLine.text, drawLine.x, drawLine.y);
+      } else {
+        const textSplit = drawLine.text.split('');
+        let x = drawLine.x;
+        for (let i = 0, j = textSplit.length; i < j; i++) {
+          this._context.fillText(textSplit[i]!, x, drawLine.y);
+          x += this.measureText(textSplit[i]!, renderInfo.letterSpacing);
+        }
+      }
+    }
+
+    if (prevShadowSettings) {
+      this._context.shadowColor = prevShadowSettings[0];
+      this._context.shadowOffsetX = prevShadowSettings[1];
+      this._context.shadowOffsetY = prevShadowSettings[2];
+      this._context.shadowBlur = prevShadowSettings[3];
+    }
+
+    if (renderInfo.cutSx || renderInfo.cutSy) {
+      this._context.translate(renderInfo.cutSx, renderInfo.cutSy);
+    }
+
+    this.renderInfo = renderInfo;
+  }
+
+  wrapWord(word: string, wordWrapWidth: number, suffix: string) {
+    const suffixWidth = this._context.measureText(suffix).width;
+    const wordLen = word.length;
+    const wordWidth = this._context.measureText(word).width;
+
+    /* If word fits wrapWidth, do nothing */
+    if (wordWidth <= wordWrapWidth) {
+      return word;
+    }
+
+    /* Make initial guess for text cuttoff */
+    let cutoffIndex = Math.floor((wordWrapWidth * wordLen) / wordWidth);
+    let truncWordWidth =
+      this._context.measureText(word.substring(0, cutoffIndex)).width +
+      suffixWidth;
+
+    /* In case guess was overestimated, shrink it letter by letter. */
+    if (truncWordWidth > wordWrapWidth) {
+      while (cutoffIndex > 0) {
+        truncWordWidth =
+          this._context.measureText(word.substring(0, cutoffIndex)).width +
+          suffixWidth;
+        if (truncWordWidth > wordWrapWidth) {
+          cutoffIndex -= 1;
+        } else {
+          break;
+        }
+      }
+
+      /* In case guess was underestimated, extend it letter by letter. */
+    } else {
+      while (cutoffIndex < wordLen) {
+        truncWordWidth =
+          this._context.measureText(word.substring(0, cutoffIndex)).width +
+          suffixWidth;
+        if (truncWordWidth < wordWrapWidth) {
+          cutoffIndex += 1;
+        } else {
+          // Finally, when bound is crossed, retract last letter.
+          cutoffIndex -= 1;
+          break;
+        }
+      }
+    }
+
+    /* If wrapWidth is too short to even contain suffix alone, return empty string */
+    return (
+      word.substring(0, cutoffIndex) +
+      (wordWrapWidth >= suffixWidth ? suffix : '')
+    );
+  }
+
+  /**
+   * Applies newlines to a string to have it optimally fit into the horizontal
+   * bounds set by the Text object's wordWrapWidth property.
+   */
+  wrapText(
+    text: string,
+    wordWrapWidth: number,
+    letterSpacing: number,
+    indent = 0,
+  ) {
+    // Greedy wrapping algorithm that will wrap words as the line grows longer.
+    // than its horizontal bounds.
+    const lines = text.split(/\r?\n/g);
+    let allLines: string[] = [];
+    const realNewlines = [];
+    for (let i = 0; i < lines.length; i++) {
+      const resultLines = [];
+      let result = '';
+      let spaceLeft = wordWrapWidth - indent;
+      const words = lines[i]!.split(' ');
+      for (let j = 0; j < words.length; j++) {
+        const wordWidth = this.measureText(words[j]!, letterSpacing);
+        const wordWidthWithSpace =
+          wordWidth + this.measureText(' ', letterSpacing);
+        if (j === 0 || wordWidthWithSpace > spaceLeft) {
+          // Skip printing the newline if it's the first word of the line that is.
+          // greater than the word wrap width.
+          if (j > 0) {
+            resultLines.push(result);
+            result = '';
+          }
+          result += words[j];
+          spaceLeft = wordWrapWidth - wordWidth - (j === 0 ? indent : 0);
+        } else {
+          spaceLeft -= wordWidthWithSpace;
+          result += ` ${words[j]!}`;
+        }
+      }
+
+      resultLines.push(result);
+      result = '';
+
+      allLines = allLines.concat(resultLines);
+
+      if (i < lines.length - 1) {
+        realNewlines.push(allLines.length);
+      }
+    }
+
+    return { l: allLines, n: realNewlines };
+  }
+
+  measureText(word: string, space = 0) {
+    if (!space) {
+      return this._context.measureText(word).width;
+    }
+    return word.split('').reduce((acc, char) => {
+      return acc + this._context.measureText(char).width + space;
+    }, 0);
+  }
+
+  mergeDefaults(settings: Partial<Settings>): Settings {
+    return {
+      text: '',
+      w: 0,
+      h: 0,
+      fontStyle: 'normal',
+      fontSize: 40,
+      fontFace: null,
+      wordWrap: true,
+      wordWrapWidth: 0,
+      wordBreak: false,
+      textOverflow: '',
+      lineHeight: null,
+      textBaseline: 'alphabetic',
+      textAlign: 'left',
+      verticalAlign: 'top',
+      offsetY: null,
+      maxLines: 0,
+      maxLinesSuffix: '..',
+      textColor: [1.0, 1.0, 1.0, 1.0],
+      paddingLeft: 0,
+      paddingRight: 0,
+      shadow: false,
+      shadowColor: [0.0, 0.0, 0.0, 1.0],
+      shadowOffsetX: 0,
+      shadowOffsetY: 0,
+      shadowBlur: 5,
+      highlight: false,
+      highlightHeight: 0,
+      highlightColor: [0.0, 0.0, 0.0, 1.0],
+      highlightOffset: 0,
+      highlightPaddingLeft: 0,
+      highlightPaddingRight: 0,
+      letterSpacing: 0,
+      textIndent: 0,
+      cutSx: 0,
+      cutEx: 0,
+      cutSy: 0,
+      cutEy: 0,
+      advancedRenderer: false,
+      fontBaselineRatio: 0,
+      precision: 1,
+      textRenderIssueMargin: 0,
+      ...settings,
+    };
+  }
+}