OpenShot Library | libopenshot  0.3.3
Pixelate.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_PIXELATE_EFFECT_H
14 #define OPENSHOT_PIXELATE_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 Pixelate : public EffectBase
35  {
36  private:
38  void init_effect_details();
39 
40 
41  public:
47 
49  Pixelate();
50 
59 
66  std::shared_ptr<openshot::Frame>
67  GetFrame(int64_t frame_number) override {
68  return GetFrame(std::make_shared<openshot::Frame>(),
69  frame_number);
70  }
71 
81  std::shared_ptr<openshot::Frame>
82  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:54
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
Definition: KeyFrame.h:53
This class pixelates an image, and can be animated with openshot::Keyframe curves over time.
Definition: Pixelate.h:35
Pixelate()
Default constructor, useful when using Json to load the effect properties.
Definition: Pixelate.cpp:25
Keyframe right
Size of right margin.
Definition: Pixelate.h:45
std::string Json() const override
Generate JSON string of this object.
Definition: Pixelate.cpp:93
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Pixelate.cpp:152
Keyframe pixelization
Amount of pixelization.
Definition: Pixelate.h:42
Keyframe left
Size of left margin.
Definition: Pixelate.h:43
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Pixelate.cpp:100
void SetJson(const std::string value) override
Load JSON string into this object.
Definition: Pixelate.cpp:116
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition: Pixelate.cpp:133
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: Pixelate.h:67
Keyframe top
Size of top margin.
Definition: Pixelate.h:44
Keyframe bottom
Size of bottom margin.
Definition: Pixelate.h:46
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:29