@lightningtv/renderer 2.16.1 → 3.2.3

package/src/core/renderers/webgl/WebGlShaderProgram.ts

@@ -0,0 +1,356 @@
+import type { WebGlContextWrapper } from '../../lib/WebGlContextWrapper.js';
+import { USE_RTT } from '../../../utils.js';
+import { Default } from '../../shaders/webgl/Default.js';
+import type { CoreShaderProgram } from '../CoreShaderProgram.js';
+import type { WebGlCtxTexture } from './WebGlCtxTexture.js';
+import type { WebGlRenderer, WebGlRenderOp } from './WebGlRenderer.js';
+import type { WebGlShaderType } from './WebGlShaderNode.js';
+import { WebGlShaderNode } from './WebGlShaderNode.js';
+import type { BufferCollection } from './internal/BufferCollection.js';
+import {
+  createProgram,
+  createShader,
+  type UniformSet1Param,
+  type UniformSet2Params,
+  type UniformSet3Params,
+  type UniformSet4Params,
+} from './internal/ShaderUtils.js';
+import { CoreNode } from '../../CoreNode.js';
+
+export class WebGlShaderProgram implements CoreShaderProgram {
+  protected program: WebGLProgram | null;
+  /**
+   * Vertex Array Object
+   *
+   * @remarks
+   * Used by WebGL2 Only
+   */
+  protected vao: WebGLVertexArrayObject | undefined;
+  protected renderer: WebGlRenderer;
+  protected glw: WebGlContextWrapper;
+  protected attributeLocations: string[];
+  protected uniformLocations: Record<string, WebGLUniformLocation> | null;
+  protected lifecycle: Pick<WebGlShaderType, 'update' | 'canBatch'>;
+  protected useSystemAlpha = false;
+  protected useSystemDimensions = false;
+  protected useTimeValue = false;
+  public isDestroyed = false;
+  supportsIndexedTextures = false;
+
+  constructor(
+    renderer: WebGlRenderer,
+    config: WebGlShaderType,
+    resolvedProps: Record<string, any>,
+  ) {
+    this.renderer = renderer;
+    const glw = (this.glw = renderer.glw);
+
+    // Check that extensions are supported
+    const webGl2 = glw.isWebGl2();
+    let requiredExtensions: string[] = [];
+
+    this.supportsIndexedTextures =
+      config.supportsIndexedTextures || this.supportsIndexedTextures;
+    requiredExtensions =
+      (webGl2 && config.webgl2Extensions) ||
+      (!webGl2 && config.webgl1Extensions) ||
+      [];
+
+    const glVersion = webGl2 ? '2.0' : '1.0';
+    requiredExtensions.forEach((extensionName) => {
+      if (!glw.getExtension(extensionName)) {
+        throw new Error(
+          `Shader "${this.constructor.name}" requires extension "${extensionName}" for WebGL ${glVersion} but wasn't found`,
+        );
+      }
+    });
+
+    let vertexSource =
+      config.vertex instanceof Function
+        ? config.vertex(renderer, resolvedProps)
+        : config.vertex;
+
+    if (vertexSource === undefined) {
+      vertexSource = Default.vertex as string;
+    }
+
+    const fragmentSource =
+      config.fragment instanceof Function
+        ? config.fragment(renderer, resolvedProps)
+        : config.fragment;
+
+    const vertexShader = createShader(glw, glw.VERTEX_SHADER, vertexSource);
+    if (!vertexShader) {
+      throw new Error('Vertex shader creation failed');
+    }
+
+    const fragmentShader = createShader(
+      glw,
+      glw.FRAGMENT_SHADER,
+      fragmentSource,
+    );
+
+    if (!fragmentShader) {
+      throw new Error('fragment shader creation failed');
+    }
+
+    const program = createProgram(glw, vertexShader, fragmentShader);
+    if (!program) {
+      throw new Error();
+    }
+
+    this.program = program;
+    this.attributeLocations = glw.getAttributeLocations(program);
+
+    const uniLocs = (this.uniformLocations = glw.getUniformLocations(program));
+
+    this.useSystemAlpha = uniLocs['u_alpha'] !== undefined;
+    this.useSystemDimensions = uniLocs['u_dimensions'] !== undefined;
+
+    this.useTimeValue =
+      this.glw.getUniformLocation(program, 'u_dimensions') !== null &&
+      config.time !== undefined;
+
+    this.lifecycle = {
+      update: config.update,
+      canBatch: config.canBatch,
+    };
+  }
+
+  disableAttribute(location: number) {
+    this.glw.disableVertexAttribArray(location);
+  }
+
+  disableAttributes() {
+    const glw = this.glw;
+    const attribLen = this.attributeLocations.length;
+    for (let i = 0; i < attribLen; i++) {
+      glw.disableVertexAttribArray(i);
+    }
+  }
+
+  reuseRenderOp(node: CoreNode, currentRenderOp: WebGlRenderOp): boolean {
+    if (this.lifecycle.canBatch !== undefined) {
+      return this.lifecycle.canBatch(node, currentRenderOp);
+    }
+
+    const { time, worldAlpha, width, height } = node;
+
+    if (this.useTimeValue === true) {
+      if (time !== currentRenderOp.time) {
+        return false;
+      }
+    }
+
+    if (this.useSystemAlpha === true) {
+      if (worldAlpha !== currentRenderOp.worldAlpha) {
+        return false;
+      }
+    }
+
+    if (this.useSystemDimensions === true) {
+      if (
+        width !== currentRenderOp.width ||
+        height !== currentRenderOp.height
+      ) {
+        return false;
+      }
+    }
+
+    let shaderPropsA: Record<string, unknown> | undefined = undefined;
+    let shaderPropsB: Record<string, unknown> | undefined = undefined;
+
+    const shader = node.props.shader;
+
+    if (shader !== null) {
+      shaderPropsA = (shader as WebGlShaderNode).resolvedProps;
+    }
+
+    const opShader = currentRenderOp.shader;
+    if (opShader !== null) {
+      shaderPropsB = (opShader as WebGlShaderNode).resolvedProps;
+    }
+
+    if (
+      (shaderPropsA === undefined && shaderPropsB !== undefined) ||
+      (shaderPropsA !== undefined && shaderPropsB === undefined)
+    ) {
+      return false;
+    }
+
+    if (shaderPropsA !== undefined && shaderPropsB !== undefined) {
+      for (const key in shaderPropsA) {
+        if (shaderPropsA[key] !== shaderPropsB[key]) {
+          return false;
+        }
+      }
+    }
+
+    return true;
+  }
+
+  bindRenderOp(renderOp: WebGlRenderOp) {
+    const isCoreNode = renderOp.isCoreNode;
+
+    this.bindTextures(renderOp.renderOpTextures);
+    this.bindBufferCollection(renderOp.quadBufferCollection);
+
+    const parentHasRenderTexture = renderOp.parentHasRenderTexture;
+    const framebufferDimensions =
+      isCoreNode && renderOp.parentHasRenderTexture
+        ? renderOp.parentFramebufferDimensions
+        : renderOp.framebufferDimensions;
+
+    // Skip if the parent and current operation both have render textures
+    if (USE_RTT && renderOp.rtt === true && parentHasRenderTexture === true) {
+      return;
+    }
+
+    // Bind render texture framebuffer dimensions as resolution
+    // if the parent has a render texture
+    if (USE_RTT && parentHasRenderTexture === true && framebufferDimensions) {
+      const { w, h } = framebufferDimensions;
+      // Force pixel ratio to 1.0 for render textures since they are always 1:1
+      // the final render texture will be rendered to the screen with the correct pixel ratio
+      this.glw.uniform1f('u_pixelRatio', 1.0);
+
+      // Set resolution to the framebuffer dimensions
+      this.glw.uniform2f('u_resolution', w, h);
+    } else {
+      this.glw.uniform1f('u_pixelRatio', renderOp.stage.pixelRatio);
+
+      this.glw.uniform2f(
+        'u_resolution',
+        this.glw.canvas.width,
+        this.glw.canvas.height,
+      );
+    }
+
+    if (this.useTimeValue === true) {
+      this.glw.uniform1f('u_time', renderOp.time);
+    }
+
+    if (this.useSystemAlpha === true) {
+      this.glw.uniform1f('u_alpha', renderOp.worldAlpha);
+    }
+
+    if (this.useSystemDimensions === true) {
+      this.glw.uniform2f('u_dimensions', renderOp.width, renderOp.height);
+    }
+
+    /**temporary fix to make sdf texts work */
+    if (isCoreNode === false && renderOp.sdfShaderProps !== undefined) {
+      const opShader = renderOp.shader; // SdfRenderOp has .shader
+      (opShader.shaderType as WebGlShaderType).onSdfBind?.call(
+        this.glw,
+        renderOp.sdfShaderProps,
+      );
+      return;
+    }
+
+    const shader = renderOp.shader as WebGlShaderNode;
+    if (shader.props !== undefined) {
+      /**
+       * loop over all precalculated uniform types
+       */
+      const uniforms = shader.uniforms;
+
+      for (const key in uniforms.single) {
+        const { method, value } = uniforms.single[key]!;
+        this.glw[method as keyof UniformSet1Param](key, value as never);
+      }
+
+      for (const key in uniforms.vec2) {
+        const { method, value } = uniforms.vec2[key]!;
+        this.glw[method as keyof UniformSet2Params](key, value[0], value[1]);
+      }
+
+      for (const key in uniforms.vec3) {
+        const { method, value } = uniforms.vec3[key]!;
+        this.glw[method as keyof UniformSet3Params](
+          key,
+          value[0],
+          value[1],
+          value[2],
+        );
+      }
+
+      for (const key in uniforms.vec4) {
+        const { method, value } = uniforms.vec4[key]!;
+        this.glw[method as keyof UniformSet4Params](
+          key,
+          value[0],
+          value[1],
+          value[2],
+          value[3],
+        );
+      }
+    }
+  }
+
+  bindBufferCollection(buffer: BufferCollection) {
+    const { glw } = this;
+    const attribs = this.attributeLocations;
+    const attribLen = attribs.length;
+
+    for (let i = 0; i < attribLen; i++) {
+      const name = attribs[i]!;
+      const resolvedBuffer = buffer.getBuffer(name);
+      const resolvedInfo = buffer.getAttributeInfo(name);
+      if (resolvedBuffer === undefined || resolvedInfo === undefined) {
+        continue;
+      }
+      glw.enableVertexAttribArray(i);
+      glw.vertexAttribPointer(
+        resolvedBuffer,
+        i,
+        resolvedInfo.size,
+        resolvedInfo.type,
+        resolvedInfo.normalized,
+        resolvedInfo.stride,
+        resolvedInfo.offset,
+      );
+    }
+  }
+
+  bindTextures(textures: WebGlCtxTexture[]) {
+    if (textures[0] === undefined) {
+      return;
+    }
+    this.glw.activeTexture(0);
+    this.glw.bindTexture(textures[0].ctxTexture);
+  }
+
+  attach(): void {
+    if (this.isDestroyed === true) {
+      return;
+    }
+    this.glw.useProgram(this.program, this.uniformLocations!);
+    if (this.glw.isWebGl2() && this.vao) {
+      this.glw.bindVertexArray(this.vao);
+    }
+  }
+
+  detach(): void {
+    this.disableAttributes();
+  }
+
+  destroy() {
+    if (this.isDestroyed === true) {
+      return;
+    }
+    const glw = this.glw;
+
+    this.detach();
+
+    glw.deleteProgram(this.program!);
+    this.program = null;
+    this.uniformLocations = null;
+
+    const attribs = this.attributeLocations;
+    const attribLen = this.attributeLocations.length;
+    for (let i = 0; i < attribLen; i++) {
+      this.glw.deleteBuffer(attribs[i]!);
+    }
+  }
+}

