vpVideoReader Class Reference

#include <visp3/io/vpVideoReader.h>

Inheritance diagram for vpVideoReader:

Public Member Functions
	vpVideoReader ()
virtual	~vpVideoReader ()
void	acquire (vpImage< vpRGBa > &I)
void	acquire (vpImage< unsigned char > &I)
void	close ()
bool	end ()
bool	getFrame (vpImage< vpRGBa > &I, long frame)
bool	getFrame (vpImage< unsigned char > &I, long frame)
double	getFramerate ()
long	getFrameIndex () const
std::string	getFrameName () const
long	getFirstFrameIndex ()
long	getLastFrameIndex ()
long	getFrameStep () const
bool	isVideoFormat () const
void	open (vpImage< vpRGBa > &I)
void	open (vpImage< unsigned char > &I)
vpVideoReader &	operator>> (vpImage< unsigned char > &I)
vpVideoReader &	operator>> (vpImage< vpRGBa > &I)
void	resetFrameCounter ()
void	setFileName (const std::string &filename)
void	setFirstFrameIndex (const long first_frame)
void	setLastFrameIndex (const long last_frame)
void	setFrameStep (const long frame_step)

Public Attributes
bool	init

Inherited functionalities from vpFramegrabber
unsigned int	getHeight () const
unsigned int	getWidth () const
unsigned int	height
unsigned int	width

Detailed Description

Class that enables to manipulate easily a video file or a sequence of images. As it inherits from the vpFrameGrabber Class, it can be used like an other frame grabber class.

This class has its own implementation to read a sequence of PGM and PPM images.

This class may benefit from optional 3rd parties:

• libpng: If installed this optional 3rd party is used to read a sequence of PNG images. Installation instructions are provided here https://visp.inria.fr/3rd_png.
• libjpeg: If installed this optional 3rd party is used to read a sequence of JPEG images. Installation instructions are provided here https://visp.inria.fr/3rd_jpeg.
• OpenCV: If installed this optional 3rd party is used to read a sequence of images where images could be in TIFF, BMP, DIB, PBM, RASTER, JPEG2000 format. If libpng or libjpeg is not installed, OpenCV is also used to consider these image formats. OpenCV allows also to consider AVI, MPEG, MPEG4, MOV, OGV, WMV, FLV, MKV video formats. Installation instructions are provided here https://visp.inria.fr/3rd_opencv.

The following example available in tutorial-video-reader.cpp shows how this class is really easy to use. It enables to read a video file named video.mpeg.

#include <visp3/core/vpConfig.h>
#include <visp3/gui/vpDisplayFactory.h>
#include <visp3/core/vpTime.h>
#include <visp3/io/vpVideoReader.h>
 
int main(int argc, char **argv)
{
#if defined(VISP_HAVE_OPENCV) && defined(HAVE_OPENCV_HIGHGUI) && defined(HAVE_OPENCV_VIDEOIO)
#ifdef ENABLE_VISP_NAMESPACE
  using namespace VISP_NAMESPACE_NAME;
#endif
  try {
    std::string videoname = "video.mp4";
 
    for (int i = 0; i < argc; i++) {
      if (std::string(argv[i]) == "--name")
        videoname = std::string(argv[i + 1]);
      else if (std::string(argv[i]) == "--help" || std::string(argv[i]) == "-h") {
        std::cout << "\nUsage: " << argv[0] << " [--name <video name> (default: " << videoname << ")]"
          << " [--help] [-h]\n"
          << std::endl;
        return EXIT_SUCCESS;
      }
    }
 
    vpImage<unsigned char> I;
    vpVideoReader g;
    g.setFileName(videoname);
    g.open(I);
    std::cout << "Video name     : " << videoname << std::endl;
    std::cout << "Video framerate: " << g.getFramerate() << "Hz" << std::endl;
    std::cout << "Video dimension: " << I.getWidth() << " " << I.getHeight() << std::endl;
 
#ifdef VISP_HAVE_DISPLAY
    vpDisplay *d = vpDisplayFactory::allocateDisplay(I);
#else
    std::cout << "No image viewer is available..." << std::endl;
#endif
    vpDisplay::setTitle(I, "Video reader");
 
    unsigned cpt = 1;
    bool quit = false;
    while ((!g.end()) && (!quit)) {
      double t = vpTime::measureTimeMs();
      g.acquire(I);
      vpDisplay::display(I);
      vpDisplay::displayText(I, 20, 20, "Click to quit", vpColor::red);
      std::stringstream ss;
      ss << "Frame: " << ++cpt;
      std::cout << "Read " << ss.str() << std::endl;
      vpDisplay::displayText(I, 40, 20, ss.str(), vpColor::red);
      vpDisplay::flush(I);
      if (vpDisplay::getClick(I, false)) {
        quit = true;
      }
      vpTime::wait(t, 1000. / g.getFramerate());
    }
    if (!quit) {
      std::cout << "End of video was reached" << std::endl;
    }
#ifdef VISP_HAVE_DISPLAY
    delete d;
#endif
  }
  catch (const vpException &e) {
    std::cout << e.getMessage() << std::endl;
  }
#else
  (void)argc;
  (void)argv;
  std::cout << "Install OpenCV and rebuild ViSP to use this example." << std::endl;
#endif
  return EXIT_SUCCESS;
}

