noobapluginapi.h

#ifndef NOOBAPLUGINAPI_H
#define NOOBAPLUGINAPI_H

#include "noobapluginbase.h"

//Qt
#include <QObject>
#include <QString>
#include <QStringList>
#include <QtPlugin>
#include <QMetaType>
#include <QImage>
#include <QColor>

/************************************************************************/
/* IMPORTANT: ANY CHANGE TO THE API CORRESPOND TO A CHANGE IN THE       */
/*            VERSION NUMBER. SO IF A CHANGE IS DONE TO THE API         */
/*            REMEMBER TO CHANGE THE API MAJOR AND MINOR VESION         */
/*            NUMBERS ACCORDINGLY.                                      */
/*                                                                      */
/* ~ Asitha Nanayakkara <daun07@gmail.com> - 2/3/2013                   */
/************************************************************************/

// forward declaration
namespace cv {
    class Mat;
}



namespace nooba {


    enum ParamType {
        IntParam        = 0, 
        DoubleParam     = 1, 
        StringParam     = 2, 
        RangeParam      = 3, 
        RegionParam     = 4, 
        MultiValueParam = 5, 
        FilePathParam   = 6  
    };


    enum VideoState {
        PlayingState    = 0, 
        PausedState     = 1, 
        StoppedState    = 2  
    };


    enum AlertType {
        RedAlert    = 0, 
        AmberAlert  = 1  
    };


    enum PathType {
        FilePath    = 0, 
        DirPath     = 1  
    };
}

Q_DECLARE_METATYPE(nooba::ParamType)   // now ParamTypes can be used with QVariants
Q_DECLARE_METATYPE(nooba::VideoState)
Q_DECLARE_METATYPE(nooba::AlertType)
Q_DECLARE_METATYPE(nooba::PathType)

struct ProcParamsPrivate;
struct PluginInfoPrivate;
struct NoobaPluginAPIPrivate;
struct PluginPassDataPrivate;

class ProcParams
{
public:

    ProcParams();
    ProcParams(const ProcParams& rhs);                // copy constructor
    ProcParams& operator=(const ProcParams& rhs);     // assignment operator

    ~ProcParams();

    void setFrameId(int id);
    int frameId() const;

    void setFrameRate(double rate);
    double frameRate() const;

    void setErrorState(bool isError);
    bool isError() const;

    void setErrorMsg(const QString& errMsg);
    QString errMsg() const;

    nooba::VideoState currentVideoState() const;

    bool setVidState(nooba::VideoState state);

private:

    ProcParamsPrivate* createPrivateStruct(const ProcParams& rhs);
    ProcParamsPrivate*   d;  // d pointer

};

Q_DECLARE_METATYPE(ProcParams*)

class PluginPassData
{
public:

    explicit PluginPassData();
    ~PluginPassData();

    PluginPassData(const PluginPassData& rhs);                // copy constructor
    PluginPassData& operator=(const PluginPassData& rhs);     // assignment operator
    QStringList strList() const;
    void setStrList(const QStringList& list);
    void appendStrList(const QString& str);
    void setImage(const QImage& image);
    QImage& getImage() const;

private:

    PluginPassDataPrivate* createPrivateStruct(const PluginPassData& rhs);
    PluginPassDataPrivate*  d; // d pointer
};

Q_DECLARE_METATYPE(PluginPassData*)
Q_DECLARE_METATYPE(PluginPassData)

class PluginInfo
{
public:

    PluginInfo(const QString& name, const int majorVersion, const int minorVersion,
               const QString& description, const QString& author);
    PluginInfo(const PluginInfo& rhs);                // copy constructor
    PluginInfo& operator=(const PluginInfo& rhs);     // assignment operator

    ~PluginInfo();

    QString name() const;
    QString description() const;
    QString author() const;

    int majorVersion() const;
    int minorVersion() const;

private:

    PluginInfoPrivate *createPrivateStruct(const PluginInfo& rhs);
    PluginInfoPrivate*  d;

};

class NoobaPluginAPI: public NoobaPluginAPIBase
{
    Q_OBJECT

public:

    virtual ~NoobaPluginAPI(){}

    virtual bool init() = 0;

    virtual bool release() = 0;

    virtual bool procFrame(const cv::Mat& in, cv::Mat& out, ProcParams& params) = 0;

    virtual PluginInfo getPluginInfo() const = 0;

    // functions to create variables that need to be changed by the user.
    // once created user can see the variables and change them.

    void createIntParam(const QString& varName, int val, int max = 100, int min = 0)
    {   emit createIntParamRequest(varName, val, max, min);}

