OpenShot Library | libopenshot  0.3.3
Brightness.h
Go to the documentation of this file.
1 
9 // Copyright (c) 2008-2019 OpenShot Studios, LLC
10 //
11 // SPDX-License-Identifier: LGPL-3.0-or-later
12 
13 #ifndef OPENSHOT_BRIGHTNESS_EFFECT_H
14 #define OPENSHOT_BRIGHTNESS_EFFECT_H
15 
16 #include "../EffectBase.h"
17 
18 #include "../Frame.h"
19 #include "../Json.h"
20 #include "../KeyFrame.h"
21 
22 #include <memory>
23 #include <string>
24 
25 namespace openshot
26 {
27 
34  class Brightness : public EffectBase
35  {
36  private:
38  void init_effect_details();
39 
40  public:
43 
45  Brightness();
46 
48  // contrast of a frame's image.
52  Brightness(Keyframe new_brightness, Keyframe new_contrast);
53 
60  std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override { return GetFrame(std::make_shared<openshot::Frame>(), frame_number); }
61 
71  std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
72 
73  // Get and Set JSON methods
74  std::string Json() const override;
75  void SetJson(const std::string value) override;
76  Json::Value JsonValue() const override;
77  void SetJsonValue(const Json::Value root) override;
78 
81  std::string PropertiesJSON(int64_t requested_frame) const override;
82  };
83 
84 }
85 
86 #endif
openshot::Brightness::PropertiesJSON
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Brightness.cpp:146
openshot::EffectBase
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:53
openshot::Brightness::GetFrame
std::shared_ptr< openshot::Frame > GetFrame(int64_t frame_number) override
This method is required for all derived classes of ClipBase, and returns a new openshot::Frame object...
Definition: Brightness.h:60
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:28
openshot::Brightness::Json
std::string Json() const override
Generate JSON string of this object.
Definition: Brightness.cpp:96
openshot::Brightness
This class adjusts the brightness and contrast of an image, and can be animated with openshot::Keyfra...
Definition: Brightness.h:34
openshot::Brightness::brightness
Keyframe brightness
Brightness keyframe. A constant value here will prevent animation.
Definition: Brightness.h:41
openshot::Keyframe
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
Definition: KeyFrame.h:53
openshot::Brightness::JsonValue
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Brightness.cpp:103
openshot::Brightness::SetJson
void SetJson(const std::string value) override
Load JSON string into this object.
Definition: Brightness.cpp:116
openshot::Brightness::Brightness
Brightness()
Blank constructor, useful when using Json to load the effect properties.
Definition: Brightness.cpp:19
openshot::Brightness::contrast
Keyframe contrast
Contrast keyframe.
Definition: Brightness.h:42
openshot::Brightness::SetJsonValue
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition: Brightness.cpp:133