As shown in the next example, this class allows also to access to a specific frame. But be careful, for video files, the getFrame() method is not precise and returns the nearest intra key frame from the expected frame. You can use the getFrame() method to position the reader in the video and then use the acquire() method to get the following frames one by one.

#include <visp3/io/vpVideoReader.h>
 
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
 
int main()
{
#ifdef VISP_HAVE_OPENCV
  vpImage<vpRGBa> I;
 
  vpVideoReader reader;
 
  // Initialize the reader.
  reader.setFileName("video.mpeg");
  reader.open(I);
 
  // Read the nearest key frame from the 3th frame
  reader.getFrame(I, 2);
 
  // After positioning the video reader use acquire to read the video frame by frame
  reader.acquire(I);
 
  return 0;
#endif
}

The other following example explains how to use the class to read a sequence of images. The images are stored in the folder "./image" and are named "image0000.jpeg", "image0001.jpeg", "image0002.jpeg", ... As explained in setFirstFrameIndex() and setLastFrameIndex() it is also possible to set the first and last image numbers to read a portion of the sequence. If these two functions are not used, first and last image numbers are set automatically to match the first and image images of the sequence.

#include <visp3/io/vpVideoReader.h>
 
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
 
int main()
{
  vpImage<vpRGBa> I;
 
  vpVideoReader reader;
 
  // Initialize the reader.
  reader.setFileName("./image/image%04d.jpeg");
  reader.setFirstFrameIndex(10);
  reader.setLastFrameIndex(20);
  reader.open(I);
 
  while (! reader.end() )
    reader.acquire(I);
 
  return 0;
}

Note that it is also possible to access to a specific frame using getFrame().

#include <visp3/io/vpVideoReader.h>
 
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
 
int main()
{
  vpImage<vpRGBa> I;
 
  vpVideoReader reader;
 
  // Initialize the reader.
  reader.setFileName("./image/image%04d.jpeg");
  reader.open(I);
 
  // Read the 3th frame
  reader.getFrame(I,2);
 
  return 0;
}

Examples

AROgre.cpp, AROgreBasic.cpp, imageSequenceReader.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtKltTracking.cpp, templateTracker.cpp, testImageNormalizedCorrelation.cpp, testImageTemplateMatching.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint.cpp, trackMeEllipse.cpp, trackMeLine.cpp, trackMeNurbs.cpp, tutorial-circle-hough.cpp, tutorial-detection-object-mbt-deprecated.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-detection-object-mbt2.cpp, tutorial-face-detector.cpp, tutorial-hsv-segmentation.cpp, tutorial-klt-tracker-with-reinit.cpp, tutorial-klt-tracker.cpp, tutorial-matching-keypoint-SIFT.cpp, tutorial-matching-keypoint-homography.cpp, tutorial-matching-keypoint.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-generic-tracker-full.cpp, tutorial-mb-generic-tracker-save.cpp, tutorial-mb-generic-tracker-stereo-mono.cpp, tutorial-mb-generic-tracker-stereo.cpp, tutorial-mb-generic-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker.cpp, tutorial-template-tracker.cpp, tutorial-video-manipulation.cpp, tutorial-video-reader.cpp, and videoReader.cpp.