    void createDoubleParam(const QString& varName, double val, double max = 100.0, double min = 0.0)
    {   emit createDoubleParamRequest(varName, val, max, min); }

    void createStringParam(const QString& varName, QString val, bool isFilePath = false)
    {   emit createStringParamRequest(varName, val, isFilePath);}

    void createFilePathParam(const QString& varName, QString path = QString(), nooba::PathType pathType = nooba::FilePath, const QString& filter = QString() )
    {   emit createFilePathParamRequest(varName, path, pathType, filter); }

    void createMultiValParam(const QString& varName, const QStringList& varList)
    {   emit createMultiValParamRequest(varName, varList);   }

    void createLineParam(const QString& varName, const QString& frameViewerTitle, QColor lineColor)
    {   emit createLineParamRequest(varName, frameViewerTitle, lineColor); }

    void debugMsg(const QString& msg)
    {   emit debugMsgRequest(msg); }

    void outputData(const PluginPassData& data)
    {   emit outputDataRequest(data); }

    void outputData(const QStringList& strList, QList<QImage> imageList)
    {   emit outputDataRequest(strList, imageList); }

    void createFrameViewer(const QString& title, bool isVisible = true)
    {   emit createFrameViewerRequest(title, isVisible); }

    void updateFrameViewer(const QString& title, const QImage& frame)
    {   emit updateFrameViewerRequest(title, frame); }

    void setFrameViewerVisibility(const QString& title, bool isVisible)
    {   emit updateFrameViewerVisibilityRequest(title, isVisible); }

    void generateAlert(const QString& frameViewerTitle, const QString& msg,  nooba::AlertType alert)  // after version 0.11
    {   emit generateAlertRequest(frameViewerTitle, msg, alert); }

signals:

    void createIntParamRequest(const QString& varName, int val, int max = 100, int min = 0);
    void createDoubleParamRequest(const QString& varName, double val, double max = 100.0, double min = 0.0);
    void createStringParamRequest(const QString& varName, QString val, bool isFilePath = false);
    void createMultiValParamRequest(const QString& varName, const QStringList& varList);
    void createLineParamRequest(const QString& varName, const QString& frameViewerTitle, QColor lineColor);   // after version 0.10
    void debugMsgRequest(const QString& msg);
    void outputDataRequest(const PluginPassData& data);
    void outputDataRequest(const QStringList& strList, QList<QImage> imageList);
    void createFrameViewerRequest(const QString& title, bool isVisible = true); // added isVisible argument after ver 0.9
    void updateFrameViewerRequest(const QString& title, const QImage& frame);
    void updateFrameViewerVisibilityRequest(const QString& title, bool isVisible); // after ver 0.9
    void createFilePathParamRequest(const QString& varName, QString path,
                                    nooba::PathType pathType, const QString& filter);   // added in version 0.10
    void generateAlertRequest(const QString& frameViewerTitle, const QString& msg, nooba::AlertType alert);  // after version 0.11

public slots:

    virtual void onIntParamChanged(const QString& varName, int val) {
        Q_UNUSED(varName) Q_UNUSED(val)
    }

    virtual void onDoubleParamChanged(const QString& varName, double val) {
        Q_UNUSED(varName) Q_UNUSED(val)
    }

    virtual void onStringParamChanged(const QString& varName, const QString& val){
        Q_UNUSED(varName) Q_UNUSED(val)
    }

    virtual void onMultiValParamChanged(const QString& varName, const QString& val){
        Q_UNUSED(varName) Q_UNUSED(val)
    }

    virtual void onFilePathParamChanged(const QString& varName, const QString& path) {
        Q_UNUSED(varName) Q_UNUSED(path)
    }

    virtual void inputData(const PluginPassData& data){
        Q_UNUSED(data)
    }

    virtual void inputData(const QStringList& strList, QList<QImage> imageList){
        Q_UNUSED(strList) Q_UNUSED(imageList)
    }

    virtual void onLineParamUpdated(const QString& varName, const QString frameViewerTitle, QLine line)
    {   Q_UNUSED(varName) Q_UNUSED(frameViewerTitle) Q_UNUSED(line) }

protected:

    explicit NoobaPluginAPI();

private:

    NoobaPluginAPI(const NoobaPluginAPI& rhs);                // private copy constructor
    NoobaPluginAPI& operator=(const NoobaPluginAPI& rhs);     // private assignment operator

    NoobaPluginAPIPrivate*      d;                            // d pointer (opaque pointer)
};

Q_DECLARE_INTERFACE(NoobaPluginAPI, "NoobaVSS.NoobaPluginAPI/" )
#endif // NOOBAPLUGINAPI_H