itkOpenCVVideoCapture.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  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 itkOpenCVVideoCapture_h
#define itkOpenCVVideoCapture_h
 
#include <string>
 
// Include the required header with OpenCV > 2.X
#include "opencv2/core/version.hpp"
#if !defined(CV_VERSION_EPOCH)
// OpenCV 3.x
#  include "opencv2/videoio.hpp"
#else
// OpenCV 2.4.x
#  include "highgui.h"
#endif
 
#include "itkVideoStream.h"
 
namespace itk
{

template <typename TVideoStream>
class ITK_TEMPLATE_EXPORT OpenCVVideoCapture : public cv::VideoCapture
{
public:
  using VideoStreamType = TVideoStream;
  using Self = OpenCVVideoCapture<VideoStreamType>;
  using FrameType = typename VideoStreamType::FrameType;
  using PixelType = typename FrameType::PixelType;
  static constexpr unsigned int Dimensions = FrameType::ImageDimension;
  OpenCVVideoCapture();

  OpenCVVideoCapture(VideoStreamType * videoStream);

  virtual ~OpenCVVideoCapture() {}

  itkVirtualGetNameOfClassMacro(OpenCVVideoCapture);
 
  // Open, close functionality

  virtual bool
  open(const std::string &)
  {
    itkExceptionStringMacro("itk::OpenCVVideoCapture::open(filename) -> If you just want to read from a file, use "
                            "cv::VideoCapture since there is nothing to be gained using itk's version.");
  }
 
  virtual bool
  open(int)
  {
    itkExceptionStringMacro("itk::OpenCVVideoCapture::open(device) -> If you just want to read from a device, use "
                            "cv::VideoCapture since there is nothing to be gained using itk's version.");
  }

  virtual bool
  open(VideoStreamType * videoStream);

  virtual bool
  isOpened() const
  {
    return m_VideoStream == 0;
  }

  virtual void
  release();
 
  // Frame access

  virtual bool
  grab();

  virtual bool
  retrieve(cv::Mat & image, int channel = 0);

  virtual Self &
  operator>>(cv::Mat & image);

  virtual bool
  read(cv::Mat & image);
 
  // Properties

  virtual bool
  set(int propId, double value);

  virtual double
  get(int propId);
 
protected:
  VideoStreamType * m_VideoStream{};

  double m_FpS{};
  int    m_FourCC{};
 
}; // end class VideoCapture
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkOpenCVVideoCapture.hxx"
#endif
 
#endif