Definition at line 178 of file vpVideoReader.h.

Constructor & Destructor Documentation

vpVideoReader()

BEGIN_VISP_NAMESPACE vpVideoReader::vpVideoReader

(

)

Basic constructor.

Definition at line 51 of file vpVideoReader.cpp.

~vpVideoReader()

vpVideoReader::~vpVideoReader ( )

virtual

Basic destructor.

Definition at line 64 of file vpVideoReader.cpp.

Member Function Documentation

acquire() [1/2]

void vpVideoReader::acquire ( vpImage< unsigned char > &  I )

virtual

Grabs the kth image in the stack of frames and increments the frame counter in order to grab the next image (k+1) during the next use of the method.

This method enables to use the class as frame grabber.

Parameters

I	: The image where the frame is stored.

Implements vpFrameGrabber.

Definition at line 337 of file vpVideoReader.cpp.

References vpDiskGrabber::acquire(), vpImageConvert::convert(), vpDiskGrabber::getImageName(), vpDiskGrabber::getImageNumber(), open(), vpDiskGrabber::setImageNumber(), and vpDiskGrabber::setStep().

acquire() [2/2]

void vpVideoReader::acquire ( vpImage< vpRGBa > &  I )

virtual

Grabs the current (k) image in the stack of frames and increments the frame counter in order to grab the next image (k+1) during the next use of the method. If open() was not called previously, this method opens the video reader.

This method enables to use the class as frame grabber.

Parameters

I	: The image where the frame is stored.

Implements vpFrameGrabber.

Examples

AROgre.cpp, AROgreBasic.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtKltTracking.cpp, templateTracker.cpp, testImageTemplateMatching.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint.cpp, trackMeEllipse.cpp, trackMeLine.cpp, tutorial-circle-hough.cpp, tutorial-detection-object-mbt-deprecated.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-detection-object-mbt2.cpp, tutorial-face-detector.cpp, tutorial-hsv-segmentation.cpp, tutorial-klt-tracker-with-reinit.cpp, tutorial-klt-tracker.cpp, tutorial-matching-keypoint-SIFT.cpp, tutorial-matching-keypoint-homography.cpp, tutorial-matching-keypoint.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-generic-tracker-full.cpp, tutorial-mb-generic-tracker-save.cpp, tutorial-mb-generic-tracker-stereo-mono.cpp, tutorial-mb-generic-tracker-stereo.cpp, tutorial-mb-generic-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker.cpp, tutorial-template-tracker.cpp, tutorial-video-manipulation.cpp, tutorial-video-reader.cpp, and videoReader.cpp.

Definition at line 243 of file vpVideoReader.cpp.

References vpDiskGrabber::acquire(), vpImageConvert::convert(), vpDiskGrabber::getImageName(), vpDiskGrabber::getImageNumber(), open(), vpDiskGrabber::setImageNumber(), setLastFrameIndex(), and vpDiskGrabber::setStep().

Referenced by operator>>().

close()

void vpVideoReader::close ( )

inlinevirtual

This virtual function is used to de-allocate the memory used by a specific frame grabber

Implements vpFrameGrabber.

Examples

AROgre.cpp, AROgreBasic.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtKltTracking.cpp, and templateTracker.cpp.

Definition at line 244 of file vpVideoReader.h.

end()

bool vpVideoReader::end ( void  )

inline

Returns

true if the end of the sequence is reached.

Examples

