API 参考

SDK 2.0.0。命名空间 facebetter。与 Windows 同一套公共 C++ API。头文件：facebetter/*.h。枚举见参数枚举。鉴权见授权与许可。

Linux 说明

分发 libfacebetter.so。设置 LD_LIBRARY_PATH、rpath 或 ldconfig。
用 ./scripts/build_linux.sh 编译 SDK（产物在 build/linux/release），或使用 CMake。
resource_path 必须是 resource.fbd 文件。
没有 SetRenderView。
external_context = true 使用调用线程的当前 GL 上下文（GLFW / EGL / OSMesa）。

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 / `{token}` JSON / `.lic` — 非空时优先
`external_context`	`false`：SDK 管理 OpenGL；`true`：调用方上下文

struct EngineConfig {
  std::string app_id;
  std::string app_key;
  std::string resource_path;
  std::string license_token;
  bool external_context = false;
};

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 SetSharpening(float intensity);
int SetRosiness(float intensity);
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;
};

事件

码	含义
`0`	授权成功
`1`	授权失败
`100`	初始化完成
`101`	初始化失败

struct EngineCallbacks {
  std::function<void(const std::vector<FaceDetectionResult>&)> on_face_landmarks;
  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("horizontal"|"vertical"|"both")、SetMirror、Convert、ToFile。 访问器： Width/Height/Stride/Size/GetFormat/Data、YUV 平面、Texture()、Buffer()。字段：FrameType type。

struct FaceDetectionResult {
  Rect rect;
  std::vector<Point2d> key_points;  // 111
  std::vector<float> visibility;
  int face_id = -1;
  float score = 0.0f;
  float pitch, roll, yaw;
};

错误码

码	含义
`0`	成功
`-1`	参数非法
`-2`	未初始化
`-3`	授权
`-4`	不支持
`-5`	I/O
`-6`	无槽位
`-7`	处理失败
`-8`	内存不足

将 ProcessImage 串行化到同一线程。Data() 像素指针只读。

产品介绍

Android

iOS

macOS

Windows

Linux

Web

Linux 说明

日志

引擎

`EngineConfig`

皮肤

美型

美体

美妆

色度键与虚拟背景

滤镜与贴纸

统计、回调、处理

事件

图像

错误码

​Linux 说明

​日志

​引擎

​EngineConfig

​皮肤

​美型

​美体

​美妆

​色度键与虚拟背景

​滤镜与贴纸

​统计、回调、处理

​事件

​图像

​错误码

Linux 说明

日志

引擎

`EngineConfig`

皮肤

美型

美体

美妆

色度键与虚拟背景

滤镜与贴纸

统计、回调、处理

事件

图像

错误码