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
Also include the documentation MarkDown pages in the Doxygen docs.
These will show up as Related Pages in the interface.
* The formatting of `INSTALL-*.md` had to be changed some:
- Doxygen doesn't support headings in bulleted lists (lines starting
with `* ###`) -- I'm not even sure that's legal markdown. They were
changed to just level 3 headings (lines starting with `###`).
- ALL Windows paths in `INSTALL-WINDOWS.md` were wrapped in backticks,
to prevent Doxygen parsing them as markup commands.
- Level 1 headings were added to the top of the three install docs,
giving them the title "Building libopenshot for ___(OS)___".
Otherwise all three pages were titled "Getting Started".
* Separately, the table at the top of `HW-ACCEL.md` does not
translate well to Doxygen. It will need further polishing. But the
docs are all quite readable now.
* 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.
* 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
36
38
37
-
*### Qt 5 (libqt5)
39
+
### Qt 5 (libqt5)
38
40
*http://www.qt.io/qt5/`(Library)`
39
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...
40
42
41
-
*### CMake (cmake)
43
+
### CMake (cmake)
42
44
*http://www.cmake.org/`(Executable)`
43
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.
44
46
45
-
*### SWIG (swig)
47
+
### SWIG (swig)
46
48
*http://www.swig.org/`(Executable)`
47
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.
48
50
49
-
*### Python 3 (libpython)
51
+
### Python 3 (libpython)
50
52
*http://www.python.org/`(Executable and Library)`
51
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).
* This executable is used to auto-generate the documentation used by libopenshot.
56
58
57
-
*### UnitTest++ (libunittest++)
59
+
### UnitTest++ (libunittest++)
58
60
*https://github.com/unittest-cpp/`(Library)`
59
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.
60
62
61
-
*### ZeroMQ (libzmq)
63
+
### ZeroMQ (libzmq)
62
64
*http://zeromq.org/`(Library)`
63
65
* This library is used to communicate between libopenshot and other applications (publisher / subscriber). Primarily used to send debug data from libopenshot.
64
66
65
-
*### OpenMP (-fopenmp)
67
+
### OpenMP (-fopenmp)
66
68
*http://openmp.org/wp/`(Compiler Flag)`
67
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.
The source code is divided up into the following folders.
101
103
102
-
*### build/
104
+
### build/
103
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).
104
106
105
-
*### cmake/
107
+
### cmake/
106
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.
107
109
108
-
*### doc/
110
+
### doc/
109
111
* This folder contains documentation and related files, such as logos and images required by the doxygen auto-generated documentation.
110
112
111
-
*### include/
113
+
### include/
112
114
* This folder contains all headers (*.h) used by libopenshot.
113
115
114
-
*### src/
116
+
### src/
115
117
* This folder contains all source code (*.cpp) used by libopenshot.
116
118
117
-
*### tests/
119
+
### tests/
118
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.
119
121
120
-
*### thirdparty/
122
+
### thirdparty/
121
123
* This folder contains code not written by the OpenShot team. For example, jsoncpp, an open-source JSON parser.
* 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.
* 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
36
38
37
-
*### Qt 5 (libqt5)
39
+
### Qt 5 (libqt5)
38
40
*http://www.qt.io/qt5/`(Library)`
39
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...
40
42
41
-
*### CMake (cmake)
43
+
### CMake (cmake)
42
44
*http://www.cmake.org/`(Executable)`
43
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.
44
46
45
-
*### SWIG (swig)
47
+
### SWIG (swig)
46
48
*http://www.swig.org/`(Executable)`
47
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.
48
50
49
-
*### Python 3 (libpython)
51
+
### Python 3 (libpython)
50
52
*http://www.python.org/`(Executable and Library)`
51
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).
* This executable is used to auto-generate the documentation used by libopenshot.
56
58
57
-
*### UnitTest++ (libunittest++)
59
+
### UnitTest++ (libunittest++)
58
60
*https://github.com/unittest-cpp/`(Library)`
59
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.
60
62
61
-
*### ZeroMQ (libzmq)
63
+
### ZeroMQ (libzmq)
62
64
*http://zeromq.org/`(Library)`
63
65
* This library is used to communicate between libopenshot and other applications (publisher / subscriber). Primarily used to send debug data from libopenshot.
64
66
65
-
*### OpenMP (-fopenmp)
67
+
### OpenMP (-fopenmp)
66
68
*http://openmp.org/wp/`(Compiler Flag)`
67
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.
The source code is divided up into the following folders.
100
102
101
-
*### build/
103
+
### build/
102
104
* 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).
103
105
104
-
*### cmake/
106
+
### cmake/
105
107
* 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.
106
108
107
-
*### doc/
109
+
### doc/
108
110
* This folder contains documentation and related files, such as logos and images required by the doxygen auto-generated documentation.
109
111
110
-
*### include/
112
+
### include/
111
113
* This folder contains all headers (*.h) used by libopenshot.
112
114
113
-
*### src/
115
+
### src/
114
116
* This folder contains all source code (*.cpp) used by libopenshot.
115
117
116
-
*### tests/
118
+
### tests/
117
119
* 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.
118
120
119
-
*### thirdparty/
121
+
### thirdparty/
120
122
* This folder contains code not written by the OpenShot team. For example, jsoncpp, an open-source JSON parser.
* 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.
* 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
40
39
-
*### Qt 5 (libqt5)
41
+
### Qt 5 (libqt5)
40
42
*http://www.qt.io/qt5/`(Library)`
41
43
* 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
44
43
-
*### CMake (cmake)
45
+
### CMake (cmake)
44
46
*http://www.cmake.org/`(Executable)`
45
47
* 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
48
47
-
*### SWIG (swig)
49
+
### SWIG (swig)
48
50
*http://www.swig.org/`(Executable)`
49
51
* 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
52
51
-
*### Python 3 (libpython)
53
+
### Python 3 (libpython)
52
54
*http://www.python.org/`(Executable and Library)`
53
55
* 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).
* This executable is used to auto-generate the documentation used by libopenshot.
58
60
59
-
*### UnitTest++ (libunittest++)
61
+
### UnitTest++ (libunittest++)
60
62
*https://github.com/unittest-cpp/`(Library)`
61
63
* 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
64
63
-
*### ZeroMQ (libzmq)
65
+
### ZeroMQ (libzmq)
64
66
*http://zeromq.org/`(Library)`
65
67
* This library is used to communicate between libopenshot and other applications (publisher / subscriber). Primarily used to send debug data from libopenshot.
66
68
67
-
*### OpenMP (-fopenmp)
69
+
### OpenMP (-fopenmp)
68
70
*http://openmp.org/wp/`(Compiler Flag)`
69
71
* 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
72
@@ -109,7 +111,7 @@ check each folder path for accuracy, as your paths will likely be different than
The source code is divided up into the following folders.
132
134
133
-
*### build/
135
+
### build/
134
136
* This folder needs to be manually created, and is used by cmake to store the temporary
135
137
build files, such as makefiles, as well as the final binaries (library and test executables).
136
138
137
-
*### cmake/
139
+
### cmake/
138
140
* This folder contains custom modules not included by default in cmake, used to find
139
141
dependency libraries and headers and determine if these libraries are installed.
140
142
141
-
*### doc/
143
+
### doc/
142
144
* This folder contains documentation and related files, such as logos and images
143
145
required by the doxygen auto-generated documentation.
144
146
145
-
*### include/
147
+
### include/
146
148
* This folder contains all headers (*.h) used by libopenshot.
147
149
148
-
*### src/
150
+
### src/
149
151
* This folder contains all source code (*.cpp) used by libopenshot.
150
152
151
-
*### tests/
153
+
### tests/
152
154
* This folder contains all unit test code. Each class has it’s own test file (*.cpp), and
153
155
uses UnitTest++ macros to keep the test code simple and manageable.
154
156
155
-
*### thirdparty/
157
+
### thirdparty/
156
158
* This folder contains code not written by the OpenShot team. For example, jsoncpp, an
157
159
open-source JSON parser.
158
160
@@ -240,28 +242,28 @@ mingw32-make install
240
242
241
243
## Manual Dependencies
242
244
243
-
*### DLfcn
245
+
### DLfcn
244
246
*https://github.com/dlfcn-win32/dlfcn-win32
245
-
* Download and Extract the Win32 Static (.tar.bz2) archive to a local folder: C:\libdl\
246
-
* Create an environment variable called DL_DIR and set the value to C:\libdl\. This environment variable will be used by CMake to find the binary and header file.
247
+
* Download and Extract the Win32 Static (.tar.bz2) archive to a local folder: `C:\libdl\`
248
+
* Create an environment variable called DL_DIR and set the value to `C:\libdl\`. This environment variable will be used by CMake to find the binary and header file.
247
249
248
-
*### DirectX SDK / Windows SDK
250
+
### DirectX SDK / Windows SDK
249
251
* Windows 7: (DirectX SDK) http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=6812
* Download and Install the SDK Setup program. This is needed for the JUCE library to play audio on Windows.
253
-
Create an environment variable called DXSDK_DIR and set the value to C:\Program Files\Microsoft DirectX SDK (June 2010)\ (your path might be different). This environment variable will be used by CMake to find the binaries and header files.
255
+
Create an environment variable called DXSDK_DIR and set the value to `C:\Program Files\Microsoft DirectX SDK (June 2010)\` (your path might be different). This environment variable will be used by CMake to find the binaries and header files.
254
256
255
-
*### libSndFile
257
+
### libSndFile
256
258
*http://www.mega-nerd.com/libsndfile/#Download
257
259
* Download and Install the Win32 Setup program.
258
-
* Create an environment variable called SNDFILE_DIR and set the value to C:\Program Files\libsndfile. This environment variable will be used by CMake to find the binary and header files.
260
+
* Create an environment variable called SNDFILE_DIR and set the value to `C:\Program Files\libsndfile`. This environment variable will be used by CMake to find the binary and header files.
259
261
260
-
*### libzmq
262
+
### libzmq
261
263
*http://zeromq.org/intro:get-the-software
262
264
* Download source code (zip)
263
265
* Follow their instructions, and build with mingw
264
-
* Create an environment variable called ZMQDIR and set the value to C:\libzmq\build\ (the location of the compiled version). This environment variable will be used by CMake to find the binary and header files.
266
+
* Create an environment variable called ZMQDIR and set the value to `C:\libzmq\build\` (the location of the compiled version). This environment variable will be used by CMake to find the binary and header files.
265
267
266
268
## Windows Build Instructions (libopenshot-audio)
267
269
In order to compile libopenshot-audio, launch a command prompt and enter the following commands. This does not require the MSYS2 prompt, but it should work in both the Windows command prompt and the MSYS2 prompt.
@@ -314,8 +316,8 @@ built, we need to install it (i.e. copy it to the correct folder, so other libra
314
316
mingw32-make install
315
317
```
316
318
317
-
This should copy the binary files to C:\Program Files\openshot\lib\, and the header
318
-
files to C:\Program Files\openshot\include\... This is where other projects will
319
+
This should copy the binary files to `C:\Program Files\openshot\lib\`, and the header
320
+
files to `C:\Program Files\openshot\include\...` This is where other projects will
319
321
look for the libopenshot files when building.. Python 3 bindings are also installed
320
322
at this point. let's verify the python bindings work:
0 commit comments