AROgre.cpp, AROgreBasic.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtKltTracking.cpp, templateTracker.cpp, testImageTemplateMatching.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint.cpp, trackMeEllipse.cpp, trackMeLine.cpp, tutorial-circle-hough.cpp, tutorial-detection-object-mbt-deprecated.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-detection-object-mbt2.cpp, tutorial-face-detector.cpp, tutorial-hsv-segmentation.cpp, tutorial-klt-tracker-with-reinit.cpp, tutorial-klt-tracker.cpp, tutorial-matching-keypoint-SIFT.cpp, tutorial-matching-keypoint-homography.cpp, tutorial-matching-keypoint.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-generic-tracker-full.cpp, tutorial-mb-generic-tracker-save.cpp, tutorial-mb-generic-tracker-stereo-mono.cpp, tutorial-mb-generic-tracker-stereo.cpp, tutorial-mb-generic-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker.cpp, tutorial-video-manipulation.cpp, tutorial-video-reader.cpp, and videoReader.cpp.

Definition at line 249 of file vpVideoReader.h.

getFirstFrameIndex()

long vpVideoReader::getFirstFrameIndex ( )

inline

Gets the first frame index.

Returns

Returns the first frame index.

Examples

mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtKltTracking.cpp, trackMeEllipse.cpp, trackMeLine.cpp, tutorial-klt-tracker.cpp, and tutorial-video-manipulation.cpp.

Definition at line 298 of file vpVideoReader.h.

getFrame() [1/2]

bool vpVideoReader::getFrame	(	vpImage< unsigned char > &	I,
		long	frame_index
	)

Gets the th frame and stores it in the image .

Warning

For the video files this method is not precise, and returns the nearest key frame from the expected frame. But this method enables to position the reader where you want. Then, use the acquire method to grab the following images one after one.

Parameters

I	: The vpImage used to stored the frame.
frame_index	: The index of the frame which has to be read.

Returns

It returns true if the frame could be read. Else it returns false.

Definition at line 510 of file vpVideoReader.cpp.

References vpDiskGrabber::acquire(), vpImageConvert::convert(), vpImage< Type >::getHeight(), vpDiskGrabber::getImageNumber(), vpImage< Type >::getWidth(), vpFrameGrabber::height, vpDiskGrabber::setImageNumber(), setLastFrameIndex(), and vpFrameGrabber::width.

getFrame() [2/2]

bool vpVideoReader::getFrame	(	vpImage< vpRGBa > &	I,
		long	frame_index
	)

Gets the th frame and stores it in the image .

Warning

For the video files this method is not precise, and returns the nearest key frame from the expected frame. But this method enables to position the reader where you want. Then, use the acquire method to grab the following images one after one.

Parameters

I	: The vpImage used to stored the frame.
frame_index	: The index of the frame which has to be read.

Returns

It returns true if the frame could be read. Else it returns false.

Examples

imageSequenceReader.cpp, and trackMeNurbs.cpp.

Definition at line 433 of file vpVideoReader.cpp.

References vpDiskGrabber::acquire(), vpImageConvert::convert(), vpImage< Type >::getHeight(), vpDiskGrabber::getImageNumber(), vpImage< Type >::getWidth(), vpFrameGrabber::height, vpDiskGrabber::setImageNumber(), setLastFrameIndex(), and vpFrameGrabber::width.

Referenced by open().

getFrameIndex()

long vpVideoReader::getFrameIndex ( ) const

inline

Get the frame index of the current image. This index is updated at each call of the acquire method. It can be used to detect the end of a file (comparison with getLastFrameIndex()).

Returns

Returns the current frame index.

See also

end()

Examples

imageSequenceReader.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtKltTracking.cpp, templateTracker.cpp, testImageTemplateMatching.cpp, testKeyPoint-2.cpp, testKeyPoint-4.cpp, trackMeEllipse.cpp, trackMeLine.cpp, tutorial-klt-tracker-with-reinit.cpp, tutorial-klt-tracker.cpp, tutorial-mb-generic-tracker-full.cpp, tutorial-video-manipulation.cpp, and videoReader.cpp.

Definition at line 286 of file vpVideoReader.h.

getFrameName()

std::string vpVideoReader::getFrameName ( ) const

inline

Return the name of the file in which the last frame was read.

Examples

trackMeEllipse.cpp, and trackMeLine.cpp.

Definition at line 291 of file vpVideoReader.h.

getFramerate()

double vpVideoReader::getFramerate ( )

