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"

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

  itkNewMacro(Self);

  itkTypeMacro(FileListVideoIO, Superclass);

  virtual void FinishReadingOrWriting();

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

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

  virtual void SetReadFromFile();

  virtual void SetReadFromCamera();

  virtual bool CanReadFile(const char *);

  virtual bool CanReadCamera( CameraIDType cameraID )const;

  virtual void ReadImageInformation();

  virtual void Read(void *buffer);

  virtual bool SetNextFrameToRead(FrameOffsetType frameNumber);

  itkGetConstMacro(PositionInMSec,TemporalOffsetType);
  itkGetConstMacro(Ratio,TemporalRatioType);
  itkGetConstMacro(FrameTotal,FrameOffsetType);
  itkGetConstMacro(FramesPerSecond,TemporalRatioType);
  itkGetConstMacro(CurrentFrame,FrameOffsetType);
  itkGetConstMacro(IFrameInterval,FrameOffsetType);
  itkGetConstMacro(LastIFrame,FrameOffsetType);

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

  virtual double GetSpacing(unsigned int i) const;

  virtual double GetOrigin(unsigned int i) const;

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

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

  virtual bool CanWriteFile(const char *);

  virtual void WriteImageInformation();

  virtual void Write(const void *buffer);

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

protected:
  FileListVideoIO();
  ~FileListVideoIO();

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

  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