OpenShot Library | libopenshot  0.2.2
Pixelate.cpp
Go to the documentation of this file.
1 /**
2  * @file
3  * @brief Source file for Pixelate effect class
4  * @author Jonathan Thomas <jonathan@openshot.org>
5  *
6  * @section LICENSE
7  *
8  * Copyright (c) 2008-2014 OpenShot Studios, LLC
9  * <http://www.openshotstudios.com/>. This file is part of
10  * OpenShot Library (libopenshot), an open-source project dedicated to
11  * delivering high quality video editing and animation solutions to the
12  * world. For more information visit <http://www.openshot.org/>.
13  *
14  * OpenShot Library (libopenshot) is free software: you can redistribute it
15  * and/or modify it under the terms of the GNU Lesser General Public License
16  * as published by the Free Software Foundation, either version 3 of the
17  * License, or (at your option) any later version.
18  *
19  * OpenShot Library (libopenshot) is distributed in the hope that it will be
20  * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22  * GNU Lesser General Public License for more details.
23  *
24  * You should have received a copy of the GNU Lesser General Public License
25  * along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
26  */
27 
28 #include "../../include/effects/Pixelate.h"
29 
30 using namespace openshot;
31 
32 /// Blank constructor, useful when using Json to load the effect properties
33 Pixelate::Pixelate() : pixelization(0.7), left(0.0), top(0.0), right(0.0), bottom(0.0) {
34  // Init effect properties
35  init_effect_details();
36 }
37 
38 // Default constructor
39 Pixelate::Pixelate(Keyframe pixelization, Keyframe left, Keyframe top, Keyframe right, Keyframe bottom) :
40  pixelization(pixelization), left(left), top(top), right(right), bottom(bottom)
41 {
42  // Init effect properties
43  init_effect_details();
44 }
45 
46 // Init effect settings
47 void Pixelate::init_effect_details()
48 {
49  /// Initialize the values of the EffectInfo struct.
51 
52  /// Set the effect info
53  info.class_name = "Pixelate";
54  info.name = "Pixelate";
55  info.description = "Pixelate (increase or decrease) the number of visible pixels.";
56  info.has_audio = false;
57  info.has_video = true;
58 }
59 
60 // This method is required for all derived classes of EffectBase, and returns a
61 // modified openshot::Frame object
62 std::shared_ptr<Frame> Pixelate::GetFrame(std::shared_ptr<Frame> frame, int64_t frame_number)
63 {
64  // Get the frame's image
65  std::shared_ptr<QImage> frame_image = frame->GetImage();
66 
67  // Get current keyframe values
68  double pixelization_value = 1.0 - min(fabs(pixelization.GetValue(frame_number)), 1.0);
69  double left_value = left.GetValue(frame_number);
70  double top_value = top.GetValue(frame_number);
71  double right_value = right.GetValue(frame_number);
72  double bottom_value = bottom.GetValue(frame_number);
73 
74  if (pixelization_value > 0.0) {
75  // Resize frame image smaller (based on pixelization value)
76  std::shared_ptr<QImage> smaller_frame_image = std::shared_ptr<QImage>(new QImage(frame_image->scaledToWidth(max(frame_image->width() * pixelization_value, 2.0), Qt::SmoothTransformation)));
77 
78  // Resize image back to original size (with no smoothing to create pixelated image)
79  std::shared_ptr<QImage> pixelated_image = std::shared_ptr<QImage>(new QImage(smaller_frame_image->scaledToWidth(frame_image->width(), Qt::FastTransformation).convertToFormat(QImage::Format_RGBA8888)));
80 
81  // Get pixel array pointer
82  unsigned char *pixels = (unsigned char *) frame_image->bits();
83  unsigned char *pixelated_pixels = (unsigned char *) pixelated_image->bits();
84 
85  // Get pixels sizes of all margins
86  int top_bar_height = top_value * frame_image->height();
87  int bottom_bar_height = bottom_value * frame_image->height();
88  int left_bar_width = left_value * frame_image->width();
89  int right_bar_width = right_value * frame_image->width();
90 
91  // Loop through rows
92  for (int row = 0; row < frame_image->height(); row++) {
93 
94  // Copy pixelated pixels into original frame image (where needed)
95  if ((row >= top_bar_height) && (row <= frame_image->height() - bottom_bar_height)) {
96  memcpy(&pixels[(row * frame_image->width() + left_bar_width) * 4], &pixelated_pixels[(row * frame_image->width() + left_bar_width) * 4], sizeof(char) * (frame_image->width() - left_bar_width - right_bar_width) * 4);
97  }
98  }
99 
100  // Cleanup temp images
101  smaller_frame_image.reset();
102  pixelated_image.reset();
103  }
104 
105  // return the modified frame
106  return frame;
107 }
108 
109 // Generate JSON string of this object
110 string Pixelate::Json() {
111 
112  // Return formatted string
113  return JsonValue().toStyledString();
114 }
115 
116 // Generate Json::JsonValue for this object
117 Json::Value Pixelate::JsonValue() {
118 
119  // Create root json object
120  Json::Value root = EffectBase::JsonValue(); // get parent properties
121  root["type"] = info.class_name;
122  root["pixelization"] = pixelization.JsonValue();
123  root["left"] = left.JsonValue();
124  root["top"] = top.JsonValue();
125  root["right"] = right.JsonValue();
126  root["bottom"] = bottom.JsonValue();
127 
128  // return JsonValue
129  return root;
130 }
131 
132 // Load JSON string into this object
133 void Pixelate::SetJson(string value) {
134 
135  // Parse JSON string into JSON objects
136  Json::Value root;
137  Json::Reader reader;
138  bool success = reader.parse( value, root );
139  if (!success)
140  // Raise exception
141  throw InvalidJSON("JSON could not be parsed (or is invalid)", "");
142 
143  try
144  {
145  // Set all values that match
146  SetJsonValue(root);
147  }
148  catch (exception e)
149  {
150  // Error parsing JSON (or missing keys)
151  throw InvalidJSON("JSON is invalid (missing keys or invalid data types)", "");
152  }
153 }
154 
155 // Load Json::JsonValue into this object
156 void Pixelate::SetJsonValue(Json::Value root) {
157 
158  // Set parent data
160 
161  // Set data from Json (if key is found)
162  if (!root["pixelization"].isNull())
163  pixelization.SetJsonValue(root["pixelization"]);
164  if (!root["left"].isNull())
165  left.SetJsonValue(root["left"]);
166  if (!root["top"].isNull())
167  top.SetJsonValue(root["top"]);
168  if (!root["right"].isNull())
169  right.SetJsonValue(root["right"]);
170  if (!root["bottom"].isNull())
171  bottom.SetJsonValue(root["bottom"]);
172 }
173 
174 // Get all properties for a specific frame
175 string Pixelate::PropertiesJSON(int64_t requested_frame) {
176 
177  // Generate JSON properties list
178  Json::Value root;
179  root["id"] = add_property_json("ID", 0.0, "string", Id(), NULL, -1, -1, true, requested_frame);
180  root["position"] = add_property_json("Position", Position(), "float", "", NULL, 0, 1000 * 60 * 30, false, requested_frame);
181  root["layer"] = add_property_json("Track", Layer(), "int", "", NULL, 0, 20, false, requested_frame);
182  root["start"] = add_property_json("Start", Start(), "float", "", NULL, 0, 1000 * 60 * 30, false, requested_frame);
183  root["end"] = add_property_json("End", End(), "float", "", NULL, 0, 1000 * 60 * 30, false, requested_frame);
184  root["duration"] = add_property_json("Duration", Duration(), "float", "", NULL, 0, 1000 * 60 * 30, true, requested_frame);
185 
186  // Keyframes
187  root["pixelization"] = add_property_json("Pixelization", pixelization.GetValue(requested_frame), "float", "", &pixelization, 0.0, 0.9999, false, requested_frame);
188  root["left"] = add_property_json("Left Margin", left.GetValue(requested_frame), "float", "", &left, 0.0, 1.0, false, requested_frame);
189  root["top"] = add_property_json("Top Margin", top.GetValue(requested_frame), "float", "", &top, 0.0, 1.0, false, requested_frame);
190  root["right"] = add_property_json("Right Margin", right.GetValue(requested_frame), "float", "", &right, 0.0, 1.0, false, requested_frame);
191  root["bottom"] = add_property_json("Bottom Margin", bottom.GetValue(requested_frame), "float", "", &bottom, 0.0, 1.0, false, requested_frame);
192 
193  // Return formatted string
194  return root.toStyledString();
195 }
196 
openshot::EffectBase::info
EffectInfoStruct info
Information about the current effect.
Definition: EffectBase.h:73
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: AudioBufferSource.h:45
openshot::ClipBase::Start
float Start()
Get start position (in seconds) of clip (trim start of video)
Definition: ClipBase.h:85
openshot::EffectInfoStruct::class_name
string class_name
The class name of the effect.
Definition: EffectBase.h:51
openshot::ClipBase::Id
string Id()
Get basic properties.
Definition: ClipBase.h:82
openshot::Pixelate::pixelization
Keyframe pixelization
Amount of pixelization.
Definition: Pixelate.h:60
openshot::Pixelate::JsonValue
Json::Value JsonValue()
Generate Json::JsonValue for this object.
Definition: Pixelate.cpp:117
openshot::EffectBase::JsonValue
virtual Json::Value JsonValue()=0
Generate Json::JsonValue for this object.
Definition: EffectBase.cpp:81
openshot::ClipBase::add_property_json
Json::Value add_property_json(string name, float value, string type, string memo, Keyframe *keyframe, float min_value, float max_value, bool readonly, int64_t requested_frame)
Generate JSON for a property.
Definition: ClipBase.cpp:65
openshot::Pixelate::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: Pixelate.cpp:62
openshot::Pixelate::SetJson
void SetJson(string value)
Load JSON string into this object.
Definition: Pixelate.cpp:133
openshot::Keyframe::GetValue
double GetValue(int64_t index)
Get the value at a specific index.
Definition: KeyFrame.cpp:226
openshot::Pixelate::bottom
Keyframe bottom
Size of bottom margin.
Definition: Pixelate.h:64
openshot::Keyframe
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
Definition: KeyFrame.h:64
openshot::InvalidJSON
Exception for invalid JSON.
Definition: Exceptions.h:152
openshot::ClipBase::Duration
float Duration()
Get the length of this clip (in seconds)
Definition: ClipBase.h:87
openshot::EffectBase::InitEffectInfo
void InitEffectInfo()
Definition: EffectBase.cpp:33
openshot::EffectInfoStruct::has_audio
bool has_audio
Determines if this effect manipulates the audio of a frame.
Definition: EffectBase.h:56
openshot::Pixelate::right
Keyframe right
Size of right margin.
Definition: Pixelate.h:63
openshot::EffectInfoStruct::description
string description
The description of this effect and what it does.
Definition: EffectBase.h:54
openshot::Keyframe::JsonValue
Json::Value JsonValue()
Generate Json::JsonValue for this object.
Definition: KeyFrame.cpp:321
openshot::EffectInfoStruct::name
string name
The name of the effect.
Definition: EffectBase.h:53
openshot::Pixelate::Json
string Json()
Get and Set JSON methods.
Definition: Pixelate.cpp:110
openshot::EffectBase::SetJsonValue
virtual void SetJsonValue(Json::Value root)=0
Load Json::JsonValue into this object.
Definition: EffectBase.cpp:121
OpenShot Wipe Tests.e
e
Definition: OpenShot Wipe Tests.py:28
openshot::EffectInfoStruct::has_video
bool has_video
Determines if this effect manipulates the image of a frame.
Definition: EffectBase.h:55
openshot::Pixelate::left
Keyframe left
Size of left margin.
Definition: Pixelate.h:61
openshot::ClipBase::End
float End()
Get end position (in seconds) of clip (trim end of video)
Definition: ClipBase.h:86
openshot::Pixelate::Pixelate
Pixelate()
Blank constructor, useful when using Json to load the effect properties.
Definition: Pixelate.cpp:33
openshot::ClipBase::Layer
int Layer()
Get layer of clip on timeline (lower number is covered by higher numbers)
Definition: ClipBase.h:84
openshot::Pixelate::PropertiesJSON
string PropertiesJSON(int64_t requested_frame)
Definition: Pixelate.cpp:175
openshot::Keyframe::SetJsonValue
void SetJsonValue(Json::Value root)
Load Json::JsonValue into this object.
Definition: KeyFrame.cpp:362
openshot::Pixelate::top
Keyframe top
Size of top margin.
Definition: Pixelate.h:62
openshot::Pixelate::SetJsonValue
void SetJsonValue(Json::Value root)
Load Json::JsonValue into this object.
Definition: Pixelate.cpp:156
openshot::ClipBase::Position
float Position()
Get position on timeline (in seconds)
Definition: ClipBase.h:83