vpVideoReader.h

/****************************************************************************
 *
 * This file is part of the ViSP software.
 * Copyright (C) 2005 - 2017 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
 * ("GPL") version 2 as published by the Free Software Foundation.
 * 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 http://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:
 * Read videos and sequences of images .
 *
 * Authors:
 * Nicolas Melchior
 * Fabien Spindler
 *
 *****************************************************************************/

#ifndef vpVideoReader_H
#define vpVideoReader_H

#include <string>

#include <visp3/io/vpDiskGrabber.h>
#include <visp3/io/vpFFMPEG.h>

#if VISP_HAVE_OPENCV_VERSION >= 0x020200
#include "opencv2/highgui/highgui.hpp"
#elif VISP_HAVE_OPENCV_VERSION >= 0x020000
#include "opencv/highgui.h"
#endif

class VISP_EXPORT vpVideoReader : public vpFrameGrabber
{    
  private:
    vpDiskGrabber *imSequence;
#ifdef VISP_HAVE_FFMPEG
    vpFFMPEG *ffmpeg;
#elif VISP_HAVE_OPENCV_VERSION >= 0x020100
    cv::VideoCapture capture;
    cv::Mat frame;
#endif
    typedef enum
    {
      FORMAT_PGM,
      FORMAT_PPM,
      FORMAT_JPEG,
      FORMAT_PNG,
      // Formats supported by opencv
      FORMAT_TIFF,
      FORMAT_BMP,
      FORMAT_DIB,
      FORMAT_PBM,
      FORMAT_RASTER,
      FORMAT_JPEG2000,
      // Video format
      FORMAT_AVI,
      FORMAT_MPEG,
      FORMAT_MPEG4,
      FORMAT_MOV,
      FORMAT_OGV,
      FORMAT_WMV,
      FORMAT_FLV,
      FORMAT_MKV,
      FORMAT_UNKNOWN
    } vpVideoFormatType;
    
    vpVideoFormatType formatType;
    
    char fileName[FILENAME_MAX];
    bool initFileName;
    bool isOpen;
    long frameCount; // Index of the next image
    long firstFrame;
    long lastFrame;
    bool firstFrameIndexIsSet;
    bool lastFrameIndexIsSet;

//private:
//#ifndef DOXYGEN_SHOULD_SKIP_THIS
//    vpVideoReader(const vpVideoReader &)
//      : vpFrameGrabber(), imSequence(NULL),
//    #ifdef VISP_HAVE_FFMPEG
//        ffmpeg(NULL),
//    #elif VISP_HAVE_OPENCV_VERSION >= 0x020100
//        capture(), frame(),
//    #endif
//        formatType(FORMAT_UNKNOWN), initFileName(false), isOpen(false), frameCount(0),
//        firstFrame(0), lastFrame(0), firstFrameIndexIsSet(false), lastFrameIndexIsSet(false)
//    {
//      throw vpException(vpException::functionNotImplementedError, "Not implemented!");
//    }
//    vpVideoReader &operator=(const vpVideoReader &){
//      throw vpException(vpException::functionNotImplementedError, "Not implemented!");
//      return *this;
//    }
//#endif

  public:
    vpVideoReader();
    ~vpVideoReader();
    
    void acquire(vpImage< vpRGBa > &I);
    void acquire(vpImage< unsigned char > &I);
    void close(){;}

    inline bool end() {
      if (frameCount > lastFrame )
        return true;
      return false;
    }
    bool getFrame(vpImage<vpRGBa> &I, long frame);
    bool getFrame(vpImage<unsigned char> &I, long frame);
    double getFramerate();

    inline long getFrameIndex() const { return frameCount;}

    inline long getFirstFrameIndex() const {return firstFrame;}
    inline long getLastFrameIndex() const {return lastFrame;}
    void open (vpImage< vpRGBa > &I);
    void open (vpImage< unsigned char > &I);

    vpVideoReader & operator>>(vpImage<unsigned char> &I);
    vpVideoReader & operator>>(vpImage<vpRGBa> &I);

    inline void resetFrameCounter() {frameCount = firstFrame;}
    void setFileName(const char *filename);
    void setFileName(const std::string &filename);
    inline void setFirstFrameIndex(const long first_frame) {
      this->firstFrameIndexIsSet = true;
      this->firstFrame = first_frame;
    }
    inline void setLastFrameIndex(const long last_frame) {
      this->lastFrameIndexIsSet = true;
      this->lastFrame = last_frame;
    }

  private:
    vpVideoFormatType getFormat(const char *filename);
    static std::string getExtension(const std::string &filename);
    void findFirstFrameIndex();
    void findLastFrameIndex();
    bool isImageExtensionSupported();
    bool isVideoExtensionSupported();
};

#endif