@predy-js/render-interface 0.3.3-beta.34 → 0.3.3-beta.35

package/dist/statistic.js

@@ -2,7 +2,7 @@
  * Name: @predy-js/render-interface
  * Description: undefined
  * Author: undefined
- * Version: v0.3.3-beta.34
+ * Version: v0.3.3-beta.35
  */
 
 // https://github.com/greggman/webgl-memory/blob/main/src/texture-utils.js

package/dist/types/constants.d.ts

@@ -4,3 +4,19 @@ export declare enum DestroyOptions {
     keep = 1,
     force = 0
 }
+export declare enum PredyTextEncoding {
+    utf8 = 0,
+    ascii = 1
+}
+export declare enum PredyVideoCodec {
+    h264 = "avc1",
+    h265 = "hev1",
+    av1 = "av1"
+}
+export declare enum PredyResourceCacheStatus {
+    noCache = 0,
+    cached = 1,
+    preloaded = 2,
+    hitCDN = 3,
+    missCDN = 4
+}

package/dist/types/native/PredyNativeInternal.d.ts

@@ -3,6 +3,9 @@ import type { TypedArray, vec2 } from '../type';
 import type { GPUCapability } from '../GPUCapability';
 import type { PredyResizeTemplate, SDFImageOptions, SDFImage } from '@predy-js/specification';
 import type { ImageBitmapInternal } from './ImageBitmapInternal';
