visageSDK
API

Table of Contents

The following section provides an overview of key functionalities, gives links to most important classes and relevant sample projects, and lists required libraries to link. The detailed information is found in the documentation of each class, reached through links in this section or links on the side menu, or through class reference.

visage|SDK API is provided in three main libraries:

All listed APIs use neural networks to process and analyze facial images.

Additional configuration file NeuralNet.cfg is provided in Samples/data folder. It allows for specifying the desired backend and number of threads that the runner will use for inference. Following backend values are supported:

If NeuralNet.cfg is not found, backend will default to AUTO and neural network runner will use 1 thread.

More information about configuring neural network runners can be found in VisageTracker Configuration Manual, chapter 3. Configuring neural network runners.

For the NeuralNet.cfg configuration file to be successfully loaded, Samples/data folder, including its subfolders and files, should keep the same hierarchy as it is in distributed visage|SDK package. Specifically, API expects that the file will be in the same folder as vfa, vfr and vft folders within users' applications.

visage|SDK provides additional libraries:

Facial features tracking

Visage tracker tracks multiple faces and facial features in video sequences and outputs 3D head pose, facial expressions, gaze direction, facial feature points and textured 3D face model. The tracker is fully configurable in terms of performance, quality, tracked features and facial actions, as well as other options, allowing in effect a variety of customized trackers suited to different applications. Several common configurations are delivered. Details about configuring the tracker can be found in the VisageTracker Configuration Manual.

Main classes

Face tracking is demonstrated in VisageTrackerDemo and VisageTrackerUnity sample project.

Facial feature detection

The class VisageFeaturesDetector detects faces and facial features in input images. The results are, for each detected face, the 3D head pose, the coordinates of facial feature points, e.g. chin tip, nose tip, lip corners etc. and 3D face model fitted to the face. The results are returned in one or more FaceData objects, one for each detected face.

The FaceDetectDemo sample project demonstrates facial features detection.

Main classes

Facial feature analysis

The class VisageFaceAnalyser contains face analysis algorithms capable of estimating gender and emotion from facial images. For gender estimation it returns estimated gender and for emotions estimation it returns the probability of each of estimated facial emotions: anger, disgust, fear, happiness, sadness, surprise and neutral.

The ShowcaseDemo sample demonstrates age, gender and emotion estimation.

Main classes

Face recognition

The class VisageFaceRecognition contains a face recognition algorithm capable of measuring similarity between human faces and recognizing a person's identity from frontal facial images (yaw angle approximately from -20 to 20 degrees) by comparing it to previously stored faces.

The FaceDetectDemo sample demonstrates face recognition.

Main classes

Liveness

Liveness system is used to differentiate between a live person in the live video stream, as opposed to a still image. It is used in combination with face recognition to verify that the person is actually in front of the camera. This is accomplished by prompting a person to perform a specific set of facial actions and verifying that the actions have actually been performed. System allows you to use already implemented actions (eyebrows raise, blink, smile), as well as implement your own actions using VisageLivenessAction interface.

Liveness verification is demonstrated in VisageTrackerDemo sample application.

Main classes