vpVideoWriter.h

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2024 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:
 * Write videos and sequences of images.
 */
 
#ifndef VP_VIDEO_WRITER_H
#define VP_VIDEO_WRITER_H
 
#include <string>
 
#include <visp3/io/vpImageIo.h>
 
#if defined(VISP_HAVE_OPENCV) && defined(HAVE_OPENCV_VIDEOIO) && defined(HAVE_OPENCV_HIGHGUI)
#include <opencv2/videoio/videoio.hpp>
#include <opencv2/highgui/highgui.hpp>
#endif
 
BEGIN_VISP_NAMESPACE
 
class VISP_EXPORT vpVideoWriter
{
private:
#if defined(VISP_HAVE_OPENCV) && defined(HAVE_OPENCV_HIGHGUI) && defined(HAVE_OPENCV_VIDEOIO)
  cv::VideoWriter m_writer;
  int m_fourcc;
  double m_framerate;
#endif
  typedef enum
  {
    FORMAT_PGM,
    FORMAT_PPM,
    FORMAT_JPEG,
    FORMAT_PNG,
    FORMAT_AVI,
    FORMAT_MPEG,
    FORMAT_MPEG4,
    FORMAT_MOV,
    FORMAT_UNKNOWN
  } vpVideoFormatType;
 
  vpVideoFormatType m_formatType;
 
  std::string m_videoName;
  std::string m_frameName;
 
  bool m_initFileName;
 
  bool m_isOpen;
 
  int m_frameCount;
 
  int m_firstFrame;
 
  unsigned int m_width;
  unsigned int m_height;
 
  int m_frameStep;
 
public:
  vpVideoWriter();
  virtual ~vpVideoWriter();
 
  void close();
 
  inline unsigned int getCurrentFrameIndex() const { return m_frameCount; }
  inline std::string getFrameName() const { return m_frameName; }
 
  void open(vpImage<vpRGBa> &I);
  void open(vpImage<unsigned char> &I);
  inline void resetFrameCounter() { m_frameCount = m_firstFrame; }
 
  void saveFrame(vpImage<vpRGBa> &I);
  void saveFrame(vpImage<unsigned char> &I);
 
#if defined(VISP_HAVE_OPENCV) && defined(HAVE_OPENCV_HIGHGUI) && defined(HAVE_OPENCV_VIDEOIO)
  inline void setCodec(const int fourcc_codec) { m_fourcc = fourcc_codec; }
#endif
 
  void setFileName(const std::string &filename);
  void setFirstFrameIndex(int first_frame);
 
#if defined(VISP_HAVE_OPENCV) && defined(HAVE_OPENCV_HIGHGUI) && defined(HAVE_OPENCV_VIDEOIO)
  inline void setFramerate(const double framerate) { m_framerate = framerate; }
#else
  inline void setFramerate(const double dummy) { (void)dummy; }
#endif
  inline void setFrameStep(const int frame_step) { m_frameStep = frame_step; }
 
private:
  vpVideoFormatType getFormat(const std::string &filename);
  static std::string getExtension(const std::string &filename);
};
 
END_VISP_NAMESPACE
 
#endif