API リファレンス

SDK 2.0.0。名前空間は facebetter。ヘッダー: facebetter/beauty_effect_engine.h、beauty_params.h、image_frame.h、type_defines.h。スタイル / 色番号 / リシェイプ列挙: パラメータ列挙。認証: 認証とライセンス。

ログ

`LogLevel`

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

`LogConfig`

フィールド	デフォルト	説明
`console_enabled`	`false`	stdout へ出力
`file_enabled`	`false`	ファイルへ書き込み
`level`	`Info`	最低レベル
`file_name`	`""`	`file_enabled` が true のときのパス

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

エンジン

`EngineConfig`

フィールド	説明
`app_id`	コンソールのアプリ ID（`app_key` と合わせてオンライン v2 認証）
`app_key`	コンソールのアプリキー
`resource_path`	`resource.fbd` ファイルパス（デスクトップでは必須）
`license_token`	ライセンストークン、`{token}` JSON、またはオフライン `.lic` の内容

認証の優先順位: license_token が空でなければそのトークンをローカル検証し、app_id + app_key ではネット接続しません。それ以外は app_id + app_key で /facebetter/v2/auth をリクエストします。

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

`BeautyEffectEngine`

コピー不可。Create で作成し、shared_ptr を解放すると破棄されます。

`SetLogConfig`（静的）

static int SetLogConfig(const LogConfig& config);

Create の前に呼び出してください。成功時は 0 を返します。

`Create`（静的）

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

失敗時は nullptr を返します。

EngineConfig cfg;
cfg.app_id = "your_app_id";
cfg.app_key = "your_app_key";
cfg.resource_path = "resource/resource.fbd";
auto engine = BeautyEffectEngine::Create(cfg);

肌

強度のデフォルト範囲は [0.0, 1.0]、0 はオフです。成功時は 0 を返します。

virtual int SetSmoothing(float intensity) = 0;
virtual int SetSmoothingStyle(beauty_params::SmoothingStyle style) = 0;
virtual int SetWhitening(float intensity) = 0;
virtual int SetWhiteningStyle(beauty_params::WhiteningStyle style) = 0;
virtual int SetRosiness(float intensity) = 0;
virtual int SetBrightness(float intensity) = 0;
virtual int SetContrast(float intensity) = 0;
virtual int SetSaturation(float intensity) = 0;
virtual int SetColorTemperature(float intensity) = 0;
virtual int SetColorTint(float intensity) = 0;
virtual int SetClarity(float intensity) = 0;
virtual int SetBeautySkinOnly(bool enabled) = 0;

SetBeautySkinOnly(true) のとき、スムージング / 美白などは検出した肌にのみ作用します。スタイル列挙: パラメータ列挙。

リシェイプ

virtual int SetReshape(beauty_params::Reshape param, float intensity) = 0;

intensity は [-1.0, 1.0] です。0 でオフ。正負は反対方向です。完全なリスト: パラメータ列挙。

engine->SetReshape(Reshape::FaceThin, 0.4f);

ボディリシェイプ

virtual int SetBodyReshape(beauty_params::BodyReshape param, float intensity) = 0;

intensity は [0.0, 1.0]。0 はオフ。resource_body.fbd が必要です（resource.fbd と同じ場所、または AddResourcePack）。パラメータ列挙、オプションリソースパック。

engine->SetBodyReshape(BodyReshape::WaistSlim, 0.4f);

メイク

各効果には強度があり、Style（マスク）および / または Color（着色）があります。口紅は Color のみ、瞳は Color のみ、コントアは Style のみです。

virtual int SetLipstick(float intensity) = 0;
virtual int SetLipstickColor(beauty_params::LipstickColor color) = 0;

virtual int SetBlush(float intensity) = 0;
virtual int SetBlushStyle(beauty_params::BlushStyle style) = 0;
virtual int SetBlushColor(beauty_params::BlushColor color) = 0;

virtual int SetContour(float intensity) = 0;
virtual int SetContourStyle(beauty_params::ContourStyle style) = 0;

