2 \label{cha:Installation}
5 \section{\CGG{} AppImage}%
6 \label{sec:cin_gg_appimage}
8 The main way to install \CGG{} is to use the AppImage. This is updated regularly and works for every distro, since it already contains the necessary dependencies.
9 A big advantage of using the AppImage format is that it is only 1/3 the size of the normal install,
10 and since each release is named differently, you can keep a number of versions in a directory,
11 and when testing from a terminal you just have to type CinGG, then hit tab, and complete it to
12 the desired date release.
14 For 64-bit systems you can choose between an image with up-to-date libraries or one that supports older libraries, which you should use only if the first image gives you problems with unsupported libs. There is also a 32-bit older distro available that has \textit{i686} as part of the filename that currently works on older distros but may not work on the newest distros
15 (most of the popular Linux distributions such
16 as Arch, Ubuntu, and Fedora have dropped support for this older architecture). In any case, if you are using a 32-bit Linux distro, you should compile your sources from git or use a precompiled binary\protect\footnote{Remember that a 32-bit distro does not address more than 4GB of memory, so you may have stability and performance problems with large, high-resolution mediafiles.}. And there is a 8/10/12 bit newer distro that handles 8 or 10 or 12 bits that has \textit{multibit} as part of the filename. Installing the appimage is simple:
18 Download the file from:
20 \url{https://cinelerra-gg.org/download/images/}
22 Some example file names are as follows - where 8 digits represent yyyymmdd:
24 \begin{lstlisting}[style=sh]
25 CinGG-20210731-x86_64.AppImage
26 (currently based on Fedora Core 32, libc version 2.31)
27 CinGG-20210731-x86_64-older-distros.AppImage
28 (currently based on Ubuntu 16.04, libc version 2.23)
29 CinGG-20210731-i686.AppImage
30 (currently based on Debian 9, linux kernel 4.9, use "newer" for Debian 11.0)
31 CinGG-20210731-i686-newer-distros.AppImage
32 (currently based on Debian 11, linux kernel 5.10)
33 CinGG-20210731-x86_64-multibit.AppImage
34 (currently based on Fedora Core 32, libc version 2.31)
37 Make the file executable with the proper execute permissions either from the GUI of the Desktop Environment used (link to the file) or from a terminal window. Make sure you are already in the directory containing the appimage:
39 \begin{lstlisting}[style=sh]
40 $ chmod u+x CinGG-yyyymmdd.AppImage
43 Finally start the program from a window in the directory where the image is stored:
45 \begin{lstlisting}[style=sh]
46 $ ./CinGG-yyyymmdd.AppImpage
49 or create a convenient desktop icon with a link to the run action, or do a \textit{Desktop Integration} manually or with external programs. There is a
50 description of a GUI methodology for doing so in this file on the webiste:
52 \url{https://cinelerra-gg.org/download/images/README\_appimage.txt}
54 Most distros already have the libraries to run the appimage, but if not you may need an additional installation. For example Arch Linux needs the \texttt{libappimage} package.
56 \begin{lstlisting}[style=sh]
57 sudo pacman -S libappimage
60 And Leap 15.3 (OpenSUSE) requires installation of the \textit{appimage} package.
62 \begin{lstlisting}[style=sh]
63 sudo zypper se -is appimage
66 In addition, if you are using the OpenGL video driver, you will need to install the appropriate OpenGL
67 drivers for your Operating System graphics board because libGLU.so and other OpenGL libraries are
68 not included in the AppImage.
70 \section{Download Already Built \CGG{}}%
71 \label{sec:download_already_built_cinelerra_gg}
75 \includegraphics[width=1.0\linewidth]{download-distros.png}
76 \caption{Screencast of the website Download page for installing \CGG{} for various O/S.}
77 \label{fig:download-distros}
80 All of these images are dated 10/31/2020 and are no longer being maintained. They
81 will still work on the version of the O/S in use at that time but will have none of
82 the latest features. You should use the simpler AppImage instead as described previously.
84 If you prefer to not have to take the time to build \CGG{} Infinity
85 yourself, there are pre-built dynamic or static binaries for various
86 versions of Ubuntu, Mint, Suse, Fedora, Debian, Centos, Arch, and
87 Slackware linux as well as Gentoo and FreeBSD. If you do want to build it yourself so that
88 you get the added benefit of the latest checked in changes, please reference
89 ~\ref{sec:How_to_build}.
91 A Windows 10 version installation is described in~\ref{sec:ms_windows10}. There are also 32-bit i686 Ubuntu, Debian,
92 and Slackware versions available\protect\footnote{Remember that a 32-bit distro does not address more than 4GB of memory, so you may have stability and performance problems with large, high-resolution mediafiles.}. \textbf{These binaries are no longer being updated; they are stable and working but without future functionality}.
93 They are in subdirectories of:
96 \item \href{https://cinelerra-gg.org/download/tars}{https://cinelerra-gg.org/download/tars}
97 \item \href{https://cinelerra-gg.org/download/pkgs}{https://cinelerra-gg.org/download/pkgs}
100 The \textbf{tars} \index{tars} directory contains single-user static builds for
103 This is the recommended usage of \CGG{} because all of the files
104 will exist in a single directory. Generally all of the necessary
105 libraries are built into the static build, but in some cases you may
106 have to install another library that is being called for.
108 To install the single user builds, download the designated tarball
109 from the \texttt{./tars} subdirectory and unpack as indicated below:
111 \begin{lstlisting}[style=sh]
115 tar -xJf /src/path/cinelerra-5.1-*.txz # for the *, substitute your distro tarball name
118 \emph{Do not download the LEAP 10-bit version unless you specifically want to
119 use h265 rendering to 10-bit instead of the more standard 8-bit.} For more
120 information see ~\ref{sec:cinx_and_a_bit_of_confusion}.
122 The \textbf{pkgs} \index{pkgs} directory contains the standard packaged
123 application for various distros. This will install a dynamic
124 system version for users who prefer to have the binaries in the
125 system area and for multi-user systems.
127 In addition, performing the package install checks the md5sum in
128 the file \texttt{md5sum.txt} to ensure the channel correctly
129 transmits the package. There is a
130 \href{https://cinelerra-gg.org/download/README.pkgs}{README.pkgs}
131 file in the \texttt{download} directory with instructions so you
132 can \textit{cut and paste} and avoid typos; it is also shown
135 \lstset{inputpath=extra/}
138 basicstyle=\footnotesize,
139 caption={README.pkgs}
142 \section{How to Build \CGG{} from Developer's Git Repository}%
143 \label{sec:How_to_build}
147 These are generic build instructions for building \CGG{} Infinity.
148 Known to work on Ubuntu, Mint, OpenSuse, Fedora, Debian, Centos,
149 Arch, Slackware, and Gentoo. Compiling from git is perhaps the best way to get \CGG{} on 32-bit systems\protect\footnote{Remember that a 32-bit distro does not address more than 4GB of memory, so you may have stability and performance problems with large, high-resolution mediafiles.}. It has not been tested on every
150 single possible distro yet so you might expect to have to make
151 some minor changes. Also works on a somewhat limited basis on
152 FreeBSD and Windows 10 with the bsd.patch for FreeBSD and the
153 cygwin.patch for Windows 10. As of 10/31/2020, FreeBSD and Windows
154 10 builds and patches are no longer being maintained so that they
155 will work using the GIT version in use at that time but you will
156 have to create new patches for arising problems on later GITs.
158 NOTE: as of May 31, 2021 when Context Help was added, to include
159 this Context Help you will need to download the corresponding
160 tgz file containing the HTML manual sections referenced for the
161 Help pages. The file to download is:
162 \url{https://cinelerra-gg.org/download/images/HTML_Manual-20210531.tgz}
163 substituting for "20210531" the "yyyymmdd" representing latest release date.
164 Then unpack to your Cinelerra/bin/doc directory so it is included in
168 Alternatively, there are some pre-built dynamic or static binaries
169 which are updated on a fairly regular basis (as long as code changes
170 have been made) available at the link below.
172 \href{https://cinelerra-gg.org/download/}{https://cinelerra-gg.org/download/}
175 There are 2 kinds of builds, the default system-build and a
176 single-user build. A system build has results which are installed
177 to the system. The majority of the files are installed in the
178 standard system paths, but some customization is possible. The
179 single user build allows for running completely out of a local
180 user directory so it doesn't affect the system.
182 We recommend the single-user version when possible. It makes it
183 very easy to install a new version without having to delete the
184 older version in case you want it for backup -- once you are happy
185 with the new version, all you have to do is delete the entire old
186 directory path. Another reason for using single-user is that if
187 you install a new Operating System version and if you have \CGG{}
188 on separate disk space that is preserved, you won't have to
189 reinstall \CGG{}. It is also convenient for the purpose of having
190 the ability to interrupt or to see any possible error messages, if
191 you start the application from a terminal window command line
192 where you will have more control to catch problems. All that
193 said, the system builds can be useful in a university lab setting
194 where there are possibly multiple users, or multiple versions.
196 There are two notable differences between standard views
197 of \CGG{} and this implementation for the system builds. Both of
198 these can be configured during installation. The differences make
199 it possible to have several different versions installed without
200 having them interfere with each other.
203 \item application name can be set during a build but defaults
205 \item the home configuration directory can also be set and
206 traditionally defaults to: \texttt{\$HOME/.bcast5}
210 \subsection{The system build}
211 \label{sec:system-build}
214 To do a system build \index{build} , you should read the file
215 \texttt{README} that is at the top level after you get the source.
218 \item You need about 6.0 \,GB of disk storage to operate a build and
219 you need to have \textit{git} installed.
221 \item Obviously in order to install into the system, you must run as
224 \item The \textit{git:} step has to download many files (approx
225 130\,MB) so allow time. When decompressed this will expand to
228 \item Run the following commands (this takes awhile):
230 \begin{lstlisting}[style=sh]
231 # This is where you need the 6.0GB of disk space:
233 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
234 # Change to the cloned directory:
235 cd cinelerra5/cinelerra-5.1
237 NOTE: if your system has never had \CGG{} Infinity installed, you
238 will have to make sure you have all of the compilers and libraries
239 necessary. So on the very first build you should run:
241 \begin{lstlisting}[style=sh]
242 ./blds/bld_prepare.sh <os> # where <os> represents the
243 # Operating System of
244 # centos, fedora, suse, ubuntu, mint, debian.
246 ./configure --prefix=/usr # optional parameters can be added here
247 make 2>&1 | tee log # make and log the build
250 \texttt{bld\_prepare.sh} does not work for Arch Linux or Gentoo,
251 so we have to install the dependencies
252 manually. \texttt{README.arch} or \texttt{README.gentoo}, which
253 contain the list of dependencies, can be found at:
255 \item \href{https://cinelerra-gg.org/download/README.arch}{https://cinelerra-gg.org/download/README.arch}
256 \item \href{https://cinelerra-gg.org/download/README.gentoo}{https://cinelerra-gg.org/download/README.gentoo}
259 \item Check for obvious build errors:
260 \begin{lstlisting}[style=sh]
261 grep "\*\*\*.*error" -ai log
263 If this reports errors and you need assistance or you think
264 improvements can be made to the builds, email the log which is
266 \href{mailto:cin@lists.cinelerra-gg.org}{cin@lists.cinelerra-gg.org}
267 \begin{lstlisting}[style=sh]
268 /<build_path>/cinelerra5/cinelerra-5.1/log
271 \item If there are no build errors, finally just run:
272 \begin{lstlisting}[style=sh]
275 Where <os> represents the Operating System supported by \CGG{}, such
276 as centos, fedora, suse, ubuntu, mint, debian.
277 The ``with-single-user'' parameter makes it so.
278 % Make and log build (
279 Check for errors before proceeding.
282 \item If it all worked, you are all setup. Just click on the \CGG{}
287 \subsection{The single-user build}
288 \label{sec:single-user-build}
289 \index{single-user build}
292 To do a single-user build, read the file \texttt{README} that is at
293 the top level after you get the source.
296 \item You need at least 6\,GB of disk storage to operate a build +
297 you need to have “\texttt{git}” installed.
299 \item Recommend you build and run as \textbf{root}, just to avoid
300 permission issues initially.
301 \item The \textit{git} step has to download many files (approx
302 130\,MB) so allow time.
304 \item Run the following commands (this takes awhile):
305 \begin{lstlisting}[style=sh]
306 # This is where you need the 6GB of disk space
308 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
309 # Toplevel directory:
310 cd cinelerra5/cinelerra-5.1
314 NOTE: if your system has never had \CGG{} Infinity installed, you
315 will have to make sure all the compilers and libraries necessary are
316 installed. So on the very first build you should run as
319 % FIXME No novels in the listings.
320 \begin{lstlisting}[style=sh]
321 ./blds/bld_prepare.sh <os>
323 ./configure --with-single-user
327 Where <os> represents the Operating System supported by \CGG{}, such
328 as centos, fedora, suse, ubuntu, mint, debian.
329 The ``with-single-user'' parameter makes it so.
330 % Make and log build (
331 Check for errors before proceeding.
334 Then just start the application by keying in: \texttt{./cin} in the
335 bin subdirectory OR add a desktop icon by using the appropriate
336 directory to copy the files to, run as \textbf{root}, and edit to
337 correct the directory path. Below are generic directions of how to
340 Then just start the application by keying in: \texttt{./cin} in the
341 bin subdirectory OR add a desktop icon by using the appropriate
342 directory to copy the files to, run as \textbf{root}, and edit to
343 correct the directory path. Below are generic directions of how to
346 \begin{lstlisting}[style=sh]
347 cd /cinelerra_directory_path
348 cp -a image/cin.{svg,xpm} /usr/share/pixmaps/
349 cp -a image/cin.desktop /usr/share/applications/cin.desktop
352 After you have followed the above, in the cin.desktop file, change
353 the \texttt{Exec=cin} line to be
354 \texttt{Exec=<your\_directory\_path>/bin/cin}.
356 The preceding directions for doing a single-user build may work
357 without being root on some distros except for the \texttt{bld\_prepare.sh}
358 and creating the desktop icon. For example in Arch Linux installing without being root
359 works using the following steps:
361 \begin{lstlisting}[style=sh]
362 $ git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
363 $ cd /home/USER/cinelerra5/cinelerra-5.1
365 $ ./configure --prefix=/usr --with-single-user --with-booby
366 $ make 2>&1 | tee /tmp/cin5.log && make install
370 \subsection{Notable Options and Caveats}%
371 \label{sub:notable_options_and_caveats}
374 These procedures and the \CGG{} Infinity software have all been run
375 as \textbf{root} on various home laptops and desktops. This provides
376 the best chance to ensure all works correctly and also allows for
377 handling errors, other problems and potential crashes with the most
378 success. Included in this section are some of the build variations
379 easily available for normal builds.
381 To see the full list of features use:
383 \begin{lstlisting}[style=sh]
386 The default build \index{build} is a system build which uses:
388 \begin{lstlisting}[style=sh]
389 ./configure --without-single-user
392 In the single-user build \index{single-user build}, the target directory is always
393 \texttt{cin}. Because this is also the developer build, constant
394 names are used throughout. However, you can rename files after the
397 If your operating system has issues with the default install to
398 \texttt{/usr/local}, you might have to change the location to
399 \texttt{/usr} for a system build. Then you will have to use:
400 \begin{lstlisting}[style=sh]
401 ./configure --prefix=/usr
404 If you wish to change the default directory for a system build you
405 will have to add the destination directory path on the \texttt{make
406 install} line. For example:
407 \begin{lstlisting}[style=sh]
408 make install DESTDIR=<your selected target directory path>
411 The application name can be set during installation, but defaults to
412 \texttt{cin} so that the GG/Infinity build can coexist with other
413 \CGG{} builds if necessary. To override the default \texttt{cin}
415 \begin{lstlisting}[style=sh]
416 ./configure --with-exec-name=cinelerra
419 The home configuration directory can also be set, but default
420 location is traditionally \texttt{\$HOME/.bcast5}. For example:
422 \begin{lstlisting}[style=sh]
423 ./configure -with-config-dir=/myusername/.bcast5
426 NOTE: when you specify parameters to the configure program, it will
427 create a \texttt{make} file as a consequence. Since in a
428 \texttt{make} file, the \$ is a special character, it must be
429 escaped so in order to represent a \$ as part of an input parameter,
430 it has to be stuttered. That is, you will need \$\$ (2 dollar
431 signs) to represent a single dollar sign.
433 It may be necessary on some distros which have missing or incomplete
434 up-to-date libraries, to build \CGG{} without Ladspa. To do so,
437 \begin{lstlisting}[style=sh]
438 ./configure --prefix=/usr --without-ladspa-build
441 Note that the with-ladspa-dir is the ladspa search path, and
442 exists even if the ladspa build is not selected. This gives you
443 the ability to specify an alternate ladspa system path by
444 utilizing the \texttt{LADSPA\_PATH} environment variable (that is,
445 the default ladspa build is deselected).
447 Note for 32-bit 14.2 Slackware, Debian, Gentoo, Arch, FreeBSD,
448 before running the configure, you will need to set up the following:
450 \begin{lstlisting}[style=sh]
451 export ac_cv_header_xmmintrin_h=no
452 export FFMPEG_EXTRA_CFG=" --disable-vdpau"
455 NOTE: as of May 31, 2021 when Context Help was added, to include
456 this Context Help you will need to download the corresponding
457 tgz file containing the HTML manual sections referenced for the
458 Help pages. The file to download is:
459 \url{https://cinelerra-gg.org/download/images/HTML_Manual-20210531.tgz}
460 substituting for "20210531" the "yyyymmdd" representing latest release date.
461 Then unpack to your Cinelerra/bin/doc directory so it is included in
462 your built system. The reason for not including the HTML manual in
463 the source code so that it would already be there, is because it is
464 very large and has its own GIT base.
466 \subsection{Notes about Building from Git in your Customized Environment}%
467 \label{sub:notes_about_building_from_git_in_your_customized_environment}
472 Getting a build to work in a custom environment is not easy. If you
473 have already installed libraries which are normally in the
474 thirdparty build, getting them to be recognized means you have to
475 install the \textit{devel} version so the header files which match
476 the library interfaces exist. Below is the list of thirdparty
477 builds, but this list may have changed over time.
478 % It's list of Table?
482 \begin{longtable}{m{8em} c}
483 \caption{List of thirdparty builds}
484 \label{tab:List_of_thirdparty_builds}\\
527 The \textit{yes} means force build and \textit{auto} means probe and
528 use the system version if the build operation is not static. To get
529 your customized build to work, you need to change the probe options
530 for the conflicting libraries from \textit{yes} to \textit{auto}, or
531 even rework the \texttt{configure.ac} script. There may be several
532 libraries which need special treatment.
534 An example of a problem you might encounter with your customized
535 installation is with \texttt{a52dec} which has probes line
536 \texttt{(CHECK\_LIB/CHECK\_HEADERS)} in \texttt{configure.ac}, but
537 \texttt{djbfft} does not. In this case, \texttt{djbfft} is only
538 built because \texttt{a52dec} is built, so if your system has
539 \texttt{a52dec}, set \texttt{a52dec} to auto and see if that
540 problem is solved by retrying the build with:
541 \begin{lstlisting}[style=sh]
542 ./confgure --with-single-user -enable-a52dec=auto .
545 With persistence, you can get results, but it may take several tries
546 to stabilize the build. If you need help, email the \texttt{log}
547 and \texttt{config.log}, which is usually sufficient to determine
550 If you have already installed the \texttt{libfdk\_aac} development
551 package on your computer because you prefer this version over the
552 default aac, you will have to do the following to get this
553 alternative operational. The libfdk\_aac library is not a part of
554 \CGG{} by default because it is not license free.
556 \begin{lstlisting}[style=sh]
557 export FFMPEG_EXTRA_CFG=" --enable-libfdk-aac --enable-nonfree"
558 export EXTRA_LIBS=" -lfdk-aac"
559 for f in `grep -lw aac cinelerra-5.1/ffmpeg/audio/*`; do
560 sed -e 's/\<aac\>/libfdk_aac/' -i $f
565 \subsection{Cloning the Repository for Faster Updates}%
566 \label{sub:cloning_the_repository_for_faster_updates}
570 If you want to avoid downloading the software every time an update
571 is available you need to create a local ``repository'' or repo. The
572 repo is a directory where you first do a \texttt{git clone}. For
573 the initial git clone, set up a local area for the repository
574 storage, referred to as \texttt{<repo\_path>}. The \texttt{git
575 clone} creates a repo named \texttt{cin5} in the
576 \texttt{/<repo\_path>/} directory. This accesses about 530\,MB of
577 repo data, so the device has to have at least that available. The
578 repo path is always a perfect clone of the main repo.
581 \paragraph{Setting up the initial clone}%
582 \label{par:setting_up_the_initial_clone}
584 You may want to add ``\verb|--depth 1|'' before \texttt{cin5}
585 because this will clone faster and is smaller, but has no history.
587 \begin{lstlisting}[style=sh]
589 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra" cin5
591 Cloning into "cin5"...
592 remote: Counting objects: 20032, done.
593 remote: Compressing objects: 100% (11647/11647), done.
594 remote: Total 20032 (delta 11333), reused 16632 (delta 8189)
595 Receiving objects: 100% (20032/20032), 395.29 MiB | 3.26 MiB/s, done.
596 Resolving deltas: 100% (11333/11333), done.
597 Checking connectivity... done.
601 \paragraph{Update an existing repo}%
602 \label{par:update_an_existing_repo}
603 The below shows how you can get updates.
605 \begin{lstlisting}[style=sh]
611 \paragraph{Useful git commands}%
612 \label{par:useful_git_commands}
613 Some other commands that are useful.
615 \begin{lstlisting}[style=sh]
616 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cin5
617 git pull # pull remote changes to the local version
618 git status # shows changed files
619 git clean -i # interactive clean, use answer 1 to "clean"
623 \subsection{How to Build from a Previous GIT Version}%
624 \label{sub:how_to_build_from_a_previous_git_version}
629 If you have a problem with the current GIT version, you can revert
630 to a previous working version easily. The commands to use will be
631 similar to these next lines which are then explained in more detail.
634 \begin{lstlisting}[style=sh]
635 cd /<path>/cin5 # substitute your repo path name for cin5
636 git log # shows a list of versions depending on history depth specification
637 git checkout <version> # choose a version number as listed
640 The \texttt{git log} command produces a log file with hash values
641 for commit keys to the level specifed if the the depth paramter
643 The hash ids are the commit names to use when you
644 use git checkout. Next is displayed sample output:
646 \begin{lstlisting}[style=nil]
647 delete stray line in last checkin
649 commit 4a90ef3ae46465c0634f81916b79e279e4bd9961
650 Author: Good Guy <good1.2guy@gmail.com>
651 Date: Thu Feb 22 14:56:45 2018 -0700
653 nested clips, big rework and cleanup, sams new icons,
656 commit f87479bd556ea7db4afdd02297fc00977412b873
657 Author: Good Guy <good1.2guy@gmail.com>
658 Date: Sat Feb 17 18:09:22 2018 -0700
661 For the \texttt{git checkout <version>}, you would then keyin the
662 line below for the following results:
664 \begin{lstlisting}[style=nil]
665 git checkout f87479bd556ea7db4afdd02297fc00977412b873
667 Note: checking out 'f87479bd556ea7db4afdd02297fc00977412b873'.
669 You are in 'detached HEAD' state. You can look around, make
670 experimental changes and commit them, and you can discard any
671 commits you make in this state without impacting any branches by
672 performing another checkout.
674 If you want to create a new branch to retain commits you create,
675 you may do so (now or later) by using -b with the checkout command
678 git checkout -b <new-branch-name>
680 HEAD is now at f87479bd... more file size icon updates,
681 and more to followend
684 Later to get the repo back to current, use:
685 \begin{lstlisting}[style=sh]
690 \subsection{Debuggable Single User Build}%
691 \label{sub:debuggable_single_user_build}
692 \index{single-user build}
695 To build from source with full debugging symbols, first build a full
696 static (non\_debug) build as follows but instead of using
697 \texttt{/tmp} substitute your permanent disk path if you want to
700 \begin{lstlisting}[style=sh]
702 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
703 cp -a /<repo_path>/cinelerra-5.1 /tmp/
704 cd /tmp/cinelerra-5.1
708 Then, to run as a developer in the debugger:
710 \begin{lstlisting}[style=sh]
711 CFLAGS="-O2 -ggdb" make -j8 rebuild_all
717 \subsection{Unbundled Builds}%
718 \label{sub:unbundled_builds}
723 There are some generic build scripts included in the \CGG{} GIT
724 repository for users who want to do unbundled builds with ffmpeg
725 already available on their system. This has been tested on Arch,
726 Ubuntu 18, FreeBSD, Windows10 and Leap 15 (rpm) at the time this
729 The names of the build scripts are: \texttt{arch.bld},
730 \texttt{bsd.bld}, \texttt{deb.bld}, \texttt{rpm.bld}, and
731 \texttt{cygwin.bld}. These scripts are in the \texttt{blds}
732 subdirectory. The \texttt{bsd.bld} should be used with the
733 \texttt{bsd.patch} file in that same directory. The
734 \texttt{cygwin.bld} should be used with the \texttt{cygwin.patch}
735 file in that same directory.
737 The reason that Cin Infinity traditionally uses its own thirdparty builds
738 (bundled builds) is because there are a lot of different distros
739 with varying levels of ffmpeg and other needed thirdparty
740 libraries. However, some users prefer using their current system
741 baseline without another/different copy of ffmpeg.
743 With different levels of the user’s libraries, uncertainty,
744 potential instability, and unknown issues may come up while
745 running \CGG{} and this will make it, for all practical purposes,
746 impossible to diagnose and debug problems or crashes.
748 There may be no help in these cases. You are encouraged to report
749 any errors which potentially originate from Cin Infinity, but if
750 the data indicates alternate library sources, please report the
751 problems to the appropriate maintainers.
753 With the unbundled builds, some features may not be available and
754 no attempt to comment them out has been made. So if you use a
755 pulldown, or pick a render option, or choose something that is not
756 available, it just will not work. For example, unless special
757 options were set up by you, the LV2 audio plugins will not be
758 available. Nor will the codec libzmpeg, the file codec ac3, or
759 DVD creation. The old school file classes will all work, but some
760 of the formats that come with ffmpeg may not because of the way
761 that ffmpeg was installed on your operating system. That is
762 because the \CGG{} included ffmpeg is a known static build and is
763 usually the latest stable/released version. For example, in the
764 current case of Leap 15, libx264 and libx265 are not built in and
765 this can be debilitating; you can always run \texttt{ffmpeg
766 -formats} and \texttt{ffmpeg -codecs} to see what is available
769 \section{Building the HTML Manual for Context Help}%
770 \label{sec:building_the_manual}
773 In addition to compiling your own \CGG{}, you should also build an html version of the manual that is needed for Context Help in the program. The main version of the manual is in latex to produce a pdf version of the manual and this is required to be built first as the basis for the html version. This means that you need a full latex environment, git, and the latex2html program in order to eventually create the html version. Texlive is about 1 GB; Latex2html itself has many requirements and missing any will result in failure: some requirments include Netpbm, GhostScript, dvips, etc. Latex2html must be at least version \textit{2021.2} in order to create the html manual version from the latex.
775 The steps are as follows:
777 \item Download the manual in LaTeX:
779 \begin{lstlisting}[style=sh]
780 git clone "git://git.cinelerra-gg.org/goodguy/cin-manual-latex.git" master
783 \item Included in the download is the \texttt{translate\_manual} script. After modifying this file to have execute permission, run this script from a terminal window in the \textit{master} directory where it was downloaded (be aware that this script includes several \textit{rm} commands):
784 \begin{lstlisting}[style=sh]
788 The steps that this script performs are as follows:
790 \item PDF production. The PDF document will be produced from the latex source in the \textit{master} directory. Since the glossary and index are also present, it has to run the pdf build several times. The following commands in the \texttt{translate\_manual} script produce the PDF document from latex source which includes invoking makeindex for the Index and Glossary.
792 \begin{lstlisting}[style=sh]
793 pdflatex CinelerraGG_Manual.tex
794 makeindex CinelerraGG_Manual.idx
795 pdflatex CinelerraGG_Manual.tex
796 makeindex CinelerraGG_Manual.nlo -s nomencl.ist -o CinelerraGG_Manual.nls
797 pdflatex CinelerraGG_Manual.tex
800 After these commands are executed you will have the manual only in PDF format. So if you only want a PDF version, you only need to run these previous 5 lines but Context Help from the program will not be available with the PDF version.
801 \item Next, to produce HTML output the script then moves (renames) \texttt{latex 2html-init} to \texttt{.latex2html-init} (starting with dot).
803 \item Then the script uses latex2html: latex2html is run with a unique set of parameters and some cleanup is performed. It creates the directory CinelerraGG\_Manual containing all the files of the manual in html: tables, references, index, glossary, and various images.
806 \item After installation of the \CGG{} program, place the complete unchanged directory \texttt{CinelerraGG\_Manual}, as it was produced by latex2html from the manual package, into the \textit{doc} directory of the installed Cinelerra package. This will be the directory \textit{bin/doc/CinelerraGG\_Manual} if \CGG{} was built \texttt{--with-single-user}. The script ContextManual.pl will automatically be in bin/doc after the successful build of the program. It is this perl script that allows the program to access CinelerraGG\_Manual to offer Context Help.
808 \item Optionally you can make some adjustments to the latex2html command line in the \texttt{translate\_manual} script. Some variants are shown in the comments inside the script but changes may impact the usability of Alt/h hotkey from the program.
811 \section{Windows 10 with Cygwin for \CGG{} Limited}%
812 \label{sec:ms_windows10}
815 As of 10/31/2020, this is no longer being maintained. It should
816 still work using an older GIT version with Windows 10 but it is
817 possible with some effort to modify the patch file to work with the
820 To run \CGG{} on a Windows 10 computer, you will need to have
821 Cygwin installed on your system, along with the \CGG{} static tar
822 and a patched library: libxcb. This setup has been tested with
823 Windows 10, version 1909, on an HP EliteBook 820 at 2.3 GHz.
825 This limited version provides \textit{core} functionality at this
826 time with the standard Windows FFmpeg executable, meaning that
827 specific modifications in FFmpeg needed for \CGG{} are not
828 available. Limited capabilities include only a few render output
829 formats available - for example \textit{mov}, \textit{qt} as
830 \textit{mjpeg}, and \textit{mpeg} for videos and \textit{avi} and
831 \textit{qt} as \textit{s16le} for audio, but not \textit{mkv} or
832 \textit{mp4}. This is due to the fact that several codec and
833 utility libraries are not currently compiled to work with Windows.
835 \subsection*{Installing Cygwin}
836 \label{sec:installing_cygwin}
839 Cygwin is an environment that runs natively on Windows which
840 allows Unix programs to be compiled and run on Windows. With
841 cygwin installed on your Windows 10 computer, you will be able to
842 run \CGG{}. Before installing cygwin, you need to be warned that
843 the Avast anti-virus software kills files necessary for cygwin
844 installation and execution, so you will have to remove it and use
845 alternative anti-virus software (the standard default already
846 included with Windows 10 is Defender). Below are the steps for
850 \item Download cygwin for your 64-bit computer at:
851 \href{https://www.cygwin.com/}{https://www.cygwin.com/}
853 \item Generally just take the defaults as they show up, but the
854 next steps show what comes up.
856 \item When a warning window pops up, click \textit{Yes}.
858 \item Click \textit{Next}.
860 \item Choose \textit{Install from Internet} option and then click
863 \item Choose your desired directory by clicking on Browse
864 button. Choose \textit{All Users (Recommended)} and then click
867 \item Choose the local package directory where you would like your
868 installation files to be placed. Click \textit{Next}.
870 \item Choose \textit{Direct Connection} if you are using Internet
871 with plug and play device. Click \textit{Next}.
873 \item Choose any download site preferably
874 ``cygwin.mirror.constant.com'' and then click \textit{Next}.
876 \item For list of things to install, leave all set to
877 \textit{Default} except these to \textit{Install} instead:
886 This install takes a long time; approximately 2 hours on an
887 EliteBook and requires approximately 20GB storage.
889 \item Finally you will want to have the icons on your desktop
890 (already default) and then click \textit{Finish}.
893 Then to install the \CGG{} tar files, you will need to start a
894 cygwin console terminal from the startup menu as shown here:
895 \texttt{Start $\rightarrow$ Cygwin $\rightarrow$ Cygwin64}
898 \subsection*{Installing \CGG{}}
899 \label{sec:installing_cinelerra}
902 \item Download the tar file
903 \href{https://cinelerra-gg.org/download/testing/libxcb-bld.tar.bz2}{libxcb-bld.tar.bz2}.
905 \item Install libxcb from the tar file -- installs into
906 \texttt{/usr/local} and requires approximately 21MB storage.
907 \begin{lstlisting}[style=sh]
908 tar -C /usr/local -xJf /path/libxcb-bld.tar.bz2
910 The libxcb patch repairs an error (XIOError), which stops
913 \item Download the tar file
914 \href{https://cinelerra-gg.org/download/testing/cygcin-bld.tar.bz2}{cygcin-bld.tar.bz2}.
916 \item Install cygcin from the tar file - this installs into home
917 directory. Note this is cygcin \emph{not} cygwin. You must change the
918 \texttt{path} below to the name of the path where you downloaded
920 \begin{lstlisting}[style=sh]
922 tar -xJf /path/cygcin-bld.tar.bz2
926 This creates \texttt{\~{}/cygcin}, a user build installation of
927 \CGG{} and requires approximately 400MB storage.
929 \paragraph{Running \CGG{}:}
930 You will need to start a cygwin desktop from the startup menu:
932 \item \texttt{Start$\rightarrow$ Cygwin-X $\rightarrow$ Openbox}
934 You should start a console controlling terminal so that you can
937 \item \texttt{Start$\rightarrow$ Cygwin $\rightarrow$ Cygwin64} Terminal
939 This opens a separate window that can survive a cygwin hang and
940 bugs. Without these logs, it is much more difficult to use.
942 \item Type into that console controlling window, the following:
943 \begin{lstlisting}[style=sh]
947 \item Change directories to where \CGG{} is installed:
948 \begin{lstlisting}[style=sh]
949 cd /path/cygcin (NOT cygwin)
953 \begin{lstlisting}[style=sh]
956 which starts up your 4 \CGG{} windows.
959 The most noticeable difference from the Linux versions is that
960 \CGG{} seems to run very slowly on Windows 10. You must be very
961 tolerant and patient to see this work. It can however exhibit
962 astonishing speed when encoding. \CGG{} has to be downgraded
963 significantly due to lack of supported interfaces, codecs (for
964 example h264/h265), and utilities. The only graphics driver is
965 X11 and the only sound driver is pulseaudio. Almost all
966 configurable omissions are applied to this build.
968 \paragraph{\CGG{} build on cygwin from source code:}
971 \item Download and install ffmpeg into /usr/local :
973 download ffmpeg (currently 4.2.2)
974 \begin{lstlisting}[style=sh]
976 tar -xJf /path/ffmpeg-4.2.2.tar.bz2
983 \item Download and install a patched libxcb:
984 \begin{lstlisting}[style=sh]
987 tar -xf /path/libxcb-1.13.tar.bz2
989 patch -p1 < /path/cinelerra-5.1/thirdparty/src/libxcb.patch1
990 patching file configure.ac
991 patching file src/xcb_in.c
997 \item Download cinelerra-gg:
998 \begin{lstlisting}[style=sh]
1000 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git"
1001 cd cinelerra-gg/cinelerra-5.1
1003 \item Apply cygwin patch:
1004 \begin{lstlisting}[style=sh]
1005 patch -p2 < blds/cygwin.patch
1007 \item Run the build with:
1008 \begin{lstlisting}[style=sh]
1013 This produces a directory: /build\_path/cinelerra-gg/cinelerra-5.1/bin
1014 which is used to create the cygcin archive.
1016 Currently, the targets are not stripped and can be run from gdb.
1017 There is only very limited signal handler dmp file support.
1018 Running gdb from inside a desktop resident console (not a cygwin64
1019 window) will hang cygwin (and cin) when it hits a breakpoint. You
1020 must run from an external console window to avoid this issue.
1022 \section{Android Tablet or Phone with TERMUX}%
1023 \label{sec:android_termux}
1026 \CGG{} can be run on Android (without audio), a non-x86 mostly posix system,
1027 tablet or phone after installing TERMUX, the \textit{terminal emulator}.
1028 You will have to do your own build using the file in Cinelerra's
1029 \texttt{blds} subdirectory, \texttt{termux.bld}.
1030 Because this is a relatively new capability and of lesser use, some
1031 additional effort may have to be exerted on your part to get it going
1032 but it is easy to get help by contacting the mailing list.
1033 In addition, there is currently no known procedure for hearing audio.
1035 \begin{figure}[htpb]
1037 \includegraphics[width=1.0\linewidth]{android.png}
1038 \caption{Screencast of an Android tablet running \CGG{} using TERMUX.}
1042 Some requirements include;
1044 \item Termux runs with X on Android 7+.
1045 \item Install takes 5 GB of internal storage. In addition you can download videos,
1046 and other files with wget to one specific location at sdcard after running termux-setup-storage
1047 inside termux (it will prompt you to give access to sdcard graphically the first time used).
1048 \item If you have empty versions of \texttt{locale.alias}, \texttt{locale.dir},
1050 \newline \texttt{\$PREFIX/share/X11/locale/en\_US.UTF-8/XLC\_LOCALE}
1051 \newline you will have to request non-empty versions via the mailing list.
1052 \item Some helpful information on installing the X environment is at:
1053 \url{https://wiki.termux.com/wiki/Graphical\_Environment}
1054 \item To prevent crashing when loading a video file that has audio, use the guide
1055 \url{https://www.reddit.com/r/termux/comments/bpa8jz/pulseaudio\_streaming\_client/}
1056 which explains vnc/pulseaudio setup.
1059 A little more about Audio is presented next because you will need to have this running
1060 in order to prevent a crash (even though you still will not be able to hear audio) -- there does not seem to be a simple PA client in termux itself.
1061 Some information is available at:
1062 \url{https://android.stackexchange.com/questions/205576/how-to-play-sound-from-termux-when-using-linux} .
1064 The next few lines show a successful setup/usage.
1065 \begin{lstlisting}[style=sh]
1066 $ pulseaudio --start
1068 PID TTY STAT TIME MAJFL TRS DRS RSS %MEM COMMAND
1069 7003 pts/28 S<s 0:00 637 532 9039 1716 0.0 /data/data/com
1070 13684 ? S<l 0:00 0 49 123898 16616 0.8 pulseaudio --
1071 13692 pts/28 R<+ 0:00 0 63 7500 1420 0.0 ps axv
1073 \begin{lstlisting}[style=sh]
1074 $ pactl load-module module-native-protocol-tcp auth-ip-acl=127.0.0.1 auth-anonymous=116
1075 $ PULSE_SERVER=127.0.0.1 pactl info
1076 Server String: 127.0.0.1
1077 Library Protocol Version: 34
1078 Server Protocol Version: 34
1083 Host Name: localhost
1084 Server Name: pulseaudio
1085 Server Version: 14.2
1086 Default Sample Specification: s16le 2ch 44100Hz
1087 Default Channel Map: front-left,front-right
1088 Default Sink: OpenSL_ES_sink
1089 Default Source: OpenSL_ES_sink.monitor
1093 Now to start up \CGG{}, type in:
1094 \begin{lstlisting}[style=sh]
1095 $ cd (your cinelerra directory)/cinelerra/cinelerra-5.1/
1096 $ PULSE_SERVER=127.0.0.1 ./cin.sh
1099 You can even build a package version similiar to Debian, just with "\texttt{pkg search} pkg\_name / \texttt{pkg install}
1100 pkg\_name" instead of "\texttt{apt search/install} pkg\_name" and with "\texttt{*-static}" instead of "\texttt{*-dev/-devel} packages".
1101 For more information on this, see:
1103 \url{https://wiki.termux.com/wiki/Package\_Management}
1104 \newline \url{https://wiki.termux.com/wiki/Building\_packages}
1106 \section{Distro with \CGG{} Included}%
1107 \label{sec:distro_with_cinelerra_included}
1108 \index{linux distro}
1110 There are also some special complete distribution systems
1111 available that include \CGG{} for audio and video production
1114 \subsection{AV Linux}
1115 \label{sec:AV_Linux}
1117 \textbf{AV Linux} is a downloadable/installable shared snapshot
1118 ISO image based on MX Linux. It provides the user an easy method to
1119 get an Audio and Video production workstation without the hassle
1120 of trying to find and install all of the usual components
1121 themselves. Of course, it includes \CGG{}!
1124 \href{http://www.bandshed.net/avlinux/}{homepage of AV Linux}.
1126 \subsection{Bodhi Linux Media}
1127 \label{sec:Bodhi_Linux}
1129 \textbf{Bodhi Linux Media} is a free and open source distribution that
1130 comes with a curated list of open source software for digital
1131 artists who work with audio, video, includes \CGG{}, games,
1132 graphics, animations, physical computing, etc.
1135 \href{https://gitlab.com/giuseppetorre/bodhilinuxmedia}{homepage of Bodhi Linux}.
1137 \subsection{DeLinuxCo}
1138 \label{sec:delinuxco}
1140 \textbf{DeLinuxCo} is a distro derived from Manjaro (so Arch based) with DE Cinammon. It is a professional workstation, mainly oriented to the multimedia field but not only. It contains many specialized programs already configured, including \CGG{}.
1142 You can read all about DeLinuxCo \href{https://www.delinuxco.com/}{here} and download \href{https://www.delinuxco.com/download/}{here}.
1147 \textbf{Elive}, or Enlightenment live CD, is a non-commercial, cost-free operating system based on Debian, and it can be used either as a live CD or an Installed system. Elive uses a customized Enlightenment desktop. It is fast, user-friendly and feature-rich and \CGG{} is included in the 64 bit version.
1149 Click \href{https://www.elivecd.org/}{Elive} for more information. The \CGG{} packages for the program
1150 and the manual are in the direcotry at
1151 \href{https://repo.bullseye.elive.elivecd.org/pool/multimedia/c/} {Bullseye version 11} and
1152 \href{http://repo.buster.elive.elivecd.org/pool/multimedia/c/}{Buster version 10} - just download
1153 the .deb files inside that directory and install via “dpkg -i “.
1155 \section{Cinx and a “Bit” of Confusion}%
1156 \label{sec:cinx_and_a_bit_of_confusion}
1159 Cinx is the exact same program as Cin. The X (x) represents the
1160 roman numeral 10 for 10-bit as opposed to 8-bit standard. The
1161 third-party library used for x265 must be specially compiled with
1162 \texttt{--bit-depth=10} in order to produce 10-bit rendered
1163 output. A cinx version can be built for most other distros if
1164 rendering at 10-bit is desirable instead of 8-bit.
1166 This build will not be able to output 8-bit depth which means you
1167 have to retain the Cin version also.
1169 Whatever build ffmpeg is linked to will determine what bit depth
1170 it can output. This is why there have to be separate builds. If
1171 you install both packages, Cin and CinX, you may get \textit{file
1172 conflicts of same file name} --- just continue.
1174 Keep in mind that the regular 8-bit version works on 8-bit bytes
1175 --- the standard word size for computers, but the 10-bit version
1176 has to use 2 words to contain all 10 bits so you can expect
1177 rendering to be as much as twice as slow.
1179 There is also a 12-bit version for consideration but currently the
1180 results are simply the same as 10-bit with padding to make 12-bit
1181 so it is of no value.
1183 \section{Multibit build for x265-8/10/12-bit}%
1184 \label{sec:multibit_build}
1187 To build a version that can handle 8 bit, or 10 bit, or 12 bit videos, a patch is provided in the \texttt{thirdparty} subdirectory that needs to be applied to do so. Be aware that the compile may take more time and seems to be about twice as long. To apply the required patch:
1189 \begin{lstlisting}[style=sh]
1190 cd /path/to/cinelerra-5.1/thirdparty
1191 patch < compile_multibit_X265.txt
1192 mv x265_3.5.patch* src/.
1194 Render formats \textit{h265-10bit} and \textit{h265-12bit} have been provided and will
1195 be operational after the applied patch is compiled in.
1197 %%% Local Variables:
1199 %%% TeX-master: "../CinelerraGG_Manual"