+import type { PredyVideoDecoder, PredyVideoDecoderConstructor } from './VideoDecoder';
+import type { ResourcePlatform } from './ResourceInternal';
+import type { PredyVideoCodec, PredyTextEncoding, PredyResourceCacheStatus } from '../constants';
 export interface PredyRequestOptions {
     url: string;
     disableCache?: boolean;
@@ -10,13 +13,6 @@ export interface PredyRequestOptions {
     responseType?: 'text' | 'arraybuffer';
     useSystemNetwork?: boolean;
 }
-export declare enum PredyResourceCacheStatus {
-    noCache = 0,
-    cached = 1,
-    preloaded = 2,
-    hitCDN = 3,
-    missCDN = 4
-}
 export interface PredyRequestResponse {
     data: ArrayBuffer | string;
     cacheStatus: PredyResourceCacheStatus;
@@ -25,12 +21,13 @@ export interface PredyRequestResponse {
 export type PredyRequestCallback = (err: string | undefined, res: PredyRequestResponse) => void;
 export declare const DataCompressMethodZlib = 1;
 type DataCompressMethod = typeof DataCompressMethodZlib;
-export declare enum PredyTextEncoding {
-    utf8 = 0,
-    ascii = 1
-}
 export interface PredyNativeInternal {
     webpDisabled?: boolean;
+    /**
+       * 是否支持获取gles3，但如果获取es3失败，会降级到es2
+       */
+    supportGLES3?: boolean;
+    platform: ResourcePlatform;
     createImageBitmap(data: TypedArray | string, //图片文件的数据
     options: ImageBitmapConstructor, callback: ImageBitmapCallback): void;
     getDefaultGPUCapability(): GPUCapability;
@@ -83,10 +80,20 @@ export interface PredyNativeInternal {
        */
     inflateData(data: Uint8Array, method: DataCompressMethod): Uint8Array | undefined;
     /**
-     * 恢复当前的主JSContext,多个JSContext执行的时候会发生抢占，
-     * 调用此函数后，当前的JSContext会被恢复
-     */
+       * 恢复当前的主JSContext,多个JSContext执行的时候会发生抢占，
+       * 调用此函数后，当前的JSContext会被恢复
+       */
     restoreJSContext(): boolean;
+    /**
+       * 创建 video decoder
+       * @param options
+       */
+    createVideoDecoder(options: PredyVideoDecoderConstructor): PredyVideoDecoder;
+    /**
+       * 是否支持视频编码
+       * @param codec
+       */
+    supportVideoCodec(codec: PredyVideoCodec): boolean;
 }
 type renderSDFImageCallback = (img: SDFImage) => void;
 export {};

package/dist/types/native/TextureInternal.d.ts

@@ -23,6 +23,7 @@ export declare abstract class TextureInternal implements ResourceInternal {
     readonly height: number;
     readonly name: string;
     readonly options: TextureInternalOptions;
+    readonly error?: number;
     protected constructor(options: TextureInternalConstructOptions);
     abstract resize(width: number, height: number): boolean;
     abstract destroy(): void;

package/dist/types/native/VideoDecoder.d.ts

@@ -0,0 +1,77 @@
+import type { VideoFrameFormat } from '@predy-js/specification';
+import type { PredyResourceCacheStatus } from '../constants';
+export interface PredyVideoDecoderFrameData {
+    width: number;
+    height: number;
+    data: Uint8Array;
+    idx: number;
+    keyframe: boolean;
+}
+export declare enum PredyVideoDecoderStatus {
+    init = 0,
+    loading = 1,
+    metadataReady = 2,
+    seekingFrame = 3,
+    frameReady = 4,
+    destroyed = 5,
+    error = 44
+}
+/**
+ * 视频解码的通用class，在native和web端有不同的实现
+ */
+export interface PredyVideoDecoderMetadata {
+    width: number;
+    height: number;
+    duration: number;
+    frameCount: number;
+    cacheStatus: PredyResourceCacheStatus;
+    format: VideoFrameFormat;
+    frameBufferSize: number;
+}
+/**
+ * VideoDecoder创建参数
+ */
+export interface PredyVideoDecoderConstructor {
+    name: string;
+    prefetchOnly?: boolean;
+}
+export type PredyVideoDecoderLoadedCallback = (error?: Error, metadata?: PredyVideoDecoderMetadata) => void;
+export type PredyVideoDecoderSeekFrameCallback = (error?: Error, frame?: PredyVideoDecoderFrameData) => void;
+export interface PredyVideoDecoder {
+    readonly name: string;
+    readonly status: PredyVideoDecoderStatus;
+    readonly metadata?: PredyVideoDecoderMetadata;
+    /**
+       * 只做资源请求，不进行视频解码，
+       * 这种情况下，seekFrame永远返回error（prefetch only）
+       */
+    readonly prefetchOnly: boolean;
+    /**
+       * 是否要跳播/回播，如果不需要的话，Decoder可以自行释放已经播放的帧
+       */
+    readonly willReverseTime: boolean;
+    readonly currentFrame: number;
+    /**
+       * 加载视频,解析视频的metadata，设置frame数组,
+       * 此函数只能调用一次，如果需要解析其他的视频，需要重新创建对象
+       * @param url 视频地址
+       * @param callback 解析回调
+       */
+    loadVideo(url: string, callback: PredyVideoDecoderLoadedCallback): void;
+    /**
+       * 如果当前正在解析，中断解析，并且之前的callback返回error（abort）
+       * 调用后回到frameReady状态
+       */
+    abortSeeking(): void;
+    /**
+       * 解析视频的下一帧，获得图像数据。如果调用的时候正在解析，callback直接返回error
+       * @param frameIndex frame的index
+       * @param data 图像数据buffer，数据将被写入到此Buffer中，如果buffer尺寸不对，解析会失败
+       * @param callback 图像数据回调
+       */
+    seekFrame(frameIndex: number, data: Uint8Array, callback: PredyVideoDecoderSeekFrameCallback): void;
+    /**
+       * 释放资源
+       */
+    destroy(): void;
+}

package/dist/types/native/index.d.ts

@@ -13,3 +13,4 @@ export * from './TextureInternal';
 export * from './AndGLContext';
 export * from './PredyNativeInternal';
 export * from './PredyNativeModule';
+export * from './VideoDecoder';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@predy-js/render-interface",
-  "version": "0.3.3-beta.34",
+  "version": "0.3.3-beta.35",
   "license": "MIT",
   "module": "./dist/index.mjs",
   "main": "./dist/index.js",

package/types/constants.ts

@@ -5,3 +5,23 @@ export enum DestroyOptions {
   keep = 1,
   force = destroy,
 }
+
+export enum PredyTextEncoding {
+  utf8 = 0,
+  ascii = 1,
+}
+
+export enum PredyVideoCodec {
+  h264 = 'avc1',
+  h265 = 'hev1',
+  av1 = 'av1'
+}
+
+export enum PredyResourceCacheStatus {
+  noCache = 0, // 没有缓存，走网络请求
+  cached = 1, // 命中缓存，如果请求同一个url，在关闭APP之前，一定会命中缓存，关闭APP后，清理时间由系统决定
+  preloaded = 2, // 命中预推
+  hitCDN = 3, // 从正常CDN加载
+  missCDN = 4, // CDN异常加载（回源）
+}
+

package/types/native/PredyNativeInternal.ts

@@ -3,6 +3,9 @@ import type { TypedArray, vec2 } from '../type';
 import type { GPUCapability } from '../GPUCapability';
 import type { PredyResizeTemplate, SDFImageOptions, SDFImage } from '@predy-js/specification';
 import type { ImageBitmapInternal } from './ImageBitmapInternal';
+import type { PredyVideoDecoder, PredyVideoDecoderConstructor } from './VideoDecoder';
+import type { ResourcePlatform } from './ResourceInternal';
+import type { PredyVideoCodec, PredyTextEncoding, PredyResourceCacheStatus } from '../constants';
 
 export interface PredyRequestOptions {
   url: string,
@@ -17,14 +20,6 @@ export interface PredyRequestOptions {
   useSystemNetwork?: boolean,
 }
 
-export enum PredyResourceCacheStatus {
-  noCache = 0, // 没有缓存，走网络请求
-  cached = 1, // 命中缓存，如果请求同一个url，在关闭APP之前，一定会命中缓存，关闭APP后，清理时间由系统决定
-  preloaded = 2, // 命中预推
-  hitCDN = 3, // 从正常CDN加载
-  missCDN = 4, // CDN异常加载（回源）
-}
-
 export interface PredyRequestResponse {
   data: ArrayBuffer | string,
   cacheStatus: PredyResourceCacheStatus,
@@ -37,28 +32,23 @@ export const DataCompressMethodZlib = 1;
 
 type DataCompressMethod = typeof DataCompressMethodZlib;
 
-export enum PredyTextEncoding {
-  utf8 = 0,
-  ascii = 1,
-}
-
 export interface PredyNativeInternal {
   webpDisabled?: boolean,
-
+  /**
+     * 是否支持获取gles3，但如果获取es3失败，会降级到es2
+     */
+  supportGLES3?: boolean,
+  platform: ResourcePlatform,
   createImageBitmap(data: TypedArray | string, //图片文件的数据
     options: ImageBitmapConstructor, callback: ImageBitmapCallback): void,
-
   getDefaultGPUCapability(): GPUCapability,
-
   requestWithCache(options: PredyRequestOptions, callback: PredyRequestCallback): void,
-
   /**
      * decode text from data
      * @param data
      * @param encoding 默认utf8
      */
   decodeText(data: Uint8Array, encoding?: PredyTextEncoding): string,
-
   /**
      * 将图片绘制到画布上，同时替换文案，绘制的顺序如下
      * 创建template.size尺寸的画布, 接下来的绘制均应用 template.offset
@@ -67,14 +57,12 @@ export interface PredyNativeInternal {
      * @param template
      */
   renderImageTemplate(template: PredyResizeTemplate): ImageBitmapInternal,
-
   /**
      * 异步绘制图片的模板
      * @param options
      * @param callback 如果传入callback就是异步绘制，否则会直接返回结果
      */
   generateSDFImage(options: SDFImageOptions, callback?: renderSDFImageCallback): SDFImage | undefined,
-
   /**
      * 下载并且执行脚本文件，此方法会缓存https的脚本内容
      * 对于http的请求（开发环境），每次都重新请求
@@ -82,7 +70,6 @@ export interface PredyNativeInternal {
      * @param callback
      */
   evaluateScriptURL(url: string, callback: (err: Error, result: any) => void): void,
-
   /**
      * 将float32Array转换为half float，写入Uint16Array中,
      * 如果提供了range参数，代表float16会被重新map到range中，以此提高精度范围
@@ -107,10 +94,22 @@ export interface PredyNativeInternal {
   inflateData(data: Uint8Array, method: DataCompressMethod): Uint8Array | undefined,
 
   /**
-   * 恢复当前的主JSContext,多个JSContext执行的时候会发生抢占，
-   * 调用此函数后，当前的JSContext会被恢复
-   */
+     * 恢复当前的主JSContext,多个JSContext执行的时候会发生抢占，
+     * 调用此函数后，当前的JSContext会被恢复
+     */
   restoreJSContext(): boolean,
+
+  /**
+     * 创建 video decoder
+     * @param options
+     */
+  createVideoDecoder(options: PredyVideoDecoderConstructor): PredyVideoDecoder,
+
+  /**
+     * 是否支持视频编码
+     * @param codec
+     */
+  supportVideoCodec(codec: PredyVideoCodec): boolean,
 }
 
 type renderSDFImageCallback = (img: SDFImage) => void;

package/types/native/TextureInternal.ts

@@ -32,6 +32,8 @@ export abstract class TextureInternal implements ResourceInternal {
 
   readonly options: TextureInternalOptions;
 
+  readonly error?: number;
+
   protected constructor (options: TextureInternalConstructOptions) {
   }
 

package/types/native/VideoDecoder.ts

@@ -0,0 +1,87 @@
+import type { VideoFrameFormat } from '@predy-js/specification';
+import type { PredyResourceCacheStatus } from '../constants';
+export interface PredyVideoDecoderFrameData {
+  width: number,
+  height: number,
+  data: Uint8Array,
+  idx: number,
+  keyframe: boolean,
+}
+
+export enum PredyVideoDecoderStatus {
+  init = 0, // 创建对象
+  loading = 1, // 正在解析metadata，解析过程任何函数调用都会导致error
+  metadataReady = 2, // metadata 解析完成，此时 currentFrame = -1
+  seekingFrame = 3, // 正在解析某一帧，解析过程任何函数调用都会导致error
+  frameReady = 4, // 解析某一帧完成，此时 currentFrame = frame.index
+  destroyed = 5, // 对象已经销毁
+  error = 44, // 发生错误
+}
+
+/**
+ * 视频解码的通用class，在native和web端有不同的实现
+ */
+export interface PredyVideoDecoderMetadata {
+  width: number,
+  height: number,
+  duration: number, // in ms
+  frameCount: number,
+  cacheStatus: PredyResourceCacheStatus,
+  format: VideoFrameFormat,
+  frameBufferSize: number, // 每帧的buffer大小
+}
+
+/**
+ * VideoDecoder创建参数
+ */
+export interface PredyVideoDecoderConstructor {
+  name: string,
+  prefetchOnly?: boolean,
+}
+
+export type PredyVideoDecoderLoadedCallback = (error?: Error, metadata?: PredyVideoDecoderMetadata) => void;
+export type PredyVideoDecoderSeekFrameCallback = (error?: Error, frame?: PredyVideoDecoderFrameData) => void;
+
+export interface PredyVideoDecoder {
+  readonly name: string,
+  readonly status: PredyVideoDecoderStatus,
+  readonly metadata?: PredyVideoDecoderMetadata,
+
+  /**
+     * 只做资源请求，不进行视频解码，
+     * 这种情况下，seekFrame永远返回error（prefetch only）
+     */
+  readonly prefetchOnly: boolean,
+  /**
+     * 是否要跳播/回播，如果不需要的话，Decoder可以自行释放已经播放的帧
+     */
+  readonly willReverseTime: boolean,
+  readonly currentFrame: number,
+
+  /**
+     * 加载视频,解析视频的metadata，设置frame数组,
+     * 此函数只能调用一次，如果需要解析其他的视频，需要重新创建对象
+     * @param url 视频地址
+     * @param callback 解析回调
+     */
+  loadVideo(url: string, callback: PredyVideoDecoderLoadedCallback): void,
+
+  /**
+     * 如果当前正在解析，中断解析，并且之前的callback返回error（abort）
+     * 调用后回到frameReady状态
+     */
+  abortSeeking(): void,
+
+  /**
+     * 解析视频的下一帧，获得图像数据。如果调用的时候正在解析，callback直接返回error
+     * @param frameIndex frame的index
+     * @param data 图像数据buffer，数据将被写入到此Buffer中，如果buffer尺寸不对，解析会失败
+     * @param callback 图像数据回调
+     */
+  seekFrame(frameIndex: number, data: Uint8Array, callback: PredyVideoDecoderSeekFrameCallback): void,
+
+  /**
+     * 释放资源
+     */
+  destroy(): void,
+}

package/types/native/index.ts

@@ -13,3 +13,4 @@ export * from './TextureInternal';
 export * from './AndGLContext';
 export * from './PredyNativeInternal';
 export * from './PredyNativeModule';
+export * from './VideoDecoder';