OpenShot Library | libopenshot  0.3.0
Saturation.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_SATURATION_EFFECT_H
14 #define OPENSHOT_SATURATION_EFFECT_H
15 
16 #include "../EffectBase.h"
17 
18 #include <cmath>
19 #include <ctime>
20 #include <iostream>
21 #include <omp.h>
22 #include <stdio.h>
23 #include <memory>
24 #include "../Color.h"
25 #include "../Exceptions.h"
26 #include "../Json.h"
27 #include "../KeyFrame.h"
28 #include "../ReaderBase.h"
29 #include "../FFmpegReader.h"
30 #include "../QtImageReader.h"
31 #include "../ChunkReader.h"
32 
33 namespace openshot
34 {
35 
42  class Saturation : public EffectBase
43  {
44  private:
46  void init_effect_details();
47 
48  public:
53 
55  Saturation();
56 
63  Saturation(Keyframe saturation, Keyframe saturation_R, Keyframe saturation_G, Keyframe saturation_B);
64 
71  std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override { return GetFrame(std::make_shared<openshot::Frame>(), frame_number); }
72 
82  std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
83 
84  // Get and Set JSON methods
85  std::string Json() const override;
86  void SetJson(const std::string value) override;
87  Json::Value JsonValue() const override;
88  void SetJsonValue(const Json::Value root) override;
89 
92  std::string PropertiesJSON(int64_t requested_frame) const override;
93  };
94 
95 }
96 
97 #endif
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:52
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Saturation.cpp:154
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Saturation.cpp:203
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition: Saturation.cpp:186
Saturation()
Blank constructor, useful when using Json to load the effect properties.
Definition: Saturation.cpp:19
std::string Json() const override
Generate JSON string of this object.
Definition: Saturation.cpp:147
Keyframe saturation_R
Red color saturation.
Definition: Saturation.h:50
Keyframe saturation_G
Green color saturation.
Definition: Saturation.h:51
This class adjusts the saturation of color on a frame&#39;s image.
Definition: Saturation.h:42
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:28
Keyframe saturation_B
Blue color saturation.
Definition: Saturation.h:52
void SetJson(const std::string value) override
Load JSON string into this object.
Definition: Saturation.cpp:169
A Keyframe is a collection of Point instances, which is used to vary a number or property over time...
Definition: KeyFrame.h:54
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: Saturation.h:71
Keyframe saturation
Overall color saturation: 0.0 = greyscale, 1.0 = normal, 2.0 = double saturation. ...
Definition: Saturation.h:49