facebetter 1.1.0 → 1.1.2

package/README.md

@@ -1,7 +1,7 @@
 # Facebetter Web SDK
 
 <h2 align="center">
-  <a href="https://github.com/pixpark/facebetter-demo"><img src="./logo.svg" alt="Facebetter Logo" width="300"></a>
+  <a href="https://github.com/pixpark/facebetter-sdk"><img src="./logo.svg" alt="Facebetter Logo" width="300"></a>
 </h2>
 
 Facebetter is a high-performance, cross-platform SDK for real-time face beauty and AR effects. The Web version leverages WebAssembly (WASM) and WebGL acceleration to provide professional-grade skin retouching, face reshaping, makeup, and virtual background capabilities directly in the browser.

package/dist/facebetter.esm.js

@@ -47,7 +47,7 @@ class EngineConfig {
     this.appId = config.appId || null;
     this.appKey = config.appKey || null;
     this.licenseJson = config.licenseJson || null;
-    this.resourcePath = '/facebetter/resource.bundle';
+    this.resourcePath = '/resource.fbd';
     /**
      * Whether to use an external GL context (native platforms only).
      * In Web/WASM environments, this field is kept for configuration structure alignment,
@@ -92,7 +92,9 @@ const BeautyType$1 = {
   Reshape: 1,           // Face reshaping (face thinning, big eyes, etc.)
   Makeup: 2,            // Makeup effects (lipstick, blush, etc.)
   VirtualBackground: 3,  // Virtual background (blur, image replacement)
-  ChromaKey: 4          // Chroma key (green screen removal)
+  ChromaKey: 4,          // Chroma key (green screen removal)
+  Filter: 5,             // LUT based filter
+  Sticker: 6             // 2D/3D sticker
 };
 
 /**
@@ -159,6 +161,16 @@ const FrameType$1 = {
   Video: 1        // Video mode
 };
 
+/**
+ * Mirror mode enumeration (apply to input before processing)
+ */
+const MirrorMode$1 = {
+  None: 0,        // No mirror
+  Horizontal: 1,  // Mirror horizontally (e.g. front camera selfie)
+  Vertical: 2,    // Mirror vertically
+  Both: 3         // Mirror both axes
+};
+
 /**
  * Virtual background options class
  * Matches the C++/Java/OC API design
@@ -195,6 +207,7 @@ var constants = /*#__PURE__*/Object.freeze({
   ChromaKeyParam: ChromaKeyParam$1,
   FrameType: FrameType$1,
   MakeupParam: MakeupParam$1,
+  MirrorMode: MirrorMode$1,
   ReshapeParam: ReshapeParam$1,
   VirtualBackgroundOptions: VirtualBackgroundOptions$1
 });
@@ -250,7 +263,7 @@ class BeautyEffectEngine {
     this.appId = engineConfig.appId;
     this.appKey = engineConfig.appKey;
     this.licenseJson = engineConfig.licenseJson;
-    this.resourcePath = '/facebetter/resource.bundle';
+    this.resourcePath = '/resource.fbd';
     this.enginePtr = null;
     this.initialized = false;
     this.srcBufferPtr = null;
@@ -267,7 +280,6 @@ class BeautyEffectEngine {
     this._getWasmModule = platformAPI.getWasmModule;
     this._getWasmBuffer = platformAPI.getWasmBuffer;
     this._toImageData = platformAPI.toImageData;
-    this._verifyAppKeyOnline = platformAPI.verifyAppKeyOnline;
     this._ensureGPUPixelCanvas = platformAPI.ensureGPUPixelCanvas;
     this._cleanupGPUPixelCanvas = platformAPI.cleanupGPUPixelCanvas;
     
@@ -376,7 +388,7 @@ class BeautyEffectEngine {
         if (!Module.onReportUsage) {
           Module.onReportUsage = async (payloadJson) => {
             try {
-              const url = 'https://facebetter.pixpark.net/rest/v1/rpc/report_sdk_usage';
+              const url = 'https://facebetter.pixpark.net/facebetter/v1/report';
               const response = await fetch(url, {
                 method: 'POST',
                 headers: {
@@ -395,7 +407,7 @@ class BeautyEffectEngine {
         if (!Module.onOnlineAuth) {
           Module.onOnlineAuth = async (payloadJson) => {
             try {
-              const url = 'https://facebetter.pixpark.net/rest/v1/rpc/online_auth_v2';
+              const url = 'https://facebetter.pixpark.net/facebetter/v1/auth';
               const response = await fetch(url, {
                 method: 'POST',
                 headers: {
@@ -635,7 +647,231 @@ class BeautyEffectEngine {
   }
 
   /**
-   * Internal method to set beauty parameters
+   * Sets a LUT-based filter
+   * @param {string} filterId - Unique identifier of the filter (e.g., "chuxin"). Pass "" to clear.
+   */
+  setFilter(filterId) {
+    this._ensureInitialized();
+    const Module = this._getWasmModule();
+    const result = Module.ccall(
+      'SetFilter',
+      'number',
+      ['number', 'string'],
+      [this.enginePtr, filterId || '']
+    );
+    checkResult(result, 'Failed to set filter');
+  }
+
+  /**
+   * Sets the intensity of the current filter
+   * @param {number} intensity - Filter intensity (0.0 - 1.0)
+   */
+  setFilterIntensity(intensity) {
+    this._ensureInitialized();
+    const Module = this._getWasmModule();
+    const result = Module.ccall(
+      'SetFilterIntensity',
+      'number',
+      ['number', 'number'],
+      [this.enginePtr, intensity]
+    );
+    checkResult(result, 'Failed to set filter intensity');
+  }
+
+  /**
+   * Sets a 2D sticker
+   * @param {string} stickerId - Unique identifier of the sticker (e.g., "樱花"). Pass "" to clear.
+   */
+  setSticker(stickerId) {
+    this._ensureInitialized();
+    const Module = this._getWasmModule();
+    const result = Module.ccall(
+      'SetSticker',
+      'number',
+      ['number', 'string'],
+      [this.enginePtr, stickerId || '']
+    );
+    checkResult(result, 'Failed to set sticker');
+  }
+
+  /**
+   * Registers a filter from a file path or data
+   * @param {string} filterId - Unique identifier for the filter
+   * @param {string|Uint8Array} resource - Path to .fbd file or Uint8Array data
+   */
+  registerFilter(filterId, resource) {
+    this._ensureInitialized();
+    const Module = this._getWasmModule();
+
+    if (typeof resource === 'string') {
+      const result = Module.ccall(
+        'RegisterFilterPath',
+        'number',
+        ['number', 'string', 'string'],
+        [this.enginePtr, filterId, resource]
+      );
+      checkResult(result, `Failed to register filter path: ${filterId}`);
+    } else if (resource instanceof Uint8Array) {
+      const dataPtr = Module._malloc(resource.length);
+      Module.HEAPU8.set(resource, dataPtr);
+      try {
+        const result = Module.ccall(
+          'RegisterFilterData',
+          'number',
+          ['number', 'string', 'number', 'number'],
+          [this.enginePtr, filterId, dataPtr, resource.length]
+        );
+        checkResult(result, `Failed to register filter data: ${filterId}`);
+      } finally {
+        Module._free(dataPtr);
+      }
+    } else {
+      throw new FacebetterError('Resource must be a string path or Uint8Array data');
+    }
+  }
+
+  /**
+   * Registers a sticker from a file path or data
+   * @param {string} stickerId - Unique identifier for the sticker
+   * @param {string|Uint8Array} resource - Path to .fbd file or Uint8Array data
+   */
+  registerSticker(stickerId, resource) {
+    this._ensureInitialized();
+    const Module = this._getWasmModule();
+
+    if (typeof resource === 'string') {
+      const result = Module.ccall(
+        'RegisterStickerPath',
+        'number',
+        ['number', 'string', 'string'],
+        [this.enginePtr, stickerId, resource]
+      );
+      checkResult(result, `Failed to register sticker path: ${stickerId}`);
+    } else if (resource instanceof Uint8Array) {
+      const dataPtr = Module._malloc(resource.length);
+      Module.HEAPU8.set(resource, dataPtr);
+      try {
+        const result = Module.ccall(
+          'RegisterStickerData',
+          'number',
+          ['number', 'string', 'number', 'number'],
+          [this.enginePtr, stickerId, dataPtr, resource.length]
+        );
+        checkResult(result, `Failed to register sticker data: ${stickerId}`);
+      } finally {
+        Module._free(dataPtr);
+      }
+    } else {
+      throw new FacebetterError('Resource must be a string path or Uint8Array data');
+    }
+  }
+
+  /**
+   * Unregisters a specific filter
+   * @param {string} filterId - Filter ID to unregister
+   */
+  unregisterFilter(filterId) {
+    this._ensureInitialized();
+    const Module = this._getWasmModule();
+    const result = Module.ccall(
+      'UnregisterFilter',
+      'number',
+      ['number', 'string'],
+      [this.enginePtr, filterId]
+    );
+    checkResult(result, `Failed to unregister filter: ${filterId}`);
+  }
+
+  /**
+   * Unregisters all filters
+   */
+  unregisterAllFilters() {
+    this._ensureInitialized();
+    const Module = this._getWasmModule();
+    const result = Module.ccall(
+      'UnregisterAllFilters',
+      'number',
+      ['number'],
+      [this.enginePtr]
+    );
+    checkResult(result, 'Failed to unregister all filters');
+  }
+
+  /**
+   * Unregisters a specific sticker
+   * @param {string} stickerId - Sticker ID to unregister
+   */
+  unregisterSticker(stickerId) {
+    this._ensureInitialized();
+    const Module = this._getWasmModule();
+    const result = Module.ccall(
+      'UnregisterSticker',
+      'number',
+      ['number', 'string'],
+      [this.enginePtr, stickerId]
+    );
+    checkResult(result, `Failed to unregister sticker: ${stickerId}`);
+  }
+
+  /**
+   * Unregisters all stickers
+   */
+  unregisterAllStickers() {
+     this._ensureInitialized();
+     const Module = this._getWasmModule();
+     const result = Module.ccall(
+       'UnregisterAllStickers',
+       'number',
+       ['number'],
+       [this.enginePtr]
+     );
+     checkResult(result, 'Failed to unregister all stickers');
+   }
+ 
+   /**
+    * Gets the list of registered filter IDs
+    * @returns {string[]} Array of registered filter IDs
+    */
+   getRegisteredFilters() {
+     this._ensureInitialized();
+     const Module = this._getWasmModule();
+     const jsonStr = Module.ccall(
+       'GetRegisteredFilters',
+       'string',
+       ['number'],
+       [this.enginePtr]
+     );
+     try {
+       return JSON.parse(jsonStr || '[]');
+     } catch (e) {
+       console.error('Failed to parse registered filters JSON:', e);
+       return [];
+     }
+   }
+ 
+   /**
+    * Gets the list of registered sticker IDs
+    * @returns {string[]} Array of registered sticker IDs
+    */
+   getRegisteredStickers() {
+     this._ensureInitialized();
+     const Module = this._getWasmModule();
+     const jsonStr = Module.ccall(
+       'GetRegisteredStickers',
+       'string',
+       ['number'],
+       [this.enginePtr]
+     );
+     try {
+       return JSON.parse(jsonStr || '[]');
+     } catch (e) {
+       console.error('Failed to parse registered stickers JSON:', e);
+       return [];
+     }
+   }
+ 
+   /**
+    * Internal method to set beauty parameters
    * @private
    */
   _setBeautyParam(functionName, param, value) {
@@ -873,9 +1109,10 @@ class BeautyEffectEngine {
    * @param {number} width - Image width (required if input is Uint8ClampedArray)
    * @param {number} height - Image height (required if input is Uint8ClampedArray)
    * @param {number} frameType - Frame type (use FrameType enum, default: FrameType.Video)
+   * @param {number} mirrorMode - Mirror mode applied to input before processing (MirrorMode enum, default: MirrorMode.None)
    * @returns {ImageData} Processed image data
    */
-  processImage(input, width, height, frameType = FrameType$1.Video) {
+  processImage(input, width, height, frameType = FrameType$1.Video, mirrorMode = MirrorMode$1.None) {
     this._ensureInitialized();
     const imageData = this._platformAPI.toImageData(input, width, height);
     const Module = this._getWasmModule();
@@ -893,7 +1130,7 @@ class BeautyEffectEngine {
       const result = Module.ccall(
         'ProcessImageRGBA',
         'number',
-        ['number', 'number', 'number', 'number', 'number', 'number', 'number'],
+        ['number', 'number', 'number', 'number', 'number', 'number', 'number', 'number'],
         [
           this.enginePtr,
           this.srcBufferPtr,
@@ -901,7 +1138,8 @@ class BeautyEffectEngine {
           imageData.height,
           imageData.width * 4,
           this.dstBufferPtr,
-          frameType
+          frameType,
+          mirrorMode
         ]
       );
 
@@ -933,13 +1171,15 @@ class BeautyEffectEngine {
    * @param {number} height - Texture height
    * @param {number} stride - Row stride (usually width * 4)
    * @param {number} [frameType] - Frame type (FrameType.Image / FrameType.Video)
+   * @param {number} [mirrorMode] - Mirror mode (MirrorMode enum; texture path does not support mirror, param reserved)
    * @returns {number} Processed texture handle (GL_TEXTURE_2D, uint32)
    */
   processTexture(textureHandle,
                  width,
                  height,
                  stride,
-                 frameType = FrameType$1.Video) {
+                 frameType = FrameType$1.Video,
+                 mirrorMode = MirrorMode$1.None) {
     this._ensureInitialized();
     if (!textureHandle || width <= 0 || height <= 0 || stride <= 0) {
       throw new FacebetterError('Invalid textureHandle or dimensions for processTexture');
@@ -951,14 +1191,15 @@ class BeautyEffectEngine {
       const result = Module.ccall(
         'ProcessImageTexture',
         'number',
-        ['number', 'number', 'number', 'number', 'number', 'number'],
+        ['number', 'number', 'number', 'number', 'number', 'number', 'number'],
         [
           this.enginePtr,
           textureHandle,
           width,
           height,
           stride,
-          frameType
+          frameType,
+          mirrorMode
         ]
       );
 
@@ -1045,15 +1286,6 @@ class BeautyEffectEngine {
     return this._offscreenCanvas;
   }
 
-  /**
-   * Internal method for online authentication (Deprecated: logic moved to WASM layer)
-   * @private
-   */
-  async _verifyAppKeyOnline(appId, appKey) {
-    // This method is now deprecated as logic is moved to WASM layer via Module.onOnlineAuth
-    return null;
-  }
-
 }
 
 /**
@@ -1105,77 +1337,6 @@ function toImageData(source, width, height) {
   throw new FacebetterError('Unsupported image source type');
 }
 
-/**
- * Gets User-Agent string for web platform
- * @returns {string} User-Agent string
- */
-function getUserAgentString() {
-  return 'FB/1.0 (web; wasm32)';
-}
-
-/**
- * Generates HMAC-SHA256 signature (browser version)
- * @param {string} key - HMAC key (app_key)
- * @param {string} data - Data to sign (timestamp string)
- * @returns {Promise<string>} Promise that resolves with hex-encoded signature
- */
-async function generateHMACSignature(key, data) {
-  const encoder = new TextEncoder();
-  const keyData = encoder.encode(key);
-  const messageData = encoder.encode(data);
-
-  const cryptoKey = await crypto.subtle.importKey(
-    'raw',
-    keyData,
-    { name: 'HMAC', hash: 'SHA-256' },
-    false,
-    ['sign']
-  );
-
-  const signature = await crypto.subtle.sign('HMAC', cryptoKey, messageData);
-
-  // Convert to hex string
-  const hashArray = Array.from(new Uint8Array(signature));
-  const hashHex = hashArray.map(b => b.toString(16).padStart(2, '0')).join('');
-  return hashHex;
-}
-
-/**
- * Calls online_auth API to verify app_key (browser version)
- * @param {string} appId - Application ID
- * @param {string} appKey - Application key
- * @returns {Promise<Object>} Promise that resolves with response data
- */
-async function verifyAppKeyOnline(appId, appKey) {
-  try {
-    const timestamp = Math.floor(Date.now() / 1000);
-    const timestampStr = timestamp.toString();
-    const hmacSignature = await generateHMACSignature(appKey, timestampStr);
-
-    const requestBody = {
-      p_app_id: appId,
-      p_hmac_signature: hmacSignature,
-      p_timestamp: timestamp,
-      p_user_agent: getUserAgentString()
-    };
-
-    const response = await fetch('https://facebetter.pixpark.net/rest/v1/rpc/online_auth_v2', {
-      method: 'POST',
-      headers: {
-        'Content-Type': 'application/json',
-        'User-Agent': getUserAgentString()
-      },
-      body: JSON.stringify(requestBody)
-    });
-
-    const responseData = await response.json();
-    return responseData;
-  } catch (error) {
-    console.error('Online auth request failed:', error);
-    return null;
-  }
-}
-
 /**
  * ESM Entry Point
  * For Vue/React/Vite/Webpack (ES Module)
@@ -1317,7 +1478,6 @@ const platformAPI = {
   getWasmModule,
   getWasmBuffer,
   toImageData: toImageData,
-  verifyAppKeyOnline: verifyAppKeyOnline,
   ensureGPUPixelCanvas,
   cleanupGPUPixelCanvas
 };
@@ -1344,6 +1504,7 @@ const MakeupParam = MakeupParam$1;
 const ChromaKeyParam = ChromaKeyParam$1;
 const BackgroundMode = BackgroundMode$1;
 const FrameType = FrameType$1;
+const MirrorMode = MirrorMode$1;
 const VirtualBackgroundOptions = VirtualBackgroundOptions$1;
 
 // Default export
@@ -1355,5 +1516,5 @@ var index = {
   loadWasmModule
 };
 
-export { BackgroundMode, BasicParam, ESMBeautyEffectEngine as BeautyEffectEngine, BeautyType, ChromaKeyParam, EngineConfig, FacebetterError, FrameType, MakeupParam, ReshapeParam, VirtualBackgroundOptions, createBeautyEffectEngine, index as default, getWasmBuffer, getWasmModule, loadWasmModule };
+export { BackgroundMode, BasicParam, ESMBeautyEffectEngine as BeautyEffectEngine, BeautyType, ChromaKeyParam, EngineConfig, FacebetterError, FrameType, MakeupParam, MirrorMode, ReshapeParam, VirtualBackgroundOptions, createBeautyEffectEngine, index as default, getWasmBuffer, getWasmModule, loadWasmModule };
 //# sourceMappingURL=facebetter.esm.js.map