Loading...
Searching...
No Matches
Profiles.cpp
Go to the documentation of this file.
// Copyright (c) 2008-2019 OpenShot Studios, LLC
//
// SPDX-License-Identifier: LGPL-3.0-or-later
#include <iomanip>
#include "Profiles.h"
#include "Exceptions.h"
using namespace openshot;
// default constructor
Profile::Profile() {
// Initialize info values
info.description = "";
info.height = 0;
info.width = 0;
info.pixel_format = 0;
info.fps.num = 0;
info.fps.den = 0;
info.pixel_ratio.num = 0;
info.pixel_ratio.den = 0;
info.display_ratio.num = 0;
info.display_ratio.den = 0;
info.interlaced_frame = false;
info.spherical = false; // Default to non-spherical (regular) video
}
// @brief Constructor for Profile.
// @param path The folder path / location of a profile file
Profile::Profile(std::string path) {
bool read_file = false;
// Initialize all values to defaults (same as default constructor)
info.description = "";
info.height = 0;
info.width = 0;
info.pixel_format = 0;
info.fps.num = 0;
info.fps.den = 0;
info.pixel_ratio.num = 0;
info.pixel_ratio.den = 0;
info.display_ratio.num = 0;
info.display_ratio.den = 0;
info.interlaced_frame = false;
info.spherical = false; // Default to non-spherical (regular) video
try
{
QFile inputFile(path.c_str());
if (inputFile.open(QIODevice::ReadOnly))
{
QTextStream in(&inputFile);
while (!in.atEnd())
{
QString line = in.readLine();
if (line.length() <= 0)
continue;
// Split current line
QStringList parts = line.split( "=" );
std::string setting = parts[0].toStdString();
std::string value = parts[1].toStdString();
int value_int = 0;
// update struct (based on line number)
if (setting == "description") {
info.description = value;
}
else if (setting == "frame_rate_num") {
value_int = std::stoi(value);
info.fps.num = value_int;
}
else if (setting == "frame_rate_den") {
value_int = std::stoi(value);
info.fps.den = value_int;
}
else if (setting == "width") {
value_int = std::stoi(value);
info.width = value_int;
}
else if (setting == "height") {
value_int = std::stoi(value);
info.height = value_int;
}
else if (setting == "progressive") {
value_int = std::stoi(value);
info.interlaced_frame = !(bool)value_int;
}
else if (setting == "sample_aspect_num") {
value_int = std::stoi(value);
info.pixel_ratio.num = value_int;
}
else if (setting == "sample_aspect_den") {
value_int = std::stoi(value);
info.pixel_ratio.den = value_int;
}
else if (setting == "display_aspect_num") {
value_int = std::stoi(value);
info.display_ratio.num = value_int;
}
else if (setting == "display_aspect_den") {
value_int = std::stoi(value);
info.display_ratio.den = value_int;
}
else if (setting == "colorspace") {
value_int = std::stoi(value);
info.pixel_format = value_int;
}
else if (setting == "spherical") {
value_int = std::stoi(value);
info.spherical = (bool)value_int;
}
}
read_file = true;
inputFile.close();
}
}
catch (const std::exception& e)
{
// Error parsing profile file
throw InvalidFile("Profile could not be found or loaded (or is invalid).", path);
}
// Throw error if file was not read
if (!read_file)
// Error parsing profile file
throw InvalidFile("Profile could not be found or loaded (or is invalid).", path);
}
// Return a formatted FPS
std::string Profile::formattedFPS(bool include_decimal) {
// Format FPS to use 2 decimals (if needed)
if (!include_decimal) {
int fps_code = 0;
if (info.fps.den == 1) {
// Exact integer FPS (e.g. 24 → 0024)
fps_code = info.fps.num;
} else {
// Fractional FPS, scale by 100 (e.g. 29.97 → 2997)
fps_code = static_cast<int>((info.fps.num * 100.0) / info.fps.den + 0.5);
}
char buffer[5];
std::snprintf(buffer, sizeof(buffer), "%04d", fps_code);
return std::string(buffer);
}
// Human-readable version for display
float fps = info.fps.ToFloat();
if (std::fabs(fps - std::round(fps)) < 0.01) {
return std::to_string(static_cast<int>(std::round(fps)));
}
char buffer[16];
std::snprintf(buffer, sizeof(buffer), "%.2f", fps);
return std::string(buffer);
}
// Return a unique key of this profile (01920x1080i2997_16-09)
std::string Profile::Key() {
std::string raw_fps = formattedFPS(false);
// Pad FPS string to 4 characters with leading zeros
std::string fps_padded = std::string(4 - raw_fps.length(), '0') + raw_fps;
char buffer[64];
std::snprintf(buffer, sizeof(buffer), "%05dx%04d%s%s_%02d-%02d",
info.width,
info.height,
info.interlaced_frame ? "i" : "p",
fps_padded.c_str(),
info.display_ratio.num,
info.display_ratio.den
);
std::string result(buffer);
if (info.spherical)
result += "_360";
return result;
}
// Return the name of this profile (1920x1080p29.97)
std::string Profile::ShortName() {
std::string progressive_str = info.interlaced_frame ? "i" : "p";
std::string fps_string = formattedFPS(true);
std::string result = std::to_string(info.width) + "x" + std::to_string(info.height) + progressive_str + fps_string;
if (info.spherical)
result += " 360°";
return result;
}
// Return a longer format name (1920x1080p @ 29.97 fps (16:9))
std::string Profile::LongName() {
std::string progressive_str = info.interlaced_frame ? "i" : "p";
std::string fps_string = formattedFPS(true);
std::string result = std::to_string(info.width) + "x" + std::to_string(info.height) +
progressive_str + " @ " + fps_string +
" fps (" + std::to_string(info.display_ratio.num) + ":" +
std::to_string(info.display_ratio.den) + ")";
if (info.spherical)
result += " 360°";
return result;
}
// Return a longer format name (1920x1080p @ 29.97 fps (16:9) HD 1080i 29.97 fps)
std::string Profile::LongNameWithDesc() {
std::string progressive_str = info.interlaced_frame ? "i" : "p";
std::string fps_string = formattedFPS(true);
std::string result = std::to_string(info.width) + "x" + std::to_string(info.height) +
progressive_str + " @ " + fps_string +
" fps (" + std::to_string(info.display_ratio.num) + ":" +
std::to_string(info.display_ratio.den) + ")";
if (info.spherical)
result += " 360°";
if (!info.description.empty())
result += " " + info.description;
return result;
}
// Save profile to file system
void Profile::Save(const std::string& file_path) const {
std::ofstream file(file_path);
if (!file.is_open()) {
throw std::ios_base::failure("Failed to save profile.");
}
file << "description=" << info.description << "\n";
file << "frame_rate_num=" << info.fps.num << "\n";
file << "frame_rate_den=" << info.fps.den << "\n";
file << "width=" << info.width << "\n";
file << "height=" << info.height << "\n";
file << "progressive=" << !info.interlaced_frame << "\n"; // Correct the boolean value for progressive/interlaced
file << "sample_aspect_num=" << info.pixel_ratio.num << "\n";
file << "sample_aspect_den=" << info.pixel_ratio.den << "\n";
file << "display_aspect_num=" << info.display_ratio.num << "\n";
file << "display_aspect_den=" << info.display_ratio.den << "\n";
file << "pixel_format=" << info.pixel_format << "\n";
file << "spherical=" << info.spherical;
file.close();
}
// Generate JSON string of this object
std::string Profile::Json() const {
// Return formatted string
return JsonValue().toStyledString();
}
// Generate Json::Value for this object
Json::Value Profile::JsonValue() const {
// Create root json object
Json::Value root;
root["description"] = info.description;
root["height"] = info.height;
root["width"] = info.width;
root["pixel_format"] = info.pixel_format;
root["fps"] = Json::Value(Json::objectValue);
root["fps"]["num"] = info.fps.num;
root["fps"]["den"] = info.fps.den;
root["pixel_ratio"] = Json::Value(Json::objectValue);
root["pixel_ratio"]["num"] = info.pixel_ratio.num;
root["pixel_ratio"]["den"] = info.pixel_ratio.den;
root["display_ratio"] = Json::Value(Json::objectValue);
root["display_ratio"]["num"] = info.display_ratio.num;
root["display_ratio"]["den"] = info.display_ratio.den;
root["progressive"] = !info.interlaced_frame;
root["spherical"] = info.spherical;
// return JsonValue
return root;
}
// Load JSON string into this object
void Profile::SetJson(const std::string value) {
// Parse JSON string into JSON objects
try
{
const Json::Value root = openshot::stringToJson(value);
// Set all values that match
SetJsonValue(root);
}
catch (const std::exception& e)
{
// Error parsing JSON (or missing keys)
throw InvalidJSON("JSON is invalid (missing keys or invalid data types)");
}
}
// Load Json::Value into this object
void Profile::SetJsonValue(const Json::Value root) {
if (!root["description"].isNull())
info.description = root["description"].asString();
if (!root["height"].isNull())
info.height = root["height"].asInt();
if (!root["width"].isNull())
info.width = root["width"].asInt();
if (!root["pixel_format"].isNull())
info.pixel_format = root["pixel_format"].asInt();
if (!root["fps"].isNull()) {
info.fps.num = root["fps"]["num"].asInt();
info.fps.den = root["fps"]["den"].asInt();
}
if (!root["pixel_ratio"].isNull()) {
info.pixel_ratio.num = root["pixel_ratio"]["num"].asInt();
info.pixel_ratio.den = root["pixel_ratio"]["den"].asInt();
info.pixel_ratio.Reduce();
}
if (!root["display_ratio"].isNull()) {
info.display_ratio.num = root["display_ratio"]["num"].asInt();
info.display_ratio.den = root["display_ratio"]["den"].asInt();
info.display_ratio.Reduce();
}
if (!root["progressive"].isNull())
info.interlaced_frame = !root["progressive"].asBool();
if (!root["spherical"].isNull())
info.spherical = root["spherical"].asBool();
}
Exceptions.h
Header file for all Exception classes.
path
path
Definition FFmpegWriter.cpp:1468
Profiles.h
Header file for Profile class.
openshot::Fraction::num
int num
Numerator for the fraction.
Definition Fraction.h:32
openshot::Fraction::den
int den
Denominator for the fraction.
Definition Fraction.h:33
openshot::InvalidFile
Exception for files that can not be found or opened.
Definition Exceptions.h:188
openshot::InvalidJSON
Exception for invalid JSON.
Definition Exceptions.h:218
openshot::Profile::LongName
std::string LongName()
Return a longer format name (1920x1080p @ 29.97 fps (16:9)).
Definition Profiles.cpp:207
openshot::Profile::SetJsonValue
void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition Profiles.cpp:312
openshot::Profile::ShortName
std::string ShortName()
Return the name of this profile (1920x1080p29.97).
Definition Profiles.cpp:196
openshot::Profile::Profile
Profile()
Default Constructor for Profile.
Definition Profiles.cpp:20
openshot::Profile::Save
void Save(const std::string &file_path) const
Save profile to a text file (label=value, one per line format).
Definition Profiles.cpp:240
openshot::Profile::LongNameWithDesc
std::string LongNameWithDesc()
Return a longer format name with description (1920x1080p @ 29.97 fps (16:9) HD 1080i 29....
Definition Profiles.cpp:221
openshot::Profile::Json
std::string Json() const
Generate JSON string of this object.
Definition Profiles.cpp:263
openshot::Profile::info
ProfileInfo info
Profile data stored here.
Definition Profiles.h:136
openshot::Profile::SetJson
void SetJson(const std::string value)
Load JSON string into this object.
Definition Profiles.cpp:295
openshot::Profile::Key
std::string Key()
Return a unique key of this profile with padding (01920x1080i2997_16:09).
Definition Profiles.cpp:173
openshot::Profile::JsonValue
Json::Value JsonValue() const
Generate Json::Value for this object.
Definition Profiles.cpp:270
openshot
This namespace is the default namespace for all code in the openshot library.
Definition Compressor.h:29
openshot::stringToJson
const Json::Value stringToJson(const std::string value)
Definition Json.cpp:16
openshot::ProfileInfo::fps
Fraction fps
Frames per second, as a fraction (i.e. 24/1 = 24 fps).
Definition Profiles.h:44