diff --git a/bindings/python/openshot.i b/bindings/python/openshot.i index 29b9c8ee3..9f5616f6e 100644 --- a/bindings/python/openshot.i +++ b/bindings/python/openshot.i @@ -115,6 +115,7 @@ #include "effects/Tracker.h" #include "effects/ObjectDetection.h" #include "effects/Outline.h" + #include "effects/Shadow.h" #include "TrackedObjectBase.h" #include "TrackedObjectBBox.h" %} @@ -357,4 +358,5 @@ %include "effects/Tracker.h" %include "effects/ObjectDetection.h" %include "effects/Outline.h" + %include "effects/Shadow.h" #endif diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 153b2c1ec..792d4a19b 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -100,6 +100,7 @@ set(OPENSHOT_CV_SOURCES effects/Tracker.cpp effects/ObjectDetection.cpp effects/Outline.cpp + effects/Shadow.cpp ./sort_filter/sort.cpp ./sort_filter/Hungarian.cpp ./sort_filter/KalmanTracker.cpp) diff --git a/src/EffectInfo.cpp b/src/EffectInfo.cpp index a9f67028d..1535e7980 100644 --- a/src/EffectInfo.cpp +++ b/src/EffectInfo.cpp @@ -112,6 +112,9 @@ EffectBase* EffectInfo::CreateEffect(std::string effect_type) { #ifdef USE_OPENCV else if (effect_type == "Outline") return new Outline(); + + else if (effect_type == "Shadow") + return new Shadow(); else if(effect_type == "Stabilizer") return new Stabilizer(); @@ -165,6 +168,7 @@ Json::Value EffectInfo::JsonValue() { #ifdef USE_OPENCV root.append(Outline().JsonInfo()); + root.append(Shadow().JsonInfo()); root.append(Stabilizer().JsonInfo()); root.append(Tracker().JsonInfo()); root.append(ObjectDetection().JsonInfo()); diff --git a/src/Effects.h b/src/Effects.h index ad577f32a..96636981a 100644 --- a/src/Effects.h +++ b/src/Effects.h @@ -47,6 +47,7 @@ /* OpenCV Effects */ #ifdef USE_OPENCV +#include "effects/Shadow.h" #include "effects/Outline.h" #include "effects/ObjectDetection.h" #include "effects/Tracker.h" diff --git a/src/Frame.cpp b/src/Frame.cpp index f799bcea9..7c6357100 100644 --- a/src/Frame.cpp +++ b/src/Frame.cpp @@ -2,6 +2,7 @@ * @file * @brief Source file for Frame class * @author Jonathan Thomas + * @author HaiVQ * * @ref License */ @@ -112,6 +113,7 @@ Frame::~Frame() { audio.reset(); #ifdef USE_OPENCV imagecv.release(); + brga_image_cv.release(); #endif } @@ -890,6 +892,13 @@ cv::Mat Frame::GetImageCV() return imagecv; } +// Set pointer to OpenCV image object +void Frame::SetImageCV(cv::Mat _image) +{ + imagecv = _image; + image = Mat2Qimage(_image); +} + std::shared_ptr Frame::Mat2Qimage(cv::Mat img){ cv::cvtColor(img, img, cv::COLOR_BGR2RGB); QImage qimg((uchar*) img.data, img.cols, img.rows, img.step, QImage::Format_RGB888); @@ -903,11 +912,39 @@ std::shared_ptr Frame::Mat2Qimage(cv::Mat img){ return imgIn; } -// Set pointer to OpenCV image object -void Frame::SetImageCV(cv::Mat _image) -{ - imagecv = _image; - image = Mat2Qimage(_image); +// Convert QImage to cv::Mat and vice versa +// Frame class has GetImageCV, but it does not include alpha channel +// so we need a separate methods which preserve alpha channel +cv::Mat Frame::QImage2BGRACvMat(std::shared_ptr& qimage) { + cv::Mat cv_img( + qimage->height(), qimage->width(), + CV_8UC4, (uchar*)qimage->constBits(), + qimage->bytesPerLine() + ); + return cv_img; +} + +// Convert cv::Mat back to QImage +std::shared_ptr Frame::BGRACvMat2QImage(cv::Mat img) { + cv::Mat final_img; + cv::cvtColor(img, final_img, cv::COLOR_BGRA2RGBA); + QImage qimage(final_img.data, final_img.cols, final_img.rows, final_img.step, QImage::Format_ARGB32); + std::shared_ptr imgIn = std::make_shared(qimage.convertToFormat(QImage::Format_RGBA8888_Premultiplied)); + return imgIn; +} + +// Get BGRA +cv::Mat Frame::GetBGRACvMat() { + if (!image) + // Fill with black + AddColor(width, height, color); + brga_image_cv = QImage2BGRACvMat(image); + return brga_image_cv; +} + +void Frame::SetBGRACvMat(cv::Mat _image) { + brga_image_cv = _image; + image = BGRACvMat2QImage(_image); } #endif diff --git a/src/Frame.h b/src/Frame.h index 528a69b85..08cafc2b6 100644 --- a/src/Frame.h +++ b/src/Frame.h @@ -2,6 +2,7 @@ * @file * @brief Header file for Frame class * @author Jonathan Thomas + * @author HaiVQ * * @ref License */ @@ -106,6 +107,7 @@ namespace openshot #ifdef USE_OPENCV cv::Mat imagecv; ///< OpenCV image. It will always be in BGR format + cv::Mat brga_image_cv; ///< OpenCV image. It will always be in BGR format #endif /// Constrain a color value from 0 to 255 @@ -277,6 +279,18 @@ namespace openshot /// Set pointer to OpenCV image object void SetImageCV(cv::Mat _image); + + /// Convert QImage to OpenCV Mat (alpha channel included) + cv::Mat QImage2BGRACvMat(std::shared_ptr& qimage); + + /// Convert OpenCV Mat to QImage (alpha channel included) + std::shared_ptr BGRACvMat2QImage(cv::Mat img); + + /// Get pointer to OpenCV Mat image object (with alpha channel) + cv::Mat GetBGRACvMat(); + + /// Set pointer to OpenCV image object (with alpha channel) + void SetBGRACvMat(cv::Mat _image); #endif }; diff --git a/src/effects/Outline.cpp b/src/effects/Outline.cpp index bcd9e18ba..2948d8dd4 100644 --- a/src/effects/Outline.cpp +++ b/src/effects/Outline.cpp @@ -1,8 +1,9 @@ /** * @file * @brief Source file for Outline effect class - * @author Jonathan Thomas , HaiVQ - * + * @author Jonathan Thomas + * @author HaiVQ + * * @ref License */ @@ -60,12 +61,11 @@ std::shared_ptr Outline::GetFrame(std::shared_ptr frame_image = frame->GetImage(); - + cv::Mat cv_image = frame->GetBGRACvMat(); + float sigmaValue = widthValue / 3.0; if (sigmaValue <= 0.0) sigmaValue = 0.01; - cv::Mat cv_image = QImageToBGRACvMat(frame_image); // Extract alpha channel for the mask std::vector channels(4); @@ -95,25 +95,24 @@ std::shared_ptr Outline::GetFrame(std::shared_ptr new_frame_image = BGRACvMatToQImage(final_image); - - // FIXME: The shared_ptr::swap does not work somehow - *frame_image = *new_frame_image; + frame->SetBGRACvMat(final_image); + return frame; } -cv::Mat Outline::QImageToBGRACvMat(std::shared_ptr& qimage) { - cv::Mat cv_img(qimage->height(), qimage->width(), CV_8UC4, (uchar*)qimage->constBits(), qimage->bytesPerLine()); - return cv_img; -} - -std::shared_ptr Outline::BGRACvMatToQImage(cv::Mat img) { - cv::Mat final_img; - cv::cvtColor(img, final_img, cv::COLOR_RGBA2BGRA); - QImage qimage(final_img.data, final_img.cols, final_img.rows, final_img.step, QImage::Format_ARGB32); - std::shared_ptr imgIn = std::make_shared(qimage.convertToFormat(QImage::Format_RGBA8888_Premultiplied)); - return imgIn; -} +// Moved to Frame.cpp +// cv::Mat Outline::QImageToBGRACvMat(std::shared_ptr& qimage) { +// cv::Mat cv_img(qimage->height(), qimage->width(), CV_8UC4, (uchar*)qimage->constBits(), qimage->bytesPerLine()); +// return cv_img; +// } + +// std::shared_ptr Outline::BGRACvMatToQImage(cv::Mat img) { +// cv::Mat final_img; +// cv::cvtColor(img, final_img, cv::COLOR_RGBA2BGRA); +// QImage qimage(final_img.data, final_img.cols, final_img.rows, final_img.step, QImage::Format_ARGB32); +// std::shared_ptr imgIn = std::make_shared(qimage.convertToFormat(QImage::Format_RGBA8888_Premultiplied)); +// return imgIn; +// } // Generate JSON string of this object std::string Outline::Json() const { diff --git a/src/effects/Outline.h b/src/effects/Outline.h index 99cb91eeb..3e45cad31 100644 --- a/src/effects/Outline.h +++ b/src/effects/Outline.h @@ -1,7 +1,8 @@ /** * @file * @brief Header file for Outline effect class - * @author Jonathan Thomas , HaiVQ + * @author Jonathan Thomas + * @author HaiVQ * * @ref License */ @@ -33,6 +34,7 @@ namespace openshot * with openshot::Keyframe curves over time. * * Outlines can be added around any image or text, and animated over time. + * Idea from: https://stackoverflow.com/a/78480103 */ class Outline : public EffectBase { @@ -40,12 +42,9 @@ namespace openshot /// Init effect settings void init_effect_details(); - // Convert QImage to cv::Mat and vice versa - // Although Frame class has GetImageCV, but it does not include alpha channel - // so we need a separate methods which preserve alpha channel - // Idea from: https://stackoverflow.com/a/78480103 - cv::Mat QImageToBGRACvMat(std::shared_ptr& qimage); - std::shared_ptr BGRACvMatToQImage(cv::Mat img); + // Moved to Frame.h + // cv::Mat QImageToBGRACvMat(std::shared_ptr& qimage); + // std::shared_ptr BGRACvMatToQImage(cv::Mat img); public: Keyframe width; ///< Width of the outline diff --git a/src/effects/Shadow.cpp b/src/effects/Shadow.cpp new file mode 100644 index 000000000..8e02882c1 --- /dev/null +++ b/src/effects/Shadow.cpp @@ -0,0 +1,198 @@ +/** + * @file + * @brief Source file for Shadow effect class + * @author Jonathan Thomas + * @author HaiVQ + * + * @ref License + */ + +// Copyright (c) 2008-2025 OpenShot Studios, LLC +// +// SPDX-License-Identifier: LGPL-3.0-or-later + +#include "Shadow.h" +#include "Exceptions.h" + +using namespace openshot; + +/// Blank constructor, useful when using Json to load the effect properties +Shadow::Shadow() : x_offset(10), y_offset(10), blur_radius(10.0) { + // Init effect properties + color = Color("#000000"); + color.alpha = 128; // alpha = 0.5 + init_effect_details(); +} + +// Default constructor +Shadow::Shadow(Keyframe x_offset, Keyframe y_offset, Keyframe blur_radius, Color color) : + x_offset(x_offset), y_offset(y_offset), blur_radius(blur_radius), color(color) +{ + // Init effect properties + init_effect_details(); +} + +// Init effect settings +void Shadow::init_effect_details() +{ + /// Initialize the values of the EffectInfo struct. + InitEffectInfo(); + + /// Set the effect info + info.class_name = "Shadow"; + info.name = "Shadow"; + info.description = "Drop shadow under any image or text."; + info.has_audio = false; + info.has_video = true; +} + +// This method is required for all derived classes of EffectBase, and returns a +// modified openshot::Frame object +std::shared_ptr Shadow::GetFrame(std::shared_ptr frame, int64_t frame_number) +{ + int x_offsetValue = x_offset.GetValue(frame_number); + int y_offsetValue = y_offset.GetValue(frame_number); + int blur_radiusValue = blur_radius.GetValue(frame_number); + + int blueValue = color.blue.GetValue(frame_number); + int greenValue = color.green.GetValue(frame_number); + int redValue = color.red.GetValue(frame_number); + int alphaValue = color.alpha.GetValue(frame_number); + + // The shadow drop directly under the image or completely transparent. + // No need to do anything here, return the original frame + if ( + ((x_offsetValue == 0.0) && (y_offsetValue == 0) && (blur_radiusValue == 0.0)) // shadow is directly under the image + || + (alphaValue <= 0) // shadow is completely transparent + ) { + return frame; + } + + // Get the frame's image + cv::Mat cv_image = frame->GetBGRACvMat(); + + int abs_x_offset = abs(x_offsetValue); + int abs_y_offset = abs(y_offsetValue); + int paddedWidth = cv_image.cols + 2 * abs_x_offset; + int paddedHeight = cv_image.rows + 2 * abs_y_offset; + + // The shadow is completely out of the frame + if ((abs_x_offset + blur_radiusValue > cv_image.cols) || (abs_y_offset + blur_radiusValue > cv_image.rows)) { + return frame; + } + + std::vector channels(4); + cv::split(cv_image, channels); + + // Prepare shadow mask + cv::Mat shadow_mask = channels[3].clone(); + + cv::Mat final_image; + + // Padding the shadow color matrix and shadow mask to use ROI later + cv::Mat shadow_color_mat(cv::Size(paddedWidth, paddedHeight), CV_8UC4, cv::Scalar(redValue, greenValue, blueValue, alphaValue)); + + // only shifting image if shadow is not directly under the image + if (abs_x_offset && abs_y_offset) { + cv::copyMakeBorder(shadow_mask, shadow_mask, abs_y_offset, abs_y_offset, abs_x_offset, abs_x_offset, cv::BorderTypes::BORDER_REFLECT); + // Create ROI to crop from the shadow color matrix and shadow mask above, + // shift the shadow color and shadow mask + cv::Rect roi(abs_x_offset - x_offsetValue, abs_y_offset - y_offsetValue, cv_image.cols, cv_image.rows); + + // Draw cropped (by ROI) shadow color mat into final image + shadow_color_mat(roi).copyTo(final_image, shadow_mask(roi)); + } else { + // Draw shadow color mat into final image + shadow_color_mat.copyTo(final_image, shadow_mask); + } + + // Blur the final image to simulate shadow blur. Ignore if blur_radius is 0 + // FIXME: Not physically correct + if (blur_radiusValue > 0.0) { + cv::GaussianBlur(final_image, final_image, cv::Size(0, 0), blur_radiusValue, blur_radiusValue, cv::BorderTypes::BORDER_DEFAULT); + } + + // Draw the original image on top of the shadow + cv_image.copyTo(final_image, channels[3]); + + frame->SetBGRACvMat(final_image); + + return frame; +} + +// Generate JSON string of this object +std::string Shadow::Json() const { + + // Return formatted string + return JsonValue().toStyledString(); +} + +// Generate Json::Value for this object +Json::Value Shadow::JsonValue() const { + + // Create root json object + Json::Value root = EffectBase::JsonValue(); // get parent properties + root["type"] = info.class_name; + root["x_offset"] = x_offset.JsonValue(); + root["y_offset"] = y_offset.JsonValue(); + root["blur_radius"] = blur_radius.JsonValue(); + root["color"] = color.JsonValue(); + + // return JsonValue + return root; +} + +// Load JSON string into this object +void Shadow::SetJson(const std::string value) { + + // Parse JSON string into JSON objects + try + { + const Json::Value root = openshot::stringToJson(value); + // Set all values that match + SetJsonValue(root); + } + catch (const std::exception& e) + { + // Error parsing JSON (or missing keys) + throw InvalidJSON("JSON is invalid (missing keys or invalid data types)"); + } +} + +// Load Json::Value into this object +void Shadow::SetJsonValue(const Json::Value root) { + + // Set parent data + EffectBase::SetJsonValue(root); + + // Set data from Json (if key is found) + if (!root["x_offset"].isNull()) + x_offset.SetJsonValue(root["x_offset"]); + if (!root["y_offset"].isNull()) + y_offset.SetJsonValue(root["y_offset"]); + if (!root["blur_radius"].isNull()) + blur_radius.SetJsonValue(root["blur_radius"]); + if (!root["color"].isNull()) + color.SetJsonValue(root["color"]); +} + +// Get all properties for a specific frame +std::string Shadow::PropertiesJSON(int64_t requested_frame) const { + + // Generate JSON properties list + Json::Value root = BasePropertiesJSON(requested_frame); + + // Keyframes + root["x_offset"] = add_property_json("X Offset", x_offset.GetValue(requested_frame), "int", "", &x_offset, -4000, 4000, false, requested_frame); + root["y_offset"] = add_property_json("Y Offset", y_offset.GetValue(requested_frame), "int", "", &y_offset, -4000, 4000, false, requested_frame); + root["blur_radius"] = add_property_json("Blur Radius", blur_radius.GetValue(requested_frame), "int", "", &blur_radius, 0, 100, false, requested_frame); + root["color"] = add_property_json("Key Color", 0.0, "color", "", &color.red, 0, 255, false, requested_frame); + root["color"]["red"] = add_property_json("Red", color.red.GetValue(requested_frame), "int", "", &color.red, 0, 255, false, requested_frame); + root["color"]["green"] = add_property_json("Green", color.green.GetValue(requested_frame), "int", "", &color.green, 0, 255, false, requested_frame); + root["color"]["blue"] = add_property_json("Blue", color.blue.GetValue(requested_frame), "int", "", &color.blue, 0, 255, false, requested_frame); + root["color"]["alpha"] = add_property_json("Alpha", color.alpha.GetValue(requested_frame), "int", "", &color.alpha, 0, 255, false, requested_frame); + + // Return formatted string + return root.toStyledString(); +} diff --git a/src/effects/Shadow.h b/src/effects/Shadow.h new file mode 100644 index 000000000..6a3a119ed --- /dev/null +++ b/src/effects/Shadow.h @@ -0,0 +1,93 @@ +/** + * @file + * @brief Header file for Shadow effect class + * @author Jonathan Thomas + * @author HaiVQ + * + * @ref License + */ + +// Copyright (c) 2008-2025 OpenShot Studios, LLC +// +// SPDX-License-Identifier: LGPL-3.0-or-later + +#ifndef OPENSHOT_SHADOW_EFFECT_H +#define OPENSHOT_SHADOW_EFFECT_H + +#include + +#include "../EffectBase.h" + +#include "../Frame.h" +#include "../Json.h" +#include "../KeyFrame.h" + +#include +#include + + +namespace openshot +{ + + /** + * @brief This class drops shadow of image with transparent background and can be animated + * with openshot::Keyframe curves over time. + * + * Shadows can be added under any image or text. All coordination, + * blur radius and color can be animated with openshot::Keyframe curves. + */ + class Shadow : public EffectBase + { + private: + /// Init effect settings + void init_effect_details(); + + public: + Keyframe x_offset; ///< horizontal offset of the shadow + Keyframe y_offset; ///< vertical offset of the shadow + Keyframe blur_radius; ///< Radius of the shadow blur + Color color; ///< Color of the shadow + + /// Blank constructor, useful when using Json to load the effect properties + Shadow(); + + /// Default constructor, which require x_offset, y_offset, blur_radius and color keyframe + /// + /// @param x_offset The horizontal offset of the shadow (between -1000 and 1000, rounded to int) + /// @param y_offset The vertical offset of the shadow (between -1000 and 1000, rounded to int) + /// @param blur_radius Radius of the shadow blur (between 0 and 1000) + /// @param color The color of the shadow + Shadow(Keyframe x_offset, Keyframe y_offset, Keyframe blur_radius, Color color); + + /// @brief This method is required for all derived classes of ClipBase, and returns a + /// new openshot::Frame object. All Clip keyframes and effects are resolved into + /// pixels. + /// + /// @returns A new openshot::Frame object + /// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline. + std::shared_ptr GetFrame(int64_t frame_number) override { return GetFrame(std::make_shared(), frame_number); } + + /// @brief This method is required for all derived classes of ClipBase, and returns a + /// modified openshot::Frame object + /// + /// The frame object is passed into this method and used as a starting point (pixels and audio). + /// All Clip keyframes and effects are resolved into pixels. + /// + /// @returns The modified openshot::Frame object + /// @param frame The frame object that needs the clip or effect applied to it + /// @param frame_number The frame number (starting at 1) of the clip or effect on the timeline. + std::shared_ptr GetFrame(std::shared_ptr frame, int64_t frame_number) override; + + // Get and Set JSON methods + std::string Json() const override; ///< Generate JSON string of this object + void SetJson(const std::string value) override; ///< Load JSON string into this object + Json::Value JsonValue() const override; ///< Generate Json::Value for this object + void SetJsonValue(const Json::Value root) override; ///< Load Json::Value into this object + + /// Get all properties for a specific frame (perfect for a UI to display the current state + /// of all properties at any time) + std::string PropertiesJSON(int64_t requested_frame) const override; + }; +} + +#endif diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index c24b1f617..0bd82f6a6 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -65,6 +65,7 @@ if($CACHE{HAVE_OPENCV}) CVTracker CVStabilizer CVOutline + # CVShadow # Temporally disable CVShadow test # CVObjectDetection ) endif() diff --git a/tests/CVShadow.cpp b/tests/CVShadow.cpp new file mode 100644 index 000000000..fa3e672e4 --- /dev/null +++ b/tests/CVShadow.cpp @@ -0,0 +1,65 @@ +/** + * @file + * @brief Unit tests for OpenCV Shadow effect + * @author Jonathan Thomas + * @author HaiVQ + * + * @ref License + */ + +// Copyright (c) 2008-2025 OpenShot Studios, LLC +// +// SPDX-License-Identifier: LGPL-3.0-or-later + +#include +#include +#include + +#include "openshot_catch.h" + +#include "Clip.h" +#include "effects/Shadow.h" + +using namespace openshot; + +TEST_CASE( "Shadow_Tests", "[libopenshot][opencv][shadow]" ) +{ + // FIXME: This is a stub test case, does not check the effect correctly. + // Create a video clip + std::stringstream path; + path << TEST_MEDIA_PATH << "1F0CF.svg"; + + // Open clip + openshot::Clip c(path.str()); + c.Open(); + auto f = c.GetFrame(1); + + // Create effect constructor (default values) + openshot::Shadow e1{}; + e1.info.apply_before_clip = false; + + // Get frame from effect + auto f1 = e1.GetFrame(f, 1); + std::shared_ptr i1 = f1->GetImage(); + + // Check effect colors + QColor pix1 = i1->pixelColor(3, 32); + QColor compare1{0, 0, 0, 0}; + CHECK(pix1 == compare1); + + // Test another effect constructor + openshot::Shadow e2(Keyframe(15), Keyframe(5), Keyframe(15), Color(255, 0, 0, 128)); + e1.info.apply_before_clip = false; + + // Get frame from effect + auto f2 = e2.GetFrame(f,1); + std::shared_ptr i2 = f2->GetImage(); + + // Check effect colors + QColor pix2 = i2->pixelColor(11, 35); + QColor compare2{255, 0, 0, 128}; + CHECK(pix2 == compare2); + + // Close clip + c.Close(); +} diff --git a/tests/Frame.cpp b/tests/Frame.cpp index ffe4d84dd..ba280fff8 100644 --- a/tests/Frame.cpp +++ b/tests/Frame.cpp @@ -3,6 +3,7 @@ * @brief Unit tests for openshot::Frame * @author Jonathan Thomas * @author FeRD (Frank Dana) + * @author HaiVQ * * @ref License */ @@ -160,4 +161,26 @@ TEST_CASE( "Convert_Image", "[libopenshot][opencv][frame]" ) CHECK(f1->GetHeight() == cvimage.rows); CHECK(cvimage.channels() == 3); } + +TEST_CASE( "Convert_Image_Alpha", "[libopenshot][opencv][frame]" ) +{ + // Create a video clip + std::stringstream path; + path << TEST_MEDIA_PATH << "sintel_trailer-720p.mp4"; + Clip c1(path.str()); + c1.Open(); + + // Get first frame + auto f1 = c1.GetFrame(1); + + // Get first Mat image + cv::Mat cvimage = f1->GetBGRACvMat(); + + CHECK_FALSE(cvimage.empty()); + + CHECK(f1->number == 1); + CHECK(f1->GetWidth() == cvimage.cols); + CHECK(f1->GetHeight() == cvimage.rows); + CHECK(cvimage.channels() == 4); +} #endif