API Reference

SDK 2.0.0. Namespace facebetter. Headers: facebetter/beauty_effect_engine.h, beauty_params.h, image_frame.h, type_defines.h. Style / color / reshape enums: Parameter enums. Auth: Auth & License.

Logging

`LogLevel`

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

`LogConfig`

Field	Default	Description
`console_enabled`	`false`	stdout
`file_enabled`	`false`	write a file
`level`	`Info`	minimum level
`file_name`	`""`	path when `file_enabled` is true

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

Engine

`EngineConfig`

Field	Description
`app_id`	Dashboard app ID (online v2 auth with `app_key`)
`app_key`	Dashboard app key
`resource_path`	Path to the `resource.fbd` file (required on desktop)
`license_token`	License token string, `{token}` JSON, or offline `.lic` contents
`external_context`	`false`: SDK-managed OpenGL context. `true`: caller’s current context

Auth priority: if license_token is non-empty, validate that token locally and skip app_id + app_key network auth. Otherwise use app_id + app_key against /facebetter/v2/auth.

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

`BeautyEffectEngine`

Non-copyable. Create with Create; destroy by releasing the shared_ptr.

`SetLogConfig` (static)

static int SetLogConfig(const LogConfig& config);

Call before Create. Returns 0 on success.

`Create` (static)

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

Returns nullptr on failure.

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

Skin

Intensities [0.0, 1.0] unless noted. 0 is off. Returns 0 on success.

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 SetSharpening(float intensity) = 0;
virtual int SetRosiness(float intensity) = 0;
virtual int SetBeautySkinOnly(bool enabled) = 0;

SetBeautySkinOnly(true) applies smoothing / whitening / etc. only on detected skin. Style enums: Parameter enums.

Reshape

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

intensity is [-1.0, 1.0]. 0 is off. Positive / negative are opposite directions. Full list: Parameter enums.

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

Body reshape

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

intensity is [0.0, 1.0]. 0 is off. Requires resource_body.fbd (sibling of resource.fbd, or AddResourcePack). Full list: Parameter enums. Packs: Optional resource packs.

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

Makeup

Each effect has intensity plus Style (mask) and/or Color (tint). Lipstick: Color only. Pupil: Color only. Contour: Style only.

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;

Values: Parameter enums.

Chroma key

Mask for virtual background. Fill is still SetVirtualBackgroundBlur / SetVirtualBackground. With no fill, the keyed region is transparent. ClearChromaKey() restores portrait segmentation.

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 background

virtual int SetVirtualBackgroundBlur(float level) = 0;  // [0, 1]; 0 clears fill
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. Path must be non-empty. Bytes overload is encoded image data.

Filter (LUT `.fbd`)

GPU LUT is created on the next ProcessImage. No register / ID API.

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]

Sticker (`.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;

Load optional packs first (resource_3d.fbd before 3D stickers, resource_body.fbd before body reshape). See Optional resource packs.

Stats, callbacks, process

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;

Set image_frame->type to FrameType::Image or FrameType::Video (default). Output format tracks input when possible. Returns nullptr on failure.

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

Callbacks and events

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

Code	Meaning
`0`	License success
`1`	License failed
`100`	Init complete
`101`	Init failed

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

on_face_landmarks may run every processed frame (empty if no face).

Image

`Format`

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

`Rotation`

enum class Rotation {
  Rotation_0, Rotation_90, Rotation_180, Rotation_270  // clockwise
};

`FrameType`

enum class FrameType {
  Image = 0,  // still / photo
  Video = 1   // stream (default)
};

Set on ImageFrame::type.

`ImageFrame`

Not copyable. Not thread-safe. Factories

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

Prefer dedicated YUV factories over Create for multi-plane formats. Operations

int Rotate(Rotation rotation);
int Mirror(const std::string& mode);       // "horizontal" | "vertical" | "both"
void SetMirror(const std::string& mode);   // applied inside ProcessImage; "" clears
std::shared_ptr<ImageFrame> Convert(Format format) const;
int ToFile(const std::string& path, int quality = 90) const;

Accessors: Width(), Height(), Stride(), Size(), GetFormat(), Data(), DataY/U/V(), StrideY/U/V(), DataUV(), StrideUV(), Texture(), Buffer(), MirrorHorizontal(), MirrorVertical(). Public field: FrameType type = FrameType::Video.

Detection types

struct Point2d { float x; float y; };  // normalized [0, 1]
struct Rect { float x, y, width, height; };  // normalized

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

Error codes

Typical int returns:

Code	Meaning
`0`	OK
`-1`	Invalid argument
`-2`	Not initialized
`-3`	License
`-4`	Unsupported
`-5`	I/O
`-6`	No slot
`-7`	Process
`-8`	Out of memory

Notes

Thread safety: serialize ProcessImage and mutating calls on one thread (or the GL thread if external_context).
Lifetime: factory methods return std::shared_ptr.
Pixel pointers from Data() are const — do not write through them.
SetRenderView is iOS / macOS only.
Windows binary: link facebetter.lib, load facebetter.dll at runtime.

Introduction

Android

iOS

macOS

Windows

Linux

Web

Logging

`LogLevel`

`LogConfig`

Engine

`EngineConfig`

`BeautyEffectEngine`

`SetLogConfig` (static)

`Create` (static)

Skin

Reshape

Body reshape

Makeup

Chroma key

Virtual background

Filter (LUT `.fbd`)

Sticker (`.fbd`)

Stats, callbacks, process

`EngineStats`

Callbacks and events

Image

`Format`

`Rotation`

`FrameType`

`ImageFrame`

Detection types

Error codes

Notes

​Logging

​LogLevel

​LogConfig

​Engine

​EngineConfig

​BeautyEffectEngine

​SetLogConfig (static)

​Create (static)

​Skin

​Reshape

​Body reshape

​Makeup

​Chroma key

​Virtual background

​Filter (LUT .fbd)

​Sticker (.fbd)

​Stats, callbacks, process

​EngineStats

​Callbacks and events

​Image

​Format

​Rotation

​FrameType

​ImageFrame

​Detection types

​Error codes

​Notes

Logging

`LogLevel`

`LogConfig`

Engine

`EngineConfig`

`BeautyEffectEngine`

`SetLogConfig` (static)

`Create` (static)

Skin

Reshape

Body reshape

Makeup

Chroma key

Virtual background

Filter (LUT `.fbd`)

Sticker (`.fbd`)

Stats, callbacks, process

`EngineStats`

Callbacks and events

Image

`Format`

`Rotation`

`FrameType`

`ImageFrame`

Detection types

Error codes

Notes