josh04/vkd

node-based video editor in vulkan

vkd

a vulkan node-based image and video processing platform
Docs · Downloads · Bugs

Table of Contents

1. About *vkd*
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
   • Built With
6. License
7. Contact

About vkd

vkd is a node-based video and photo editing platform implemented in Vulkan. The nodes perform work chiefly through applying Vulkan compute shaders. My initial goals were to allow simple compositing graphs for video and accurate colour operations for inverting photo negatives.

Getting Started

To get a local copy up and running follow these example steps. To use OCIO you will need to download an OCIO configuration - in development I have the aces_1.2 folder in my build/bundle/release/bin directory.

Prerequisites

vkd can build on Windows, MacOS or Linux. On Windows, the Visual Studio 2019 compiler is required.

Most dependencies are included in the repository and will build alongside the main software. Some dependencies are provided as binaries. A zip of these binaries will be made available TBC.

Installation

1. Install cmake and ninja
2. Clone the repository

   git clone --recurse-submodules https://github.com/josh04/vkd.git

3. Navigate to the build directory

   cd vkd/cmake

4. Configure using cmake

   cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo -GNinja -DCMAKE_EXPORT_COMPILE_COMMANDS=TRUE .

5. Build using ninja

   ninja install

Screenshots

Contributing

Active development is currently performed on a private development branch. If you wish to contribute a feature, feel free to fork the current master and submit a pull request.

Third Party

vkd depends on

• ACES
• enkiTS
• ffmpeg
• glm
• glslang
• Imath
• dear imgui
• ktx
• libpng
• LibRaw
• OCIO
• OpenEXR
• sago PlatformFolders
• SDL2
• spirv-reflect
• tinyxml2
• zlib
• cereal
• ghc::filesystem
• gl3w
• stb_image

License

License TBD.

Contact

Twitter: @vkdapp

Project Link: https://github.com/josh04/vkd

(back to top)