Caption.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_CAPTION_EFFECT_H
#define OPENSHOT_CAPTION_EFFECT_H
 
#include <memory>
#include <string>
#include <vector>
#include <QFont>
#include <QFontMetrics>
#include <QRegularExpression>
#include "../Color.h"
#include "../EffectBase.h"
#include "../Json.h"
#include "../KeyFrame.h"
 
 
 
namespace openshot
{
 
class Caption : public EffectBase
{
private:
    std::vector<QRegularExpressionMatch> matchedCaptions; 
    std::string caption_text;    
    QFontMetrics* metrics;       
    QFont* font;                 
    bool is_dirty;
 
    void init_effect_details();
 
    void process_regex();
 
 
public:
    Color color;         
    Color stroke;        
    Color background;    
    Keyframe background_alpha;     
    Keyframe background_corner;    
    Keyframe background_padding;    
    Keyframe stroke_width;  
    Keyframe font_size;     
    Keyframe font_alpha;     
    Keyframe line_spacing;   
    Keyframe left;       
    Keyframe top;        
    Keyframe right;      
    Keyframe fade_in;        
    Keyframe fade_out;       
    std::string font_name;  
 
    Caption();
 
    Caption(std::string captions);
 
    std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override { return GetFrame(std::make_shared<openshot::Frame>(), frame_number); }
 
    std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
 
    // Get and Set caption data
    std::string CaptionText(); 
    void CaptionText(std::string new_caption_text); 
 
    // Get and Set JSON methods
    std::string Json() const override; 
    void SetJson(const std::string value) override; 
    Json::Value JsonValue() const override; 
    void SetJsonValue(const Json::Value root) override; 
 
    std::string PropertiesJSON(int64_t requested_frame) const override;
};
 
}  // namespace openshot
 
#endif  // OPENSHOT_CAPTION_EFFECT_H