Refactored videostab module, added base class for woobble suppression
[profile/ivi/opencv.git] / modules / videostab / include / opencv2 / videostab / wobble_suppression.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_WOBBLE_SUPPRESSION_HPP__
44 #define __OPENCV_VIDEOSTAB_WOBBLE_SUPPRESSION_HPP__
45
46 #include <vector>
47 #include "opencv2/core/core.hpp"
48 #include "opencv2/videostab/global_motion.hpp"
49
50 namespace cv
51 {
52 namespace videostab
53 {
54
55 class CV_EXPORTS WobbleSuppressorBase
56 {
57 public:
58     virtual ~WobbleSuppressorBase() {}
59
60     virtual void setFrames(const std::vector<Mat> &val) { frames_ = &val; }
61     virtual const std::vector<Mat>& frames() const { return *frames_; }
62
63     virtual void setMotions(const std::vector<Mat> &val) { motions_ = &val; }
64     virtual const std::vector<Mat>& motions() const { return *motions_; }
65
66     virtual void setStabilizedFrames(const std::vector<Mat> &val) { stabilizedFrames_ = &val; }
67     virtual const std::vector<Mat>& stabilizedFrames() const { return *stabilizedFrames_; }
68
69     virtual void setStabilizationMotions(const std::vector<Mat> &val) { stabilizationMotions_ = &val; }
70     virtual const std::vector<Mat>& stabilizationMotions() const { return *stabilizationMotions_; }
71
72     virtual void suppress(int idx, Mat &frame) = 0;
73
74 protected:
75     const std::vector<Mat> *frames_;
76     const std::vector<Mat> *motions_;
77     const std::vector<Mat> *stabilizedFrames_;
78     const std::vector<Mat> *stabilizationMotions_;
79 };
80
81 class CV_EXPORTS NullWobbleSuppressor : public WobbleSuppressorBase
82 {
83 public:
84     virtual void suppress(int idx, Mat &result);
85 };
86
87 } // namespace videostab
88 } // namespace cv
89
90 #endif
91