Image Component Library (ICL)
VideoGrabber.h
Go to the documentation of this file.
1 /********************************************************************
2 ** Image Component Library (ICL) **
3 ** **
4 ** Copyright (C) 2006-2013 CITEC, University of Bielefeld **
5 ** Neuroinformatics Group **
6 ** Website: www.iclcv.org and **
7 ** http://opensource.cit-ec.de/projects/icl **
8 ** **
9 ** File : ICLIO/src/ICLIO/VideoGrabber.h **
10 ** Module : ICLIO **
11 ** Authors: Christof Elbrechter, Viktor Richter **
12 ** **
13 ** **
14 ** GNU LESSER GENERAL PUBLIC LICENSE **
15 ** This file may be used under the terms of the GNU Lesser General **
16 ** Public License version 3.0 as published by the **
17 ** **
18 ** Free Software Foundation and appearing in the file LICENSE.LGPL **
19 ** included in the packaging of this file. Please review the **
20 ** following information to ensure the license requirements will **
21 ** be met: http://www.gnu.org/licenses/lgpl-3.0.txt **
22 ** **
23 ** The development of this software was supported by the **
24 ** Excellence Cluster EXC 277 Cognitive Interaction Technology. **
25 ** The Excellence Cluster EXC 277 is a grant of the Deutsche **
26 ** Forschungsgemeinschaft (DFG) in the context of the German **
27 ** Excellence Initiative. **
28 ** **
29 ********************************************************************/
30 
31 #pragma once
32 
33 #include <ICLIO/Grabber.h>
34 #include <ICLUtils/Exception.h>
35 
36 namespace icl{
37  namespace io{
38 
40 
64  class VideoGrabber : public Grabber{
65  public:
66 
68  VideoGrabber(const std::string &fileName) ;
69 
71  ~VideoGrabber();
72 
74  virtual const core::ImgBase *acquireImage();
75 
77  void pause();
78 
80  void unpause();
81 
83  void restart();
84 
87 
88 
89  protected:
91  struct Data;
92  struct XineHandle;
93  struct Params;
96  XineHandle *m_xine;
97  Data *m_data;
98  Params *m_params;
99  };
100 
101  } // namespace io
102 }
103 
virtual const core::ImgBase * acquireImage()
grab function
undocument this line if you encounter any issues!
Definition: Any.h:37
void restart()
direct access to restart video playback from the first frame
void processPropertyChange(const utils::Configurable::Property &prop)
callback for changed configurable properties
Params * m_params
property values
Definition: VideoGrabber.h:98
void unpause()
direct access to unpause video playback
Xine-based Video Grabber (grabs most common image formats)
Definition: VideoGrabber.h:64
void pause()
direct access to pause video playback (grab will block then)
Common interface class for all grabbers.
Definition: Grabber.h:153
~VideoGrabber()
Destructor.
Property & prop(const std::string &propertyName)
this CAN be used e.g. to store a property value in internal property-list
XineHandle * m_xine
internal data belonging to the xine library
Definition: VideoGrabber.h:96
VideoGrabber(const std::string &fileName)
Create video grabber with given video-file name.
Represents a single property.
Definition: Configurable.h:200
Data * m_data
internal data
Definition: VideoGrabber.h:97
ImgBase is the Image-Interface class that provides save access to underlying Img-template .
Definition: ImgBase.h:131