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