Loading...
Searching...
No Matches
ClipBase.cpp
Go to the documentation of this file.
// Copyright (c) 2008-2019 OpenShot Studios, LLC
//
// SPDX-License-Identifier: LGPL-3.0-or-later
#include "ClipBase.h"
#include "Timeline.h"
using namespace openshot;
// Set position on timeline (in seconds)
void ClipBase::Position(float value) {
position = value;
if (ParentTimeline()) {
// Resort timeline items (internal clips/effects arrays)
Timeline *parentTimeline = (Timeline *) ParentTimeline();
parentTimeline->SortTimeline();
}
}
// Set layer of clip on timeline (lower number is covered by higher numbers)
void ClipBase::Layer(int value) {
layer = value;
if (ParentTimeline()) {
// Resort timeline items (internal clips/effects arrays)
Timeline *parentTimeline = (Timeline *) ParentTimeline();
parentTimeline->SortTimeline();
}
}
// Set start position (in seconds) of clip (trim start of video)
void ClipBase::Start(float value) {
start = value;
if (ParentTimeline()) {
// Resort timeline items (internal clips/effects arrays)
Timeline *parentTimeline = (Timeline *) ParentTimeline();
parentTimeline->SortTimeline();
}
}
// Set end position (in seconds) of clip (trim end of video)
void ClipBase::End(float value) {
end = value;
if (ParentTimeline()) {
// Resort timeline items (internal clips/effects arrays)
Timeline *parentTimeline = (Timeline *) ParentTimeline();
parentTimeline->SortTimeline();
}
}
// 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;
}
ClipBase.h
Header file for ClipBase class.
Timeline.h
Header file for Timeline class.
openshot::ClipBase::Start
float Start() const
Get start position (in seconds) of clip (trim start of video).
Definition ClipBase.h:88
openshot::ClipBase::start
float start
The position in seconds to start playing (used to trim the beginning of a clip).
Definition ClipBase.h:37
openshot::ClipBase::Duration
float Duration() const
Get the length of this clip (in seconds).
Definition ClipBase.h:90
openshot::ClipBase::End
virtual float End() const
Get end position (in seconds) of clip (trim end of video).
Definition ClipBase.h:89
openshot::ClipBase::Id
std::string Id() const
Get the Id of this clip object.
Definition ClipBase.h:85
openshot::ClipBase::JsonValue
virtual Json::Value JsonValue() const =0
Generate Json::Value for this object.
Definition ClipBase.cpp:64
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:132
openshot::ClipBase::Layer
int Layer() const
Get layer of clip on timeline (lower number is covered by higher numbers).
Definition ClipBase.h:87
openshot::ClipBase::SetJsonValue
virtual void SetJsonValue(const Json::Value root)=0
Load Json::Value into this object.
Definition ClipBase.cpp:80
openshot::ClipBase::layer
int layer
The layer this clip is on. Lower clips are covered up by higher clips.
Definition ClipBase.h:36
openshot::ClipBase::Position
float Position() const
Get position on timeline (in seconds).
Definition ClipBase.h:86
openshot::ClipBase::ParentTimeline
virtual openshot::TimelineBase * ParentTimeline()
Get the associated Timeline pointer (if any).
Definition ClipBase.h:91
openshot::ClipBase::position
float position
The position on the timeline where this clip should start playing.
Definition ClipBase.h:35
openshot::ClipBase::end
float end
The position in seconds to end playing (used to trim the ending of a clip).
Definition ClipBase.h:38
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:96
openshot::Coordinate::X
double X
The X value of the coordinate (usually representing the frame #).
Definition Coordinate.h:40
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::Keyframe::Contains
bool Contains(Point p) const
Does this keyframe contain a specific point.
Definition KeyFrame.cpp:184
openshot::Keyframe::GetPreviousPoint
Point GetPreviousPoint(Point p) const
Get previous point (.
Definition KeyFrame.cpp:226
openshot::Keyframe::GetCount
int64_t GetCount() const
Get the number of points (i.e. # of points).
Definition KeyFrame.cpp:424
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:221
openshot::Point
A Point is the basic building block of a key-frame curve.
Definition Point.h:64
openshot::Point::co
Coordinate co
This is the primary coordinate.
Definition Point.h:66
openshot::Point::interpolation
InterpolationType interpolation
This is the interpolation mode.
Definition Point.h:69
openshot::Timeline
This class represents a timeline.
Definition Timeline.h:154
openshot::Timeline::SortTimeline
void SortTimeline()
Sort all clips and effects on timeline - which affects the internal order of clips and effects arrays...
Definition Timeline.h:365
openshot
This namespace is the default namespace for all code in the openshot library.
Definition Compressor.h:29
openshot::CONSTANT
@ CONSTANT
Constant curves jump from their previous position to a new one (with no interpolation).
Definition Point.h:31