2 © OpenShot Studios, LLC
4 SPDX-License-Identifier: LGPL-3.0-or-later
7 # Building libopenshot for MacOS
11 The best way to get started with libopenshot, is to learn about our build system, obtain all the source code,
12 install a development IDE and tools, and better understand our dependencies. So, please read through the
13 following sections, and follow the instructions. And keep in mind, that your computer is likely different
14 than the one used when writing these instructions. Your file paths and versions of applications might be
15 slightly different, so keep an eye out for subtle file path differences in the commands you type.
19 CMake is the backbone of our build system. It is a cross-platform build system, which checks for
20 dependencies, locates header files and libraries, generates makefiles, and supports the cross-platform
21 compiling of libopenshot and libopenshot-audio. CMake uses an out-of-source build concept, where
22 all temporary build files, such as makefiles, object files, and even the final binaries, are created
23 outside of the source code folder, inside a /build/ sub-folder. This prevents the build process
24 from cluttering up the source code. These instructions have only been tested with the GNU compiler
25 (including MSYS2/MinGW for Windows).
29 The following libraries are required to build libopenshot. Instructions on how to install these
30 dependencies vary for each operating system. Libraries and Executables have been labeled in the
31 list below to help distinguish between them.
33 ### FFmpeg (libavformat, libavcodec, libavutil, libavdevice, libavresample, libswscale)
34 * http://www.ffmpeg.org/ `(Library)`
35 * 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.
37 ### ImageMagick++ (libMagick++, libMagickWand, libMagickCore)
38 * http://www.imagemagick.org/script/magick++.php `(Library)`
39 * This library is **optional**, and used to decode and encode images.
41 ### OpenShot Audio Library (libopenshot-audio)
42 * https://github.com/OpenShot/libopenshot-audio/ `(Library)`
43 * 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
46 * http://www.qt.io/qt5/ `(Library)`
47 * 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...
50 * http://www.cmake.org/ `(Executable)`
51 * This executable is used to automate the generation of Makefiles, check for dependencies, and is the backbone of libopenshot’s cross-platform build process.
54 * http://www.swig.org/ `(Executable)`
55 * 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.
57 ### Python 3 (libpython)
58 * http://www.python.org/ `(Executable and Library)`
59 * 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).
62 * http://www.stack.nl/~dimitri/doxygen/ `(Executable)`
63 * This executable is used to auto-generate the documentation used by libopenshot.
65 ### UnitTest++ (libunittest++)
66 * https://github.com/unittest-cpp/ `(Library)`
67 * 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.
70 * http://zeromq.org/ `(Library)`
71 * This library is used to communicate between libopenshot and other applications (publisher / subscriber). Primarily used to send debug data from libopenshot.
74 * http://openmp.org/wp/ `(Compiler Flag)`
75 * 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.
77 ## CMake Flags (Optional)
78 There are many different build flags that can be passed to cmake to adjust how libopenshot is compiled.
79 Some of these flags might be required when compiling on certain OSes, just depending on how your build
80 environment is setup. To add a build flag, follow this general syntax:
81 `cmake -DMAGICKCORE_HDRI_ENABLE=1 -DENABLE_TESTS=1 ../`
83 * MAGICKCORE_HDRI_ENABLE (default 0)
84 * MAGICKCORE_QUANTUM_DEPTH (default 0)
85 * OPENSHOT_IMAGEMAGICK_COMPATIBILITY (default 0)
86 * DISABLE_TESTS (default 0)
87 * CMAKE_PREFIX_PATH (`/location/to/missing/library/`)
88 * PYTHON_INCLUDE_DIR (`/location/to/python/include/`)
89 * PYTHON_LIBRARY (`/location/to/python/lib.a`)
90 * PYTHON_FRAMEWORKS (`/usr/local/Cellar/python3/3.3.2/Frameworks/Python.framework/`)
91 * CMAKE_CXX_COMPILER (`/location/to/mingw/g++`)
92 * CMAKE_C_COMPILER (`/location/to/mingw/gcc`)
94 ## Obtaining Source Code
96 The first step in installing libopenshot is to obtain the most recent source code. The source code
97 is available on [GitHub](https://github.com/OpenShot/libopenshot). Use the following command to
98 obtain the latest libopenshot source code.
101 git clone https://github.com/OpenShot/libopenshot.git
102 git clone https://github.com/OpenShot/libopenshot-audio.git
105 ## Folder Structure (libopenshot)
107 The source code is divided up into the following folders.
110 * 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).
113 * 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.
116 * This folder contains documentation and related files, such as logos and images required by the doxygen auto-generated documentation.
119 * This folder contains all headers (*.h) used by libopenshot.
122 * This folder contains all source code (*.cpp) used by libopenshot.
125 * 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.
128 * This folder contains code not written by the OpenShot team. For example, jsoncpp, an open-source JSON parser.
130 ## Install Dependencies
132 In order to actually compile libopenshot and libopenshot-audio, we need to install some dependencies on
133 your system. Most packages needed by libopenshot can be installed easily with Homebrew. However, first
134 install Xcode with the following options ("UNIX Development", "System Tools", "Command Line Tools", or
135 "Command Line Support"). Be sure to refresh your list of Homebrew packages with the “brew update” command.
137 **NOTE:** Homebrew seems to work much better for most users (compared to MacPorts), so I am going to
138 focus on brew for this guide.
140 Install the following packages using the Homebrew package installer (http://brew.sh/). Pay close attention
141 to any warnings or errors during these brew installs. NOTE: You might have some conflicting libraries in
142 your /usr/local/ folders, so follow the directions from brew if these are detected.
145 brew install gcc48 --enable-all-languages
150 brew install unittest-cpp --cc=gcc-4.8. You must specify the c++ compiler with the --cc flag to be 4.7 or 4.8.
157 ## Mac Build Instructions (libopenshot-audio)
158 Since libopenshot-audio is not available in a Homebrew or MacPorts package, we need to go through a
159 few additional steps to manually build and install it. Launch a terminal and enter:
162 cd [libopenshot-audio repo folder]
165 cmake -d -G "Unix Makefiles" -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_C_COMPILER=clang ../ (CLang must be used due to GNU incompatible Objective-C code in some of the Apple frameworks)
168 ./src/openshot-audio-test-sound (This should play a test sound)
171 ## Mac Build Instructions (libopenshot)
172 Run the following commands to build libopenshot:
175 $ cd [libopenshot repo folder]
178 $ cmake -G "Unix Makefiles" -DCMAKE_CXX_COMPILER=/usr/local/opt/gcc48/bin/g++-4.8 -DCMAKE_C_COMPILER=/usr/local/opt/gcc48/bin/gcc-4.8 -DCMAKE_PREFIX_PATH=/usr/local/Cellar/qt5/5.4.2/ -DPYTHON_INCLUDE_DIR=/usr/local/Cellar/python3/3.3.2/Frameworks/Python.framework/Versions/3.3/include/python3.3m/ -DPYTHON_LIBRARY=/usr/local/Cellar/python3/3.3.2/Frameworks/Python.framework/Versions/3.3/lib/libpython3.3.dylib -DPython_FRAMEWORKS=/usr/local/Cellar/python3/3.3.2/Frameworks/Python.framework/ ../ -D"CMAKE_BUILD_TYPE:STRING=Debug"
181 The extra arguments on the cmake command make sure the compiler will be gcc4.8 and that cmake
182 knows where to look for the Qt header files and Python library. Double check these file paths,
183 as yours will likely be different.
189 If you are missing any dependencies for libopenshot, you will receive error messages at this point.
190 Just install the missing dependencies, and run the above commands again. Repeat until no error
191 messages are displayed and the build process completes.
193 Also, if you are having trouble building, please see the CMake Flags section above, as it might
194 provide a solution for finding a missing folder path, missing Python 3 library, etc...
196 To run all unit tests (and verify everything is working correctly), launch a terminal, and enter:
202 To auto-generate the documentation for libopenshot, launch a terminal, and enter:
208 This will use doxygen to generate a folder of HTML files, with all classes and methods documented.
209 The folder is located at build/doc/html/. Once libopenshot has been successfully built, we need
210 to install it (i.e. copy it to the correct folder, so other libraries can find it).
216 This should 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:
225 If no errors are displayed, you have successfully compiled and installed libopenshot on your
226 system. 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!