ClipBase.cpp
Go to the documentation of this file.
/**
* @file
* @brief Source file for EffectBase class
* @author Jonathan Thomas <jonathan@openshot.org>
*
* @ref License
*/
/* LICENSE
*
* Copyright (c) 2008-2019 OpenShot Studios, LLC
* <http://www.openshotstudios.com/>. This file is part of
* OpenShot Library (libopenshot), an open-source project dedicated to
* delivering high quality video editing and animation solutions to the
* world. For more information visit <http://www.openshot.org/>.
*
* OpenShot Library (libopenshot) is free software: you can redistribute it
* and/or modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* OpenShot Library (libopenshot) is distributed in the hope that it will be
* useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
*/
#include "../include/ClipBase.h"
using namespace openshot;
// Generate Json::Value for this object
Json::Value ClipBase::JsonValue() const {
// Create root json object
Json::Value root;
root["id"] = Id();
root["position"] = Position();
root["layer"] = Layer();
root["start"] = Start();
root["end"] = End();
root["duration"] = Duration();
// return JsonValue
return root;
}
// Load Json::Value into this object
void ClipBase::SetJsonValue(const Json::Value root) {
// Set data from Json (if key is found)
if (!root["id"].isNull())
Id(root["id"].asString());
if (!root["position"].isNull())
Position(root["position"].asDouble());
if (!root["layer"].isNull())
Layer(root["layer"].asInt());
if (!root["start"].isNull())
Start(root["start"].asDouble());
if (!root["end"].isNull())
End(root["end"].asDouble());
}
// Generate JSON for a property
Json::Value ClipBase::add_property_json(std::string name, float value, std::string type, std::string memo, const Keyframe* keyframe, float min_value, float max_value, bool readonly, int64_t requested_frame) const {
// Requested Point
const Point requested_point(requested_frame, requested_frame);
// Create JSON Object
Json::Value prop = Json::Value(Json::objectValue);
prop["name"] = name;
prop["value"] = value;
prop["memo"] = memo;
prop["type"] = type;
prop["min"] = min_value;
prop["max"] = max_value;
if (keyframe) {
prop["keyframe"] = keyframe->Contains(requested_point);
prop["points"] = int(keyframe->GetCount());
Point closest_point = keyframe->GetClosestPoint(requested_point);
prop["interpolation"] = closest_point.interpolation;
prop["closest_point_x"] = closest_point.co.X;
prop["previous_point_x"] = keyframe->GetPreviousPoint(closest_point).co.X;
}
else {
prop["keyframe"] = false;
prop["points"] = 0;
prop["interpolation"] = CONSTANT;
prop["closest_point_x"] = -1;
prop["previous_point_x"] = -1;
}
prop["readonly"] = readonly;
prop["choices"] = Json::Value(Json::arrayValue);
// return JsonValue
return prop;
}
Json::Value ClipBase::add_property_choice_json(std::string name, int value, int selected_value) const {
// Create choice
Json::Value new_choice = Json::Value(Json::objectValue);
new_choice["name"] = name;
new_choice["value"] = value;
new_choice["selected"] = (value == selected_value);
// return JsonValue
return new_choice;
}
openshot::ClipBase::End
float End() const
Get end position (in seconds) of clip (trim end of video)
Definition: ClipBase.h:80
openshot::ClipBase::Start
float Start() const
Get start position (in seconds) of clip (trim start of video)
Definition: ClipBase.h:79
openshot::ClipBase::Duration
float Duration() const
Get the length of this clip (in seconds)
Definition: ClipBase.h:81
openshot::ClipBase::Id
std::string Id() const
Get basic properties.
Definition: ClipBase.h:76
openshot::ClipBase::JsonValue
virtual Json::Value JsonValue() const =0
Generate Json::Value for this object.
Definition: ClipBase.cpp:36
openshot::ClipBase::add_property_choice_json
Json::Value add_property_choice_json(std::string name, int value, int selected_value) const
Generate JSON choice for a property (dropdown properties)
Definition: ClipBase.cpp:104
openshot::ClipBase::Layer
int Layer() const
Get layer of clip on timeline (lower number is covered by higher numbers)
Definition: ClipBase.h:78
openshot::ClipBase::SetJsonValue
virtual void SetJsonValue(const Json::Value root)=0
Load Json::Value into this object.
Definition: ClipBase.cpp:52
openshot::ClipBase::Position
float Position() const
Get position on timeline (in seconds)
Definition: ClipBase.h:77
openshot::ClipBase::add_property_json
Json::Value add_property_json(std::string name, float value, std::string type, std::string memo, const Keyframe *keyframe, float min_value, float max_value, bool readonly, int64_t requested_frame) const
Generate JSON for a property.
Definition: ClipBase.cpp:68
openshot::Coordinate::X
double X
The X value of the coordinate (usually representing the frame #)
Definition: Coordinate.h:57
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::Keyframe::Contains
bool Contains(Point p) const
Does this keyframe contain a specific point.
Definition: KeyFrame.cpp:188
openshot::Keyframe::GetPreviousPoint
Point GetPreviousPoint(Point p) const
Get previous point (.
Definition: KeyFrame.cpp:230
openshot::Keyframe::GetCount
int64_t GetCount() const
Get the number of points (i.e. # of points)
Definition: KeyFrame.cpp:510
openshot::Keyframe::GetClosestPoint
Point GetClosestPoint(Point p) const
Get current point (or closest point to the right) from the X coordinate (i.e. the frame number)
Definition: KeyFrame.cpp:225
openshot::Point
A Point is the basic building block of a key-frame curve.
Definition: Point.h:82
openshot::Point::co
Coordinate co
This is the primary coordinate.
Definition: Point.h:84
openshot::Point::interpolation
InterpolationType interpolation
This is the interpolation mode.
Definition: Point.h:87
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: AudioBufferSource.h:39
openshot::CONSTANT
@ CONSTANT
Constant curves jump from their previous position to a new one (with no interpolation).
Definition: Point.h:49