EffectBase.cpp
Go to the documentation of this file.
/**
* @file
* @brief Source file for EffectBase class
* @author Jonathan Thomas <jonathan@openshot.org>
*
* @section LICENSE
*
* Copyright (c) 2008-2014 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/EffectBase.h"
using namespace openshot;
// Initialize the values of the FileInfo struct
void EffectBase::InitEffectInfo()
{
// Init clip settings
Position(0.0);
Layer(0);
Start(0.0);
End(0.0);
Order(0);
info.has_video = false;
info.has_audio = false;
info.name = "";
info.description = "";
}
// Display file information
void EffectBase::DisplayInfo() {
cout << fixed << setprecision(2) << boolalpha;
cout << "----------------------------" << endl;
cout << "----- Effect Information -----" << endl;
cout << "----------------------------" << endl;
cout << "--> Name: " << info.name << endl;
cout << "--> Description: " << info.description << endl;
cout << "--> Has Video: " << info.has_video << endl;
cout << "--> Has Audio: " << info.has_audio << endl;
cout << "----------------------------" << endl;
}
// Constrain a color value from 0 to 255
int EffectBase::constrain(int color_value)
{
// Constrain new color from 0 to 255
if (color_value < 0)
color_value = 0;
else if (color_value > 255)
color_value = 255;
return color_value;
}
// Generate JSON string of this object
string EffectBase::Json() {
// Return formatted string
return JsonValue().toStyledString();
}
// Generate Json::JsonValue for this object
Json::Value EffectBase::JsonValue() {
// Create root json object
Json::Value root = ClipBase::JsonValue(); // get parent properties
root["name"] = info.name;
root["class_name"] = info.class_name;
root["short_name"] = info.short_name;
root["description"] = info.description;
root["has_video"] = info.has_video;
root["has_audio"] = info.has_audio;
root["order"] = Order();
// return JsonValue
return root;
}
// Load JSON string into this object
void EffectBase::SetJson(string value) {
// Parse JSON string into JSON objects
Json::Value root;
Json::Reader reader;
bool success = reader.parse( value, root );
if (!success)
// Raise exception
throw InvalidJSON("JSON could not be parsed (or is invalid)", "");
try
{
// Set all values that match
SetJsonValue(root);
}
catch (exception e)
{
// Error parsing JSON (or missing keys)
throw InvalidJSON("JSON is invalid (missing keys or invalid data types)", "");
}
}
// Load Json::JsonValue into this object
void EffectBase::SetJsonValue(Json::Value root) {
// Set parent data
ClipBase::SetJsonValue(root);
// Set data from Json (if key is found)
if (!root["order"].isNull())
Order(root["order"].asInt());
}
// Generate Json::JsonValue for this object
Json::Value EffectBase::JsonInfo() {
// Create root json object
Json::Value root;
root["name"] = info.name;
root["class_name"] = info.class_name;
root["short_name"] = info.short_name;
root["description"] = info.description;
root["has_video"] = info.has_video;
root["has_audio"] = info.has_audio;
// return JsonValue
return root;
}
openshot::EffectBase::info
EffectInfoStruct info
Information about the current effect.
Definition: EffectBase.h:73
openshot::EffectBase::JsonInfo
Json::Value JsonInfo()
Generate JSON object of meta data / info.
Definition: EffectBase.cpp:132
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: AudioBufferSource.h:45
openshot::EffectBase::Json
virtual string Json()=0
Get and Set JSON methods.
Definition: EffectBase.cpp:74
openshot::EffectInfoStruct::class_name
string class_name
The class name of the effect.
Definition: EffectBase.h:51
openshot::EffectBase::Order
int Order()
Get the order that this effect should be executed.
Definition: EffectBase.h:104
openshot::EffectBase::DisplayInfo
void DisplayInfo()
Display effect information in the standard output stream (stdout)
Definition: EffectBase.cpp:49
openshot::EffectBase::JsonValue
virtual Json::Value JsonValue()=0
Generate Json::JsonValue for this object.
Definition: EffectBase.cpp:81
openshot::EffectBase::SetJson
virtual void SetJson(string value)=0
Load JSON string into this object.
Definition: EffectBase.cpp:98
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::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::ClipBase::SetJsonValue
virtual void SetJsonValue(Json::Value root)=0
Load Json::JsonValue into this object.
Definition: ClipBase.cpp:49
openshot::EffectBase::constrain
int constrain(int color_value)
Constrain a color value from 0 to 255.
Definition: EffectBase.cpp:62
openshot::EffectInfoStruct::short_name
string short_name
A short name of the effect, commonly used for icon names, etc...
Definition: EffectBase.h:52
openshot::ClipBase::JsonValue
virtual Json::Value JsonValue()=0
Generate Json::JsonValue for this object.
Definition: ClipBase.cpp:33