@predy-js/render-interface 0.3.3-beta.1 → 0.3.3-beta.3

package/dist/statistic.js

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

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

@@ -3,6 +3,8 @@ 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';
 export interface PredyRequestOptions {
     url: string;
     disableCache?: boolean;
@@ -29,8 +31,18 @@ export declare enum PredyTextEncoding {
     utf8 = 0,
     ascii = 1
 }
+export declare enum PredyVideoCodec {
+    h264 = "avc1",
+    h265 = "hev1",
+    av1 = "av1"
+}
 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 +95,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/VideoDecoder.d.ts

@@ -0,0 +1,72 @@
+import type { VideoFrameFormat } from '@predy-js/specification';
+/**
+ * video原始数据的切片，原始数据不暴露到js，只能通过decoder解析
+ * 只暴露当前的切片时间和是否是keyframe
+ */
+export interface PredyVideoDecoderFrame {
+    time: number;
+    key?: boolean;
+    idx: number;
+}
+export interface PredyVideoDecoderFrameData {
+    width: number;
+    height: number;
+    data: Uint8Array;
+    idx: number;
+}
+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;
+    frames: PredyVideoDecoderFrame[];
+    format: VideoFrameFormat;
+    frameBufferSize: number;
+}
+/**
+ * VideoDecoder创建参数
+ */
+export interface PredyVideoDecoderConstructor {
+    name: string;
+}
+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;
+    /**
+       * 是否要跳播/回播，如果不需要的话，Decoder可以自行释放已经播放的帧
+       */
+    readonly willReverseTime: boolean;
+    readonly currentFrame: number;
+    /**
+       * 加载视频,解析视频的metadata，设置frame数组,
+       * 此函数只能调用一次，如果需要解析其他的视频，需要重新创建对象
+       * @param url 视频地址
+       * @param callback 解析回调
+       */
+    loadVideo(url: string, callback: PredyVideoDecoderLoadedCallback): void;
+    /**
+       * 解析视频的下一帧，获得图像数据。
+       * @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.1",
+  "version": "0.3.3-beta.3",
   "license": "MIT",
   "module": "./dist/index.mjs",
   "main": "./dist/index.js",

package/types/native/PredyNativeInternal.ts

@@ -3,6 +3,8 @@ 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';
 
 export interface PredyRequestOptions {
   url: string,
@@ -42,9 +44,22 @@ export enum PredyTextEncoding {
   ascii = 1,
 }
 
+export enum PredyVideoCodec {
+  h264 = 'avc1',
+  h265 = 'hev1',
+  av1 = 'av1'
+}
+
 export interface PredyNativeInternal {
   webpDisabled?: boolean,
 
+  /**
+     * 是否支持获取gles3，但如果获取es3失败，会降级到es2
+     */
+  supportGLES3?: boolean,
+
+  platform: ResourcePlatform,
+
   createImageBitmap(data: TypedArray | string, //图片文件的数据
     options: ImageBitmapConstructor, callback: ImageBitmapCallback): void,
 
@@ -107,10 +122,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/VideoDecoder.ts

@@ -0,0 +1,82 @@
+import type { VideoFrameFormat } from '@predy-js/specification';
+
+/**
+ * video原始数据的切片，原始数据不暴露到js，只能通过decoder解析
+ * 只暴露当前的切片时间和是否是keyframe
+ */
+export interface PredyVideoDecoderFrame {
+  time: number,
+  key?: boolean,
+  idx: number,
+}
+
+export interface PredyVideoDecoderFrameData {
+  width: number,
+  height: number,
+  data: Uint8Array,
+  idx: number,
+}
+
+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,
+  frames: PredyVideoDecoderFrame[],
+  format: VideoFrameFormat,
+  frameBufferSize: number, // 每帧的buffer大小
+}
+
+/**
+ * VideoDecoder创建参数
+ */
+export interface PredyVideoDecoderConstructor {
+  name: string,
+}
+
+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,
+  /**
+     * 是否要跳播/回播，如果不需要的话，Decoder可以自行释放已经播放的帧
+     */
+  readonly willReverseTime: boolean,
+  readonly currentFrame: number,
+
+  /**
+     * 加载视频,解析视频的metadata，设置frame数组,
+     * 此函数只能调用一次，如果需要解析其他的视频，需要重新创建对象
+     * @param url 视频地址
+     * @param callback 解析回调
+     */
+  loadVideo(url: string, callback: PredyVideoDecoderLoadedCallback): void,
+
+  /**
+     * 解析视频的下一帧，获得图像数据。
+     * @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';