Tree [e1c391] master 0.8.2 / effects /
History



File Date Author Commit
update 2011-09-10 ttill ttill [777db0] Add support of SOP/Sat effect version 0.2.
CMakeLists.txt 2011-09-06 ttill ttill [9feb43] Update mechanism for effects.
README 2011-09-10 ttill ttill [99200f] Allow to offset effect parameters.
audiobalance.xml 2010-08-17 ddennedy ddennedy [618c18] Add audio balance and pan effects.
audiopan.xml 2011-07-14 j-b-m j-b-m [cfe2fb] Required changes to make Kdenlive work with som...
audiowave.xml 2010-12-29 j-b-m j-b-m [627581] Add MLT's audiowave effect to display the audio...
automask.xml 2010-09-13 Marco Gittler Marco Gittler [785c03] Merge branch 'gmarco' of ssh://kdenlive.git.sou...
boxblur.xml 2010-11-07 ttill ttill [d1e973] Update some effect GUIs (mostly parameter order...
brightness.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
channelcopy.xml 2011-07-14 j-b-m j-b-m [cfe2fb] Required changes to make Kdenlive work with som...
charcoal.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
chroma.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
chroma_hold.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
crop.xml 2011-07-03 j-b-m j-b-m [66bd4b] Fix crop effect max value so that the slider ha...
dust.xml 2011-01-08 prokoudine prokoudine [fd01ab] MLT effects don't use "simplekeyframe"
fade_from_black.xml 2009-04-28 j-b-m j-b-m [a58fdb] Add missing param to fade from black effect:
fade_to_black.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
fadein.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
fadeout.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
freeze.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
frei0r_3dflippo.xml 2011-03-13 ddennedy ddennedy [598099] Fix a bunch of effects XML and registration.
frei0r_alpha0ps.xml 2011-07-14 j-b-m j-b-m [cfe2fb] Required changes to make Kdenlive work with som...
frei0r_alphagrad.xml 2011-07-14 j-b-m j-b-m [cfe2fb] Required changes to make Kdenlive work with som...
frei0r_alphaspot.xml 2011-07-14 j-b-m j-b-m [cfe2fb] Required changes to make Kdenlive work with som...
frei0r_balanc0r.xml 2011-09-06 j-b-m j-b-m [d20e33] Fix White balance default value as noted by Dan...
frei0r_baltan.xml 2011-01-07 prokoudine prokoudine [5c21ec] A bunch of new previously missing effects descr...
frei0r_bezier_curves.xml 2011-07-14 j-b-m j-b-m [cfe2fb] Required changes to make Kdenlive work with som...
frei0r_brightness.xml 2009-07-21 j-b-m j-b-m [127254] xml for frei0r saturat0r & lens correction
frei0r_c0rners.xml 2011-07-14 j-b-m j-b-m [cfe2fb] Required changes to make Kdenlive work with som...
frei0r_cartoon.xml 2011-09-09 ttill ttill [7a129d] Add support for upcoming version 2.1 of filter ...
frei0r_cluster.xml 2011-03-13 ddennedy ddennedy [598099] Fix a bunch of effects XML and registration.
frei0r_coloradj_rgb.xml 2011-07-14 j-b-m j-b-m [cfe2fb] Required changes to make Kdenlive work with som...
frei0r_colordistance.xml 2011-01-06 prokoudine prokoudine [a5d8b8] Added missing descriptions, adjusted names of v...
frei0r_contrast0r.xml 2010-11-10 ttill ttill [aef2c4] Remove some "0r"s from effect names
frei0r_curves.xml 2011-09-08 ttill ttill [854892] Add support for curves version 0.3
frei0r_d90stairsteppingfix.xml 2011-01-04 granjow granjow [044824] Explanation for stairstepping filter added
frei0r_defish0r.xml 2011-07-14 j-b-m j-b-m [cfe2fb] Required changes to make Kdenlive work with som...
frei0r_delay0r.xml 2011-03-13 ddennedy ddennedy [598099] Fix a bunch of effects XML and registration.
frei0r_delaygrab.xml 2011-01-07 prokoudine prokoudine [5c21ec] A bunch of new previously missing effects descr...
frei0r_distort0r.xml 2010-11-10 ttill ttill [aef2c4] Remove some "0r"s from effect names
frei0r_edgeglow.xml 2011-03-13 ddennedy ddennedy [598099] Fix a bunch of effects XML and registration.
frei0r_equaliz0r.xml 2011-03-13 ddennedy ddennedy [598099] Fix a bunch of effects XML and registration.
frei0r_facebl0r.xml 2011-03-16 ddennedy ddennedy [47a9a9] Add effects XML files for frei0r facebl0r and f...
frei0r_facedetect.xml 2011-07-14 j-b-m j-b-m [cfe2fb] Required changes to make Kdenlive work with som...
frei0r_flippo.xml 2011-01-07 prokoudine prokoudine [5c21ec] A bunch of new previously missing effects descr...
frei0r_glow.xml 2010-05-13 ttill ttill [702cba] Add XML GUI for frei0r.glow and frei0r.pixeliz0...
frei0r_hqdn3d.xml 2010-12-23 ttill ttill [268d9b] Make it possible to add a comment explaining ef...
frei0r_hueshift0r.xml 2011-01-06 prokoudine prokoudine [a5d8b8] Added missing descriptions, adjusted names of v...
frei0r_lenscorrection.xml 2010-10-23 ttill ttill [c49c32] - Make more frei0r effects keyframable
frei0r_letterb0xed.xml 2011-03-13 ddennedy ddennedy [598099] Fix a bunch of effects XML and registration.
frei0r_levels.xml 2011-09-06 ttill ttill [9feb43] Update mechanism for effects.
frei0r_lightgraffiti.xml 2011-09-10 ttill ttill [bb3bbe] Add support for light graffiti effect version 0.2.
frei0r_luminance.xml 2011-03-13 ddennedy ddennedy [598099] Fix a bunch of effects XML and registration.
frei0r_mask0mate.xml 2011-03-13 ddennedy ddennedy [598099] Fix a bunch of effects XML and registration.
frei0r_nervous.xml 2011-01-07 prokoudine prokoudine [5c21ec] A bunch of new previously missing effects descr...
frei0r_nosync0r.xml 2011-03-13 ddennedy ddennedy [598099] Fix a bunch of effects XML and registration.
frei0r_pixeliz0r.xml 2010-11-12 ttill ttill [6261fc] Add option to speed up project loading: Replace...
frei0r_pr0be.xml 2011-07-14 j-b-m j-b-m [cfe2fb] Required changes to make Kdenlive work with som...
frei0r_pr0file.xml 2011-07-14 j-b-m j-b-m [cfe2fb] Required changes to make Kdenlive work with som...
frei0r_primaries.xml 2011-03-13 ddennedy ddennedy [598099] Fix a bunch of effects XML and registration.
frei0r_rgbparade.xml 2011-01-07 prokoudine prokoudine [5c21ec] A bunch of new previously missing effects descr...
frei0r_saturat0r.xml 2010-11-10 ttill ttill [aef2c4] Remove some "0r"s from effect names
frei0r_scale0tilt.xml 2010-11-10 ttill ttill [aef2c4] Remove some "0r"s from effect names
frei0r_scanline0r.xml 2011-01-06 prokoudine prokoudine [23e4da] First batch of missing effects descriptions, ch...
frei0r_select0r.xml 2011-07-14 j-b-m j-b-m [cfe2fb] Required changes to make Kdenlive work with som...
frei0r_sharpness.xml 2010-12-11 ttill ttill [850a75] Sharpness effect: Rename to Sharpen, move to En...
frei0r_sobel.xml 2011-03-13 ddennedy ddennedy [598099] Fix a bunch of effects XML and registration.
frei0r_sopsat.xml 2011-09-10 ttill ttill [777db0] Add support of SOP/Sat effect version 0.2.
frei0r_squareblur.xml 2009-11-14 j-b-m j-b-m [e70f47] First frei0r effect with keyframes
frei0r_tehroxx0r.xml 2011-03-13 ddennedy ddennedy [598099] Fix a bunch of effects XML and registration.
frei0r_three_point_balance.xml 2010-11-07 ttill ttill [d1e973] Update some effect GUIs (mostly parameter order...
frei0r_threelay0r.xml 2011-01-07 prokoudine prokoudine [5c21ec] A bunch of new previously missing effects descr...
frei0r_threshold0r.xml 2009-11-19 j-b-m j-b-m [5a1cae] More keyframes for frei0r effects
frei0r_tint0r.xml 2010-11-10 ttill ttill [aef2c4] Remove some "0r"s from effect names
frei0r_twolay0r.xml 2011-01-07 prokoudine prokoudine [5c21ec] A bunch of new previously missing effects descr...
frei0r_vectorscope.xml 2011-01-07 prokoudine prokoudine [5c21ec] A bunch of new previously missing effects descr...
frei0r_vertigo.xml 2011-09-10 ttill ttill [c090fa] Add support for vertigo effect version 1.1.
frei0r_vignette.xml 2011-07-21 granjow granjow [aa4d89] Vignetting effect xml added
gain.xml 2009-08-29 j-b-m j-b-m [67cc51] update gain effect xml
gamma.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
grain.xml 2011-01-07 prokoudine prokoudine [5fec80] Tag should be equal to id, otherwise it just do...
greyscale.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
invert.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
ladspa_declipper.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
ladspa_equalizer.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
ladspa_equalizer_15.xml 2011-02-04 granjow granjow [5beab2] Updated German translation.
ladspa_limiter.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
ladspa_phaser.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
ladspa_pitch.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
ladspa_pitch_scale.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
ladspa_rate_scale.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
ladspa_reverb.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
ladspa_room_reverb.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
ladspa_vinyl.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
mirror.xml 2011-07-14 j-b-m j-b-m [cfe2fb] Required changes to make Kdenlive work with som...
mute.xml 2010-11-07 ttill ttill [d1e973] Update some effect GUIs (mostly parameter order...
normalise.xml 2010-10-19 ddennedy ddennedy [32a949] Add parameters to normalize audio effect.
obscure.xml 2011-08-02 ttill ttill [40d7f1] Keyframes in the obscure effect are currently n...
oldfilm.xml 2011-01-06 prokoudine prokoudine [d60b69] New descriptions use double instead of integer ...
pan_zoom.xml 2010-06-13 j-b-m j-b-m [43f0fb] keyframable geometry for pan_zoom effect
rotation.xml 2010-05-11 ttill ttill [249e7c] - Add ability to disable opacity in geometryval
rotation_keyframable.xml 2011-02-08 j-b-m j-b-m [4b8abf] Add keyframable offset to rotation effect (supp...
rotoscoping.xml 2011-07-14 j-b-m j-b-m [cfe2fb] Required changes to make Kdenlive work with som...
scratchlines.xml 2011-01-07 prokoudine prokoudine [5fec80] Tag should be equal to id, otherwise it just do...
sepia.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
sox_band.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
sox_bass.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
sox_echo.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
sox_flanger.xml 2011-07-14 j-b-m j-b-m [cfe2fb] Required changes to make Kdenlive work with som...
sox_gain.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
sox_phaser.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
sox_pitch.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
sox_reverb.xml 2010-09-03 ddennedy ddennedy [55b21d] Update Sox Reverb effect for parameter changes ...
sox_stretch.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
speed.xml 2010-03-28 xzhayon xzhayon [391da0] - Set the limit to 10000% (100 times faster).
swapchannels.xml 2010-08-16 ddennedy ddennedy [309955] Add options to "Mono to stereo" and add "Swap c...
tcolor.xml 2011-01-07 prokoudine prokoudine [3f09e3] Reverting simplekeyframe for tcolor. It doesn't...
threshold.xml 2009-03-04 j-b-m j-b-m [5b2eaf] copy KDE4 branch to triunk/kdenlive
vignette.xml 2010-11-07 ttill ttill [d1e973] Update some effect GUIs (mostly parameter order...
volume.xml 2009-04-20 kamikazow kamikazow [41c36e] Fixed Frensh spacing and a typo.
wave.xml 2011-03-13 ddennedy ddennedy [598099] Fix a bunch of effects XML and registration.

Read Me

================================
------------EFFECTS-------------
================================

==========
Kdenlive uses MLT for all video/audio effects/filters.
For filters that provide metadata the GUI can be generated automatically.
If the generated GUI is not sufficient a custom one can be build using a XML
file describing the effect and its parameters.
==========



==========
The basic structure of a XML filter description:
--------------------------------------------------------------------------------------
01 <!DOCTYPE kpartgui>
02 <effect tag="mlt_filter" id="mlt_filter_custom1">
03      <name>Filter name</name>
04      <description>Filter the image</description>
05      <author>Anon</author>
06      <parameter type="constant" name="amount" default="10" min="0" max="1000" factor="1000">
07              <name>Amount of filtering</name>
08      </parameter>
09      <parameter type="bool" name="enable" default="0">
10              <name>Enable</name>
11      </parameter>
15 </effect>
--------------------------------------------------------------------------------------

Line 1:
    - required to make strings used in the effect translatable
Line 2:
    - tag: MLT ("mlt_service") name of the effect
    - id: internal kdenlive id, can be anything, but must be unique for each effect
    - type: (default = "video") whether effect modifies video or audio (use "audio" then)
    - unique: (default = "0") this effect cannot be attached multiple times to one clip (speed, fades, ...)
    - version: (optional) minimum version of the effect required to be available (works only if the MLT filter provides the necessary metadata)
Line 3:
    - name of the effect that will appear to the user
Line 4:
    - Short description of the effect to be shown in the effect list
    - Additionally a <full> part can be added inside. It's content will be available in the effect stack (see frei0r_lightgraffiti.xml for an example):
        - supports HTML formatting (requires the use of CDATA)
Line 5:
    - name of the author(s) of the filter (not of the XML file ;))
The rest:
    - list of effect parameters:
        - tag "name": visible name of the parameter (depending on the GUI this parameter uses)
        - tag "comment": (optional) description of the parameter (support HTML formatting) (not yet supported by all widgets)
        - attribute "name": MLT filter parameter name
        - attribute "default": initial value, format depends on parameter type
        - attribute "type": widget (GUI) to use
            - "fixed":
                - sets a (MLT filter) parameter, but does not expose it to the user (no GUI)
            - "constant":
                - number
                - represented by a slider
                - additional parameter attributes:
                    - "factor": (optional) values coming from MLT will be multiplied with factor
                    - "offset": (optional) will be added to values coming from MLT after "factor" is applied
                    - "min": smallest value possible (after multiplying with "factor")
                    - "max": largest value possible (after multiplying with "factor")
                    - "suffix": (optional) displayed unit of the values
            - "double":
                - synonym for "constant"
            - "bool": 
                - true/false
                - represented by a checkbox
            - "list":
                - multiple choice
                - represented by a drop-down menu
                - additional parameter attribute:
                    - "paramlist": list of possible values separated by comma (no whitespaces!)
                - addtional tag:
                    - "paramlistdisplay": (optional) list of names to use for the values
            - "position":
                - time stored as frame number
                - represented by a slider
            - "color":
                - color value, similar to representation HTML ("#rrggbb" or "0xrrggbb")
                - represented by a button opening the KDE color dialog + a color picker button
            - "keyframe":
                - keyframable number
                - keyframes are opt-in (only one keyframe by default -> should be prefered over "constant" whenever possible)
                - works with MLT filters that utilize start/end values
                - same attributes as "constant"
                - additional attributes:
                    - "intimeline": (default = "0") parameter to preselect for editing in the timeline (only one parameter can have "1")
                    - "widget": (optional) GUI based on the standard keyframe GUI (possible values: "corners")
            - "simplekeyframe":
                - works with MLT filters that use mlt_geometry for keyframe support (includes all frei0r filters)
                - same attributes as "keyframe"
            - "geometry":
                - a rectangle: postion + dimension + additional value
                - works with MLT filters using mlt_geometry
                - the rect can be edited on the project monitor
                - additional attributes:
                    - "fixed": (default = "0") use to disable keyframe support
                    - "showrotation": (default = "0") use to enable support to 3 axis rotation
                    - "opacity": (default = "true") use to disable support of the opacity setting
            - "url":
                - url/path
                - represented by button to open "file open" dialog
            - "wipe":
                - special GUI for the wipe transition makes it possible to select a direction of a slide
            - "addedgeometry":
                - parameter linked to a "geometry" parameter
            - "curve":
                - cubic curve editor for the frei0r color curves filter (old version)
            - "bezier_spline":
                - cubic Bézier spline editor for the frei0r color curves filter (new version, might be reused for other filters)
            - "roto-spline":
                - GUI for the rotoscoping filter (spline on the monitor)
==========

==========
Effects can be blacklisted in kdenlive/data/blacklisted_effects.txt
All effects with a custom XML GUI need to be blacklisted.
==========

==========
Effects can be assigned to an effect category in kdenlive/data/kdenliveeffectscategory.rc.
==========

==========
Kdenlive parses the effect folder at each startup, so that if you have an XML file describing a new effect,
just copy it to your ~/.kde/share/apps/kdenlive/effects/ folder and restart Kdenlive to enable the new effect.
==========