OpenCV 2.4.8 components for OpenCVgrabber.
[mmanager-3rdparty.git] / OpenCV2.4.8 / build / include / opencv2 / videostab / stabilizer.hpp
1 /*M///////////////////////////////////////////////////////////////////////////////////////
2 //
3 //  IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING.
4 //
5 //  By downloading, copying, installing or using the software you agree to this license.
6 //  If you do not agree to this license, do not download, install,
7 //  copy or use the software.
8 //
9 //
10 //                           License Agreement
11 //                For Open Source Computer Vision Library
12 //
13 // Copyright (C) 2000-2008, Intel Corporation, all rights reserved.
14 // Copyright (C) 2009-2011, Willow Garage Inc., all rights reserved.
15 // Third party copyrights are property of their respective owners.
16 //
17 // Redistribution and use in source and binary forms, with or without modification,
18 // are permitted provided that the following conditions are met:
19 //
20 //   * Redistribution's of source code must retain the above copyright notice,
21 //     this list of conditions and the following disclaimer.
22 //
23 //   * Redistribution's in binary form must reproduce the above copyright notice,
24 //     this list of conditions and the following disclaimer in the documentation
25 //     and/or other materials provided with the distribution.
26 //
27 //   * The name of the copyright holders may not be used to endorse or promote products
28 //     derived from this software without specific prior written permission.
29 //
30 // This software is provided by the copyright holders and contributors "as is" and
31 // any express or implied warranties, including, but not limited to, the implied
32 // warranties of merchantability and fitness for a particular purpose are disclaimed.
33 // In no event shall the Intel Corporation or contributors be liable for any direct,
34 // indirect, incidental, special, exemplary, or consequential damages
35 // (including, but not limited to, procurement of substitute goods or services;
36 // loss of use, data, or profits; or business interruption) however caused
37 // and on any theory of liability, whether in contract, strict liability,
38 // or tort (including negligence or otherwise) arising in any way out of
39 // the use of this software, even if advised of the possibility of such damage.
40 //
41 //M*/
42
43 #ifndef __OPENCV_VIDEOSTAB_STABILIZER_HPP__
44 #define __OPENCV_VIDEOSTAB_STABILIZER_HPP__
45
46 #include <vector>
47 #include "opencv2/core/core.hpp"
48 #include "opencv2/imgproc/imgproc.hpp"
49 #include "opencv2/videostab/global_motion.hpp"
50 #include "opencv2/videostab/motion_stabilizing.hpp"
51 #include "opencv2/videostab/frame_source.hpp"
52 #include "opencv2/videostab/log.hpp"
53 #include "opencv2/videostab/inpainting.hpp"
54 #include "opencv2/videostab/deblurring.hpp"
55
56 namespace cv
57 {
58 namespace videostab
59 {
60
61 class CV_EXPORTS StabilizerBase
62 {
63 public:
64     virtual ~StabilizerBase() {}
65
66     void setLog(Ptr<ILog> _log) { log_ = _log; }
67     Ptr<ILog> log() const { return log_; }
68
69     void setRadius(int val) { radius_ = val; }
70     int radius() const { return radius_; }
71
72     void setFrameSource(Ptr<IFrameSource> val) { frameSource_ = val; }
73     Ptr<IFrameSource> frameSource() const { return frameSource_; }
74
75     void setMotionEstimator(Ptr<IGlobalMotionEstimator> val) { motionEstimator_ = val; }
76     Ptr<IGlobalMotionEstimator> motionEstimator() const { return motionEstimator_; }
77
78     void setDeblurer(Ptr<DeblurerBase> val) { deblurer_ = val; }
79     Ptr<DeblurerBase> deblurrer() const { return deblurer_; }
80
81     void setTrimRatio(float val) { trimRatio_ = val; }
82     float trimRatio() const { return trimRatio_; }
83
84     void setCorrectionForInclusion(bool val) { doCorrectionForInclusion_ = val; }
85     bool doCorrectionForInclusion() const { return doCorrectionForInclusion_; }
86
87     void setBorderMode(int val) { borderMode_ = val; }
88     int borderMode() const { return borderMode_; }
89
90     void setInpainter(Ptr<InpainterBase> val) { inpainter_ = val; }
91     Ptr<InpainterBase> inpainter() const { return inpainter_; }
92
93 protected:
94     StabilizerBase();
95
96     void setUp(int cacheSize, const Mat &frame);
97     Mat nextStabilizedFrame();
98     bool doOneIteration();
99     void stabilizeFrame(const Mat &stabilizationMotion);
100
101     virtual void setUp(Mat &firstFrame) = 0;
102     virtual void stabilizeFrame() = 0;
103     virtual void estimateMotion() = 0;
104
105     Ptr<ILog> log_;
106     Ptr<IFrameSource> frameSource_;
107     Ptr<IGlobalMotionEstimator> motionEstimator_;
108     Ptr<DeblurerBase> deblurer_;
109     Ptr<InpainterBase> inpainter_;
110     int radius_;
111     float trimRatio_;
112     bool doCorrectionForInclusion_;
113     int borderMode_;
114
115     Size frameSize_;
116     Mat frameMask_;
117     int curPos_;
118     int curStabilizedPos_;
119     bool doDeblurring_;
120     Mat preProcessedFrame_;
121     bool doInpainting_;
122     Mat inpaintingMask_;
123     std::vector<Mat> frames_;
124     std::vector<Mat> motions_; // motions_[i] is the motion from i-th to i+1-th frame
125     std::vector<float> blurrinessRates_;
126     std::vector<Mat> stabilizedFrames_;
127     std::vector<Mat> stabilizedMasks_;
128     std::vector<Mat> stabilizationMotions_;
129 };
130
131 class CV_EXPORTS OnePassStabilizer : public StabilizerBase, public IFrameSource
132 {
133 public:
134     OnePassStabilizer();
135
136     void setMotionFilter(Ptr<MotionFilterBase> val) { motionFilter_ = val; }
137     Ptr<MotionFilterBase> motionFilter() const { return motionFilter_; }
138
139     virtual void reset() { resetImpl(); }
140     virtual Mat nextFrame() { return nextStabilizedFrame(); }
141
142 private:
143     void resetImpl();
144
145     virtual void setUp(Mat &firstFrame);
146     virtual void estimateMotion();
147     virtual void stabilizeFrame();
148
149     Ptr<MotionFilterBase> motionFilter_;
150 };
151
152 class CV_EXPORTS TwoPassStabilizer : public StabilizerBase, public IFrameSource
153 {
154 public:
155     TwoPassStabilizer();
156
157     void setMotionStabilizer(Ptr<IMotionStabilizer> val) { motionStabilizer_ = val; }
158     Ptr<IMotionStabilizer> motionStabilizer() const { return motionStabilizer_; }
159
160     void setEstimateTrimRatio(bool val) { mustEstTrimRatio_ = val; }
161     bool mustEstimateTrimaRatio() const { return mustEstTrimRatio_; }
162
163     virtual void reset() { resetImpl(); }
164     virtual Mat nextFrame();
165
166     // available after pre-pass, before it's empty
167     std::vector<Mat> motions() const;
168
169 private:
170     void resetImpl();
171     void runPrePassIfNecessary();
172
173     virtual void setUp(Mat &firstFrame);
174     virtual void estimateMotion() { /* do nothing as motion was estimation in pre-pass */ }
175     virtual void stabilizeFrame();
176
177     Ptr<IMotionStabilizer> motionStabilizer_;
178     bool mustEstTrimRatio_;
179
180     int frameCount_;
181     bool isPrePassDone_;
182 };
183
184 } // namespace videostab
185 } // namespace cv
186
187 #endif