itkVideoFileReader.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 itkVideoFileReader_h
#define itkVideoFileReader_h
 
#include "itkVideoSource.h"
#include "itkVideoIOFactory.h"
#include "itkDefaultConvertPixelTraits.h"
 
namespace itk
{

template <typename TOutputVideoStream>
class ITK_TEMPLATE_EXPORT VideoFileReader : public VideoSource<TOutputVideoStream>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(VideoFileReader);

  using Self = VideoFileReader;
  using Superclass = VideoSource<TOutputVideoStream>;
  using Pointer = SmartPointer<Self>;
  using VideoStreamType = TOutputVideoStream;
  using VideoStreamPointer = typename VideoStreamType::Pointer;
 
  using FrameType = typename VideoStreamType::FrameType;
  using PixelType = typename FrameType::PixelType;
  using RegionType = typename FrameType::RegionType;
  using SizeType = typename FrameType::SizeType;
  using IndexType = typename FrameType::IndexType;
  using PointType = typename FrameType::PointType;
  using SpacingType = typename FrameType::SpacingType;
  using DirectionType = typename FrameType::DirectionType;
 
  using TemporalOffsetType = typename VideoIOBase::TemporalOffsetType;
  using FrameOffsetType = typename VideoIOBase::FrameOffsetType;
  using TemporalRatioType = typename VideoIOBase::TemporalRatioType;
 
  static constexpr unsigned int FrameDimension = FrameType::ImageDimension;

  using ConvertPixelTraits = DefaultConvertPixelTraits<PixelType>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(VideoFileReader);
 

  itkSetStringMacro(FileName);
  itkGetStringMacro(FileName);

  itkSetMacro(IFrameSafe, bool);
  itkGetMacro(IFrameSafe, bool);
  itkBooleanMacro(IFrameSafe);

  void
  UpdateOutputInformation() override;

  void
  SetVideoIO(VideoIOBase * videoIO);

  FrameOffsetType
  GetCurrentPositionFrame();
 
  TemporalRatioType
  GetCurrentPositionRatio();
 
  TemporalOffsetType
  GetCurrentPositionMSec();

  FrameOffsetType
  GetNumberOfFrames();

  TemporalRatioType
  GetFramesPerSecond();
 
protected:
  VideoFileReader();
  ~VideoFileReader() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  TemporalStreamingGenerateData() override;

  void
  DoConvertBuffer(const void * inputData, FrameOffsetType frameNumber);

  void
  InitializeVideoIO();
 
private:
  std::string m_FileName{};

  VideoIOBase::Pointer m_VideoIO{};

  bool m_PixelConversionNeeded{};

  bool m_IFrameSafe{};
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkVideoFileReader.hxx"
#endif
 
#endif