inline

Return the frame rate in Hz used to encode the video stream.

If the video is a sequence of images, return -1.

Examples

tutorial-video-reader.cpp.

Definition at line 269 of file vpVideoReader.h.

getFrameStep()

long vpVideoReader::getFrameStep ( ) const

inline

Gets the frame step.

Returns

Returns the frame step value.

Examples

trackMeEllipse.cpp, and trackMeLine.cpp.

Definition at line 324 of file vpVideoReader.h.

getHeight()

BEGIN_VISP_NAMESPACE unsigned int vpFrameGrabber::getHeight ( ) const

inherited

Return the number of rows in the image.

Examples

AROgre.cpp, AROgreBasic.cpp, and testPylonGrabber.cpp.

Definition at line 38 of file vpFrameGrabber.cpp.

References vpFrameGrabber::height.

getLastFrameIndex()

long vpVideoReader::getLastFrameIndex ( )

inline

Gets the last frame index.

Returns

Returns the last frame index.

Examples

imageSequenceReader.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtKltTracking.cpp, trackMeEllipse.cpp, trackMeLine.cpp, tutorial-mb-generic-tracker-save.cpp, and tutorial-video-manipulation.cpp.

Definition at line 311 of file vpVideoReader.h.

getWidth()

unsigned int vpFrameGrabber::getWidth ( ) const

inherited

Return the number of columns in the image.

Examples

AROgre.cpp, AROgreBasic.cpp, and testPylonGrabber.cpp.

Definition at line 43 of file vpFrameGrabber.cpp.

References vpFrameGrabber::width.

isVideoFormat()

bool vpVideoReader::isVideoFormat

(

)

const

Indicate if the video is an encoded single video file.

Returns

true if the video format corresponds to an encoded single video file like one of the following avi, mpeg, mp4, mts, mov, ogv, wmv, flv, mkv. Return false, if the video is a sequence of successive images (png, jpeg, ppm, pgm...).

Examples

tutorial-klt-tracker.cpp, and tutorial-template-tracker.cpp.

Definition at line 895 of file vpVideoReader.cpp.

open() [1/2]

void vpVideoReader::open ( vpImage< unsigned char > &  I )

virtual

Sets all the parameters needed to read the video or the image sequence.

Grab the first frame and stores it in the image .

Parameters

I	: The image where the frame is stored.

Implements vpFrameGrabber.

Definition at line 207 of file vpVideoReader.cpp.

References getFrame(), and vpException::ioError.

open() [2/2]

void vpVideoReader::open ( vpImage< vpRGBa > &  I )

virtual

Sets all the parameters needed to read the video or the image sequence.

Grab the first frame and stores it in the image .

Parameters

I	: The image where the frame is stored.

Implements vpFrameGrabber.

Examples

AROgre.cpp, AROgreBasic.cpp, imageSequenceReader.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtKltTracking.cpp, templateTracker.cpp, testImageNormalizedCorrelation.cpp, testImageTemplateMatching.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint.cpp, trackMeEllipse.cpp, trackMeLine.cpp, trackMeNurbs.cpp, tutorial-circle-hough.cpp, tutorial-detection-object-mbt-deprecated.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-detection-object-mbt2.cpp, tutorial-face-detector.cpp, tutorial-hsv-segmentation.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-generic-tracker-full.cpp, tutorial-mb-generic-tracker-save.cpp, tutorial-mb-generic-tracker-stereo-mono.cpp, tutorial-mb-generic-tracker-stereo.cpp, tutorial-mb-generic-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker.cpp, tutorial-template-tracker.cpp, tutorial-video-manipulation.cpp, tutorial-video-reader.cpp, and videoReader.cpp.

Definition at line 174 of file vpVideoReader.cpp.

References getFrame(), and vpException::ioError.

Referenced by acquire().

operator>>() [1/2]

vpVideoReader & vpVideoReader::operator>>

(

vpImage< unsigned char > &

I

)

Operator that allows to capture a grey level image.

Parameters

I	: The captured image.

#include <visp3/io/vpVideoReader.h>
 
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
 
