2 \label{cha:Installation}
5 \section{\CGG{} AppImage}%
6 \label{sec:cin_gg_appimage}
9 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.
10 A big advantage of using the AppImage format is that it is only 1/3 the size of the normal install,
11 and since each release is named differently, you can keep a number of versions in a directory,
12 and when testing from a terminal you just have to type CinGG, then hit tab, and complete it to
13 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 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:
17 Download the file from:
19 \url{https://cinelerra-gg.org/download/images/}
21 Some example file names are as follows - where 8 digits represent yyyymmdd:
23 \begin{lstlisting}[style=sh]
24 CinGG-20220131-x86_64.AppImage
25 (currently based on Fedora 32, linux kernel 5.8.15, libc version 2.31)
26 CinGG-20220131-x86_64-older-distros.AppImage
27 (currently based on Ubuntu 16.04, libc version 2.23)
28 CinGG-20220131-i686.AppImage
29 (currently based on Debian 9, linux kernel 4.9, use "newer" for Debian 11.0)
30 CinGG-20220131-i686-newer-distros.AppImage
31 (currently based on Debian 11, linux kernel 5.10)
32 CinGG-20220131-x86_64-multibit.AppImage
33 (currently based on Fedora 32, libc version 2.31)
34 CinGG-20220131-x86_64-older-distros-multibit.AppImage
35 (currently based on Fedora 29 - runs on RHEL8 - linux kernel 4.19.9, libc version 2.28)
38 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:
40 \begin{lstlisting}[style=sh]
41 $ chmod u+x CinGG-yyyymmdd.AppImage
44 Finally start the program from a window in the directory where the image is stored:
46 \begin{lstlisting}[style=sh]
47 $ ./CinGG-yyyymmdd.AppImpage
50 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
51 description of a GUI methodology for doing so in this file on the webiste:
53 \url{https://cinelerra-gg.org/download/images/README\_appimage.txt}
55 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.
57 \begin{lstlisting}[style=sh]
58 sudo pacman -S libappimage
61 And Leap 15.3 (OpenSUSE) requires installation of the \textit{appimage} package.
63 \begin{lstlisting}[style=sh]
64 sudo zypper se -is appimage
67 In addition, if you are using the OpenGL video driver, you will need to install the appropriate OpenGL
68 drivers for your Operating System graphics board because libGLU.so and other OpenGL libraries are
69 not included in the AppImage.
71 Using AppImage means you can't have the installation folder and work on the files. To unpack the AppImage and get its structure in folders and files see \nameref{sub:managing_appimage} To create, edit and manage appimages see \nameref{sub:built_appimage_scratch}.
73 \section{Download Already Built \CGG{}}%
74 \label{sec:download_already_built_cinelerra_gg}
78 \includegraphics[width=1.0\linewidth]{download-distros.png}
79 \caption{Screencast of the website Download page for installing \CGG{} for various O/S.}
80 \label{fig:download-distros}
83 All of these images are dated 10/31/2020 and are no longer being maintained. They
84 will still work on the version of the O/S in use at that time but will have none of
85 the latest features. You should use the simpler AppImage instead as described previously.
87 If you prefer to not have to take the time to build \CGG{} Infinity
88 yourself, there are pre-built dynamic or static binaries for various
89 versions of Ubuntu, Mint, Suse, Fedora, Debian, Centos, Arch, and
90 Slackware linux as well as Gentoo and FreeBSD. If you do want to build it yourself so that
91 you get the added benefit of the latest checked in changes, please reference
92 ~\ref{sec:How_to_build}.
94 A Windows 10 version installation is described in~\ref{sec:ms_windows10}. There are also 32-bit i686 Ubuntu, Debian,
95 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}.
96 They are in subdirectories of:
99 \item \href{https://cinelerra-gg.org/download/tars}{https://cinelerra-gg.org/download/tars}
100 \item \href{https://cinelerra-gg.org/download/pkgs}{https://cinelerra-gg.org/download/pkgs}
103 The \textbf{tars} \index{tars} directory contains single-user static builds for
106 This is the recommended usage of \CGG{} because all of the files
107 will exist in a single directory. Generally all of the necessary
108 libraries are built into the static build, but in some cases you may
109 have to install another library that is being called for.
111 To install the single user builds, download the designated tarball
112 from the \texttt{./tars} subdirectory and unpack as indicated below:
114 \begin{lstlisting}[style=sh]
118 tar -xJf /src/path/cinelerra-5.1-*.txz # for the *, substitute your distro tarball name
121 \emph{Do not download the LEAP 10-bit version unless you specifically want to
122 use h265 rendering to 10-bit instead of the more standard 8-bit.} For more
123 information see ~\ref{sec:cinx_and_a_bit_of_confusion}.
125 The \textbf{pkgs} \index{pkgs} directory contains the standard packaged
126 application for various distros. This will install a dynamic
127 system version for users who prefer to have the binaries in the
128 system area and for multi-user systems.
130 In addition, performing the package install checks the md5sum in
131 the file \texttt{md5sum.txt} to ensure the channel correctly
132 transmits the package. There is a
133 \href{https://cinelerra-gg.org/download/README.pkgs}{README.pkgs}
134 file in the \texttt{download} directory with instructions so you
135 can \textit{cut and paste} and avoid typos; it is also shown
138 \lstset{inputpath=extra/}
141 basicstyle=\footnotesize,
142 caption={README.pkgs}
145 \section{How to Build \CGG{} from Developer's Git Repository}%
146 \label{sec:How_to_build}
150 These are generic build instructions for building \CGG{} Infinity.
151 Known to work on Ubuntu, Mint, OpenSuse, Fedora, Debian, Centos,
152 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
153 single possible distro yet so you might expect to have to make
154 some minor changes. Also works on a somewhat limited basis on
155 FreeBSD and Windows 10 with the bsd.patch for FreeBSD and the
156 cygwin.patch for Windows 10. As of 10/31/2020, FreeBSD and Windows
157 10 builds and patches are no longer being maintained so that they
158 will work using the GIT version in use at that time but you will
159 have to create new patches for arising problems on later GITs.
161 NOTE: as of May 31, 2021 when Context Help was added, to include
162 this Context Help you will need to download the corresponding
163 tgz file containing the HTML manual sections referenced for the
164 Help pages. The file to download is:
165 \url{https://cinelerra-gg.org/download/images/HTML_Manual-20220131.tgz}
166 substituting for "20220131" the "yyyymmdd" representing latest release date.
167 Then unpack to your Cinelerra/bin/doc directory so it is included in
171 Alternatively, there are some pre-built dynamic or static binaries
172 which are updated on a fairly regular basis (as long as code changes
173 have been made) available at the link below.
175 \href{https://cinelerra-gg.org/download/}{https://cinelerra-gg.org/download/}
178 There are 2 kinds of builds, the default system-build and a
179 single-user build. A system build has results which are installed
180 to the system. The majority of the files are installed in the
181 standard system paths, but some customization is possible. The
182 single user build allows for running completely out of a local
183 user directory so it doesn't affect the system.
185 We recommend the single-user version when possible. It makes it
186 very easy to install a new version without having to delete the
187 older version in case you want it for backup -- once you are happy
188 with the new version, all you have to do is delete the entire old
189 directory path. Another reason for using single-user is that if
190 you install a new Operating System version and if you have \CGG{}
191 on separate disk space that is preserved, you won't have to
192 reinstall \CGG{}. It is also convenient for the purpose of having
193 the ability to interrupt or to see any possible error messages, if
194 you start the application from a terminal window command line
195 where you will have more control to catch problems. All that
196 said, the system builds can be useful in a university lab setting
197 where there are possibly multiple users, or multiple versions.
199 There are two notable differences between standard views
200 of \CGG{} and this implementation for the system builds. Both of
201 these can be configured during installation. The differences make
202 it possible to have several different versions installed without
203 having them interfere with each other.
206 \item application name can be set during a build but defaults
208 \item the home configuration directory can also be set and
209 traditionally defaults to: \texttt{\$HOME/.bcast5}
213 \subsection{The system build}
214 \label{sec:system-build}
217 To do a system build \index{build} , you should read the file
218 \texttt{README} that is at the top level after you get the source.
221 \item You need about 6.0 \,GB of disk storage to operate a build and
222 you need to have \textit{git} installed.
224 \item Obviously in order to install into the system, you must run as
227 \item The \textit{git:} step has to download many files (approx
228 130\,MB) so allow time. When decompressed this will expand to
231 \item Run the following commands (this takes awhile):
233 \begin{lstlisting}[style=sh]
234 # This is where you need the 6.0GB of disk space:
236 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
237 # Change to the cloned directory:
238 cd cinelerra5/cinelerra-5.1
240 NOTE: if your system has never had \CGG{} Infinity installed, you
241 will have to make sure you have all of the compilers and libraries
242 necessary. So on the very first build you should run:
244 \begin{lstlisting}[style=sh]
245 ./blds/bld_prepare.sh <os> # where <os> represents the
246 # Operating System of
247 # centos, fedora, suse, ubuntu, mint, debian.
249 ./configure --prefix=/usr # optional parameters can be added here
250 make 2>&1 | tee log # make and log the build
253 \texttt{bld\_prepare.sh} does not work for Arch Linux or Gentoo,
254 so we have to install the dependencies
255 manually. \texttt{README.arch} or \texttt{README.gentoo}, which
256 contain the list of dependencies, can be found at:
258 \item \href{https://cinelerra-gg.org/download/README.arch}{https://cinelerra-gg.org/download/README.arch}
259 \item \href{https://cinelerra-gg.org/download/README.gentoo}{https://cinelerra-gg.org/download/README.gentoo}
262 \item Check for obvious build errors:
263 \begin{lstlisting}[style=sh]
264 grep "\*\*\*.*error" -ai log
266 If this reports errors and you need assistance or you think
267 improvements can be made to the builds, email the log which is
269 \href{mailto:cin@lists.cinelerra-gg.org}{cin@lists.cinelerra-gg.org}
270 \begin{lstlisting}[style=sh]
271 /<build_path>/cinelerra5/cinelerra-5.1/log
274 \item If there are no build errors, finally just run:
275 \begin{lstlisting}[style=sh]
278 Where <os> represents the Operating System supported by \CGG{}, such
279 as centos, fedora, suse, ubuntu, mint, debian.
280 The ``with-single-user'' parameter makes it so.
281 % Make and log build (
282 Check for errors before proceeding.
285 \item If it all worked, you are all setup. Just click on the \CGG{}
290 \subsection{The single-user build}
291 \label{sec:single-user-build}
292 \index{single-user build}
295 To do a single-user build, read the file \texttt{README} that is at
296 the top level after you get the source.
299 \item You need at least 6\,GB of disk storage to operate a build +
300 you need to have “\texttt{git}” installed.
302 \item Recommend you build and run as \textbf{root}, just to avoid
303 permission issues initially.
304 \item The \textit{git} step has to download many files (approx
305 130\,MB) so allow time.
307 \item Run the following commands (this takes awhile):
308 \begin{lstlisting}[style=sh]
309 # This is where you need the 6GB of disk space
311 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
312 # Toplevel directory:
313 cd cinelerra5/cinelerra-5.1
317 NOTE: if your system has never had \CGG{} Infinity installed, you
318 will have to make sure all the compilers and libraries necessary are
319 installed. So on the very first build you should run as
322 % FIXME No novels in the listings.
323 \begin{lstlisting}[style=sh]
324 ./blds/bld_prepare.sh <os>
326 ./configure --with-single-user
330 Where <os> represents the Operating System supported by \CGG{}, such
331 as centos, fedora, suse, ubuntu, mint, debian.
332 The ``with-single-user'' parameter makes it so.
333 % Make and log build (
334 Check for errors before proceeding.
337 Then just start the application by keying in: \texttt{./cin} in the
338 bin subdirectory OR add a desktop icon by using the appropriate
339 directory to copy the files to, run as \textbf{root}, and edit to
340 correct the directory path. Below are generic directions of how to
343 Then just start the application by keying in: \texttt{./cin} in the
344 bin subdirectory OR add a desktop icon by using the appropriate
345 directory to copy the files to, run as \textbf{root}, and edit to
346 correct the directory path. Below are generic directions of how to
349 \begin{lstlisting}[style=sh]
350 cd /cinelerra_directory_path
351 cp -a image/cin.{svg,xpm} /usr/share/pixmaps/
352 cp -a image/cin.desktop /usr/share/applications/cin.desktop
355 After you have followed the above, in the cin.desktop file, change
356 the \texttt{Exec=cin} line to be
357 \texttt{Exec=<your\_directory\_path>/bin/cin}.
359 The preceding directions for doing a single-user build may work
360 without being root on some distros except for the \texttt{bld\_prepare.sh}
361 and creating the desktop icon. For example in Arch Linux installing without being root
362 works using the following steps:
364 \begin{lstlisting}[style=sh]
365 $ git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
366 $ cd /home/USER/cinelerra5/cinelerra-5.1
368 $ ./configure --prefix=/usr --with-single-user --with-booby
369 $ make 2>&1 | tee /tmp/cin5.log && make install
373 \subsection{Notable Options and Caveats}%
374 \label{sub:notable_options_and_caveats}
377 These procedures and the \CGG{} Infinity software have all been run
378 as \textbf{root} on various home laptops and desktops. This provides
379 the best chance to ensure all works correctly and also allows for
380 handling errors, other problems and potential crashes with the most
381 success. Included in this section are some of the build variations
382 easily available for normal builds.
384 To see the full list of features use:
386 \begin{lstlisting}[style=sh]
389 The default build \index{build} is a system build which uses:
391 \begin{lstlisting}[style=sh]
392 ./configure --without-single-user
395 In the single-user build \index{single-user build}, the target directory is always
396 \texttt{cin}. Because this is also the developer build, constant
397 names are used throughout. However, you can rename files after the
400 If your operating system has issues with the default install to
401 \texttt{/usr/local}, you might have to change the location to
402 \texttt{/usr} for a system build. Then you will have to use:
403 \begin{lstlisting}[style=sh]
404 ./configure --prefix=/usr
407 If you wish to change the default directory for a system build you
408 will have to add the destination directory path on the \texttt{make
409 install} line. For example:
410 \begin{lstlisting}[style=sh]
411 make install DESTDIR=<your selected target directory path>
414 The application name can be set during installation, but defaults to
415 \texttt{cin} so that the GG/Infinity build can coexist with other
416 \CGG{} builds if necessary. To override the default \texttt{cin}
418 \begin{lstlisting}[style=sh]
419 ./configure --with-exec-name=cinelerra
422 The home configuration directory can also be set, but default
423 location is traditionally \texttt{\$HOME/.bcast5}. For example:
425 \begin{lstlisting}[style=sh]
426 ./configure -with-config-dir=/myusername/.bcast5
429 NOTE: when you specify parameters to the configure program, it will
430 create a \texttt{make} file as a consequence. Since in a
431 \texttt{make} file, the \$ is a special character, it must be
432 escaped so in order to represent a \$ as part of an input parameter,
433 it has to be stuttered. That is, you will need \$\$ (2 dollar
434 signs) to represent a single dollar sign.
436 It may be necessary on some distros which have missing or incomplete
437 up-to-date libraries, to build \CGG{} without Ladspa. To do so,
440 \begin{lstlisting}[style=sh]
441 ./configure --prefix=/usr --without-ladspa-build
444 Note that the with-ladspa-dir is the ladspa search path, and
445 exists even if the ladspa build is not selected. This gives you
446 the ability to specify an alternate ladspa system path by
447 utilizing the \texttt{LADSPA\_PATH} environment variable (that is,
448 the default ladspa build is deselected).
450 Note for 32-bit 14.2 Slackware, Debian, Gentoo, Arch, FreeBSD,
451 before running the configure, you will need to set up the following:
453 \begin{lstlisting}[style=sh]
454 export ac_cv_header_xmmintrin_h=no
455 export FFMPEG_EXTRA_CFG=" --disable-vdpau"
458 Note for building 32-bit packages on hybrid 32/64 x86 systems, you may
459 need to add the following:
461 \begin{lstlisting}[style=sh]
462 setarch i686 (befire configure and package build)
465 NOTE: as of May 31, 2021 when Context Help was added, to include
466 this Context Help you will need to download the corresponding
467 tgz file containing the HTML manual sections referenced for the
468 Help pages. The file to download is:
469 \url{https://cinelerra-gg.org/download/images/HTML_Manual-20220131.tgz}
470 substituting for "20220131" the "yyyymmdd" representing latest release date.
471 Then unpack to your Cinelerra/bin/doc directory so it is included in
472 your built system. The reason for not including the HTML manual in
473 the source code so that it would already be there, is because it is
474 very large and has its own GIT base.
476 \subsection{Notes about Building from Git in your Customized Environment}%
477 \label{sub:notes_about_building_from_git_in_your_customized_environment}
482 Getting a build to work in a custom environment is not easy. If you
483 have already installed libraries which are normally in the
484 thirdparty build, getting them to be recognized means you have to
485 install the \textit{devel} version so the header files which match
486 the library interfaces exist. Below is the list of thirdparty
487 builds, but this list may have changed over time.
488 % It's list of Table?
492 \begin{longtable}{m{8em} c}
493 \caption{List of thirdparty builds}
494 \label{tab:List_of_thirdparty_builds}\\
537 The \textit{yes} means force build and \textit{auto} means probe and
538 use the system version if the build operation is not static. To get
539 your customized build to work, you need to change the probe options
540 for the conflicting libraries from \textit{yes} to \textit{auto}, or
541 even rework the \texttt{configure.ac} script. There may be several
542 libraries which need special treatment.
544 An example of a problem you might encounter with your customized
545 installation is with \texttt{a52dec} which has probes line
546 \texttt{(CHECK\_LIB/CHECK\_HEADERS)} in \texttt{configure.ac}, but
547 \texttt{djbfft} does not. In this case, \texttt{djbfft} is only
548 built because \texttt{a52dec} is built, so if your system has
549 \texttt{a52dec}, set \texttt{a52dec} to auto and see if that
550 problem is solved by retrying the build with:
551 \begin{lstlisting}[style=sh]
552 ./confgure --with-single-user -enable-a52dec=auto .
555 With persistence, you can get results, but it may take several tries
556 to stabilize the build. If you need help, email the \texttt{log}
557 and \texttt{config.log}, which is usually sufficient to determine
560 If you have already installed the \texttt{libfdk\_aac} development
561 package on your computer because you prefer this version over the
562 default aac, you will have to do the following to get this
563 alternative operational. The libfdk\_aac library is not a part of
564 \CGG{} by default because it is not license free.
566 \begin{lstlisting}[style=sh]
567 export FFMPEG_EXTRA_CFG=" --enable-libfdk-aac --enable-nonfree"
568 export EXTRA_LIBS=" -lfdk-aac"
569 for f in `grep -lw aac cinelerra-5.1/ffmpeg/audio/*`; do
570 sed -e 's/\<aac\>/libfdk_aac/' -i $f
575 \subsection{Cloning the Repository for Faster Updates}%
576 \label{sub:cloning_the_repository_for_faster_updates}
580 If you want to avoid downloading the software every time an update
581 is available you need to create a local ``repository'' or repo. The
582 repo is a directory where you first do a \texttt{git clone}. For
583 the initial git clone, set up a local area for the repository
584 storage, referred to as \texttt{<repo\_path>}. The \texttt{git
585 clone} creates a repo named \texttt{cin5} in the
586 \texttt{/<repo\_path>/} directory. This accesses about 530\,MB of
587 repo data, so the device has to have at least that available. The
588 repo path is always a perfect clone of the main repo.
591 \paragraph{Setting up the initial clone}%
592 \label{par:setting_up_the_initial_clone}
594 You may want to add ``\verb|--depth 1|'' before \texttt{cin5}
595 because this will clone faster and is smaller, but has no history.
597 \begin{lstlisting}[style=sh]
599 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra" cin5
601 Cloning into "cin5"...
602 remote: Counting objects: 20032, done.
603 remote: Compressing objects: 100% (11647/11647), done.
604 remote: Total 20032 (delta 11333), reused 16632 (delta 8189)
605 Receiving objects: 100% (20032/20032), 395.29 MiB | 3.26 MiB/s, done.
606 Resolving deltas: 100% (11333/11333), done.
607 Checking connectivity... done.
611 \paragraph{Update an existing repo}%
612 \label{par:update_an_existing_repo}
613 The below shows how you can get updates.
615 \begin{lstlisting}[style=sh]
621 \paragraph{Useful git commands}%
622 \label{par:useful_git_commands}
623 Some other commands that are useful.
625 \begin{lstlisting}[style=sh]
626 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cin5
627 git pull # pull remote changes to the local version
628 git status # shows changed files
629 git clean -i # interactive clean, use answer 1 to "clean"
633 \subsection{How to Build from a Previous GIT Version}%
634 \label{sub:how_to_build_from_a_previous_git_version}
639 If you have a problem with the current GIT version, you can revert
640 to a previous working version easily. The commands to use will be
641 similar to these next lines which are then explained in more detail.
644 \begin{lstlisting}[style=sh]
645 cd /<path>/cin5 # substitute your repo path name for cin5
646 git log # shows a list of versions depending on history depth specification
647 git checkout <version> # choose a version number as listed
650 The \texttt{git log} command produces a log file with hash values
651 for commit keys to the level specifed if the the depth paramter
653 The hash ids are the commit names to use when you
654 use git checkout. Next is displayed sample output:
656 \begin{lstlisting}[style=nil]
657 delete stray line in last checkin
659 commit 4a90ef3ae46465c0634f81916b79e279e4bd9961
660 Author: Good Guy <good1.2guy@gmail.com>
661 Date: Thu Feb 22 14:56:45 2018 -0700
663 nested clips, big rework and cleanup, sams new icons,
666 commit f87479bd556ea7db4afdd02297fc00977412b873
667 Author: Good Guy <good1.2guy@gmail.com>
668 Date: Sat Feb 17 18:09:22 2018 -0700
671 For the \texttt{git checkout <version>}, you would then keyin the
672 line below for the following results:
674 \begin{lstlisting}[style=nil]
675 git checkout f87479bd556ea7db4afdd02297fc00977412b873
677 Note: checking out 'f87479bd556ea7db4afdd02297fc00977412b873'.
679 You are in 'detached HEAD' state. You can look around, make
680 experimental changes and commit them, and you can discard any
681 commits you make in this state without impacting any branches by
682 performing another checkout.
684 If you want to create a new branch to retain commits you create,
685 you may do so (now or later) by using -b with the checkout command
688 git checkout -b <new-branch-name>
690 HEAD is now at f87479bd... more file size icon updates,
691 and more to followend
694 Later to get the repo back to current, use:
695 \begin{lstlisting}[style=sh]
700 \subsection{Debuggable Single User Build}%
701 \label{sub:debuggable_single_user_build}
702 \index{single-user build}
705 To build from source with full debugging symbols, first build a full
706 static (non\_debug) build as follows but instead of using
707 \texttt{/tmp} substitute your permanent disk path if you want to
710 \begin{lstlisting}[style=sh]
712 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
713 cp -a /<repo_path>/cinelerra-5.1 /tmp/
714 cd /tmp/cinelerra-5.1
718 Then, to run as a developer in the debugger:
720 \begin{lstlisting}[style=sh]
721 CFLAGS="-O2 -ggdb" make -j8 rebuild_all
727 \subsection{Unbundled Builds}%
728 \label{sub:unbundled_builds}
733 There are some generic build scripts included in the \CGG{} GIT
734 repository for users who want to do unbundled builds with ffmpeg
735 already available on their system. This has been tested on Arch,
736 Ubuntu 18, FreeBSD, Windows10 and Leap 15 (rpm) at the time this
739 The names of the build scripts are: \texttt{arch.bld},
740 \texttt{bsd.bld}, \texttt{deb.bld}, \texttt{rpm.bld}, and
741 \texttt{cygwin.bld}. These scripts are in the \texttt{blds}
742 subdirectory. The \texttt{bsd.bld} should be used with the
743 \texttt{bsd.patch} file in that same directory. The
744 \texttt{cygwin.bld} should be used with the \texttt{cygwin.patch}
745 file in that same directory.
747 The reason that Cin Infinity traditionally uses its own thirdparty builds
748 (bundled builds) is because there are a lot of different distros
749 with varying levels of ffmpeg and other needed thirdparty
750 libraries. However, some users prefer using their current system
751 baseline without another/different copy of ffmpeg.
753 With different levels of the user’s libraries, uncertainty,
754 potential instability, and unknown issues may come up while
755 running \CGG{} and this will make it, for all practical purposes,
756 impossible to diagnose and debug problems or crashes.
758 There may be no help in these cases. You are encouraged to report
759 any errors which potentially originate from Cin Infinity, but if
760 the data indicates alternate library sources, please report the
761 problems to the appropriate maintainers.
763 With the unbundled builds, some features may not be available and
764 no attempt to comment them out has been made. So if you use a
765 pulldown, or pick a render option, or choose something that is not
766 available, it just will not work. For example, unless special
767 options were set up by you, the LV2 audio plugins will not be
768 available. Nor will the codec libzmpeg, the file codec ac3, or
769 DVD creation. The old school file classes will all work, but some
770 of the formats that come with ffmpeg may not because of the way
771 that ffmpeg was installed on your operating system. That is
772 because the \CGG{} included ffmpeg is a known static build and is
773 usually the latest stable/released version. For example, in the
774 current case of Leap 15, libx264 and libx265 are not built in and
775 this can be debilitating; you can always run \texttt{ffmpeg
776 -formats} and \texttt{ffmpeg -codecs} to see what is available
779 \section{Building the HTML Manual for Context Help}%
780 \label{sec:building_the_manual}
783 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.
785 The steps are as follows:
787 \item Download the manual in LaTeX:
789 \begin{lstlisting}[style=sh]
790 git clone "git://git.cinelerra-gg.org/goodguy/cin-manual-latex.git" master
793 \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):
794 \begin{lstlisting}[style=sh]
798 The steps that this script performs are as follows:
800 \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.
802 \begin{lstlisting}[style=sh]
803 pdflatex CinelerraGG_Manual.tex
804 makeindex CinelerraGG_Manual.idx
805 pdflatex CinelerraGG_Manual.tex
806 makeindex CinelerraGG_Manual.nlo -s nomencl.ist -o CinelerraGG_Manual.nls
807 pdflatex CinelerraGG_Manual.tex
810 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.
811 \item Next, to produce HTML output the script then moves (renames) \texttt{latex 2html-init} to \texttt{.latex2html-init} (starting with dot).
813 \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.
816 \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.
818 \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.
821 \section{Windows 10 with Cygwin for \CGG{} Limited}%
822 \label{sec:ms_windows10}
825 As of 10/31/2020, this is no longer being maintained. It should
826 still work using an older GIT version with Windows 10 but it is
827 possible with some effort to modify the patch file to work with the
830 To run \CGG{} on a Windows 10 computer, you will need to have
831 Cygwin installed on your system, along with the \CGG{} static tar
832 and a patched library: libxcb. This setup has been tested with
833 Windows 10, version 1909, on an HP EliteBook 820 at 2.3 GHz.
835 This limited version provides \textit{core} functionality at this
836 time with the standard Windows FFmpeg executable, meaning that
837 specific modifications in FFmpeg needed for \CGG{} are not
838 available. Limited capabilities include only a few render output
839 formats available - for example \textit{mov}, \textit{qt} as
840 \textit{mjpeg}, and \textit{mpeg} for videos and \textit{avi} and
841 \textit{qt} as \textit{s16le} for audio, but not \textit{mkv} or
842 \textit{mp4}. This is due to the fact that several codec and
843 utility libraries are not currently compiled to work with Windows.
845 \subsection*{Installing Cygwin}
846 \label{sec:installing_cygwin}
849 Cygwin is an environment that runs natively on Windows which
850 allows Unix programs to be compiled and run on Windows. With
851 cygwin installed on your Windows 10 computer, you will be able to
852 run \CGG{}. Before installing cygwin, you need to be warned that
853 the Avast anti-virus software kills files necessary for cygwin
854 installation and execution, so you will have to remove it and use
855 alternative anti-virus software (the standard default already
856 included with Windows 10 is Defender). Below are the steps for
860 \item Download cygwin for your 64-bit computer at:
861 \href{https://www.cygwin.com/}{https://www.cygwin.com/}
863 \item Generally just take the defaults as they show up, but the
864 next steps show what comes up.
866 \item When a warning window pops up, click \textit{Yes}.
868 \item Click \textit{Next}.
870 \item Choose \textit{Install from Internet} option and then click
873 \item Choose your desired directory by clicking on Browse
874 button. Choose \textit{All Users (Recommended)} and then click
877 \item Choose the local package directory where you would like your
878 installation files to be placed. Click \textit{Next}.
880 \item Choose \textit{Direct Connection} if you are using Internet
881 with plug and play device. Click \textit{Next}.
883 \item Choose any download site preferably
884 ``cygwin.mirror.constant.com'' and then click \textit{Next}.
886 \item For list of things to install, leave all set to
887 \textit{Default} except these to \textit{Install} instead:
896 This install takes a long time; approximately 2 hours on an
897 EliteBook and requires approximately 20GB storage.
899 \item Finally you will want to have the icons on your desktop
900 (already default) and then click \textit{Finish}.
903 Then to install the \CGG{} tar files, you will need to start a
904 cygwin console terminal from the startup menu as shown here:
905 \texttt{Start $\rightarrow$ Cygwin $\rightarrow$ Cygwin64}
908 \subsection*{Installing \CGG{}}
909 \label{sec:installing_cinelerra}
912 \item Download the tar file
913 \href{https://cinelerra-gg.org/download/testing/libxcb-bld.tar.bz2}{libxcb-bld.tar.bz2}.
915 \item Install libxcb from the tar file -- installs into
916 \texttt{/usr/local} and requires approximately 21MB storage.
917 \begin{lstlisting}[style=sh]
918 tar -C /usr/local -xJf /path/libxcb-bld.tar.bz2
920 The libxcb patch repairs an error (XIOError), which stops
923 \item Download the tar file
924 \href{https://cinelerra-gg.org/download/testing/cygcin-bld.tar.bz2}{cygcin-bld.tar.bz2}.
926 \item Install cygcin from the tar file - this installs into home
927 directory. Note this is cygcin \emph{not} cygwin. You must change the
928 \texttt{path} below to the name of the path where you downloaded
930 \begin{lstlisting}[style=sh]
932 tar -xJf /path/cygcin-bld.tar.bz2
936 This creates \texttt{\~{}/cygcin}, a user build installation of
937 \CGG{} and requires approximately 400MB storage.
939 \paragraph{Running \CGG{}:}
940 You will need to start a cygwin desktop from the startup menu:
942 \item \texttt{Start$\rightarrow$ Cygwin-X $\rightarrow$ Openbox}
944 You should start a console controlling terminal so that you can
947 \item \texttt{Start$\rightarrow$ Cygwin $\rightarrow$ Cygwin64} Terminal
949 This opens a separate window that can survive a cygwin hang and
950 bugs. Without these logs, it is much more difficult to use.
952 \item Type into that console controlling window, the following:
953 \begin{lstlisting}[style=sh]
957 \item Change directories to where \CGG{} is installed:
958 \begin{lstlisting}[style=sh]
959 cd /path/cygcin (NOT cygwin)
963 \begin{lstlisting}[style=sh]
966 which starts up your 4 \CGG{} windows.
969 The most noticeable difference from the Linux versions is that
970 \CGG{} seems to run very slowly on Windows 10. You must be very
971 tolerant and patient to see this work. It can however exhibit
972 astonishing speed when encoding. \CGG{} has to be downgraded
973 significantly due to lack of supported interfaces, codecs (for
974 example h264/h265), and utilities. The only graphics driver is
975 X11 and the only sound driver is pulseaudio. Almost all
976 configurable omissions are applied to this build.
978 \paragraph{\CGG{} build on cygwin from source code:}
981 \item Download and install ffmpeg into /usr/local :
983 download ffmpeg (currently 4.2.2)
984 \begin{lstlisting}[style=sh]
986 tar -xJf /path/ffmpeg-4.2.2.tar.bz2
993 \item Download and install a patched libxcb:
994 \begin{lstlisting}[style=sh]
997 tar -xf /path/libxcb-1.13.tar.bz2
999 patch -p1 < /path/cinelerra-5.1/thirdparty/src/libxcb.patch1
1000 patching file configure.ac
1001 patching file src/xcb_in.c
1007 \item Download cinelerra-gg:
1008 \begin{lstlisting}[style=sh]
1010 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git"
1011 cd cinelerra-gg/cinelerra-5.1
1013 \item Apply cygwin patch:
1014 \begin{lstlisting}[style=sh]
1015 patch -p2 < blds/cygwin.patch
1017 \item Run the build with:
1018 \begin{lstlisting}[style=sh]
1023 This produces a directory: /build\_path/cinelerra-gg/cinelerra-5.1/bin
1024 which is used to create the cygcin archive.
1026 Currently, the targets are not stripped and can be run from gdb.
1027 There is only very limited signal handler dmp file support.
1028 Running gdb from inside a desktop resident console (not a cygwin64
1029 window) will hang cygwin (and cin) when it hits a breakpoint. You
1030 must run from an external console window to avoid this issue.
1032 \section{Android Tablet or Phone with TERMUX}%
1033 \label{sec:android_termux}
1036 \CGG{} can be run on Android (without audio), a non-x86 mostly posix system,
1037 tablet or phone after installing TERMUX, the \textit{terminal emulator}.
1038 You will have to do your own build using the file in Cinelerra's
1039 \texttt{blds} subdirectory, \texttt{termux.bld}.
1040 Because this is a relatively new capability and of lesser use, some
1041 additional effort may have to be exerted on your part to get it going
1042 but it is easy to get help by contacting the mailing list.
1043 In addition, there is currently no known procedure for hearing audio.
1045 \begin{figure}[htpb]
1047 \includegraphics[width=1.0\linewidth]{android.png}
1048 \caption{Screencast of an Android tablet running \CGG{} using TERMUX.}
1052 Some requirements include;
1054 \item Termux runs with X on Android 7+.
1055 \item Install takes 5 GB of internal storage. In addition you can download videos,
1056 and other files with wget to one specific location at sdcard after running termux-setup-storage
1057 inside termux (it will prompt you to give access to sdcard graphically the first time used).
1058 \item If you have empty versions of \texttt{locale.alias}, \texttt{locale.dir},
1060 \newline \texttt{\$PREFIX/share/X11/locale/en\_US.UTF-8/XLC\_LOCALE}
1061 \newline you will have to request non-empty versions via the mailing list.
1062 \item Some helpful information on installing the X environment is at:
1063 \url{https://wiki.termux.com/wiki/Graphical\_Environment}
1064 \item To prevent crashing when loading a video file that has audio, use the guide
1065 \url{https://www.reddit.com/r/termux/comments/bpa8jz/pulseaudio\_streaming\_client/}
1066 which explains vnc/pulseaudio setup.
1069 A little more about Audio is presented next because you will need to have this running
1070 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.
1071 Some information is available at:
1072 \url{https://android.stackexchange.com/questions/205576/how-to-play-sound-from-termux-when-using-linux} .
1074 The next few lines show a successful setup/usage.
1075 \begin{lstlisting}[style=sh]
1076 $ pulseaudio --start
1078 PID TTY STAT TIME MAJFL TRS DRS RSS %MEM COMMAND
1079 7003 pts/28 S<s 0:00 637 532 9039 1716 0.0 /data/data/com
1080 13684 ? S<l 0:00 0 49 123898 16616 0.8 pulseaudio --
1081 13692 pts/28 R<+ 0:00 0 63 7500 1420 0.0 ps axv
1083 \begin{lstlisting}[style=sh]
1084 $ pactl load-module module-native-protocol-tcp auth-ip-acl=127.0.0.1 auth-anonymous=116
1085 $ PULSE_SERVER=127.0.0.1 pactl info
1086 Server String: 127.0.0.1
1087 Library Protocol Version: 34
1088 Server Protocol Version: 34
1093 Host Name: localhost
1094 Server Name: pulseaudio
1095 Server Version: 14.2
1096 Default Sample Specification: s16le 2ch 44100Hz
1097 Default Channel Map: front-left,front-right
1098 Default Sink: OpenSL_ES_sink
1099 Default Source: OpenSL_ES_sink.monitor
1103 Now to start up \CGG{}, type in:
1104 \begin{lstlisting}[style=sh]
1105 $ cd (your cinelerra directory)/cinelerra/cinelerra-5.1/
1106 $ PULSE_SERVER=127.0.0.1 ./cin.sh
1109 You can even build a package version similiar to Debian, just with "\texttt{pkg search} pkg\_name / \texttt{pkg install}
1110 pkg\_name" instead of "\texttt{apt search/install} pkg\_name" and with "\texttt{*-static}" instead of "\texttt{*-dev/-devel} packages".
1111 For more information on this, see:
1113 \url{https://wiki.termux.com/wiki/Package\_Management}
1114 \newline \url{https://wiki.termux.com/wiki/Building\_packages}
1116 \section{Distro with \CGG{} Included}%
1117 \label{sec:distro_with_cinelerra_included}
1118 \index{linux distro}
1120 There are also some special complete distribution systems
1121 available that include \CGG{} for audio and video production
1124 \subsection{AV Linux}
1125 \label{sec:AV_Linux}
1127 \textbf{AV Linux} is a downloadable/installable shared snapshot
1128 ISO image based on MX Linux. It provides the user an easy method to
1129 get an Audio and Video production workstation without the hassle
1130 of trying to find and install all of the usual components
1131 themselves. Of course, it includes \CGG{}!
1134 \href{http://www.bandshed.net/avlinux/}{homepage of AV Linux}.
1136 \subsection{Bodhi Linux Media}
1137 \label{sec:Bodhi_Linux}
1139 \textbf{Bodhi Linux Media} is a free and open source distribution that
1140 comes with a curated list of open source software for digital
1141 artists who work with audio, video, includes \CGG{}, games,
1142 graphics, animations, physical computing, etc.
1145 \href{https://gitlab.com/giuseppetorre/bodhilinuxmedia}{homepage of Bodhi Linux}.
1147 \subsection{DeLinuxCo}
1148 \label{sec:delinuxco}
1150 \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{}.
1152 You can read all about DeLinuxCo \href{https://www.delinuxco.com/}{here} and download \href{https://www.delinuxco.com/download/}{here}.
1157 \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 both the 64 bit and 32 bit versions.
1159 Click \href{https://www.elivecd.org/}{Elive} for more information. The \CGG{} packages for the program
1160 and the manual are in the direcotry at
1161 \href{https://repo.bullseye.elive.elivecd.org/pool/multimedia/c/} {Bullseye version 11} and
1162 \href{http://repo.buster.elive.elivecd.org/pool/multimedia/c/}{Buster version 10} - just download
1163 the .deb files inside that directory and install via “dpkg -i “.
1165 \section{Cinx and a “Bit” of Confusion}%
1166 \label{sec:cinx_and_a_bit_of_confusion}
1169 Cinx is the exact same program as Cin. The X (x) represents the
1170 roman numeral 10 for 10-bit as opposed to 8-bit standard. The
1171 third-party library used for x265 must be specially compiled with
1172 \texttt{--bit-depth=10} in order to produce 10-bit rendered
1173 output. A cinx version can be built for most other distros if
1174 rendering at 10-bit is desirable instead of 8-bit.
1176 This build will not be able to output 8-bit depth which means you
1177 have to retain the Cin version also.
1179 Whatever build ffmpeg is linked to will determine what bit depth
1180 it can output. This is why there have to be separate builds. If
1181 you install both packages, Cin and CinX, you may get \textit{file
1182 conflicts of same file name} --- just continue.
1184 Keep in mind that the regular 8-bit version works on 8-bit bytes
1185 --- the standard word size for computers, but the 10-bit version
1186 has to use 2 words to contain all 10 bits so you can expect
1187 rendering to be as much as twice as slow.
1189 There is also a 12-bit version for consideration but currently the
1190 results are simply the same as 10-bit with padding to make 12-bit
1191 so it is of no value.
1193 \section{Multibit build for x265-8/10/12-bit}%
1194 \label{sec:multibit_build}
1197 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:
1199 \begin{lstlisting}[style=sh]
1200 cd /path/to/cinelerra-5.1/thirdparty
1201 patch < compile_multibit_X265.txt
1202 mv x265_3.5.patch* src/.
1204 Render formats \textit{h265-10bit} and \textit{h265-12bit} have been provided and will
1205 be operational after the applied patch is compiled in.
1207 %%% Local Variables:
1209 %%% TeX-master: "../CinelerraGG_Manual"