iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
VideoSource.H
Go to the documentation of this file.
1 /*! @file
2  @author Randolph Voorhies (voorhies@usc.edu)
3  @copyright GNU Public License (GPL v3)
4  @section License
5  @verbatim
6  // ////////////////////////////////////////////////////////////////////////
7  // The iLab Neuromorphic Robotics Toolkit (NRT) //
8  // Copyright 2010-2012 by the University of Southern California (USC) //
9  // and the iLab at USC. //
10  // //
11  // iLab - University of Southern California //
12  // Hedco Neurociences Building, Room HNB-10 //
13  // Los Angeles, Ca 90089-2520 - USA //
14  // //
15  // See http://ilab.usc.edu for information about this project. //
16  // ////////////////////////////////////////////////////////////////////////
17  // This file is part of The iLab Neuromorphic Robotics Toolkit. //
18  // //
19  // The iLab Neuromorphic Robotics Toolkit is free software: you can //
20  // redistribute it and/or modify it under the terms of the GNU General //
21  // Public License as published by the Free Software Foundation, either //
22  // version 3 of the License, or (at your option) any later version. //
23  // //
24  // The iLab Neuromorphic Robotics Toolkit is distributed in the hope //
25  // that it will be useful, but WITHOUT ANY WARRANTY; without even the //
26  // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR //
27  // PURPOSE. See the GNU General Public License for more details. //
28  // //
29  // You should have received a copy of the GNU General Public License //
30  // along with The iLab Neuromorphic Robotics Toolkit. If not, see //
31  // <http://www.gnu.org/licenses/>. //
32  // ////////////////////////////////////////////////////////////////////////
33  @endverbatim */
34 
35 
36 #ifndef INCLUDE_NRT_IMAGEPROC_IO_IMAGESOURCE_VIDEOSOURCE_H
37 #define INCLUDE_NRT_IMAGEPROC_IO_IMAGESOURCE_VIDEOSOURCE_H
38 
42 
43 namespace nrt
44 {
45  namespace videosource
46  {
47  NRT_DECLARE_PARAMETER_WITH_CALLBACK(path, std::string, "Path", "", nrt::imagesource::ParamCateg);
48  }
49 
50  //! A SeekableImageSourceType for streaming video files
51  /*! The VideoSource is used to read images from VideoFiles using the ImageSource framework. Upon setting the --video
52  Parameter, this class will query the nrt::VideoReaderFactory to determine if any VideoReaderBase classes have been
53  registered (see the NRT_REGISTER_VIDEO_READER(CLASSNAME) macro) to parse the given extension. Available video
54  readers can be found in nrt/ImageProc/IO/ImageSource/VideoReaders */
55  class VideoSource : public SeekableImageSourceType, public nrt::Parameter<videosource::path>
56  {
57  public:
58  VideoSource(std::string const& instanceID="video");
59 
60  //! Attempts to seek to the given framenumber
61  /*! \return Whether or not the seek was succesful */
62  bool const seek(size_t const framenumber);
63 
64  //! Returns a GenericImage from its VideoReader::in()
65  GenericImage const in();
66 
67  //! Get the name associated with our --in type
68  static std::string const id() { return "video"; }
69 
70  //! Get a description to show for --help
71  static std::string const description() { return "Reads frames from a video file"; }
72 
73  //! Returns whether or not the next call to in() will return a valid GenericImage
74  //! by checking the underlying VideoReader::ok()
75  bool const ok() const;
76 
77  //! Get the intersection of the video's physical FrameRange, and the
78  //! requested FrameRange set by the SeekableImageSourceType's parameter
79  nrt::FrameRange const frameRange() const;
80 
81  //! Get the next frame number (e.g. the frame that will be returned by the next call to in())
82  size_t const nextFrameNumber() const;
83 
84  private:
85  nrt::ParameterDef<std::string> createPathDef();
86  void onParamChange(nrt::videosource::path const & param, std::string const & filename);
87 
88  // implementation of pure virtual callback defined in base class:
89  void onParamChange(nrt::seekableimagesource::frames const & param, nrt::FrameRange const & range);
90 
91  std::shared_ptr<VideoReaderBase> itsReader;
92  bool itsOk;
93  };
94 }
95 
96 #endif // INCLUDE_NRT_IMAGEPROC_IO_IMAGESOURCE_VIDEOSOURCE_H