ClipBase.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_CLIPBASE_H
#define OPENSHOT_CLIPBASE_H
 
#include <memory>
#include "CacheMemory.h"
#include "Frame.h"
#include "Point.h"
#include "KeyFrame.h"
#include "Json.h"
#include "TimelineBase.h"
 
 
namespace openshot {
    class ClipBase {
    protected:
        std::string id; 
        float position; 
        int layer; 
        float start; 
        float end; 
        std::string previous_properties; 
        openshot::TimelineBase* timeline; 
 
        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;
 
        Json::Value add_property_choice_json(std::string name, int value, int selected_value) const;
 
    public:
        ClipBase() :
            position(0.0),
            layer(0),
            start(0.0),
            end(0.0),
            previous_properties(""),
            timeline(nullptr) {}
 
        // Compare a clip using the Position() property
        bool operator< ( ClipBase& a) { return (Position() < a.Position()); }
        bool operator<= ( ClipBase& a) { return (Position() <= a.Position()); }
        bool operator> ( ClipBase& a) { return (Position() > a.Position()); }
        bool operator>= ( ClipBase& a) { return (Position() >= a.Position()); }
 
        virtual std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) = 0;
 
        virtual std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) = 0;
 
        // Get basic properties
        std::string Id() const { return id; } 
        float Position() const { return position; } 
        int Layer() const { return layer; } 
        float Start() const { return start; } 
        virtual float End() const { return end; } 
        float Duration() const { return end - start; } 
        virtual openshot::TimelineBase* ParentTimeline() { return timeline; } 
 
        // Set basic properties
        void Id(std::string value) { id = value; } 
        void Position(float value); 
        void Layer(int value); 
        void Start(float value); 
        virtual void End(float value); 
        virtual void ParentTimeline(openshot::TimelineBase* new_timeline) { timeline = new_timeline; } 
 
        // Get and Set JSON methods
        virtual std::string Json() const = 0; 
        virtual void SetJson(const std::string value) = 0; 
        virtual Json::Value JsonValue() const = 0; 
        virtual void SetJsonValue(const Json::Value root) = 0; 
 
        virtual std::string PropertiesJSON(int64_t requested_frame) const = 0;
 
        virtual ~ClipBase() = default;
    };
 
 
}
 
#endif