OpenShot Library | libopenshot  0.2.0
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  * @section LICENSE
7  *
8  * Copyright (c) 2008-2014 OpenShot Studios, LLC
9  * <http://www.openshotstudios.com/>. This file is part of
10  * OpenShot Library (libopenshot), an open-source project dedicated to
11  * delivering high quality video editing and animation solutions to the
12  * world. For more information visit <http://www.openshot.org/>.
13  *
14  * OpenShot Library (libopenshot) is free software: you can redistribute it
15  * and/or modify it under the terms of the GNU Lesser General Public License
16  * as published by the Free Software Foundation, either version 3 of the
17  * License, or (at your option) any later version.
18  *
19  * OpenShot Library (libopenshot) is distributed in the hope that it will be
20  * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22  * GNU Lesser General Public License for more details.
23  *
24  * You should have received a copy of the GNU Lesser General Public License
25  * along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
26  */
27 
28 #ifndef OPENSHOT_CROP_EFFECT_H
29 #define OPENSHOT_CROP_EFFECT_H
30 
31 #include "../EffectBase.h"
32 
33 #include <cmath>
34 #include <stdio.h>
35 #include <memory>
36 #include "../Color.h"
37 #include "../Json.h"
38 #include "../KeyFrame.h"
39 
40 
41 using namespace std;
42 
43 namespace openshot
44 {
45 
46  /**
47  * @brief This class crops a frame image (from any side), and can be animated with
48  * openshot::Keyframe curves over time.
49  *
50  * Cropping images can be useful when wanting to remove a border around an image or video, and animating
51  * the crop can create some very interesting effects.
52  */
53  class Crop : public EffectBase
54  {
55  private:
56  /// Init effect settings
57  void init_effect_details();
58 
59 
60  public:
61  Color color; ///< Color of bars
62  Keyframe left; ///< Size of left bar
63  Keyframe top; ///< Size of top bar
64  Keyframe right; ///< Size of right bar
65  Keyframe bottom; ///< Size of bottom bar
66 
67  /// Blank constructor, useful when using Json to load the effect properties
68  Crop();
69 
70  /// Default constructor, which takes 4 curves. These curves animate the crop over time.
71  ///
72  /// @param color The curve to adjust the color of bars
73  /// @param left The curve to adjust the left bar size (between 0 and 1)
74  /// @param top The curve to adjust the top bar size (between 0 and 1)
75  /// @param right The curve to adjust the right bar size (between 0 and 1)
76  /// @param bottom The curve to adjust the bottom bar size (between 0 and 1)
77  Crop(Keyframe left, Keyframe top, Keyframe right, Keyframe bottom);
78 
79  /// @brief This method is required for all derived classes of EffectBase, and returns a
80  /// modified openshot::Frame object
81  ///
82  /// The frame object is passed into this method, and a frame_number is passed in which
83  /// tells the effect which settings to use from it's keyframes (starting at 1).
84  ///
85  /// @returns The modified openshot::Frame object
86  /// @param frame The frame object that needs the effect applied to it
87  /// @param frame_number The frame number (starting at 1) of the effect on the timeline.
88  std::shared_ptr<Frame> GetFrame(std::shared_ptr<Frame> frame, int64_t frame_number);
89 
90  /// Get and Set JSON methods
91  string Json(); ///< Generate JSON string of this object
92  void SetJson(string value); ///< Load JSON string into this object
93  Json::Value JsonValue(); ///< Generate Json::JsonValue for this object
94  void SetJsonValue(Json::Value root); ///< Load Json::JsonValue into this object
95 
96  /// Get all properties for a specific frame (perfect for a UI to display the current state
97  /// of all properties at any time)
98  string PropertiesJSON(int64_t requested_frame);
99  };
100 
101 }
102 
103 #endif
Keyframe top
Size of top bar.
Definition: Crop.h:63
This class crops a frame image (from any side), and can be animated with openshot::Keyframe curves ov...
Definition: Crop.h:53
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:66
Keyframe right
Size of right bar.
Definition: Crop.h:64
Keyframe left
Size of left bar.
Definition: Crop.h:62
Keyframe bottom
Size of bottom bar.
Definition: Crop.h:65
Color color
Color of bars.
Definition: Crop.h:61
This class represents a color (used on the timeline and clips)
Definition: Color.h:42
This namespace is the default namespace for all code in the openshot library.
A Keyframe is a collection of Point instances, which is used to vary a number or property over time...
Definition: KeyFrame.h:64