Skip to content

Latest commit

 

History

History
233 lines (127 loc) · 11.5 KB

davinci-resolve-openfx.md

File metadata and controls

233 lines (127 loc) · 11.5 KB
description
Gyroflow engine is also available as an OpenFX plugin to allow you to stabilise videos inside a video editor like DaVinci Resolve.

🔌 DaVinci Resolve (OpenFX)

Installation

The Gyroflow OpenFX Plugin works on Mac, Windows and Linux:

{% tabs %} {% tab title="Mac" %}

Installing the OpenFX plugin

  1. Download the latest version from https://gyroflow.xyz/download#plugins
  2. Create the OFX folder: /Library/OFX/Plugins. You can do that in Finder or in the Terminal: sudo mkdir -p /Library/OFX/Plugins ; open /Library/OFX/Plugins.
  3. Run Gyroflow-ofx-macosx.dmg
  4. Copy Gyroflow.ofx.bundle folder to /Library/OFX/Plugins/

{% hint style="info" %} IMPORTANT: Make sure the OFX folder is in the root /Library folder, not your user /Users/YOUR-USER-NAME/Library folder. {% endhint %}

Properly installed plugin on macOS

Hardware Acceleration

Gyroflow OFX plugin supports Metal acceleration on Mac. {% endtab %}

{% tab title="Windows" %}

Installing the OpenFX plugin

  1. Download the latest version from https://gyroflow.xyz/download#plugins
  2. Extract Gyroflow-ofx-windows.zip somewhere
  3. Create the OFX folder: C:\Program Files\Common Files\OFX\Plugins.
  4. Copy Gyroflow.ofx.bundle folder to C:\Program Files\Common Files\OFX\Plugins

Properly installed plugin on Windows

Hardware Acceleration

Gyroflow OFX plugin supports OpenGL, OpenCL and CUDA acceleration on Windows {% endtab %}

{% tab title="Linux" %}

Installing the OpenFX plugin

  1. Download the latest version from https://gyroflow.xyz/download#plugins
  2. Create the OFX folder: /usr/OFX/Plugins.
    1. You can do that in the Terminal: sudo mkdir -p /usr/OFX/Plugins && sudo chown $USER /usr/OFX/Plugins.
  3. ExtractGyroflow-ofx-linux.zip to /usr/OFX/Plugins

Properly installed plugin on Linux

Hardware Acceleration

Gyroflow OFX plugin supports OpenGL, OpenCL and CUDA acceleration on Linux {% endtab %} {% endtabs %}

Source Code

You can find the source code for this OpenFX plugin on GitHub here.

Nightly Builds

Development moves fast and there are new features added very often, check them out by downloading the nightly build:

The list of all nightly builds is available on GitHub actions.

Supported Hosts

This OpenFX plugin has been primarily built for Blackmagic's DaVinci Resolve, however it has also been tested in MAGIX Vegas and ASSIMILATE Scratch.

It may also work in other OpenFX-compatible hosts, such as Baselight, DVS Clipster, Nuke & Flame, however it's currently untested.

If you would like to use this OpenFX Plugin in another application, and it's not working correctly, please post a GitHub issue.

Interface

This section explains the various sections of the OpenFX Plugin Interface.

Gyroflow Project

Load for current file

This feature relies on external scripting and is only available in paid DaVinci Resolve Studio.

To use this feature, you also have to allow executing external scripts.

You can do this by going to Preferences...

Then within the General section, make sure External scripting using is set to Local.

For this feature to work, you must have the clip you want to apply Gyroflow to selected in the Edit page or in the Color page.

It is also impossible to query file path on a Compound Clip. In any case, you can just select the video or project file using the Browse button, as explained next...

Browse

If you're not able to use the Load for current file feature, you can manually Browse for a Gyroflow Project. Just click the Browse button and navigate to wherever your Gyroflow Project is saved.

The OpenFX Plugin will remember the last opened folder.

Load preset/lens profile

Clicking the Load preset/lens profile button allows you to select a Preset or Lens Profile.

