CacheBase.h

Go to the documentation of this file.

 
// Copyright (c) 2008-2019 OpenShot Studios, LLC
//
// SPDX-License-Identifier: LGPL-3.0-or-later
 
#ifndef OPENSHOT_CACHE_BASE_H
#define OPENSHOT_CACHE_BASE_H
 
#include <map>
#include <vector>
#include <memory>
#include <mutex>
#include <algorithm>
 
#include "Json.h"
 
namespace openshot {
    class Frame;
 
    class CacheBase
    {
    protected:
        std::string cache_type; 
        int64_t max_bytes; 
 
        bool needs_range_processing; 
        std::string json_ranges; 
        std::vector<int64_t> ordered_frame_numbers; 
        std::map<int64_t, int64_t> frame_ranges;    
        int64_t range_version; 
        
        std::recursive_mutex *cacheMutex;
 
        void CalculateRanges();
 
    public:
        CacheBase();
 
        CacheBase(int64_t max_bytes);
 
        virtual void Add(std::shared_ptr<openshot::Frame> frame) = 0;
 
        virtual void Clear() = 0;
 
        virtual bool Contains(int64_t frame_number) = 0;
 
        virtual int64_t Count() = 0;
 
        virtual std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) = 0;
 
        virtual std::vector<std::shared_ptr<openshot::Frame>> GetFrames() = 0;
 
        virtual int64_t GetBytes() = 0;
 
        virtual std::shared_ptr<openshot::Frame> GetSmallestFrame() = 0;
 
        virtual void Remove(int64_t frame_number) = 0;
 
        virtual void Remove(int64_t start_frame_number, int64_t end_frame_number) = 0;
 
        virtual void Touch(int64_t frame_number) = 0;
 
        int64_t GetMaxBytes() { return max_bytes; };
 
        void SetMaxBytes(int64_t number_of_bytes) { max_bytes = number_of_bytes; };
 
        void SetMaxBytesFromInfo(int64_t number_of_frames, int width, int height, int sample_rate, int channels);
 
        // Get and Set JSON methods
        virtual std::string Json() = 0; 
        virtual void SetJson(const std::string value) = 0; 
        virtual Json::Value JsonValue() = 0; 
        virtual void SetJsonValue(const Json::Value root) = 0; 
        virtual ~CacheBase() = default;
 
    };
 
}
 
#endif