]> git.sesse.net Git - kdenlive/blob - effects/README
Move translation files
[kdenlive] / effects / README
1 Effects 
2
3 Kdenlive uses MLT for all video/audio effects. Effects in Kdenlive are now built using 
4 xml files describing the effect and its parameters.
5
6 Here is a sample effect file:
7
8 --------------------------------------------------------------------------------------
9
10 1  <!DOCTYPE kpartgui>
11 2  <effect tag="motion_est">
12 3       <name>Auto Mask</name>
13 4       <properties id="autotrack_rectangle" tag="autotrack_rectangle" />
14 5       <parameter type="geometry" name="geometry" default="100,100:100x100">
15 6               <name>Geometry</name>
16 7       </parameter>
17 8       <parameter type="bool" name="debug" default="1">
18 9               <name>Debug</name>
19 10      </parameter>
20 11      <parameter type="bool" name="obscure" default="0">
21 12              <name>Obscure</name>
22 13      </parameter>
23 14 </effect>
24
25 --------------------------------------------------------------------------------------
26
27
28 Line 1 is required to have the effect and parameter names added to the translation files
29 In line 2, the "tag" is the name of the mlt filter that has to be found in the file 
30 /usr/share/mlt/modules/filters.dat for the effect to appear in Kdenlive
31 Line 3 is the name of the effect that will appear to the user
32 Line 4 holds several effect parameters:
33         id is an internal kdenlive id, can be anything, but must be unique for each effect
34         tag is the "mlt_service" name of the effect
35         type defines if the effect is "audio" or "video". If omitted, effect is considered as video
36
37 Then, you have the parameter definitions.
38 The parameter entry has the following attributes:
39         type is used by Kdenlive to build the UI for this effect.
40                 allowed types are: 
41                 - constant = a number, represented by a slider
42                 - bool = boolean value, represented as a checkbox
43                 - color = a color value, represented by a selectable color button
44                 - list = a combobox listing different strings
45                 - geometry = 4 different sliders for x, y, width and height values that will end up as x,y:wxh
46                 - position = a frame number that can be obtained from current cursor position
47                 - double = a number with keyframes
48                 - complex = only used in obscure effect, has x, y, width, height and pixellation values
49
50                 The integer values can have max, min and default values defined, see effect files in this folder for more examples
51         the "name" parameter is the name that will be passed to MLT
52
53 The "name" tag gives the parameter name as it will appear to the user
54
55 Kdenlive parses the effect folder at each startup, so that if you have an xml file describing a new effect, just copy it in your ~/.kde/share/apps/kdenlive/effects/ folder and restart Kdenlive to enable the new effect
56