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 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 Keyframe x; ///< X-offset 68 Keyframe y; ///< Y-offset 69 70 /// Blank constructor, useful when using Json to load the effect properties 71 Crop(); 72 73 /// Default constructor, which takes 4 curves. These curves animate the crop over time. 74 /// 75 /// @param left The curve to adjust the left bar size (between 0 and 1) 76 /// @param top The curve to adjust the top bar size (between 0 and 1) 77 /// @param right The curve to adjust the right bar size (between 0 and 1) 78 /// @param bottom The curve to adjust the bottom bar size (between 0 and 1) 79 Crop(Keyframe left, Keyframe top, Keyframe right, Keyframe bottom); 80 81 /// @brief This method is required for all derived classes of ClipBase, and returns a 82 /// new openshot::Frame object. All Clip keyframes and effects are resolved into 83 /// pixels. 84 /// 85 /// @returns A new openshot::Frame object 86 /// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline. GetFrame(int64_t frame_number)87 std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override { return GetFrame(std::make_shared<openshot::Frame>(), frame_number); } 88 89 /// @brief This method is required for all derived classes of ClipBase, and returns a 90 /// modified openshot::Frame object 91 /// 92 /// The frame object is passed into this method and used as a starting point (pixels and audio). 93 /// All Clip keyframes and effects are resolved into pixels. 94 /// 95 /// @returns The modified openshot::Frame object 96 /// @param frame The frame object that needs the clip or effect applied to it 97 /// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline. 98 std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override; 99 100 // Get and Set JSON methods 101 std::string Json() const override; ///< Generate JSON string of this object 102 void SetJson(const std::string value) override; ///< Load JSON string into this object 103 Json::Value JsonValue() const override; ///< Generate Json::Value for this object 104 void SetJsonValue(const Json::Value root) override; ///< Load Json::Value into this object 105 106 /// Get all properties for a specific frame (perfect for a UI to display the current state 107 /// of all properties at any time) 108 std::string PropertiesJSON(int64_t requested_frame) const override; 109 }; 110 111 } 112 113 #endif 114