virtual int SetEyeShadow(float intensity) = 0;
virtual int SetEyeShadowStyle(beauty_params::EyeShadowStyle style) = 0;
virtual int SetEyeShadowColor(beauty_params::EyeShadowColor color) = 0;

virtual int SetEyeLiner(float intensity) = 0;
virtual int SetEyeLinerStyle(beauty_params::EyeLinerStyle style) = 0;
virtual int SetEyeLinerColor(beauty_params::EyeLinerColor color) = 0;

virtual int SetEyebrow(float intensity) = 0;
virtual int SetEyebrowStyle(beauty_params::EyebrowStyle style) = 0;
virtual int SetEyebrowColor(beauty_params::EyebrowColor color) = 0;

virtual int SetEyelash(float intensity) = 0;
virtual int SetEyelashStyle(beauty_params::EyelashStyle style) = 0;
virtual int SetEyelashColor(beauty_params::EyelashColor color) = 0;

virtual int SetPupil(float intensity) = 0;
virtual int SetPupilColor(beauty_params::PupilColor color) = 0;

値: パラメータ列挙。

クロマキー

バーチャル背景のマスクとして使います。塗りつぶしは引き続き SetVirtualBackgroundBlur / SetVirtualBackground で制御します。塗りつぶしがないとき、キーアウト領域は透明です。ClearChromaKey() は人物セグメンテーションに戻します。

virtual int SetChromaKey(beauty_params::ChromaKeyColor color) = 0;
virtual int ClearChromaKey() = 0;
virtual int SetChromaKeySimilarity(float value) = 0;   // [0, 1]
virtual int SetChromaKeySmoothness(float value) = 0;   // [0, 1]
virtual int SetChromaKeyDesaturation(float value) = 0; // [0, 1]

ChromaKeyColor: Green = 0、Blue、Red。

バーチャル背景

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

PNG / JPEG。パスは空にできません。バイトオーバーロードはエンコード済み画像データです。

フィルター（LUT `.fbd`）

GPU LUT は次の ProcessImage で作成されます。登録 / ID インターフェースはありません。

virtual int SetFilter(const std::string& fbd_file_path) = 0;
virtual int SetFilter(const std::vector<uint8_t>& fbd_data) = 0;
virtual int ClearFilter() = 0;
virtual int SetFilterIntensity(float intensity) = 0;  // [0, 1]

ステッカー（`.fbd`）

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

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

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

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

image_frame->type を FrameType::Image または FrameType::Video（デフォルト）に設定します。出力形式はできるだけ入力と一致します。失敗時は nullptr を返します。

input->type = FrameType::Video;
auto output = engine->ProcessImage(input);

`EngineStats`

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;
};

コールバックとイベント

enum class EngineEventCode {
  LicenseValidationSuccess = 0,
  LicenseValidationFailed = 1,
  EngineInitializationComplete = 100,
  EngineInitializationFailed = 101,
};

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

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

画像

`Format`

enum class Format {
  I420, NV12, NV21, BGRA, RGBA, BGR, RGB, Texture
};

`Rotation`

enum class Rotation {
  Rotation_0, Rotation_90, Rotation_180, Rotation_270  // 時計回り
};

`FrameType`

enum class FrameType {
  Image = 0,  // 静止画 / 写真
  Video = 1   // 動画ストリーム（デフォルト）
};

ImageFrame::type に設定します。

`ImageFrame`

コピー不可、スレッドセーフではありません。 ファクトリメソッド

static std::shared_ptr<ImageFrame> CreateWithFile(const std::string& file_path);
static std::shared_ptr<ImageFrame> Create(
    const uint8_t* data, int width, int height, Format format);
static std::shared_ptr<ImageFrame> CreateWithRGBA(
    const uint8_t* data, int width, int height, int stride);
static std::shared_ptr<ImageFrame> CreateWithBGRA(
    const uint8_t* data, int width, int height, int stride,
    bool copy_data = false);
static std::shared_ptr<ImageFrame> CreateWithRGB(
    const uint8_t* data, int width, int height, int stride);
