Implement Beauty

This page matches SDK 2.0.0. Auth: Auth & License. Makeup / reshape enums: Parameter enums.

Add SDK dependency

Method A: CocoaPods (recommended)

target 'YourTargetName' do
  pod 'Facebetter', '2.0.0'
end

pod install

Xcode 15+ compilation errorIf you are using Xcode 15 or later, you might encounter a Sandbox: rsync.samba deny(1) error. This is caused by User Script Sandboxing.Solution:

Select your Project in Xcode.
Open Build Settings.
Search for ENABLE_USER_SCRIPT_SANDBOXING.
Change the value from Yes to No.

Method B: Manual framework

Download the SDK from Download, copy Facebetter.framework into the project, and embed the dynamic library with Embed & Sign.

Permissions

Sandboxed Mac apps that use online appId / appKey must allow outgoing network:

Camera (optional): NSCameraUsageDescription in Info.plist.

Import

#import <Facebetter/FBBeautyEffectEngine.h>

AppKit types (NSImage) require #import <AppKit/AppKit.h> (usually via the prefix header or the engine header on macOS).

Log configuration

Logging is off by default. Call setLogConfig: before creating the engine.

FBLogConfig *logConfig = [[FBLogConfig alloc] init];
logConfig.level = FBLogLevel_Info;
logConfig.consoleEnabled = YES;
logConfig.fileEnabled = YES;
logConfig.fileName = @"/path/in/container/facebetter.log";
[FBBeautyEffectEngine setLogConfig:logConfig];

Create the engine

Bind the macOS Bundle ID, then pass either licenseToken or appId + appKey. See Get AppID and AppKey and Auth & License. Priority: if licenseToken is non-empty (license token string, {token} JSON, or .lic contents), the SDK validates it locally. Otherwise it uses appId + appKey against /facebetter/v2/auth.

FBEngineConfig *engineConfig = [[FBEngineConfig alloc] init];
engineConfig.appId = @"your appId";
engineConfig.appKey = @"your appKey";
// engineConfig.licenseToken = @"your license token";
engineConfig.externalContext = NO;

self.beautyEffectEngine = [FBBeautyEffectEngine createEngineWithConfig:engineConfig];
if (self.beautyEffectEngine == nil) {
  NSLog(@"Failed to create beauty engine");
  return;
}

createEngineWithConfig: returns an instance, not a singleton. For command-line tools without a Bundle ID, bind the process name in the Dashboard.

Skin beauty

Intensity is typically [0.0, 1.0]. Style enums: Parameter enums.

[self.beautyEffectEngine setSmoothing:0.5f];
[self.beautyEffectEngine setSmoothingStyle:FBSmoothingStyle_Natural];
[self.beautyEffectEngine setWhitening:0.3f];
[self.beautyEffectEngine setWhiteningStyle:FBWhiteningStyle_ColdWhite];
[self.beautyEffectEngine setSharpening:0.2f];
[self.beautyEffectEngine setRosiness:0.15f];
[self.beautyEffectEngine setBeautySkinOnly:YES];

Face reshape

setReshape:intensity: range is [-1.0, 1.0]. 0 is off. Parameters: FBReshape_FaceThin … FBReshape_BrowThickness (0–25). Meanings: Parameter enums.

[self.beautyEffectEngine setReshape:FBReshape_FaceThin intensity:0.4f];
[self.beautyEffectEngine setReshape:FBReshape_EyeSize intensity:0.2f];

Body reshape

setBodyReshape:intensity: range is [0.0, 1.0]. 0 is off. Register resource_body.fbd with addResourcePack: first. Parameters: FBBodyReshape_BodySlim … FBBodyReshape_TorsoLong (0–8). See Parameter enums and Optional resource packs.

NSString *bodyPack = [[NSBundle mainBundle] pathForResource:@"resource_body" ofType:@"fbd"];
[self.beautyEffectEngine addResourcePack:bodyPack];
[self.beautyEffectEngine setBodyReshape:FBBodyReshape_WaistSlim intensity:0.4f];
[self.beautyEffectEngine setBodyReshape:FBBodyReshape_LegStretch intensity:0.3f];
[self.beautyEffectEngine setBodyReshape:FBBodyReshape_TorsoLong intensity:0.3f];