package/src/core/renderers/webgl/internal/BufferCollection.ts

@@ -1,22 +1,3 @@
-/*
- * 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.
- */
-
 import type { AttributeInfo } from './ShaderUtils.js';
 
 export interface BufferItem {
@@ -29,7 +10,19 @@ export interface BufferItem {
  * vertex attribute formats.
  */
 export class BufferCollection {
-  constructor(readonly config: BufferItem[]) {}
+  private _lookup = new Map<string, BufferItem>();
+
+  constructor(readonly config: BufferItem[]) {
+    for (const item of config) {
+      for (const attrName in item.attributes) {
+        // We only care about attributes that are actually defined (truthy)
+        // and we want the first one found in the config array order
+        if (item.attributes[attrName] && !this._lookup.has(attrName)) {
+          this._lookup.set(attrName, item);
+        }
+      }
+    }
+  }
 
   /**
    * Get the WebGLBuffer associated with the given attribute name if it exists.
@@ -38,7 +31,7 @@ export class BufferCollection {
    * @returns
    */
   getBuffer(attributeName: string): WebGLBuffer | undefined {
-    return this.config.find((item) => item.attributes[attributeName])?.buffer;
+    return this._lookup.get(attributeName)?.buffer;
   }
 
   /**
@@ -48,7 +41,6 @@ export class BufferCollection {
    * @returns
    */
   getAttributeInfo(attributeName: string): AttributeInfo | undefined {
-    return this.config.find((item) => item.attributes[attributeName])
-      ?.attributes[attributeName];
+    return this._lookup.get(attributeName)?.attributes[attributeName];
   }
 }

package/src/core/renderers/webgl/internal/RendererUtils.ts

@@ -1,22 +1,3 @@
-/*
- * 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.
- */
-
 import type { WebGlContextWrapper } from '../../../lib/WebGlContextWrapper.js';
 
 export interface CoreWebGlParameters {

package/src/core/renderers/webgl/internal/ShaderUtils.ts

@@ -1,24 +1,4 @@
-/*
- * 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.
- */
-
 import type { WebGlContextWrapper } from '../../../lib/WebGlContextWrapper.js';
-import type { WebGlCoreRenderer } from '../WebGlCoreRenderer.js';
 
 //#region Types
 export interface AttributeInfo {
@@ -35,10 +15,73 @@ export interface UniformInfo {
   uniform: keyof UniformMethodMap;
 }
 
+export type SingleValue = number | Float32Array | Int32Array;
+export type Vec2 = [number, number];
+export type Vec3 = [number, number, number];
+export type Vec4 = [number, number, number, number];
+
+export type UniformValue = SingleValue | Vec2 | Vec3 | Vec4;
+
+export interface UniformCollection {
+  single: Record<string, Uniform<SingleValue>>;
+  vec2: Record<string, Uniform<Vec2>>;
+  vec3: Record<string, Uniform<Vec3>>;
+  vec4: Record<string, Uniform<Vec4>>;
+}
+
+export interface Uniform<T = UniformValue> {
+  method: string;
+  value: T;
+}
+
+export interface SupportedSetUniforms {
+  uniform2fv: Float32Array;
+  uniform2iv: Int32Array;
+  uniform3fv:
+    | 'uniform2iv'
+    | 'uniform3fv'
+    | 'uniform3iv'
+    | 'uniform4fv'
+    | 'uniform4iv'
+    | 'uniformMatrix2fv'
+    | 'uniformMatrix3fv'
+    | 'uniformMatrix4fv'
+    | 'uniform1f'
+    | 'uniform1fv'
+    | 'uniform1i'
+    | 'uniform1iv'
+    | 'uniform3fv'
+    | 'uniform2f'
+    | 'uniform2i'
+    | 'uniform3f'
+    | 'uniform3i'
+    | 'uniform4f'
+    | 'uniform4i';
+}
+
+type SupportSetUniforms =
+  | 'uniform2fv'
+  | 'uniform2iv'
+  | 'uniform3fv'
+  | 'uniform3iv'
+  | 'uniform4fv'
+  | 'uniform4iv'
+  | 'uniformMatrix2fv'
+  | 'uniformMatrix3fv'
+  | 'uniformMatrix4fv'
+  | 'uniform1f'
+  | 'uniform1fv'
+  | 'uniform1i'
+  | 'uniform1iv'
+  | 'uniform3fv'
+  | 'uniform2f'
+  | 'uniform2i'
+  | 'uniform3f'
+  | 'uniform3i'
+  | 'uniform4f'
+  | 'uniform4i';
+
 export interface ShaderOptions {
-  renderer: WebGlCoreRenderer;
-  attributes: string[];
-  uniforms: UniformInfo[];
   shaderSources?: ShaderProgramSources;
   supportsIndexedTextures?: boolean;
   webgl1Extensions?: string[];
@@ -63,6 +106,28 @@ export type UniformMethodMap = {
   : never;
 };
 
+export type UniformSet1Param = Omit<
+  UniformMethodMap,
+  | 'uniform2f'
+  | 'uniform2i'
+  | 'uniform3f'
+  | 'uniform3i'
+  | 'uniform4f'
+  | 'uniform4i'
+>;
+export type UniformSet2Params = Pick<
+  UniformMethodMap,
+  'uniform2f' | 'uniform2i'
+>;
+export type UniformSet3Params = Pick<
+  UniformMethodMap,
+  'uniform3f' | 'uniform3i'
+>;
+export type UniformSet4Params = Pick<
+  UniformMethodMap,
+  'uniform4f' | 'uniform4i'
+>;
+
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 type TupleToObject<T extends any[]> = Omit<T, keyof any[]>;
 
@@ -80,7 +145,7 @@ export type UniformTupleToMap<Uniforms extends [...UniformInfo[]]> = {
   : never;
 };
 
-type ShaderSource = string | ((textureUnits: number) => string);
+export type ShaderSource = string | ((textureUnits: number) => string);
 
 export interface ShaderProgramSources {
   vertex: ShaderSource;
@@ -141,3 +206,57 @@ export function createProgram(
   glw.deleteProgram(program);
   return undefined;
 }
+
+export const DefaultVertexSource = `
+  # ifdef GL_FRAGMENT_PRECISION_HIGH
+  precision highp float;
+  # else
+  precision mediump float;
+  # endif
+
+  attribute vec2 a_position;
+  attribute vec2 a_textureCoords;
+  attribute vec4 a_color;
+  attribute vec2 a_nodeCoords;
+
+  uniform vec2 u_resolution;
+  uniform float u_pixelRatio;
+  uniform vec2 u_dimensions;
+  uniform vec4 u_shadow;
+
+  varying vec4 v_color;
+  varying vec2 v_textureCoords;
+
+  void main() {
+    vec2 normalized = a_position * u_pixelRatio;
+    vec2 screenSpace = vec2(2.0 / u_resolution.x, -2.0 / u_resolution.y);
+
+    vec2 outerEdge = clamp(a_textureCoords * 2.0 - vec2(1.0), -1.0, 1.0);
+    vec2 shadowEdge = outerEdge;
+    vec2 vertexPos = normalized + outerEdge + shadowEdge;
+    v_color = a_color;
+    v_textureCoords = a_textureCoords;
+
+    gl_Position = vec4(vertexPos.x * screenSpace.x - 1.0, -sign(screenSpace.y) * (vertexPos.y * -abs(screenSpace.y)) + 1.0, 0.0, 1.0);
+  }
+`;
+
+/**
+ * generate fragment source for
+ * @param stops
+ * @returns
+ */
+export function genGradientColors(stops: number): string {
+  let result = `
+    float stopCalc = (dist - u_stops[0]) / (u_stops[1] - u_stops[0]);
+    vec4 colorOut = mix(u_colors[0], u_colors[1], stopCalc);
+  `;
+  if (stops > 2) {
+    for (let i = 2; i < stops; i++) {
+      result += `colorOut = mix(colorOut, u_colors[${i}], clamp((dist - u_stops[${
+        i - 1
+      }]) / (u_stops[${i}] - u_stops[${i - 1}]), 0.0, 1.0));`;
+    }
+  }
+  return result;
+}

package/src/core/renderers/webgl/internal/WebGlUtils.ts

@@ -1,22 +1,3 @@
-/*
- * 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.
- */
-
 /**
  * Generic WebGL Utility Functions
  *