int main()
{
  vpImage<unsigned char> I;
  vpVideoReader reader;
 
  // Initialize the reader.
  reader.setFileName("./image/image%04d.jpeg");
  reader.setFirstFrameIndex(10);
  reader.setLastFrameIndex(20);
  reader.open(I);
 
  while (! reader.end() )
  reader >> I;
}

Definition at line 830 of file vpVideoReader.cpp.

References acquire().

operator>>() [2/2]

vpVideoReader & vpVideoReader::operator>>

(

vpImage< vpRGBa > &

I

)

Operator that allows to capture a grey level image.

Parameters

I	: The captured image.

#include <visp3/io/vpVideoReader.h>
 
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
 
int main()
{
  vpImage<vpRGBa> I;
  vpVideoReader reader;
 
  // Initialize the reader.
  reader.setFileName("./image/image%04d.jpeg");
  reader.setFirstFrameIndex(10);
  reader.setLastFrameIndex(20);
  reader.open(I);
 
  while (! reader.end() )
  reader >> I;
}

Definition at line 863 of file vpVideoReader.cpp.

References acquire().

resetFrameCounter()

void vpVideoReader::resetFrameCounter ( )

inline

Reset the frame counter and sets it to the first image index.

By default the first frame index is set to 0.

This method is useful if you use the class like a frame grabber (ie with the acquire method).

Definition at line 341 of file vpVideoReader.h.

setFileName()

void vpVideoReader::setFileName

(

const std::string &

filename

)

It enables to set the path and the name of the video which has to be read.

If you want to read a video file, filename corresponds to the path to the file (e.g.: /local/video.mpeg).

If you want to read a sequence of images, filename corresponds rather to the path followed by the image name template. For example, if you want to read different images named image0001.jpeg, image0002.jpg... and located in the folder /local/image, filename will be /local/image/image%04d.jpg.

Parameters

filename

: Path to a video file or file name template of a image sequence.

Examples

AROgre.cpp, AROgreBasic.cpp, imageSequenceReader.cpp, mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtKltTracking.cpp, templateTracker.cpp, testImageNormalizedCorrelation.cpp, testImageTemplateMatching.cpp, testKeyPoint-2.cpp, testKeyPoint-3.cpp, testKeyPoint-4.cpp, testKeyPoint.cpp, trackMeEllipse.cpp, trackMeLine.cpp, trackMeNurbs.cpp, tutorial-circle-hough.cpp, tutorial-detection-object-mbt-deprecated.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-detection-object-mbt2.cpp, tutorial-face-detector.cpp, tutorial-hsv-segmentation.cpp, tutorial-klt-tracker-with-reinit.cpp, tutorial-klt-tracker.cpp, tutorial-matching-keypoint-SIFT.cpp, tutorial-matching-keypoint-homography.cpp, tutorial-matching-keypoint.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-generic-tracker-full.cpp, tutorial-mb-generic-tracker-save.cpp, tutorial-mb-generic-tracker-stereo-mono.cpp, tutorial-mb-generic-tracker-stereo.cpp, tutorial-mb-generic-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker.cpp, tutorial-template-tracker.cpp, tutorial-video-manipulation.cpp, tutorial-video-reader.cpp, and videoReader.cpp.

Definition at line 86 of file vpVideoReader.cpp.

References vpException::badValue, vpIoTools::getName(), and vpImageException::noFileNameError.

setFirstFrameIndex()

void vpVideoReader::setFirstFrameIndex ( const long  first_frame )

inline

Enables to set the first frame index if you want to use the class like a grabber (ie with the acquire method).

Parameters

first_frame

: The first frame index.

See also

setLastFrameIndex()

Examples

AROgre.cpp, AROgreBasic.cpp, imageSequenceReader.cpp, templateTracker.cpp, trackMeEllipse.cpp, trackMeLine.cpp, trackMeNurbs.cpp, and tutorial-mb-generic-tracker-full.cpp.

Definition at line 352 of file vpVideoReader.h.

setFrameStep()

void vpVideoReader::setFrameStep ( const long  frame_step )

inline

Sets the frame step index. The default frame step is 1

