itkVideoSource.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 __itkVideoSource_h
#define __itkVideoSource_h

#include "itkTemporalProcessObject.h"
#include "itkVideoStream.h"

namespace itk
{

template< class TOutputVideoStream >
class ITK_EXPORT VideoSource : public TemporalProcessObject
{
public:

  /*-TYPEDEFS----------------------------------------------------------------*/

  typedef VideoSource                Self;
  typedef TemporalProcessObject      Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;
  typedef WeakPointer< const Self >  ConstWeakPointer;
  typedef TOutputVideoStream         OutputVideoStreamType;

  typedef typename OutputVideoStreamType::FrameType         OutputFrameType;
  typedef typename OutputVideoStreamType::SpatialRegionType OutputFrameSpatialRegionType;
  typedef typename OutputVideoStreamType::IndexType         OutputFrameIndexType;
  typedef typename OutputVideoStreamType::PixelType         OutputFramePixelType;
  typedef typename OutputVideoStreamType::PointType         OutputFramePointType;
  typedef typename OutputVideoStreamType::SpacingType       OutputFrameSpacingType;
  typedef typename OutputVideoStreamType::SizeType          OutputFrameSizeType;
  typedef typename OutputVideoStreamType::DirectionType     OutputFrameDirectionType;

  itkNewMacro(Self);

  itkTypeMacro(VideoSource, TemporalProcessObject);

  /*-PUBLIC METHODS----------------------------------------------------------*/

  itkStaticConstMacro(OutputFrameDimension, unsigned int, OutputFrameType::ImageDimension);
  static unsigned int GetOutputFrameDimension()
  {
    return OutputFrameType::ImageDimension;
  }

  OutputVideoStreamType* GetOutput();

  OutputVideoStreamType* GetOutput(unsigned int idx);

  virtual void GraftNthOutput(unsigned int idx, OutputVideoStreamType* output);

  virtual void GraftOutput(OutputVideoStreamType* output);

  typedef ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType;
  using Superclass::MakeOutput;
  virtual DataObjectPointer MakeOutput(DataObjectPointerArraySizeType idx);

protected:

  virtual void GenerateOutputRequestedTemporalRegion(TemporalDataObject* output);

  virtual void TemporalStreamingGenerateData();

  virtual void ThreadedGenerateData(
    const OutputFrameSpatialRegionType& outputRegionForThread,
    int threadId);

  virtual void AllocateOutputs();

  virtual void BeforeThreadedGenerateData() {
  }

  virtual void AfterThreadedGenerateData() {
  }

  virtual int SplitRequestedSpatialRegion(int i, int num,
                                          OutputFrameSpatialRegionType& splitRegion);

  static ITK_THREAD_RETURN_TYPE ThreaderCallback(void* arg);

  struct ThreadStruct {
    Pointer Filter;
    };

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

private:

  VideoSource(const Self &);    //purposely not implemented
  void operator=(const Self &); //purposely not implemented

};  // end class VideoSource

} // end namespace itk

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

#endif