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