itkVideoFileWriter.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 __itkVideoFileWriter_h
#define __itkVideoFileWriter_h

#include "itkTemporalProcessObject.h"
#include "itkVideoIOFactory.h"

namespace itk
{

template< class TInputVideoStream >
class ITK_EXPORT VideoFileWriter : public TemporalProcessObject
{
public:

  typedef VideoFileWriter< TInputVideoStream>         Self;
  typedef TemporalProcessObject                       Superclass;
  typedef SmartPointer<Self>                          Pointer;

  typedef VideoIOBase                                 IOBaseType;
  typedef typename VideoIOBase::Pointer               IOBasePointer;
  typedef typename IOBaseType::SizeValueType          SizeValueType;
  typedef typename IOBaseType::TemporalRatioType      TemporalRatioType;

  typedef TInputVideoStream                           VideoStreamType;
  typedef typename VideoStreamType::Pointer           VideoStreamPointer;
  typedef typename VideoStreamType::FrameType         FrameType;
  typedef typename FrameType::PixelType               PixelType;

  itkNewMacro(Self);

  itkTypeMacro(VideoFileWriter, TemporalProcessObject);

  itkSetStringMacro(FileName);
  itkGetStringMacro(FileName);

  itkSetMacro(FramesPerSecond, TemporalRatioType);
  itkGetMacro(FramesPerSecond, TemporalRatioType);

  itkSetStringMacro(FourCC);
  itkGetStringMacro(FourCC);

  itkSetMacro(OutputTemporalRegion, TemporalRegion);
  itkGetMacro(OutputTemporalRegion, TemporalRegion);

  using Superclass::SetInput;
  void SetInput( const VideoStreamType* input );
  const VideoStreamType* GetInput();

  void SetVideoIO( IOBasePointer videoIO );

  void Write();

  void FinishWriting();

  virtual void Update();

  virtual void UpdateLargestPossibleRegion();

protected:

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

  bool InitializeOutputParameters();

  bool InitializeVideoIO();

  virtual void TemporalStreamingGenerateData();

  std::string m_FileName;

  IOBasePointer m_VideoIO;

  TemporalRegion     m_OutputTemporalRegion;

  TemporalRatioType            m_FramesPerSecond;
  std::string                  m_FourCC;
  std::vector<SizeValueType>   m_Dimensions;
  SizeValueType                m_NumberOfComponents;
  ImageIOBase::IOComponentType m_ComponentType;
private:
  VideoFileWriter(const Self &); // purposely not implemented
  void operator=(const Self &);  // purposely not implemented

};

} // end namespace itk

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

#endif