itkVideoFileReader.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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
 *
 *         http://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< class TOutputVideoStream >
class ITK_EXPORT VideoFileReader : public VideoSource< TOutputVideoStream >
{
public:

  typedef VideoFileReader                          Self;
  typedef VideoSource< TOutputVideoStream >        Superclass;
  typedef SmartPointer<Self>                       Pointer;
  typedef TOutputVideoStream                       VideoStreamType;
  typedef typename VideoStreamType::Pointer        VideoStreamPointer;

  typedef typename VideoStreamType::FrameType      FrameType;
  typedef typename FrameType::PixelType            PixelType;
  typedef typename FrameType::RegionType           RegionType;
  typedef typename FrameType::SizeType             SizeType;
  typedef typename FrameType::IndexType            IndexType;
  typedef typename FrameType::PointType            PointType;
  typedef typename FrameType::SpacingType          SpacingType;
  typedef typename FrameType::DirectionType        DirectionType;

  typedef typename VideoIOBase::TemporalOffsetType TemporalOffsetType;
  typedef typename VideoIOBase::FrameOffsetType    FrameOffsetType;
  typedef typename VideoIOBase::TemporalRatioType  TemporalRatioType;

  itkStaticConstMacro(FrameDimension,unsigned int,FrameType::ImageDimension);

  typedef DefaultConvertPixelTraits<PixelType> ConvertPixelTraits;

  itkNewMacro(Self);

  itkTypeMacro(VideoFileReader, VideoSource);

  itkSetStringMacro(FileName);
  itkGetStringMacro(FileName);

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

  virtual void UpdateOutputInformation();

  void SetVideoIO(VideoIOBase* videoIO);

  FrameOffsetType GetCurrentPositionFrame();

  TemporalRatioType GetCurrentPositionRatio();

  TemporalOffsetType GetCurrentPositionMSec();

  FrameOffsetType GetNumberOfFrames();

  TemporalRatioType GetFramesPerSecond();

protected:

  VideoFileReader();
  virtual ~VideoFileReader();
  void PrintSelf(std::ostream &os, Indent indent) const;

  virtual void TemporalStreamingGenerateData();

  void DoConvertBuffer(void* inputData, FrameOffsetType frameNumber);

  void InitializeVideoIO();

  std::string m_FileName;

  VideoIOBase::Pointer m_VideoIO;

  bool m_PixelConversionNeeded;

  bool m_IFrameSafe;
private:
  VideoFileReader(const Self &); // purposely not implemented
  void operator=(const Self &);  // purposely not implemented

};

} // end namespace itk

#if ITK_TEMPLATE_TXX
#include "itkVideoFileReader.hxx"
#endif

#endif