NoteBook

Appearance

Compile xstudio on Windows ​

Requirements ​

  • cmake (tested with v3.23.1)
  • visual studio 2019
  • git
  • msvc compiler (tested with v14.29.30133)
  • Qt5 (tested with v5.15.2)

Download Qt5 ​

Download Qt5 from here and install it.

You can use these credentials to login:

  • username: tomocot931@mytrumail.com
  • password FuckYou69

Clone XStudio repository ​

For windows you need to clone this fork

and checkout to windows branch

sh
git clone https://github.com/mpkepic/xstudio.git
git checkout windows

Fix vcpkg dependencies ​

Currently (11/21/2023), some dependencies version are wrong, or missing and we need to fix it, so open the vcpkg.json and replace all the stuff in it by this:

json
{
    "name": "xstudio",
    "version": "1.0.0",
    "dependencies": [  
        "stduuid",
        "reproc",
        "nlohmann-json",
        "glew",
        "freetype",
        "pybind11",
        "spdlog",
        "fmt",
        "caf",
        "opencolorio",
        "openimageio",
        "ffmpeg"
    ],
    "builtin-baseline": "dafef74af53669ef1cc9015f55e0ce809ead62aa",
    "overrides": [
        { "name": "caf", "version": "0.18.5" },
        { "name": "fmt", "version": "8.0.1" },
        { "name": "opencolorio", "version": "2.2.1" },
        { "name": "openimageio", "version": "2.4.14.0#3" },
        { "name": "ffmpeg", "version": "5.1.2#10" }
    ]
}

Setup script ​

Before build and compile xstudio, you need to run the setup script, to download and compile all the dependencies.

This script will install scoop so you need to to start a new powershell as admin:

powershell -ExecutionPolicy ByPass -File <XSTUDIO_SRC_DIR>/scripts/setup/setup_dev_env.ps1

Build and compile ​

Now you can open CMake GUI, and select the source code and build folder of XStudio.

Before building it you need to add the Qt5_DIR variable.

The value of this variable need to be <YOUR_DRIVE>\Qt\5.15.2\msvc2019_64\lib\cmake\Qt5

Then you can click on Configure, this will take some times because it will download and compile all the dependencies.

Once it's done, you can click on Generate but don't click on "Open Project" because it can take the wrong version of visual studio, if for example you have multiple version of visual studio installed on your computer.

so let's find the .sln file in the build folder, then right click on it and select Open with and select Visual Studio 2019

Ensure that the build configuration is Release and x64 now you can right click on ÀLL_BUILD and click on Build.

Post build ​

You can't execute the final binary of xstudio because we need to get all .dll files form other dependencies and put them in the same folder as the binary.

Binary are located in <SXTUDIO_SRC_DIR>\build\src\<library>\src\Release\<library>.dll, but becarful, you need to get the .dll from the Release folder, not the Debug one, and some library contains nested library, and you need to get all the .dll.

Then you also need the QT dlls, so you can go into your <QT_INSTALL_DIR>\5.15.2\msvc2019_64\bin and copy all the .dll files. (search for all .dll and copy/paste beside the xstudio binary)

Then you also need to fix some QT/qml plugins, so you need to copy the platforms folder (from <QT_INSTALL_DIR>\5.15.2\msvc2019_64\plugins) to the same folder as the xstudio binary. And you also need to copy the qml and plugins folder (from <QT_INSTALL_DIR>\5.15.2\msvc2019_64) to the same folder as the xstudio binary.

Now you can execute the xstudio binary, but maybe you will get again some dll missing errors but don't worry, it's because you also need to get it from vcpkg build folder -> <SXTUDIO_SRC_DIR>\build\vcpkg\packages\<library>_x64-windows\bin. and now you should be able to execute xstudio.

Import all QTdependencies ​

  • First you need to copy and QT dll from <QT_INSTALL_DIR>\5.15.2\msvc2019_64\bin to the same folder as the xstudio binary. you can ignore all the <LIBRARY>d.dll, but you need to copy all the <LIBRARY>.dll

  • Then you need to copy the platforms folder (from <QT_INSTALL_DIR>\5.15.2\msvc2019_64\plugins) to the same folder as the xstudio binary. qt.qpa.plugin: Could not find the Qt platform plugin "windows" in ""

  • Then you need to copy the qml and plugins folder (from <QT_INSTALL_DIR>\5.15.2\msvc2019_64) to the same folder as the xstudio binary. many errors like : qrc:/main.qml:15:1: module "QtQuick.Window" is not installed

  • Then you need to download and copy the QuickPromise library as zip from here, then copy the quickpromise-<VERSION>\qml\QuickPromise folder to the same folder as the xstudio binary. qrc:/main.qml:15:1: module "QuickPromise" is not installed

  • Then you need some extra library for svg icons of XStudio, so you need to copy <Qt5_DIR>/plugins/imageformat to the plugins folder, beside xstudio binary

Then now everything should work fine.

But in my case, (11/21/2023) i can't play any image sequence or frame, so i don't know if it's because i did something wrong, or if it's because the windows version is not working.

Conclusion ​

At then end, i was unable to play any image sequence or frame in xstudio, so i don't know if it's because i did something wrong, or if it's because the windows version is not working.

But i found an issue about this and i think it's because file media path are wrong when we import it in xstudio, so i will try to fix it later in source code.

References ​