Skip to content

Commit

Permalink
renamed the 1.0 plugin to Gyroflow, added 1.0 instructions to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
ilya-epifanov committed Feb 6, 2022
1 parent 2d846f8 commit 15f1406
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 12 deletions.
35 changes: 26 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,44 @@
* Works with stabilization data exported with [gyroflow](http://gyroflow.xyz/)
* Allows you apply the stabilization right in your OpenFX-capable video editor

## Installation
# Installation

Grab the archive for your OS from the [releases page](https://github.com/ilya-epifanov/gyroflow-ofx/releases).

### Linux
## Linux

mkdir -p /usr/OFX/Plugins
cd /usr/OFX/Plugins
sudo unzip ${PATH_TO}/gyroflow-ofx-linux.zip

### MacOS
## MacOS

Copy the `GyroFlow.ofx.bundle` from the archive into the `/Library/OFX/Plugins` directory.
Create the directory if it doesn't exist yet.

### Windows
## Windows

Copy the `GyroFlow.ofx.bundle` from the archive into the `C:\Program Files\Common Files\OFX\Plugins` folder.
Create the folder if it doesn't exist yet.

## Usage
# Usage

## With Gyroflow 1.0

### Export `.gyroflow` file in the Gyroflow app

Click the `Export .gyroflow file (including gyro data)` in the Gyroflow app.

### Basic plugin usage

First you need to apply the plugin to the clip.
In DaVinci Resolve you can do that by going to the Fusion tab and inserting the "Warp -> Gyroflow (1.0)" (or "Warp -> Fisheye stabilizer (1.0)") after the media input node.

### Load the .gyroflow file

In DaVinci Resolve Fusion, go to the `Gyroflow` (or `Fisheye stabilizer`) node settings. Select the `.gyroflow` file in the `Gyroflow file` entry.

## With Gyroflow 0.x

### Export keyframes in the Gyroflow app

Expand All @@ -35,7 +52,7 @@ Instead of exporting video, click the `Export (hopefully) stabilized keyframes f
### Basic plugin usage

First you need to apply the plugin to the clip.
In DaVinci Resolve you can do that by going to the Fusion tab and inserting the "Warp -> Fisheye stabilizer" after media input node.
In DaVinci Resolve you can do that by going to the Fusion tab and inserting the "Warp -> Fisheye stabilizer (0.x)" after media input node.
You'll see some distortion correction being applied, probably not the correct one for your setup.

### Per-camera setup
Expand Down Expand Up @@ -112,15 +129,15 @@ Save this as a preset. In Fusion, right-click the node and `Settings -> Save As.

You should see the distortion being corrected properly now (straight lines should still be straight no matter how close to the frame edge).

### Load gyro data
### Load the gyro data

In DaVinci Resolve Fusion, go to the `Fisheye stabilizer` node settings again. Click the diamond button next to `Correction W/X/Y/Z` parameters in the `Correction quaternion` section.
Open the `Spline` pane.
Right click `Fisheyestabilizer*/Correction W` -> `Import Spline...`, load the corresponding `.w.spl` file. Do the same for `Correction X/Y/Z` parameters. Take care to load the correct `.(x|y|z).spl` files.
Voilà.
Now adjust the `FOV scale` parameter to your liking.

## License
# License

Version 0.1 of the plugin is licensed under either of

Expand All @@ -136,7 +153,7 @@ Version 1.0 of the plugin is licensed under either of
* GNU General Public License version 3
([LICENSE-GPL](LICENSE-GPL))

## Contribution
# Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
Expand Down
6 changes: 3 additions & 3 deletions src/fisheyestab_v1.rs
Original file line number Diff line number Diff line change
Expand Up @@ -221,9 +221,9 @@ impl Execute for FisheyeStabilizerPlugin {
let mut effect_properties: EffectDescriptor = effect.properties()?;
effect_properties.set_grouping("Warp")?;

effect_properties.set_label("Fisheye stabilizer (1.0)")?;
effect_properties.set_short_label("Fisheye stabilizer")?;
effect_properties.set_long_label("Fisheye stabilizer (for gyroflow >= 1.0)")?;
effect_properties.set_label("Gyroflow (1.0)")?;
effect_properties.set_short_label("Gyroflow")?;
effect_properties.set_long_label("Gyroflow (>= 1.0)")?;

effect_properties.set_supported_pixel_depths(&[BitDepth::Float])?;
effect_properties.set_supported_contexts(&[ImageEffectContext::Filter])?;
Expand Down

0 comments on commit 15f1406

Please sign in to comment.