frame_source.hpp

00001 /*M///////////////////////////////////////////////////////////////////////////////////////
00002 //
00003 //  IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING.
00004 //
00005 //  By downloading, copying, installing or using the software you agree to this license.
00006 //  If you do not agree to this license, do not download, install,
00007 //  copy or use the software.
00008 //
00009 //
00010 //                           License Agreement
00011 //                For Open Source Computer Vision Library
00012 //
00013 // Copyright (C) 2000-2008, Intel Corporation, all rights reserved.
00014 // Copyright (C) 2009-2011, Willow Garage Inc., all rights reserved.
00015 // Third party copyrights are property of their respective owners.
00016 //
00017 // Redistribution and use in source and binary forms, with or without modification,
00018 // are permitted provided that the following conditions are met:
00019 //
00020 //   * Redistribution's of source code must retain the above copyright notice,
00021 //     this list of conditions and the following disclaimer.
00022 //
00023 //   * Redistribution's in binary form must reproduce the above copyright notice,
00024 //     this list of conditions and the following disclaimer in the documentation
00025 //     and/or other materials provided with the distribution.
00026 //
00027 //   * The name of the copyright holders may not be used to endorse or promote products
00028 //     derived from this software without specific prior written permission.
00029 //
00030 // This software is provided by the copyright holders and contributors "as is" and
00031 // any express or implied warranties, including, but not limited to, the implied
00032 // warranties of merchantability and fitness for a particular purpose are disclaimed.
00033 // In no event shall the Intel Corporation or contributors be liable for any direct,
00034 // indirect, incidental, special, exemplary, or consequential damages
00035 // (including, but not limited to, procurement of substitute goods or services;
00036 // loss of use, data, or profits; or business interruption) however caused
00037 // and on any theory of liability, whether in contract, strict liability,
00038 // or tort (including negligence or otherwise) arising in any way out of
00039 // the use of this software, even if advised of the possibility of such damage.
00040 //
00041 //M*/
00042 
00043 #ifndef __OPENCV_VIDEOSTAB_FRAME_SOURCE_HPP__
00044 #define __OPENCV_VIDEOSTAB_FRAME_SOURCE_HPP__
00045 
00046 #include <vector>
00047 #include "opencv2/core.hpp"
00048 
00049 namespace cv
00050 {
00051 namespace videostab
00052 {
00053 
00054 //! @addtogroup videostab
00055 //! @{
00056 
00057 class CV_EXPORTS IFrameSource
00058 {
00059 public:
00060     virtual ~IFrameSource() {}
00061     virtual void reset() = 0;
00062     virtual Mat nextFrame() = 0;
00063 };
00064 
00065 class CV_EXPORTS NullFrameSource : public IFrameSource
00066 {
00067 public:
00068     virtual void reset() {}
00069     virtual Mat nextFrame() { return Mat(); }
00070 };
00071 
00072 class CV_EXPORTS VideoFileSource : public IFrameSource
00073 {
00074 public:
00075     VideoFileSource(const String &path, bool volatileFrame = false);
00076 
00077     virtual void reset();
00078     virtual Mat nextFrame();
00079 
00080     int width();
00081     int height();
00082     int count();
00083     double fps();
00084 
00085 private:
00086     Ptr<IFrameSource> impl;
00087 };
00088 
00089 //! @}
00090 
00091 } // namespace videostab
00092 } // namespace cv
00093 
00094 #endif
00095