/usr/include/x86_64-linux-gnu/visp3/io/vpVideoReader.h is in libvisp-io-dev 3.1.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 | /****************************************************************************
*
* 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 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 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
*
*****************************************************************************/
/*!
\file vpVideoReader.h
\brief Read videos and image sequences
*/
#ifndef vpVideoReader_H
#define vpVideoReader_H
#include <string>
#include <visp3/io/vpDiskGrabber.h>
#if VISP_HAVE_OPENCV_VERSION >= 0x020200
#include "opencv2/highgui/highgui.hpp"
#elif VISP_HAVE_OPENCV_VERSION >= 0x020000
#include "opencv/highgui.h"
#endif
/*!
\class vpVideoReader
\ingroup group_io_video
\brief 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 tutorial-video-reader.cpp
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.
\code
#include <visp3/io/vpVideoReader.h>
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 positionning the video reader use acquire to read the video frame by frame
reader.acquire(I);
return 0;
#endif
}
\endcode
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.
\code
#include <visp3/io/vpVideoReader.h>
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;
}
\endcode
Note that it is also possible to access to a specific frame using
getFrame().
\code
#include <visp3/io/vpVideoReader.h>
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;
}
\endcode
*/
class VISP_EXPORT vpVideoReader : public vpFrameGrabber
{
private:
//! To read sequences of images
vpDiskGrabber *imSequence;
#if VISP_HAVE_OPENCV_VERSION >= 0x020100
//! To read video files with OpenCV
cv::VideoCapture capture;
cv::Mat frame;
#endif
//! Types of available formats
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;
//! Video's format which has to be read
vpVideoFormatType formatType;
//! Path to the video
char fileName[FILENAME_MAX];
//! Indicates if the path to the video is set.
bool initFileName;
//! Indicates if the video is "open".
bool isOpen;
//! Count the frame number when the class is used as a grabber.
long frameCount; // Index of the next image
//! The first frame index
long firstFrame;
//! The last frame index
long lastFrame;
bool firstFrameIndexIsSet;
bool lastFrameIndexIsSet;
//! The frame step
long frameStep;
double frameRate;
// private:
//#ifndef DOXYGEN_SHOULD_SKIP_THIS
// vpVideoReader(const vpVideoReader &)
// : vpFrameGrabber(), imSequence(NULL),
// #if 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() { ; }
/*!
\return true if the end of the sequence is reached.
*/
inline bool end()
{
if (frameStep > 0) {
if (frameCount + frameStep > lastFrame)
return true;
} else if (frameStep < 0) {
if (frameCount + frameStep < firstFrame)
return true;
}
return false;
}
bool getFrame(vpImage<vpRGBa> &I, long frame);
bool getFrame(vpImage<unsigned char> &I, long frame);
/*!
Return the frame rate in Hz used to encode the video stream.
If the video is a sequence of images, return -1.
*/
double getFramerate()
{
if (!isOpen) {
getProperties();
}
return frameRate;
}
/*!
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()).
\return Returns the current frame index.
\sa end()
*/
inline long getFrameIndex() const { return frameCount; }
/*!
Gets the first frame index.
\return Returns the first frame index.
*/
inline long getFirstFrameIndex()
{
if (!isOpen) {
getProperties();
}
return firstFrame;
}
/*!
Gets the last frame index.
\return Returns the last frame index.
*/
inline long getLastFrameIndex()
{
if (!isOpen) {
getProperties();
}
return lastFrame;
}
/*!
Gets the frame step.
\return Returns the frame step value.
*/
inline long getFrameStep() const { return frameStep; }
void open(vpImage<vpRGBa> &I);
void open(vpImage<unsigned char> &I);
vpVideoReader &operator>>(vpImage<unsigned char> &I);
vpVideoReader &operator>>(vpImage<vpRGBa> &I);
/*!
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
theacquire method).
*/
inline void resetFrameCounter() { frameCount = firstFrame; }
void setFileName(const char *filename);
void setFileName(const std::string &filename);
/*!
Enables to set the first frame index if you want to use the class like a
grabber (ie with the acquire method).
\param first_frame : The first frame index.
\sa setLastFrameIndex()
*/
inline void setFirstFrameIndex(const long first_frame)
{
this->firstFrameIndexIsSet = true;
this->firstFrame = first_frame;
}
/*!
Enables to set the last frame index.
\param last_frame : The last frame index.
\sa setFirstFrameIndex()
*/
inline void setLastFrameIndex(const long last_frame)
{
this->lastFrameIndexIsSet = true;
this->lastFrame = last_frame;
}
/*!
Sets the frame step index.
The default frame step is 1
\param frame_step : The frame index step.
\sa setFrameStep()
*/
inline void setFrameStep(const long frame_step) { this->frameStep = frame_step; }
private:
vpVideoFormatType getFormat(const char *filename);
static std::string getExtension(const std::string &filename);
void findFirstFrameIndex();
void findLastFrameIndex();
bool isImageExtensionSupported();
bool isVideoExtensionSupported();
long extractImageIndex(const std::string &imageName, const std::string &format);
bool checkImageNameFormat(const std::string &format);
void getProperties();
};
#endif
|