/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkOpenCVVideoIO_h
#define itkOpenCVVideoIO_h

#include "itkVideoIOBase.h"

#include "opencv2/core/version.hpp"
#if !defined(CV_VERSION_EPOCH)
// OpenCV 3.x
#  include "opencv2/videoio/videoio.hpp"
#  include "opencv2/videoio/videoio_c.h"
#  include "opencv2/imgproc/imgproc_c.h"
#else
// OpenCV 2.4.x
#  include "cv.h"
#  include "highgui.h"
#endif

#include "ITKVideoBridgeOpenCVExport.h"


namespace itk
{
/**
 * \class OpenCVVideoIO
 *
 * \brief VideoIO object for reading and writing videos using OpenCV
 *
 * \ingroup ITKVideoBridgeOpenCV
 */
class ITKVideoBridgeOpenCV_EXPORT OpenCVVideoIO : public VideoIOBase
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(OpenCVVideoIO);

  /** Standard class type aliases. */
  using Self = OpenCVVideoIO;
  using Superclass = VideoIOBase;
  using Pointer = SmartPointer<Self>;

  using TemporalOffsetType = Superclass::TemporalOffsetType;
  using FrameOffsetType = Superclass::FrameOffsetType;
  using TemporalRatioType = Superclass::TemporalRatioType;
  using CameraIDType = Superclass::CameraIDType;

  /** Method for creation through the object factory. */
  itkNewMacro(Self);

  /** \see LightObject::GetNameOfClass() */
  itkOverrideGetNameOfClassMacro(OpenCVVideoIO);

  /** Close the reader and writer and reset members */
  virtual void
  FinishReadingOrWriting();

  //
  // Data reading-related methods
  //

  /** Set to reading from file */
  virtual void
  SetReadFromFile();

  /** Set to reading from a camera */
  virtual void
  SetReadFromCamera();

  /** Determine the file type. Returns true if this ImageIO can read the
   * file specified. */
  virtual bool
  CanReadFile(const char *);

  /** Return whether or not the VideoIO can read from a camera */
  virtual bool
  CanReadCamera(CameraIDType cameraID) const;

  /** Set the spacing and dimension information for the set filename. */
  virtual void
  ReadImageInformation();

  /** Reads the data from disk into the memory buffer provided. */
  virtual void
  Read(void * buffer);

  /** Set the next frame that should be read. Return true if you operation
   * successful. */
  virtual bool
  SetNextFrameToRead(FrameOffsetType frameNumber);

  /** Virtual accessor functions to be implemented in each derived class. */
  virtual TemporalOffsetType
  GetPositionInMSec() const;
  virtual TemporalRatioType
  GetRatio() const;
  virtual FrameOffsetType
  GetFrameTotal() const;
  virtual TemporalRatioType
  GetFramesPerSecond() const;
  virtual FrameOffsetType
  GetCurrentFrame() const;
  virtual FrameOffsetType
  GetIFrameInterval() const;
  virtual FrameOffsetType
  GetLastIFrame() const;

  //
  // Data writing-related methods
  //

  /** Get/Set the device index for reading from a camera. */
  virtual void
  SetCameraIndex(CameraIDType idx);
  virtual CameraIDType
  GetCameraIndex() const;

  /** Override Accessors to pass default values since OpenCV doesn't handle
   * this type of meta data. */
  virtual double
  GetSpacing(unsigned int itkNotUsed(i)) const
  {
    return 1.0;
  }
  virtual double
  GetOrigin(unsigned int itkNotUsed(i)) const
  {
    return 0.0;
  }
  virtual std::vector<double>
  GetDirection(unsigned int i) const
  {
    return this->GetDefaultDirection(i);
  }

  /** Determine the file type. Returns true if this ImageIO can write the
   * file specified. */
  virtual bool
  CanWriteFile(const char *);

  /** Writes the spacing and dimensions of the image.
   * Assumes SetFileName has been called with a valid file name. */
  virtual void
  WriteImageInformation();

  /** Writes the data to disk from the memory buffer provided. Make sure
   * that the IORegion has been set properly. */
  virtual void
  Write(const void * buffer);

  /** Set Writer parameters. */
  virtual void
  SetWriterParameters(TemporalRatioType                  fps,
                      const std::vector<SizeValueType> & dim,
                      const char *                       fourCC,
                      unsigned int                       nChannels,
                      IOComponentEnum                    componentType);

protected:
  OpenCVVideoIO();
  ~OpenCVVideoIO();

  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  /** Update the local members from the internal capture. */
  void
  UpdateReaderProperties();

  /** Reset member variables to empty state closed. */
  void
  ResetMembers();

  /** Open the reader if the writer is not open. */
  void
  OpenReader();

  /** Open the writer if the reader is not open. */
  void
  OpenWriter();

private:
private:
  IplImage *      m_CVImage{};
  IplImage *      m_TempImage{};
  CvCapture *     m_Capture{};
  CvVideoWriter * m_Writer{};
  int             m_FourCC{};

  int m_CameraIndex{};
};
} // end namespace itk

#endif // itkOpenCVVideoIO_h
