itkVideoFileWriter.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 itkVideoFileWriter_h
#define itkVideoFileWriter_h
 
#include "itkTemporalProcessObject.h"
#include "itkVideoIOFactory.h"
 
namespace itk
{

template <typename TInputVideoStream>
class ITK_TEMPLATE_EXPORT VideoFileWriter : public TemporalProcessObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(VideoFileWriter);

  using Self = VideoFileWriter<TInputVideoStream>;
  using Superclass = TemporalProcessObject;
  using Pointer = SmartPointer<Self>;
 
  using IOBaseType = VideoIOBase;
  using IOBasePointer = typename VideoIOBase::Pointer;
  using SizeValueType = typename IOBaseType::SizeValueType;
  using TemporalRatioType = typename IOBaseType::TemporalRatioType;
 
  using VideoStreamType = TInputVideoStream;
  using VideoStreamPointer = typename VideoStreamType::Pointer;
  using FrameType = typename VideoStreamType::FrameType;
  using PixelType = typename FrameType::PixelType;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(VideoFileWriter);
 

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

  void
  Update() override;

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

  bool
  InitializeOutputParameters();

  bool
  InitializeVideoIO();

  void
  TemporalStreamingGenerateData() override;
 
private:
  std::string m_FileName{};

  IOBasePointer m_VideoIO{};

  TemporalRegion m_OutputTemporalRegion{};

  TemporalRatioType          m_FramesPerSecond{ 24 };
  std::string                m_FourCC{};
  std::vector<SizeValueType> m_Dimensions{};
  SizeValueType              m_NumberOfComponents{ 0 };
  IOComponentEnum            m_ComponentType{};
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkVideoFileWriter.hxx"
#endif
 
#endif