OpenShot Library | libopenshot  0.1.9
Deinterlace.h
Go to the documentation of this file.
1 /**
2  * @file
3  * @brief Header file for De-interlace class
4  * @author Jonathan Thomas <jonathan@openshot.org>
5  *
6  * @section LICENSE
7  *
8  * Copyright (c) 2008-2014 OpenShot Studios, LLC
9  * <http://www.openshotstudios.com/>. This file is part of
10  * OpenShot Library (libopenshot), an open-source project dedicated to
11  * delivering high quality video editing and animation solutions to the
12  * world. For more information visit <http://www.openshot.org/>.
13  *
14  * OpenShot Library (libopenshot) is free software: you can redistribute it
15  * and/or modify it under the terms of the GNU Lesser General Public License
16  * as published by the Free Software Foundation, either version 3 of the
17  * License, or (at your option) any later version.
18  *
19  * OpenShot Library (libopenshot) is distributed in the hope that it will be
20  * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22  * GNU Lesser General Public License for more details.
23  *
24  * You should have received a copy of the GNU Lesser General Public License
25  * along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
26  */
27 
28 #ifndef OPENSHOT_DEINTERLACE_EFFECT_H
29 #define OPENSHOT_DEINTERLACE_EFFECT_H
30 
31 #include "../EffectBase.h"
32 
33 #include <cmath>
34 #include <ctime>
35 #include <iostream>
36 #include <omp.h>
37 #include <stdio.h>
38 #include <memory>
39 #include "../Color.h"
40 #include "../Exceptions.h"
41 #include "../Json.h"
42 #include "../KeyFrame.h"
43 
44 using namespace std;
45 
46 namespace openshot
47 {
48 
49  /**
50  * @brief This class uses the ImageMagick++ libraries, to de-interlace the image, which
51  * removes the EVEN or ODD horizontal lines (which represent different points of time).
52  *
53  * This is most useful when converting video made for traditional TVs to computers,
54  * which are not interlaced.
55  */
56  class Deinterlace : public EffectBase
57  {
58  private:
59  bool isOdd;
60 
61  /// Init effect settings
62  void init_effect_details();
63 
64  public:
65 
66  /// Blank constructor, useful when using Json to load the effect properties
67  Deinterlace();
68 
69  /// Default constructor
70  Deinterlace(bool isOdd);
71 
72  /// @brief This method is required for all derived classes of EffectBase, and returns a
73  /// modified openshot::Frame object
74  ///
75  /// The frame object is passed into this method, and a frame_number is passed in which
76  /// tells the effect which settings to use from it's keyframes (starting at 1).
77  ///
78  /// @returns The modified openshot::Frame object
79  /// @param frame The frame object that needs the effect applied to it
80  /// @param frame_number The frame number (starting at 1) of the effect on the timeline.
81  std::shared_ptr<Frame> GetFrame(std::shared_ptr<Frame> frame, int64_t frame_number);
82 
83  /// Get and Set JSON methods
84  string Json(); ///< Generate JSON string of this object
85  void SetJson(string value); ///< Load JSON string into this object
86  Json::Value JsonValue(); ///< Generate Json::JsonValue for this object
87  void SetJsonValue(Json::Value root); ///< Load Json::JsonValue into this object
88 
89  // Get all properties for a specific frame
90  string PropertiesJSON(int64_t requested_frame);
91  };
92 
93 }
94 
95 #endif
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:66
This namespace is the default namespace for all code in the openshot library.
This class uses the ImageMagick++ libraries, to de-interlace the image, which removes the EVEN or ODD...
Definition: Deinterlace.h:56