Integration of resvg SVG library (optional during build) (#185)

* Integration of libresvg SVG library (optional during build)

* Major refactor of max_width and max_height for preview optimization

* Fixed many bugs related to preview resizing, with regards to cached frames

* Updating gitlab CI to find RESVGDIR correctly for windows, and adding svgz support

* Updating cmake findresvg module to search for windows locations first, to prevent an issue on our windows builders and updating some CMake output.

* Removing folder path from resvg header, since it could be installed in different named folders. This is an attempt to fix Windows include issues.

* Making call to AV_FREE_FRAME conditional for non windows systems (because it crashes on Windows for seemingly no reason). Needs more investigation.

Author: jonoomph

.gitlab-ci.yml

@@ -66,6 +66,7 @@ windows-builder-x86:
     - Expand-Archive -Path artifacts.zip -DestinationPath .
     - $env:LIBOPENSHOT_AUDIO_DIR = "$CI_PROJECT_DIR\build\install-x86"
     - $env:UNITTEST_DIR = "C:\msys32\usr"
+    - $env:RESVGDIR = "C:\msys32\usr\local"
     - $env:ZMQDIR = "C:\msys32\usr"
     - $env:Path = "C:\msys32\mingw32\bin;C:\msys32\mingw32\lib;C:\msys32\usr\lib\cmake\UnitTest++;C:\msys32\home\jonathan\depot_tools;C:\msys32\usr;C:\msys32\usr\lib;" + $env:Path;
     - New-Item -ItemType Directory -Force -Path build

cmake/Modules/FindRESVG.cmake

@@ -0,0 +1,34 @@
+# - Try to find RESVG
+# Once done this will define
+# RESVG_FOUND - System has RESVG
+# RESVG_INCLUDE_DIRS - The RESVG include directories
+# RESVG_LIBRARIES - The libraries needed to use RESVG
+# RESVG_DEFINITIONS - Compiler switches required for using RESVG
+find_path ( RESVG_INCLUDE_DIR ResvgQt.h
+            PATHS ${RESVGDIR}/include/resvg
+                  $ENV{RESVGDIR}/include/resvg
+                  $ENV{RESVGDIR}/include
+                  /usr/include/resvg
+                  /usr/include
+                  /usr/local/include/resvg
+                  /usr/local/include )
+
+find_library ( RESVG_LIBRARY NAMES resvg
+               PATHS /usr/lib
+                    /usr/local/lib
+                    $ENV{RESVGDIR}/lib )
+
+set ( RESVG_LIBRARIES ${RESVG_LIBRARY} )
+set ( RESVG_INCLUDE_DIRS ${RESVG_INCLUDE_DIR} )
+
+SET( RESVG_FOUND FALSE )
+
+IF ( RESVG_INCLUDE_DIR AND RESVG_LIBRARY )
+    SET ( RESVG_FOUND TRUE )
+
+    include ( FindPackageHandleStandardArgs )
+    # handle the QUIETLY and REQUIRED arguments and set RESVG_FOUND to TRUE
+    # if all listed variables are TRUE
+    find_package_handle_standard_args ( RESVG DEFAULT_MSG RESVG_LIBRARY RESVG_INCLUDE_DIR )
+ENDIF ( RESVG_INCLUDE_DIR AND RESVG_LIBRARY )
+

include/ChunkReader.h

@@ -29,8 +29,6 @@
 #define OPENSHOT_CHUNK_READER_H
 
 #include "ReaderBase.h"
-#include "FFmpegReader.h"
-
 #include <cmath>
 #include <ctime>
 #include <iostream>
@@ -107,7 +105,7 @@ namespace openshot
 		string path;
 		bool is_open;
 		int64_t chunk_size;
-		FFmpegReader *local_reader;
+		ReaderBase *local_reader;
 		ChunkLocation previous_location;
 		ChunkVersion version;
 		std::shared_ptr<Frame> last_frame;

include/Clip.h

@@ -44,18 +44,9 @@
 #include "EffectBase.h"
 #include "Effects.h"
 #include "EffectInfo.h"
-#include "FFmpegReader.h"
 #include "Fraction.h"
-#include "FrameMapper.h"
-#ifdef USE_IMAGEMAGICK
-	#include "ImageReader.h"
-	#include "TextReader.h"
-#endif
-#include "QtImageReader.h"
-#include "ChunkReader.h"
 #include "KeyFrame.h"
 #include "ReaderBase.h"
-#include "DummyReader.h"
 
 using namespace std;
 using namespace openshot;

include/ClipBase.h

@@ -58,8 +58,6 @@ namespace openshot {
 		float start; ///< The position in seconds to start playing (used to trim the beginning of a clip)
 		float end; ///< The position in seconds to end playing (used to trim the ending of a clip)
 		string previous_properties; ///< This string contains the previous JSON properties
-		int max_width; ///< The maximum image width needed by this clip (used for optimizations)
-		int max_height; ///< The maximium image height needed by this clip (used for optimizations)
 
 		/// Generate JSON for a property
 		Json::Value add_property_json(string name, float value, string type, string memo, Keyframe* keyframe, float min_value, float max_value, bool readonly, int64_t requested_frame);
@@ -70,7 +68,7 @@ namespace openshot {
 	public:
 
 		/// Constructor for the base clip
-		ClipBase() { max_width = 0; max_height = 0; };
+		ClipBase() { };
 
 		// Compare a clip using the Position() property
 		bool operator< ( ClipBase& a) { return (Position() < a.Position()); }
@@ -93,9 +91,6 @@ namespace openshot {
 		void Start(float value) { start = value; } ///< Set start position (in seconds) of clip (trim start of video)
 		void End(float value) { end = value; } ///< Set end position (in seconds) of clip (trim end of video)
 
-		/// Set Max Image Size (used for performance optimization)
-		void SetMaxSize(int width, int height) { max_width = width; max_height = height;  };
-
 		/// Get and Set JSON methods
 		virtual string Json() = 0; ///< Generate JSON string of this object
 		virtual void SetJson(string value) = 0; ///< Load JSON string into this object

include/FFmpegReader.h

@@ -42,6 +42,7 @@
 #include <stdio.h>
 #include <memory>
 #include "CacheMemory.h"
+#include "Clip.h"
 #include "Exceptions.h"
 #include "OpenMPUtilities.h"
 #include "Settings.h"

include/FFmpegUtilities.h

@@ -141,7 +141,7 @@
 		#define AV_ALLOCATE_FRAME() av_frame_alloc()
 		#define AV_ALLOCATE_IMAGE(av_frame, pix_fmt, width, height) av_image_alloc(av_frame->data, av_frame->linesize, width, height, pix_fmt, 1)
 		#define AV_RESET_FRAME(av_frame) av_frame_unref(av_frame)
-    	#define AV_FREE_FRAME(av_frame) if (av_frame) av_frame_free(av_frame)
+    	#define AV_FREE_FRAME(av_frame) av_frame_free(av_frame)
 		#define AV_FREE_PACKET(av_packet) av_packet_unref(av_packet)
 		#define AV_FREE_CONTEXT(av_context) avcodec_free_context(&av_context)
 		#define AV_GET_CODEC_TYPE(av_stream) av_stream->codecpar->codec_type
@@ -176,7 +176,7 @@
 		#define AV_ALLOCATE_FRAME() av_frame_alloc()
 		#define AV_ALLOCATE_IMAGE(av_frame, pix_fmt, width, height) av_image_alloc(av_frame->data, av_frame->linesize, width, height, pix_fmt, 1)
 		#define AV_RESET_FRAME(av_frame) av_frame_unref(av_frame)
-    	#define AV_FREE_FRAME(av_frame) if(av_frame) av_frame_free(av_frame)
+    	#define AV_FREE_FRAME(av_frame) av_frame_free(av_frame)
 		#define AV_FREE_PACKET(av_packet) av_packet_unref(av_packet)
 		#define AV_FREE_CONTEXT(av_context) avcodec_free_context(&av_context)
 		#define AV_GET_CODEC_TYPE(av_stream) av_stream->codecpar->codec_type
@@ -211,7 +211,7 @@
 		#define AV_ALLOCATE_FRAME() av_frame_alloc()
 		#define AV_ALLOCATE_IMAGE(av_frame, pix_fmt, width, height) avpicture_alloc((AVPicture *) av_frame, pix_fmt, width, height)
 		#define AV_RESET_FRAME(av_frame) av_frame_unref(av_frame)
-    	#define AV_FREE_FRAME(av_frame) if (av_frame) av_frame_free(av_frame)
+    	#define AV_FREE_FRAME(av_frame) av_frame_free(av_frame)
 		#define AV_FREE_PACKET(av_packet) av_packet_unref(av_packet)
 		#define AV_FREE_CONTEXT(av_context) avcodec_close(av_context)
 		#define AV_GET_CODEC_TYPE(av_stream) av_stream->codec->codec_type
@@ -241,7 +241,7 @@
 		#define AV_ALLOCATE_FRAME() avcodec_alloc_frame()
 		#define AV_ALLOCATE_IMAGE(av_frame, pix_fmt, width, height) avpicture_alloc((AVPicture *) av_frame, pix_fmt, width, height)
 		#define AV_RESET_FRAME(av_frame) avcodec_get_frame_defaults(av_frame)
-		#define AV_FREE_FRAME(av_frame) if(av_frame) avcodec_free_frame(av_frame)
+		#define AV_FREE_FRAME(av_frame) avcodec_free_frame(av_frame)
 		#define AV_FREE_PACKET(av_packet) av_free_packet(av_packet)
 		#define AV_FREE_CONTEXT(av_context) avcodec_close(av_context)
 		#define AV_GET_CODEC_TYPE(av_stream) av_stream->codec->codec_type

include/QtImageReader.h

@@ -28,19 +28,14 @@
 #ifndef OPENSHOT_QIMAGE_READER_H
 #define OPENSHOT_QIMAGE_READER_H
 
-#include "ReaderBase.h"
-
 #include <cmath>
 #include <ctime>
 #include <iostream>
 #include <omp.h>
 #include <stdio.h>
 #include <memory>
-#include <QtCore/QString>
-#include <QtGui/QImage>
-#include <QtGui/QPainter>
-#include "CacheMemory.h"
 #include "Exceptions.h"
+#include "ReaderBase.h"
 
 using namespace std;
 
@@ -110,9 +105,6 @@ namespace openshot
 		Json::Value JsonValue(); ///< Generate Json::JsonValue for this object
 		void SetJsonValue(Json::Value root); ///< Load Json::JsonValue into this object
 
-		/// Set Max Image Size (used for performance optimization)
-		void SetMaxSize(int width, int height);
-
 		/// Open File - which is called by the constructor automatically
 		void Open();
 	};

include/ReaderBase.h

@@ -35,6 +35,7 @@
 #include <sstream>
 #include "CacheMemory.h"
 #include "ChannelLayouts.h"
+#include "ClipBase.h"
 #include "Fraction.h"
 #include "Frame.h"
 #include "Json.h"
@@ -99,9 +100,7 @@ namespace openshot
 		/// Section lock for multiple threads
 	    CriticalSection getFrameCriticalSection;
 	    CriticalSection processingCriticalSection;
-
-		int max_width; ///< The maximum image width needed by this clip (used for optimizations)
-		int max_height; ///< The maximium image height needed by this clip (used for optimizations)
+		ClipBase* parent;
 
 	public:
 
@@ -111,6 +110,12 @@ namespace openshot
 		/// Information about the current media file
 		ReaderInfo info;
 
+		/// Parent clip object of this reader (which can be unparented and NULL)
+		ClipBase* GetClip();
+
+		/// Set parent clip object of this reader
+		void SetClip(ClipBase* clip);
+
 		/// Close the reader (and any resources it was consuming)
 		virtual void Close() = 0;
 
@@ -140,9 +145,6 @@ namespace openshot
 		virtual Json::Value JsonValue() = 0; ///< Generate Json::JsonValue for this object
 		virtual void SetJsonValue(Json::Value root) = 0; ///< Load Json::JsonValue into this object
 
-		/// Set Max Image Size (used for performance optimization)
-		void SetMaxSize(int width, int height) { max_width = width; max_height = height; };
-
 		/// Open the reader (and start consuming resources, such as images or video files)
 		virtual void Open() = 0;
 	};

include/Settings.h

@@ -85,6 +85,12 @@ namespace openshot {
 		/// Scale mode used in FFmpeg decoding and encoding (used as an optimization for faster previews)
 		bool HIGH_QUALITY_SCALING = false;
 
+		/// Maximum width for image data (useful for optimzing for a smaller preview or render)
+		int MAX_WIDTH = 0;
+
+		/// Maximum height for image data (useful for optimzing for a smaller preview or render)
+		int MAX_HEIGHT = 0;
+
 		/// Wait for OpenMP task to finish before continuing (used to limit threads on slower systems)
 		bool WAIT_FOR_VIDEO_PROCESSING_TASK = false;