You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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.
28
+
*<http://www.ffmpeg.org/>**(Library)**
29
+
* This library is used to decode and encode video, audio, and image files.
30
+
It is also used to obtain information about media files,
31
+
such as frame rate, sample rate, aspect ratio, and other common attributes.
* 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
* This library is used to mix, resample, host plug-ins, and play audio.
40
+
It is based on the JUCE project,
41
+
an outstanding audio library used by many different applications.
35
42
36
43
#### Qt 5 (libqt5)
37
-
*http://www.qt.io/qt5/**(Library)**
38
-
* 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...
44
+
*<http://www.qt.io/qt5/>**(Library)**
45
+
* Qt5 is used to display video, store image data, composite images,
46
+
apply image effects, and many other utility functions,
47
+
such as file system manipulation, high resolution timers, etc.
39
48
40
49
#### ZeroMQ (libzmq)
41
-
*http://zeromq.org/**(Library)**
42
-
* This library is used to communicate between libopenshot and other applications (publisher / subscriber). Primarily used to send debug data from libopenshot.
50
+
*<http://zeromq.org/>**(Library)**
51
+
* This library is used to communicate between libopenshot and other applications (publisher / subscriber).
52
+
Primarily used to send debug data from libopenshot.
43
53
44
54
#### OpenMP (`-fopenmp`)
45
-
*http://openmp.org/wp/**(Compiler Flag)**
46
-
* 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.
55
+
*<http://openmp.org/wp/>**(Compiler Flag)**
56
+
* If your compiler supports this flag (GCC, Clang, and most other compilers),
57
+
it provides libopenshot with implementations of common parallel programming techniques
58
+
used to improve performance and take advantage of multi-core processors.
47
59
48
60
#### CMake (`cmake`)
49
-
*http://www.cmake.org/**(Executable)**
50
-
* This executable is used to automate the generation of Makefiles, check for dependencies, and is the backbone of libopenshot’s cross-platform build process.
61
+
*<http://www.cmake.org/>**(Executable)**
62
+
* This executable is used to automate the generation of Makefiles,
63
+
check for dependencies, and is the backbone of libopenshot’s cross-platform build process.
51
64
52
65
#### SWIG (`swig`)
53
-
*http://www.swig.org/**(Executable)**
54
-
* 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.
66
+
*<http://www.swig.org/>**(Executable)**
67
+
* This executable is used to generate the Python and Ruby bindings for libopenshot.
68
+
It is a powerful wrapper for C++ libraries, and supports many languages.
55
69
56
70
#### Python 3 (libpython)
57
-
*http://www.python.org/**(Executable and Library)**
58
-
* 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).
71
+
*<http://www.python.org/>**(Executable and Library)**
72
+
* This library is used by swig to create the Python (version 3+) bindings for libopenshot.
73
+
This is also the official language used by OpenShot Video Editor (a graphical interface to libopenshot).
* This executable is used to auto-generate the documentation used by libopenshot.
63
78
64
79
#### UnitTest++ (libunittest++)
65
-
*https://github.com/unittest-cpp/**(Library)**
66
-
* 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.
80
+
*<https://github.com/unittest-cpp/>**(Library)**
81
+
* This library is used to execute unit tests for libopenshot.
82
+
It contains many macros used to keep our unit testing code clean and easy-to-follow.
67
83
68
84
## Obtaining Source Code
69
85
70
-
The first step in installing libopenshot is to obtain the most recent source code. The source code is available on [GitHub](https://github.com/OpenShot/libopenshot). Use the following command to obtain the latest libopenshot source code.
86
+
The first step in installing libopenshot is to obtain the most recent source code.
87
+
The source code is available on [GitHub](https://github.com/OpenShot/libopenshot).
88
+
Use the following command to obtain the latest libopenshot source code.
The source code is divided up into the following folders.
80
98
81
99
#### `build/`
82
-
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).
100
+
This folder needs to be manually created,
101
+
and is used by cmake to store the build system control files and generated output
102
+
(such as compiled object files and the result of template-file processing)
103
+
as well as the final results of the build (library, tool, and test program binaries).
83
104
84
105
#### `cmake/`
85
106
This folder contains custom modules not included by default in cmake.
86
-
CMake find modules are used to discover dependency libraries on the system, and to incorporate their headers and object files.
107
+
CMake find modules are used to discover dependency libraries on the system,
108
+
and to incorporate their headers and object files.
87
109
CMake code modules are used to implement build features such as test coverage scanning.
88
110
89
111
#### `doc/`
90
112
This folder contains documentation and related files.
91
113
This includes logos and images required by the doxygen-generated API documentation.
92
114
93
-
#### `include/`
94
-
This folder contains all headers (*.h) used by libopenshot.
95
-
96
115
#### `src/`
97
-
This folder contains all source code (*.cpp) used by libopenshot.
116
+
This folder contains all source code (`*.cpp`) and headers (`*.h`) for libopenshot.
117
+
118
+
#### `bindings/`
119
+
This folder contains language bindings for the libopenshot API.
120
+
Current supported languages are Python and Ruby.
121
+
122
+
#### `examples/`
123
+
This folder contains various pieces of example code written in C++, Ruby, or Python.
124
+
It also holds the media files (data files) used in examples and unit tests.
98
125
99
126
#### `tests/`
100
127
This folder contains all unit test code.
101
128
Each test file (`<class>_Tests.cpp`) contains the tests for the named class.
102
-
We use UnitTest++ macros to keep the test code simple and manageable.
129
+
We use UnitTest++ macros to keep the test code uncomplicated and manageable.
103
130
104
131
#### `thirdparty/`
105
132
This folder contains code not written by the OpenShot team.
@@ -113,79 +140,90 @@ locates header files and libraries, and generates a build system in various form
113
140
We use CMake's Makefile generators to compile libopenshot and libopenshot-audio.
114
141
115
142
CMake uses an out-of-source build concept.
116
-
This means that the build system, all temporary files, and all generated products are kept separate from the source code.
143
+
This means that the build system,
144
+
along with all temporary/intermediate files and generated products output during the build,
145
+
is kept strictly separate from the source code.
117
146
This includes Makefiles, object files, and even the final binaries.
118
-
While it is possible to build in-tree, we highly recommend you use a `/build/` sub-folder to compile each library.
119
-
This prevents the build process from cluttering up the source
120
-
code.
121
-
These instructions have only been tested with the GNU compiler suite (including MSYS2/MinGW for Windows), and the Clang compiler (including AppleClang on MacOS).
147
+
The source code files and directories are never modified by the build system,
148
+
which makes it convenient and safe to re-run, reconfigure, or discard builds as needed.
149
+
While it is possible to build in-tree,
150
+
we highly recommend you use a `/build/` sub-folder to compile each library.
151
+
152
+
These instructions have only been tested with the following compiler stacks:
153
+
* The GNU compiler suite (including MSYS2/MinGW for Windows)
154
+
* The Clang compiler (including AppleClang on MacOS)
155
+
Other compilers, including MSVC, are entirely unsupported.
156
+
It may be possible to build libopenshot using other compiler stacks,
157
+
but most likely not without modifications to the build system which you would have to make yourself.
122
158
123
159
## CMake Flags (Optional)
124
-
There are many different build flags that can be passed to cmake to adjust how libopenshot is compiled. Some of these flags might be required when compiling on certain OSes, just depending on how your build environment is setup.
160
+
There are many different build flags that can be passed to cmake to adjust how libopenshot is compiled.
161
+
Some of these flags might be required when compiling on certain OSes,
0 commit comments