Merge pull request #305 from jeffski/qt-text-html-readers

QtTextReader and QtHtmlReader

include/OpenShot.h

@@ -135,7 +135,9 @@
 #include "PlayerBase.h"
 #include "Point.h"
 #include "Profiles.h"
+#include "QtHtmlReader.h"
 #include "QtImageReader.h"
+#include "QtTextReader.h"
 #include "Timeline.h"
 #include "Settings.h"
 

include/QtHtmlReader.h

@@ -0,0 +1,145 @@
+/**
+ * @file
+ * @brief Header file for QtHtmlReader class
+ * @author Jonathan Thomas <[email protected]>
+ * @author Sergei Kolesov (jediserg)
+ * @author Jeff Shillitto (jeffski)
+ *
+ * @ref License
+ */
+
+/* LICENSE
+ *
+ * Copyright (c) 2008-2019 OpenShot Studios, LLC
+ * <http://www.openshotstudios.com/>. This file is part of
+ * OpenShot Library (libopenshot), an open-source project dedicated to
+ * delivering high quality video editing and animation solutions to the
+ * world. For more information visit <http://www.openshot.org/>.
+ *
+ * OpenShot Library (libopenshot) is free software: you can redistribute it
+ * and/or modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * OpenShot Library (libopenshot) is distributed in the hope that it will be
+ * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef OPENSHOT_QT_HTML_READER_H
+#define OPENSHOT_QT_HTML_READER_H
+
+#include "ReaderBase.h"
+
+#include <cmath>
+#include <ctime>
+#include <iostream>
+#include <omp.h>
+#include <stdio.h>
+#include <memory>
+#include "CacheMemory.h"
+#include "Enums.h"
+#include "Exceptions.h"
+
+class QImage;
+
+namespace openshot
+{
+
+	/**
+	 * @brief This class uses Qt libraries, to create frames with rendered HTML, and return
+	 * openshot::Frame objects.
+	 *
+	 * Supports HTML/CSS subset available via Qt libraries, see: https://doc.qt.io/qt-5/richtext-html-subset.html
+	 *
+	 * @code
+	 * // Any application using this class must instantiate either QGuiApplication or QApplication
+	 * QApplication a(argc, argv);
+	 *
+	 * // Create a reader to generate an openshot::Frame containing text
+	 * QtHtmlReader r(720, // width
+	 *              480, // height
+	 *              5, // x_offset
+	 *              5, // y_offset
+	 *              GRAVITY_CENTER, // gravity
+	 *              "<b>Check out</b> this Text!", // html
+	 *              "b { color: #ff0000 }", // css
+	 *              "#000000" // background_color
+	 *              );
+	 * r.Open(); // Open the reader
+	 *
+	 * // Get frame number 1 from the video (in fact, any frame # you request will return the same frame)
+	 * std::shared_ptr<Frame> f = r.GetFrame(1);
+	 *
+	 * // Now that we have an openshot::Frame object, lets have some fun!
+	 * f->Display(); // Display the frame on the screen
+	 *
+	 * // Close the reader
+	 * r.Close();
+	 * @endcode
+	 */
+	class QtHtmlReader : public ReaderBase
+	{
+	private:
+		int width;
+		int height;
+		int x_offset;
+		int y_offset;
+		std::string html;
+		std::string css;
+		std::string background_color;
+		std::shared_ptr<QImage> image;
+		bool is_open;
+		openshot::GravityType gravity;
+	public:
+
+		/// Default constructor (blank text)
+		QtHtmlReader();
+
+		/// @brief Constructor for QtHtmlReader with all parameters.
+		/// @param width The width of the requested openshot::Frame (not the size of the text)
+		/// @param height The height of the requested openshot::Frame (not the size of the text)
+		/// @param x_offset The number of pixels to offset the text on the X axis (horizontal)
+		/// @param y_offset The number of pixels to offset the text on the Y axis (vertical)
+		/// @param gravity The alignment / gravity of the text
+		/// @param html The HTML you want to render / display
+		/// @param css The CSS you want to apply to style the HTML
+		/// @param background_color The background color of the frame image (valid values are a color string in #RRGGBB or #AARRGGBB notation, a CSS color name, or 'transparent')
+		QtHtmlReader(int width, int height, int x_offset, int y_offset, GravityType gravity, std::string html, std::string css, std::string background_color);
+
+		/// Close Reader
+		void Close();
+
+		/// Get the cache object used by this reader (always returns NULL for this object)
+		openshot::CacheMemory* GetCache() { return NULL; };
+
+		/// Get an openshot::Frame object for a specific frame number of this reader.  All numbers
+		/// return the same Frame, since they all share the same image data.
+		///
+		/// @returns The requested frame (containing the image)
+		/// @param requested_frame The frame number that is requested.
+		std::shared_ptr<openshot::Frame> GetFrame(int64_t requested_frame);
+
+		/// Determine if reader is open or closed
+		bool IsOpen() { return is_open; };
+
+		/// Return the type name of the class
+		std::string Name() { return "QtHtmlReader"; };
+
+		/// Get and Set JSON methods
+		std::string Json(); ///< Generate JSON string of this object
+		void SetJson(std::string value); ///< Load JSON string into this object
+		Json::Value JsonValue(); ///< Generate Json::JsonValue for this object
+		void SetJsonValue(Json::Value root); ///< Load Json::JsonValue into this object
+
+		/// Open Reader - which is called by the constructor automatically
+		void Open();
+	};
+
+}
+
+#endif

