Kdenlive/Development: Difference between revisions

From KDE Community Wiki
(Removing mention for Ubuntu version <= Xenial (too old))
(29 intermediate revisions by 4 users not shown)
Line 1: Line 1:
This page should guide the developer to a build environment and provide a general “getting started”.
Kdenlive is rather easy to build (at least on supported platforms), and this page should show you the simple steps to get there. If you encounter any problem during the process or spot any information that should be added/updated, please don't hesitate to reach out to the [[#Developer_Mailing_List| Developper's mailing list]].


== Pre-requisites and Supported Platforms ==
== Pre-requisites and Supported Platforms ==


Kdenlive is primarely developped on GNU/Linux. Supported distributions are :
Kdenlive is primarely developped on GNU/Linux. There is an effort to  [[Kdenlive/Development/WindowsBuild|build Kdenlive on Microsoft Windows]], but it's still a work in progress.


* Ubuntu 18.04 LTS Bionic Beaver
Supported distributions are :
 
* Ubuntu 18.10 Cosmic Cuttlefish and derivatives
* Arch Linux
* Arch Linux


Current development code (2018) requires '''Qt >= 5.7''' , KF5, and '''MLT >= 6.6.0'''., which are provided as package by the supported platforms.
Current development code (2018) requires '''Qt >= 5.7''' , KF5 >= 5.50 --  which are provided as package by the supported platforms --.
but also  '''MLT >= 6.10.0''', which is not available for Ubuntu 18.04 in default repositories:  you'll have to get it from [https://launchpad.net/~kdenlive/+archive/ubuntu/mlt Kdenlive's ppa]:
 
<pre>
sudo add-apt-repository ppa:kdenlive/mlt
sudo apt-get update
</pre>


If your distro does not provide a recent MLT, you will need to compile it by yourself, see [[Kdenlive/Development/KF5|Kdenlive KF5 development page]].
It is recommended to uninstall the official kdenlive package since our version will replace it.  
It is recommended to uninstall the official kdenlive package since our version will replace it.  


Line 34: Line 40:
sudo apt install libkf5archive-dev libkf5bookmarks-dev libkf5coreaddons-dev libkf5config-dev \
sudo apt install libkf5archive-dev libkf5bookmarks-dev libkf5coreaddons-dev libkf5config-dev \
libkf5configwidgets-dev libkf5dbusaddons-dev libkf5kio-dev libkf5widgetsaddons-dev \
libkf5configwidgets-dev libkf5dbusaddons-dev libkf5kio-dev libkf5widgetsaddons-dev \
libkf5notifyconfig-dev libkf5newstuff-dev libkf5xmlgui-dev libkf5declarative-dev \  
libkf5notifyconfig-dev libkf5newstuff-dev libkf5xmlgui-dev libkf5declarative-dev \
libkf5notifications-dev libkf5guiaddons-dev libkf5textwidgets-dev \
libkf5notifications-dev libkf5guiaddons-dev libkf5textwidgets-dev libkf5purpose-dev \
libkf5iconthemes-dev kdoctools-dev libkf5crash-dev libkf5filemetadata-dev  kio \
libkf5iconthemes-dev kdoctools-dev libkf5crash-dev libkf5filemetadata-dev  kio \
kinit kde-runtime qtdeclarative5-dev libqt5svg5-dev qml-module-qtquick-controls
kinit kde-runtime qtdeclarative5-dev libqt5svg5-dev qml-module-qtquick-controls \
qtmultimedia5-dev
</pre>
</pre>
<div style="background:#F5F5DC">Note: on slightly older Ubuntu (<= Xenial), the libkf5kio-dev package is called kio-dev</div>


=== Multimedia stack ===
=== Multimedia stack ===


You will also need MLT >= 6.6.0, ffmpeg and frei0r plug-ins
If your distribution packages a recent enough version of  MLT (>= 6.10.0), you can install it directly along ffmpeg and frei0r plug-ins. Otherwise, you'll have to add our ppa or compile it yourself (see above)


<pre>
<pre>
Line 63: Line 68:


<pre>
<pre>
git clone git://anongit.kde.org/kdenlive.git
git clone git@invent.kde.org:kde/kdenlive.git
</pre>
</pre>


=== Selecting the  branch ===
=== Selecting the  branch ===


The development branch is currently in 'refactoring_timeline'. So to get the latest code:
/!\ More guidance about which branch to choose should be inserted here...
 
<pre>
cd kdenlive
git checkout master
</pre>
 
or
 
<pre>
<pre>
cd kdenlive
cd kdenlive
git checkout refactoring_timeline
git checkout Applications/19.08
</pre>
</pre>


Line 85: Line 98:


<pre>
<pre>
cmake .. -DKDE_INSTALL_USE_QT_SYS_PATHS=ON -DCMAKE_INSTALL_PREFIX=/usr
cmake .. -DKDE_INSTALL_USE_QT_SYS_PATHS=ON -DCMAKE_INSTALL_PREFIX=/usr -DRELEASE_BUILD=OFF
</pre>
 
Alternately you can build it with debug flags (advanced users only ;-)  and you need to have clang installed ) :
 
