path: root/xsig/include/signature.hpp

//Chris Xiong 2022
//License: MPL-2.0
#ifndef SIGNATURE_HPP
#define SIGNATURE_HPP

#include <memory>
#include <filesystem>
#include <string>

struct signature_config
{
    int slices;
    int blur_window;
    int min_window;
    bool crop;
    bool compress;
    double pr;
    double noise_threshold;
    double contrast_threshold;
    double max_cropping;
};

namespace cv
{
    class Mat;
};

class signature_priv;
class signature
{
private:
    std::shared_ptr<signature_priv> p;
    signature(signature_priv* _p);
    signature(const signature&)=default;
    signature& operator=(const signature&)=default;
public:
    signature();
    ~signature();
    signature(signature&&)=default;
    signature& operator=(signature&&)=default;
    signature clone() const;//do not use unless absolutely needed
    void dump() const;
    bool valid() const;
    double length() const;
    double distance(const signature &o) const;
    bool operator ==(const signature &o) const;
    std::string to_string() const;

    static signature from_string(std::string &&s);

    static signature from_path(const std::filesystem::path &path, const signature_config &cfg);

    static signature from_file(const char *fn, const signature_config &cfg);

    /*
     * Input will be stripped of alpha channel (by blending with white),
     * converted to single channel (rgb2gray).
     * Then it will be passed to from_preprocessed_matrix.
     * The matrix doesn't have to be continuous.
     */
    static signature from_cvmatrix(cv::Mat *m, const signature_config &cfg);

    /*
     * Input must be a single channel, floating point matrix
     * (values clamped to 0-1)
     * The matrix must be continuous if cropping is used
     * STILL *Will* be cropped if config().crop == true
     * STILL *Will* be blurred if config().blur_window > 1
     */
    static signature from_preprocessed_matrix(cv::Mat *m, const signature_config &cfg);

    static signature_config default_cfg();

    friend class signature_priv;
    friend struct signature_hash;
};

struct signature_hash
{
    size_t operator()(signature const& sig) const noexcept;
};

#endif