Makeup

Intensity, shape, and color are separate calls. Full presets: Parameter enums.

[self.beautyEffectEngine setLipstick:0.5f];
[self.beautyEffectEngine setLipstickColor:FBLipstickColor_Rouge];

[self.beautyEffectEngine setBlush:0.4f];
[self.beautyEffectEngine setBlushStyle:FBBlushStyle_SunKissed];
[self.beautyEffectEngine setBlushColor:FBBlushColor_CoralPink];

[self.beautyEffectEngine setContour:0.35f];
[self.beautyEffectEngine setContourStyle:FBContourStyle_Natural];

[self.beautyEffectEngine setEyeShadow:0.4f];
[self.beautyEffectEngine setEyeShadowStyle:FBEyeShadowStyle_Soft];
[self.beautyEffectEngine setEyeShadowColor:FBEyeShadowColor_Plum];

[self.beautyEffectEngine setEyeLiner:0.4f];
[self.beautyEffectEngine setEyeLinerStyle:FBEyeLinerStyle_Classic];
[self.beautyEffectEngine setEyeLinerColor:FBEyeLinerColor_Coffee];

[self.beautyEffectEngine setEyebrow:0.4f];
[self.beautyEffectEngine setEyebrowStyle:FBEyebrowStyle_Natural];
[self.beautyEffectEngine setEyebrowColor:FBEyebrowColor_DarkBrown];

[self.beautyEffectEngine setEyelash:0.4f];
[self.beautyEffectEngine setEyelashStyle:FBEyelashStyle_Classic];
[self.beautyEffectEngine setEyelashColor:FBEyelashColor_Black];

[self.beautyEffectEngine setPupil:0.4f];
[self.beautyEffectEngine setPupilColor:FBPupilColor_Hazel];

Virtual background

[self.beautyEffectEngine setVirtualBackgroundBlur:0.6f];
[self.beautyEffectEngine setVirtualBackground:imagePath];
[self.beautyEffectEngine setVirtualBackgroundWithData:pngOrJpegData];
[self.beautyEffectEngine clearVirtualBackground];

Chroma key replaces the mask only. Fill is still blur or the replacement image.

[self.beautyEffectEngine setChromaKey:FBChromaKeyColor_Green];
[self.beautyEffectEngine setChromaKeySimilarity:0.4f];
[self.beautyEffectEngine setChromaKeySmoothness:0.3f];
[self.beautyEffectEngine setChromaKeyDesaturation:0.2f];
[self.beautyEffectEngine clearChromaKey];

Filters and stickers

Pass a .fbd file path or in-memory bytes.

NSString *filterPath = [[NSBundle mainBundle] pathForResource:@"chuxin" ofType:@"fbd"];
[self.beautyEffectEngine setFilter:filterPath];
[self.beautyEffectEngine setFilterIntensity:0.8f];
[self.beautyEffectEngine clearFilter];
[self.beautyEffectEngine setFilterWithData:filterData];

NSString *stickerPath = [[NSBundle mainBundle] pathForResource:@"cherry" ofType:@"fbd"];
[self.beautyEffectEngine setSticker:stickerPath];
[self.beautyEffectEngine clearSticker];
[self.beautyEffectEngine setStickerWithData:stickerData];

3D stickers need the optional resource_3d.fbd pack (not in the framework). See Optional resource packs:

NSString *packPath = [[NSBundle mainBundle] pathForResource:@"resource_3d" ofType:@"fbd"];
[self.beautyEffectEngine addResourcePack:packPath];
NSString *sticker3dPath = [[NSBundle mainBundle] pathForResource:@"oculos" ofType:@"fbd"];
[self.beautyEffectEngine set3DSticker:sticker3dPath];
[self.beautyEffectEngine clear3DSticker];

