AcademySoftwareFoundation
diff --git a/‎.gitignore‎
Lines changed: 7 additions & 1 deletion b/‎.gitignore‎
Lines changed: 7 additions & 1 deletion
diff --git a/‎CMakeLists.txt‎
Lines changed: 16 additions & 11 deletions b/‎CMakeLists.txt‎
Lines changed: 16 additions & 11 deletions
diff --git a/‎CMakePresets.json‎
Lines changed: 36 additions & 1 deletion b/‎CMakePresets.json‎
Lines changed: 36 additions & 1 deletion
diff --git a/‎README.md‎
Lines changed: 2 additions & 6 deletions b/‎README.md‎
Lines changed: 2 additions & 6 deletions
diff --git a/‎cmake/macros.cmake‎
Lines changed: 34 additions & 12 deletions b/‎cmake/macros.cmake‎
Lines changed: 34 additions & 12 deletions
diff --git a/‎docs/Doxyfile‎
Lines changed: 1 addition & 1 deletion b/‎docs/Doxyfile‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎docs/conf.py‎
Lines changed: 6 additions & 2 deletions b/‎docs/conf.py‎
Lines changed: 6 additions & 2 deletions
diff --git a/‎docs/reference/build_guides/developer_tips.md‎
Lines changed: 21 additions & 0 deletions b/‎docs/reference/build_guides/developer_tips.md‎
Lines changed: 21 additions & 0 deletions
diff --git a/‎docs/reference/build_guides/linux_generic.md‎
Lines changed: 2 additions & 1 deletion b/‎docs/reference/build_guides/linux_generic.md‎
Lines changed: 2 additions & 1 deletion
diff --git a/‎docs/reference/build_guides/macos.md‎
Lines changed: 7 additions & 1 deletion b/‎docs/reference/build_guides/macos.md‎
Lines changed: 7 additions & 1 deletion
@@ -5,7 +5,7 @@
 .vscode/
 __*__
 ignore/
-python/src/xstudio.egg-info/
+*.egg-info/
 python/test/xstudio.log
 docs/conf.py
 python/src/xstudio/version.py
