git.sesse.net Git - kdenlive/blob - 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
  30 Line 3 is the name of the effect that will appear to the user
  31 Line 4 holds several effect parameters:
  32         id is an internal kdenlive id, can be anything, but must be unique for each effect
  33         tag is the "mlt_service" name of the effect
  34         type defines if the effect is "audio" or "video". If omitted, effect is considered as video
  35
  36 Then, you have the parameter definitions.
  37 The parameter entry has the following attributes:
  38         type is used by Kdenlive to build the UI for this effect.
  39                 allowed types are:
  40                 - constant = a number, represented by a slider
  41                 - bool = boolean value, represented as a checkbox
  42                 - color = a color value, represented by a selectable color button
  43                 - list = a combobox listing different strings
  44                 - geometry = 4 different sliders for x, y, width and height values that will end up as x,y:wxh
  45                 - position = a frame number that can be obtained from current cursor position
  46                 - double = a number with keyframes
  47                 - complex = only used in obscure effect, has x, y, width, height and pixellation values
  48
  49                 The integer values can have max, min and default values defined, see effect files in this folder for more examples
  50         the "name" parameter is the name that will be passed to MLT
  51
  52 The "name" tag gives the parameter name as it will appear to the user
  53
  54 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.
  55
  56 Effects need to be blacklisted in the file kdenlive/data/blacklisted_effects.txt if they use a custom (i.e. non-default) XML GUI from this directory.