Skip to main content
Version: 3.15.0

Connecting library to Your Project

Add a Library to the Project​

Required dependencies​

To use OMNI, install the following dependencies:

  • Windows: sense4.dll. This library is located in the bin folder in OMNI. If you change the default location, It must be located next to facerec.dll.
  • Windows 64-bit: tensorflow.dll when GPU/AVX2 acceleration is used. This library is located in the bin folder of OMNI distribution package. It must be located in the directory, which the application is launched from. Otherwise, add the path to the directory with this library to the PATH system variable.
  • Windows 64-bit: Microsoft Visual C++ Redistributable for Visual Studio 2019
  • Linux: libusb-0.1.so.4
  • Linux 64-bit: libtensorflow.so.2 when GPU/AVX2 acceleration is used. This library is located in the lib folder in OMNI.

C++​

The libfacerec library is loaded dynamically in runtime mode when the static method pbio::FacerecService::createService is called. Therefore, do not link your program with libfacerec.so (Linux) or facerec.dll (Windows). Only add the include directory to include directories, or, for Linux projects, to link the libdl library with the -export-dynamic flag.

Warning: You can call pbio::FacerecService::createService only once, otherwise, you may encounter a crash.

All libfacerec declarations are divided in two headers:

The libfacerec library doesn't have any actual third-party dependencies*, since all used third-party libraries (see Open Source Licenses) are linked statically. Therefore, any version of these libraries must work for examples, in which OpenCV or boost is used.

* – except for the linux x86_64 and windows_x86_64 distribution packages when GPU/AVX2 acceleration is used - in this case, a dependency on libtensorflow.so.2 or tensorflow.dll is used.

Library Version​

You can get the current library version by calling the get_version method from the created FacerecService object. This method will return a string in the format of x.yy.zz, where x is the major version, yy is the minor version, and zz is the patch version.

In C++ the version can be additionally obtained from the preprocessor constants:

  • LIBFACEREC_VERSION – string representation, similar to FacerecService.get_version()
  • LIBFACEREC_VERSION_HEX – 3-byte HEX representation that is useful in numeric comparisons, e.g. 0x010234

Java​

To use facerec.jar in a project, specify the path to this file in classpath. The facerec.jar Java library is a wrapper for the C++ library, so libfacerec_jni.so and libfacerec.so for Linux and Android or facerec_jni.dll and facerec.dll for Windows are required in runtime. Path to the directory, which contains lifacerec_jni.so or facerec_jni.dll, must be specified in java.library.path.

C#​

To use facerec in a project, add a reference to FacerecCSharpWrapper.dll in a project. Add facerec.so (for Linux) or facerec.dll (for Windows) and FacerecCSharpWrapper.dll to the folder with executable file.

Use the libfacerec library​

To use the libfacerec library, call the FacerecService.createService method, which dynamically loads the library.

The FacerecService.createService method has an overloading signature and can be called:

  • by passing the path to the directory with the license
  • by passing the license in the form of a special structure: FacerecService.License

Warning: You can call FacerecService.createService only once, otherwise, you may encounter a crash.

Examples​

#include <iostream>
#include <exception>
#include <facerec/import.h>
#include <facerec/libfacerec.h>
int main (int argc, char** argv)
{
    try
    {
        pbio::FacerecService::Ptr service;
#ifdef _WIN32
        service = pbio::FacerecService::createService("../bin/facerec.dll", "../conf/facerec/");
#else
        service = pbio::FacerecService::createService("../lib/libfacerec.so", "../conf/facerec/");
#endif
        const pbio::Recognizer::Ptr recognizer = service->createRecognizer("method7v7_recognizer.xml");
        pbio::FacerecService::Config capturer_config("common_capturer4_fda.xml");
        capturer_config.overrideParameter("min_size", 200);
        pbio::Capturer::Ptr capturer = service->createCapturer(capturer_config);
        // ...
    }
    catch(const pbio::Error &e)
    {
        std::cerr << "facerec exception catched: '" << e.what() << "' code: " << std::hex << e.code() << std::endl;
    }
    catch(const std::exception &e)
    {
        std::cerr << "exception catched: '" << e.what() << "'" << std::endl;
    }
}

Examples of calling the createService method with a preloaded (stored in a string variable) license​

std::string license_body = "<?xml version="1.0" encoding="utf-8"?><License>........"; // contents of your license
auto license = pbio::FacerecService::License(license_body);
const pbio::FacerecService::Ptr service = pbio::FacerecService::createService("../bin/facerec.dll", "../conf/facerec/", license);