Collector.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_COLLECTOR_H
#define LIBDFX_COLLECTOR_H
 
#include "dfx/ChunkData.h"
#include "dfx/Face.h"
#include "dfx/Frame.h"
#include "dfx/MeasurementResult.h"
 
#include <functional>
#include <map>
#include <memory>
#include <string>
#include <vector>
 
namespace dfx {
 
class Frame;
 
enum class ConstraintResult : char {
    Good = 0, 
    Warn = 1, 
    Error = 2 
};
 
enum class CollectorState : char {
    Waiting = 0,    
    Collecting = 1, 
    ChunkReady = 2, 
    Completed = 3,  
    Error = 4,      
};
 
class Collector {
  public:
    virtual ~Collector() {
        // Empty but necessary for vtable
    }
 
    virtual std::shared_ptr<dfx::Frame> createFrame(const dfx::VideoFrame &videoFrame) = 0;
 
    virtual CollectorState startCollection() = 0;
 
    virtual bool prepareMeasurement(const std::vector<uint8_t>& createMeasurementPayload) = 0;
 
    virtual CollectorState getCollectorState() = 0;
 
    virtual std::string getMode() const = 0;
 
    virtual bool setTargetFPS(float targetFPS) = 0;
 
    virtual bool setChunkDurationSeconds(float chunkDurationSeconds) = 0;
 
    virtual float getChunkDurationSeconds() = 0;
 
    virtual bool setNumberChunks(uint32_t numberChunks) = 0;
 
    virtual uint32_t getNumberChunks() = 0;
 
    virtual bool enableConstraint(const std::string &constraintID) = 0;
 
    virtual bool disableConstraint(const std::string &constraintID) = 0;
 
    virtual std::vector<std::string> getEnabledConstraints() = 0;
 
    virtual std::vector<std::string> getAvailableConstraints() const = 0;
 
    virtual ConstraintResult checkConstraints(std::shared_ptr<dfx::Frame> &frame, std::vector<std::pair<std::string,dfx::ConstraintResult>> &results) = 0;
 
    virtual std::string getConstraintErrorMessage(const std::string &violationID) = 0;
 
    virtual bool setConstraintsConfig(const std::string& key, const std::string &propertyValue) = 0;
 
    virtual std::string getConstraintsConfig(const std::string& key) = 0;
 
    virtual std::vector<std::string> getRequiredPosePointIDs() const = 0;
 
    virtual CollectorState defineRegions(std::shared_ptr<dfx::Frame> &frame) = 0;
 
    virtual CollectorState extractChannels(std::shared_ptr<dfx::Frame> &frame) = 0;
 
    virtual bool isChunkReady() const = 0;
 
    virtual int32_t numberFramesNeeded() const = 0;
 
    virtual std::shared_ptr<dfx::ChunkData> getChunkData() = 0;
 
    virtual std::shared_ptr<dfx::MeasurementResult> decodeMeasurementResult(const std::vector<uint8_t>& measurementResponse) = 0;
 
    virtual bool setProperty(const std::string &key, const std::string &value) = 0;
 
    virtual std::string getProperty(const std::string& key) = 0;
 
    virtual void removeProperty(const std::string& key) = 0;
 
    virtual std::map<std::string, std::string> getProperties() = 0;
 
    virtual std::string getLastErrorMessage() = 0;
 
    virtual void cancelCollection() = 0;
 
    virtual void stopCollection() = 0;
 
    virtual void forceComplete() = 0;
 
    virtual void resetCollection() = 0;
 
    virtual bool setFaceAttribute(const std::string& faceID, FaceAttribute key, FaceAttributeValue value) = 0;
 
    virtual bool setFaceAttribute(const std::string& faceID, FaceAttribute key, double value) = 0;
 
    virtual bool setCloudResultsFeedback(const std::string& jsonCloudResults) = 0;
 
    virtual bool initializeModel(int8_t modelType, const std::vector<unsigned char> &data) = 0;
};
} // namespace dfx
 
#endif // LIBDFX_COLLECTOR_H