frvt1N.h

/*
 * This software was developed at the National Institute of Standards and
 * Technology (NIST) by employees of the Federal Government in the course
 * of their official duties. Pursuant to title 17 Section 105 of the
 * United States Code, this software is not subject to copyright protection
 * and is in the public domain. NIST assumes no responsibility  whatsoever for
 * its use by other parties, and makes no guarantees, expressed or implied,
 * about its quality, reliability, or any other characteristic.
 */
 
#ifndef FRVT1N_H_
#define FRVT1N_H_
 
#include <cstdint>
#include <string>
#include <vector>
 
#include <frvt_structs.h>
 
namespace FRVT_1N {
 
enum class GalleryType {
    Consolidated = 0,
    Unconsolidated = 1
};
 
typedef struct Candidate {
    bool isAssigned;
 
    std::string templateId;
 
    double score;
 
    Candidate() :
        isAssigned{false},
        templateId{""},
        score{-1.0}
        {}
 
    Candidate(
        bool isAssigned,
        std::string templateId,
        double score) :
        isAssigned{isAssigned},
        templateId{templateId},
        score{score}
        {}
} Candidate;
 
class Interface {
public:
    virtual ~Interface() {}
 
    virtual FRVT::ReturnStatus
    initializeTemplateCreation(
        const std::string &configDir,
        FRVT::TemplateRole role) = 0;
 
    virtual FRVT::ReturnStatus
    createFaceTemplate(
        const std::vector<FRVT::Image> &faces,
        FRVT::TemplateRole role,
        std::vector<uint8_t> &templ,
        std::vector<FRVT::EyePair> &eyeCoordinates) = 0;
 
    virtual FRVT::ReturnStatus
    createFaceTemplate(
        const FRVT::Image &image,
        FRVT::TemplateRole role,
        std::vector<std::vector<uint8_t>> &templ,
        std::vector<FRVT::EyePair> &eyeCoordinates) = 0;
 
    virtual FRVT::ReturnStatus
    createIrisTemplate(
        const std::vector<FRVT::Image> &irises,
        FRVT::TemplateRole role,
        std::vector<uint8_t> &templ,
        std::vector<FRVT::IrisAnnulus> &irisLocations) = 0;
 
    virtual FRVT::ReturnStatus
    createFaceAndIrisTemplate(
        const std::vector<FRVT::Image> &facesIrises,
        FRVT::TemplateRole role,
        std::vector<uint8_t> &templ) = 0;
 
    virtual FRVT::ReturnStatus
    finalizeEnrollment(
        const std::string &configDir,
        const std::string &enrollmentDir,
        const std::string &edbName,
        const std::string &edbManifestName,
        FRVT_1N::GalleryType galleryType) = 0;
 
    virtual FRVT::ReturnStatus
    initializeIdentification(
        const std::string &configDir,
        const std::string &enrollmentDir) = 0;
 
    virtual FRVT::ReturnStatus
    identifyTemplate(
        const std::vector<uint8_t> &idTemplate,
        const uint32_t candidateListLength,
        std::vector<FRVT_1N::Candidate> &candidateList) = 0;
 
    static std::shared_ptr<Interface>
    getImplementation();
};
 
/*
 * API versioning
 *
 * NIST code will extern the version number symbols.
 * Participant shall compile them into their core library.
 */
#ifdef NIST_EXTERN_API_VERSION
extern uint16_t API_MAJOR_VERSION;
extern uint16_t API_MINOR_VERSION;
#else /* NIST_EXTERN_API_VERSION */
uint16_t API_MAJOR_VERSION{3};
uint16_t API_MINOR_VERSION{0};
#endif /* NIST_EXTERN_API_VERSION */
}
 
#endif /* FRVT1N_H_ */