itkFileListVideoIO.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 itkFileListVideoIO_h
#define itkFileListVideoIO_h

#include "itkVideoIOBase.h"
#include "ITKVideoIOExport.h"

namespace itk
{
class ITKVideoIO_EXPORT FileListVideoIO : public VideoIOBase
{
public:
  typedef FileListVideoIO      Self;
  typedef VideoIOBase          Superclass;
  typedef SmartPointer< Self > Pointer;

  itkNewMacro(Self);

  itkTypeMacro(FileListVideoIO, Superclass);

  virtual void FinishReadingOrWriting() ITK_OVERRIDE;

  static std::vector<std::string> SplitFileNames(const std::string& fileList);

  /*-------- This part of the interface deals with reading data. ------ */

  virtual void SetReadFromFile() ITK_OVERRIDE;

  virtual void SetReadFromCamera() ITK_OVERRIDE;

  virtual bool CanReadFile(const char *) ITK_OVERRIDE;

  virtual bool CanReadCamera( CameraIDType cameraID )const ITK_OVERRIDE;

  virtual void ReadImageInformation() ITK_OVERRIDE;

  virtual void Read(void *buffer) ITK_OVERRIDE;

  virtual bool SetNextFrameToRead(FrameOffsetType frameNumber) ITK_OVERRIDE;

  virtual TemporalOffsetType GetPositionInMSec() const ITK_OVERRIDE
    {
    return this->m_PositionInMSec;
    }
  virtual TemporalOffsetType GetRatio() const ITK_OVERRIDE
    {
    return this->m_Ratio;
    }
  virtual FrameOffsetType GetFrameTotal() const ITK_OVERRIDE
    {
    return this->m_FrameTotal;
    }
  virtual TemporalRatioType GetFramesPerSecond() const ITK_OVERRIDE
    {
    return this->m_FramesPerSecond;
    }
  virtual FrameOffsetType GetCurrentFrame() const ITK_OVERRIDE
    {
    return this->m_CurrentFrame;
    }
  itkGetConstMacro(IFrameInterval,FrameOffsetType);
  virtual FrameOffsetType GetLastIFrame() const ITK_OVERRIDE
    {
    return this->m_LastIFrame;
    }

  virtual void SetFileName(const std::string& fileList) ITK_OVERRIDE;
  virtual void SetFileName(const char* fileList) ITK_OVERRIDE;

  virtual double GetSpacing(unsigned int i) const ITK_OVERRIDE;

  virtual double GetOrigin(unsigned int i) const ITK_OVERRIDE;

  virtual std::vector< double > GetDirection(unsigned int i) const ITK_OVERRIDE;

  /*-------- This part of the interfaces deals with writing data. ----- */

  virtual bool CanWriteFile(const char *) ITK_OVERRIDE;

  virtual void WriteImageInformation() ITK_OVERRIDE;

  virtual void Write(const void *buffer) ITK_OVERRIDE;

  virtual void SetWriterParameters( TemporalRatioType framesPerSecond,
                                    const std::vector<SizeValueType>& dim,
                                    const char* fourCC,
                                    unsigned int nChannels,
                                    IOComponentType componentType ) ITK_OVERRIDE;

protected:
  FileListVideoIO();
  ~FileListVideoIO();

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

  void ResetMembers();

  void OpenReader();

  void OpenWriter();

  bool VerifyExtensions( const std::vector<std::string>& fileList ) const;

private:
  FileListVideoIO(const Self &); //purposely not implemented
  void operator=(const Self &);  //purposely not implemented

  ImageIOBase::Pointer m_ImageIO;

  std::vector<std::string> m_FileNames;

};
} // end namespace itk

#endif // itkFileListVideoIO_h