API リファレンス

SDK 2.0.0。名前空間は facebetter。Windows と同一の公開 C++ API です。ヘッダー: facebetter/*.h。列挙: パラメータ列挙。認証: 認証とライセンス。

Linux の注意点

libfacebetter.so を配布します。LD_LIBRARY_PATH、rpath、または ldconfig を設定してください。
SDK のビルドは ./scripts/build_linux.sh（成果物は build/linux/release）、または CMake です。
resource_path は resource.fbd ファイルである必要があります。
GL コンテキストがカレントなスレッドでエンジンを作成して処理します。入出力テクスチャはそのコンテキストに属している必要があります。CPU フレームに呼び出し側の GL コンテキストは不要です。設定にコンテキスト用のフラグはありません。

target_include_directories(app PRIVATE /path/to/sdk/include)
target_link_libraries(app PRIVATE /path/to/sdk/lib/libfacebetter.so GL)

ログ

enum class LogLevel { Trace = 0, Debug, Info, Warn, Error, Critical };

struct LogConfig {
  bool console_enabled = false;
  bool file_enabled = false;
  LogLevel level = LogLevel::Info;
  std::string file_name = "";
};

static int BeautyEffectEngine::SetLogConfig(const LogConfig& config);

Create の前に SetLogConfig を呼び出してください。

エンジン

`EngineConfig`

フィールド	説明
`app_id` / `app_key`	ネイティブのオンライン v2 認証
`resource_path`	`resource.fbd` ファイルパス（ディレクトリではありません）
`license_token`	トークン / `{token}` JSON / `.lic` — 空でなければ優先

struct EngineConfig {
  std::string app_id;
  std::string app_key;
  std::string resource_path;
  std::string license_token;
};

static std::shared_ptr<BeautyEffectEngine> BeautyEffectEngine::Create(
    const EngineConfig& config);

肌

int SetSmoothing(float intensity);          // [0, 1]
int SetSmoothingStyle(SmoothingStyle style);
int SetWhitening(float intensity);
int SetWhiteningStyle(WhiteningStyle style);
int SetRosiness(float intensity);
int SetBrightness(float intensity);       // [-1, 1], 0 neutral
int SetContrast(float intensity);
int SetSaturation(float intensity);
int SetColorTemperature(float intensity);
int SetColorTint(float intensity);
int SetClarity(float intensity);          // [0, 1]
int SetBeautySkinOnly(bool enabled);

リシェイプ

int SetReshape(Reshape param, float intensity);  // [-1, 1]

完全な Reshape リスト: パラメータ列挙。

ボディリシェイプ

int SetBodyReshape(BodyReshape param, float intensity);  // [0, 1]

BodyReshape の全リスト: パラメータ列挙。resource_body.fbd が必要です。オプションリソースパック。

メイク

int SetLipstick(float);        int SetLipstickColor(LipstickColor);
int SetBlush(float);           int SetBlushStyle(BlushStyle); int SetBlushColor(BlushColor);
int SetContour(float);         int SetContourStyle(ContourStyle);
int SetEyeShadow(float);       int SetEyeShadowStyle(...); int SetEyeShadowColor(...);
int SetEyeLiner(float);        int SetEyeLinerStyle(...);  int SetEyeLinerColor(...);
int SetEyebrow(float);         int SetEyebrowStyle(...);   int SetEyebrowColor(...);
int SetEyelash(float);         int SetEyelashStyle(...);   int SetEyelashColor(...);
int SetPupil(float);           int SetPupilColor(PupilColor);

口紅は Color のみ、瞳は Color のみ、コントアは Style のみです。値: パラメータ列挙。

クロマキーとバーチャル背景

int SetChromaKey(ChromaKeyColor color);  // Green, Blue, Red
int ClearChromaKey();
int SetChromaKeySimilarity(float);
int SetChromaKeySmoothness(float);
int SetChromaKeyDesaturation(float);

int SetVirtualBackgroundBlur(float level);  // [0, 1]；0 で塗りつぶしをクリア
int SetVirtualBackground(const std::string& image_path);
int SetVirtualBackground(const std::vector<uint8_t>& image_data);
int ClearVirtualBackground();

フィルターとステッカー

パスまたはエンコード済み .fbd バイトです。登録 / ID インターフェースはありません。次の ProcessImage の後に反映されます。

int SetFilter(const std::string& fbd_file_path);
int SetFilter(const std::vector<uint8_t>& fbd_data);
int ClearFilter();
int SetFilterIntensity(float intensity);

int SetSticker(const std::string& fbd_file_path);
int SetSticker(const std::vector<uint8_t>& fbd_data);
int ClearSticker();
int AddResourcePack(const std::string& fbd_file_path);
int AddResourcePack(const std::vector<uint8_t>& fbd_data);
int Set3DSticker(const std::string& resource);
int Set3DSticker(const std::vector<uint8_t>& fbd_data);
int Clear3DSticker();

3D ステッカーやボディリシェイプの前に対応するオプションパックを読み込んでください。オプションリソースパック。

統計、コールバック、処理

EngineStats GetStats() const;
int SetCallbacks(const EngineCallbacks& callbacks);
const std::shared_ptr<ImageFrame> ProcessImage(
    const std::shared_ptr<ImageFrame> image_frame);

frame->type を FrameType::Image または FrameType::Video に設定します。

struct EngineStats {
  double fps = 0.0;
  double avg_process_time_ms = 0.0;
  double session_time_s = 0.0;
  size_t gpu_live_textures = 0;
  size_t gpu_live_meshes = 0;
};

イベント

コード	意味
`0`	認証成功
`1`	認証失敗
`100`	初期化完了
`101`	初期化失敗

struct EngineCallbacks {
  std::function<void(int code, const std::string& message)> on_engine_event;
};

画像

enum class Format { I420, NV12, NV21, BGRA, RGBA, BGR, RGB, Texture };
enum class Rotation { Rotation_0, Rotation_90, Rotation_180, Rotation_270 };
enum class FrameType { Image = 0, Video = 1 };

ファクトリ: CreateWithFile、Create、CreateWithRGBA/BGRA/RGB/BGR、CreateWithI420/NV12/NV21、CreateWithTexture。 操作: Rotate、Mirror(MirrorMode::Horizontal|Vertical|Both)、SetMirror、Convert、ToFile。 Rotate、Mirror、SetMirror が変えるのは CPU ピクセルフレームだけです（RGBA、RGB、YUV、画像ファイル）。OpenGL テクスチャは変換しません。テクスチャは正立にしてから渡してください。 アクセサ: Width/Height/Stride/Size/GetFormat/Data、YUV プレーン、Texture()。フィールド: FrameType type。

エラーコード

コード	意味
`0`	成功
`-1`	引数不正
`-2`	未初期化
`-3`	認証
`-4`	非対応
`-5`	I/O
`-6`	処理失敗
`-7`	メモリ不足

ProcessImage は同一スレッドへ直列化してください。Data() のピクセルポインタは読み取り専用です。

はじめに

Android

iOS

macOS

Windows

Linux

Web

Linux の注意点

ログ

エンジン

`EngineConfig`

肌

リシェイプ

ボディリシェイプ

メイク

クロマキーとバーチャル背景

フィルターとステッカー

統計、コールバック、処理

イベント

画像

エラーコード

​Linux の注意点

​ログ

​エンジン

​EngineConfig

​肌

​リシェイプ

​ボディリシェイプ

​メイク

​クロマキーとバーチャル背景

​フィルターとステッカー

​統計、コールバック、処理

​イベント

​画像

​エラーコード

Linux の注意点

ログ

エンジン

`EngineConfig`

肌

リシェイプ

ボディリシェイプ

メイク

クロマキーとバーチャル背景

フィルターとステッカー

統計、コールバック、処理

イベント

画像

エラーコード