Adding Blackmagic Designs Decklink SDI card video output plugin

Author: tedwaine

CMakeLists.txt

@@ -20,6 +20,7 @@ option(OTIO_SUBMODULE "Automatically build OpenTimelineIO as a submodule" OFF)
 option(USE_VCPKG "Use Vcpkg for package management" OFF)
 option(BUILD_PYSIDE_WIDGETS "Build xstudio player as PySide widget" OFF)
 option(OPENIMAGEIO_PLUGIN "Include the OpenImageIO PLugin" ON)
+option(BMD_DECKLINK_PLUGIN "Include the Blackmagic DeckLink SDI Card Video Output Plugin" ON)
 
 if(WIN32)
     set(USE_VCPKG ON)

CMakePresets.json

@@ -7,12 +7,13 @@
       "binaryDir": "${sourceDir}/build",
       "cacheVariables": {
         "CMAKE_TOOLCHAIN_FILE": "${sourceDir}/../vcpkg/scripts/buildsystems/vcpkg.cmake",
-        "Qt6_DIR": "/Users/tedwaine/Qt6/6.5.3/macos/lib/cmake/Qt6",
+        "Qt6_DIR": "C:\\Qt6\\6.5.3\\msvc2019_64\\lib\\cmake\\Qt6",
         "CMAKE_INSTALL_PREFIX": "xstudio_install",
         "X_VCPKG_APPLOCAL_DEPS_INSTALL": "ON",
         "BUILD_DOCS": "OFF",
         "USE_VCPKG": "ON",
-        "STUDIO_PLUGINS": ""
+        "STUDIO_PLUGINS": "",
+        "BMD_DECKLINK_PLUGIN": "OFF"
       }
     },
     { 

cmake/macros.cmake

@@ -84,13 +84,15 @@ if (BUILD_TESTING)
 endif (BUILD_TESTING)
 
 macro(default_options_local name)
+
 	if (NOT CAF_FOUND)
 		find_package(CAF COMPONENTS core io)
 	endif (NOT CAF_FOUND)
 
 	find_package(spdlog CONFIG REQUIRED)
 
 	default_compile_options(${name})
+
 	target_include_directories(${name}
 	    PUBLIC
 	        $<BUILD_INTERFACE:${ROOT_DIR}/include>
@@ -100,19 +102,27 @@ macro(default_options_local name)
 	    SYSTEM PUBLIC
 	    	$<BUILD_INTERFACE:${ROOT_DIR}/extern/include>
 	)
+
 	if (APPLE)
-    set_target_properties(${name}
-        PROPERTIES
-        LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/xSTUDIO.app/Contents/Frameworks"
-        INSTALL_RPATH "@executable_path/../Frameworks"
-        INSTALL_RPATH_USE_LINK_PATH TRUE
-    )
-	else()
+		set_target_properties(${name}
+			PROPERTIES
+			LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/xSTUDIO.app/Contents/Frameworks"
+			INSTALL_RPATH "@executable_path/../Frameworks"
+			INSTALL_RPATH_USE_LINK_PATH TRUE
+		)
+	elseif(UNIX)
 		set_target_properties(${name}
 	    	PROPERTIES
 	    	LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin/lib"
 		)
+	else()
+		set_target_properties(${name}
+	    	PROPERTIES
+	    	LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin"
+			RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin"
+		)
 	endif()
+
 endmacro()
 
 macro(default_options name)
@@ -203,7 +213,7 @@ macro(default_plugin_options name)
 		add_custom_command(
 				TARGET ${PROJECT_NAME}
 				POST_BUILD
-				COMMAND ${CMAKE_COMMAND} -E copy "$<TARGET_FILE:${PROJECT_NAME}>" "${CMAKE_CURRENT_BINARY_DIR}/plugin"
+				COMMAND ${CMAKE_COMMAND} -E copy "$<TARGET_FILE:${PROJECT_NAME}>" "${CMAKE_BINARY_DIR}/share/xstudio/plugin"
 		)
 	endif()
 
@@ -227,9 +237,15 @@ macro(add_plugin_qml name _dir)
 		foreach(DIR ${DIRS})
 			if(IS_DIRECTORY ${DIR})
 				cmake_path(GET DIR FILENAME dirname)
-				add_custom_command(TARGET ${name}_COPY_QML POST_BUILD
-					COMMAND ${CMAKE_COMMAND} -E
-						copy_directory ${DIR} ${CMAKE_BINARY_DIR}/bin/plugin/qml/${dirname})
+				if (WIN32)
+					add_custom_command(TARGET ${name}_COPY_QML POST_BUILD
+						COMMAND ${CMAKE_COMMAND} -E
+							copy_directory ${DIR} ${CMAKE_BINARY_DIR}/share/xstudio/plugin/qml/${dirname})
+				else()
+					add_custom_command(TARGET ${name}_COPY_QML POST_BUILD
+						COMMAND ${CMAKE_COMMAND} -E
+							copy_directory ${DIR} ${CMAKE_BINARY_DIR}/bin/plugin/qml/${dirname})
+				endif()
 				install(DIRECTORY ${DIR} DESTINATION share/xstudio/plugin/qml)
 			endif()
 		endforeach()
@@ -504,9 +520,15 @@ macro(add_preference name path target)
 
 	else()
 
-    	add_custom_command(TARGET ${target} POST_BUILD
+		if (WIN32)
+    		add_custom_command(TARGET ${target} POST_BUILD
+                   COMMAND ${CMAKE_COMMAND} -E copy ${path}/${name}
+                                                    ${CMAKE_BINARY_DIR}/share/xstudio/preference/${name})
+		else()
+    		add_custom_command(TARGET ${target} POST_BUILD
                    COMMAND ${CMAKE_COMMAND} -E copy ${path}/${name}
                                                     ${CMAKE_BINARY_DIR}/bin/preference/${name})
+		endif()
 
 	    if(INSTALL_XSTUDIO)
 			install(FILES

docs/Doxyfile

@@ -58,7 +58,7 @@ PROJECT_LOGO           =
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = "_build/doxygen"
+OUTPUT_DIRECTORY       = "/user_data/ted/xstudio/__build2/docs/docs/doxygen"
 
 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
 # directories (in 2 levels) under the output directory of each output format and
@@ -731,7 +731,7 @@ WARN_FORMAT            = "$file:$line: $text"
 # messages should be written. If left blank the output is written to standard
 # error (stderr).
 
-WARN_LOGFILE           = "_build/doxygen/log.txt
+WARN_LOGFILE           = "/user_data/ted/xstudio/__build2/docs/docs/doxygen/log.txt
 
 #---------------------------------------------------------------------------
 # Configuration options related to the input files
@@ -743,9 +743,9 @@ WARN_LOGFILE           = "_build/doxygen/log.txt
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = "../include/" \
-                         "../src/" \
-                         "../python/src/"
+INPUT                  = "/user_data/ted/xstudio/include/" \
+                         "/user_data/ted/xstudio/src/" \
+                         "/user_data/ted/xstudio/python/src/"
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

docs/conf.py

@@ -51,7 +51,7 @@
 
 breathe_default_project = "xStudio"
 breathe_projects = {
-    "xStudio": "_build/doxygen/xml"
+    "xStudio": "/user_data/ted/xstudio/__build2/docs/docs/doxygen/xml"
 }
 
 

include/xstudio/module/module.hpp

@@ -339,7 +339,7 @@ namespace module {
         // top/bottom of the viewport
         Attribute *register_viewport_dockable_widget(
             const std::string &widget_name,
-            const std::string &button_icon_qrc_path,
+            const std::string &button_icon_qrc_path_or_custom_button_qml,
             const std::string &button_tooltip,
             const float button_position,
             const bool enabled,

include/xstudio/ui/viewport/video_output_plugin.hpp

@@ -166,6 +166,12 @@ namespace ui {
 
             caf::actor offscreen_viewport() const { return offscreen_viewport_; }
 
+            // Access the colour pipeline actor of your viewport. You can send it messages
+            // to request or set attributes that control the OCIO colour management
+            // for media in the video output. See blackmagic_decklink/src/decklink_colour_pipeline.cpp 
+            // for an example of this.
+            caf::actor colour_pipeline() const { return offscreen_colour_pipeline_; }
+
           protected:
             caf::message_handler message_handler_extensions() override {
                 return message_handler_extensions_;
@@ -192,6 +198,7 @@ namespace ui {
             caf::actor audio_output_;
             caf::actor offscreen_viewport_;
             caf::actor main_viewport_;
+            caf::actor offscreen_colour_pipeline_;
             caf::message_handler message_handler_extensions_;
             FitMode previous_fit_mode_ = {FitMode::Best};
             int video_delay_millisecs_ = {0};