Lens calibration is a very important piece of the stabilization algorithm and it's very important to use accurate lens profile when stabilizing a video in Gyroflow. You can learn more here.

On macOS, the built-in Lens Profiles are located at:

/Applications/Gyroflow.app/Contents/Resources/camera_presets

Open in Gyroflow

If you already have a Gyroflow Project loaded, pressing Open in Gyroflow will open this project in Gyroflow. If you don't already have a Gyroflow Project loaded, this will just open Gyroflow in it's default state.

Reload Project

If you already have a Gyroflow Project loaded, pressing the Reload Project button will reload the project from the filesystem. This is useful if you've made changes in the main Gyroflow application, but now want to update the OpenFX Plugin.

Last saved project

This is a convenince function that allows you to load the last saved project in the main Gyroflow application to the OpenFX plugin. This is useful if you're working on the free version of DaVinci Resolve, and you don't have access to the Load for current file feature.

Status Message

Underneath the Last save project button is a checkbox that displays a status message. This is useful to determine if everything is working correctly, or if there's any issues or problems - for example, a frames per second mismatch:

If everything is correct and working, you'll see this:

Adjust Parameters

This section allows you to manually adjust several Gyroflow parameters directly within the OpenFX plugin. You can also apply keyframes.

Input & Video Rotation

Input Rotation is when the Host (i.e. DaVinci Resolve) rotates the input pixels before feeding to the OpenFX Plugin. For example, if an .mp4 contains rotation in the metadata, the Host will automatically rotate it. Gyroflow expects raw pixels directly from the source file, so if the Host has already rotated them, it won't match. Given this, the Input rotation is the rotation done by the host BEFORE feeding to the OpenFX plugin, whereas Video rotation is a rotation by the Gyroflow engine AFTER stabilisation.

Video Speed

Use this slider to change video speed or keyframe it, instead of built-in speed changes in the editor.

Disable Gyroflow's stretch

If you used Input stretch in the lens profile in Gyroflow, and you de-stretched the video separately in Resolve, check this to disable Gyroflow's internal stretching.

Keyframes

This section allows you to control how the OpenFX handles keyframes.

Use Gyroflow's keyframes

Ticking this uses Gyroflow's internal keyframes, instead of the ones in your host application (i.e. DaVinci Resolve). This is enabled by default.

Recalculate keyframes

This button allows you to recalculate keyframes after adjusting the splines (in Fusion mode).

Additional Settings

This section covers the additional settings at the bottom of the OpenFX settings.

Stabilization overview

This allow you to zoom out the view to see the stabilization results. This is very useful to see if and how Gyroflow is working. You should disable this before rendering.

Don't draw outside source clip

When clip and timeline aspect ratio don't match, draw the final image inside the source clip, instead of drawing outside it.

Embed .gyroflow data in plugin

If you intend to share the host (i.e. DaVinci Resolve) project to someone else, the plugin can embed the Gyroflow project data including gyro data inside the host project. This way you don't have to share .gyroflow project files. Enabling this option will make the project bigger. This option is off by default.

Workflow

Vertical Video or different aspect ratio

For vertical video, or if your timeline has different aspect ratio than your source video, the first thing you have to do is change your timeline settings -> Mismatched resolution to "Scale entire image to fit"

Then you have two options:

  1. The preferred option is to add the Gyroflow OpenFX plugin in a Fusion node, then set the target resolution in the Output size area in the plugin. Then go to plugin Settings and check Use plugin RoD for output size and then you can continue on the vertical timeline in the edit/color pages. For this to work correctly, you have to change Clip attributes -> Image Orientation to , and then in plugin set Video rotation to 90 or -90 and Input rotation to 0°.
  2. Alternatively, change your timeline scaling settings to Scale image to fit instead of Scale image with crop - this is easier method but if you have 16:9 video that you want to export as 9:16, it will negatively affect the quality.

Frame Rate Mismatch

If your timeline has different frame rate than the source file, you may experience broken stabilization. The plugin tries its best to adapt to the frame rate differences, but sometimes it's not possible and in that case, you have to add the plugin as a Fusion node instead.