OpenShot Library | libopenshot  0.5.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 {
38  };
39 
46  class Saturation : public EffectBase
47  {
48  private:
50  void init_effect_details();
51 
52  protected:
53  bool UseCustomMaskBlend(int64_t frame_number) const override;
54  void ApplyCustomMaskBlend(std::shared_ptr<QImage> original_image, std::shared_ptr<QImage> effected_image,
55  std::shared_ptr<QImage> mask_image, int64_t frame_number) const override;
56 
57  public:
62  int mask_mode;
63 
65  Saturation();
66 
74 
81  std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override { return GetFrame(std::make_shared<openshot::Frame>(), frame_number); }
82 
92  std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
93 
94  // Get and Set JSON methods
95  std::string Json() const override;
96  void SetJson(const std::string value) override;
97  Json::Value JsonValue() const override;
98  void SetJsonValue(const Json::Value root) override;
99 
102  std::string PropertiesJSON(int64_t requested_frame) const override;
103  };
104 
105 }
106 
107 #endif
openshot::EffectBase
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:56
openshot::Saturation::Json
std::string Json() const override
Generate JSON string of this object.
Definition: Saturation.cpp:235
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:28
openshot::Saturation
This class adjusts the saturation of color on a frame's image.
Definition: Saturation.h:46
openshot::SaturationMaskMode
SaturationMaskMode
Definition: Saturation.h:35
openshot::Saturation::mask_mode
int mask_mode
How to apply common masks to saturation (post-blend or drive-amount).
Definition: Saturation.h:62
openshot::Saturation::saturation_R
Keyframe saturation_R
Red color saturation.
Definition: Saturation.h:59
openshot::Saturation::SetJsonValue
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition: Saturation.cpp:275
openshot::Saturation::JsonValue
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Saturation.cpp:242
openshot::SATURATION_MASK_DRIVE_AMOUNT
@ SATURATION_MASK_DRIVE_AMOUNT
Definition: Saturation.h:37
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::Saturation::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: Saturation.h:81
openshot::Saturation::saturation_G
Keyframe saturation_G
Green color saturation.
Definition: Saturation.h:60
openshot::Saturation::saturation_B
Keyframe saturation_B
Blue color saturation.
Definition: Saturation.h:61
openshot::Saturation::UseCustomMaskBlend
bool UseCustomMaskBlend(int64_t frame_number) const override
Optional override for effects that need custom mask behavior.
Definition: Saturation.cpp:36
openshot::Saturation::PropertiesJSON
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Saturation.cpp:294
openshot::Saturation::ApplyCustomMaskBlend
void ApplyCustomMaskBlend(std::shared_ptr< QImage > original_image, std::shared_ptr< QImage > effected_image, std::shared_ptr< QImage > mask_image, int64_t frame_number) const override
Optional override for effects with custom mask implementation.
Definition: Saturation.cpp:41
openshot::Saturation::Saturation
Saturation()
Blank constructor, useful when using Json to load the effect properties.
Definition: Saturation.cpp:21
openshot::SATURATION_MASK_POST_BLEND
@ SATURATION_MASK_POST_BLEND
Definition: Saturation.h:36
openshot::Saturation::SetJson
void SetJson(const std::string value) override
Load JSON string into this object.
Definition: Saturation.cpp:258
openshot::Saturation::saturation
Keyframe saturation
Overall color saturation: 0.0 = greyscale, 1.0 = normal, 2.0 = double saturation.
Definition: Saturation.h:58