OpenShot Library | libopenshot  0.2.6
Crop.h
Go to the documentation of this file.
1 /**
2  * @file
3  * @brief Header file for Crop 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_CROP_EFFECT_H
32 #define OPENSHOT_CROP_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 <memory>
42 #include <string>
43 
44 
45 namespace openshot
46 {
47 
48  /**
49  * @brief This class crops a frame image (from any side), and can be animated with
50  * openshot::Keyframe curves over time.
51  *
52  * Cropping images can be useful when wanting to remove a border around an image or video, and animating
53  * the crop can create some very interesting effects.
54  */
55  class Crop : public EffectBase
56  {
57  private:
58  /// Init effect settings
59  void init_effect_details();
60 
61 
62  public:
63  Color color; ///< Color of bars
64  Keyframe left; ///< Size of left bar
65  Keyframe top; ///< Size of top bar
66  Keyframe right; ///< Size of right bar
67  Keyframe bottom; ///< Size of bottom bar
68 
69  /// Blank constructor, useful when using Json to load the effect properties
70  Crop();
71 
72  /// Default constructor, which takes 4 curves. These curves animate the crop over time.
73  ///
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)
78  Crop(Keyframe left, Keyframe top, Keyframe right, Keyframe bottom);
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
Keyframe top
Size of top bar.
Definition: Crop.h:65
This class crops a frame image (from any side), and can be animated with openshot::Keyframe curves ov...
Definition: Crop.h:55
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:70
Keyframe right
Size of right bar.
Definition: Crop.h:66
void SetJson(const std::string value) override
Load JSON string into this object.
Definition: Crop.cpp:141
Keyframe left
Size of left bar.
Definition: Crop.h:64
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Crop.cpp:126
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition: Crop.cpp:158
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: Crop.h:86
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Crop.cpp:175
Keyframe bottom
Size of bottom bar.
Definition: Crop.h:67
Color color
Color of bars.
Definition: Crop.h:63
This class represents a color (used on the timeline and clips)
Definition: Color.h:45
std::string Json() const override
Generate JSON string of this object.
Definition: Crop.cpp:119
Crop()
Blank constructor, useful when using Json to load the effect properties.
Definition: Crop.cpp:37
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:46
A Keyframe is a collection of Point instances, which is used to vary a number or property over time...
Definition: KeyFrame.h:72