Frame.h

/*
 *              Copyright (c) 2016-2019, Nuralogix Corp.
 *                      All Rights reserved
 *
 *      THIS SOFTWARE IS LICENSED BY AND IS THE CONFIDENTIAL AND
 *      PROPRIETARY PROPERTY OF NURALOGIX CORP. IT IS
 *      PROTECTED UNDER THE COPYRIGHT LAWS OF THE USA, CANADA
 *      AND OTHER FOREIGN COUNTRIES. THIS SOFTWARE OR ANY
 *      PART THEREOF, SHALL NOT, WITHOUT THE PRIOR WRITTEN CONSENT
 *      OF NURALOGIX CORP, BE USED, COPIED, DISCLOSED,
 *      DECOMPILED, DISASSEMBLED, MODIFIED OR OTHERWISE TRANSFERRED
 *      EXCEPT IN ACCORDANCE WITH THE TERMS AND CONDITIONS OF A
 *      NURALOGIX CORP SOFTWARE LICENSE AGREEMENT.
 */
#pragma once
#ifndef LIBDFX_FRAME_H
#define LIBDFX_FRAME_H
 
#include "dfx/Face.h"
#include "dfx/VideoFrame.h"
 
#include <memory>
#include <string>
 
namespace dfx {
class Frame {
  public:
    virtual ~Frame() {
        // Empty but necessary for vtable
    }
 
    virtual VideoFrame getVideoFrame() const = 0;
 
    virtual bool addFace(std::shared_ptr<dfx::Face> face) = 0;
 
    virtual std::vector<float> getQualityMetrics(float iso, float exposure) = 0;
 
    virtual std::vector<float> getOpticalQualityMetrics() = 0;
 
    virtual int getStarRating(std::string& feedback) = 0;
 
    virtual int getOpticalQualityRating(std::string& feedback) = 0;
 
    virtual bool addMarker(const std::string &label) = 0;
 
    virtual std::vector<std::string> getMarkers() const = 0;
 
    virtual std::vector<std::string> getDesiredFaceAttributes() const = 0;
 
    virtual std::vector<std::string> getDesiredDeviceAttributes() const = 0;
 
    virtual double getDeviceAttribute(const std::string& key) const = 0;
 
    virtual void setDeviceAttribute(const std::string& key, double value) = 0;
 
    virtual std::vector<std::string> getFaceIdentifiers() const = 0;
 
    virtual std::vector<std::string> getRegionNames(const std::string &faceID) const = 0;
 
    virtual std::vector<cv::Point> getRegionPolygon(const std::string &faceID, const std::string &regionName) const = 0;
 
    virtual int32_t getRegionIntProperty(const std::string& faceID, const std::string& regionName, const std::string& property) const = 0;
 
    virtual cv::Mat getRegionHistogram(const std::string &faceID, const std::string &regionName) const = 0;
};
} // namespace dfx
 
#endif // LIBDFX_FRAME_H