@@ -14,3 +14,9 @@ python/src/xstudio/version.py
 /build/
 xstudio_install/
 **/qml/*_qml_export.h
+<<<<<<< HEAD
+CMakeUserPresets.json
+=======
+__build
+__build_debug
+>>>>>>> c808bb352 (WIP)
@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.28 FATAL_ERROR)
 cmake_policy(VERSION 3.28)
 
-set(XSTUDIO_GLOBAL_VERSION "1.1.0" CACHE STRING "Version string")
+set(XSTUDIO_GLOBAL_VERSION "1.2.0" CACHE STRING "Version string")
 set(XSTUDIO_GLOBAL_NAME xStudio)
 
 # set(CMAKE_OSX_DEPLOYMENT_TARGET "14.5" CACHE STRING "Minimum OS X deployment version" FORCE)
@@ -16,24 +16,29 @@ option(ENABLE_CLANG_TIDY "Enable clang-tidy, ninja clang-tidy." OFF)
 option(ENABLE_CLANG_FORMAT "Enable clang format, ninja clangformat." OFF)
 option(FORCE_COLORED_OUTPUT "Always produce ANSI-colored output (GNU/Clang only)." TRUE)
 option(OPTIMIZE_FOR_NATIVE "Build with -march=native" OFF)
-option(BUILD_RESKIN "Build xstudio reskin binary" ON)
 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)
     #include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules/vcpkg.cmake)
     set(CMAKE_CXX_FLAGS_DEBUG "/Zi /Ob0 /Od /Oy-")
-    add_compile_options($<$<CXX_COMPILER_ID:MSVC>:/MP>)
+    # /MP is for MSBuild which parallelizes at project level.
+    # Ninja parallelizes at file level, so /MP would over-subscribe CPUs.
+    if(NOT CMAKE_GENERATOR STREQUAL "Ninja")
+        add_compile_options($<$<CXX_COMPILER_ID:MSVC>:/MP>)
+    endif()
     # enable UUID System Generator
     add_definitions(-DUUID_SYSTEM_GENERATOR=ON)
 endif()
 
 set(STUDIO_PLUGINS "" CACHE STRING "Enable compilation of SITE plugins")
 
 if (("${CMAKE_GENERATOR}" MATCHES "Makefiles" OR ("${CMAKE_GENERATOR}" MATCHES "Ninja" AND NOT WIN32)) AND NOT __CHECKED_CXX_FLAGS)
-    set(__CHECKED_CXX_FLAGS TRUE CACHE INTERNAL "Whether we checked the CXX flags already")
+  set(__CHECKED_CXX_FLAGS TRUE CACHE INTERNAL "Whether we checked the CXX flags already")
 	set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} ${COMMON_GCC}" CACHE STRING "" FORCE)
 	set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} ${COMMON_GCC}" CACHE STRING "" FORCE)
 	set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO} ${COMMON_GCC}" CACHE STRING "" FORCE)
@@ -103,8 +108,8 @@ if (USE_SANITIZER STREQUAL "Address")
     if(MSVC)
         target_compile_options(<target> PUBLIC /fsanitize=address)
     else()
-        set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=address")
-        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=address")
+        set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=address -fno-omit-frame-pointer")
+        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=address -fno-omit-frame-pointer")
         set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fsanitize=address")
         set(CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} -fsanitize=address")
     endif()
@@ -295,7 +300,7 @@ if(INSTALL_XSTUDIO)
 
 endif ()
 
-if(USE_VCPKG)
+if (USE_VCPKG)
   # To provide reliable ordering, we need to make this install script happen in a subdirectory.
   # Otherwise, Qt deploy will happen before we have the rest of the application deployed.
   add_subdirectory("scripts/qt_install")
@@ -305,8 +310,8 @@ if (WIN32)
 
   include(InstallRequiredSystemLibraries)
 
-  set(CPACK_PACKAGE_VERSION "1.1.0")
-  set(CPACK_PACKAGE_VERSION_MAJOR "1")
+  set(CPACK_PACKAGE_VERSION "1.2.0")
+  set(CPACK_PACKAGE_VERSION_MAJOR "2")
   set(CPACK_PACKAGE_VERSION_MINOR "1")
   set(CPACK_PACKAGE_VERSION_PATCH "0")
   set(CPACK_PACKAGE_VENDOR "DNEG / Academy Software Foundation")
@@ -343,11 +348,11 @@ if (WIN32)
       WriteRegStr HKCR 'XStudioSession\\\\DefaultIcon' \\\\
                         '' '$INSTDIR\\\\bin\\\\xstudio.exe,0'
       WriteRegStr HKCR 'XStudioSession\\\\shell\\\\open\\\\command' \\\\
-                        '' '$INSTDIR\\\\bin\\\\xstudio.exe \\"%1\\"'
+                        '' '$INSTDIR\\\\bin\\\\xstudio.exe \\\"%1\\\"'
       WriteRegStr HKCR 'XStudioSession\\\\shell\\\\edit' \\\\
                         '' 'Edit xSTUDIO Session File'
       WriteRegStr HKCR 'XStudioSession\\\\shell\\\\edit\\\\command' \\\\
-                        '' '$INSTDIR\\\\bin\\\\xstudio.exe \\"%1\\"'
+                        '' '$INSTDIR\\\\bin\\\\xstudio.exe \\\"%1\\\"'
       System::Call \\\\
         'Shell32::SHChangeNotify(i 0x8000000, i 0, i 0, i 0)'
       ")
 
@@ -11,7 +11,9 @@
         "CMAKE_INSTALL_PREFIX": "xstudio_install",
         "X_VCPKG_APPLOCAL_DEPS_INSTALL": "ON",
         "BUILD_DOCS": "OFF",
-        "USE_VCPKG": "ON"
+        "USE_VCPKG": "ON",
+        "STUDIO_PLUGINS": "",
+        "BMD_DECKLINK_PLUGIN": "OFF"
       }
     },
     { 
@@ -49,6 +51,39 @@
         "USE_SANITIZER": "address"
       }
     },
+    {
+      "name": "windows-ninja-base",
+      "inherits": "default",
+      "condition": {
+        "type": "equals",
+        "lhs": "${hostSystemName}",
+        "rhs": "Windows"
+      },
+      "hidden": true,
+      "generator": "Ninja"
+    },
+    {
+      "name": "WinNinjaRelease",
+      "inherits": ["windows-ninja-base"],
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Release"
+      }
+    },
+    {
+      "name": "WinNinjaRelWithDebInfo",
+      "inherits": ["windows-ninja-base"],
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "RelWithDebInfo",
+        "USE_SANITIZER": "address"
+      }
+    },
+    {
+      "name": "WinNinjaDebug",
+      "inherits": ["windows-ninja-base"],
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Debug"
+      }
+    },
     { 
       "name": "macos-base-arm",
       "condition": {
 
@@ -1,12 +1,8 @@
-# Welcome to xSTUDIO - v1.1.0
+# Welcome to xSTUDIO - v1.2.0
 
 xSTUDIO is a media playback and review application designed for professionals working in the film and TV post production industries, particularly the Visual Effects and Feature Animation sectors. xSTUDIO is focused on providing an intuitive, easy to use interface with a high performance playback engine at its core and C++ and Python APIs for pipeline integration and customisation for total flexibility.
 
-This codebase will build version 1.0.0 (alpha) of xstudio. There are some known issues that are currently being worked on:
-
-* Moderate audio distortion on playback (Windows only)
-* Ueser Documentation and API Documentation is badly out-of-date.
-* Saved sessions might not restore media correctly (Windows only)
+This codebase will build version 1.2.0 of xSTUDIO.
 
 ## Building xSTUDIO
 
 
@@ -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
 
@@ -38,7 +38,7 @@ PROJECT_NAME           = "xStudio"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "1.1.0"
+PROJECT_NUMBER         = "1.2.0"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
 
@@ -51,7 +51,11 @@
 
 breathe_default_project = "xStudio"
 breathe_projects = {
+<<<<<<< HEAD
+    "xStudio": "/user_data/ted/xstudio/__build2/docs/docs/doxygen/xml"
+=======
     "xStudio": "_build/doxygen/xml"
+>>>>>>> 0b8690b (Make the doc paths relative.)
 }
 
 
@@ -79,9 +83,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.1.0'
+version = '1.2.0'
 # The full version, including alpha/beta/rc tags.
-release = '1.1.0'
+release = '1.2.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 
@@ -0,0 +1,21 @@
+# Tips for Developers
+
+### A Faster Development Cycle on Windows
+
+If you are developing xSTUDIO on Windows the build times for both **package** and **install** targets are very long even if you need to test a single line code change. A solution to this problem is to do a full package build first and then copy the contents of the **bin** folder in the target package output folder into the regular **build/bin** folder in the build output folder. This will allow you to run xstudio directly from the **./build/bin** folder after subsequent builds without specifying package or install as the build target. Likewise if your build environment is MS Visual Studio you can set your debug target to **build/bin/xstudio.exe** for a much faster code-change / build / test cycles. The steps to do this in a PowerShell will look something like this:
+
+*Clear the bin and share build output folders (you only need to do this once):*
+
+    rm -r -fo ./bin/build
+    rm -r -fo ./bin/share/xstudio
+
+*Copy the corresponding folders from the package output back into the build folder (again, you only need to do this once):*
+
+    cp -r .\build\_CPack_Packages\win64\NSIS\xSTUDIO-1.2.0-win64\bin .\build\
+    cp -r .\build\_CPack_Packages\win64\NSIS\xSTUDIO-1.2.0-win64\share\xstudio .\build\share\
+
+*Now you can build and execute xstudio quickly without doing a full package/install build:*
+
+    cmake --build build
+    ./bin/xstudio.exe
+
@@ -12,10 +12,11 @@ Follow [these instructions](downloading_qt.md) - ensuring that you download the
 
 ### Download the VCPKG repo
 
-To build xSTUDIO we need a number of other open source software packages. We use the VCPKG package manager to do this. All that we need to do is download the repo and run the bootstrap script before we build xstudio.
+To build xSTUDIO we need a number of other open source software packages. We use the VCPKG package manager to do this. All that we need to do is download the repo, run the bootstrap script and then switch to a specific git commit before we build xstudio. Run these commands in the Powershell:
 
     git clone https://github.com/microsoft/vcpkg.git
     ./vcpkg/bootstrap-vcpkg.sh
+    git checkout c2aeddd80357b17592e59ad965d2adf65a19b22f
 
 ### Download the xSTUDIO repo
 
 
@@ -24,12 +24,18 @@ We require 5 packages to be installed to proceed. Run these commands in a termin
 
 Follow [these instructions](downloading_qt.md)
 
+> **NOTE:** Since Xcode version 26.X our specified version of Qt (6.5.3) is not strictly compatible with MacOS and you may see an error when you run the first 'cmake' command below. There are two options to resolve this. You can download Qt version 6.8.3 and use this instead of 6.5.3. Alternatively, open the file 'FindWrapOpenGL.cmake' within the Qt installation (at 6.5.3/macos/lib/cmake) and comment out lines 48 and 49 so that they look like this:
+
+    #target_link_libraries(WrapOpenGL::WrapOpenGL INTERFACE ${__opengl_fw_path})
+    #target_link_libraries(WrapOpenGL::WrapOpenGL INTERFACE ${__opengl_agl_fw_path})
+
 ### Download the VCPKG repo
 
-To build xSTUDIO we need a number of other open source software packages. We use the VCPKG package manager to do this. All that we need to do is download the repo and run the bootstrap script before we build xstudio.
+To build xSTUDIO we need a number of other open source software packages. We use the VCPKG package manager to do this. All that we need to do is download the repo, run the bootstrap script and then switch to a specific git commit before we build xstudio. Run these commands in a terminal:
 
     git clone https://github.com/microsoft/vcpkg.git
     ./vcpkg/bootstrap-vcpkg.sh
+    git checkout c2aeddd80357b17592e59ad965d2adf65a19b22f
 
 ### Download the xSTUDIO repo