git.sesse.net Git - mlt/blob - src/modules/vid.stab/filter_vidstab.yml

   1 schema_version: 0.1
   2 type: filter
   3 identifier: vidstab
   4 title: Vid.Stab Detect and Transform
   5 copyright: Jakub Ksiezniak
   6 creator: Marco Gittler <g.marco@freenet.de>
   7 version: 1
   8 license: GPL
   9 language: en
  10 url: http://public.hronopik.de/vid.stab/
  11 tags:
  12   - Video
  13 description: Stabilize Video (for wiggly/rolling video)
  14 notes: >
  15   This filter requires two passes. The first pass performs analysis and stores
  16   the result in a file. Upon successful completion of the analysis, the
  17   "results" property is updated with the name of the file storing the results.
  18   The second pass applies the results to the image.
  19
  20   To use with melt, use 'melt ... -consumer xml:output.mlt all=1' for the
  21   first pass. For the second pass, use output.mlt as the input.
  22
  23 parameters:
  24   - identifier: results
  25     title: Analysis Results
  26     type: string
  27     description: >
  28       Set after analysis. Used during application.
  29       A set of image motion information that describes the analyzed clip.
  30       When results are not supplied, the filter computes the results and stores
  31       them in a file. This property is updated with the name of that file when
  32       the last frame has been processed.
  33     mutable: no
  34
  35   - identifier: filename
  36     title: Target File Name
  37     type: string
  38     description: >
  39       Used during analysis.
  40       The name of the file to store the analysis results in.
  41     required: no
  42     readonly: no
  43     default: vidstab.trf
  44     widget: fileopen
  45
  46   - identifier: shakiness
  47     title: Shakiness
  48     type: integer
  49     description: >
  50       Used during analysis.
  51       How shaky the video is.
  52     readonly: no
  53     required: no
  54     minimum: 1
  55     maximum: 10
  56     default: 4
  57     mutable: no
  58     widget: spinner
  59
  60   - identifier: accuracy
  61     title: Accuracy
  62     type: integer
  63     description: >
  64       Used during analysis.
  65       The accuracy of shakiness detection.
  66     readonly: no
  67     required: no
  68     minimum: 1
  69     maximum: 15
  70     default: 4
  71     mutable: no
  72     widget: spinner
  73
  74   - identifier: stepsize
  75     title: Stepsize
  76     type: integer
  77     description: >
  78       Used during analysis.
  79       The step size of the search process.
  80     readonly: no
  81     required: no
  82     minimum: 0
  83     maximum: 100
  84     default: 6
  85     mutable: no
  86     widget: spinner
  87
  88   - identifier: mincontrast
  89     title: Minimum Contrast
  90     type: float
  91     description: >
  92       Used during analysis.
  93       Below this contrast, a field is discarded.
  94     readonly: no
  95     required: no
  96     minimum: 0
  97     maximum: 1
  98     default: 0.3
  99     mutable: no
 100     widget: spinner
 101
 102   - identifier: show
 103     title: Show
 104     type: integer
 105     description: >
 106       Used during analysis.
 107       0 = draw nothing
 108       1 or 2 = show fields and transforms
 109     readonly: no
 110     required: no
 111     minimum: 0
 112     maximum: 2
 113     default: 0
 114     mutable: no
 115     widget: spinner
 116
 117   - identifier: tripod
 118     title: Tripod
 119     type: integer
 120     description: >
 121       Used during analysis and application.
 122       if 0, tripod mode is disabled.
 123       if > 0, specifies the frame to be used as a reference frame for tripod mode
 124       During application, relative and smoothing properties are both ignored if tripod mode is in use.
 125     readonly: no
 126     required: no
 127     minimum: 0
 128     maximum: 100000
 129     default: 0
 130     mutable: no
 131     widget: spinner
 132
 133   - identifier: smoothing
 134     title: Smoothing
 135     type: integer
 136     description: >
 137       Used during application.
 138       Number of frames for lowpass filtering (2N + 1 frames)
 139     readonly: no
 140     required: no
 141     minimum: 0
 142     maximum: 100
 143     default: 15
 144     mutable: yes
 145     widget: spinner
 146
 147   - identifier: maxshift
 148     title: Maxshift
 149     type: integer
 150     description: >
 151       Used during application.
 152       Maximum number of pixels to transform the image. -1 = no limit
 153     unit: pixels
 154     readonly: no
 155     required: no
 156     minimum: -1
 157     maximum: 1000
 158     default: -1
 159     mutable: yes
 160     widget: spinner
 161
 162   - identifier: maxangle
 163     title: Maxangle
 164     type: float
 165     description: >
 166       Used during application.
 167       Maximum angle to rotate, -1 = no limit
 168     unit: radians
 169     readonly: no
 170     required: no
 171     minimum: -1
 172     maximum: 3.142
 173     default: -1
 174     mutable: yes
 175     widget: spinner
 176
 177   - identifier: crop
 178     title: Crop
 179     type: integer
 180     description: >
 181       Used during application.
 182       0 = keep border, 1 = black background
 183     readonly: no
 184     required: no
 185     minimum: 0
 186     maximum: 1
 187     default: 0
 188     mutable: yes
 189     widget: spinner
 190
 191   - identifier: invert
 192     title: Invert
 193     type: integer
 194     description: >
 195       Used during application.
 196       Invert transforms
 197     readonly: no
 198     required: no
 199     minimum: 0
 200     maximum: 1
 201     default: 0
 202     mutable: yes
 203     widget: spinner
 204
 205   - identifier: relative
 206     title: Relative
 207     type: integer
 208     description: >
 209       Used during application.
 210       Consider transforms as absolute (0) or relative (1)
 211     readonly: no
 212     required: no
 213     minimum: 0
 214     maximum: 1
 215     default: 1
 216     mutable: yes
 217     widget: spinner
 218
 219   - identifier: zoom
 220     title: Zoom
 221     type: integer
 222     description: >
 223       Used during application.
 224       Additional zoom amount
 225     unit: percent
 226     readonly: no
 227     required: no
 228     minimum: -500
 229     maximum: 500
 230     default: 0
 231     mutable: yes
 232     widget: spinner
 233
 234   - identifier: optzoom
 235     title: Optimal Zoom
 236     type: integer
 237     description: >
 238       Used during application.
 239       Automatically determine optimal zoom. 1 - static zoom, 2 - adaptive zoom
 240     readonly: no
 241     required: no
 242     minimum: 0
 243     maximum: 2
 244     default: 1
 245     mutable: yes
 246     widget: spinner
 247
 248   - identifier: zoomspeed
 249     title: Optimal Zoom Speed
 250     type: float
 251     description: >
 252       Used during application.
 253       Zoom per frame (used when optzoom = 2)
 254     unit: percent
 255     readonly: no
 256     required: no
 257     minimum: 0
 258     maximum: 1
 259     default: 0.25
 260     mutable: yes
 261     widget: spinner
 262
 263   - identifier: reload
 264     title: Reload Results
 265     description: >
 266       The application should set this to 1 when it updates the results property to indicate that the results should be reloaded.
 267     type: integer
 268     minimum: 0
 269     maximum: 1
 270     mutable: yes