Kdenlive/Development: Difference between revisions

From KDE Community Wiki
Line 6: Line 6:


== Getting the sources ==
== Getting the sources ==
Please refer to the TechBase tutorial [https://techbase.kde.org/Development/Tutorials/Building_An_Existing_Application Building An Existing Application]. You may also be interested in the other [https://techbase.kde.org/Development/Tutorials tutorials on TechBase].
All informations necessary to compile the Qt5/KF5 version of can be found on our [[Kdenlive/Development/KF5|KF5 development page]].<br/>
You can also get some general infod on the TechBase tutorial [https://techbase.kde.org/Development/Tutorials/Building_An_Existing_Application Building An Existing Application]. You may also be interested in the other [https://techbase.kde.org/Development/Tutorials tutorials on TechBase].


== IDE Setup ==
== IDE Setup ==

Revision as of 20:23, 15 February 2015

This page should guide the developer to a build environment and provide a general “getting started”.

Porting Kdenlive to Qt5/KF5: Kdenlive development is now mostly moving towards the Qt5/KF5 version. You will find information on this page: Kdenlive/Development/KF5

Getting the sources

All informations necessary to compile the Qt5/KF5 version of can be found on our KF5 development page.
You can also get some general infod on the TechBase tutorial Building An Existing Application. You may also be interested in the other tutorials on TechBase.

IDE Setup

Pick your favourite!

Setting up KDevelop

  • adding kdenlive
  • adding mlt (references)

Setting up QtCreator

After checking out Kdenlive from git—when working on refactoring, you may want to clone two copies, one with the next branch and another one on the refactoring branch—, you can open the CMakeLists.txt in QtCreator, which will load the project if cmake succeeds. If you run/debug Kdenlive, make sure that kdenlive and not kdenlive_render is selected as active project.

If you let QtCreator restore the previous session (File > Session manager), it will remember the open documents. Environment variables (see below) can be set in Projects > Build Environment.

MLT documentation

Kdenlive uses MLT’s C++ API called mlt++. This API is not documented as it is simply a wrapper to C functions. For example, the documentation of Mlt::Consumer::position() can be found in framework/mlt_consumer.c:mlt_consumer_position(). The actual C function name is usually a combination of the class name and the function name, but can also be found by consulting mlt++/MltConsumer.cpp:position().

Environment variables

If kdenlive crashes on startup (e.g. in QtCreator) and shows a message like:

   kdenlive(24309) KXMLGUIClient::setXMLFile: cannot find .rc file "kdenliveui.rc" for component "kdenlive"

then you have to ensure the .rc file is found. If CMake is configured to install Kdenlive to /usr/local, the .rc file is put there, but when kdenlive is then run from the build directory, the KXMLGUIClient will not search there. Solution: Set the environment variable KDEDIRS to $KDEDIRS:/usr/local.

You can get more information about the paths that are checked by running kdenlive like this:

   strace build/src/kdenlive 2>&1 | grep kdenliveui.rc


Developer Mailing List

The kdenlive developer mailing list archives can be found here

A searchable archive of the kdenlive developer mailing list can be found here

Information on how to subscribe can be found here