Difference between revisions of "Kdenlive/Development"

Jump to: navigation, search
(Pre-requisites: Adding qml-module-qtquick-dialogs as it seems requiered for refactoring_timeline branch)
m (Fix minor typos)
Line 29: Line 29:
 
Downloading Kdenlive source code:
 
Downloading Kdenlive source code:
  
We are cloning the git repository for kdenlive into a local folder on your hard drive.  This step will create a new kdenlive folder in the current directory. In this example I cloned into ~/kdenlive/kdenlive_git.  Which creates ~/kdenlive/kdenlive_git/kdenlive
+
We are cloning the git repository for kdenlive into a local folder on your hard drive.  This step will create a new kdenlive folder in the current directory. In this example, I cloned into ~/kdenlive/kdenlive_git.  Which creates ~/kdenlive/kdenlive_git/kdenlive
  
 
<pre>
 
<pre>
Line 59: Line 59:
 
kdenlive
 
kdenlive
 
</pre>
 
</pre>
Some more detailed informations if you also want to compile MLT to get the by yourself can be found on our [[Kdenlive/Development/KF5|KF5 development page]].<br/>
+
Some more detailed information if you also want to compile MLT to get the by yourself can be found on our [[Kdenlive/Development/KF5|KF5 development page]].<br/>
You can also get some general infos 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].
+
You can also get some general info 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 ==
Line 71: Line 71:
  
 
=== Setting up QtCreator ===
 
=== 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.
+
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 an 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.
 
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.

Revision as of 14:35, 2 April 2018

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

Pre-requisites

Current development code (2018) requires Qt >= 5.7 and MLT >= 6.6.0. If your distro does not provide a recent MLT, you will need to compile it by yourself, see Kdenlive KF5 development page.

It is recommended to uninstall the official kdenlive package since our version will replace it:

sudo apt-get remove kdenlive kdenlive-data

You will need to install several Qt/KDE devel packages to successfully compile. On Ubuntu the following packages will pull all the necessary dependencies:

sudo apt-get install \
 libkf5archive-dev libkf5bookmarks-dev libkf5coreaddons-dev libkf5config-dev \
 libkf5configwidgets-dev libkf5dbusaddons-dev libkf5kio-dev libkf5widgetsaddons-dev \
 libkf5notifyconfig-dev libkf5newstuff-dev libkf5xmlgui-dev libkf5declarative-dev \
 libkf5notifications-dev libkf5guiaddons-dev libkf5textwidgets-dev libkf5iconthemes-dev \
 kdoctools-dev libkf5crash-dev libkf5filemetadata-dev extra-cmake-modules \
 libsm-dev cmake qtdeclarative5-dev libqt5svg5-dev kde-runtime kinit  kio \
 qml-module-qtquick-controls qml-module-qtquick-dialogs \
 libmlt-dev libmlt++-dev melt frei0r-plugins ffmpeg
Note: on slightly older Ubuntu (<= Xenial), the libkf5kio-dev package is called kio-dev

Getting the sources

Downloading Kdenlive source code:

We are cloning the git repository for kdenlive into a local folder on your hard drive. This step will create a new kdenlive folder in the current directory. In this example, I cloned into ~/kdenlive/kdenlive_git. Which creates ~/kdenlive/kdenlive_git/kdenlive

cd ~/kdenlive
mkdir kdenlive_git
cd kdenlive_git
git clone git://anongit.kde.org/kdenlive.git


The development branch is currently in 'refactoring_timeline'. So to get the latest code:

cd kdenlive
git checkout -b refactoring_timeline origin/refactoring_timeline

To avoid problems with plugins and libraries, it is easier to install Kdenlive in /usr:

cmake . -DKDE_INSTALL_USE_QT_SYS_PATHS=ON -DCMAKE_INSTALL_PREFIX=/usr

Then build and install:

 make -j5
 sudo make install

You can then start your compiled version by simple entering:

kdenlive

Some more detailed information if you also want to compile MLT to get the by yourself can be found on our KF5 development page.
You can also get some general info 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

Open KDevelop and go to Project > Open/Import project Then select the CMakeLists.txt file in the kdenlive source folder. You can now start hacking on Kdenlive!

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 an 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


Content is available under Creative Commons License SA 4.0 unless otherwise noted.