]> git.sesse.net Git - mlt/blob - src/modules/rotoscoping/filter_rotoscoping.yml
Move burningtv into plusgpl module.
[mlt] / src / modules / rotoscoping / filter_rotoscoping.yml
1 schema_version: 0.1
2 type: filter
3 identifier: rotoscoping
4 title: Rotoscoping
5 copyright: Copyright (C) 2011 Till Theato
6 version: 0.3
7 license: GPL
8 language: en
9 url: none
10 creator: Till Theato <root@ttill.de>
11 tags:
12   - Video
13 description: Keyframable vector based rotoscoping
14
15 bugs:
16   - in some cases top most row in polygon is assigned to outside
17
18 parameters:
19   - identifier: mode
20     title: Mode
21     type: string
22     description: How to visualize the area described by the spline
23     readonly: no
24     required: no
25     default: alpha
26     mutable: yes
27     widget: dropdown
28     values:
29       - alpha
30       - luma
31       - rgb
32
33   - identifier: alpha_operation
34     title: Alpha Operation 
35     type: string
36     description: |
37       How to proceed with the current alpha mask (only if mode = alpha).
38       clear = existing alpha mask is overwritten
39       max = maximum: existing alpha mask, mask generated by this filter
40       min = minimum: existing alpha mask, mask generated by this filter
41       add = existing alpha mask + generated mask
42       sub = existing alpha mask - generated mask
43     readonly: no
44     required: no
45     default: clear
46     mutable: yes
47     widget: dropdown
48     values:
49       - clear
50       - max
51       - min
52       - add
53       - sub
54
55   - identifier: invert
56     title: Invert
57     type: integer
58     description: use area inside of spline (0) or the outside (1)
59     readonly: no
60     required: no
61     minimum: 0
62     maximum: 1
63     default: 0
64     mutable: yes
65     widget: checkbox
66
67   - identifier: feather
68     title: Feather
69     type: integer
70     description: amount of feathering (radius of "average" blur applied on mask)
71     readonly: no
72     required: no
73     minimum: 0
74     maximum: 1000 # no real limit
75     default: 0
76     mutable: yes
77     widget: spinner
78
79   - identifier: feather_passes
80     title: Feathering passes
81     type: integer
82     description: number of blur (feathering) passes
83     readonly: no
84     required: no
85     minimum: 1
86     maximum: 1000 # no real limit
87     default: 1
88     mutable: yes
89     widget: spinner
90
91   - identifier: spline
92     title: Spline
93     type: string
94     description: >
95       The spline, a list of cubic Bézier curves, is described using JSON.
96       The most basic parts are the coordinate tuples: [x, y]; x,y will be mapped from the range 0-1 to the image dimensions.
97       Next layer are the Bézier points: [handle 1, point, handle 2] with handle 1, point, handle 2 being coordinate tuples
98       The spline is a list of Bézier points.
99       Optionally keyframes can be defined as a object of frame values, relative to the filter's in point, assigned to splines.
100     readonly: no
101     required: yes
102     mutable: yes