vpDiskGrabber.h

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2025 by Inria. All rights reserved.
 *
 * This software is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ViSP with software that can not be combined with the GNU
 * GPL, please contact Inria about acquiring a ViSP Professional
 * Edition License.
 *
 * See https://visp.inria.fr for more information.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * If you have questions regarding the use of this file, please contact
 * Inria at visp@inria.fr
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * Description:
 * Disk framegrabber.
 */

#ifndef VP_DISK_GRABBER_H
#define VP_DISK_GRABBER_H
 
#include <string>
 
#include <visp3/core/vpFrameGrabber.h>
#include <visp3/core/vpRGBa.h>
#include <visp3/io/vpImageIo.h>
 
BEGIN_VISP_NAMESPACE

class VISP_EXPORT vpDiskGrabber : public vpFrameGrabber
{
private:
  long m_image_number;           
  long m_image_number_next;      
  long m_image_step;             
  unsigned int m_number_of_zero; 
 
  std::string m_directory; 
  std::string m_base_name; 
  std::string m_extension; 
 
  bool m_use_generic_name;
  std::string m_generic_name;
  std::string m_image_name;
 
public:
  vpDiskGrabber();

  vpDiskGrabber(const vpDiskGrabber &grabber);

  VP_EXPLICIT vpDiskGrabber(const std::string &genericName);

  virtual ~vpDiskGrabber() VP_OVERRIDE { }

  vpDiskGrabber &operator=(const vpDiskGrabber &grabber);

  VP_EXPLICIT vpDiskGrabber(const std::string &dir, const std::string &basename, long number, int step, unsigned int noz,
                            const std::string &ext);

  void acquire(vpImage<unsigned char> &I) VP_OVERRIDE;

  void acquire(vpImage<vpRGBa> &I) VP_OVERRIDE;

  void acquire(vpImage<float> &I);

  void acquire(vpImage<unsigned char> &I, long image_number);

  void acquire(vpImage<vpRGBa> &I, long image_number);

  void acquire(vpImage<float> &I, long image_number);

  void close() VP_OVERRIDE { }

  inline long getImageNumber() const { return m_image_number; }

  inline std::string getImageName() const { return m_image_name; }

  void open(vpImage<unsigned char> &I) VP_OVERRIDE;

  void open(vpImage<vpRGBa> &I) VP_OVERRIDE;

  void open(vpImage<float> &I);

  void setBaseName(const std::string &name) { m_base_name = name; }

  void setDirectory(const std::string &dir) { m_directory = dir; }

  void setExtension(const std::string &ext) { m_extension = ext; }

  void setGenericName(const std::string &genericName);

  void setImageNumber(long number);

  void setNumberOfZero(unsigned int noz) { m_number_of_zero = noz; }

  void setStep(long step) { m_image_step = step; }
};
 
END_VISP_NAMESPACE
 
#endif