itkVXLVideoIO.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 itkVXLVideoIO_h
#define itkVXLVideoIO_h
 
// Define support for VXLVideo
#ifndef ITK_VIDEO_USE_VXL
#  define ITK_VIDEO_USE_VXL
#endif
 
#ifdef _MSC_VER
#  pragma warning(disable : 4786)
#endif
 
#include "itkVideoIOBase.h"
#include "vidl/vidl_ffmpeg_istream.h"
#include "vidl/vidl_ffmpeg_ostream.h"
#include "vidl/vidl_convert.h"
#include "vul/vul_reg_exp.h"
 
namespace itk
{
class VXLVideoIO : public VideoIOBase
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(VXLVideoIO);
 
  using Self = VXLVideoIO;
  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(VXLVideoIO);
 
  void
  FinishReadingOrWriting() override;
 
  /*-------- This part of the interface deals with reading data. ------ */
 
  void
  SetReadFromFile() override;
 
  void
  SetReadFromCamera() override;
 
  bool
  CanReadFile(const char *) override;
 
  bool
  CanReadCamera(CameraIDType cameraID) const override;
 
  void
  ReadImageInformation() override;
 
  void
  Read(void * buffer) override;
 
 
  bool
  SetNextFrameToRead(FrameOffsetType frameNumber) override;
 
  TemporalOffsetType
  GetPositionInMSec() const override;
  TemporalRatioType
  GetRatio() const override;
  FrameOffsetType
  GetFrameTotal() const override;
  TemporalRatioType
  GetFramesPerSecond() const override;
  FrameOffsetType
  GetCurrentFrame() const override;
  FrameOffsetType
  GetLastIFrame() const override;
  virtual FrameOffsetType
  GetIFrameInterval() const;
  virtual void
  SetCameraIndex(int idx);
  virtual int
  GetCameraIndex();
  /*-------- This part of the interfaces deals with writing data. ----- */
 
  bool
  CanWriteFile(const char *) override;
 
  void
  WriteImageInformation() override;
 
  void
  Write(const void * buffer) override;
 
  void
  SetWriterParameters(TemporalRatioType                  fps,
                      const std::vector<SizeValueType> & dim,
                      const char *                       fourCC,
                      unsigned int                       nChannels,
                      IOComponentEnum                    componentType) override;
 
protected:
  VXLVideoIO();
  ~VXLVideoIO();
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  UpdateReaderProperties();
 
  void
  ResetMembers();
 
  void
  OpenReader();
 
  void
  OpenWriter();
 
 
  vidl_ffmpeg_ostream_params::encoder_type
  FourCCtoEncoderType(const char * fourCC);
 
  unsigned int
  GetNChannelsFromPixelFormat(vidl_pixel_format fmt);
 
  unsigned int
  GetSizeFromPixelFormat(vidl_pixel_format fmt);
 
  bool
  PixelFormatSupported(vidl_pixel_format fmt);
 
private:
  vidl_pixel_format                        m_PixelFormat{};
  vidl_frame_sptr                          m_VIDLFrame{};
  vidl_ffmpeg_istream *                    m_Reader{};
  vidl_ffmpeg_ostream *                    m_Writer{};
  vidl_ffmpeg_ostream_params::encoder_type m_Encoder{};
 
 
  int m_CameraIndex{};
};
} // end namespace itk
 
#endif // itkVXLVideoIO_h