Add SDKVersion interface and removed the "upper camel case" function …

…name on Web platform. (#397)

(cherry picked from commit 2118050)

src/platform/web/PAGWasmBindings.cpp

@@ -481,6 +481,8 @@ EMSCRIPTEN_BINDINGS(pag) {
  WebSoftwareDecoderFactory::Make(factory).release());
  }));
 
+ function("_SDKVersion", &PAG::SDKVersion);
+
  register_vector<std::shared_ptr<PAGLayer>>("VectorPAGLayer");
  register_vector<std::string>("VectorString");
  register_vector<int>("VectorInt");

web/demo/index.ts

@@ -48,7 +48,7 @@ window.onload = async () => {
  tablecloth!.style.height = `${canvasElementSize}px`;
  }
 
- console.log('wasm loaded!', PAG);
+ console.log(`wasm loaded! SDKVersion ${PAG.SDKVersion()}`, PAG);
 
  document.getElementById('waiting')!.style.display = 'none';
  document.getElementById('container')!.style.display = isMobile ? 'block' : '';

web/src/binding.ts

@@ -54,6 +54,9 @@ export const binding = (module: PAG) => {
  module.registerSoftwareDecoderFactory = function (factory = null) {
  module._registerSoftwareDecoderFactory(factory);
  };
+ module.SDKVersion = function () {
+ return module._SDKVersion();
+ };
 };
 
 export let PAGModule: PAG;

web/src/core/web-mask.ts

