itkOpenCVVideoIO.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 itkOpenCVVideoIO_h
#define itkOpenCVVideoIO_h
 
#include "itkVideoIOBase.h"
 
#include "opencv2/videoio.hpp"
 
#include "ITKVideoBridgeOpenCVExport.h"
 
 
namespace itk
{
class ITKVideoBridgeOpenCV_EXPORT OpenCVVideoIO : public VideoIOBase
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(OpenCVVideoIO);

  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;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(OpenCVVideoIO);

  virtual void
  FinishReadingOrWriting();
 
  //
  // Data reading-related methods
  //

  virtual void
  SetReadFromFile();

  virtual void
  SetReadFromCamera();

  virtual bool
  CanReadFile(const char *);

  virtual bool
  CanReadCamera(CameraIDType cameraID) const;

  virtual void
  ReadImageInformation();

  virtual void
  Read(void * buffer);

  virtual bool
  SetNextFrameToRead(FrameOffsetType frameNumber);

  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
  //

  virtual void
  SetCameraIndex(CameraIDType idx);
  virtual CameraIDType
  GetCameraIndex() const;

  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);
  }

  virtual bool
  CanWriteFile(const char *);

  virtual void
  WriteImageInformation();

  virtual void
  Write(const void * buffer);

  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;

  void
  UpdateReaderProperties();

  void
  ResetMembers();

  void
  OpenReader();

  void
  OpenWriter();
 
private:
  cv::Mat          m_CVImage{};
  cv::VideoCapture m_Capture{};
  cv::VideoWriter  m_Writer{};
  int              m_FourCC{};
 
  int m_CameraIndex{};
};
} // end namespace itk
 
#endif // itkOpenCVVideoIO_h