OpenShot Library | libopenshot  0.2.6
/build/libopenshot-qajDji/libopenshot-0.2.6+dfsg2+1045+202108251946+daily~ubuntu18.04.1/doc/INSTALL-LINUX.md
Go to the documentation of this file.
1 # Building libopenshot for Linux
2 
3 ## Getting Started
4 
5 The best way to get started with libopenshot, is to learn about our build system, obtain all the source code,
6 install a development IDE and tools, and better understand our dependencies. So, please read through the
7 following sections, and follow the instructions. And keep in mind, that your computer is likely different
8 than the one used when writing these instructions. Your file paths and versions of applications might be
9 slightly different, so keep an eye out for subtle file path differences in the commands you type.
10 
11 ## Build Tools
12 
13 CMake is the backbone of our build system. It is a cross-platform build system, which checks for
14 dependencies, locates header files and libraries, generates makefiles, and supports the cross-platform
15 compiling of libopenshot and libopenshot-audio. CMake uses an out-of-source build concept, where
16 all temporary build files, such as makefiles, object files, and even the final binaries, are created
17 outside of the source code folder, inside a /build/ sub-folder. This prevents the build process
18 from cluttering up the source code. These instructions have only been tested with the GNU compiler
19 (including MSYS2/MinGW for Windows).
20 
21 ## Dependencies
22 
23 The following libraries are required to build libopenshot. Instructions on how to install these
24 dependencies vary for each operating system. Libraries and Executables have been labeled in the
25 list below to help distinguish between them.
26 
27 ### FFmpeg (libavformat, libavcodec, libavutil, libavdevice, libavresample, libswscale)
28  * http://www.ffmpeg.org/ `(Library)`
29  * This library is used to decode and encode video, audio, and image files. It is also used to obtain information about media files, such as frame rate, sample rate, aspect ratio, and other common attributes.
30 
31 ### ImageMagick++ (libMagick++, libMagickWand, libMagickCore)
32  * http://www.imagemagick.org/script/magick++.php `(Library)`
33  * This library is **optional**, and used to decode and encode images.
34 
35 ### OpenShot Audio Library (libopenshot-audio)
36  * https://github.com/OpenShot/libopenshot-audio/ `(Library)`
37  * This library is used to mix, resample, host plug-ins, and play audio. It is based on the JUCE project, which is an outstanding audio library used by many different applications
38 
39 ### Qt 5 (libqt5)
40  * http://www.qt.io/qt5/ `(Library)`
41  * Qt5 is used to display video, store image data, composite images, apply image effects, and many other utility functions, such as file system manipulation, high resolution timers, etc...
42 
43 ### CMake (cmake)
44  * http://www.cmake.org/ `(Executable)`
45  * This executable is used to automate the generation of Makefiles, check for dependencies, and is the backbone of libopenshot’s cross-platform build process.
46 
47 ### SWIG (swig)
48  * http://www.swig.org/ `(Executable)`
49  * This executable is used to generate the Python and Ruby bindings for libopenshot. It is a simple and powerful wrapper for C++ libraries, and supports many languages.
50 
51 ### Python 3 (libpython)
52  * http://www.python.org/ `(Executable and Library)`
53  * This library is used by swig to create the Python (version 3+) bindings for libopenshot. This is also the official language used by OpenShot Video Editor (a graphical interface to libopenshot).
54 
55 ### Doxygen (doxygen)
56  * http://www.stack.nl/~dimitri/doxygen/ `(Executable)`
57  * This executable is used to auto-generate the documentation used by libopenshot.
58 
59 ### UnitTest++ (libunittest++)
60  * https://github.com/unittest-cpp/ `(Library)`
61  * This library is used to execute unit tests for libopenshot. It contains many macros used to keep our unit testing code very clean and simple.
62 
63 ### ZeroMQ (libzmq)
64  * http://zeromq.org/ `(Library)`
65  * This library is used to communicate between libopenshot and other applications (publisher / subscriber). Primarily used to send debug data from libopenshot.
66 
67 ### OpenMP (-fopenmp)
68  * http://openmp.org/wp/ `(Compiler Flag)`
69  * If your compiler supports this flag (GCC, Clang, and most other compilers), it provides libopenshot with easy methods of using parallel programming techniques to improve performance and take advantage of multi-core processors.
70 
71 
72 ## CMake Flags (Optional)
73 There are many different build flags that can be passed to cmake to adjust how libopenshot is
74 compiled. Some of these flags might be required when compiling on certain OSes, just depending
75 on how your build environment is setup. To add a build flag, follow this general syntax:
76 `cmake -DMAGICKCORE_HDRI_ENABLE=1 -DENABLE_TESTS=1 ../`
77 
78 * MAGICKCORE_HDRI_ENABLE (default 0)
79 * MAGICKCORE_QUANTUM_DEPTH (default 0)
80 * OPENSHOT_IMAGEMAGICK_COMPATIBILITY (default 0)
81 * DISABLE_TESTS (default 0)
82 * CMAKE_PREFIX_PATH (`/location/to/missing/library/`)
83 * PYTHON_INCLUDE_DIR (`/location/to/python/include/`)
84 * PYTHON_LIBRARY (`/location/to/python/lib.a`)
85 * PYTHON_FRAMEWORKS (`/usr/local/Cellar/python3/3.3.2/Frameworks/Python.framework/`)
86 * CMAKE_CXX_COMPILER (`/location/to/mingw/g++`)
87 * CMAKE_C_COMPILER (`/location/to/mingw/gcc`)
88 
89 ## Obtaining Source Code
90 
91 The first step in installing libopenshot is to obtain the most recent source code. The source code is
92 available on [GitHub](https://github.com/OpenShot/libopenshot). Use the following command
93 to obtain the latest libopenshot source code.
94 
95 ```
96 git clone https://github.com/OpenShot/libopenshot.git
97 git clone https://github.com/OpenShot/libopenshot-audio.git
98 ```
99 
100 ## Folder Structure (libopenshot)
101 
102 The source code is divided up into the following folders.
103 
104 ### build/
105  * This folder needs to be manually created, and is used by cmake to store the temporary build files, such as makefiles, as well as the final binaries (library and test executables).
106 
107 ### cmake/
108  * This folder contains custom modules not included by default in cmake, used to find dependency libraries and headers and determine if these libraries are installed.
109 
110 ### doc/
111  * This folder contains documentation and related files, such as logos and images required by the doxygen auto-generated documentation.
112 
113 ### include/
114  * This folder contains all headers (*.h) used by libopenshot.
115 
116 ### src/
117  * This folder contains all source code (*.cpp) used by libopenshot.
118 
119 ### tests/
120  * This folder contains all unit test code. Each class has it’s own test file (*.cpp), and uses UnitTest++ macros to keep the test code simple and manageable.
121 
122 ### thirdparty/
123  * This folder contains code not written by the OpenShot team. For example, jsoncpp, an open-source JSON parser.
124 
125 ## Install Dependencies
126 
127 In order to actually compile libopenshot, we need to install some dependencies on your system. The easiest
128 way to accomplish this is with our Daily PPA. A PPA is an unofficial Ubuntu repository, which has our
129 software packages available to download and install.
130 
131 ```
132  sudo add-apt-repository ppa:openshot.developers/libopenshot-daily
133  sudo apt-get update
134  sudo apt-get install openshot-qt \
135  cmake \
136  libx11-dev \
137  libasound2-dev \
138  libavcodec-dev \
139  libavdevice-dev \
140  libavfilter-dev \
141  libavformat-dev \
142  libavresample-dev \
143  libavutil-dev \
144  libfdk-aac-dev \
145  libfreetype6-dev \
146  libjsoncpp-dev \
147  libmagick++-dev \
148  libopenshot-audio-dev \
149  libswscale-dev \
150  libunittest++-dev \
151  libxcursor-dev \
152  libxinerama-dev \
153  libxrandr-dev \
154  libzmq3-dev \
155  pkg-config \
156  python3-dev \
157  qtbase5-dev \
158  qtmultimedia5-dev \
159  swig
160 ```
161 
162 ## Linux Build Instructions (libopenshot-audio)
163 To compile libopenshot-audio, we need to go through a few additional steps to manually build and
164 install it. Launch a terminal and enter:
165 
166 ```
167 cd [libopenshot-audio repo folder]
168 mkdir build
169 cd build
170 cmake ../
171 make
172 make install
173 ./src/openshot-audio-test-sound (This should play a test sound)
174 ```
175 
176 ## Linux Build Instructions (libopenshot)
177 Run the following commands to compile libopenshot:
178 
179 ```
180 cd [libopenshot repo directory]
181 mkdir -p build
182 cd build
183 cmake ../
184 make
185 ```
186 
187 If you are missing any dependencies for libopenshot, you might receive error messages at this point.
188 Just install the missing packages (usually with a -dev suffix), and run the above commands again.
189 Repeat until no error messages are displayed, and the build process completes. Also, if you manually
190 install Qt 5, you might need to specify the location for cmake:
191 
192 ```
193 cmake -DCMAKE_PREFIX_PATH=/qt5_path/qt5/5.2.0/ ../
194 ```
195 
196 To run all unit tests (and verify everything is working correctly), launch a terminal, and enter:
197 
198 ```
199 make test
200 ```
201 
202 To auto-generate documentation for libopenshot, launch a terminal, and enter:
203 
204 ```
205 make doc
206 ```
207 
208 This will use doxygen to generate a folder of HTML files, with all classes and methods documented. The
209 folder is located at **build/doc/html/**. Once libopenshot has been successfully built, we need to
210 install it (i.e. copy it to the correct folder, so other libraries can find it).
211 
212 ```
213 make install
214 ```
215 
216 This will copy the binary files to /usr/local/lib/, and the header files to /usr/local/include/openshot/...
217 This is where other projects will look for the libopenshot files when building. Python 3 bindings are
218 also installed at this point. let's verify the python bindings work:
219 
220 ```
221 python3
222 >>> import openshot
223 ```
224 
225 If no errors are displayed, you have successfully compiled and installed libopenshot on your system.
226 Congratulations and be sure to read our wiki on [Becoming an OpenShot Developer](https://github.com/OpenShot/openshot-qt/wiki/Become-a-Developer)!
227 Welcome to the OpenShot developer community! We look forward to meeting you!