vidl_itk_istream.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 vidl_itk_istream_h
#define vidl_itk_istream_h

#include "vidl/vidl_istream.h"
#include "itkVideoStream.h"

namespace itk
{

template< typename TVideoStream >
class ITK_TEMPLATE_EXPORT vidl_itk_istream : public vidl_istream
{
public:

  using VideoStreamType = TVideoStream;
  using Self = vidl_itk_istream< VideoStreamType >;
  using FrameType = typename VideoStreamType::FrameType;
  using FrameOffsetType = ::itk::SizeValueType;
  using PixelType = typename FrameType::PixelType;
  static constexpr unsigned int Dimensions =      FrameType::ImageDimension;

  vidl_itk_istream();

  vidl_itk_istream(VideoStreamType* videoStream);

  virtual ~vidl_itk_istream() {}

  // Cannot use as we do not derive from ITK Object with GetNameOfClass itkTypeMacro(vidl_itk_istream, vidl_istream);
  const char *GetNameOfClass() const
    {
    return "vidl_itk_istream";
    }


  virtual bool open(VideoStreamType* videoStream);

  virtual void close() { m_VideoStream = nullptr; }


  virtual bool is_open() const { return m_VideoStream != nullptr; }

  virtual bool is_valid() const;

  virtual bool is_seekable() const;

  virtual int num_frames() const;

  virtual unsigned int frame_number() const;

  virtual unsigned int width() const;

  virtual unsigned int height() const;

  virtual vidl_pixel_format format() const;

  virtual double frame_rate() const { return 0.0; }

  virtual double duration() const;


  virtual bool advance();

  virtual vidl_frame_sptr read_frame();

  virtual vidl_frame_sptr current_frame();

  virtual bool seek_frame(unsigned int frameNumber);

protected:

  VideoStreamType* m_VideoStream;

  bool m_AdvanceCalled;

};  // end class vidl_itk_istream


} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "vidl_itk_istream.hxx"
#endif

#endif