OpenShot Library | libopenshot  0.2.5
Negate.h
Go to the documentation of this file.
1 /**
2  * @file
3  * @brief Header file for Negate 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_NEGATE_EFFECT_H
32 #define OPENSHOT_NEGATE_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 "../KeyFrame.h"
45 
46 namespace openshot
47 {
48 
49  /**
50  * @brief This class uses the ImageMagick++ libraries, to negate image (i.e. negative)
51  *
52  * This produces a common negative effect popular in photography.
53  */
54  class Negate : public EffectBase
55  {
56  public:
57 
58  /// Default constructor
59  Negate();
60 
61  /// @brief This method is required for all derived classes of EffectBase, and returns a
62  /// modified openshot::Frame object
63  ///
64  /// The frame object is passed into this method, and a frame_number is passed in which
65  /// tells the effect which settings to use from its keyframes (starting at 1).
66  ///
67  /// @returns The modified openshot::Frame object
68  /// @param frame The frame object that needs the effect applied to it
69  /// @param frame_number The frame number (starting at 1) of the effect on the timeline.
70  std::shared_ptr<Frame> GetFrame(std::shared_ptr<Frame> frame, int64_t frame_number);
71 
72  /// Get and Set JSON methods
73  std::string Json() const override; ///< Generate JSON string of this object
74  void SetJson(const std::string value); ///< Load JSON string into this object
75  Json::Value JsonValue() const override; ///< Generate Json::Value for this object
76  void SetJsonValue(const Json::Value root); ///< Load Json::Value into this object
77 
78  // Get all properties for a specific frame
79  std::string PropertiesJSON(int64_t requested_frame) const override;
80  };
81 
82 }
83 
84 #endif
openshot::Negate::JsonValue
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Negate.cpp:68
openshot::EffectBase
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:66
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: AudioBufferSource.h:38
openshot::Negate::GetFrame
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: Negate.cpp:51
openshot::Negate::SetJson
void SetJson(const std::string value)
Load JSON string into this object.
Definition: Negate.cpp:79
openshot::Negate::Json
std::string Json() const override
Get and Set JSON methods.
Definition: Negate.cpp:61
openshot::Negate::Negate
Negate()
Default constructor.
Definition: Negate.cpp:36
openshot::Negate
This class uses the ImageMagick++ libraries, to negate image (i.e. negative)
Definition: Negate.h:54
openshot::Negate::SetJsonValue
void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition: Negate.cpp:96
openshot::Negate::PropertiesJSON
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Negate.cpp:104