@@ -45,7 +45,10 @@ export class WebMask {
  public fillPath(path: Path2D, fillType: ctor) {
  const context = this.canvas.getContext('2d') as CanvasRenderingContext2D;
  context.setTransform(1, 0, 0, 1, 0, 0);
- if (fillType === PAGModule.TGFXPathFillType.InverseWinding || fillType === PAGModule.TGFXPathFillType.InverseEvenOdd) {
+ if (
+ fillType === PAGModule.TGFXPathFillType.InverseWinding ||
+ fillType === PAGModule.TGFXPathFillType.InverseEvenOdd
+ ) {
  context.clip(path, fillType === PAGModule.TGFXPathFillType.InverseEvenOdd ? 'evenodd' : 'nonzero');
  context.fillRect(0, 0, this.canvas.width, this.canvas.height);
  } else {

web/src/pag-composition.ts

@@ -8,16 +8,6 @@ import type { Marker } from './types';
 @destroyVerify
 @wasmAwaitRewind
 export class PAGComposition extends PAGLayer {
- /**
- * [Deprecated]
- * Make a empty PAGComposition with specified size.
- */
- public static Make(width: number, height: number): PAGComposition {
- console.warn(
- 'Please use PAGComposition.make to create PAGComposition object! This interface will be removed in the next version!',
- );
- return PAGComposition.make(width, height);
- }
  /**
  * Make a empty PAGComposition with specified size.
  */

web/src/pag-image-layer.ts

@@ -9,16 +9,6 @@ import type { PAGVideoRange } from './types';
 @destroyVerify
 @wasmAwaitRewind
 export class PAGImageLayer extends PAGLayer {
- /**
- * [Deprecated]
- * Make a empty PAGImageLayer with specified size.
- */
- public static Make(width: number, height: number, duration: number): PAGImageLayer {
- console.warn(
- 'Please use PAGImageLayer.make to create PAGImageLayer object! This interface will be removed in the next version!',
- );
- return PAGImageLayer.make(width, height, duration);
- }
  /**
  * Make a empty PAGImageLayer with specified size.
  */

web/src/pag-player.ts

@@ -2,7 +2,7 @@ import { PAGModule } from './binding';
 import { PAGFile } from './pag-file';
 import { PAGSurface } from './pag-surface';
 import { wasmAwaitRewind, wasmAsyncMethod, destroyVerify } from './utils/decorators';
-import { layer2typeLayer, proxyVector } from './utils/type-utils';
+import { getWasmIns, layer2typeLayer, proxyVector } from './utils/type-utils';
 import { Matrix } from './core/matrix';
 
 import type { PAGLayer } from './pag-layer';
@@ -133,8 +133,8 @@ export class PAGPlayer {
  /**
  * Set the PAGSurface object for PAGPlayer to render onto.
  */
- public setSurface(pagSurface: PAGSurface): void {
- this.wasmIns._setSurface(pagSurface.wasmIns);
+ public setSurface(pagSurface: PAGSurface | null): void {
+ this.wasmIns._setSurface(getWasmIns(pagSurface));
  }
  /**
  *
@@ -153,8 +153,8 @@ export class PAGPlayer {
  * Sets a new PAGComposition for PAGPlayer to render as content.
  */
 
- public setComposition(pagComposition: PAGComposition) {
- this.wasmIns._setComposition(pagComposition.wasmIns);
+ public setComposition(pagComposition: PAGComposition | null) {
+ this.wasmIns._setComposition(getWasmIns(pagComposition));
  }
  /**
  * Returns the PAGSurface object for PAGPlayer to render onto.

web/src/pag-solid-layer.ts

@@ -7,16 +7,6 @@ import type { Color } from './types';
 @destroyVerify
 @wasmAwaitRewind
 export class PAGSolidLayer extends PAGLayer {
- /**
- * [Deprecated]
- * Make a empty PAGSolidLayer with specified size.
- */
- public static Make(duration: number, width: number, height: number, solidColor: Color, opacity: number) {
- console.warn(
- 'Please use PAGSolidLayer.make to create PAGSolidLayer object! This interface will be removed in the next version!',
- );
- return PAGSolidLayer.make(duration, width, height, solidColor, opacity);
- }
  /**
  * Make a empty PAGSolidLayer with specified size.
  */

web/src/pag-text-layer.ts

@@ -8,15 +8,15 @@ import type { Color, TextDocument } from './types';
 @destroyVerify
 @wasmAwaitRewind
 export class PAGTextLayer extends PAGLayer {
- public static Make(
+ public static make(
  duration: number,
  text: string,
  fontSize: number,
  fontFamily: string,
  fontStyle: string,
  ): PAGTextLayer;
- public static Make(duration: number, textDocumentHandle: TextDocument): PAGTextLayer;
- public static Make(
+ public static make(duration: number, textDocumentHandle: TextDocument): PAGTextLayer;
+ public static make(
  duration: number,
  text: string | TextDocument,
  fontSize = 0,

web/src/pag.ts

@@ -4,7 +4,6 @@ import { binding } from './binding';
 import * as types from './types';
 import createPAG from './wasm/libpag';
 import { WebAssemblyQueue } from './utils/queue';
-import { version } from '../package.json';
 
 export interface moduleOption {
  /**
@@ -30,4 +29,4 @@ const PAGInit = (moduleOption: moduleOption = {}): Promise<types.PAG> =>
  throw new Error('PAGInit fail! Please check .wasm file path valid.');
  });
 
-export { PAGInit, types, version };
+export { PAGInit, types };

web/src/types.ts

@@ -110,6 +110,7 @@ export interface PAG extends EmscriptenModule {
  Matrix: typeof ClassMatrix;
  traceImage: (info: { width: number; height: number }, pixels: Uint8Array, tag: string) => void;
  registerSoftwareDecoderFactory: (factory: SoftwareDecoderFactory | null) => void;
+ SDKVersion: () => string;
  [key: string]: any;
 }
 

web/src/utils/type-utils.ts

@@ -62,7 +62,7 @@ export const layer2typeLayer = (wasmIns: any): PAGSolidLayer | PAGTextLayer | PA
  }
 };
 
-export const getLayerTypeName = (layerType:LayerType)=> {
+export const getLayerTypeName = (layerType: LayerType) => {
  switch (layerType) {
  case LayerType.Solid:
  return 'Solid';
@@ -77,4 +77,11 @@ export const getLayerTypeName = (layerType:LayerType)=> {
  default:
  return 'Unknown';
  }
-}
+};
+
+export const getWasmIns = (value: any) => {
+ if (value?.wasmIns) {
+ return value.wasmIns;
+ }
+ return value;
+};