Parameters

frame_step

: The frame index step.

See also

setFrameStep()

Examples

trackMeEllipse.cpp, and trackMeLine.cpp.

Definition at line 379 of file vpVideoReader.h.

setLastFrameIndex()

void vpVideoReader::setLastFrameIndex ( const long  last_frame )

inline

Enables to set the last frame index.

Parameters

last_frame

: The last frame index.

See also

setFirstFrameIndex()

Examples

mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtKltTracking.cpp, templateTracker.cpp, trackMeEllipse.cpp, and trackMeLine.cpp.

Definition at line 365 of file vpVideoReader.h.

Referenced by acquire(), and getFrame().

Member Data Documentation

height

unsigned int vpFrameGrabber::height

protectedinherited

Number of rows in the image.

Definition at line 134 of file vpFrameGrabber.h.

Referenced by vpDiskGrabber::acquire(), vpPylonGrabberGigE::acquire(), vpPylonGrabberUsb::acquire(), vpFlyCaptureGrabber::acquire(), vpV4l2Grabber::acquire(), vp1394TwoGrabber::acquire(), vp1394TwoGrabber::dequeue(), vpDirectShowGrabber::getFormat(), getFrame(), vpFrameGrabber::getHeight(), vp1394TwoGrabber::getHeight(), vpDiskGrabber::open(), vp1394CMUGrabber::open(), vpV4l2Grabber::open(), vpDirectShowGrabber::setFormat(), vp1394TwoGrabber::setFormat7ROI(), vpDirectShowGrabber::setImageSize(), vp1394CMUGrabber::setVideoMode(), vp1394TwoGrabber::setVideoMode(), vp1394CMUGrabber::vp1394CMUGrabber(), and vp1394TwoGrabber::vp1394TwoGrabber().

init

bool vpFrameGrabber::init

inherited

Set to true if the frame grabber has been initialized.

Definition at line 102 of file vpFrameGrabber.h.

Referenced by vpV4l2Grabber::acquire(), vp1394CMUGrabber::close(), vp1394TwoGrabber::close(), vpFlyCaptureGrabber::connect(), vpPylonGrabberGigE::connect(), vpPylonGrabberUsb::connect(), vpFlyCaptureGrabber::disconnect(), vpPylonGrabberGigE::disconnect(), vpPylonGrabberUsb::disconnect(), vpDiskGrabber::open(), vpV4l2Grabber::open(), vp1394TwoGrabber::resetBus(), vpFlyCaptureGrabber::startCapture(), vpPylonGrabberGigE::startCapture(), vpPylonGrabberUsb::startCapture(), vpFlyCaptureGrabber::stopCapture(), vpPylonGrabberGigE::stopCapture(), vpPylonGrabberUsb::stopCapture(), vp1394CMUGrabber::vp1394CMUGrabber(), vp1394TwoGrabber::vp1394TwoGrabber(), vpDiskGrabber::vpDiskGrabber(), and vpV4l2Grabber::vpV4l2Grabber().

width

unsigned int vpFrameGrabber::width

protectedinherited

Number of columns in the image.

Definition at line 135 of file vpFrameGrabber.h.

Referenced by vpDiskGrabber::acquire(), vpPylonGrabberGigE::acquire(), vpPylonGrabberUsb::acquire(), vpFlyCaptureGrabber::acquire(), vpV4l2Grabber::acquire(), vp1394TwoGrabber::acquire(), vp1394TwoGrabber::dequeue(), vpDirectShowGrabber::getFormat(), getFrame(), vpFrameGrabber::getWidth(), vp1394TwoGrabber::getWidth(), vpDiskGrabber::open(), vp1394CMUGrabber::open(), vpV4l2Grabber::open(), vpDirectShowGrabber::setFormat(), vp1394TwoGrabber::setFormat7ROI(), vpDirectShowGrabber::setImageSize(), vp1394CMUGrabber::setVideoMode(), vp1394TwoGrabber::setVideoMode(), vp1394CMUGrabber::vp1394CMUGrabber(), and vp1394TwoGrabber::vp1394TwoGrabber().