Callbacks and stats

FBEngineCallbacks *callbacks = [[FBEngineCallbacks alloc] init];
callbacks.onEngineEvent = ^(FBEngineEventCode code, NSString * _Nullable message) {
  // 0 license OK, 1 license fail, 100 init complete, 101 init fail
  NSLog(@"engine event %ld %@", (long)code, message);
};
callbacks.onFaceLandmarks = ^(NSArray<FBFaceDetectionResult *> * _Nullable results) {
  NSLog(@"faces %lu", (unsigned long)results.count);
};
[self.beautyEffectEngine setCallbacks:callbacks];

FBEngineStats *stats = [self.beautyEffectEngine getStats];
NSLog(@"fps=%.1f avg=%.2fms session=%.1fs",
      stats.fps, stats.avgProcessTimeMs, stats.sessionTimeS);

Process images

FBImageFrame supports I420, NV12, NV21, RGB, RGBA, BGR, BGRA, file, texture, and NSImage.

FBImageFrame *fromFile = [FBImageFrame createWithFile:@"/path/photo.png"];
FBImageFrame *fromRGBA = [FBImageFrame createWithRGBA:data width:width height:height stride:stride];
FBImageFrame *fromNSImage = [FBImageFrame createWithNSImage:nsImage];

Set type then call processImage: (no extra mode argument). Output keeps the input format.

input.type = FBFrameTypeVideo;  // or FBFrameTypeImage
FBImageFrame *output = [self.beautyEffectEngine processImage:input];

FBFrameTypeVideo is for live streams; FBFrameTypeImage is for stills and NSImage.

[input rotate:FBImageRotation90];
[input setMirror:@"horizontal"];
FBImageFrame *rgba = [output convert:FBImageFormatRGBA];
const uint8_t *bytes = [rgba data];
[output toFile:@"/path/out.jpg" quality:90];

YUV planes: dataY, dataU, dataV, dataUV and matching strides.

External texture

Create the engine on the OpenGL thread and set externalContext = YES. Input and output textures must share that context. macOS uses desktop OpenGL 3.2 Core (NSOpenGLContext / CGL), not OpenGL ES.

FBEngineConfig *config = [[FBEngineConfig alloc] init];
config.appId = @"your appId";
config.appKey = @"your appKey";
config.externalContext = YES;
self.engine = [FBBeautyEffectEngine createEngineWithConfig:config];

FBImageFrame *inputFrame = [FBImageFrame createWithTexture:textureId
                                                     width:width
                                                    height:height
                                                    stride:width * 4];
inputFrame.type = FBFrameTypeVideo;
FBImageFrame *outputFrame = [self.engine processImage:inputFrame];
GLuint outputTexture = [outputFrame texture];

For TRTC / Agora / LiveKit: Third-party Integration.

Lifecycle

Keep a strong reference on the NSViewController. Stop the capture session when the view disappears or the window miniaturizes. Nil the engine when the session ends.

- (void)dealloc {
  self.beautyEffectEngine = nil;
}

Introduction

Android

iOS

macOS

Windows

Linux

Web

Add SDK dependency

Method A: CocoaPods (recommended)

Method B: Manual framework

Permissions

Import

Log configuration

Create the engine

Skin beauty

Face reshape

Body reshape

Makeup

Virtual background

Filters and stickers

Callbacks and stats

Process images

External texture

Lifecycle

​Add SDK dependency

​Method A: CocoaPods (recommended)

​Method B: Manual framework

​Permissions

​Import

​Log configuration

​Create the engine

​Skin beauty

​Face reshape

​Body reshape

​Makeup

​Virtual background

​Filters and stickers

​Callbacks and stats

​Process images

​External texture

​Lifecycle

​Related

Add SDK dependency

Method A: CocoaPods (recommended)

Method B: Manual framework

Permissions

Import

Log configuration

Create the engine

Skin beauty

Face reshape

Body reshape

Makeup

Virtual background

Filters and stickers

Callbacks and stats

Process images

External texture

Lifecycle

Related