/*    This file is a part of plaYUVer project
 *    Copyright (C) 2014-2016  by Luis Lucas      (luisfrlucas@gmail.com)
 *                                Joao Carreira   (jfmcarreira@gmail.com)
 *
 *    This program is free software; you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation; either version 2 of the License, or
 *    (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License along
 *   with this program; if not, write to the Free Software Foundation, Inc.,
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

/**
 * \file     OpticalFlow.h
 * \brief    Modules to measure optical flow
 */

#ifndef __OPTICALFLOWDUALTVL1_H__
#define __OPTICALFLOWDUALTVL1_H__

// OpenCV
#include <opencv2/core/core.hpp>
#include <opencv2/video/video.hpp>

// PlaYUVerLib
#include "lib/PlaYUVerModuleIf.h"


class OpticalFlowModule: public PlaYUVerModuleIf
{
protected:
  Bool m_bShowReconstruction;
  Int m_iStep;
  cv::Ptr<cv::DenseOpticalFlow> m_cOpticalFlow;
  cv::Mat_<cv::Point2f> m_cvFlow;
  PlaYUVerFrame* m_pcFramePrev;
  PlaYUVerFrame* m_pcFrameAfter;
  PlaYUVerFrame* m_pcOutputFrame;
  Void drawFlow();
  Void compensateFlow();
  Bool commonCreate( std::vector<PlaYUVerFrame*> apcFrameList );
public:
  OpticalFlowModule();
  virtual ~OpticalFlowModule()
  {
  }
  PlaYUVerFrame* process( std::vector<PlaYUVerFrame*> apcFrameList );
  Void destroy();
};


class OpticalFlowDualTVL1: public OpticalFlowModule
{
  REGISTER_CLASS_FACTORY( OpticalFlowDualTVL1 )
public:
  OpticalFlowDualTVL1();
  virtual ~OpticalFlowDualTVL1()
  {
  }
  Bool create( std::vector<PlaYUVerFrame*> apcFrameList );
};

class OpticalFlowSparseToDense: public OpticalFlowModule
{
  REGISTER_CLASS_FACTORY( OpticalFlowSparseToDense )
public:
  OpticalFlowSparseToDense();
  virtual ~OpticalFlowSparseToDense()
  {
  }
  Bool create( std::vector<PlaYUVerFrame*> apcFrameList );
};


class OpticalFlowFarneback: public OpticalFlowModule
{
  REGISTER_CLASS_FACTORY( OpticalFlowFarneback )
public:
  OpticalFlowFarneback();
  virtual ~OpticalFlowFarneback()
  {
  }
  Bool create( std::vector<PlaYUVerFrame*> apcFrameList );
};

class OpticalDeepFlow: public OpticalFlowModule
{
  REGISTER_CLASS_FACTORY( OpticalDeepFlow )
public:
  OpticalDeepFlow();
  virtual ~OpticalDeepFlow()
  {
  }
  Bool create( std::vector<PlaYUVerFrame*> apcFrameList );
};


#endif // __OPTICALFLOW_H__