Tree [04e5ca] 0.7.0 / effects /
 History

HTTPS access


File Date Author Commit
 CMakeLists.txt 2008-10-28 j-b-m j-b-m [dfe42e] Add xml file for frei0r.distort0r effect to set...
 README 2008-02-17 j-b-m j-b-m [acee19] Add effect files
 automask.xml 2008-10-14 j-b-m j-b-m [312496] Fix automask effect crash
 boxblur.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 brightness.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 charcoal.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 chroma.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 chroma_hold.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 fadein.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 fadeout.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 freeze.xml 2008-11-05 j-b-m j-b-m [ca3969] Update xml for the new MLT freeze effect
 frei0r_distort0r.xml 2008-10-28 j-b-m j-b-m [dfe42e] Add xml file for frei0r.distort0r effect to set...
 frei0r_squareblur.xml 2008-10-22 j-b-m j-b-m [eac163] New file "blacklisted_effects.txt" to hide some...
 gamma.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 greyscale.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 invert.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 ladspa_declipper.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 ladspa_equalizer.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 ladspa_limiter.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 ladspa_phaser.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 ladspa_pitch.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 ladspa_pitch_scale.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 ladspa_rate_scale.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 ladspa_reverb.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 ladspa_room_reverb.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 ladspa_vinyl.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 mirror.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 mute.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 normalise.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 obscure.xml 2008-10-25 j-b-m j-b-m [2e0104] Use geometry widget to set obscure parameters (...
 rotation.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 sepia.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 sox_echo.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 sox_flanger.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 sox_pitch.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 sox_reverb.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 sox_vibro.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 speed.xml 2008-02-17 j-b-m j-b-m [acee19] Add effect files
 threshold.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 volume.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml
 wave.xml 2008-08-26 j-b-m j-b-m [01ea0f] Fix effects xml

Read Me

Effects 

Kdenlive uses MLT for all video/audio effects. Effects in Kdenlive are now built using 
xml files describing the effect and its parameters.

Here is a sample effect file:

--------------------------------------------------------------------------------------

1  <!DOCTYPE kpartgui>
2  <effect tag="motion_est">
3	<name>Auto Mask</name>
4	<properties id="autotrack_rectangle" tag="autotrack_rectangle" />
5	<parameter type="geometry" name="geometry" default="100,100:100x100">
6		<name>Geometry</name>
7	</parameter>
8	<parameter type="bool" name="debug" default="1">
9		<name>Debug</name>
10	</parameter>
11	<parameter type="bool" name="obscure" default="0">
12		<name>Obscure</name>
13	</parameter>
14 </effect>

--------------------------------------------------------------------------------------


Line 1 is required to have the effect and parameter names added to the translation files
In line 2, the "tag" is the name of the mlt filter that has to be found in the file 
/usr/share/mlt/modules/filters.dat for the effect to appear in Kdenlive
Line 3 is the name of the effect that will appear to the user
Line 4 holds several effect parameters:
	id is an internal kdenlive id, can be anything, but must be unique for each effect
	tag is the "mlt_service" name of the effect
	type defines if the effect is "audio" or "video". If omitted, effect is considered as video

Then, you have the parameter definitions.
The parameter entry has the following attributes:
	type is used by Kdenlive to build the UI for this effect.
		allowed types are: 
		- constant = a number, represented by a slider
		- bool = boolean value, represented as a checkbox
		- color = a color value, represented by a selectable color button
		- list = a combobox listing different strings
		- geometry = 4 different sliders for x, y, width and height values that will end up as x,y:wxh
		- position = a frame number that can be obtained from current cursor position
		- double = a number with keyframes
		- complex = only used in obscure effect, has x, y, width, height and pixellation values

		The integer values can have max, min and default values defined, see effect files in this folder for more examples
	the "name" parameter is the name that will be passed to MLT

The "name" tag gives the parameter name as it will appear to the user

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

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:

JavaScript is required for this form.





No, thanks