OpenShot Library | libopenshot 0.2.7
Bars.h
Go to the documentation of this file.
1/**
2 * @file
3 * @brief Header file for Bars effect class
4 * @author Jonathan Thomas <jonathan@openshot.org>
5 *
6 * @ref License
7 */
8
9/* LICENSE
10 *
11 * Copyright (c) 2008-2019 OpenShot Studios, LLC
12 * <http://www.openshotstudios.com/>. This file is part of
13 * OpenShot Library (libopenshot), an open-source project dedicated to
14 * delivering high quality video editing and animation solutions to the
15 * world. For more information visit <http://www.openshot.org/>.
16 *
17 * OpenShot Library (libopenshot) is free software: you can redistribute it
18 * and/or modify it under the terms of the GNU Lesser General Public License
19 * as published by the Free Software Foundation, either version 3 of the
20 * License, or (at your option) any later version.
21 *
22 * OpenShot Library (libopenshot) is distributed in the hope that it will be
23 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU Lesser General Public License for more details.
26 *
27 * You should have received a copy of the GNU Lesser General Public License
28 * along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
29 */
30
31#ifndef OPENSHOT_BARS_EFFECT_H
32#define OPENSHOT_BARS_EFFECT_H
33
34#include "../EffectBase.h"
35
36#include "../Color.h"
37#include "../Frame.h"
38#include "../Json.h"
39#include "../KeyFrame.h"
40
41#include <string>
42#include <memory>
43
44namespace openshot
45{
46
47 /**
48 * @brief This class draws black bars around your video (from any side), and can be animated with
49 * openshot::Keyframe curves over time.
50 *
51 * Adding bars around your video can be done for cinematic reasons, and creates a fun way to frame
52 * in the focal point of a scene. The bars can be any color, and each side can be animated independently.
53 */
54 class Bars : public EffectBase
55 {
56 private:
57 /// Init effect settings
58 void init_effect_details();
59
60
61 public:
62 Color color; ///< Color of bars
63 Keyframe left; ///< Size of left bar
64 Keyframe top; ///< Size of top bar
65 Keyframe right; ///< Size of right bar
66 Keyframe bottom; ///< Size of bottom bar
67
68 /// Blank constructor, useful when using Json to load the effect properties
69 Bars();
70
71 /// Default constructor, which takes 4 curves and a color. These curves animated the bars over time.
72 ///
73 /// @param color The curve to adjust the color of bars
74 /// @param left The curve to adjust the left bar size (between 0 and 1)
75 /// @param top The curve to adjust the top bar size (between 0 and 1)
76 /// @param right The curve to adjust the right bar size (between 0 and 1)
77 /// @param bottom The curve to adjust the bottom bar size (between 0 and 1)
79
80 /// @brief This method is required for all derived classes of ClipBase, and returns a
81 /// new openshot::Frame object. All Clip keyframes and effects are resolved into
82 /// pixels.
83 ///
84 /// @returns A new openshot::Frame object
85 /// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline.
86 std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override { return GetFrame(std::make_shared<openshot::Frame>(), frame_number); }
87
88 /// @brief This method is required for all derived classes of ClipBase, and returns a
89 /// modified openshot::Frame object
90 ///
91 /// The frame object is passed into this method and used as a starting point (pixels and audio).
92 /// All Clip keyframes and effects are resolved into pixels.
93 ///
94 /// @returns The modified openshot::Frame object
95 /// @param frame The frame object that needs the clip or effect applied to it
96 /// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline.
97 std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
98
99 // Get and Set JSON methods
100 std::string Json() const override; ///< Generate JSON string of this object
101 void SetJson(const std::string value) override; ///< Load JSON string into this object
102 Json::Value JsonValue() const override; ///< Generate Json::Value for this object
103 void SetJsonValue(const Json::Value root) override; ///< Load Json::Value into this object
104
105 /// Get all properties for a specific frame (perfect for a UI to display the current state
106 /// of all properties at any time)
107 std::string PropertiesJSON(int64_t requested_frame) const override;
108 };
109
110}
111
112#endif
This class draws black bars around your video (from any side), and can be animated with openshot::Key...
Definition: Bars.h:55
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Bars.cpp:178
Keyframe right
Size of right bar.
Definition: Bars.h:65
Keyframe top
Size of top bar.
Definition: Bars.h:64
std::string Json() const override
Generate JSON string of this object.
Definition: Bars.cpp:119
void SetJson(const std::string value) override
Load JSON string into this object.
Definition: Bars.cpp:142
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition: Bars.cpp:159
Bars()
Blank constructor, useful when using Json to load the effect properties.
Definition: Bars.cpp:37
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Bars.cpp:126
Keyframe bottom
Size of bottom bar.
Definition: Bars.h:66
std::shared_ptr< openshot::Frame > GetFrame(int64_t frame_number) override
This method is required for all derived classes of ClipBase, and returns a new openshot::Frame object...
Definition: Bars.h:86
Keyframe left
Size of left bar.
Definition: Bars.h:63
Color color
Color of bars.
Definition: Bars.h:62
This class represents a color (used on the timeline and clips)
Definition: Color.h:45
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:71
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
Definition: KeyFrame.h:72
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:47