include/QtTextReader.h

@@ -0,0 +1,159 @@
+/**
+ * @file
+ * @brief Header file for QtTextReader class
+ * @author Jonathan Thomas <[email protected]>
+ * @author Sergei Kolesov (jediserg)
+ * @author Jeff Shillitto (jeffski)
+ *
+ * @ref License
+ */
+
+/* LICENSE
+ *
+ * Copyright (c) 2008-2019 OpenShot Studios, LLC
+ * <http://www.openshotstudios.com/>. This file is part of
+ * OpenShot Library (libopenshot), an open-source project dedicated to
+ * delivering high quality video editing and animation solutions to the
+ * world. For more information visit <http://www.openshot.org/>.
+ *
+ * OpenShot Library (libopenshot) is free software: you can redistribute it
+ * and/or modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * OpenShot Library (libopenshot) is distributed in the hope that it will be
+ * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef OPENSHOT_QT_TEXT_READER_H
+#define OPENSHOT_QT_TEXT_READER_H
+
+#include "ReaderBase.h"
+
+#include <cmath>
+#include <ctime>
+#include <iostream>
+#include <omp.h>
+#include <stdio.h>
+#include <memory>
+#include "CacheMemory.h"
+#include "Enums.h"
+#include "Exceptions.h"
+
+class QImage;
+
+namespace openshot
+{
+
+	/**
+	 * @brief This class uses Qt libraries, to create frames with "Text", and return
+	 * openshot::Frame objects.
+	 *
+	 * All system fonts are supported, including many different font properties, such as size, color,
+	 * alignment, padding, etc...
+	 *
+	 * @code
+	 * // Any application using this class must instantiate either QGuiApplication or QApplication
+	 * QApplication a(argc, argv);
+	 *
+	 * // Create a reader to generate an openshot::Frame containing text
+	 * QtTextReader r(720, // width
+	 *              480, // height
+	 *              5, // x_offset
+	 *              5, // y_offset
+	 *              GRAVITY_CENTER, // gravity
+	 *              "Check out this Text!", // text
+	 *              "Arial", // font
+	 *              15.0, // font size
+	 *              "#fff000", // text_color
+	 *              "#000000" // background_color
+	 *              );
+	 * r.Open(); // Open the reader
+	 *
+	 * // Get frame number 1 from the video (in fact, any frame # you request will return the same frame)
+	 * std::shared_ptr<Frame> f = r.GetFrame(1);
+	 *
+	 * // Now that we have an openshot::Frame object, lets have some fun!
+	 * f->Display(); // Display the frame on the screen
+	 *
+	 * // Close the reader
+	 * r.Close();
+	 * @endcode
+	 */
+	class QtTextReader : public ReaderBase
+	{
+	private:
+		int width;
+		int height;
+		int x_offset;
+		int y_offset;
+		std::string text;
+		QFont font;
+		std::string text_color;
+		std::string background_color;
+		std::string text_background_color;
+		std::shared_ptr<QImage> image;
+		bool is_open;
+		openshot::GravityType gravity;
+
+	public:
+
+		/// Default constructor (blank text)
+		QtTextReader();
+
+		/// @brief Constructor for QtTextReader with all parameters.
+		/// @param width The width of the requested openshot::Frame (not the size of the text)
+		/// @param height The height of the requested openshot::Frame (not the size of the text)
+		/// @param x_offset The number of pixels to offset the text on the X axis (horizontal)
+		/// @param y_offset The number of pixels to offset the text on the Y axis (vertical)
+		/// @param gravity The alignment / gravity of the text
+		/// @param text The text you want to generate / display
+		/// @param font The font of the text
+		/// @param font_size The size of the text
+		/// @param is_bold Set to true to make text bold
+		/// @param is_italic Set to true to make text italic
+		/// @param text_color The color of the text (valid values are a color string in #RRGGBB or #AARRGGBB notation or a CSS color name)
+		/// @param background_color The background color of the frame image (valid values are a color string in #RRGGBB or #AARRGGBB notation, a CSS color name, or 'transparent')
+		QtTextReader(int width, int height, int x_offset, int y_offset, GravityType gravity, std::string text, QFont font, std::string text_color, std::string background_color);
+
+		/// Draw a box under rendered text using the specified color.
+		/// @param color The background color behind the text (valid values are a color string in #RRGGBB or #AARRGGBB notation or a CSS color name)
+		void SetTextBackgroundColor(std::string color);
+
+		/// Close Reader
+		void Close();
+
+		/// Get the cache object used by this reader (always returns NULL for this object)
+		openshot::CacheMemory* GetCache() { return NULL; };
+
+		/// Get an openshot::Frame object for a specific frame number of this reader.  All numbers
+		/// return the same Frame, since they all share the same image data.
+		///
+		/// @returns The requested frame (containing the image)
+		/// @param requested_frame The frame number that is requested.
+		std::shared_ptr<openshot::Frame> GetFrame(int64_t requested_frame);
+
+		/// Determine if reader is open or closed
+		bool IsOpen() { return is_open; };
+
+		/// Return the type name of the class
+		std::string Name() { return "QtTextReader"; };
+
+		/// Get and Set JSON methods
+		std::string Json(); ///< Generate JSON string of this object
+		void SetJson(string value); ///< Load JSON string into this object
+		Json::Value JsonValue(); ///< Generate Json::JsonValue for this object
+		void SetJsonValue(Json::Value root); ///< Load Json::JsonValue into this object
+
+		/// Open Reader - which is called by the constructor automatically
+		void Open();
+	};
+
+}
+
+#endif