static std::shared_ptr<ImageFrame> CreateWithBGR(
    const uint8_t* data, int width, int height, int stride);
static std::shared_ptr<ImageFrame> CreateWithI420(
    int width, int height,
    const uint8_t* dataY, int strideY,
    const uint8_t* dataU, int strideU,
    const uint8_t* dataV, int strideV);
static std::shared_ptr<ImageFrame> CreateWithNV12(
    int width, int height,
    const uint8_t* dataY, int strideY,
    const uint8_t* dataUV, int strideUV);
static std::shared_ptr<ImageFrame> CreateWithNV21(
    int width, int height,
    const uint8_t* dataY, int strideY,
    const uint8_t* dataUV, int strideUV);
static std::shared_ptr<ImageFrame> CreateWithTexture(
    uint32_t texture, int width, int height, int stride,
    bool external_oes = false, const float* tex_matrix_4x4 = nullptr);
void SetGlRenderTarget(uint32_t texture);

複数プレーンの YUV は専用ファクトリを使い、汎用 Create は使わないでください。操作

int Rotate(Rotation rotation);
int Mirror(MirrorMode mode);                   // Horizontal | Vertical | Both
void SetMirror(MirrorMode mode);               // ProcessImage 内で適用。None でクリア
std::shared_ptr<ImageFrame> Convert(Format format) const;
int ToFile(const std::string& path, int quality = 90) const;

Rotate、Mirror、SetMirror が変えるのは CPU ピクセルフレームだけです（RGBA、RGB、YUV、画像ファイル）。OpenGL テクスチャと D3D11 テクスチャは変換しません。これらは正立にしてからフレームを作ってください。 アクセサ: Width()、Height()、Stride()、Size()、GetFormat()、Data()、DataY/U/V()、StrideY/U/V()、DataUV()、StrideUV()、Texture()。公開フィールド: FrameType type = FrameType::Video。

エラーコード

典型的な int 戻り値:

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

注意事項

GL コンテキストがカレントなスレッドでエンジンを作成して処理します。入出力テクスチャはそのコンテキストに属している必要があります。CPU フレームに呼び出し側の GL コンテキストは不要です。設定にコンテキスト用のフラグはありません。
ライフサイクル: ファクトリメソッドは std::shared_ptr を返します。
Data() ポインタは読み取り専用です。書き込まないでください。
SDK に SetRenderView はありません。ProcessImage の出力はアプリ側で描画してください。

はじめに

Android

iOS

macOS

Windows

Linux

Web

ログ

`LogLevel`

`LogConfig`

エンジン

`EngineConfig`

`BeautyEffectEngine`

`SetLogConfig`（静的）

`Create`（静的）

肌

リシェイプ

ボディリシェイプ

メイク

クロマキー

バーチャル背景

フィルター（LUT `.fbd`）

ステッカー（`.fbd`）

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

`EngineStats`

コールバックとイベント

画像

`Format`

`Rotation`

`FrameType`

`ImageFrame`

エラーコード

注意事項

​ログ

​LogLevel

​LogConfig

​エンジン

​EngineConfig

​BeautyEffectEngine

​SetLogConfig（静的）

​Create（静的）

​肌

​リシェイプ

​ボディリシェイプ

​メイク

​クロマキー

​バーチャル背景

​フィルター（LUT .fbd）

​ステッカー（.fbd）

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

​EngineStats

​コールバックとイベント

​画像

​Format

​Rotation

​FrameType

​ImageFrame

​エラーコード

​注意事項

ログ

`LogLevel`

`LogConfig`

エンジン

`EngineConfig`

`BeautyEffectEngine`

`SetLogConfig`（静的）

`Create`（静的）

肌

リシェイプ

ボディリシェイプ

メイク

クロマキー

バーチャル背景

フィルター（LUT `.fbd`）

ステッカー（`.fbd`）

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

`EngineStats`

コールバックとイベント

画像

`Format`

`Rotation`

`FrameType`

`ImageFrame`

エラーコード

注意事項