OpenShot Library | libopenshot  0.2.2
Crop.cpp
Go to the documentation of this file.
1 /**
2  * @file
3  * @brief Source file for Crop 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/Crop.h"
29 
30 using namespace openshot;
31 
32 /// Blank constructor, useful when using Json to load the effect properties
33 Crop::Crop() : left(0.1), top(0.1), right(0.1), bottom(0.1) {
34  // Init effect properties
35  init_effect_details();
36 }
37 
38 // Default constructor
39 Crop::Crop(Keyframe left, Keyframe top, Keyframe right, Keyframe bottom) :
40  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 Crop::init_effect_details()
48 {
49  /// Initialize the values of the EffectInfo struct.
51 
52  /// Set the effect info
53  info.class_name = "Crop";
54  info.name = "Crop";
55  info.description = "Crop out any part of your video.";
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> Crop::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 transparent color (and create small transparent image)
68  std::shared_ptr<QImage> tempColor = std::shared_ptr<QImage>(new QImage(frame_image->width(), 1, QImage::Format_RGBA8888));
69  tempColor->fill(QColor(QString::fromStdString("transparent")));
70 
71  // Get current keyframe values
72  double left_value = left.GetValue(frame_number);
73  double top_value = top.GetValue(frame_number);
74  double right_value = right.GetValue(frame_number);
75  double bottom_value = bottom.GetValue(frame_number);
76 
77  // Get pixel array pointers
78  unsigned char *pixels = (unsigned char *) frame_image->bits();
79  unsigned char *color_pixels = (unsigned char *) tempColor->bits();
80 
81  // Get pixels sizes of all crop sides
82  int top_bar_height = top_value * frame_image->height();
83  int bottom_bar_height = bottom_value * frame_image->height();
84  int left_bar_width = left_value * frame_image->width();
85  int right_bar_width = right_value * frame_image->width();
86 
87  // Loop through rows
88  for (int row = 0; row < frame_image->height(); row++) {
89 
90  // Top & Bottom Crop
91  if ((top_bar_height > 0.0 && row <= top_bar_height) || (bottom_bar_height > 0.0 && row >= frame_image->height() - bottom_bar_height)) {
92  memcpy(&pixels[row * frame_image->width() * 4], color_pixels, sizeof(char) * frame_image->width() * 4);
93  } else {
94  // Left Crop
95  if (left_bar_width > 0.0) {
96  memcpy(&pixels[row * frame_image->width() * 4], color_pixels, sizeof(char) * left_bar_width * 4);
97  }
98 
99  // Right Crop
100  if (right_bar_width > 0.0) {
101  memcpy(&pixels[((row * frame_image->width()) + (frame_image->width() - right_bar_width)) * 4], color_pixels, sizeof(char) * right_bar_width * 4);
102  }
103  }
104  }
105 
106  // Cleanup colors and arrays
107  tempColor.reset();
108 
109  // return the modified frame
110  return frame;
111 }
112 
113 // Generate JSON string of this object
114 string Crop::Json() {
115 
116  // Return formatted string
117  return JsonValue().toStyledString();
118 }
119 
120 // Generate Json::JsonValue for this object
121 Json::Value Crop::JsonValue() {
122 
123  // Create root json object
124  Json::Value root = EffectBase::JsonValue(); // get parent properties
125  root["type"] = info.class_name;
126  root["left"] = left.JsonValue();
127  root["top"] = top.JsonValue();
128  root["right"] = right.JsonValue();
129  root["bottom"] = bottom.JsonValue();
130 
131  // return JsonValue
132  return root;
133 }
134 
135 // Load JSON string into this object
136 void Crop::SetJson(string value) {
137 
138  // Parse JSON string into JSON objects
139  Json::Value root;
140  Json::Reader reader;
141  bool success = reader.parse( value, root );
142  if (!success)
143  // Raise exception
144  throw InvalidJSON("JSON could not be parsed (or is invalid)", "");
145 
146  try
147  {
148  // Set all values that match
149  SetJsonValue(root);
150  }
151  catch (exception e)
152  {
153  // Error parsing JSON (or missing keys)
154  throw InvalidJSON("JSON is invalid (missing keys or invalid data types)", "");
155  }
156 }
157 
158 // Load Json::JsonValue into this object
159 void Crop::SetJsonValue(Json::Value root) {
160 
161  // Set parent data
163 
164  // Set data from Json (if key is found)
165  if (!root["left"].isNull())
166  left.SetJsonValue(root["left"]);
167  if (!root["top"].isNull())
168  top.SetJsonValue(root["top"]);
169  if (!root["right"].isNull())
170  right.SetJsonValue(root["right"]);
171  if (!root["bottom"].isNull())
172  bottom.SetJsonValue(root["bottom"]);
173 }
174 
175 // Get all properties for a specific frame
176 string Crop::PropertiesJSON(int64_t requested_frame) {
177 
178  // Generate JSON properties list
179  Json::Value root;
180  root["id"] = add_property_json("ID", 0.0, "string", Id(), NULL, -1, -1, true, requested_frame);
181  root["position"] = add_property_json("Position", Position(), "float", "", NULL, 0, 1000 * 60 * 30, false, requested_frame);
182  root["layer"] = add_property_json("Track", Layer(), "int", "", NULL, 0, 20, false, requested_frame);
183  root["start"] = add_property_json("Start", Start(), "float", "", NULL, 0, 1000 * 60 * 30, false, requested_frame);
184  root["end"] = add_property_json("End", End(), "float", "", NULL, 0, 1000 * 60 * 30, false, requested_frame);
185  root["duration"] = add_property_json("Duration", Duration(), "float", "", NULL, 0, 1000 * 60 * 30, true, requested_frame);
186 
187  // Keyframes
188  root["left"] = add_property_json("Left Size", left.GetValue(requested_frame), "float", "", &left, 0.0, 1.0, false, requested_frame);
189  root["top"] = add_property_json("Top Size", top.GetValue(requested_frame), "float", "", &top, 0.0, 1.0, false, requested_frame);
190  root["right"] = add_property_json("Right Size", right.GetValue(requested_frame), "float", "", &right, 0.0, 1.0, false, requested_frame);
191  root["bottom"] = add_property_json("Bottom Size", 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::Crop::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: Crop.cpp:62
openshot::EffectBase::info
EffectInfoStruct info
Information about the current effect.
Definition: EffectBase.h:73
openshot::Crop::right
Keyframe right
Size of right bar.
Definition: Crop.h:64
openshot::Crop::PropertiesJSON
string PropertiesJSON(int64_t requested_frame)
Definition: Crop.cpp:176
openshot::ClipBase::Id
void Id(string value)
Set basic properties.
Definition: ClipBase.h:90
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: AudioBufferSource.h:45
openshot::Crop::bottom
Keyframe bottom
Size of bottom bar.
Definition: Crop.h:65
openshot::EffectInfoStruct::class_name
string class_name
The class name of the effect.
Definition: EffectBase.h:51
openshot::Crop::left
Keyframe left
Size of left bar.
Definition: Crop.h:62
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::Crop::SetJsonValue
void SetJsonValue(Json::Value root)
Load Json::JsonValue into this object.
Definition: Crop.cpp:159
openshot::Keyframe::GetValue
double GetValue(int64_t index)
Get the value at a specific index.
Definition: KeyFrame.cpp:226
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::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::EffectInfoStruct::description
string description
The description of this effect and what it does.
Definition: EffectBase.h:54
openshot::Crop::JsonValue
Json::Value JsonValue()
Generate Json::JsonValue for this object.
Definition: Crop.cpp:121
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::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::Crop::SetJson
void SetJson(string value)
Load JSON string into this object.
Definition: Crop.cpp:136
openshot::Crop::Json
string Json()
Get and Set JSON methods.
Definition: Crop.cpp:114
openshot::Crop::Crop
Crop()
Blank constructor, useful when using Json to load the effect properties.
Definition: Crop.cpp:33
openshot::Keyframe::SetJsonValue
void SetJsonValue(Json::Value root)
Load Json::JsonValue into this object.
Definition: KeyFrame.cpp:362
openshot::Crop::top
Keyframe top
Size of top bar.
Definition: Crop.h:63