Loading...
Searching...
No Matches
CacheDisk.cpp
Go to the documentation of this file.
// Copyright (c) 2008-2019 OpenShot Studios, LLC
//
// SPDX-License-Identifier: LGPL-3.0-or-later
#include "CacheDisk.h"
#include "Exceptions.h"
#include "Frame.h"
#include "QtUtilities.h"
#include <Qt>
#include <QString>
#include <QTextStream>
using namespace std;
using namespace openshot;
// Default constructor, no max bytes
CacheDisk::CacheDisk(std::string cache_path, std::string format, float quality, float scale) : CacheBase(0) {
// Set cache type name
cache_type = "CacheDisk";
range_version = 0;
needs_range_processing = false;
frame_size_bytes = 0;
image_format = format;
image_quality = quality;
image_scale = scale;
max_bytes = 0;
// Init path directory
InitPath(cache_path);
}
// Constructor that sets the max bytes to cache
CacheDisk::CacheDisk(std::string cache_path, std::string format, float quality, float scale, int64_t max_bytes) : CacheBase(max_bytes) {
// Set cache type name
cache_type = "CacheDisk";
range_version = 0;
needs_range_processing = false;
frame_size_bytes = 0;
image_format = format;
image_quality = quality;
image_scale = scale;
// Init path directory
InitPath(cache_path);
}
// Initialize cache directory
void CacheDisk::InitPath(std::string cache_path) {
QString qpath;
if (!cache_path.empty()) {
// Init QDir with cache directory
qpath = QString(cache_path.c_str());
} else {
// Init QDir with user's temp directory
qpath = QDir::tempPath() + QString("/preview-cache/");
}
// Init QDir with cache directory
path = QDir(qpath);
// Check if cache directory exists
if (!path.exists())
// Create
path.mkpath(qpath);
}
// Default destructor
CacheDisk::~CacheDisk()
{
Clear();
// remove mutex
delete cacheMutex;
}
// Add a Frame to the cache
void CacheDisk::Add(std::shared_ptr<Frame> frame)
{
// Create a scoped lock, to protect the cache from multiple threads
const std::lock_guard<std::recursive_mutex> lock(*cacheMutex);
int64_t frame_number = frame->number;
// Freshen frame if it already exists
if (frames.count(frame_number))
// Move frame to front of queue
Touch(frame_number);
else
{
// Add frame to queue and map
frames[frame_number] = frame_number;
frame_numbers.push_front(frame_number);
ordered_frame_numbers.push_back(frame_number);
needs_range_processing = true;
// Save image to disk (if needed)
QString frame_path(path.path() + "/" + QString("%1.").arg(frame_number) + QString(image_format.c_str()).toLower());
frame->Save(frame_path.toStdString(), image_scale, image_format, image_quality);
if (frame_size_bytes == 0) {
// Get compressed size of frame image (to correctly apply max size against)
QFile image_file(frame_path);
frame_size_bytes = image_file.size();
}
// Save audio data (if needed)
if (frame->has_audio_data) {
QString audio_path(path.path() + "/" + QString("%1").arg(frame_number) + ".audio");
QFile audio_file(audio_path);
if (audio_file.open(QIODevice::WriteOnly)) {
QTextStream audio_stream(&audio_file);
audio_stream << frame->SampleRate() << Qt::endl;
audio_stream << frame->GetAudioChannelsCount() << Qt::endl;
audio_stream << frame->GetAudioSamplesCount() << Qt::endl;
audio_stream << frame->ChannelsLayout() << Qt::endl;
// Loop through all samples
for (int channel = 0; channel < frame->GetAudioChannelsCount(); channel++)
{
// Get audio for this channel
float *samples = frame->GetAudioSamples(channel);
for (int sample = 0; sample < frame->GetAudioSamplesCount(); sample++)
audio_stream << samples[sample] << Qt::endl;
}
}
}
// Clean up old frames
CleanUp();
}
}
// Check if frame is already contained in cache
bool CacheDisk::Contains(int64_t frame_number) {
if (frames.count(frame_number) > 0) {
return true;
} else {
return false;
}
}
// Get a frame from the cache (or NULL shared_ptr if no frame is found)
std::shared_ptr<Frame> CacheDisk::GetFrame(int64_t frame_number)
{
// Create a scoped lock, to protect the cache from multiple threads
const std::lock_guard<std::recursive_mutex> lock(*cacheMutex);
// Does frame exists in cache?
if (frames.count(frame_number)) {
// Does frame exist on disk
QString frame_path(path.path() + "/" + QString("%1.").arg(frame_number) + QString(image_format.c_str()).toLower());
if (path.exists(frame_path)) {
// Load image file
auto image = std::make_shared<QImage>();
image->load(frame_path);
// Set pixel formatimage->
image = std::make_shared<QImage>(image->convertToFormat(QImage::Format_RGBA8888_Premultiplied));
// Create frame object
auto frame = std::make_shared<Frame>();
frame->number = frame_number;
frame->AddImage(image);
// Get audio data (if found)
QString audio_path(path.path() + "/" + QString("%1").arg(frame_number) + ".audio");
QFile audio_file(audio_path);
if (audio_file.exists()) {
// Open audio file
QTextStream in(&audio_file);
if (audio_file.open(QIODevice::ReadOnly)) {
int sample_rate = in.readLine().toInt();
int channels = in.readLine().toInt();
int sample_count = in.readLine().toInt();
int channel_layout = in.readLine().toInt();
// Set basic audio properties
frame->ResizeAudio(channels, sample_count, sample_rate, (ChannelLayout) channel_layout);
// Loop through audio samples and add to frame
int current_channel = 0;
int current_sample = 0;
float *channel_samples = new float[sample_count];
while (!in.atEnd()) {
// Add sample to channel array
channel_samples[current_sample] = in.readLine().toFloat();
current_sample++;
if (current_sample == sample_count) {
// Add audio to frame
frame->AddAudio(true, current_channel, 0, channel_samples, sample_count, 1.0);
// Increment channel, and reset sample position
current_channel++;
current_sample = 0;
}
}
}
}
// return the Frame object
return frame;
}
}
// no Frame found
return std::shared_ptr<Frame>();
}
// @brief Get an array of all Frames
std::vector<std::shared_ptr<openshot::Frame>> CacheDisk::GetFrames()
{
// Create a scoped lock, to protect the cache from multiple threads
const std::lock_guard<std::recursive_mutex> lock(*cacheMutex);
std::vector<std::shared_ptr<openshot::Frame>> all_frames;
std::vector<int64_t>::iterator itr_ordered;
for(itr_ordered = ordered_frame_numbers.begin(); itr_ordered != ordered_frame_numbers.end(); ++itr_ordered)
{
int64_t frame_number = *itr_ordered;
all_frames.push_back(GetFrame(frame_number));
}
return all_frames;
}
// Get the smallest frame number (or NULL shared_ptr if no frame is found)
std::shared_ptr<Frame> CacheDisk::GetSmallestFrame()
{
// Create a scoped lock, to protect the cache from multiple threads
const std::lock_guard<std::recursive_mutex> lock(*cacheMutex);
// Loop through frame numbers
std::deque<int64_t>::iterator itr;
int64_t smallest_frame = -1;
for(itr = frame_numbers.begin(); itr != frame_numbers.end(); ++itr)
{
if (*itr < smallest_frame || smallest_frame == -1)
smallest_frame = *itr;
}
// Return frame (if any)
if (smallest_frame != -1) {
return GetFrame(smallest_frame);
} else {
return NULL;
}
}
// Gets the maximum bytes value
int64_t CacheDisk::GetBytes()
{
// Create a scoped lock, to protect the cache from multiple threads
const std::lock_guard<std::recursive_mutex> lock(*cacheMutex);
int64_t total_bytes = 0;
// Loop through frames, and calculate total bytes
std::deque<int64_t>::reverse_iterator itr;
for(itr = frame_numbers.rbegin(); itr != frame_numbers.rend(); ++itr)
total_bytes += frame_size_bytes;
return total_bytes;
}
// Remove a specific frame
void CacheDisk::Remove(int64_t frame_number)
{
Remove(frame_number, frame_number);
}
// Remove range of frames
void CacheDisk::Remove(int64_t start_frame_number, int64_t end_frame_number)
{
// Create a scoped lock, to protect the cache from multiple threads
const std::lock_guard<std::recursive_mutex> lock(*cacheMutex);
// Loop through frame numbers
std::deque<int64_t>::iterator itr;
for(itr = frame_numbers.begin(); itr != frame_numbers.end();)
{
//deque<int64_t>::iterator current = itr++;
if (*itr >= start_frame_number && *itr <= end_frame_number)
{
// erase frame number
itr = frame_numbers.erase(itr);
} else
itr++;
}
// Loop through ordered frame numbers
std::vector<int64_t>::iterator itr_ordered;
for(itr_ordered = ordered_frame_numbers.begin(); itr_ordered != ordered_frame_numbers.end();)
{
if (*itr_ordered >= start_frame_number && *itr_ordered <= end_frame_number)
{
// erase frame number
frames.erase(*itr_ordered);
// Remove the image file (if it exists)
QString frame_path(path.path() + "/" + QString("%1.").arg(*itr_ordered) + QString(image_format.c_str()).toLower());
QFile image_file(frame_path);
if (image_file.exists())
image_file.remove();
// Remove audio file (if it exists)
QString audio_path(path.path() + "/" + QString("%1").arg(*itr_ordered) + ".audio");
QFile audio_file(audio_path);
if (audio_file.exists())
audio_file.remove();
itr_ordered = ordered_frame_numbers.erase(itr_ordered);
} else
itr_ordered++;
}
// Needs range processing (since cache has changed)
needs_range_processing = true;
}
// Move frame to front of queue (so it lasts longer)
void CacheDisk::Touch(int64_t frame_number)
{
// Does frame exists in cache?
if (frames.count(frame_number))
{
// Create a scoped lock, to protect the cache from multiple threads
const std::lock_guard<std::recursive_mutex> lock(*cacheMutex);
// Loop through frame numbers
std::deque<int64_t>::iterator itr;
for(itr = frame_numbers.begin(); itr != frame_numbers.end(); ++itr)
{
if (*itr == frame_number)
{
// erase frame number
frame_numbers.erase(itr);
// add frame number to 'front' of queue
frame_numbers.push_front(frame_number);
break;
}
}
}
}
// Clear the cache of all frames
void CacheDisk::Clear()
{
// Create a scoped lock, to protect the cache from multiple threads
const std::lock_guard<std::recursive_mutex> lock(*cacheMutex);
// Clear all containers
frames.clear();
frame_numbers.clear();
frame_numbers.shrink_to_fit();
ordered_frame_numbers.clear();
ordered_frame_numbers.shrink_to_fit();
needs_range_processing = true;
frame_size_bytes = 0;
// Delete cache directory, and recreate it
QString current_path = path.path();
path.removeRecursively();
// Re-init folder
InitPath(current_path.toStdString());
}
// Count the frames in the queue
int64_t CacheDisk::Count()
{
// Create a scoped lock, to protect the cache from multiple threads
const std::lock_guard<std::recursive_mutex> lock(*cacheMutex);
// Return the number of frames in the cache
return frames.size();
}
// Clean up cached frames that exceed the number in our max_bytes variable
void CacheDisk::CleanUp()
{
// Do we auto clean up?
if (max_bytes > 0)
{
// Create a scoped lock, to protect the cache from multiple threads
const std::lock_guard<std::recursive_mutex> lock(*cacheMutex);
while (GetBytes() > max_bytes && frame_numbers.size() > 20)
{
// Get the oldest frame number.
int64_t frame_to_remove = frame_numbers.back();
// Remove frame_number and frame
Remove(frame_to_remove);
}
}
}
// Generate JSON string of this object
std::string CacheDisk::Json() {
// Return formatted string
return JsonValue().toStyledString();
}
// Generate Json::Value for this object
Json::Value CacheDisk::JsonValue() {
// Process range data (if anything has changed)
CalculateRanges();
// Create root json object
Json::Value root = CacheBase::JsonValue(); // get parent properties
root["type"] = cache_type;
root["path"] = path.path().toStdString();
Json::Value version;
std::stringstream range_version_str;
range_version_str << range_version;
root["version"] = range_version_str.str();
// Parse and append range data (if any)
// Parse and append range data (if any)
try {
const Json::Value ranges = openshot::stringToJson(json_ranges);
root["ranges"] = ranges;
} catch (...) { }
// return JsonValue
return root;
}
// Load JSON string into this object
void CacheDisk::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 CacheDisk::SetJsonValue(const Json::Value root) {
// Close timeline before we do anything (this also removes all open and closing clips)
Clear();
// Set parent data
CacheBase::SetJsonValue(root);
if (!root["type"].isNull())
cache_type = root["type"].asString();
if (!root["path"].isNull())
// Update duration of timeline
InitPath(root["path"].asString());
}
CacheDisk.h
Header file for CacheDisk class.
Exceptions.h
Header file for all Exception classes.
Frame.h
Header file for Frame class.
QtUtilities.h
Header file for QtUtilities (compatibiity overlay).
openshot::CacheBase::range_version
int64_t range_version
The version of the JSON range data (incremented with each change).
Definition CacheBase.h:44
openshot::CacheBase::CacheBase
CacheBase()
Default constructor, no max bytes.
Definition CacheBase.cpp:19
openshot::CacheBase::JsonValue
virtual Json::Value JsonValue()=0
Generate Json::Value for this object.
Definition CacheBase.cpp:100
openshot::CacheBase::cache_type
std::string cache_type
This is a friendly type name of the derived cache instance.
Definition CacheBase.h:37
openshot::CacheBase::CalculateRanges
void CalculateRanges()
Calculate ranges of frames.
Definition CacheBase.cpp:36
openshot::CacheBase::SetJsonValue
virtual void SetJsonValue(const Json::Value root)=0
Load Json::Value into this object.
Definition CacheBase.cpp:111
openshot::CacheBase::needs_range_processing
bool needs_range_processing
Something has changed, and the range data needs to be re-calculated.
Definition CacheBase.h:40
openshot::CacheBase::max_bytes
int64_t max_bytes
This is the max number of bytes to cache (0 = no limit).
Definition CacheBase.h:38
openshot::CacheBase::cacheMutex
std::recursive_mutex * cacheMutex
Mutex for multiple threads.
Definition CacheBase.h:47
openshot::CacheBase::json_ranges
std::string json_ranges
JSON ranges of frame numbers.
Definition CacheBase.h:41
openshot::CacheBase::ordered_frame_numbers
std::vector< int64_t > ordered_frame_numbers
Ordered list of frame numbers used by cache.
Definition CacheBase.h:42
openshot::CacheDisk::GetFrames
std::vector< std::shared_ptr< openshot::Frame > > GetFrames()
Get an array of all Frames.
Definition CacheDisk.cpp:226
openshot::CacheDisk::GetFrame
std::shared_ptr< openshot::Frame > GetFrame(int64_t frame_number)
Get a frame from the cache.
Definition CacheDisk.cpp:156
openshot::CacheDisk::CacheDisk
CacheDisk(std::string cache_path, std::string format, float quality, float scale)
Default constructor, no max bytes.
Definition CacheDisk.cpp:26
openshot::CacheDisk::~CacheDisk
~CacheDisk()
Definition CacheDisk.cpp:79
openshot::CacheDisk::Contains
bool Contains(int64_t frame_number)
Check if frame is already contained in cache.
Definition CacheDisk.cpp:147
openshot::CacheDisk::Touch
void Touch(int64_t frame_number)
Move frame to front of queue (so it lasts longer).
Definition CacheDisk.cpp:337
openshot::CacheDisk::Json
std::string Json()
Generate JSON string of this object.
Definition CacheDisk.cpp:416
openshot::CacheDisk::Add
void Add(std::shared_ptr< openshot::Frame > frame)
Add a Frame to the cache.
Definition CacheDisk.cpp:88
openshot::CacheDisk::GetSmallestFrame
std::shared_ptr< openshot::Frame > GetSmallestFrame()
Get the smallest frame number.
Definition CacheDisk.cpp:243
openshot::CacheDisk::JsonValue
Json::Value JsonValue()
Generate Json::Value for this object.
Definition CacheDisk.cpp:423
openshot::CacheDisk::Clear
void Clear()
Clear the cache of all frames.
Definition CacheDisk.cpp:363
openshot::CacheDisk::SetJsonValue
void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition CacheDisk.cpp:467
openshot::CacheDisk::SetJson
void SetJson(const std::string value)
Load JSON string into this object.
Definition CacheDisk.cpp:450
openshot::CacheDisk::GetBytes
int64_t GetBytes()
Gets the maximum bytes value.
Definition CacheDisk.cpp:266
openshot::CacheDisk::Count
int64_t Count()
Count the frames in the queue.
Definition CacheDisk.cpp:386
openshot::CacheDisk::Remove
void Remove(int64_t frame_number)
Remove a specific frame.
Definition CacheDisk.cpp:282
openshot::InvalidJSON
Exception for invalid JSON.
Definition Exceptions.h:218
openshot
This namespace is the default namespace for all code in the openshot library.
Definition Compressor.h:29
openshot::ChannelLayout
ChannelLayout
This enumeration determines the audio channel layout (such as stereo, mono, 5 point surround,...
Definition ChannelLayouts.h:29
openshot::stringToJson
const Json::Value stringToJson(const std::string value)
Definition Json.cpp:16