include/TextReader.h

@@ -121,7 +121,7 @@ namespace openshot
 		TextReader(int width, int height, int x_offset, int y_offset, GravityType gravity, string text, string font, double size, string text_color, string background_color);
 
 		/// Draw a box under rendered text using the specified color.
-		/// @param text_background_color The background color behind the text
+		/// @param color The background color behind the text
 		void SetTextBackgroundColor(string color);
 
 		/// Close Reader

src/CMakeLists.txt

@@ -223,6 +223,9 @@ SET ( OPENSHOT_SOURCE_FILES
 		QtPlayer.cpp
 		Settings.cpp
 		Timeline.cpp
+		QtTextReader.cpp
+		QtHtmlReader.cpp
+
 
 		# Qt Video Player
 		${QT_PLAYER_FILES}
@@ -335,7 +338,7 @@ target_link_libraries(openshot PUBLIC ${REQUIRED_LIBRARIES})
 # Pick up parameters from OpenMP target and propagate
 target_link_libraries(openshot PUBLIC OpenMP::OpenMP_CXX)
 
-############### CLI EXECUTABLE ################
+############### CLI EXECUTABLES ################
 # Create test executable
 add_executable(openshot-example examples/Example.cpp)
 
@@ -350,6 +353,9 @@ target_compile_definitions(openshot-example PRIVATE
 # Link test executable to the new library
 target_link_libraries(openshot-example openshot)
 
+add_executable(openshot-html-test examples/ExampleHtml.cpp)
+target_link_libraries(openshot-html-test openshot Qt5::Gui)
+
 ############### PLAYER EXECUTABLE ################
 # Create test executable
 add_executable(openshot-player Qt/demo/main.cpp)