Gyroflow documentation
  • ๐Ÿ‘‹Welcome to Gyroflow
    • ๐Ÿ’ŽFeatures
    • โœจExamples
    • ๐ŸงชTest Files
  • Getting started
    • โš™๏ธInstallation
      • DaVinci Resolve (OpenFX)
      • Final Cut Pro (Gyroflow Toolbox)
    • ๐ŸŽฅSupported Cameras
      • GoPro
      • DJI
      • Sony
      • Insta360
      • Blackmagic
      • RED
      • Flight controllers
      • RunCam
      • Caddx
      • Hawkeye
      • Mobile Phones
      • Other Cameras
    • ๐Ÿ”งBasic Usage
      • ๐Ÿ“ˆTimeline & Gyro Chart
      • โŒ›Synchronization
      • ๐Ÿ”ฅStabilization
      • ๐ŸŽฌExporting
    • ๐Ÿ“ธCommon Filming Tips & Issues
    • ๐ŸLens Calibration
    • โŒจ๏ธKeyboard Shortcuts
    • ๐ŸŽž๏ธFile Joiner
    • โ“FAQ
    • ๐ŸžTroubleshooting
    • ๐Ÿ—ฃ๏ธTranslations
    • ๐Ÿ›Report an Issue
  • Advanced usage
    • ๐ŸŽฌInput Data
    • ๐Ÿ”ญLens Profiles
    • โŒ›Synchronization
    • ๐Ÿ”ฅStabilization
    • ๐Ÿ”‘Keyframes
    • โš™๏ธSettings Presets
    • โฉRender Queue
    • ๐ŸŽฌExporting
    • ๐Ÿ—๏ธCommand Line (CLI)
    • ๐Ÿ’ปOther
    • ๐Ÿ”€IMU Orientation and rotation
    • ๐ŸŽจColor Differences
    • ๐ŸŒ€Using External Gyro Source
      • Action Camera as a Logger
      • Flight Controller
      • ESP-gyrologger
      • Flowshutter
    • ๐Ÿ“บLive Feed Stabilization
    • ๐Ÿฅฝ360ยฐ Cameras
  • Hardware Acceleration
    • ๐ŸŸขNVIDIA
    • ๐Ÿ”ดAMD
    • ๐Ÿ”ตIntel
    • โšชApple
    • ๐ŸŸขAndroid
  • Video Editor Plugins
    • ๐Ÿ’กGeneral Plugin Workflow
    • ๐Ÿ”ŒDaVinci Resolve (OpenFX)
    • ๐ŸŽž๏ธAdobe Premiere / After Effects
    • ๐ŸŽฌFinal Cut Pro X
    • ๐Ÿช„frei0r
    • ๐Ÿ—ƒ๏ธCSV Export
  • Technical Details
    • ๐Ÿฆ€Used Technologies
    • ๐Ÿ–‡๏ธParsing Gyro Data
    • ๐Ÿ› ๏ธGyroflow Core
    • ๐ŸงชBuilding from Source
    • ๐Ÿ—ƒ๏ธGCSV Format
    • ๐Ÿ—„๏ธGyroflow protobuf
    • ๐Ÿ–ฅ๏ธGitHub Repository
  • Authors
    • ๐Ÿ‘จโ€๐Ÿ”งAuthors
Powered by GitBook
On this page
  1. Advanced usage

Command Line (CLI)

Gyroflow has a CLI interface for usage in scripts and automating workflows.

You can also use Gyroflow as a command line program, in order to automate some tasks in scripts.

Most common usage will be to provide a video file and render the stabilized video. You can simply call Gyroflow.exe YOUR_FILE.mp4 to do that in case of sync-less files, or also add --preset YOUR_PRESET.gyroflow to apply any settings and/or lens profile you want.

CLI can also render from a project file.

One of more interesting CLI features is a watch folder, which can be used to automatically stabilize all new footage copied to that specified folder. You can simply run Gyroflow.exe --watch C:\MY_FOOTAGE\ and it automatically stabilize any new video files that appear in that folder.

All other options are pretty self-explanatory.

Usage: gyroflow [<input...>] [-f] [-j <parallel-renders>] [-d <when-done>] [-p <out-params>] [-t <suffix>] [-s <sync-params>] [--export-project <export-project>] [--export-metadata <export-metadata>] [--export-metadata-fields <export-metadata-fields>] [--export-stmap <export-stmap>] [--preset <preset>] [--open <open>] [--watch <watch>] [-g <gyro-file>] [-b <processing-device>] [-r <rendering-device>] [--version]

Gyroflow v1.6.0
Video stabilization using gyroscope data

Positional Arguments:
  input             input files: videos, project files, lens profiles, presets

Options:
  -f, --overwrite   overwrite if output file exists, default: false
  -j, --parallel-renders
                    number of parallel renders, default: 1
  -d, --when-done   when done: 1 - shut down; 2 - reboot; 3 - sleep; 4 -
                    hibernate; 5 - logout
  -p, --out-params  output parameters, eg. "{{ 'codec': 'H.265/HEVC',
                    'bitrate': 150, 'use_gpu': true, 'audio': true }}"
  -t, --suffix      default output suffix, eg. "_stabilized"
  -s, --sync-params synchronization parameters, eg. "{{ 'search_size': 3,
                    'processing_resolution': 720 }}"
  --export-project  export project file instead of rendering: 1 - default
                    project, 2 - with gyro data, 3 - with processed gyro data, 4
                    - video + project file
  --export-metadata export metadata instead of rendering. <type>:<path>, where
                    type is 1 - full metadata, 2 - parsed metadata, 3 - camera
                    data. Eg. "3:camera.json"
  --export-metadata-fields
                    fields to include in the exported camera metadata file.
                    Defaults to all: "{{ 'original': {{ 'gyroscope': true,
                    'accelerometer': true, 'quaternion': true, 'euler_angles':
                    true }}, 'stabilized': {{ 'quaternion': true,
                    'euler_angles': true }}, 'zooming': {{ 'minimal_fovs':
                    true, 'fovs': true, 'focal_length': true }} }}"
  --export-stmap    export STmap instead of rendering. <type>:<folder_path>,
                    where type is 1 - single frame, 2 - all frames. Eg.
                    "1:C:/stmaps/"
  --preset          preset (file or content directly), eg. "{{ 'version': 2,
                    'stabilization': {{ 'fov': 1.5 }} }}"
  --open            open file in the GUI (video or project)
  --watch           watch folder for automated processing
  -g, --gyro-file   gyro file path
  -b, --processing-device
                    processing device index. By default it uses the one set in
                    the GUI
  -r, --rendering-device
                    rendering device, specify the GPU type. Eg. "nvidia",
                    "intel", "amd", "apple m"
  --version         print app version
  --help, help      display usage information

Last updated 2 months ago

๐Ÿ—๏ธ