<pre>
cmake .. -DKDE_INSTALL_USE_QT_SYS_PATHS=ON \
-DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug \
-DCMAKE_CXX_COMPILER=/usr/bin/clang++ \
-DECM_ENABLE_SANITIZERS='address' \
-DBUILD_TESTING=ON -DBUILD_FUZZING=ON -DBUILD_COVERAGE=OFF \
-DRELEASE_BUILD=OFF
</pre>
</pre>


Line 103: Line 127:
Then build and install:
Then build and install:
<pre>
<pre>
make -j5
make -j5
sudo make install
sudo make install
</pre>
</pre>


Line 111: Line 135:
kdenlive
kdenlive
</pre>
</pre>
If you have compiled it in debug mode, you may encounter errors like
<pre>
SUMMARY: AddressSanitizer: new-delete-type-mismatch (/usr/bin/kdenlive+0x643020)
==6982==HINT: if you don't care about these errors you may set ASAN_OPTIONS=new_delete_type_mismatch=0
==6982==ABORTING
</pre>
As the hint says, the you can solve this with
<pre>
export ASAN_OPTIONS=new_delete_type_mismatch=0
</pre>
== Next Steps ==
Now that you've got a working dev environment, you can head to [[https://phabricator.kde.org/project/profile/40/ Kdenlive's page on KDE's phabricator]]


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].
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].

Revision as of 13:28, 31 July 2019

Kdenlive is rather easy to build (at least on supported platforms), and this page should show you the simple steps to get there. If you encounter any problem during the process or spot any information that should be added/updated, please don't hesitate to reach out to the Developper's mailing list.

Pre-requisites and Supported Platforms

Kdenlive is primarely developped on GNU/Linux. There is an effort to build Kdenlive on Microsoft Windows, but it's still a work in progress.

Supported distributions are :

  • Ubuntu 18.10 Cosmic Cuttlefish and derivatives
  • Arch Linux

Current development code (2018) requires Qt >= 5.7 , KF5 >= 5.50 -- which are provided as package by the supported platforms --. but also MLT >= 6.10.0, which is not available for Ubuntu 18.04 in default repositories: you'll have to get it from Kdenlive's ppa:

sudo add-apt-repository ppa:kdenlive/mlt
sudo apt-get update

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

sudo apt-get remove kdenlive kdenlive-data

Installing dependencies

Development tooling

You will need classical development tools (like git, gcc ...) but also cmake :

sudo apt install build-essential git cmake extra-cmake-modules libsm-dev

KDE Frameworks 5, based on Qt5

On Ubuntu the following packages will pull all the necessary dependencies:

sudo apt 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 libkf5purpose-dev \
libkf5iconthemes-dev kdoctools-dev libkf5crash-dev libkf5filemetadata-dev  kio \
kinit kde-runtime qtdeclarative5-dev libqt5svg5-dev qml-module-qtquick-controls \
qtmultimedia5-dev

Multimedia stack

If your distribution packages a recent enough version of MLT (>= 6.10.0), you can install it directly along ffmpeg and frei0r plug-ins. Otherwise, you'll have to add our ppa or compile it yourself (see above)

sudo apt install libmlt++-dev libmlt-dev melt frei0r-plugins ffmpeg

Dependencies for localisation

To have kdenlive localised in a different language than EN, you should install the additional dependencies that are required by the specific script to fetch the translations:

sudo apt install ruby subversion gnupg2 gettext

Getting the source code

Cloning the git repo

The easiest way to get Kdenlive source code is to clone the git repo:

git clone [email protected]:kde/kdenlive.git

Selecting the branch

/!\ More guidance about which branch to choose should be inserted here...

cd kdenlive
git checkout master

or

cd kdenlive
git checkout Applications/19.08

Building Kdenlive

Create a directory for the build :

mkdir build
cd build

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 -DRELEASE_BUILD=OFF

Alternately you can build it with debug flags (advanced users only ;-) and you need to have clang installed ) :

cmake .. -DKDE_INSTALL_USE_QT_SYS_PATHS=ON \
-DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug \
-DCMAKE_CXX_COMPILER=/usr/bin/clang++ \
-DECM_ENABLE_SANITIZERS='address' \
-DBUILD_TESTING=ON -DBUILD_FUZZING=ON -DBUILD_COVERAGE=OFF \
-DRELEASE_BUILD=OFF

To fetch the translations of the application :

make fetch-translations

This should create a po sub-directory in your build directory. You have then to create a symbolic link to this po sub directory :

cd ..
ln -s build/po/ po
cd build/

Then build and install:

make -j5
sudo make install

You can then start your compiled version by simple entering:

kdenlive

If you have compiled it in debug mode, you may encounter errors like

SUMMARY: AddressSanitizer: new-delete-type-mismatch (/usr/bin/kdenlive+0x643020) 
==6982==HINT: if you don't care about these errors you may set ASAN_OPTIONS=new_delete_type_mismatch=0
==6982==ABORTING

As the hint says, the you can solve this with

export ASAN_OPTIONS=new_delete_type_mismatch=0

Next Steps

Now that you've got a working dev environment, you can head to [Kdenlive's page on KDE's phabricator]

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