itkFileListVideoIO.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 itkFileListVideoIO_h
#define itkFileListVideoIO_h
 
#include "itkVideoIOBase.h"
#include "ITKVideoIOExport.h"
 
namespace itk
{
class ITKVideoIO_EXPORT FileListVideoIO : public VideoIOBase
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(FileListVideoIO);

  using Self = FileListVideoIO;
  using Superclass = VideoIOBase;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(FileListVideoIO);

  itkGetConstObjectMacro(ImageIO, ImageIOBase);

  itkGetConstMacro(FileNames, std::vector<std::string>);

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

  void
  FinishReadingOrWriting() override;

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

  void
  SetReadFromFile() override;

  void
  SetReadFromCamera() override;

  bool
  CanReadFile(const char *) override;

  bool
  CanReadCamera(CameraIDType cameraID) const override;

  void
  ReadImageInformation() override;

  void
  Read(void * buffer) override;

  bool
  SetNextFrameToRead(FrameOffsetType frameNumber) override;

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


  double
  GetSpacing(unsigned int i) const override;
 
  double
  GetOrigin(unsigned int i) const override;
 
  std::vector<double>
  GetDirection(unsigned int i) const override;

  bool
  CanWriteFile(const char *) override;

  void
  WriteImageInformation() override;

  void
  Write(const void * buffer) override;

  void
  SetWriterParameters(TemporalRatioType                  framesPerSecond,
                      const std::vector<SizeValueType> & dim,
                      const char *                       fourCC,
                      unsigned int                       nChannels,
                      IOComponentEnum                    componentType) override;
 
protected:
  FileListVideoIO();
  ~FileListVideoIO() override;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  ResetMembers();

  void
  OpenReader();

  void
  OpenWriter();

  bool
  VerifyExtensions(const std::vector<std::string> & fileList) const;
 
private:
  ImageIOBase::Pointer m_ImageIO{};
 
  std::vector<std::string> m_FileNames{};
};
} // end namespace itk
 
#endif // itkFileListVideoIO_h