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 latest distros and
15 definitely does now work on Debian version 11.00 (most of the popular Linux distributions such
16 as Arch, Ubuntu, and Fedora have dropped support for this older architecture). 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, does not work on Debian 11.0)
31 CinGG-20210731-x86_64-multibit.AppImage
32 (currently based on Fedora Core 32, libc version 2.31)
35 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:
37 \begin{lstlisting}[style=sh]
38 $ chmod u+x CinGG-yyyymmdd.AppImage
41 Finally start the program from a window in the directory where the image is stored:
43 \begin{lstlisting}[style=sh]
44 $ ./CinGG-yyyymmdd.AppImpage
47 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
48 description of a GUI methodology for doing so in this file on the webiste:
50 \url{https://cinelerra-gg.org/download/images/README\_appimage.txt}
52 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.
54 \begin{lstlisting}[style=sh]
55 sudo pacman -S libappimage
58 And Leap 15.3 (OpenSUSE) requires installation of the \textit{appimage} package.
60 \begin{lstlisting}[style=sh]
61 sudo zypper se -is appimage
64 In addition, if you are using the OpenGL video driver, you will need to install the appropriate OpenGL
65 drivers for your Operating System graphics board because libGLU.so and other OpenGL libraries are
66 not included in the AppImage.
68 \section{Download Already Built \CGG{}}%
69 \label{sec:download_already_built_cinelerra_gg}
73 \includegraphics[width=1.0\linewidth]{download-distros.png}
74 \caption{Screencast of the website Download page for installing \CGG{} for various O/S.}
75 \label{fig:download-distros}
78 All of these images are dated 10/31/2020 and are no longer being maintained. They
79 will still work on the version of the O/S in use at that time but will have none of
80 the latest features. You should use the simpler AppImage instead as described previously.
82 If you prefer to not have to take the time to build \CGG{} Infinity
83 yourself, there are pre-built dynamic or static binaries for various
84 versions of Ubuntu, Mint, Suse, Fedora, Debian, Centos, Arch, and
85 Slackware linux as well as Gentoo and FreeBSD. If you do want to build it yourself so that
86 you get the added benefit of the latest checked in changes, please reference
87 ~\ref{sec:How_to_build}.
89 A Windows 10 version installation is described in~\ref{sec:ms_windows10}. There are also 32-bit i686 Ubuntu, Debian,
90 and Slackware versions available. \textbf{These binaries are no longer being updated; they are stable and working but without future functionality}.
91 They are in subdirectories of:
94 \item \href{https://cinelerra-gg.org/download/tars}{https://cinelerra-gg.org/download/tars}
95 \item \href{https://cinelerra-gg.org/download/pkgs}{https://cinelerra-gg.org/download/pkgs}
98 The \textbf{tars} \index{tars} directory contains single-user static builds for
101 This is the recommended usage of \CGG{} because all of the files
102 will exist in a single directory. Generally all of the necessary
103 libraries are built into the static build, but in some cases you may
104 have to install another library that is being called for.
106 To install the single user builds, download the designated tarball
107 from the \texttt{./tars} subdirectory and unpack as indicated below:
109 \begin{lstlisting}[style=sh]
113 tar -xJf /src/path/cinelerra-5.1-*.txz # for the *, substitute your distro tarball name
116 \emph{Do not download the LEAP 10-bit version unless you specifically want to
117 use h265 rendering to 10-bit instead of the more standard 8-bit.} For more
118 information see ~\ref{sec:cinx_and_a_bit_of_confusion}.
120 The \textbf{pkgs} \index{pkgs} directory contains the standard packaged
121 application for various distros. This will install a dynamic
122 system version for users who prefer to have the binaries in the
123 system area and for multi-user systems.
125 In addition, performing the package install checks the md5sum in
126 the file \texttt{md5sum.txt} to ensure the channel correctly
127 transmits the package. There is a
128 \href{https://cinelerra-gg.org/download/README.pkgs}{README.pkgs}
129 file in the \texttt{download} directory with instructions so you
130 can \textit{cut and paste} and avoid typos; it is also shown
133 \lstset{inputpath=extra/}
136 basicstyle=\footnotesize,
137 caption={README.pkgs}
140 \section{How to Build \CGG{} from Developer's Git Repository}%
141 \label{sec:How_to_build}
145 These are generic build instructions for building \CGG{} Infinity.
146 Known to work on Ubuntu, Mint, OpenSuse, Fedora, Debian, Centos,
147 Arch, Slackware, and Gentoo. It has not been tested on every
148 single possible distro yet so you might expect to have to make
149 some minor changes. Also works on a somewhat limited basis on
150 FreeBSD and Windows 10 with the bsd.patch for FreeBSD and the
151 cygwin.patch for Windows 10. As of 10/31/2020, FreeBSD and Windows
152 10 builds and patches are no longer being maintained so that they
153 will work using the GIT version in use at that time but you will
154 have to create new patches for arising problems on later GITs.
156 NOTE: as of May 31, 2021 when Context Help was added, to include
157 this Context Help you will need to download the corresponding
158 tgz file containing the HTML manual sections referenced for the
159 Help pages. The file to download is:
160 \url{https://cinelerra-gg.org/download/images/HTML_Manual-20210531.tgz}
161 substituting for "20210531" the "yyyymmdd" representing latest release date.
162 Then unpack to your Cinelerra/bin/doc directory so it is included in
166 Alternatively, there are some pre-built dynamic or static binaries
167 which are updated on a fairly regular basis (as long as code changes
168 have been made) available at the link below.
170 \href{https://cinelerra-gg.org/download/}{https://cinelerra-gg.org/download/}
173 There are 2 kinds of builds, the default system-build and a
174 single-user build. A system build has results which are installed
175 to the system. The majority of the files are installed in the
176 standard system paths, but some customization is possible. The
177 single user build allows for running completely out of a local
178 user directory so it doesn't affect the system.
180 We recommend the single-user version when possible. It makes it
181 very easy to install a new version without having to delete the
182 older version in case you want it for backup -- once you are happy
183 with the new version, all you have to do is delete the entire old
184 directory path. Another reason for using single-user is that if
185 you install a new Operating System version and if you have \CGG{}
186 on separate disk space that is preserved, you won't have to
187 reinstall \CGG{}. It is also convenient for the purpose of having
188 the ability to interrupt or to see any possible error messages, if
189 you start the application from a terminal window command line
190 where you will have more control to catch problems. All that
191 said, the system builds can be useful in a university lab setting
192 where there are possibly multiple users, or multiple versions.
194 There are two notable differences between standard views
195 of \CGG{} and this implementation for the system builds. Both of
196 these can be configured during installation. The differences make
197 it possible to have several different versions installed without
198 having them interfere with each other.
201 \item application name can be set during a build but defaults
203 \item the home configuration directory can also be set and
204 traditionally defaults to: \texttt{\$HOME/.bcast5}
208 \subsection{The system build}
209 \label{sec:system-build}
212 To do a system build \index{build} , you should read the file
213 \texttt{README} that is at the top level after you get the source.
216 \item You need about 6.0 \,GB of disk storage to operate a build and
217 you need to have \textit{git} installed.
219 \item Obviously in order to install into the system, you must run as
222 \item The \textit{git:} step has to download many files (approx
223 130\,MB) so allow time. When decompressed this will expand to
226 \item Run the following commands (this takes awhile):
228 \begin{lstlisting}[style=sh]
229 # This is where you need the 6.0GB of disk space:
231 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
232 # Change to the cloned directory:
233 cd cinelerra5/cinelerra-5.1
235 NOTE: if your system has never had \CGG{} Infinity installed, you
236 will have to make sure you have all of the compilers and libraries
237 necessary. So on the very first build you should run:
239 \begin{lstlisting}[style=sh]
240 ./blds/bld_prepare.sh <os> # where <os> represents the
241 # Operating System of
242 # centos, fedora, suse, ubuntu, mint, debian.
244 ./configure --prefix=/usr # optional parameters can be added here
245 make 2>&1 | tee log # make and log the build
248 \texttt{bld\_prepare.sh} does not work for Arch Linux or Gentoo,
249 so we have to install the dependencies
250 manually. \texttt{README.arch} or \texttt{README.gentoo}, which
251 contain the list of dependencies, can be found at:
253 \item \href{https://cinelerra-gg.org/download/README.arch}{https://cinelerra-gg.org/download/README.arch}
254 \item \href{https://cinelerra-gg.org/download/README.gentoo}{https://cinelerra-gg.org/download/README.gentoo}
257 \item Check for obvious build errors:
258 \begin{lstlisting}[style=sh]
259 grep "\*\*\*.*error" -ai log
261 If this reports errors and you need assistance or you think
262 improvements can be made to the builds, email the log which is
264 \href{mailto:cin@lists.cinelerra-gg.org}{cin@lists.cinelerra-gg.org}
265 \begin{lstlisting}[style=sh]
266 /<build_path>/cinelerra5/cinelerra-5.1/log
269 \item If there are no build errors, finally just run:
270 \begin{lstlisting}[style=sh]
273 Where <os> represents the Operating System supported by \CGG{}, such
274 as centos, fedora, suse, ubuntu, mint, debian.
275 The ``with-single-user'' parameter makes it so.
276 % Make and log build (
277 Check for errors before proceeding.
280 \item If it all worked, you are all setup. Just click on the \CGG{}
285 \subsection{The single-user build}
286 \label{sec:single-user-build}
287 \index{single-user build}
290 To do a single-user build, read the file \texttt{README} that is at
291 the top level after you get the source.
294 \item You need at least 6\,GB of disk storage to operate a build +
295 you need to have “\texttt{git}” installed.
297 \item Recommend you build and run as \textbf{root}, just to avoid
298 permission issues initially.
299 \item The \textit{git} step has to download many files (approx
300 130\,MB) so allow time.
302 \item Run the following commands (this takes awhile):
303 \begin{lstlisting}[style=sh]
304 # This is where you need the 6GB of disk space
306 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
307 # Toplevel directory:
308 cd cinelerra5/cinelerra-5.1
312 NOTE: if your system has never had \CGG{} Infinity installed, you
313 will have to make sure all the compilers and libraries necessary are
314 installed. So on the very first build you should run as
317 % FIXME No novels in the listings.
318 \begin{lstlisting}[style=sh]
319 ./blds/bld_prepare.sh <os>
321 ./configure --with-single-user
325 Where <os> represents the Operating System supported by \CGG{}, such
326 as centos, fedora, suse, ubuntu, mint, debian.
327 The ``with-single-user'' parameter makes it so.
328 % Make and log build (
329 Check for errors before proceeding.
332 Then just start the application by keying in: \texttt{./cin} in the
333 bin subdirectory OR add a desktop icon by using the appropriate
334 directory to copy the files to, run as \textbf{root}, and edit to
335 correct the directory path. Below are generic directions of how to
338 Then just start the application by keying in: \texttt{./cin} in the
339 bin subdirectory OR add a desktop icon by using the appropriate
340 directory to copy the files to, run as \textbf{root}, and edit to
341 correct the directory path. Below are generic directions of how to
344 \begin{lstlisting}[style=sh]
345 cd /cinelerra_directory_path
346 cp -a image/cin.{svg,xpm} /usr/share/pixmaps/
347 cp -a image/cin.desktop /usr/share/applications/cin.desktop
350 After you have followed the above, in the cin.desktop file, change
351 the \texttt{Exec=cin} line to be
352 \texttt{Exec=<your\_directory\_path>/bin/cin}.
354 The preceding directions for doing a single-user build may work
355 without being root on some distros except for the \texttt{bld\_prepare.sh}
356 and creating the desktop icon. For example in Arch Linux installing without being root
357 works using the following steps:
359 \begin{lstlisting}[style=sh]
360 $ git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
361 $ cd /home/USER/cinelerra5/cinelerra-5.1
363 $ ./configure --prefix=/usr --with-single-user --with-booby
364 $ make 2>&1 | tee /tmp/cin5.log && make install
368 \subsection{Notable Options and Caveats}%
369 \label{sub:notable_options_and_caveats}
372 These procedures and the \CGG{} Infinity software have all been run
373 as \textbf{root} on various home laptops and desktops. This provides
374 the best chance to ensure all works correctly and also allows for
375 handling errors, other problems and potential crashes with the most
376 success. Included in this section are some of the build variations
377 easily available for normal builds.
379 To see the full list of features use:
381 \begin{lstlisting}[style=sh]
384 The default build \index{build} is a system build which uses:
386 \begin{lstlisting}[style=sh]
387 ./configure --without-single-user
390 In the single-user build \index{single-user build}, the target directory is always
391 \texttt{cin}. Because this is also the developer build, constant
392 names are used throughout. However, you can rename files after the
395 If your operating system has issues with the default install to
396 \texttt{/usr/local}, you might have to change the location to
397 \texttt{/usr} for a system build. Then you will have to use:
398 \begin{lstlisting}[style=sh]
399 ./configure --prefix=/usr
402 If you wish to change the default directory for a system build you
403 will have to add the destination directory path on the \texttt{make
404 install} line. For example:
405 \begin{lstlisting}[style=sh]
406 make install DESTDIR=<your selected target directory path>
409 The application name can be set during installation, but defaults to
410 \texttt{cin} so that the GG/Infinity build can coexist with other
411 \CGG{} builds if necessary. To override the default \texttt{cin}
413 \begin{lstlisting}[style=sh]
414 ./configure --with-exec-name=cinelerra
417 The home configuration directory can also be set, but default
418 location is traditionally \texttt{\$HOME/.bcast5}. For example:
420 \begin{lstlisting}[style=sh]
421 ./configure -with-config-dir=/myusername/.bcast5
424 NOTE: when you specify parameters to the configure program, it will
425 create a \texttt{make} file as a consequence. Since in a
426 \texttt{make} file, the \$ is a special character, it must be
427 escaped so in order to represent a \$ as part of an input parameter,
428 it has to be stuttered. That is, you will need \$\$ (2 dollar
429 signs) to represent a single dollar sign.
431 It may be necessary on some distros which have missing or incomplete
432 up-to-date libraries, to build \CGG{} without Ladspa. To do so,
435 \begin{lstlisting}[style=sh]
436 ./configure --prefix=/usr --without-ladspa-build
439 Note that the with-ladspa-dir is the ladspa search path, and
440 exists even if the ladspa build is not selected. This gives you
441 the ability to specify an alternate ladspa system path by
442 utilizing the \texttt{LADSPA\_PATH} environment variable (that is,
443 the default ladspa build is deselected).
445 Note for 32-bit 14.2 Slackware, Debian, Gentoo, Arch, FreeBSD,
446 before running the configure, you will need to set up the following:
448 \begin{lstlisting}[style=sh]
449 export ac_cv_header_xmmintrin_h=no
450 export FFMPEG_EXTRA_CFG=" --disable-vdpau"
453 NOTE: as of May 31, 2021 when Context Help was added, to include
454 this Context Help you will need to download the corresponding
455 tgz file containing the HTML manual sections referenced for the
456 Help pages. The file to download is:
457 \url{https://cinelerra-gg.org/download/images/HTML_Manual-20210531.tgz}
458 substituting for "20210531" the "yyyymmdd" representing latest release date.
459 Then unpack to your Cinelerra/bin/doc directory so it is included in
460 your built system. The reason for not including the HTML manual in
461 the source code so that it would already be there, is because it is
462 very large and has its own GIT base.
464 \subsection{Notes about Building from Git in your Customized Environment}%
465 \label{sub:notes_about_building_from_git_in_your_customized_environment}
470 Getting a build to work in a custom environment is not easy. If you
471 have already installed libraries which are normally in the
472 thirdparty build, getting them to be recognized means you have to
473 install the \textit{devel} version so the header files which match
474 the library interfaces exist. Below is the list of thirdparty
475 builds, but this list may have changed over time.
476 % It's list of Table?
480 \begin{longtable}{m{8em} c}
481 \caption{List of thirdparty builds}
482 \label{tab:List_of_thirdparty_builds}\\
525 The \textit{yes} means force build and \textit{auto} means probe and
526 use the system version if the build operation is not static. To get
527 your customized build to work, you need to change the probe options
528 for the conflicting libraries from \textit{yes} to \textit{auto}, or
529 even rework the \texttt{configure.ac} script. There may be several
530 libraries which need special treatment.
532 An example of a problem you might encounter with your customized
533 installation is with \texttt{a52dec} which has probes line
534 \texttt{(CHECK\_LIB/CHECK\_HEADERS)} in \texttt{configure.ac}, but
535 \texttt{djbfft} does not. In this case, \texttt{djbfft} is only
536 built because \texttt{a52dec} is built, so if your system has
537 \texttt{a52dec}, set \texttt{a52dec} to auto and see if that
538 problem is solved by retrying the build with:
539 \begin{lstlisting}[style=sh]
540 ./confgure --with-single-user -enable-a52dec=auto .
543 With persistence, you can get results, but it may take several tries
544 to stabilize the build. If you need help, email the \texttt{log}
545 and \texttt{config.log}, which is usually sufficient to determine
548 If you have already installed the \texttt{libfdk\_aac} development
549 package on your computer because you prefer this version over the
550 default aac, you will have to do the following to get this
551 alternative operational. The libfdk\_aac library is not a part of
552 \CGG{} by default because it is not license free.
554 \begin{lstlisting}[style=sh]
555 export FFMPEG_EXTRA_CFG=" --enable-libfdk-aac --enable-nonfree"
556 export EXTRA_LIBS=" -lfdk-aac"
557 for f in `grep -lw aac cinelerra-5.1/ffmpeg/audio/*`; do
558 sed -e 's/\<aac\>/libfdk_aac/' -i $f
563 \subsection{Cloning the Repository for Faster Updates}%
564 \label{sub:cloning_the_repository_for_faster_updates}
568 If you want to avoid downloading the software every time an update
569 is available you need to create a local ``repository'' or repo. The
570 repo is a directory where you first do a \texttt{git clone}. For
571 the initial git clone, set up a local area for the repository
572 storage, referred to as \texttt{<repo\_path>}. The \texttt{git
573 clone} creates a repo named \texttt{cin5} in the
574 \texttt{/<repo\_path>/} directory. This accesses about 530\,MB of
575 repo data, so the device has to have at least that available. The
576 repo path is always a perfect clone of the main repo.
579 \paragraph{Setting up the initial clone}%
580 \label{par:setting_up_the_initial_clone}
582 You may want to add ``\verb|--depth 1|'' before \texttt{cin5}
583 because this will clone faster and is smaller, but has no history.
585 \begin{lstlisting}[style=sh]
587 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra" cin5
589 Cloning into "cin5"...
590 remote: Counting objects: 20032, done.
591 remote: Compressing objects: 100% (11647/11647), done.
592 remote: Total 20032 (delta 11333), reused 16632 (delta 8189)
593 Receiving objects: 100% (20032/20032), 395.29 MiB | 3.26 MiB/s, done.
594 Resolving deltas: 100% (11333/11333), done.
595 Checking connectivity... done.
599 \paragraph{Update an existing repo}%
600 \label{par:update_an_existing_repo}
601 The below shows how you can get updates.
603 \begin{lstlisting}[style=sh]
609 \paragraph{Useful git commands}%
610 \label{par:useful_git_commands}
611 Some other commands that are useful.
613 \begin{lstlisting}[style=sh]
614 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cin5
615 git pull # pull remote changes to the local version
616 git status # shows changed files
617 git clean -i # interactive clean, use answer 1 to "clean"
621 \subsection{How to Build from a Previous GIT Version}%
622 \label{sub:how_to_build_from_a_previous_git_version}
627 If you have a problem with the current GIT version, you can revert
628 to a previous working version easily. The commands to use will be
629 similar to these next lines which are then explained in more detail.
632 \begin{lstlisting}[style=sh]
633 cd /<path>/cin5 # substitute your repo path name for cin5
634 git log # shows a list of versions depending on history depth specification
635 git checkout <version> # choose a version number as listed
638 The \texttt{git log} command produces a log file with hash values
639 for commit keys to the level specifed if the the depth paramter
641 The hash ids are the commit names to use when you
642 use git checkout. Next is displayed sample output:
644 \begin{lstlisting}[style=nil]
645 delete stray line in last checkin
647 commit 4a90ef3ae46465c0634f81916b79e279e4bd9961
648 Author: Good Guy <good1.2guy@gmail.com>
649 Date: Thu Feb 22 14:56:45 2018 -0700
651 nested clips, big rework and cleanup, sams new icons,
654 commit f87479bd556ea7db4afdd02297fc00977412b873
655 Author: Good Guy <good1.2guy@gmail.com>
656 Date: Sat Feb 17 18:09:22 2018 -0700
659 For the \texttt{git checkout <version>}, you would then keyin the
660 line below for the following results:
662 \begin{lstlisting}[style=nil]
663 git checkout f87479bd556ea7db4afdd02297fc00977412b873
665 Note: checking out 'f87479bd556ea7db4afdd02297fc00977412b873'.
667 You are in 'detached HEAD' state. You can look around, make
668 experimental changes and commit them, and you can discard any
669 commits you make in this state without impacting any branches by
670 performing another checkout.
672 If you want to create a new branch to retain commits you create,
673 you may do so (now or later) by using -b with the checkout command
676 git checkout -b <new-branch-name>
678 HEAD is now at f87479bd... more file size icon updates,
679 and more to followend
682 Later to get the repo back to current, use:
683 \begin{lstlisting}[style=sh]
688 \subsection{Debuggable Single User Build}%
689 \label{sub:debuggable_single_user_build}
690 \index{single-user build}
693 To build from source with full debugging symbols, first build a full
694 static (non\_debug) build as follows but instead of using
695 \texttt{/tmp} substitute your permanent disk path if you want to
698 \begin{lstlisting}[style=sh]
700 git clone --depth 1 "git://git.cinelerra-gg.org/goodguy/cinelerra.git" cinelerra5
701 cp -a /<repo_path>/cinelerra-5.1 /tmp/
702 cd /tmp/cinelerra-5.1
706 Then, to run as a developer in the debugger:
708 \begin{lstlisting}[style=sh]
709 CFLAGS="-O2 -ggdb" make -j8 rebuild_all
715 \subsection{Unbundled Builds}%
716 \label{sub:unbundled_builds}
721 There are some generic build scripts included in the \CGG{} GIT
722 repository for users who want to do unbundled builds with ffmpeg
723 already available on their system. This has been tested on Arch,
724 Ubuntu 18, FreeBSD, Windows10 and Leap 15 (rpm) at the time this
727 The names of the build scripts are: \texttt{arch.bld},
728 \texttt{bsd.bld}, \texttt{deb.bld}, \texttt{rpm.bld}, and
729 \texttt{cygwin.bld}. These scripts are in the \texttt{blds}
730 subdirectory. The \texttt{bsd.bld} should be used with the
731 \texttt{bsd.patch} file in that same directory. The
732 \texttt{cygwin.bld} should be used with the \texttt{cygwin.patch}
733 file in that same directory.
735 The reason that Cin Infinity traditionally uses its own thirdparty builds
736 (bundled builds) is because there are a lot of different distros
737 with varying levels of ffmpeg and other needed thirdparty
738 libraries. However, some users prefer using their current system
739 baseline without another/different copy of ffmpeg.
741 With different levels of the user’s libraries, uncertainty,
742 potential instability, and unknown issues may come up while
743 running \CGG{} and this will make it, for all practical purposes,
744 impossible to diagnose and debug problems or crashes.
746 There may be no help in these cases. You are encouraged to report
747 any errors which potentially originate from Cin Infinity, but if
748 the data indicates alternate library sources, please report the
749 problems to the appropriate maintainers.
751 With the unbundled builds, some features may not be available and
752 no attempt to comment them out has been made. So if you use a
753 pulldown, or pick a render option, or choose something that is not
754 available, it just will not work. For example, unless special
755 options were set up by you, the LV2 audio plugins will not be
756 available. Nor will the codec libzmpeg, the file codec ac3, or
757 DVD creation. The old school file classes will all work, but some
758 of the formats that come with ffmpeg may not because of the way
759 that ffmpeg was installed on your operating system. That is
760 because the \CGG{} included ffmpeg is a known static build and is
761 usually the latest stable/released version. For example, in the
762 current case of Leap 15, libx264 and libx265 are not built in and
763 this can be debilitating; you can always run \texttt{ffmpeg
764 -formats} and \texttt{ffmpeg -codecs} to see what is available
767 \section{Building the HTML Manual for Context Help}%
768 \label{sec:building_the_manual}
771 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.
773 The steps are as follows:
775 \item Download the manual in LaTeX:
777 \begin{lstlisting}[style=sh]
778 git clone "git://git.cinelerra-gg.org/goodguy/cin-manual-latex.git" master
781 \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):
782 \begin{lstlisting}[style=sh]
786 The steps that this script performs are as follows:
788 \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.
790 \begin{lstlisting}[style=sh]
791 pdflatex CinelerraGG_Manual.tex
792 makeindex CinelerraGG_Manual.idx
793 pdflatex CinelerraGG_Manual.tex
794 makeindex CinelerraGG_Manual.nlo -s nomencl.ist -o CinelerraGG_Manual.nls
795 pdflatex CinelerraGG_Manual.tex
798 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.
799 \item Next, to produce HTML output the script then moves (renames) \texttt{latex 2html-init} to \texttt{.latex2html-init} (starting with dot).
801 \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.
804 \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.
806 \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.
809 \section{Windows 10 with Cygwin for \CGG{} Limited}%
810 \label{sec:ms_windows10}
813 As of 10/31/2020, this is no longer being maintained. It should
814 still work using an older GIT version with Windows 10 but it is
815 possible with some effort to modify the patch file to work with the
818 To run \CGG{} on a Windows 10 computer, you will need to have
819 Cygwin installed on your system, along with the \CGG{} static tar
820 and a patched library: libxcb. This setup has been tested with
821 Windows 10, version 1909, on an HP EliteBook 820 at 2.3 GHz.
823 This limited version provides \textit{core} functionality at this
824 time with the standard Windows FFmpeg executable, meaning that
825 specific modifications in FFmpeg needed for \CGG{} are not
826 available. Limited capabilities include only a few render output
827 formats available - for example \textit{mov}, \textit{qt} as
828 \textit{mjpeg}, and \textit{mpeg} for videos and \textit{avi} and
829 \textit{qt} as \textit{s16le} for audio, but not \textit{mkv} or
830 \textit{mp4}. This is due to the fact that several codec and
831 utility libraries are not currently compiled to work with Windows.
833 \subsection*{Installing Cygwin}
834 \label{sec:installing_cygwin}
837 Cygwin is an environment that runs natively on Windows which
838 allows Unix programs to be compiled and run on Windows. With
839 cygwin installed on your Windows 10 computer, you will be able to
840 run \CGG{}. Before installing cygwin, you need to be warned that
841 the Avast anti-virus software kills files necessary for cygwin
842 installation and execution, so you will have to remove it and use
843 alternative anti-virus software (the standard default already
844 included with Windows 10 is Defender). Below are the steps for
848 \item Download cygwin for your 64-bit computer at:
849 \href{https://www.cygwin.com/}{https://www.cygwin.com/}
851 \item Generally just take the defaults as they show up, but the
852 next steps show what comes up.
854 \item When a warning window pops up, click \textit{Yes}.
856 \item Click \textit{Next}.
858 \item Choose \textit{Install from Internet} option and then click
861 \item Choose your desired directory by clicking on Browse
862 button. Choose \textit{All Users (Recommended)} and then click
865 \item Choose the local package directory where you would like your
866 installation files to be placed. Click \textit{Next}.
868 \item Choose \textit{Direct Connection} if you are using Internet
869 with plug and play device. Click \textit{Next}.
871 \item Choose any download site preferably
872 ``cygwin.mirror.constant.com'' and then click \textit{Next}.
874 \item For list of things to install, leave all set to
875 \textit{Default} except these to \textit{Install} instead:
884 This install takes a long time; approximately 2 hours on an
885 EliteBook and requires approximately 20GB storage.
887 \item Finally you will want to have the icons on your desktop
888 (already default) and then click \textit{Finish}.
891 Then to install the \CGG{} tar files, you will need to start a
892 cygwin console terminal from the startup menu as shown here:
893 \texttt{Start $\rightarrow$ Cygwin $\rightarrow$ Cygwin64}
896 \subsection*{Installing \CGG{}}
897 \label{sec:installing_cinelerra}
900 \item Download the tar file
901 \href{https://cinelerra-gg.org/download/testing/libxcb-bld.tar.bz2}{libxcb-bld.tar.bz2}.
903 \item Install libxcb from the tar file -- installs into
904 \texttt{/usr/local} and requires approximately 21MB storage.
905 \begin{lstlisting}[style=sh]
906 tar -C /usr/local -xJf /path/libxcb-bld.tar.bz2
908 The libxcb patch repairs an error (XIOError), which stops
911 \item Download the tar file
912 \href{https://cinelerra-gg.org/download/testing/cygcin-bld.tar.bz2}{cygcin-bld.tar.bz2}.
914 \item Install cygcin from the tar file - this installs into home
915 directory. Note this is cygcin \emph{not} cygwin. You must change the
916 \texttt{path} below to the name of the path where you downloaded
918 \begin{lstlisting}[style=sh]
920 tar -xJf /path/cygcin-bld.tar.bz2
924 This creates \texttt{\~{}/cygcin}, a user build installation of
925 \CGG{} and requires approximately 400MB storage.
927 \paragraph{Running \CGG{}:}
928 You will need to start a cygwin desktop from the startup menu:
930 \item \texttt{Start$\rightarrow$ Cygwin-X $\rightarrow$ Openbox}
932 You should start a console controlling terminal so that you can
935 \item \texttt{Start$\rightarrow$ Cygwin $\rightarrow$ Cygwin64} Terminal
937 This opens a separate window that can survive a cygwin hang and
938 bugs. Without these logs, it is much more difficult to use.
940 \item Type into that console controlling window, the following:
941 \begin{lstlisting}[style=sh]
945 \item Change directories to where \CGG{} is installed:
946 \begin{lstlisting}[style=sh]
947 cd /path/cygcin (NOT cygwin)
951 \begin{lstlisting}[style=sh]
954 which starts up your 4 \CGG{} windows.
957 The most noticeable difference from the Linux versions is that
958 \CGG{} seems to run very slowly on Windows 10. You must be very
959 tolerant and patient to see this work. It can however exhibit
960 astonishing speed when encoding. \CGG{} has to be downgraded
961 significantly due to lack of supported interfaces, codecs (for
962 example h264/h265), and utilities. The only graphics driver is
963 X11 and the only sound driver is pulseaudio. Almost all
964 configurable omissions are applied to this build.
966 \paragraph{\CGG{} build on cygwin from source code:}
969 \item Download and install ffmpeg into /usr/local :
971 download ffmpeg (currently 4.2.2)
972 \begin{lstlisting}[style=sh]
974 tar -xJf /path/ffmpeg-4.2.2.tar.bz2
981 \item Download and install a patched libxcb:
982 \begin{lstlisting}[style=sh]
985 tar -xf /path/libxcb-1.13.tar.bz2
987 patch -p1 < /path/cinelerra-5.1/thirdparty/src/libxcb.patch1
988 patching file configure.ac
989 patching file src/xcb_in.c
995 \item Download cinelerra-gg:
996 \begin{lstlisting}[style=sh]
998 git clone "git://git.cinelerra-gg.org/goodguy/cinelerra.git"
999 cd cinelerra-gg/cinelerra-5.1
1001 \item Apply cygwin patch:
1002 \begin{lstlisting}[style=sh]
1003 patch -p2 < blds/cygwin.patch
1005 \item Run the build with:
1006 \begin{lstlisting}[style=sh]
1011 This produces a directory: /build\_path/cinelerra-gg/cinelerra-5.1/bin
1012 which is used to create the cygcin archive.
1014 Currently, the targets are not stripped and can be run from gdb.
1015 There is only very limited signal handler dmp file support.
1016 Running gdb from inside a desktop resident console (not a cygwin64
1017 window) will hang cygwin (and cin) when it hits a breakpoint. You
1018 must run from an external console window to avoid this issue.
1020 \section{Android Tablet or Phone with TERMUX}%
1021 \label{sec:android_termux}
1024 \CGG{} can be run on Android (without audio), a non-x86 mostly posix system,
1025 tablet or phone after installing TERMUX, the \textit{terminal emulator}.
1026 You will have to do your own build using the file in Cinelerra's
1027 \textit{blds} subdirectory, \textit{termux.bld}.
1028 Because this is a relatively new capability and of lesser use, some
1029 additional effort may have to be exerted on your part to get it going
1030 but it is easy to get help by contacting the mailing list.
1031 In addition, there is currently no known procedure for hearing audio.
1033 \begin{figure}[htpb]
1035 \includegraphics[width=1.0\linewidth]{android.png}
1036 \caption{Screencast of an Android tablet running \CGG{} using TERMUX.}
1040 Some requirements include;
1042 \item Termux runs with X on Android 7+.
1043 \item Install takes 5 GB of internal storage. In addition you can download videos,
1044 and other files with wget to one specific location at sdcard after running termux-setup-storage
1045 inside termux (it will prompt you to give access to sdcard graphically the first time used).
1046 \item If you have empty versions of locale.alias, locale.dir,
1048 \newline \$PREFIX/share/X11/locale/en\_US.UTF-8/XLC\_LOCALE
1049 you will have to request non-empty versions via the mailing list.
1050 \item Some helpful information on installing the X environment is at:
1051 \url{https://wiki.termux.com/wiki/Graphical\_Environment}
1052 \item To prevent crashing when loading a video file that has audio, use the guide
1053 \url{https://www.reddit.com/r/termux/comments/bpa8jz/pulseaudio\_streaming\_client/}
1054 which explains vnc/pulseaudio setup.
1057 A little more about Audio is presented next because you will need to have this running
1058 in order to prevent a crash (even though you still will not be able to hear audio) -
1059 there does not seem to be a simple PA client in termux itself.
1060 Some information is available at:
1061 \url{https://android.stackexchange.com/questions/205576/how-to-play-sound-from-termux-when-using-linux} .
1063 The next few lines show a successful setup/usage.
1064 \begin{lstlisting}[style=sh]
1065 $ pulseaudio --start
1067 PID TTY STAT TIME MAJFL TRS DRS RSS %MEM COMMAND
1068 7003 pts/28 S<s 0:00 637 532 9039 1716 0.0 /data/data/com
1069 13684 ? S<l 0:00 0 49 123898 16616 0.8 pulseaudio --
1070 13692 pts/28 R<+ 0:00 0 63 7500 1420 0.0 ps axv
1072 \begin{lstlisting}[style=sh]
1073 $ pactl load-module module-native-protocol-tcp auth-ip-acl=127.0.0.1 auth-anonymous=116
1074 $ PULSE_SERVER=127.0.0.1 pactl info
1075 Server String: 127.0.0.1
1076 Library Protocol Version: 34
1077 Server Protocol Version: 34
1082 Host Name: localhost
1083 Server Name: pulseaudio
1084 Server Version: 14.2
1085 Default Sample Specification: s16le 2ch 44100Hz
1086 Default Channel Map: front-left,front-right
1087 Default Sink: OpenSL_ES_sink
1088 Default Source: OpenSL_ES_sink.monitor
1092 Now to start up \CGG{}, type in:
1093 \begin{lstlisting}[style=sh]
1094 $ cd (your cinelerra directory)/cinelerra/cinelerra-5.1/
1095 $ PULSE_SERVER=127.0.0.1 ./cin.sh
1098 You can even build a package version similiar to Debian, just with "pkg search pkg\_name / pkg install
1099 pkg\_name" instead of "apt search/install pkg\_name" and with "*-static" instead of "*-dev/-devel packages".
1100 For more information on this, see:
1102 \url{https://wiki.termux.com/wiki/Package\_Management}
1103 \newline \url{https://wiki.termux.com/wiki/Building\_packages}
1105 \section{Distro with \CGG{} Included}%
1106 \label{sec:distro_with_cinelerra_included}
1107 \index{linux distro}
1109 There are also some special complete distribution systems
1110 available that include \CGG{} for audio and video production
1113 \subsection{AV Linux}
1114 \label{sec:AV_Linux}
1116 \textbf{AV Linux} is a downloadable/installable shared snapshot
1117 ISO image based on MX Linux. It provides the user an easy method to
1118 get an Audio and Video production workstation without the hassle
1119 of trying to find and install all of the usual components
1120 themselves. Of course, it includes \CGG{}!
1123 \href{http://www.bandshed.net/avlinux/}{homepage of AV Linux}.
1125 \subsection{Bodhi Linux Media}
1126 \label{sec:Bodhi_Linux}
1128 \textbf{Bodhi Linux Media} is a free and open source distribution that
1129 comes with a curated list of open source software for digital
1130 artists who work with audio, video, includes \CGG{}, games,
1131 graphics, animations, physical computing, etc.
1134 \href{https://gitlab.com/giuseppetorre/bodhilinuxmedia}{homepage of Bodhi Linux}.
1136 \subsection{DeLinuxCo}
1137 \label{sec:delinuxco}
1139 \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{}.
1141 You can read all about DeLinuxCo \href{https://www.delinuxco.com/}{here} and download \href{https://www.delinuxco.com/download/}{here}.
1146 \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.
1148 Click \href{https://www.elivecd.org/}{Elive} for more information. The \CGG{} packages for the program
1149 and the manual are in the direcotry at
1150 \href{https://repo.bullseye.elive.elivecd.org/pool/multimedia/c/} {Bullseye version 11} and
1151 \href{http://repo.buster.elive.elivecd.org/pool/multimedia/c/}{Buster version 10} - just download
1152 the .deb files inside that directory and install via “dpkg -i “.
1154 \section{Cinx and a “Bit” of Confusion}%
1155 \label{sec:cinx_and_a_bit_of_confusion}
1158 Cinx is the exact same program as Cin. The X (x) represents the
1159 roman numeral 10 for 10-bit as opposed to 8-bit standard. The
1160 third-party library used for x265 must be specially compiled with
1161 \texttt{--bit-depth=10} in order to produce 10-bit rendered
1162 output. A cinx version can be built for most other distros if
1163 rendering at 10-bit is desirable instead of 8-bit.
1165 This build will not be able to output 8-bit depth which means you
1166 have to retain the Cin version also.
1168 Whatever build ffmpeg is linked to will determine what bit depth
1169 it can output. This is why there have to be separate builds. If
1170 you install both packages, Cin and CinX, you may get \textit{file
1171 conflicts of same file name} --- just continue.
1173 Keep in mind that the regular 8-bit version works on 8-bit bytes
1174 --- the standard word size for computers, but the 10-bit version
1175 has to use 2 words to contain all 10 bits so you can expect
1176 rendering to be as much as twice as slow.
1178 There is also a 12-bit version for consideration but currently the
1179 results are simply the same as 10-bit with padding to make 12-bit
1180 so it is of no value.
1182 \section{Multibit build for x265-8/10/12-bit}%
1183 \label{sec:multibit_build}
1186 To build a version that can handle 8 bit, or 10 bit, or 12 bit videos,
1187 a patch is provided in the \texttt{thirdparty} subdirectory that needs
1188 to be applied to do so. Be aware that the compile may take more time
1189 and seems to be about twice as long. To apply the required patch:
1191 \begin{lstlisting}[style=sh]
1192 cd /path/to/cinelerra-5.1/thirdparty
1193 patch < compile_multibit_X265.txt
1194 mv x265_3.5.patch* src/.
1196 Render formats \textit{h265-10bit} and \textit{h265-12bit} have been provided and will
1197 be operational after the applied patch is compiled in.
1199 %%% Local Variables:
1201 %%% TeX-master: "../CinelerraGG_Manual"